add support for dragonwell (#532)

* add support for dragonwell

* fix: update logic of parsing json file, refactor code

* build: rebuild action

* chore: update error message

* build: rebuild action

* tests: fix unit tests, add e2e tests

* chore: prettier, lint and rebuild solution

* feat: add check for the package type, update unit tests

* tests: update e2e tests

* tests: remove excess entries from e2e tests

* feat: update logic of getting json file

* feat: add logic for backuping getting json

* chore: update wordings

* chore: fix typos, add additional logs

* fix: fix review points

* chore: rebuild solution

* chore: update wordings

* chore: refactor code

---------

Co-authored-by: Ivan Zosimov <ivanzosimov@github.com>
Co-authored-by: Ivan <98037481+IvanZosimov@users.noreply.github.com>

src/distributions/distribution-factory.ts

@@ -9,6 +9,7 @@ import {MicrosoftDistributions} from './microsoft/installer';
 import {SemeruDistribution} from './semeru/installer';
 import {CorrettoDistribution} from './corretto/installer';
 import {OracleDistribution} from './oracle/installer';
+import {DragonwellDistribution} from './dragonwell/installer';
 
 enum JavaDistribution {
   Adopt = 'adopt',
@@ -21,7 +22,8 @@ enum JavaDistribution {
   Microsoft = 'microsoft',
   Semeru = 'semeru',
   Corretto = 'corretto',
-  Oracle = 'oracle'
+  Oracle = 'oracle',
+  Dragonwell = 'dragonwell'
 }
 
 export function getJavaDistribution(
@@ -60,6 +62,8 @@ export function getJavaDistribution(
       return new CorrettoDistribution(installerOptions);
     case JavaDistribution.Oracle:
       return new OracleDistribution(installerOptions);
+    case JavaDistribution.Dragonwell:
+      return new DragonwellDistribution(installerOptions);
     default:
       return null;
   }

src/distributions/dragonwell/installer.ts

@@ -0,0 +1,240 @@
+import * as core from '@actions/core';
+import * as tc from '@actions/tool-cache';
+import semver from 'semver';
+
+import fs from 'fs';
+import path from 'path';
+
+import {JavaBase} from '../base-installer';
+import {
+  convertVersionToSemver,
+  extractJdkFile,
+  getDownloadArchiveExtension,
+  getGitHubHttpHeaders,
+  isVersionSatisfies
+} from '../../util';
+import {IDragonwellVersions, IDragonwellAllVersions} from './models';
+import {
+  JavaDownloadRelease,
+  JavaInstallerOptions,
+  JavaInstallerResults
+} from '../base-models';
+
+export class DragonwellDistribution extends JavaBase {
+  constructor(installerOptions: JavaInstallerOptions) {
+    super('Dragonwell', installerOptions);
+  }
+
+  protected async findPackageForDownload(
+    version: string
+  ): Promise<JavaDownloadRelease> {
+    if (!this.stable) {
+      throw new Error('Early access versions are not supported by Dragonwell');
+    }
+
+    if (this.packageType !== 'jdk') {
+      throw new Error('Dragonwell provides only the `jdk` package type');
+    }
+
+    const availableVersions = await this.getAvailableVersions();
+
+    const matchedVersions = availableVersions
+      .filter(item => {
+        return isVersionSatisfies(version, item.jdk_version);
+      })
+      .map(item => {
+        return {
+          version: item.jdk_version,
+          url: item.download_link
+        } as JavaDownloadRelease;
+      });
+
+    if (!matchedVersions.length) {
+      throw new Error(
+        `Couldn't find any satisfied version for the specified java-version: "${version}" and architecture: "${this.architecture}".`
+      );
+    }
+
+    const resolvedVersion = matchedVersions[0];
+    return resolvedVersion;
+  }
+
+  private async getAvailableVersions(): Promise<IDragonwellVersions[]> {
+    const platform = this.getPlatformOption();
+    const arch = this.distributionArchitecture();
+
+    let fetchedDragonwellJson = await this.fetchJsonFromPrimaryUrl();
+
+    if (!fetchedDragonwellJson) {
+      fetchedDragonwellJson = await this.fetchJsonFromBackupUrl();
+    }
+
+    if (!fetchedDragonwellJson) {
+      throw new Error(
+        `Couldn't fetch Dragonwell versions information from both primary and backup urls`
+      );
+    }
+
+    core.debug(
+      'Successfully fetched information about available Dragonwell versions'
+    );
+
+    const availableVersions = this.parseVersions(
+      platform,
+      arch,
+      fetchedDragonwellJson
+    );
+
+    if (core.isDebug()) {
+      core.startGroup('Print information about available versions');
+      core.debug(availableVersions.map(item => item.jdk_version).join(', '));
+      core.endGroup();
+    }
+
+    return availableVersions;
+  }
+
+  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 extractedJavaPath = await extractJdkFile(
+      javaArchivePath,
+      getDownloadArchiveExtension()
+    );
+
+    const archiveName = fs.readdirSync(extractedJavaPath)[0];
+    const archivePath = path.join(extractedJavaPath, archiveName);
+    const version = this.getToolcacheVersionName(javaRelease.version);
+
+    const javaPath = await tc.cacheDir(
+      archivePath,
+      this.toolcacheFolderName,
+      version,
+      this.architecture
+    );
+
+    return {version: javaRelease.version, path: javaPath};
+  }
+
+  private parseVersions(
+    platform: string,
+    arch: string,
+    dragonwellVersions: IDragonwellAllVersions
+  ): IDragonwellVersions[] {
+    const eligibleVersions: IDragonwellVersions[] = [];
+
+    for (const majorVersion in dragonwellVersions) {
+      const majorVersionMap = dragonwellVersions[majorVersion];
+      for (let jdkVersion in majorVersionMap) {
+        const jdkVersionMap = majorVersionMap[jdkVersion];
+        if (!(platform in jdkVersionMap)) {
+          continue;
+        }
+        const platformMap = jdkVersionMap[platform];
+        if (!(arch in platformMap)) {
+          continue;
+        }
+        const archMap = platformMap[arch];
+
+        if (jdkVersion === 'latest') {
+          continue;
+        }
+
+        // Some version of Dragonwell JDK are numerated with help of non-semver notation (more then 3 digits).
+        // Common practice is to transform excess digits to the so-called semver build part, which is prefixed with the plus sign, to be able to operate with them using semver tools.
+        if (jdkVersion.split('.').length > 3) {
+          jdkVersion = convertVersionToSemver(jdkVersion);
+        }
+
+        for (const edition in archMap) {
+          eligibleVersions.push({
+            os: platform,
+            architecture: arch,
+            jdk_version: jdkVersion,
+            checksum: archMap[edition].sha256 ?? '',
+            download_link: archMap[edition].download_url,
+            edition: edition,
+            image_type: 'jdk'
+          });
+          break; // Get the first available link to the JDK. In most cases it should point to the Extended version of JDK, in rare cases like with v17 it points to the Standard version (the only available).
+        }
+      }
+    }
+
+    const sortedVersions = this.sortParsedVersions(eligibleVersions);
+
+    return sortedVersions;
+  }
+
+  // Sorts versions in descending order as by default data in JSON isn't sorted
+  private sortParsedVersions(
+    eligibleVersions: IDragonwellVersions[]
+  ): IDragonwellVersions[] {
+    const sortedVersions = eligibleVersions.sort((versionObj1, versionObj2) => {
+      const version1 = versionObj1.jdk_version;
+      const version2 = versionObj2.jdk_version;
+      return semver.compareBuild(version1, version2);
+    });
+    return sortedVersions.reverse();
+  }
+
+  private getPlatformOption(): string {
+    switch (process.platform) {
+      case 'win32':
+        return 'windows';
+      default:
+        return process.platform;
+    }
+  }
+
+  private async fetchJsonFromPrimaryUrl(): Promise<IDragonwellAllVersions | null> {
+    const primaryUrl = 'https://dragonwell-jdk.io/map_with_checksum.json';
+    try {
+      core.debug(
+        `Trying to fetch available Dragonwell versions info from the primary url: ${primaryUrl}`
+      );
+      const fetchedDragonwellJson = (
+        await this.http.getJson<IDragonwellAllVersions>(primaryUrl)
+      ).result;
+      return fetchedDragonwellJson;
+    } catch (err) {
+      core.debug(
+        `Fetching Dragonwell versions info from the primary link: ${primaryUrl} ended up with the error: ${err.message}`
+      );
+      return null;
+    }
+  }
+
+  private async fetchJsonFromBackupUrl(): Promise<IDragonwellAllVersions | null> {
+    const owner = 'dragonwell-releng';
+    const repository = 'dragonwell-setup-java';
+    const branch = 'main';
+    const filePath = 'releases.json';
+
+    const backupUrl = `https://api.github.com/repos/${owner}/${repository}/contents/${filePath}?ref=${branch}`;
+
+    const headers = getGitHubHttpHeaders();
+
+    try {
+      core.debug(
+        `Trying to fetch available Dragonwell versions info from the backup url: ${backupUrl}`
+      );
+      const fetchedDragonwellJson = (
+        await this.http.getJson<IDragonwellAllVersions>(backupUrl, headers)
+      ).result;
+      return fetchedDragonwellJson;
+    } catch (err) {
+      core.debug(
+        `Fetching Dragonwell versions info from the backup url: ${backupUrl} ended up with the error: ${err.message}`
+      );
+      return null;
+    }
+  }
+}

src/distributions/dragonwell/models.ts

@@ -0,0 +1,26 @@
+export interface IDragonwellAllVersions {
+  [major: string]: {
+    [jdk_version: string]: {
+      [os: string]: {
+        [arch: string]: {
+          [edition: string]: {
+            content_type: string;
+            sha256: string;
+            name: string;
+            download_url: string;
+          };
+        };
+      };
+    };
+  };
+}
+
+export interface IDragonwellVersions {
+  os: string;
+  architecture: string;
+  jdk_version: string;
+  checksum: string;
+  download_link: string;
+  edition: string;
+  image_type: string;
+}

src/distributions/microsoft/installer.ts

@@ -4,10 +4,13 @@ import {
   JavaInstallerOptions,
   JavaInstallerResults
 } from '../base-models';
-import {extractJdkFile, getDownloadArchiveExtension} from '../../util';
+import {
+  extractJdkFile,
+  getDownloadArchiveExtension,
+  getGitHubHttpHeaders
+} from '../../util';
 import * as core from '@actions/core';
 import * as tc from '@actions/tool-cache';
-import {OutgoingHttpHeaders} from 'http';
 import fs from 'fs';
 import path from 'path';
 import {ITypedResponse} from '@actions/http-client/interfaces';
@@ -85,8 +88,6 @@ export class MicrosoftDistributions extends JavaBase {
   private async getAvailableVersions(): Promise<tc.IToolRelease[] | null> {
     // TODO get these dynamically!
     // We will need Microsoft to add an endpoint where we can query for versions.
-    const token = core.getInput('token');
-    const auth = !token ? undefined : `token ${token}`;
     const owner = 'actions';
     const repository = 'setup-java';
     const branch = 'main';
@@ -96,10 +97,7 @@ export class MicrosoftDistributions extends JavaBase {
     let releases: tc.IToolRelease[] | null = null;
     const fileUrl = `https://api.github.com/repos/${owner}/${repository}/contents/${filePath}?ref=${branch}`;
 
-    const headers: OutgoingHttpHeaders = {
-      authorization: auth,
-      accept: 'application/vnd.github.VERSION.raw'
-    };
+    const headers = getGitHubHttpHeaders();
 
     let response: ITypedResponse<tc.IToolRelease[]> | null = null;
 

src/util.ts

@@ -7,6 +7,7 @@ import * as core from '@actions/core';
 
 import * as tc from '@actions/tool-cache';
 import {INPUT_JOB_STATUS, DISTRIBUTIONS_ONLY_MAJOR_VERSION} from './constants';
+import {OutgoingHttpHeaders} from 'http';
 
 export function getTempDir() {
   const tempDirectory = process.env['RUNNER_TEMP'] || os.tmpdir();
@@ -161,3 +162,13 @@ export function convertVersionToSemver(version: number[] | string) {
   }
   return mainVersion;
 }
+
+export function getGitHubHttpHeaders(): OutgoingHttpHeaders {
+  const token = core.getInput('token');
+  const auth = !token ? undefined : `token ${token}`;
+  const headers: OutgoingHttpHeaders = {
+    authorization: auth,
+    accept: 'application/vnd.github.VERSION.raw'
+  };
+  return headers;
+}