setup-java/__tests__/distributors/sapmachine-installer.test.ts

import {
  jest,
  describe,
  it,
  expect,
  beforeEach,
  afterEach,
  beforeAll,
  afterAll
} from '@jest/globals';
import {HttpClient} from '@actions/http-client';

import manifestData from '../data/sapmachine.json' with {type: 'json'};
import releaseClassManifestData from '../data/sapmachine-release-classes.json' with {type: 'json'};

// Mock @actions/core before importing source modules that depend on it
jest.unstable_mockModule('@actions/core', () => ({
  info: jest.fn(),
  warning: jest.fn(),
  debug: jest.fn(),
  error: jest.fn(),
  notice: jest.fn(),
  setFailed: jest.fn(),
  setOutput: jest.fn(),
  getInput: jest.fn(),
  getBooleanInput: jest.fn(),
  getMultilineInput: jest.fn(),
  addPath: jest.fn(),
  exportVariable: jest.fn(),
  saveState: jest.fn(),
  getState: jest.fn(),
  setSecret: jest.fn(),
  isDebug: jest.fn(() => false),
  startGroup: jest.fn(),
  endGroup: jest.fn(),
  group: jest.fn((_name: string, fn: () => Promise<unknown>) => fn()),
  toPlatformPath: jest.fn((p: string) => p),
  toWin32Path: jest.fn((p: string) => p),
  toPosixPath: jest.fn((p: string) => p)
}));

const real_util_module = await import('../../src/util.js');
jest.unstable_mockModule('../../src/util.js', () => ({
  ...real_util_module,
  getDownloadArchiveExtension: jest.fn()
}));

// Dynamic imports after mocking
const core = await import('@actions/core');
const {SapMachineDistribution} =
  await import('../../src/distributions/sapmachine/installer.js');
const utils = await import('../../src/util.js');

