Add support for Liberica JDK (#225)

.github/workflows/e2e-versions.yml

@@ -20,7 +20,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [macos-latest, windows-latest, ubuntu-latest]
-        distribution: ['temurin', 'adopt', 'adopt-openj9', 'zulu'] # internally 'adopt-hotspot' is the same as 'adopt'
+        distribution: ['temurin', 'adopt', 'adopt-openj9', 'zulu', 'liberica'] # internally 'adopt-hotspot' is the same as 'adopt'
         version: ['8', '11', '16']
     steps:
       - name: Checkout
@@ -43,7 +43,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [macos-latest, windows-latest, ubuntu-latest]
-        distribution: ['temurin', 'zulu']
+        distribution: ['temurin', 'zulu', 'liberica']
         version:
         - '11.0'
         - '8.0.302'
@@ -69,7 +69,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [macos-latest, windows-latest, ubuntu-latest]
-        distribution: ['temurin', 'zulu']
+        distribution: ['temurin', 'zulu', 'liberica']
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -136,7 +136,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [macos-latest, windows-latest, ubuntu-latest]
-        distribution: ['temurin', 'zulu']
+        distribution: ['temurin', 'zulu', 'liberica']
         java-package: ['jre']
         version: ['16.0']
         include:
@@ -148,6 +148,14 @@ jobs:
             java-package: jdk+fx
             version: '8.0.242'
             os: ubuntu-latest
+          - distribution: 'liberica'
+            java-package: jdk+fx
+            version: '8'
+            os: ubuntu-latest
+          - distribution: 'liberica'
+            java-package: jre+fx
+            version: '11'
+            os: ubuntu-latest
         exclude:
           # Eclipse Temurin currently doesn't publish JREs, only JDKs
           - distribution: 'temurin'
@@ -173,9 +181,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        # Only Zulu provides x86 arch for now and only for windows / ubuntu
+        # Only Zulu and Liberica provides x86 arch for now and only for windows / ubuntu
         os: [windows-latest, ubuntu-latest]
-        distribution: ['zulu']
+        distribution: ['zulu', 'liberica']
         version: ['11']
     steps:
       - name: Checkout

README.md

@@ -57,7 +57,8 @@ Currently, the following distributions are supported:
 | `temurin` | Eclipse Temurin | [Link](https://adoptium.net/) | [Link](https://adoptium.net/about.html)
 | `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)
+| `adopt-openj9` | Adopt OpenJDK OpenJ9 | [Link](https://adoptopenjdk.net/) | [Link](https://adoptopenjdk.net/about.html) |
+| `liberica` | Liberica JDK | [Link](https://bell-sw.com/) | [Link](https://bell-sw.com/liberica_eula/) |
 
 **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.
 
@@ -134,6 +135,7 @@ jobs:
   - [Eclipse Temurin](docs/advanced-usage.md#Eclipse-Temurin)
   - [Adopt](docs/advanced-usage.md#Adopt)
   - [Zulu](docs/advanced-usage.md#Zulu)
+  - [Liberica](docs/advanced-usage.md#Liberica)
 - [Installing custom Java package type](docs/advanced-usage.md#Installing-custom-Java-package-type)
 - [Installing custom Java architecture](docs/advanced-usage.md#Installing-custom-Java-architecture)
 - [Installing custom Java distribution from local file](docs/advanced-usage.md#Installing-Java-from-local-file)

__tests__/distributors/liberica-installer.test.ts

@@ -0,0 +1,196 @@
+import { LibericaDistributions } from '../../src/distributions/liberica/installer';
+import { ArchitectureOptions, LibericaVersion } from '../../src/distributions/liberica/models';
+import { HttpClient } from '@actions/http-client';
+
+const manifestData = require('../data/liberica.json') as LibericaVersion[];
+
+describe('getAvailableVersions', () => {
+  let spyHttpClient: jest.SpyInstance;
+
+  beforeEach(() => {
+    spyHttpClient = jest.spyOn(HttpClient.prototype, 'getJson');
+    spyHttpClient.mockReturnValue({
+      statusCode: 200,
+      headers: {},
+      result: manifestData
+    });
+  });
+
+  afterEach(() => {
+    jest.resetAllMocks();
+    jest.clearAllMocks();
+    jest.restoreAllMocks();
+  });
+
+  it.each([
+    [
+      { version: '11.x', architecture: 'x86', packageType: 'jdk', checkLatest: false },
+      'bundle-type=jdk&bitness=32&arch=x86&build-type=all'
+    ],
+    [
+      { version: '11-ea', architecture: 'x86', packageType: 'jdk', checkLatest: false },
+      'bundle-type=jdk&bitness=32&arch=x86&build-type=ea'
+    ],
+    [
+      { version: '16.0.2', architecture: 'x64', packageType: 'jdk', checkLatest: false },
+      'bundle-type=jdk&bitness=64&arch=x86&build-type=all'
+    ],
+    [
+      { version: '16.0.2', architecture: 'x64', packageType: 'jre', checkLatest: false },
+      'bundle-type=jre&bitness=64&arch=x86&build-type=all'
+    ],
+    [
+      { version: '8', architecture: 'armv7', packageType: 'jdk+fx', checkLatest: false },
+      'bundle-type=jdk-full&bitness=32&arch=arm&build-type=all'
+    ],
+    [
+      { version: '8', architecture: 'aarch64', packageType: 'jre+fx', checkLatest: false },
+      'bundle-type=jre-full&bitness=64&arch=arm&build-type=all'
+    ]
+  ])('build correct url for %s -> %s', async (input, urlParams) => {
+    const additionalParams =
+      '&installation-type=archive&fields=downloadUrl%2Cversion%2CfeatureVersion%2CinterimVersion%2C' +
+      'updateVersion%2CbuildVersion';
+    const distribution = new LibericaDistributions(input);
+    distribution['getPlatformOption'] = () => 'macos';
+    const buildUrl = `https://api.bell-sw.com/v1/liberica/releases?os=macos&${urlParams}${additionalParams}`;
+
+    await distribution['getAvailableVersions']();
+
+    expect(spyHttpClient.mock.calls).toHaveLength(1);
+    expect(spyHttpClient.mock.calls[0][0]).toBe(buildUrl);
+  });
+
+  it('load available versions', async () => {
+    const distribution = new LibericaDistributions({
+      version: '11',
+      architecture: 'x64',
+      packageType: 'jdk',
+      checkLatest: false
+    });
+    const availableVersions = await distribution['getAvailableVersions']();
+    expect(availableVersions).toEqual(manifestData);
+  });
+});
+
+describe('getArchitectureOptions', () => {
+  it.each([
+    ['x86', { bitness: '32', arch: 'x86' }],
+    ['x64', { bitness: '64', arch: 'x86' }],
+    ['armv7', { bitness: '32', arch: 'arm' }],
+    ['aarch64', { bitness: '64', arch: 'arm' }],
+    ['ppc64le', { bitness: '64', arch: 'ppc' }]
+  ] as [string, ArchitectureOptions][])('parse architecture %s -> %s', (input, expected) => {
+    const distributions = new LibericaDistributions({
+      architecture: input,
+      checkLatest: false,
+      packageType: '',
+      version: ''
+    });
+
+    expect(distributions['getArchitectureOptions']()).toEqual(expected);
+  });
+
+  it.each(['armv6', 's390x'])('not support architecture %s', input => {
+    const distributions = new LibericaDistributions({
+      architecture: input,
+      checkLatest: false,
+      packageType: '',
+      version: ''
+    });
+
+    expect(() => distributions['getArchitectureOptions']()).toThrow(
+      /Architecture '\w+' is not supported\. Supported architectures: .*/
+    );
+  });
+});
+
+describe('findPackageForDownload', () => {
+  let distribution: LibericaDistributions;
+
+  beforeEach(() => {
+    distribution = new LibericaDistributions({
+      version: '',
+      architecture: 'x64',
+      packageType: 'jdk',
+      checkLatest: false
+    });
+    distribution['getAvailableVersions'] = async () => manifestData;
+  });
+
+  it.each([
+    ['8', '8.0.302+8'],
+    ['11.x', '11.0.12+7'],
+    ['8.0', '8.0.302+8'],
+    ['11.0.x', '11.0.12+7'],
+    ['15', '15.0.2+10'],
+    ['15.0', '15.0.2+10'],
+    ['15.0.0', '15.0.0+36'],
+    ['8.0.232', '8.0.232+10'],
+    ['8.0.232+9', '8.0.232+9'],
+    ['15.0.2+8', '15.0.2+8'],
+    ['15.0.2+10', '15.0.2+10']
+  ])('version is %s -> %s', async (input, expected) => {
+    const result = await distribution['findPackageForDownload'](input);
+    expect(result.version).toBe(expected);
+  });
+
+  it('should throw an error', async () => {
+    await expect(distribution['findPackageForDownload']('17')).rejects.toThrow(
+      /Could not find satisfied version for semver */
+    );
+  });
+});
+
+describe('getPlatformOption', () => {
+  const distributions = new LibericaDistributions({
+    architecture: 'x64',
+    version: '11',
+    packageType: 'jdk',
+    checkLatest: false
+  });
+
+  it.each([
+    ['linux', 'linux'],
+    ['darwin', 'macos'],
+    ['win32', 'windows'],
+    ['cygwin', 'windows'],
+    ['sunos', 'solaris']
+  ])('os version %s -> %s', (input, expected) => {
+    const actual = distributions['getPlatformOption'](input as NodeJS.Platform);
+
+    expect(actual).toEqual(expected);
+  });
+
+  it.each(['aix', 'android', 'freebsd', 'openbsd', 'netbsd'])(
+    'not support os version %s',
+    input => {
+      expect(() => distributions['getPlatformOption'](input as NodeJS.Platform)).toThrow(
+        /Platform '\w+' is not supported\. Supported platforms: .+/
+      );
+    }
+  );
+});
+
+describe('convertVersionToSemver', () => {
+  const distributions = new LibericaDistributions({
+    architecture: 'x64',
+    version: '11',
+    packageType: 'jdk',
+    checkLatest: false
+  });
+
+  it.each([
+    [{ featureVersion: 11, interimVersion: 0, updateVersion: 12, buildVersion: 7 }, '11.0.12+7'],
+    [{ featureVersion: 11, interimVersion: 0, updateVersion: 12, buildVersion: 0 }, '11.0.12'],
+    [{ featureVersion: 11, interimVersion: 0, updateVersion: 0, buildVersion: 13 }, '11.0.0+13']
+  ])('%s -> %s', (input, expected) => {
+    const actual = distributions['convertVersionToSemver']({
+      downloadUrl: '',
+      version: '',
+      ...input
+    });
+
+    expect(actual).toEqual(expected);
+  });
+});

