setup-java/__tests__/distributors/distribution-factory.test.ts

import {getJavaDistribution} from '../../src/distributions/distribution-factory.js';
import {RetryingHttpClient} from '../../src/retrying-http-client.js';
import {
  JAVA_PACKAGE_CAPABILITIES,
  JavaDistribution
} from '../../src/distributions/package-types.js';
import os from 'os';
import {validateJavaPlatform} from '../../src/distributions/platform-types.js';
import {normalizeArchitecture} from '../../src/distributions/platform-types.js';

const supportedDistributionsOnCurrentPlatform = Object.values(
  JavaDistribution
).filter(distributionName => {
  try {
    validateJavaPlatform(distributionName, process.platform, 'x64', '25');
    return distributionName !== JavaDistribution.JdkFile;
  } catch {
    return false;
  }
});

const installerOptions = (packageType: string, version = '25') => ({
  version,
  architecture: 'x64',
  packageType,
  checkLatest: false
});

describe('getJavaDistribution', () => {
  it.each(supportedDistributionsOnCurrentPlatform)(
    'uses the shared retrying HTTP client for %s',
    async distributionName => {
      const distribution = await getJavaDistribution(distributionName, {
        version: '25',
        architecture: 'x64',
        packageType: 'jdk',
        checkLatest: false
      });

      expect(distribution).not.toBeNull();
      expect(distribution!['http']).toBeInstanceOf(RetryingHttpClient);
    }
  );

  it.each(
    Object.entries(JAVA_PACKAGE_CAPABILITIES).flatMap(
      ([distributionName, packageTypes]) =>
        supportedDistributionsOnCurrentPlatform.includes(
          distributionName as JavaDistribution
        ) || distributionName === JavaDistribution.JdkFile
          ? packageTypes.map(packageType => [distributionName, packageType])
          : []
    )
  )(
    'accepts %s with java-package %s',
    async (distributionName, packageType) => {
      expect(
        await getJavaDistribution(
          distributionName,
          installerOptions(packageType as string)
        )
      ).not.toBeNull();
    }
  );

  it.each(Object.entries(JAVA_PACKAGE_CAPABILITIES))(
    'rejects unsupported java-package values for %s',
    async (distributionName, packageTypes) => {
      await expect(
        getJavaDistribution(distributionName, installerOptions('jdk+typo'))
      ).rejects.toThrow(
        `Java package 'jdk+typo' is not supported for distribution '${distributionName}'. Supported package types: ${packageTypes.join(', ')}.`
      );
    }
  );

  it("rejects java-package 'jdk+jmods' for non-Temurin distributions", async () => {
    await expect(
      getJavaDistribution('zulu', installerOptions('jdk+jmods'))
    ).rejects.toThrow(
      "Java package 'jdk+jmods' is not supported for distribution 'zulu'. Supported package types: jdk, jre, jdk+fx, jre+fx, jdk+crac, jre+crac."
    );
  });

  it.each(['8', '23.x', '23.0.1.1', '<24'])(
    "rejects Temurin java-package 'jdk+jmods' for version %s",
    async version => {
      await expect(
        getJavaDistribution(
          JavaDistribution.Temurin,
          installerOptions('jdk+jmods', version)
        )
      ).rejects.toThrow(
        `Java package 'jdk+jmods' is not supported for distribution 'temurin'. Supported package types: jdk, jre, jdk+jmods. Package 'jdk+jmods' requires Java 24 or later; requested version '${version}'.`
      );
    }
  );

  it.each(['24', '24.0.1.1', '25-ea', '>=21', 'latest'])(
    "accepts Temurin java-package 'jdk+jmods' for version %s",
    async version => {
      expect(
        await getJavaDistribution(
          JavaDistribution.Temurin,
          installerOptions('jdk+jmods', version)
        )
      ).not.toBeNull();
    }
  );

  it('preserves unsupported distribution handling', async () => {
    expect(
      await getJavaDistribution(
        'not-a-distribution',
        installerOptions('not-a-package')
      )
    ).toBeNull();
  });

  it.each(['adopt', 'adopt-hotspot', 'adopt-openj9'])(
    'does not support legacy Adopt distribution %s',
    async distributionName => {
      expect(
        await getJavaDistribution(distributionName, installerOptions('jdk'))
      ).toBeNull();
    }
  );

  it.each([
    ['amd64', 'x64'],
    ['ia32', 'x86'],
    ['arm64', 'aarch64']
  ])('passes normalized architecture %s as %s', async (input, expected) => {
    const normalized = await getJavaDistribution(JavaDistribution.JdkFile, {
      ...installerOptions('jdk'),
      architecture: input
    });

    expect(normalized!['architecture']).toBe(expected);
  });

  it('uses the runner architecture when the input is empty', async () => {
    const distribution = await getJavaDistribution(JavaDistribution.Temurin, {
      ...installerOptions('jdk'),
      architecture: ''
    });

    const expected = normalizeArchitecture(os.arch());
    expect(distribution!['architecture']).toBe(expected);
  });

  it('rejects an unsupported combination before creating an HTTP client', async () => {
    await expect(
      getJavaDistribution(JavaDistribution.Oracle, {
        ...installerOptions('jdk'),
        architecture: 'x86'
      })
    ).rejects.toThrow(/does not support operating system/);
  });
});