describe('getAvailableVersions', () => {
  let spyHttpClient: any;
  let spyHttpGet: any;
  let spyUtilGetDownloadArchiveExtension: any;
  let spyCoreError: any;
  const archiveChecksum = 'f'.repeat(64);

  beforeEach(() => {
    spyHttpClient = jest.spyOn(HttpClient.prototype, 'getJson');
    spyHttpClient.mockReturnValue({
      statusCode: 200,
      headers: {},
      result: manifestData
    });
    spyHttpGet = jest.spyOn(HttpClient.prototype, 'get');
    spyHttpGet.mockResolvedValue({
      message: {statusCode: 200},
      readBody: async () => `${archiveChecksum}  archive`
    });

    spyUtilGetDownloadArchiveExtension =
      utils.getDownloadArchiveExtension as jest.Mock<any>;
    spyUtilGetDownloadArchiveExtension.mockReturnValue('tar.gz');

    // Mock core.error to suppress error logs
    spyCoreError = core.error as jest.Mock;
    spyCoreError.mockImplementation(() => {});
  });

  afterEach(() => {
    jest.resetAllMocks();
    jest.clearAllMocks();
    jest.restoreAllMocks();
  });

  const mockPlatform = (
    distribution: InstanceType<typeof SapMachineDistribution>,
    platform: string
  ) => {
    distribution['getPlatformOption'] = () => platform;
    const mockedExtension = platform == 'windows' ? 'zip' : 'tar.gz';
    spyUtilGetDownloadArchiveExtension.mockReturnValue(mockedExtension);
  };

  describe('shouldFallbackToBackupUrl', () => {
    it('should return correct release when the primary URL is not available', async () => {
      spyHttpClient.mockReturnValueOnce({
        statusCode: 404,
        headers: {},
        result: ''
      });
      spyHttpClient.mockReturnValueOnce({
        statusCode: 200,
        headers: {},
        result: manifestData
      });

      const version = '17';
      const distribution = new SapMachineDistribution({
        version: version,
        architecture: 'x64',
        packageType: 'jdk',
        checkLatest: false
      });

      mockPlatform(distribution, 'linux');

      const availableVersion =
        await distribution['findPackageForDownload'](version);
      expect(availableVersion).not.toBeNull();
      expect(availableVersion.url).toBe(
        'https://github.com/SAP/SapMachine/releases/download/sapmachine-17.0.10/sapmachine-jdk-17.0.10_linux-x64_bin.tar.gz'
      );
    });
  });

  describe('getAvailableVersions', () => {
    it.each([
      ['11', 'x64', 'linux', 71],
      ['11', 'aarch64', 'linux', 54],
      ['17', 'riscv', 'linux', 0],
      ['16.0.1', 'x64', 'linux', 71],
      ['23-ea', 'x64', 'linux', 727],
      ['23-ea', 'aarch64', 'windows', 0],
      ['23-ea', 'x64', 'windows', 679]
    ])(
      'should get right number of available versions from JSON',
      async (
        jdkVersion: string,
        arch: string,
        platform: string,
        len: number
      ) => {
        const distribution = new SapMachineDistribution({
          version: jdkVersion,
          architecture: arch,
          packageType: 'jdk',
          checkLatest: false
        });
        mockPlatform(distribution, platform);

        const availableVersions = await distribution['getAvailableVersions']();
        expect(availableVersions).not.toBeNull();
        expect(availableVersions.length).toBe(len);
      }
    );

    it.each([
      [
        '25',
        [
          'https://example.test/sapmachine-25.0.2-ga.tar.gz',
          'https://example.test/sapmachine-25.0.1-ga.tar.gz'
        ]
      ],
      [
        '25-ea',
        [
          'https://example.test/sapmachine-25-ea.11.tar.gz',
          'https://example.test/sapmachine-25-ea.10.tar.gz'
        ]
      ]
    ])(
      'should classify boolean and string EA metadata for %s requests',
      async (version: string, expectedLinks: string[]) => {
        spyHttpClient.mockReturnValue({
          statusCode: 200,
          headers: {},
          result: releaseClassManifestData
        });
        const distribution = new SapMachineDistribution({
          version,
          architecture: 'x64',
          packageType: 'jdk',
          checkLatest: false
        });
        mockPlatform(distribution, 'linux');

        const availableVersions = await distribution['getAvailableVersions']();

        expect(availableVersions.map(item => item.downloadLink)).toStrictEqual(
          expectedLinks
        );
      }
    );
  });

  describe('findPackageForDownload', () => {
    it.each([
      [
        '11',
        'linux',
        'x64',
        'jdk',
        'https://github.com/SAP/SapMachine/releases/download/sapmachine-11.0.22/sapmachine-jdk-11.0.22_linux-x64_bin.tar.gz'
      ],
      [
        '11',
        'linux',
        'aarch64',
        'jdk',
        'https://github.com/SAP/SapMachine/releases/download/sapmachine-11.0.22/sapmachine-jdk-11.0.22_linux-aarch64_bin.tar.gz'
      ],
      [
        '11',
        'windows',
        'x64',
        'jdk',
        'https://github.com/SAP/SapMachine/releases/download/sapmachine-11.0.22/sapmachine-jdk-11.0.22_windows-x64_bin.zip'
      ],
      [
        '11.0.17',
        'linux',
        'x64',
        'jdk',
        'https://github.com/SAP/SapMachine/releases/download/sapmachine-11.0.17/sapmachine-jdk-11.0.17_linux-x64_bin.tar.gz'
      ],
      [
        '17',
        'linux',
        'x64',
        'jdk',
        'https://github.com/SAP/SapMachine/releases/download/sapmachine-17.0.10/sapmachine-jdk-17.0.10_linux-x64_bin.tar.gz'
      ],
      [
        '17',
        'linux',
        'aarch64',
        'jdk',
        'https://github.com/SAP/SapMachine/releases/download/sapmachine-17.0.10/sapmachine-jdk-17.0.10_linux-aarch64_bin.tar.gz'
      ],
      [
        '17',
        'windows',
        'x64',
        'jdk',
        'https://github.com/SAP/SapMachine/releases/download/sapmachine-17.0.10/sapmachine-jdk-17.0.10_windows-x64_bin.zip'
      ],
      [
        '17.0.4',
        'linux',
        'x64',
        'jdk',
        'https://github.com/SAP/SapMachine/releases/download/sapmachine-17.0.4.1/sapmachine-jdk-17.0.4.1_linux-x64_bin.tar.gz'
      ],
      [
        '17',
        'linux',
        'x64',
        'jre',
        'https://github.com/SAP/SapMachine/releases/download/sapmachine-17.0.10/sapmachine-jre-17.0.10_linux-x64_bin.tar.gz'
      ],
      [
        '17',
        'linux',
        'aarch64',
        'jre',
        'https://github.com/SAP/SapMachine/releases/download/sapmachine-17.0.10/sapmachine-jre-17.0.10_linux-aarch64_bin.tar.gz'
      ],
      [
        '17',
        'windows',
        'x64',
        'jre',
        'https://github.com/SAP/SapMachine/releases/download/sapmachine-17.0.10/sapmachine-jre-17.0.10_windows-x64_bin.zip'
      ],
      [
        '17.0.4',
        'linux',
        'x64',
        'jre',
        'https://github.com/SAP/SapMachine/releases/download/sapmachine-17.0.4.1/sapmachine-jre-17.0.4.1_linux-x64_bin.tar.gz'
      ],
      [
        '23-ea',
        'linux',
        'x64',
        'jdk',
        'https://github.com/SAP/SapMachine/releases/download/sapmachine-23%2B15/sapmachine-jdk-23-ea.15_linux-x64_bin.tar.gz',
        '23'
      ],
      [
        '21.0.2+2-ea',
        'linux',
        'x64',
        'jdk',
        'https://github.com/SAP/SapMachine/releases/download/sapmachine-21.0.2%2B2/sapmachine-jdk-21.0.2-ea.2_linux-x64_bin.tar.gz',
        '21.0.2+2'
      ],
      [
        '17',
        'linux-musl',
        'x64',
        'jdk',
        'https://github.com/SAP/SapMachine/releases/download/sapmachine-17.0.10/sapmachine-jdk-17.0.10_linux-x64-musl_bin.tar.gz'
      ]
    ])(
      'should return proper link according to the specified java-version, platform and arch',
      async (
        version: string,
        platform: string,
        arch: string,
        packageType: string,
        expectedLink: string,
        normalizedVersion: string = version
      ) => {
        const distribution = new SapMachineDistribution({
          version: version,
          architecture: arch,
          packageType: packageType,
          checkLatest: false
        });
        mockPlatform(distribution, platform);

        const availableVersion =
          await distribution['findPackageForDownload'](normalizedVersion);
        expect(availableVersion).not.toBeNull();
        expect(availableVersion.url).toBe(expectedLink);
        expect(availableVersion.checksum).toEqual({
          algorithm: 'sha256',
          value: archiveChecksum,
          source: expectedLink.replace(/\.(?:tar\.gz|zip)$/, '.sha256.txt')
        });
      }
    );

    it('uses the checksum published beside the selected EA archive', async () => {
      const distribution = new SapMachineDistribution({
        version: '21-ea',
        architecture: 'x64',
        packageType: 'jdk',
        checkLatest: false
      });
      mockPlatform(distribution, 'linux');

      const release = await distribution['findPackageForDownload']('21');

      expect(spyHttpGet).toHaveBeenCalledWith(
        release.url.replace(/\.(?:tar\.gz|zip)$/, '.sha256.txt')
      );
      expect(release.checksum?.value).toBe(archiveChecksum);
    });

    it('does not select a newer stable release for an EA request', async () => {
      spyHttpClient.mockReturnValue({
        statusCode: 200,
        headers: {},
        result: releaseClassManifestData
      });
      const distribution = new SapMachineDistribution({
        version: '25-ea',
        architecture: 'x64',
        packageType: 'jdk',
        checkLatest: false
      });
      mockPlatform(distribution, 'linux');

      const release = await distribution['findPackageForDownload']('25');

      expect(release.url).toBe(
        'https://example.test/sapmachine-25-ea.11.tar.gz'
      );
    });

    it.each([
      ['8', 'linux', 'x64'],
      ['8', 'macos', 'aarch64'],
      ['23', 'macos', 'aarch64'],
      ['17', 'linux', 'riscv'],
      ['23', 'linux', 'x64'],
      ['25-ea', 'linux', 'x64', '25'],
      ['8-ea', 'linux', 'x64', '8'],
      ['21.0.3+7', 'linux', 'x64', '21.0.3+7'],
      ['21.0.3+8-ea', 'linux', 'x64', '21.0.3+8'],
      ['17', 'linux-muse', 'aarch64']
    ])(
      'should throw when required version of JDK cannot be found in the JSON',
      async (
        version: string,
        platform: string,
        arch: string,
        normalizedVersion: string = version
      ) => {
        const distribution = new SapMachineDistribution({
          version: version,
          architecture: arch,
          packageType: 'jdk',
          checkLatest: false
        });
        mockPlatform(distribution, platform);

        await expect(
          distribution['findPackageForDownload'](normalizedVersion)
        ).rejects.toThrow(
          `No matching version found for SemVer '${normalizedVersion}'`
        );
      }
    );

    it('should throw when required package type is not supported', async () => {
      const jdkVersion = '17';
      const arch = 'x64';
      const platform = 'linux';
      const distribution = new SapMachineDistribution({
        version: jdkVersion,
        architecture: arch,
        packageType: 'jdk+fx',
        checkLatest: false
      });
      mockPlatform(distribution, platform);
      await expect(
        distribution['findPackageForDownload'](jdkVersion)
      ).rejects.toThrow(
        'SapMachine provides only the `jdk` and `jre` package type'
      );
    });
  });
});