docs/advanced-usage.md

@@ -53,6 +53,18 @@ steps:
 - run: java -cp java HelloWorldApp
 ```
 
+### Liberica
+```yaml
+steps:
+- uses: actions/checkout@v2
+- uses: actions/setup-java@v2
+  with:
+    distribution: 'liberica'
+    java-version: '11'
+    java-package: jdk # optional (jdk, jre, jdk+fx or jre+fx) - defaults to jdk
+- run: java -cp java HelloWorldApp
+```
+
 ## Installing custom Java package type
 ```yaml
 steps:

src/distributions/distribution-factory.ts

@@ -4,6 +4,7 @@ import { LocalDistribution } from './local/installer';
 import { ZuluDistribution } from './zulu/installer';
 import { AdoptDistribution, AdoptImplementation } from './adopt/installer';
 import { TemurinDistribution, TemurinImplementation } from './temurin/installer';
+import { LibericaDistributions } from './liberica/installer';
 
 enum JavaDistribution {
   Adopt = 'adopt',
@@ -11,6 +12,7 @@ enum JavaDistribution {
   AdoptOpenJ9 = 'adopt-openj9',
   Temurin = 'temurin',
   Zulu = 'zulu',
+  Liberica = 'liberica',
   JdkFile = 'jdkfile'
 }
 
@@ -31,6 +33,8 @@ export function getJavaDistribution(
       return new TemurinDistribution(installerOptions, TemurinImplementation.Hotspot);
     case JavaDistribution.Zulu:
       return new ZuluDistribution(installerOptions);
+    case JavaDistribution.Liberica:
+      return new LibericaDistributions(installerOptions);
     default:
       return null;
   }

src/distributions/liberica/installer.ts

@@ -0,0 +1,157 @@
+import { JavaBase } from '../base-installer';
+import { JavaDownloadRelease, JavaInstallerOptions, JavaInstallerResults } from '../base-models';
+import semver from 'semver';
+import { extractJdkFile, getDownloadArchiveExtension, isVersionSatisfies } from '../../util';
+import * as core from '@actions/core';
+import { ArchitectureOptions, LibericaVersion, OsVersions } from './models';
+import * as tc from '@actions/tool-cache';
+import fs from 'fs';
+import path from 'path';
+
+const supportedPlatform = `'linux', 'linux-musl', 'macos', 'solaris', 'windows'`;
+
+const supportedArchitecture = `'x86', 'x64', 'armv7', 'aarch64', 'ppc64le'`;
+
+export class LibericaDistributions extends JavaBase {
+  constructor(installerOptions: JavaInstallerOptions) {
+    super('Liberica', installerOptions);
+  }
+
+  protected async downloadTool(javaRelease: JavaDownloadRelease): Promise<JavaInstallerResults> {
+    core.info(
+      `Downloading Java ${javaRelease.version} (${this.distribution}) from ${javaRelease.url} ...`
+    );
+    const javaArchivePath = await tc.downloadTool(javaRelease.url);
+
+    core.info(`Extracting Java archive...`);
+    const extension = getDownloadArchiveExtension();
+    const extractedJavaPath = await extractJdkFile(javaArchivePath, extension);
+
+    const archiveName = fs.readdirSync(extractedJavaPath)[0];
+    const archivePath = path.join(extractedJavaPath, archiveName);
+
+    const javaPath = await tc.cacheDir(
+      archivePath,
+      this.toolcacheFolderName,
+      this.getToolcacheVersionName(javaRelease.version),
+      this.architecture
+    );
+
+    return { version: javaRelease.version, path: javaPath };
+  }
+
+  protected async findPackageForDownload(range: string): Promise<JavaDownloadRelease> {
+    const availableVersionsRaw = await this.getAvailableVersions();
+
+    const availableVersions = availableVersionsRaw.map(item => ({
+      url: item.downloadUrl,
+      version: this.convertVersionToSemver(item)
+    }));
+
+    const satisfiedVersion = availableVersions
+      .filter(item => isVersionSatisfies(range, item.version))
+      .sort((a, b) => -semver.compareBuild(a.version, b.version))[0];
+
+    if (!satisfiedVersion) {
+      const availableOptions = availableVersions.map(item => item.version).join(', ');
+      const availableOptionsMessage = availableOptions
+        ? `\nAvailable versions: ${availableOptions}`
+        : '';
+      throw new Error(
+        `Could not find satisfied version for semver ${range}. ${availableOptionsMessage}`
+      );
+    }
+
+    return satisfiedVersion;
+  }
+
+  private async getAvailableVersions(): Promise<LibericaVersion[]> {
+    console.time('liberica-retrieve-available-versions');
+    const url = this.prepareAvailableVersionsUrl();
+
+    if (core.isDebug()) {
+      core.debug(`Gathering available versions from '${url}'`);
+    }
+
+    const availableVersions = (await this.http.getJson<LibericaVersion[]>(url)).result ?? [];
+
+    if (core.isDebug()) {
+      core.startGroup('Print information about available versions');
+      console.timeEnd('liberica-retrieve-available-versions');
+      console.log(`Available versions: [${availableVersions.length}]`);
+      console.log(availableVersions.map(item => item.version));
+      core.endGroup();
+    }
+
+    return availableVersions;
+  }
+
+  private prepareAvailableVersionsUrl() {
+    const urlOptions = {
+      os: this.getPlatformOption(),
+      'bundle-type': this.getBundleType(),
+      ...this.getArchitectureOptions(),
+      'build-type': this.stable ? 'all' : 'ea',
+      'installation-type': 'archive',
+      fields: 'downloadUrl,version,featureVersion,interimVersion,updateVersion,buildVersion'
+    };
+
+    const searchParams = new URLSearchParams(urlOptions).toString();
+
+    return `https://api.bell-sw.com/v1/liberica/releases?${searchParams}`;
+  }
+
+  private getBundleType(): string {
+    const [bundleType, feature] = this.packageType.split('+');
+    if (feature?.includes('fx')) {
+      return bundleType + '-full';
+    }
+    return bundleType;
+  }
+
+  private getArchitectureOptions(): ArchitectureOptions {
+    switch (this.architecture) {
+      case 'x86':
+        return { bitness: '32', arch: 'x86' };
+      case 'x64':
+        return { bitness: '64', arch: 'x86' };
+      case 'armv7':
+        return { bitness: '32', arch: 'arm' };
+      case 'aarch64':
+        return { bitness: '64', arch: 'arm' };
+      case 'ppc64le':
+        return { bitness: '64', arch: 'ppc' };
+      default:
+        throw new Error(
+          `Architecture '${this.architecture}' is not supported. Supported architectures: ${supportedArchitecture}`
+        );
+    }
+  }
+
+  private getPlatformOption(platform: NodeJS.Platform = process.platform): OsVersions {
+    switch (platform) {
+      case 'darwin':
+        return 'macos';
+      case 'win32':
+      case 'cygwin':
+        return 'windows';
+      case 'linux':
+        return 'linux';
+      case 'sunos':
+        return 'solaris';
+      default:
+        throw new Error(
+          `Platform '${platform}' is not supported. Supported platforms: ${supportedPlatform}`
+        );
+    }
+  }
+
+  private convertVersionToSemver(version: LibericaVersion): string {
+    let { buildVersion, featureVersion, interimVersion, updateVersion } = version;
+    const mainVersion = [featureVersion, interimVersion, updateVersion].join('.');
+    if (buildVersion != 0) {
+      return `${mainVersion}+${buildVersion}`;
+    }
+    return mainVersion;
+  }
+}

src/distributions/liberica/models.ts

@@ -0,0 +1,20 @@
+// Models from https://api.bell-sw.com/api.html
+
+export type Bitness = '32' | '64';
+export type ArchType = 'arm' | 'ppc' | 'sparc' | 'x86';
+
+export type OsVersions = 'linux' | 'linux-musl' | 'macos' | 'solaris' | 'windows';
+
+export interface ArchitectureOptions {
+  bitness: Bitness;
+  arch: ArchType;
+}
+
+export interface LibericaVersion {
+  downloadUrl: string;
+  version: string;
+  featureVersion: number;
+  interimVersion: number;
+  updateVersion: number;
+  buildVersion: number;
+}