Add support for Adoptium OpenJDK

Refs https://github.com/actions/setup-java/issues/191

README.md

@@ -13,7 +13,7 @@ This action provides the following functionality for GitHub Actions runners:
 - Registering problem matchers for error output
 
 ## V2 vs V1
-- V2 supports custom distributions and provides support for Zulu OpenJDK and Adopt OpenJDK out of the box. V1 supports only Zulu OpenJDK
+- V2 supports custom distributions and provides support for Zulu OpenJDK, Adopt OpenJDK and Adoptium OpenJDK out of the box. V1 supports only Zulu OpenJDK
 - V2 requires you to specify distribution along with the version. V1 defaults to Zulu OpenJDK, only version input is required. Follow [the migration guide](docs/switching-to-v2.md) to switch from V1 to V2
 
 ## Usage
@@ -31,6 +31,17 @@ steps:
 - run: java -cp java HelloWorldApp
 ```
 
+**Adoptium OpenJDK**
+```yaml
+steps:
+- uses: actions/checkout@v2
+- uses: actions/setup-java@v2
+  with:
+    distribution: 'adoptium' # See 'Supported distributions' for available options
+    java-version: '8'
+- run: java -cp java HelloWorldApp
+```
+
 **Zulu OpenJDK**
 ```yaml
 steps:
