Add support for graalpy

__tests__/find-graalpy.test.ts

@@ -0,0 +1,375 @@
+import fs from 'fs';
+
+import {HttpClient} from '@actions/http-client';
+import * as ifm from '@actions/http-client/interfaces';
+import * as tc from '@actions/tool-cache';
+import * as exec from '@actions/exec';
+import * as core from '@actions/core';
+
+import * as path from 'path';
+import * as semver from 'semver';
+
+import * as finder from '../src/find-graalpy';
+import {
+  IGraalPyManifestRelease,
+} from '../src/utils';
+
+import manifestData from './data/graalpy.json';
+
+let architecture = 'x64';
+
+const toolDir = path.join(__dirname, 'runner', 'tools');
+const tempDir = path.join(__dirname, 'runner', 'temp');
+
+describe('parseGraalPyVersion', () => {
+  it.each([
+    ['graalpy-23', '23'],
+    ['graalpy-23.0', '23.0'],
+    ['graalpy23.0', '23.0'],
+  ])('%s -> %s', (input, expected) => {
+    expect(finder.parseGraalPyVersion(input)).toEqual(expected);
+  });
+
+  it.each(['', 'graalpy-', 'graalpy', 'p', 'notgraalpy-'])(
+    'throw on invalid input "%s"',
+    input => {
+      expect(() => finder.parseGraalPyVersion(input)).toThrow(
+        "Invalid 'version' property for GraalPy. GraalPy version should be specified as 'graalpy<python-version>' or 'graalpy-<python-version>'. See README for examples and documentation."
+      );
+    }
+  );
+});
+
+describe('findGraalPyToolCache', () => {
+  const actualGraalPyVersion = '23.0.0';
+  const graalpyPath = path.join('GraalPy', actualGraalPyVersion, architecture);
+  let tcFind: jest.SpyInstance;
+  let infoSpy: jest.SpyInstance;
+  let warningSpy: jest.SpyInstance;
+  let debugSpy: jest.SpyInstance;
+  let addPathSpy: jest.SpyInstance;
+  let exportVariableSpy: jest.SpyInstance;
+  let setOutputSpy: jest.SpyInstance;
+
+  beforeEach(() => {
+    tcFind = jest.spyOn(tc, 'find');
+    tcFind.mockImplementation((toolname: string, pythonVersion: string) => {
+      const semverVersion = new semver.Range(pythonVersion);
+      return semver.satisfies(actualGraalPyVersion, semverVersion)
+        ? graalpyPath
+        : '';
+    });
+
+    infoSpy = jest.spyOn(core, 'info');
+    infoSpy.mockImplementation(() => null);
+
+    warningSpy = jest.spyOn(core, 'warning');
+    warningSpy.mockImplementation(() => null);
+
+    debugSpy = jest.spyOn(core, 'debug');
+    debugSpy.mockImplementation(() => null);
+
+    addPathSpy = jest.spyOn(core, 'addPath');
+    addPathSpy.mockImplementation(() => null);
+
+    exportVariableSpy = jest.spyOn(core, 'exportVariable');
+    exportVariableSpy.mockImplementation(() => null);
+
+    setOutputSpy = jest.spyOn(core, 'setOutput');
+    setOutputSpy.mockImplementation(() => null);
+  });
+
+  afterEach(() => {
+    jest.resetAllMocks();
+    jest.clearAllMocks();
+    jest.restoreAllMocks();
+  });
+
+  it('GraalPy exists on the path and versions are satisfied', () => {
+    expect(finder.findGraalPyToolCache('23.0.0', architecture)).toEqual({
+      installDir: graalpyPath,
+      resolvedGraalPyVersion: actualGraalPyVersion
+    });
+  });
+
+  it('GraalPy exists on the path and versions are satisfied with semver', () => {
+    expect(finder.findGraalPyToolCache('23.0', architecture)).toEqual({
+      installDir: graalpyPath,
+      resolvedGraalPyVersion: actualGraalPyVersion
+    });
+  });
+
+  it("GraalPy exists on the path, but version doesn't match", () => {
+    expect(finder.findGraalPyToolCache('22.3', architecture)).toEqual({
+      installDir: '',
+      resolvedGraalPyVersion: ''
+    });
+  });
+});
+
+describe('findGraalPyVersion', () => {
+  let getBooleanInputSpy: jest.SpyInstance;
+  let warningSpy: jest.SpyInstance;
+  let debugSpy: jest.SpyInstance;
+  let infoSpy: jest.SpyInstance;
+  let addPathSpy: jest.SpyInstance;
+  let exportVariableSpy: jest.SpyInstance;
+  let setOutputSpy: jest.SpyInstance;
+  let tcFind: jest.SpyInstance;
+  let spyExtractZip: jest.SpyInstance;
+  let spyExtractTar: jest.SpyInstance;
+  let spyHttpClient: jest.SpyInstance;
+  let spyExistsSync: jest.SpyInstance;
+  let spyExec: jest.SpyInstance;
+  let spySymlinkSync: jest.SpyInstance;
+  let spyDownloadTool: jest.SpyInstance;
+  let spyFsReadDir: jest.SpyInstance;
+  let spyCacheDir: jest.SpyInstance;
+  let spyChmodSync: jest.SpyInstance;
+  let spyCoreAddPath: jest.SpyInstance;
+  let spyCoreExportVariable: jest.SpyInstance;
+  const env = process.env;
+
+  beforeEach(() => {
+    getBooleanInputSpy = jest.spyOn(core, 'getBooleanInput');
+    getBooleanInputSpy.mockImplementation(() => false);
+
+    infoSpy = jest.spyOn(core, 'info');
+    infoSpy.mockImplementation(() => {});
+
+    warningSpy = jest.spyOn(core, 'warning');
+    warningSpy.mockImplementation(() => null);
+
+    debugSpy = jest.spyOn(core, 'debug');
+    debugSpy.mockImplementation(() => null);
+
+    addPathSpy = jest.spyOn(core, 'addPath');
+    addPathSpy.mockImplementation(() => null);
+
+    exportVariableSpy = jest.spyOn(core, 'exportVariable');
+    exportVariableSpy.mockImplementation(() => null);
+
+    setOutputSpy = jest.spyOn(core, 'setOutput');
+    setOutputSpy.mockImplementation(() => null);
+
+    jest.resetModules();
+    process.env = {...env};
+    tcFind = jest.spyOn(tc, 'find');
+    tcFind.mockImplementation((tool: string, version: string) => {
+      const semverRange = new semver.Range(version);
+      let graalpyPath = '';
+      if (semver.satisfies('23.0.0', semverRange)) {
+        graalpyPath = path.join(toolDir, 'GraalPy', '23.0.0', architecture);
+      }
+      return graalpyPath;
+    });
+
+    spyDownloadTool = jest.spyOn(tc, 'downloadTool');
+    spyDownloadTool.mockImplementation(() => path.join(tempDir, 'GraalPy'));
+
+    spyExtractZip = jest.spyOn(tc, 'extractZip');
+    spyExtractZip.mockImplementation(() => tempDir);
+
+    spyExtractTar = jest.spyOn(tc, 'extractTar');
+    spyExtractTar.mockImplementation(() => tempDir);
+
+    spyFsReadDir = jest.spyOn(fs, 'readdirSync');
+    spyFsReadDir.mockImplementation((directory: string) => ['GraalPyTest']);
+
+    spyHttpClient = jest.spyOn(HttpClient.prototype, 'getJson');
+    spyHttpClient.mockImplementation(
+      async (): Promise<ifm.ITypedResponse<IGraalPyManifestRelease[]>> => {
+        const result = JSON.stringify(manifestData);
+        return {
+          statusCode: 200,
+          headers: {},
+          result: JSON.parse(result) as IGraalPyManifestRelease[]
+        };
+      }
+    );
+
+    spyExec = jest.spyOn(exec, 'exec');
+    spyExec.mockImplementation(() => undefined);
+
+    spySymlinkSync = jest.spyOn(fs, 'symlinkSync');
+    spySymlinkSync.mockImplementation(() => undefined);
+
+    spyExistsSync = jest.spyOn(fs, 'existsSync');
+    spyExistsSync.mockReturnValue(true);
+
+    spyCoreAddPath = jest.spyOn(core, 'addPath');
+
+    spyCoreExportVariable = jest.spyOn(core, 'exportVariable');
+  });
+
+  afterEach(() => {
+    jest.resetAllMocks();
+    jest.clearAllMocks();
+    jest.restoreAllMocks();
+    process.env = env;
+  });
+
+  it('found GraalPy in toolcache', async () => {
+    await expect(
+      finder.findGraalPyVersion(
+        'graalpy-23.0',
+        architecture,
+        true,
+        false,
+        false
+      )
+    ).resolves.toEqual('23.0.0');
+    expect(spyCoreAddPath).toHaveBeenCalled();
+    expect(spyCoreExportVariable).toHaveBeenCalledWith(
+      'pythonLocation',
+      expect.anything()
+    );
+    expect(spyCoreExportVariable).toHaveBeenCalledWith(
+      'PKG_CONFIG_PATH',
+      expect.anything()
+    );
+  });
+
+  it('throw on invalid input format', async () => {
+    await expect(
+      finder.findGraalPyVersion('graalpy-x23', architecture, true, false, false)
+    ).rejects.toThrow();
+  });
+
+  it('found and install successfully', async () => {
+    spyCacheDir = jest.spyOn(tc, 'cacheDir');
+    spyCacheDir.mockImplementation(() =>
+      path.join(toolDir, 'GraalPy', '23.0.0', architecture)
+    );
+    spyChmodSync = jest.spyOn(fs, 'chmodSync');
+    spyChmodSync.mockImplementation(() => undefined);
+    await expect(
+      finder.findGraalPyVersion(
+        'graalpy-23.0.0',
+        architecture,
+        true,
+        false,
+        false
+      )
+    ).resolves.toEqual('23.0.0');
+    expect(spyCoreAddPath).toHaveBeenCalled();
+    expect(spyCoreExportVariable).toHaveBeenCalledWith(
+      'pythonLocation',
+      expect.anything()
+    );
+    expect(spyCoreExportVariable).toHaveBeenCalledWith(
+      'PKG_CONFIG_PATH',
+      expect.anything()
+    );
+  });
+
+  it('found and install successfully without environment update', async () => {
+    spyCacheDir = jest.spyOn(tc, 'cacheDir');
+    spyCacheDir.mockImplementation(() =>
+      path.join(toolDir, 'GraalPy', '23.0.0', architecture)
+    );
+    spyChmodSync = jest.spyOn(fs, 'chmodSync');
+    spyChmodSync.mockImplementation(() => undefined);
+    await expect(
+      finder.findGraalPyVersion(
+        'graalpy-23.0.0',
+        architecture,
+        false,
+        false,
+        false
+      )
+    ).resolves.toEqual('23.0.0');
+    expect(spyCoreAddPath).not.toHaveBeenCalled();
+    expect(spyCoreExportVariable).not.toHaveBeenCalled();
+  });
+
+  it('throw if release is not found', async () => {
+    await expect(
+      finder.findGraalPyVersion(
+        'graalpy-19.0.0',
+        architecture,
+        true,
+        false,
+        false
+      )
+    ).rejects.toThrow(
+      `GraalPy version 19.0.0 with arch ${architecture} not found`
+    );
+  });
+
+  it('check-latest enabled version found and used from toolcache', async () => {
+    await expect(
+      finder.findGraalPyVersion(
+        'graalpy-23.0.0',
+        architecture,
+        false,
+        true,
+        false
+      )
+    ).resolves.toEqual('23.0.0');
+
+    expect(infoSpy).toHaveBeenCalledWith(
+      'Resolved as GraalPy 23.0.0'
+    );
+  });
+
+  it('check-latest enabled version found and install successfully', async () => {
+    spyCacheDir = jest.spyOn(tc, 'cacheDir');
+    spyCacheDir.mockImplementation(() =>
+      path.join(toolDir, 'GraalPy', '23.0.0', architecture)
+    );
+    spyChmodSync = jest.spyOn(fs, 'chmodSync');
+    spyChmodSync.mockImplementation(() => undefined);
+    await expect(
+      finder.findGraalPyVersion(
+        'graalpy-23.0.0',
+        architecture,
+        false,
+        true,
+        false
+      )
+    ).resolves.toEqual('23.0.0');
+    expect(infoSpy).toHaveBeenCalledWith(
+      'Resolved as GraalPy 23.0.0'
+    );
+  });
+
+  it('check-latest enabled version is not found and used from toolcache', async () => {
+    tcFind.mockImplementationOnce((tool: string, version: string) => {
+      const semverRange = new semver.Range(version);
+      let graalpyPath = '';
+      if (semver.satisfies('22.3.4', semverRange)) {
+        graalpyPath = path.join(toolDir, 'GraalPy', '22.3.4', architecture);
+      }
+      return graalpyPath;
+    });
+    await expect(
+      finder.findGraalPyVersion(
+        'graalpy-22.3.4',
+        architecture,
+        false,
+        true,
+        false
+      )
+    ).resolves.toEqual('22.3.4');
+
+    expect(infoSpy).toHaveBeenCalledWith(
+      'Failed to resolve GraalPy 22.3.4 from manifest'
+    );
+  });
+
+  it('found and install successfully, pre-release fallback', async () => {
+    spyCacheDir = jest.spyOn(tc, 'cacheDir');
+    spyCacheDir.mockImplementation(() =>
+      path.join(toolDir, 'GraalPy', '23.1', architecture)
+    );
+    spyChmodSync = jest.spyOn(fs, 'chmodSync');
+    spyChmodSync.mockImplementation(() => undefined);
+    await expect(
+      finder.findGraalPyVersion('graalpy23.1', architecture, false, false, false)
+    ).rejects.toThrow();
+    await expect(
+      finder.findGraalPyVersion('graalpy23.1', architecture, false, false, true)
+    ).resolves.toEqual('23.1.0-a.1');
+  });
+});

__tests__/install-graalpy.test.ts

@@ -0,0 +1,282 @@
+import fs from 'fs';
+
+import {HttpClient} from '@actions/http-client';
+import * as ifm from '@actions/http-client/interfaces';
+import * as tc from '@actions/tool-cache';
+import * as exec from '@actions/exec';
+import * as core from '@actions/core';
+import * as path from 'path';
+
+import * as installer from '../src/install-graalpy';
+import {
+  IGraalPyManifestRelease,
+  IGraalPyManifestAsset,
+  IS_WINDOWS
+} from '../src/utils';
+
+import manifestData from './data/graalpy.json';
+
+let architecture: string = 'x64';
+
+const toolDir = path.join(__dirname, 'runner', 'tools');
+const tempDir = path.join(__dirname, 'runner', 'temp');
+
+describe('graalpyVersionToSemantic', () => {
+  it.each([
+    ['23.0.0a1', '23.0.0a1'],
+    ['23.0.0', '23.0.0'],
+    ['23.0.x', '23.0.x'],
+    ['23.x', '23.x']
+  ])('%s -> %s', (input, expected) => {
+    expect(installer.graalPyTagToVersion(input)).toEqual(expected);
+  });
+});
+
+describe('findRelease', () => {
+  const result = JSON.stringify(manifestData);
+  const releases = JSON.parse(result) as IGraalPyManifestRelease[];
+  const extension = 'tar.gz';
+  const arch =  architecture === 'x64' ? 'amd64' : 'aarch64';
+  const extensionName = IS_WINDOWS
+    ? `windows-${arch}.${extension}`
+    : `${process.platform}-${arch}.${extension}`;
+  const files: IGraalPyManifestAsset = {
+    name: `graalpython-23.0.0-${extensionName}`,
+    browser_download_url: `https://github.com/oracle/graalpython/releases/download/graal-23.0.0/graalpython-23.0.0-${extensionName}`
+  };
+  const filesRC1: IGraalPyManifestAsset = {
+    name: `graalpython-23.1.0a1-${extensionName}`,
+    browser_download_url: `https://github.com/oracle/graalpython/releases/download/graal-23.1.0a1/graalpython-23.1.0a1-${extensionName}`
+  };
+
+  let warningSpy: jest.SpyInstance;
+  let debugSpy: jest.SpyInstance;
+  let infoSpy: jest.SpyInstance;
+
+  beforeEach(() => {
+    infoSpy = jest.spyOn(core, 'info');
+    infoSpy.mockImplementation(() => {});
+
+    warningSpy = jest.spyOn(core, 'warning');
+    warningSpy.mockImplementation(() => null);
+
+    debugSpy = jest.spyOn(core, 'debug');
+    debugSpy.mockImplementation(() => null);
+  });
+
+  it("GraalPy version doesn't match", () => {
+    const graalpyVersion = '12.0.0';
+    expect(
+      installer.findRelease(
+        releases,
+        graalpyVersion,
+        architecture,
+        false
+      )
+    ).toEqual(null);
+  });
+
+  it('GraalPy version matches', () => {
+    const graalpyVersion = '23.0.0';
+    expect(
+      installer.findRelease(
+        releases,
+        graalpyVersion,
+        architecture,
+        false
+      )
+    ).toMatchObject({
+      foundAsset: files,
+      resolvedGraalPyVersion: graalpyVersion
+    });
+  });
+
+  it('Preview version of GraalPy is found', () => {
+    const graalpyVersion = installer.graalPyTagToVersion('vm-23.1.0a1');
+    expect(
+      installer.findRelease(
+        releases,
+        graalpyVersion,
+        architecture,
+        false
+      )
+    ).toMatchObject({
+      foundAsset: {
+        name: `graalpython-23.1.0a1-${extensionName}`,
+        browser_download_url: `https://github.com/oracle/graalpython/releases/download/graal-23.1.0a1/graalpython-23.1.0a1-${extensionName}`
+      },
+      resolvedGraalPyVersion: '23.1.0-a.1'
+    });
+  });
+
+  it('Latest GraalPy is found', () => {
+    const graalpyVersion = 'x';
+    expect(
+      installer.findRelease(
+        releases,
+        graalpyVersion,
+        architecture,
+        false
+      )
+    ).toMatchObject({
+      foundAsset: files,
+      resolvedGraalPyVersion: '23.0.0'
+    });
+  });
+
+  it('GraalPy version matches semver (pre-release)', () => {
+    const graalpyVersion = '23.1.x';
+    expect(
+      installer.findRelease(
+        releases,
+        graalpyVersion,
+        architecture,
+        false
+      )
+    ).toBeNull();
+    expect(
+      installer.findRelease(
+        releases,
+        graalpyVersion,
+        architecture,
+        true
+      )
+    ).toMatchObject({
+      foundAsset: filesRC1,
+      resolvedGraalPyVersion: '23.1.0-a.1'
+    });
+  });
+});
+
+describe('installGraalPy', () => {
+  let tcFind: jest.SpyInstance;
+  let warningSpy: jest.SpyInstance;
+  let debugSpy: jest.SpyInstance;
+  let infoSpy: jest.SpyInstance;
+  let spyExtractZip: jest.SpyInstance;
+  let spyExtractTar: jest.SpyInstance;
+  let spyFsReadDir: jest.SpyInstance;
+  let spyFsWriteFile: jest.SpyInstance;
+  let spyHttpClient: jest.SpyInstance;
+  let spyExistsSync: jest.SpyInstance;
+  let spyExec: jest.SpyInstance;
+  let spySymlinkSync: jest.SpyInstance;
+  let spyDownloadTool: jest.SpyInstance;
+  let spyCacheDir: jest.SpyInstance;
+  let spyChmodSync: jest.SpyInstance;
+
+  beforeEach(() => {
+    tcFind = jest.spyOn(tc, 'find');
+    tcFind.mockImplementation(() => path.join('GraalPy', '3.6.12', architecture));
+
+    spyDownloadTool = jest.spyOn(tc, 'downloadTool');
+    spyDownloadTool.mockImplementation(() => path.join(tempDir, 'GraalPy'));
+
+    spyExtractZip = jest.spyOn(tc, 'extractZip');
+    spyExtractZip.mockImplementation(() => tempDir);
+
+    spyExtractTar = jest.spyOn(tc, 'extractTar');
+    spyExtractTar.mockImplementation(() => tempDir);
+
+    infoSpy = jest.spyOn(core, 'info');
+    infoSpy.mockImplementation(() => {});
+
+    warningSpy = jest.spyOn(core, 'warning');
+    warningSpy.mockImplementation(() => null);
+
+    debugSpy = jest.spyOn(core, 'debug');
+    debugSpy.mockImplementation(() => null);
+
+    spyFsReadDir = jest.spyOn(fs, 'readdirSync');
+    spyFsReadDir.mockImplementation(() => ['GraalPyTest']);
+
+    spyFsWriteFile = jest.spyOn(fs, 'writeFileSync');
+    spyFsWriteFile.mockImplementation(() => undefined);
+
+    spyHttpClient = jest.spyOn(HttpClient.prototype, 'getJson');
+    spyHttpClient.mockImplementation(
+      async (): Promise<ifm.ITypedResponse<IGraalPyManifestRelease[]>> => {
+        const result = JSON.stringify(manifestData);
+        return {
+          statusCode: 200,
+          headers: {},
+          result: JSON.parse(result) as IGraalPyManifestRelease[]
+        };
+      }
+    );
+
+    spyExec = jest.spyOn(exec, 'exec');
+    spyExec.mockImplementation(() => undefined);
+
+    spySymlinkSync = jest.spyOn(fs, 'symlinkSync');
+    spySymlinkSync.mockImplementation(() => undefined);
+
+    spyExistsSync = jest.spyOn(fs, 'existsSync');
+    spyExistsSync.mockImplementation(() => false);
+  });
+
+  afterEach(() => {
+    jest.resetAllMocks();
+    jest.clearAllMocks();
+    jest.restoreAllMocks();
+  });
+
+  it('throw if release is not found', async () => {
+    await expect(
+      installer.installGraalPy('7.3.3', architecture, false, undefined)
+    ).rejects.toThrow(
+      `GraalPy version 7.3.3 with arch ${architecture} not found`
+    );
+
+    expect(spyHttpClient).toHaveBeenCalled();
+    expect(spyDownloadTool).not.toHaveBeenCalled();
+    expect(spyExec).not.toHaveBeenCalled();
+  });
+
+  it('found and install GraalPy', async () => {
+    spyCacheDir = jest.spyOn(tc, 'cacheDir');
+    spyCacheDir.mockImplementation(() =>
+      path.join(toolDir, 'GraalPy', '21.3.0', architecture)
+    );
+
+    spyChmodSync = jest.spyOn(fs, 'chmodSync');
+    spyChmodSync.mockImplementation(() => undefined);
+
+    await expect(
+      installer.installGraalPy('21.x', architecture, false, undefined)
+    ).resolves.toEqual({
+      installDir: path.join(toolDir, 'GraalPy', '21.3.0', architecture),
+      resolvedGraalPyVersion: '21.3.0'
+    });
+
+    expect(spyHttpClient).toHaveBeenCalled();
+    expect(spyDownloadTool).toHaveBeenCalled();
+    expect(spyCacheDir).toHaveBeenCalled();
+    expect(spyExec).toHaveBeenCalled();
+  });
+
+  it('found and install GraalPy, pre-release fallback', async () => {
+    spyCacheDir = jest.spyOn(tc, 'cacheDir');
+    spyCacheDir.mockImplementation(() =>
+      path.join(toolDir, 'GraalPy', '23.1.0', architecture)
+    );
+
+    spyChmodSync = jest.spyOn(fs, 'chmodSync');
+    spyChmodSync.mockImplementation(() => undefined);
+
+    await expect(
+      installer.installGraalPy('23.1.x', architecture, false, undefined)
+    ).rejects.toThrow();
+    await expect(
+      installer.installGraalPy('23.1.x', architecture, true, undefined)
+    ).resolves.toEqual({
+      installDir: path.join(toolDir, 'GraalPy', '23.1.0', architecture),
+      resolvedGraalPyVersion: '23.1.0-a.1'
+    });
+
+    expect(spyHttpClient).toHaveBeenCalled();
+    expect(spyDownloadTool).toHaveBeenCalled();
+    expect(spyCacheDir).toHaveBeenCalled();
+    expect(spyExec).toHaveBeenCalled();
+  });
+});