Merge pull request #102 from scalvert/variant-input

Replace `openssl-version` configuration with `variant`

Author: Robert Jackson

README.md

@@ -18,7 +18,7 @@ This action installs [volta](https://volta.sh) by:
 | node-version | Version Spec of the node version to use.  Examples: 10.6.x, 10.15.1, >=10.15.0 | `false` |  |
 | npm-version | Version Spec of the npm version to use.  Examples: 7.5.x, 7.5.3, >=7.5.3 | `false` |  |
 | yarn-version | Version Spec of the yarn version to use.  Examples: 1.6.x, 10.15.1, >=10.15.0 | `false` |  |
-| openssl-version | Version Spec of the openssl version to use.  Examples: 1.0, 1.1 | `false` |  |
+| variant | Specific variant to install. Example: providing the variant "linux-openssl-rhel", which will target installing the volta-${version}-linux-openssl-rhel.tar.gz tarball | `false` |  |
 | registry-url | Optional registry to set up for auth. Will set the registry in a project level .npmrc file, and set up auth to read in from env.NODE_AUTH_TOKEN | `false` |  |
 | scope | Optional scope for authenticating against scoped registries. Will fall back to the repository owner when using the GitHub Packages registry (https://npm.pkg.github.com/). | `false` |  |
 | token | Used to avoid low rate limiting for cached tool downloads.  Since there's a default, this is typically not supplied by the user. | `false` | ${{ github.token }} |
@@ -91,6 +91,21 @@ steps:
 - run: npm test
 ```
 
+In some cases, you may know the particular variant of the installer that you want to use for Volta. You can specify the `variant` input to the action to use a specific installer:
+
+```yaml
+steps:
+- uses: actions/checkout@v3
+- uses: volta-cli/action@v3
+  with:
+    variant: 'linux-openssl-rhel'
+
+- run: yarn install
+- run: yarn test
+```
+
+The `variant` fragment corresponds to a portion of the installer filename, and can be found in the [Volta Releases](https://github.com/volta-cli/action/releases) page.
+
 ## License
 
 The scripts and documentation in this project are released under the [MIT License](LICENSE)

action.yml

@@ -14,8 +14,8 @@ inputs:
   yarn-version:
     description: 'Version Spec of the yarn version to use.  Examples: 1.6.x, 10.15.1, >=10.15.0'
     default: ''
-  openssl-version:
-    description: 'Version Spec of the openssl version to use.  Examples: 1.0, 1.1'
+  variant:
+    description: 'Specific variant to install. Example: providing the variant "linux-openssl-rhel", which will target installing the volta-${version}-linux-openssl-rhel.tar.gz tarball'
     default: ''
   registry-url:
     description: 'Optional registry to set up for auth. Will set the registry in a project level .npmrc file, and set up auth to read in from env.NODE_AUTH_TOKEN'

src/index.ts

@@ -8,9 +8,9 @@ async function run(): Promise<void> {
   try {
     const authToken = core.getInput('token', { required: false });
     const voltaVersion = core.getInput('volta-version', { required: false });
-    const openSSLVersion = core.getInput('openssl-version', { required: false });
+    const variant = core.getInput('variant', { required: false });
 
-    await installer.getVolta(voltaVersion, authToken, openSSLVersion);
+    await installer.getVolta({ versionSpec: voltaVersion, authToken, variant });
 
     const hasPackageJSON = await findUp('package.json');
     const nodeVersion = core.getInput('node-version', { required: false });

src/installer.test.ts

@@ -1,4 +1,4 @@
-import { buildLayout, buildDownloadUrl, getVoltaVersion } from './installer';
+import { buildLayout, buildDownloadUrl, getVoltaVersion, getOpenSSLVersion } from './installer';
 import { createTempDir } from 'broccoli-test-helper';
 import nock from 'nock';
 
@@ -11,25 +11,21 @@ describe('buildDownloadUrl', () => {
 
   test('linux', async function () {
     expect(
-      await buildDownloadUrl('linux', '0.6.4', 'OpenSSL 1.0.1e-fips 11 Feb 2013')
+      await buildDownloadUrl('linux', '0.6.4', '', 'OpenSSL 1.0.1e-fips 11 Feb 2013')
     ).toMatchInlineSnapshot(
       `"https://github.com/volta-cli/volta/releases/download/v0.6.4/volta-0.6.4-linux-openssl-1.0.tar.gz"`
     );
 
     expect(
-      await buildDownloadUrl('linux', '0.6.4', 'OpenSSL 1.1.1e-fips 11 Sep 2018')
+      await buildDownloadUrl('linux', '0.6.4', '', 'OpenSSL 1.1.1e-fips 11 Sep 2018')
     ).toMatchInlineSnapshot(
       `"https://github.com/volta-cli/volta/releases/download/v0.6.4/volta-0.6.4-linux-openssl-1.1.tar.gz"`
     );
   });
 
-  test('linux with openssl-version input', async function () {
-    expect(await buildDownloadUrl('linux', '0.6.4', '1.0')).toMatchInlineSnapshot(
-      `"https://github.com/volta-cli/volta/releases/download/v0.6.4/volta-0.6.4-linux-openssl-1.0.tar.gz"`
-    );
-
-    expect(await buildDownloadUrl('linux', '0.6.4', '1.1')).toMatchInlineSnapshot(
-      `"https://github.com/volta-cli/volta/releases/download/v0.6.4/volta-0.6.4-linux-openssl-1.1.tar.gz"`
+  test('linux with variant input', async function () {
+    expect(await buildDownloadUrl('linux', '0.6.4', 'linux-openssl-rhel')).toMatchInlineSnapshot(
+      `"https://github.com/volta-cli/volta/releases/download/v0.6.4/volta-0.6.4-linux-openssl-rhel.tar.gz"`
     );
   });
 
@@ -46,6 +42,20 @@ describe('buildDownloadUrl', () => {
   });
 });
 
+describe('getOpenSSLVersion', () => {
+  test('1.0', async function () {
+    expect(await getOpenSSLVersion('OpenSSL 1.0.1e-fips 11 Feb 2013')).toMatchInlineSnapshot(
+      `"openssl-1.0"`
+    );
+  });
+
+  test('1.1', async function () {
+    expect(await getOpenSSLVersion('OpenSSL 1.1.1e-fips 11 Sep 2018')).toMatchInlineSnapshot(
+      `"openssl-1.1"`
+    );
+  });
+});
+
 describe('buildLayout', () => {
   test('creates the rough folder structure', async () => {
     const tmpdir = await createTempDir();
@@ -59,34 +69,34 @@ describe('buildLayout', () => {
     await buildLayout(tmpdir.path());
 
     expect(tmpdir.read()).toMatchInlineSnapshot(`
-Object {
-  "bin": Object {
-    "node": "shim-file-here",
-    "npm": "shim-file-here",
-    "npx": "shim-file-here",
-    "shim": "shim-file-here",
-    "yarn": "shim-file-here",
-  },
-  "cache": Object {
-    "node": Object {},
-  },
-  "log": Object {},
-  "tmp": Object {},
-  "tools": Object {
-    "image": Object {
-      "node": Object {},
-      "packages": Object {},
-      "yarn": Object {},
-    },
-    "inventory": Object {
-      "node": Object {},
-      "packages": Object {},
-      "yarn": Object {},
-    },
-    "user": Object {},
-  },
-}
-`);
+      Object {
+        "bin": Object {
+          "node": "shim-file-here",
+          "npm": "shim-file-here",
+          "npx": "shim-file-here",
+          "shim": "shim-file-here",
+          "yarn": "shim-file-here",
+        },
+        "cache": Object {
+          "node": Object {},
+        },
+        "log": Object {},
+        "tmp": Object {},
+        "tools": Object {
+          "image": Object {
+            "node": Object {},
+            "packages": Object {},
+            "yarn": Object {},
+          },
+          "inventory": Object {
+            "node": Object {},
+            "packages": Object {},
+            "yarn": Object {},
+          },
+          "user": Object {},
+        },
+      }
+    `);
   });
 });
 