@@ -55,6 +66,7 @@ Currently, the following distributions are supported:
 | `zulu` | Zulu OpenJDK | [Link](https://www.azul.com/downloads/zulu-community/?package=jdk) | [Link](https://www.azul.com/products/zulu-and-zulu-enterprise/zulu-terms-of-use/) |
 | `adopt` or `adopt-hotspot` | Adopt OpenJDK Hotspot | [Link](https://adoptopenjdk.net/) | [Link](https://adoptopenjdk.net/about.html)
 | `adopt-openj9` | Adopt OpenJDK OpenJ9 | [Link](https://adoptopenjdk.net/) | [Link](https://adoptopenjdk.net/about.html)
+| `adoptium` or `adoptium-hotspot` | Adoptium OpenJDK Hotspot | [Link](https://adoptium.net/) | [Link](https://adoptium.net/about.html)
 
 **NOTE:** The different distributors can provide discrepant list of available versions / supported configurations. Please refer to the official documentation to see the list of supported versions.
 

__tests__/distributors/adoptium-installer.test.ts

@@ -0,0 +1,164 @@
+import { HttpClient } from '@actions/http-client';
+
+import {
+  AdoptiumDistribution,
+  AdoptiumImplementation
+} from '../../src/distributions/adoptium/installer';
+import { JavaInstallerOptions } from '../../src/distributions/base-models';
+
+let manifestData = require('../data/adoptium.json') as [];
+
+describe('getAvailableVersions', () => {
+  let spyHttpClient: jest.SpyInstance;
+
+  beforeEach(() => {
+    spyHttpClient = jest.spyOn(HttpClient.prototype, 'getJson');
+    spyHttpClient.mockReturnValue({
+      statusCode: 200,
+      headers: {},
+      result: []
+    });
+  });
+
+  afterEach(() => {
+    jest.resetAllMocks();
+    jest.clearAllMocks();
+    jest.restoreAllMocks();
+  });
+
+  it.each([
+    [
+      { version: '16', architecture: 'x64', packageType: 'jdk', checkLatest: false },
+      AdoptiumImplementation.Hotspot,
+      'os=mac&architecture=x64&image_type=jdk&release_type=ga&jvm_impl=hotspot&page_size=20&page=0'
+    ],
+    [
+      { version: '16', architecture: 'x86', packageType: 'jdk', checkLatest: false },
+      AdoptiumImplementation.Hotspot,
+      'os=mac&architecture=x86&image_type=jdk&release_type=ga&jvm_impl=hotspot&page_size=20&page=0'
+    ],
+    [
+      { version: '16', architecture: 'x64', packageType: 'jre', checkLatest: false },
+      AdoptiumImplementation.Hotspot,
+      'os=mac&architecture=x64&image_type=jre&release_type=ga&jvm_impl=hotspot&page_size=20&page=0'
+    ],
+    [
+      { version: '16-ea', architecture: 'x64', packageType: 'jdk', checkLatest: false },
+      AdoptiumImplementation.Hotspot,
+      'os=mac&architecture=x64&image_type=jdk&release_type=ea&jvm_impl=hotspot&page_size=20&page=0'
+    ]
+  ])(
+    'build correct url for %s',
+    async (
+      installerOptions: JavaInstallerOptions,
+      impl: AdoptiumImplementation,
+      expectedParameters
+    ) => {
+      const distribution = new AdoptiumDistribution(installerOptions, impl);
+      const baseUrl = 'https://api.adoptium.net/v3/assets/version/%5B1.0,100.0%5D';
+      const expectedUrl = `${baseUrl}?project=jdk&vendor=adoptium&heap_size=normal&sort_method=DEFAULT&sort_order=DESC&${expectedParameters}`;
+      distribution['getPlatformOption'] = () => 'mac';
+
+      await distribution['getAvailableVersions']();
+
+      expect(spyHttpClient.mock.calls).toHaveLength(1);
+      expect(spyHttpClient.mock.calls[0][0]).toBe(expectedUrl);
+    }
+  );
+
+  it('load available versions', async () => {
+    spyHttpClient = jest.spyOn(HttpClient.prototype, 'getJson');
+    spyHttpClient
+      .mockReturnValueOnce({
+        statusCode: 200,
+        headers: {},
+        result: manifestData
+      })
+      .mockReturnValueOnce({
+        statusCode: 200,
+        headers: {},
+        result: manifestData
+      })
+      .mockReturnValueOnce({
+        statusCode: 200,
+        headers: {},
+        result: []
+      });
+
+    const distribution = new AdoptiumDistribution(
+      { version: '8', architecture: 'x64', packageType: 'jdk', checkLatest: false },
+      AdoptiumImplementation.Hotspot
+    );
+    const availableVersions = await distribution['getAvailableVersions']();
+    expect(availableVersions).not.toBeNull();
+    expect(availableVersions.length).toBe(manifestData.length * 2);
+  });
+
+  it.each([
+    [AdoptiumImplementation.Hotspot, 'jdk', 'Java_Adoptium-Hotspot_jdk'],
+    [AdoptiumImplementation.Hotspot, 'jre', 'Java_Adoptium-Hotspot_jre']
+  ])(
+    'find right toolchain folder',
+    (impl: AdoptiumImplementation, packageType: string, expected: string) => {
+      const distribution = new AdoptiumDistribution(
+        { version: '8', architecture: 'x64', packageType: packageType, checkLatest: false },
+        impl
+      );
+
+      // @ts-ignore - because it is protected
+      expect(distribution.toolcacheFolderName).toBe(expected);
+    }
+  );
+});
+
+describe('findPackageForDownload', () => {
+  it.each([
+    ['8', '8.0.302+8'],
+    ['16', '16.0.2+7'],
+    ['16.0', '16.0.2+7'],
+    ['16.0.2', '16.0.2+7'],
+    ['8.x', '8.0.302+8'],
+    ['x', '16.0.2+7']
+  ])('version is resolved correctly %s -> %s', async (input, expected) => {
+    const distribution = new AdoptiumDistribution(
+      { version: '8', architecture: 'x64', packageType: 'jdk', checkLatest: false },
+      AdoptiumImplementation.Hotspot
+    );
+    distribution['getAvailableVersions'] = async () => manifestData;
+    const resolvedVersion = await distribution['findPackageForDownload'](input);
+    expect(resolvedVersion.version).toBe(expected);
+  });
+
+  it('version is found but binaries list is empty', async () => {
+    const distribution = new AdoptiumDistribution(
+      { version: '9.0.8', architecture: 'x64', packageType: 'jdk', checkLatest: false },
+      AdoptiumImplementation.Hotspot
+    );
+    distribution['getAvailableVersions'] = async () => manifestData;
+    await expect(distribution['findPackageForDownload']('9.0.8')).rejects.toThrowError(
+      /Could not find satisfied version for SemVer */
+    );
+  });
+
+  it('version is not found', async () => {
+    const distribution = new AdoptiumDistribution(
+      { version: '7.x', architecture: 'x64', packageType: 'jdk', checkLatest: false },
+      AdoptiumImplementation.Hotspot
+    );
+    distribution['getAvailableVersions'] = async () => manifestData;
+    await expect(distribution['findPackageForDownload']('7.x')).rejects.toThrowError(
+      /Could not find satisfied version for SemVer */
+    );
+  });
+
+  it('version list is empty', async () => {
+    const distribution = new AdoptiumDistribution(
+      { version: '8', architecture: 'x64', packageType: 'jdk', checkLatest: false },
+      AdoptiumImplementation.Hotspot
+    );
+    distribution['getAvailableVersions'] = async () => [];
+    await expect(distribution['findPackageForDownload']('8')).rejects.toThrowError(
+      /Could not find satisfied version for SemVer */
+    );
+  });
+});

src/distributions/adoptium/installer.ts

@@ -0,0 +1,151 @@
+import * as core from '@actions/core';
+import * as tc from '@actions/tool-cache';
+
+import fs from 'fs';
+import path from 'path';
+import semver from 'semver';
+
+import { JavaBase } from '../base-installer';
+import { IAdoptiumAvailableVersions } from './models';
+import { JavaDownloadRelease, JavaInstallerOptions, JavaInstallerResults } from '../base-models';
+import { extractJdkFile, getDownloadArchiveExtension, isVersionSatisfies } from '../../util';
+
+export enum AdoptiumImplementation {
+  Hotspot = 'Hotspot'
+}
+
+export class AdoptiumDistribution extends JavaBase {
+  constructor(
+    installerOptions: JavaInstallerOptions,
+    private readonly jvmImpl: AdoptiumImplementation
+  ) {
+    super(`Adoptium-${jvmImpl}`, installerOptions);
+  }
+
+  protected async findPackageForDownload(version: string): Promise<JavaDownloadRelease> {
+    const availableVersionsRaw = await this.getAvailableVersions();
+    const availableVersionsWithBinaries = availableVersionsRaw
+      .filter(item => item.binaries.length > 0)
+      .map(item => {
+        return {
+          version: item.version_data.semver,
+          url: item.binaries[0].package.link
+        } as JavaDownloadRelease;
+      });
+
+    const satisfiedVersions = availableVersionsWithBinaries
+      .filter(item => isVersionSatisfies(version, item.version))
+      .sort((a, b) => {
+        return -semver.compareBuild(a.version, b.version);
+      });
+
+    const resolvedFullVersion = satisfiedVersions.length > 0 ? satisfiedVersions[0] : null;
+    if (!resolvedFullVersion) {
+      const availableOptions = availableVersionsWithBinaries.map(item => item.version).join(', ');
+      const availableOptionsMessage = availableOptions
+        ? `\nAvailable versions: ${availableOptions}`
+        : '';
+      throw new Error(
+        `Could not find satisfied version for SemVer '${version}'. ${availableOptionsMessage}`
+      );
+    }
+
+    return resolvedFullVersion;
+  }
+
+  protected async downloadTool(javaRelease: JavaDownloadRelease): Promise<JavaInstallerResults> {
+    let javaPath: string;
+    let extractedJavaPath: string;
+
+    core.info(
+      `Downloading Java ${javaRelease.version} (${this.distribution}) from ${javaRelease.url} ...`
+    );
+    const javaArchivePath = await tc.downloadTool(javaRelease.url);
+
+    core.info(`Extracting Java archive...`);
+    let extension = getDownloadArchiveExtension();
+
+    extractedJavaPath = await extractJdkFile(javaArchivePath, extension);
+
+    const archiveName = fs.readdirSync(extractedJavaPath)[0];
+    const archivePath = path.join(extractedJavaPath, archiveName);
+    const version = this.getToolcacheVersionName(javaRelease.version);
+
+    javaPath = await tc.cacheDir(archivePath, this.toolcacheFolderName, version, this.architecture);
+
+    return { version: javaRelease.version, path: javaPath };
+  }
+
+  protected get toolcacheFolderName(): string {
+    return super.toolcacheFolderName;
+  }
+
+  private async getAvailableVersions(): Promise<IAdoptiumAvailableVersions[]> {
+    const platform = this.getPlatformOption();
+    const arch = this.architecture;
+    const imageType = this.packageType;
+    const versionRange = encodeURI('[1.0,100.0]'); // retrieve all available versions
+    const releaseType = this.stable ? 'ga' : 'ea';
+
+    console.time('adoptium-retrieve-available-versions');
+
+    const baseRequestArguments = [
+      `project=jdk`,
+      'vendor=adoptium',
+      `heap_size=normal`,
+      'sort_method=DEFAULT',
+      'sort_order=DESC',
+      `os=${platform}`,
+      `architecture=${arch}`,
+      `image_type=${imageType}`,
+      `release_type=${releaseType}`,
+      `jvm_impl=${this.jvmImpl.toLowerCase()}`
+    ].join('&');
+
+    // need to iterate through all pages to retrieve the list of all versions
+    // Adoptium API doesn't provide way to retrieve the count of pages to iterate so infinity loop
+    let page_index = 0;
+    const availableVersions: IAdoptiumAvailableVersions[] = [];
+    while (true) {
+      const requestArguments = `${baseRequestArguments}&page_size=20&page=${page_index}`;
+      const availableVersionsUrl = `https://api.adoptium.net/v3/assets/version/${versionRange}?${requestArguments}`;
+      if (core.isDebug() && page_index === 0) {
+        // url is identical except page_index so print it once for debug
+        core.debug(`Gathering available versions from '${availableVersionsUrl}'`);
+      }
+
+      const paginationPage = (
+        await this.http.getJson<IAdoptiumAvailableVersions[]>(availableVersionsUrl)
+      ).result;
+      if (paginationPage === null || paginationPage.length === 0) {
+        // break infinity loop because we have reached end of pagination
+        break;
+      }
+
+      availableVersions.push(...paginationPage);
+      page_index++;
+    }
+
+    if (core.isDebug()) {
+      core.startGroup('Print information about available versions');
+      console.timeEnd('adoptium-retrieve-available-versions');
+      console.log(`Available versions: [${availableVersions.length}]`);
+      console.log(availableVersions.map(item => item.version_data.semver).join(', '));
+      core.endGroup();
+    }
+
+    return availableVersions;
+  }
+
+  private getPlatformOption(): string {
+    // Adoptium has own platform names so need to map them
+    switch (process.platform) {
+      case 'darwin':
+        return 'mac';
+      case 'win32':
+        return 'windows';
+      default:
+        return process.platform;
+    }
+  }
+}

src/distributions/adoptium/models.ts

@@ -0,0 +1,38 @@
+// Models from https://api.adoptium.net/q/swagger-ui/#/Assets/searchReleasesByVersion
+
+export interface IAdoptiumAvailableVersions {
+  binaries: [
+    {
+      architecture: string;
+      heap_size: string;
+      image_type: string;
+      jvm_impl: string;
+      os: string;
+      package: {
+        checksum: string;
+        checksum_link: string;
+        download_count: number;
+        link: string;
+        metadata_link: string;
+        name: string;
+        size: string;
+      };
+      project: string;
+      scm_ref: string;
+      updated_at: string;
+    }
+  ];
+  id: string;
+  release_link: string;
+  release_name: string;
+  release_type: string;
+  vendor: string;
+  version_data: {
+    build: number;
+    major: number;
+    minor: number;
+    openjdk_version: string;
+    security: string;
+    semver: string;
+  };
+}

src/distributions/distribution-factory.ts

@@ -3,11 +3,14 @@ import { JavaInstallerOptions } from './base-models';
 import { LocalDistribution } from './local/installer';
 import { ZuluDistribution } from './zulu/installer';
 import { AdoptDistribution, AdoptImplementation } from './adopt/installer';
+import { AdoptiumDistribution, AdoptiumImplementation } from './adoptium/installer';
 
 enum JavaDistribution {
   Adopt = 'adopt',
   AdoptHotspot = 'adopt-hotspot',
   AdoptOpenJ9 = 'adopt-openj9',
+  Adoptium = 'adoptium',
+  AdoptiumHotspot = 'adoptium-hotspot',
   Zulu = 'zulu',
   JdkFile = 'jdkfile'
 }
@@ -25,6 +28,9 @@ export function getJavaDistribution(
       return new AdoptDistribution(installerOptions, AdoptImplementation.Hotspot);
     case JavaDistribution.AdoptOpenJ9:
       return new AdoptDistribution(installerOptions, AdoptImplementation.OpenJ9);
+    case JavaDistribution.Adoptium:
+    case JavaDistribution.AdoptiumHotspot:
+      return new AdoptiumDistribution(installerOptions, AdoptiumImplementation.Hotspot);
     case JavaDistribution.Zulu:
       return new ZuluDistribution(installerOptions);
     default: