dev(trdl-actions): e2e-test install action

Signed-off-by: Alexandr Zaytsev <[email protected]>

Author: nervgh

.github/workflows/_lint.yaml

@@ -3,7 +3,7 @@ name: Lint
 on: [push]
 
 jobs:
-  _:
+  lint:
     runs-on: ubuntu-22.04
     timeout-minutes: 10
 

.github/workflows/_test_e2e_install.yaml

@@ -0,0 +1,19 @@
+name: Test e2e Install
+
+on: [push]
+
+jobs:
+  test-e2e-install:
+    runs-on: ubuntu-22.04
+    timeout-minutes: 10
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install trdl
+        uses: ./install
+
+      - name: Use trdl binary
+        run: |
+          trdl --help

.github/workflows/_test_unit.yaml

@@ -3,7 +3,7 @@ name: Test Unit
 on: [push]
 
 jobs:
-  _:
+  test-unit:
     runs-on: ubuntu-22.04
     timeout-minutes: 10
 

install/dist/index.mjs

@@ -28,6 +28,7 @@ import require$$0$9 from 'diagnostics_channel';
 import require$$2$2 from 'child_process';
 import require$$6$1 from 'timers';
 import { chmodSync } from 'node:fs';
+import { join } from 'node:path';
 
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
@@ -29826,7 +29827,7 @@ async function execOutput(commandLine, args, options) {
     const stderr = [];
     const defaultOptions = {
         // https://github.com/actions/toolkit/blob/%40actions/exec%401.0.1/packages/exec/src/interfaces.ts#L39
-        silent: true,
+        silent: false,
         failOnStdErr: true,
         listeners: {
             stdline(data) {
@@ -29857,13 +29858,13 @@ class GpgCli {
         }
     }
     async import(ascPath) {
-        await execOutput(this.name, ['--import', ascPath]);
+        await execOutput(this.name, ['--import', ascPath], { failOnStdErr: false });
     }
     async verify(sigPath, binPath) {
-        await execOutput(this.name, ['--verify', sigPath, binPath]);
+        await execOutput(this.name, ['--verify', sigPath, binPath], { failOnStdErr: false });
     }
     async help() {
-        const { stdout } = await execOutput(this.name, ['--help']);
+        const { stdout } = await execOutput(this.name, ['--help'], { silent: true });
         return stdout.join('\n');
     }
 }
@@ -29914,6 +29915,10 @@ class TrdlCli {
         const { stdout } = await execOutput(this.name, ['list']);
         return stdout.slice(1).map(parseLineToItem);
     }
+    async version() {
+        const { stdout } = await execOutput(this.name, ['version']);
+        return stdout.join('');
+    }
 }
 function parseLineToItem(line) {
     const [name, url, default_, channel] = line.trim().split(/ +/);
@@ -29998,13 +30003,14 @@ async function downloadParallel(binUrl, sigUrl, ascUrl) {
 function findTrdlCache(toolName, toolVersion) {
     return toolCacheExports.find(toolName, toolVersion);
 }
-async function installTrdl(toolName, toolVersion, binPath) {
+async function installTrdl(binPath, toolName, toolVersion) {
     // install tool
-    const installedPath = await toolCacheExports.cacheFile(binPath, toolName, toolName, toolVersion);
-    // set permissions
-    chmodSync(installedPath, 0o755);
+    const cachedPath = await toolCacheExports.cacheFile(binPath, toolName, toolName, toolVersion);
     // add tool to $PATH
-    coreExports.addPath(installedPath);
+    coreExports.addPath(cachedPath);
+    const cachedFile = join(cachedPath, toolName);
+    // set permissions
+    chmodSync(cachedFile, 0o755);
 }
 async function Run() {
     const trdlCli = new TrdlCli();
@@ -30013,33 +30019,39 @@ async function Run() {
     await Do(trdlCli, gpgCli, inputs);
 }
 async function Do(trdlCli, gpgCli, inputs) {
-    coreExports.startGroup('Install or self-update trdl.');
-    coreExports.debug(format(`parsed inputs=%o`, inputs));
+    coreExports.startGroup(`Install or self-update ${trdlCli.name}.`);
+    coreExports.info(format(`parsed inputs=%o`, inputs));
     const defaults = trdlCli.defaults();
-    coreExports.debug(format(`trdl defaults=%o`, defaults));
+    coreExports.info(format(`${trdlCli.name} repository defaults=%o`, defaults));
     const options = await getOptions(inputs, defaults);
-    coreExports.debug(format(`installation options=%o`, options));
-    const toolCache = findTrdlCache(defaults.repo, options.version);
+    coreExports.info(format(`${trdlCli.name} installation options=%o`, options));
+    const toolCache = findTrdlCache(trdlCli.name, options.version);
     if (toolCache) {
-        coreExports.info(`Installation skipped. trdl@v${options.version} is found at path ${toolCache}.`);
+        coreExports.info(`Installation skipped. ${trdlCli.name}@v${options.version} is found in tool cache ${toolCache}.`);
         await trdlCli.mustExist();
-        coreExports.info(`Updating trdl to group=${defaults.group} and channel=${defaults.channel}`);
+        coreExports.info(`Checking ${trdlCli.name} version before updating.`);
+        await trdlCli.version();
+        coreExports.info(`Updating ${trdlCli.name} to group=${defaults.group} and channel=${defaults.channel}.`);
         await trdlCli.update(defaults);
+        coreExports.info(`Checking ${trdlCli.name} version after updating.`);
+        await trdlCli.version();
         coreExports.endGroup();
         return;
     }
     await gpgCli.mustGnuGP();
     const [binUrl, sigUrl, ascUrl] = formatDownloadUrls(options.version);
-    coreExports.debug(format('%s bin_url=%s', defaults.repo, binUrl));
-    coreExports.debug(format('%s sig_url=%s', defaults.repo, sigUrl));
-    coreExports.debug(format('%s asc_url=%s', defaults.repo, ascUrl));
-    coreExports.info('Downloading signatures.');
+    coreExports.info(`${trdlCli.name} binUrl=${binUrl}`);
+    coreExports.info(`${trdlCli.name} sigUrl=${sigUrl}`);
+    coreExports.info(`${trdlCli.name} ascUrl=${ascUrl}`);
+    coreExports.info('Downloading binary and signatures.');
     const [binPath, sigPath, ascPath] = await downloadParallel(binUrl, sigUrl, ascUrl);
     coreExports.info('Importing and verifying gpg keys.');
     await gpgCli.import(ascPath);
     await gpgCli.verify(sigPath, binPath);
-    coreExports.info('Installing trdl and adding it to the $PATH.');
-    await installTrdl(defaults.repo, options.version, binPath);
+    coreExports.info(`Installing ${trdlCli.name} and adding it to the $PATH.`);
+    await installTrdl(binPath, trdlCli.name, options.version);
+    coreExports.info(`Checking installed ${trdlCli.name} version.`);
+    await trdlCli.version();
     coreExports.endGroup();
 }
 

install/dist/index.mjs.map

@@ -4,6 +4,7 @@ import * as toolCache from '../../test/mocks/tool-cache'
 import * as fs from '../../test/mocks/fs'
 import { trdlCli } from '../../test/mocks/trdl-cli'
 import { gpgCli } from '../../test/mocks/gpg-cli'
+import { join } from 'node:path'
 
 // Mocks should be declared before the module being tested is imported.
 jest.unstable_mockModule('@actions/core', () => core)
@@ -81,31 +82,33 @@ describe('install/action.ts', function () {
 
       await Do(trdlCli, gpgCli, inputs)
 
-      expect(toolCache.find).toHaveBeenCalledWith(defaults.repo, inputs.version)
+      expect(toolCache.find).toHaveBeenCalledWith(trdlCli.name, inputs.version)
       expect(trdlCli.mustExist).toHaveBeenCalled()
+      expect(trdlCli.version).toHaveBeenCalledTimes(2)
       expect(trdlCli.update).toHaveBeenCalledWith(defaults)
     })
     it('should install trdl if tool cache is not found', async function () {
-      const binPath = 'bin path'
+      const binPath = '/tmp/cache/path'
       const sigPath = 'sig path'
       const ascPath = 'asc path'
 
       toolCache.downloadTool.mockResolvedValueOnce(binPath)
       toolCache.downloadTool.mockResolvedValueOnce(sigPath)
       toolCache.downloadTool.mockResolvedValueOnce(ascPath)
 
-      const installedPath = '/tmp/installed/path'
-      toolCache.cacheFile.mockResolvedValueOnce(installedPath)
+      const cachedPath = '/tmp/installed/path'
+      toolCache.cacheFile.mockResolvedValueOnce(cachedPath)
 
       await Do(trdlCli, gpgCli, inputs)
 
-      expect(toolCache.find).toHaveBeenCalledWith(defaults.repo, inputs.version)
+      expect(toolCache.find).toHaveBeenCalledWith(trdlCli.name, inputs.version)
       expect(gpgCli.mustGnuGP).toHaveBeenCalled()
       expect(gpgCli.import).toHaveBeenCalledWith(ascPath)
       expect(gpgCli.verify).toHaveBeenCalledWith(sigPath, binPath)
-      expect(toolCache.cacheFile).toHaveBeenCalledWith(binPath, defaults.repo, defaults.repo, inputs.version)
-      expect(fs.chmodSync).toHaveBeenCalledWith(installedPath, 0o755)
-      expect(core.addPath).toHaveBeenCalledWith(installedPath)
+      expect(toolCache.cacheFile).toHaveBeenCalledWith(binPath, trdlCli.name, trdlCli.name, inputs.version)
+      expect(core.addPath).toHaveBeenCalledWith(cachedPath)
+      expect(fs.chmodSync).toHaveBeenCalledWith(join(cachedPath, trdlCli.name), 0o755)
+      expect(trdlCli.version).toHaveBeenCalled()
     })
   })
 })

install/src/action.test.ts

@@ -1,7 +1,8 @@
-import { getInput, platform, addPath, info, startGroup, endGroup, debug } from '@actions/core'
+import { getInput, platform, addPath, info, startGroup, endGroup } from '@actions/core'
 import { HttpClient } from '@actions/http-client'
 import { downloadTool, find, cacheFile } from '@actions/tool-cache'
 import { chmodSync } from 'node:fs'
+import { join } from 'node:path'
 import { GpgCli } from '../../lib/gpg-cli'
 import { Defaults, TrdlCli } from '../../lib/trdl-cli'
 import { format } from 'util'
@@ -90,13 +91,14 @@ function findTrdlCache(toolName: string, toolVersion: string): string {
   return find(toolName, toolVersion)
 }
 
-async function installTrdl(toolName: string, toolVersion: string, binPath: string): Promise<void> {
+async function installTrdl(binPath: string, toolName: string, toolVersion: string): Promise<void> {
   // install tool
-  const installedPath = await cacheFile(binPath, toolName, toolName, toolVersion)
-  // set permissions
-  chmodSync(installedPath, 0o755)
+  const cachedPath = await cacheFile(binPath, toolName, toolName, toolVersion)
   // add tool to $PATH
-  addPath(installedPath)
+  addPath(cachedPath)
+  const cachedFile = join(cachedPath, toolName)
+  // set permissions
+  chmodSync(cachedFile, 0o755)
 }
 
 export async function Run(): Promise<void> {
@@ -108,43 +110,52 @@ export async function Run(): Promise<void> {
 }
 
 export async function Do(trdlCli: TrdlCli, gpgCli: GpgCli, inputs: inputs): Promise<void> {
-  startGroup('Install or self-update trdl.')
-  debug(format(`parsed inputs=%o`, inputs))
+  startGroup(`Install or self-update ${trdlCli.name}.`)
+  info(format(`parsed inputs=%o`, inputs))
 
   const defaults = trdlCli.defaults()
-  debug(format(`trdl defaults=%o`, defaults))
+  info(format(`${trdlCli.name} repository defaults=%o`, defaults))
 
   const options = await getOptions(inputs, defaults)
-  debug(format(`installation options=%o`, options))
+  info(format(`${trdlCli.name} installation options=%o`, options))
 
-  const toolCache = findTrdlCache(defaults.repo, options.version)
+  const toolCache = findTrdlCache(trdlCli.name, options.version)
 
   if (toolCache) {
-    info(`Installation skipped. trdl@v${options.version} is found at path ${toolCache}.`)
-
+    info(`Installation skipped. ${trdlCli.name}@v${options.version} is found in tool cache ${toolCache}.`)
     await trdlCli.mustExist()
-    info(`Updating trdl to group=${defaults.group} and channel=${defaults.channel}`)
+
+    info(`Checking ${trdlCli.name} version before updating.`)
+    await trdlCli.version()
+
+    info(`Updating ${trdlCli.name} to group=${defaults.group} and channel=${defaults.channel}.`)
     await trdlCli.update(defaults)
 
+    info(`Checking ${trdlCli.name} version after updating.`)
+    await trdlCli.version()
+
     endGroup()
     return
   }
 
   await gpgCli.mustGnuGP()
 
   const [binUrl, sigUrl, ascUrl] = formatDownloadUrls(options.version)
-  debug(format('%s bin_url=%s', defaults.repo, binUrl))
-  debug(format('%s sig_url=%s', defaults.repo, sigUrl))
-  debug(format('%s asc_url=%s', defaults.repo, ascUrl))
+  info(`${trdlCli.name} binUrl=${binUrl}`)
+  info(`${trdlCli.name} sigUrl=${sigUrl}`)
+  info(`${trdlCli.name} ascUrl=${ascUrl}`)
 
-  info('Downloading signatures.')
+  info('Downloading binary and signatures.')
   const [binPath, sigPath, ascPath] = await downloadParallel(binUrl, sigUrl, ascUrl)
 
   info('Importing and verifying gpg keys.')
   await gpgCli.import(ascPath)
   await gpgCli.verify(sigPath, binPath)
 
-  info('Installing trdl and adding it to the $PATH.')
-  await installTrdl(defaults.repo, options.version, binPath)
+  info(`Installing ${trdlCli.name} and adding it to the $PATH.`)
+  await installTrdl(binPath, trdlCli.name, options.version)
+
+  info(`Checking installed ${trdlCli.name} version.`)
+  await trdlCli.version()
   endGroup()
 }

install/src/action.ts

@@ -16,7 +16,7 @@ export async function execOutput(
 
   const defaultOptions = {
     // https://github.com/actions/toolkit/blob/%40actions/exec%401.0.1/packages/exec/src/interfaces.ts#L39
-    silent: true,
+    silent: false,
     failOnStdErr: true,
     listeners: {
       stdline(data: string) {

lib/exec.ts

@@ -23,7 +23,7 @@ describe('gpg-cli.ts', function () {
       const ascPath = 'asc path'
       const result = await cli.import(ascPath)
       expect(result).toBeUndefined()
-      expect(libExec.execOutput).toHaveBeenCalledWith(cliName, ['--import', ascPath])
+      expect(libExec.execOutput).toHaveBeenCalledWith(cliName, ['--import', ascPath], { failOnStdErr: false })
     })
   })
 
@@ -33,7 +33,7 @@ describe('gpg-cli.ts', function () {
       const binPath = 'bin path'
       const result = await cli.verify(sigPath, binPath)
       expect(result).toBeUndefined()
-      expect(libExec.execOutput).toHaveBeenCalledWith(cliName, ['--verify', sigPath, binPath])
+      expect(libExec.execOutput).toHaveBeenCalledWith(cliName, ['--verify', sigPath, binPath], { failOnStdErr: false })
     })
   })
 
@@ -43,7 +43,7 @@ describe('gpg-cli.ts', function () {
       libExec.execOutput.mockResolvedValueOnce({ stdout, stderr: [], exitCode: 0 })
       const result = await cli.help()
       expect(result).toEqual(stdout.join('\n'))
-      expect(libExec.execOutput).toHaveBeenCalledWith(cliName, ['--help'])
+      expect(libExec.execOutput).toHaveBeenCalledWith(cliName, ['--help'], { silent: true })
     })
   })
 

lib/gpg-cli.test.ts

@@ -15,15 +15,15 @@ export class GpgCli {
   }
 
   async import(ascPath: string): Promise<void> {
-    await execOutput(this.name, ['--import', ascPath])
+    await execOutput(this.name, ['--import', ascPath], { failOnStdErr: false })
   }
 
   async verify(sigPath: string, binPath: string): Promise<void> {
-    await execOutput(this.name, ['--verify', sigPath, binPath])
+    await execOutput(this.name, ['--verify', sigPath, binPath], { failOnStdErr: false })
   }
 
   async help(): Promise<string> {
-    const { stdout } = await execOutput(this.name, ['--help'])
+    const { stdout } = await execOutput(this.name, ['--help'], { silent: true })
     return stdout.join('\n')
   }
 }