Default to runner architecture (actions#376)

yeikel · Feb 12, 2023 · a0ed1ae · a0ed1ae
1 parent f3ad745
commit a0ed1ae
Show file tree

Hide file tree

Showing 16 changed files with 303 additions and 42 deletions.
diff --git a/__tests__/distributors/adopt-installer.test.ts b/__tests__/distributors/adopt-installer.test.ts
@@ -3,6 +3,8 @@ import { HttpClient } from '@actions/http-client';
 import { AdoptDistribution, AdoptImplementation } from '../../src/distributions/adopt/installer';
 import { JavaInstallerOptions } from '../../src/distributions/base-models';
 
+import os from 'os';
+
 let manifestData = require('../data/adopt.json') as [];
 
 describe('getAvailableVersions', () => {
@@ -128,6 +130,35 @@ describe('getAvailableVersions', () => {
       expect(distribution.toolcacheFolderName).toBe(expected);
     }
   );
+
+  it.each([
+    ['amd64', 'x64'],
+    ['arm64', 'aarch64']
+  ])(
+    'defaults to os.arch(): %s mapped to distro arch: %s',
+    async (osArch: string, distroArch: string) => {
+      jest.spyOn(os, 'arch').mockReturnValue(osArch);
+
+      const installerOptions: JavaInstallerOptions = {
+        version: '17',
+        architecture: '', // to get default value
+        packageType: 'jdk',
+        checkLatest: false
+      };
+
+      const expectedParameters = `os=mac&architecture=${distroArch}&image_type=jdk&release_type=ga&jvm_impl=hotspot&page_size=20&page=0`;
+
+      const distribution = new AdoptDistribution(installerOptions, AdoptImplementation.Hotspot);
+      const baseUrl = 'https://api.adoptopenjdk.net/v3/assets/version/%5B1.0,100.0%5D';
+      const expectedUrl = `${baseUrl}?project=jdk&vendor=adoptopenjdk&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);
+    }
+  );
 });
 
 describe('findPackageForDownload', () => {

diff --git a/__tests__/distributors/base-installer.test.ts b/__tests__/distributors/base-installer.test.ts
@@ -12,6 +12,8 @@ import {
   JavaInstallerResults
 } from '../../src/distributions/base-models';
 
+import os from 'os';
+
 class EmptyJavaBase extends JavaBase {
   constructor(installerOptions: JavaInstallerOptions) {
     super('Empty', installerOptions);
@@ -192,6 +194,8 @@ describe('setupJava', () => {
 
     spyCoreSetOutput = jest.spyOn(core, 'setOutput');
     spyCoreSetOutput.mockImplementation(() => undefined);
+
+    jest.spyOn(os, 'arch').mockReturnValue('x86');
   });
 
   afterEach(() => {
@@ -212,6 +216,10 @@ describe('setupJava', () => {
     [
       { version: '11.0.8', architecture: 'x86', packageType: 'jdk', checkLatest: false },
       { version: installedJavaVersion, path: javaPath }
+    ],
+    [
+      { version: '11', architecture: '', packageType: 'jdk', checkLatest: false },
+      { version: installedJavaVersion, path: javaPath }
     ]
   ])('should find java locally for %s', (input, expected) => {
     mockJavaBase = new EmptyJavaBase(input);
@@ -237,6 +245,10 @@ describe('setupJava', () => {
     [
       { version: '11', architecture: 'x64', packageType: 'jre', checkLatest: false },
       { path: path.join('toolcache', 'Java_Empty_jre', '11.0.9', 'x64'), version: '11.0.9' }
+    ],
+    [
+      { version: '11', architecture: '', packageType: 'jre', checkLatest: false },
+      { path: path.join('toolcache', 'Java_Empty_jre', '11.0.9', 'x86'), version: '11.0.9' }
     ]
   ])('download java with configuration %s', async (input, expected) => {
     mockJavaBase = new EmptyJavaBase(input);
@@ -245,7 +257,7 @@ describe('setupJava', () => {
     expect(spyCoreAddPath).toHaveBeenCalled();
     expect(spyCoreExportVariable).toHaveBeenCalled();
     expect(spyCoreExportVariable).toHaveBeenCalledWith(
-      `JAVA_HOME_${input.version}_${input.architecture.toLocaleUpperCase()}`,
+      `JAVA_HOME_${input.version}_${(input.architecture || 'x86').toLocaleUpperCase()}`,
       expected.path
     );
     expect(spyCoreSetOutput).toHaveBeenCalled();
@@ -260,6 +272,10 @@ describe('setupJava', () => {
     [
       { version: '11.0.9', architecture: 'x86', packageType: 'jdk', checkLatest: true },
       { version: '11.0.9', path: javaPathInstalled }
+    ],
+    [
+      { version: '11.0.9', architecture: '', packageType: 'jdk', checkLatest: true },
+      { version: '11.0.9', path: javaPathInstalled }
     ]
   ])('should check the latest java version for %s and resolve locally', async (input, expected) => {
     mockJavaBase = new EmptyJavaBase(input);
@@ -283,6 +299,10 @@ describe('setupJava', () => {
     [
       { version: '11.0.x', architecture: 'x86', packageType: 'jdk', checkLatest: true },
       { version: actualJavaVersion, path: javaPathInstalled }
+    ],
+    [
+      { version: '11', architecture: '', packageType: 'jdk', checkLatest: true },
+      { version: actualJavaVersion, path: javaPathInstalled }
     ]
   ])('should check the latest java version for %s and download', async (input, expected) => {
     mockJavaBase = new EmptyJavaBase(input);

diff --git a/__tests__/distributors/corretto-installer.test.ts b/__tests__/distributors/corretto-installer.test.ts
@@ -3,6 +3,8 @@ import { JavaInstallerOptions } from '../../src/distributions/base-models';
 
 import { CorrettoDistribution } from '../../src/distributions/corretto/installer';
 import * as util from '../../src/util';
+import os from 'os';
+import { isGeneratorFunction } from 'util/types';
 
 const manifestData = require('../data/corretto.json') as [];
 
@@ -142,6 +144,33 @@ describe('getAvailableVersions', () => {
         "Could not find satisfied version for SemVer '4'"
       );
     });
+
+    it.each([
+      ['arm64', 'aarch64'],
+      ['amd64', 'x64']
+    ])(
+      'defaults to os.arch(): %s mapped to distro arch: %s',
+      async (osArch: string, distroArch: string) => {
+        jest.spyOn(os, 'arch').mockReturnValue(osArch);
+
+        const version = '17';
+        const installerOptions: JavaInstallerOptions = {
+          version,
+          architecture: '', // to get default value
+          packageType: 'jdk',
+          checkLatest: false
+        };
+
+        const distribution = new CorrettoDistribution(installerOptions);
+        mockPlatform(distribution, 'macos');
+
+        const expectedLink = `https://corretto.aws/downloads/resources/17.0.2.8.1/amazon-corretto-17.0.2.8.1-macosx-${distroArch}.tar.gz`;
+
+        const availableVersion = await distribution['findPackageForDownload'](version);
+        expect(availableVersion).not.toBeNull();
+        expect(availableVersion.url).toBe(expectedLink);
+      }
+    );
   });
 
   const mockPlatform = (distribution: CorrettoDistribution, platform: string) => {

diff --git a/__tests__/distributors/liberica-installer.test.ts b/__tests__/distributors/liberica-installer.test.ts
@@ -1,6 +1,7 @@
 import { LibericaDistributions } from '../../src/distributions/liberica/installer';
 import { ArchitectureOptions, LibericaVersion } from '../../src/distributions/liberica/models';
 import { HttpClient } from '@actions/http-client';
+import os from 'os';
 
 const manifestData = require('../data/liberica.json') as LibericaVersion[];
 
@@ -61,6 +62,39 @@ describe('getAvailableVersions', () => {
     expect(spyHttpClient.mock.calls[0][0]).toBe(buildUrl);
   });
 
+  type DistroArch = {
+    bitness: string;
+    arch: string;
+  };
+  it.each([
+    ['amd64', { bitness: '64', arch: 'x86' }],
+    ['arm64', { bitness: '64', arch: 'arm' }]
+  ])(
+    'defaults to os.arch(): %s mapped to distro arch: %s',
+    async (osArch: string, distroArch: DistroArch) => {
+      jest.spyOn(os, 'arch').mockReturnValue(osArch);
+
+      const distribution = new LibericaDistributions({
+        version: '17',
+        architecture: '', // to get default value
+        packageType: 'jdk',
+        checkLatest: false
+      });
+
+      const additionalParams =
+        '&installation-type=archive&fields=downloadUrl%2Cversion%2CfeatureVersion%2CinterimVersion%2C' +
+        'updateVersion%2CbuildVersion';
+      distribution['getPlatformOption'] = () => 'macos';
+
+      const buildUrl = `https://api.bell-sw.com/v1/liberica/releases?os=macos&bundle-type=jdk&bitness=${distroArch.bitness}&arch=${distroArch.arch}&build-type=all${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',

diff --git a/__tests__/distributors/microsoft-installer.test.ts b/__tests__/distributors/microsoft-installer.test.ts
@@ -1,5 +1,5 @@
 import { MicrosoftDistributions } from '../../src/distributions/microsoft/installer';
-import * as tc from '@actions/tool-cache';
+import os from 'os';
 import data from '../../src/distributions/microsoft/microsoft-openjdk-versions.json';
 import * as httpm from '@actions/http-client';
 import * as core from '@actions/core';
@@ -77,6 +77,30 @@ describe('findPackageForDownload', () => {
     expect(result.url).toBe(url);
   });
 
+  it.each([
+    ['amd64', 'x64'],
+    ['arm64', 'aarch64']
+  ])(
+    'defaults to os.arch(): %s mapped to distro arch: %s',
+    async (osArch: string, distroArch: string) => {
+      jest.spyOn(os, 'arch').mockReturnValue(osArch);
+      jest.spyOn(os, 'platform').mockReturnValue('linux');
+
+      const version = '17';
+      const distro = new MicrosoftDistributions({
+        version,
+        architecture: '', // to get default value
+        packageType: 'jdk',
+        checkLatest: false
+      });
+
+      const result = await distro['findPackageForDownload'](version);
+      const expectedUrl = `https://aka.ms/download-jdk/microsoft-jdk-17.0.3-linux-${distroArch}.tar.gz`;
+
+      expect(result.url).toBe(expectedUrl);
+    }
+  );
+
   it('should throw an error', async () => {
     await expect(distribution['findPackageForDownload']('8')).rejects.toThrow(
       /Could not find satisfied version for SemVer */

diff --git a/__tests__/distributors/temurin-installer.test.ts b/__tests__/distributors/temurin-installer.test.ts
@@ -1,5 +1,5 @@
 import { HttpClient } from '@actions/http-client';
-
+import os from 'os';
 import {
   TemurinDistribution,
   TemurinImplementation
@@ -109,6 +109,35 @@ describe('getAvailableVersions', () => {
       expect(distribution.toolcacheFolderName).toBe(expected);
     }
   );
+
+  it.each([
+    ['amd64', 'x64'],
+    ['arm64', 'aarch64']
+  ])(
+    'defaults to os.arch(): %s mapped to distro arch: %s',
+    async (osArch: string, distroArch: string) => {
+      jest.spyOn(os, 'arch').mockReturnValue(distroArch);
+
+      const installerOptions: JavaInstallerOptions = {
+        version: '17',
+        architecture: '',
+        packageType: 'jdk',
+        checkLatest: false
+      };
+
+      const expectedParameters = `os=mac&architecture=${distroArch}&image_type=jdk&release_type=ga&jvm_impl=hotspot&page_size=20&page=0`;
+
+      const distribution = new TemurinDistribution(installerOptions, TemurinImplementation.Hotspot);
+      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);
+    }
+  );
 });
 
 describe('findPackageForDownload', () => {

diff --git a/__tests__/distributors/zulu-installer.test.ts b/__tests__/distributors/zulu-installer.test.ts
@@ -3,6 +3,7 @@ import * as semver from 'semver';
 import { ZuluDistribution } from '../../src/distributions/zulu/installer';
 import { IZuluVersions } from '../../src/distributions/zulu/models';
 import * as utils from '../../src/util';
+import os from 'os';
 
 const manifestData = require('../data/zulu-releases-default.json') as [];
 
@@ -72,6 +73,34 @@ describe('getAvailableVersions', () => {
     expect(spyHttpClient.mock.calls[0][0]).toBe(buildUrl);
   });
 
+  type DistroArch = {
+    bitness: string;
+    arch: string;
+  };
+  it.each([
+    ['amd64', { bitness: '64', arch: 'x86' }],
+    ['arm64', { bitness: '64', arch: 'arm' }]
+  ])(
+    'defaults to os.arch(): %s mapped to distro arch: %s',
+    async (osArch: string, distroArch: DistroArch) => {
+      jest.spyOn(os, 'arch').mockReturnValue(osArch);
+
+      const distribution = new ZuluDistribution({
+        version: '17',
+        architecture: '', // to get default value
+        packageType: 'jdk',
+        checkLatest: false
+      });
+      distribution['getPlatformOption'] = () => 'macos';
+      const buildUrl = `https://api.azul.com/zulu/download/community/v1.0/bundles/?os=macos&ext=tar.gz&bundle_type=jdk&javafx=false&arch=${distroArch.arch}&hw_bitness=${distroArch.bitness}&release_status=ga`;
+
+      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 ZuluDistribution({
       version: '11',

diff --git a/action.yml b/action.yml
@@ -14,9 +14,8 @@ inputs:
     required: false
     default: 'jdk'
   architecture:
-    description: 'The architecture of the package'
+    description: "The architecture of the package (defaults to the action runner's architecture)"
     required: false
-    default: 'x64'
   jdkFile:
     description: 'Path to where the compressed JDK is located'
     required: false