src/installer.ts

@@ -10,6 +10,12 @@ import * as semver from 'semver';
 import * as fs from 'fs';
 import { v4 as uuidV4 } from 'uuid';
 
+type VoltaInstallOptions = {
+  versionSpec: string;
+  authToken: string;
+  variant: string;
+};
+
 async function getLatestVolta(authToken: string): Promise<string> {
   const url = 'https://api.github.com/repos/volta-cli/volta/releases/latest';
 
@@ -40,53 +46,36 @@ function voltaVersionHasSetup(version: string): boolean {
 export async function buildDownloadUrl(
   platform: string,
   version: string,
-  openSSLVersion = ''
+  variant = '',
+  openSSLVersionForTesting = ''
 ): Promise<string> {
-  let fileName: string;
-  switch (platform) {
-    case 'darwin':
-      fileName = `volta-${version}-macos.tar.gz`;
-      break;
-    case 'linux': {
-      openSSLVersion = await getOpenSSLVersion(openSSLVersion);
-
-      fileName = `volta-${version}-linux-${openSSLVersion}.tar.gz`;
-      break;
+  let fileName = '';
+
+  if (variant) {
+    fileName = `volta-${version}-${variant}.tar.gz`;
+  } else {
+    switch (platform) {
+      case 'darwin':
+        fileName = `volta-${version}-macos.tar.gz`;
+        break;
+      case 'linux': {
+        const openSSLVersion = await getOpenSSLVersion(openSSLVersionForTesting);
+
+        fileName = `volta-${version}-linux-${openSSLVersion}.tar.gz`;
+        break;
+      }
+      case 'win32':
+        fileName = `volta-${version}-windows-x86_64.msi`;
+        break;
+      default:
+        throw new Error(`your platform ${platform} is not yet supported`);
     }
-    case 'win32':
-      fileName = `volta-${version}-windows-x86_64.msi`;
-      break;
-    default:
-      throw new Error(`your platform ${platform} is not yet supported`);
   }
 
   return `https://github.com/volta-cli/volta/releases/download/v${version}/${fileName}`;
 }
 
-async function execOpenSSLVersion() {
-  let output = '';
-  const options: ExecOptions = {};
-  options.listeners = {
-    stdout: (data: Buffer) => {
-      output += data.toString();
-    },
-    stderr: (data: Buffer) => {
-      output += data.toString();
-    },
-  };
-
-  await exec('openssl version', [], options);
-
-  return output;
-}
-
-async function getOpenSSLVersion(version = ''): Promise<string> {
-  const specificVersionViaInput = /^\d{1,3}\.\d{1,3}$/.test(version);
-
-  if (specificVersionViaInput) {
-    return `openssl-${version}`;
-  }
-
+export async function getOpenSSLVersion(version = ''): Promise<string> {
   if (version === '') {
     version = await execOpenSSLVersion();
   }
@@ -107,6 +96,23 @@ async function getOpenSSLVersion(version = ''): Promise<string> {
   return `openssl-${version}`;
 }
 
+async function execOpenSSLVersion() {
+  let output = '';
+  const options: ExecOptions = {};
+  options.listeners = {
+    stdout: (data: Buffer) => {
+      output += data.toString();
+    },
+    stderr: (data: Buffer) => {
+      output += data.toString();
+    },
+  };
+
+  await exec('openssl version', [], options);
+
+  return output;
+}
+
 /*
  * Used to setup a specific shim when running volta < 0.7
  */
@@ -155,21 +161,17 @@ export async function buildLayout(voltaHome: string): Promise<void> {
   await setupShims(voltaHome);
 }
 
-async function acquireVolta(
-  version: string,
-  authToken: string,
-  openSSLVersion: string
-): Promise<string> {
+async function acquireVolta(version: string, options: VoltaInstallOptions): Promise<string> {
   //
   // Download - a tool installer intimately knows how to get the tool (and construct urls)
   //
 
   core.info(`downloading volta@${version}`);
 
-  const downloadUrl = await buildDownloadUrl(os.platform(), version, openSSLVersion);
+  const downloadUrl = await buildDownloadUrl(os.platform(), version, options.variant);
 
   core.debug(`downloading from \`${downloadUrl}\``);
-  const downloadPath = await tc.downloadTool(downloadUrl, undefined, authToken);
+  const downloadPath = await tc.downloadTool(downloadUrl, undefined, options.authToken);
 
   const voltaHome = path.join(
     // `RUNNER_TEMP` is used by @actions/tool-cache
@@ -280,18 +282,14 @@ export async function getVoltaVersion(versionSpec: string, authToken: string): P
   return version;
 }
 
-export async function getVolta(
-  versionSpec: string,
-  authToken: string,
-  openSSLVersion: string
-): Promise<void> {
-  const version = await getVoltaVersion(versionSpec, authToken);
+export async function getVolta(options: VoltaInstallOptions): Promise<void> {
+  const version = await getVoltaVersion(options.versionSpec, options.authToken);
 
   let voltaHome = tc.find('volta', version);
 
   if (voltaHome === '') {
     // download, extract, cache
-    const toolRoot = await acquireVolta(version, authToken, openSSLVersion);
+    const toolRoot = await acquireVolta(version, options);
 
     await setupVolta(version, toolRoot);