Skip to content
This repository was archived by the owner on Sep 8, 2025. It is now read-only.

Commit a1a6085

Browse files
nervghnervgh
committed
dev(trdl-actions): e2e-test install action
Signed-off-by: Alexandr Zaytsev <[email protected]>
1 parent 171bed0 commit a1a6085

File tree

15 files changed

+123
-58
lines changed

15 files changed

+123
-58
lines changed

‎.github/workflows/_lint.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Lint
33
on: [push]
44

55
jobs:
6-
_:
6+
lint:
77
runs-on: ubuntu-22.04
88
timeout-minutes: 10
99

‎.github/workflows/_test_e2e_install.yaml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Test e2e Install
2+
3+
on: [push]
4+
5+
jobs:
6+
test-e2e-install:
7+
runs-on: ubuntu-22.04
8+
timeout-minutes: 10
9+
10+
steps:
11+
- name: Checkout code
12+
uses: actions/checkout@v4
13+
14+
- name: Install trdl
15+
uses: ./install
16+
17+
- name: Use trdl binary
18+
run: |
19+
trdl --help

‎.github/workflows/_test_unit.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Test Unit
33
on: [push]
44

55
jobs:
6-
_:
6+
test-unit:
77
runs-on: ubuntu-22.04
88
timeout-minutes: 10
99

‎install/dist/index.mjs‎

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ import require$$0$9 from 'diagnostics_channel';
2828
import require$$2$2 from 'child_process';
2929
import require$$6$1 from 'timers';
3030
import { chmodSync } from 'node:fs';
31+
import { join } from 'node:path';
3132

3233
var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
3334

@@ -29857,10 +29858,10 @@ class GpgCli {
2985729858
}
2985829859
}
2985929860
async import(ascPath) {
29860-
await execOutput(this.name, ['--import', ascPath]);
29861+
await execOutput(this.name, ['--import', ascPath], { silent: false, failOnStdErr: false });
2986129862
}
2986229863
async verify(sigPath, binPath) {
29863-
await execOutput(this.name, ['--verify', sigPath, binPath]);
29864+
await execOutput(this.name, ['--verify', sigPath, binPath], { silent: false, failOnStdErr: false });
2986429865
}
2986529866
async help() {
2986629867
const { stdout } = await execOutput(this.name, ['--help']);
@@ -29914,6 +29915,10 @@ class TrdlCli {
2991429915
const { stdout } = await execOutput(this.name, ['list']);
2991529916
return stdout.slice(1).map(parseLineToItem);
2991629917
}
29918+
async version() {
29919+
const { stdout } = await execOutput(this.name, ['version'], { silent: false });
29920+
return stdout.join('');
29921+
}
2991729922
}
2991829923
function parseLineToItem(line) {
2991929924
const [name, url, default_, channel] = line.trim().split(/ +/);
@@ -29998,13 +30003,14 @@ async function downloadParallel(binUrl, sigUrl, ascUrl) {
2999830003
function findTrdlCache(toolName, toolVersion) {
2999930004
return toolCacheExports.find(toolName, toolVersion);
3000030005
}
30001-
async function installTrdl(toolName, toolVersion, binPath) {
30006+
async function installTrdl(binPath, toolName, toolVersion) {
3000230007
// install tool
30003-
const installedPath = await toolCacheExports.cacheFile(binPath, toolName, toolName, toolVersion);
30004-
// set permissions
30005-
chmodSync(installedPath, 0o755);
30008+
const cachedPath = await toolCacheExports.cacheFile(binPath, toolName, toolName, toolVersion);
3000630009
// add tool to $PATH
30007-
coreExports.addPath(installedPath);
30010+
coreExports.addPath(cachedPath);
30011+
const cachedFile = join(cachedPath, toolName);
30012+
// set permissions
30013+
chmodSync(cachedFile, 0o755);
3000830014
}
3000930015
async function Run() {
3001030016
const trdlCli = new TrdlCli();
@@ -30014,11 +30020,11 @@ async function Run() {
3001430020
}
3001530021
async function Do(trdlCli, gpgCli, inputs) {
3001630022
coreExports.startGroup('Install or self-update trdl.');
30017-
coreExports.debug(format(`parsed inputs=%o`, inputs));
30023+
coreExports.info(format(`parsed inputs=%o`, inputs));
3001830024
const defaults = trdlCli.defaults();
30019-
coreExports.debug(format(`trdl defaults=%o`, defaults));
30025+
coreExports.info(format(`trdl defaults=%o`, defaults));
3002030026
const options = await getOptions(inputs, defaults);
30021-
coreExports.debug(format(`installation options=%o`, options));
30027+
coreExports.info(format(`installation options=%o`, options));
3002230028
const toolCache = findTrdlCache(defaults.repo, options.version);
3002330029
if (toolCache) {
3002430030
coreExports.info(`Installation skipped. trdl@v${options.version} is found at path ${toolCache}.`);
@@ -30030,16 +30036,18 @@ async function Do(trdlCli, gpgCli, inputs) {
3003030036
}
3003130037
await gpgCli.mustGnuGP();
3003230038
const [binUrl, sigUrl, ascUrl] = formatDownloadUrls(options.version);
30033-
coreExports.debug(format('%s bin_url=%s', defaults.repo, binUrl));
30034-
coreExports.debug(format('%s sig_url=%s', defaults.repo, sigUrl));
30035-
coreExports.debug(format('%s asc_url=%s', defaults.repo, ascUrl));
30036-
coreExports.info('Downloading signatures.');
30039+
coreExports.info(format('%s binUrl=%s', defaults.repo, binUrl));
30040+
coreExports.info(format('%s sigUrl=%s', defaults.repo, sigUrl));
30041+
coreExports.info(format('%s ascUrl=%s', defaults.repo, ascUrl));
30042+
coreExports.info('Downloading binary and signatures.');
3003730043
const [binPath, sigPath, ascPath] = await downloadParallel(binUrl, sigUrl, ascUrl);
3003830044
coreExports.info('Importing and verifying gpg keys.');
3003930045
await gpgCli.import(ascPath);
3004030046
await gpgCli.verify(sigPath, binPath);
3004130047
coreExports.info('Installing trdl and adding it to the $PATH.');
30042-
await installTrdl(defaults.repo, options.version, binPath);
30048+
await installTrdl(binPath, defaults.repo, options.version);
30049+
const version = await trdlCli.version();
30050+
coreExports.info(format('Installed version: trdl@%s', version));
3004330051
coreExports.endGroup();
3004430052
}
3004530053

‎install/dist/index.mjs.map‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎install/src/action.test.ts‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import * as toolCache from '../../test/mocks/tool-cache'
44
import * as fs from '../../test/mocks/fs'
55
import { trdlCli } from '../../test/mocks/trdl-cli'
66
import { gpgCli } from '../../test/mocks/gpg-cli'
7+
import { join } from 'node:path'
78

89
// Mocks should be declared before the module being tested is imported.
910
jest.unstable_mockModule('@actions/core', () => core)
@@ -86,16 +87,16 @@ describe('install/action.ts', function () {
8687
expect(trdlCli.update).toHaveBeenCalledWith(defaults)
8788
})
8889
it('should install trdl if tool cache is not found', async function () {
89-
const binPath = 'bin path'
90+
const binPath = '/tmp/cache/path'
9091
const sigPath = 'sig path'
9192
const ascPath = 'asc path'
9293

9394
toolCache.downloadTool.mockResolvedValueOnce(binPath)
9495
toolCache.downloadTool.mockResolvedValueOnce(sigPath)
9596
toolCache.downloadTool.mockResolvedValueOnce(ascPath)
9697

97-
const installedPath = '/tmp/installed/path'
98-
toolCache.cacheFile.mockResolvedValueOnce(installedPath)
98+
const cachedPath = '/tmp/installed/path'
99+
toolCache.cacheFile.mockResolvedValueOnce(cachedPath)
99100

100101
await Do(trdlCli, gpgCli, inputs)
101102

@@ -104,8 +105,9 @@ describe('install/action.ts', function () {
104105
expect(gpgCli.import).toHaveBeenCalledWith(ascPath)
105106
expect(gpgCli.verify).toHaveBeenCalledWith(sigPath, binPath)
106107
expect(toolCache.cacheFile).toHaveBeenCalledWith(binPath, defaults.repo, defaults.repo, inputs.version)
107-
expect(fs.chmodSync).toHaveBeenCalledWith(installedPath, 0o755)
108-
expect(core.addPath).toHaveBeenCalledWith(installedPath)
108+
expect(core.addPath).toHaveBeenCalledWith(cachedPath)
109+
expect(fs.chmodSync).toHaveBeenCalledWith(join(cachedPath, defaults.repo), 0o755)
110+
expect(trdlCli.version).toHaveBeenCalled()
109111
})
110112
})
111113
})

‎install/src/action.ts‎

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
import { getInput, platform, addPath, info, startGroup, endGroup, debug } from '@actions/core'
1+
import { getInput, platform, addPath, info, startGroup, endGroup } from '@actions/core'
22
import { HttpClient } from '@actions/http-client'
33
import { downloadTool, find, cacheFile } from '@actions/tool-cache'
44
import { chmodSync } from 'node:fs'
5+
import { join } from 'node:path'
56
import { GpgCli } from '../../lib/gpg-cli'
67
import { Defaults, TrdlCli } from '../../lib/trdl-cli'
78
import { format } from 'util'
@@ -90,13 +91,14 @@ function findTrdlCache(toolName: string, toolVersion: string): string {
9091
return find(toolName, toolVersion)
9192
}
9293

93-
async function installTrdl(toolName: string, toolVersion: string, binPath: string): Promise<void> {
94+
async function installTrdl(binPath: string, toolName: string, toolVersion: string): Promise<void> {
9495
// install tool
95-
const installedPath = await cacheFile(binPath, toolName, toolName, toolVersion)
96-
// set permissions
97-
chmodSync(installedPath, 0o755)
96+
const cachedPath = await cacheFile(binPath, toolName, toolName, toolVersion)
9897
// add tool to $PATH
99-
addPath(installedPath)
98+
addPath(cachedPath)
99+
const cachedFile = join(cachedPath, toolName)
100+
// set permissions
101+
chmodSync(cachedFile, 0o755)
100102
}
101103

102104
export async function Run(): Promise<void> {
@@ -109,13 +111,13 @@ export async function Run(): Promise<void> {
109111

110112
export async function Do(trdlCli: TrdlCli, gpgCli: GpgCli, inputs: inputs): Promise<void> {
111113
startGroup('Install or self-update trdl.')
112-
debug(format(`parsed inputs=%o`, inputs))
114+
info(format(`parsed inputs=%o`, inputs))
113115

114116
const defaults = trdlCli.defaults()
115-
debug(format(`trdl defaults=%o`, defaults))
117+
info(format(`trdl defaults=%o`, defaults))
116118

117119
const options = await getOptions(inputs, defaults)
118-
debug(format(`installation options=%o`, options))
120+
info(format(`installation options=%o`, options))
119121

120122
const toolCache = findTrdlCache(defaults.repo, options.version)
121123

@@ -133,18 +135,21 @@ export async function Do(trdlCli: TrdlCli, gpgCli: GpgCli, inputs: inputs): Prom
133135
await gpgCli.mustGnuGP()
134136

135137
const [binUrl, sigUrl, ascUrl] = formatDownloadUrls(options.version)
136-
debug(format('%s bin_url=%s', defaults.repo, binUrl))
137-
debug(format('%s sig_url=%s', defaults.repo, sigUrl))
138-
debug(format('%s asc_url=%s', defaults.repo, ascUrl))
138+
info(format('%s binUrl=%s', defaults.repo, binUrl))
139+
info(format('%s sigUrl=%s', defaults.repo, sigUrl))
140+
info(format('%s ascUrl=%s', defaults.repo, ascUrl))
139141

140-
info('Downloading signatures.')
142+
info('Downloading binary and signatures.')
141143
const [binPath, sigPath, ascPath] = await downloadParallel(binUrl, sigUrl, ascUrl)
142144

143145
info('Importing and verifying gpg keys.')
144146
await gpgCli.import(ascPath)
145147
await gpgCli.verify(sigPath, binPath)
146148

147149
info('Installing trdl and adding it to the $PATH.')
148-
await installTrdl(defaults.repo, options.version, binPath)
150+
await installTrdl(binPath, defaults.repo, options.version)
151+
152+
const version = await trdlCli.version()
153+
info(format('Installed version: trdl@%s', version))
149154
endGroup()
150155
}

‎lib/gpg-cli.test.ts‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,10 @@ describe('gpg-cli.ts', function () {
2323
const ascPath = 'asc path'
2424
const result = await cli.import(ascPath)
2525
expect(result).toBeUndefined()
26-
expect(libExec.execOutput).toHaveBeenCalledWith(cliName, ['--import', ascPath])
26+
expect(libExec.execOutput).toHaveBeenCalledWith(cliName, ['--import', ascPath], {
27+
silent: false,
28+
failOnStdErr: false
29+
})
2730
})
2831
})
2932

@@ -33,7 +36,10 @@ describe('gpg-cli.ts', function () {
3336
const binPath = 'bin path'
3437
const result = await cli.verify(sigPath, binPath)
3538
expect(result).toBeUndefined()
36-
expect(libExec.execOutput).toHaveBeenCalledWith(cliName, ['--verify', sigPath, binPath])
39+
expect(libExec.execOutput).toHaveBeenCalledWith(cliName, ['--verify', sigPath, binPath], {
40+
silent: false,
41+
failOnStdErr: false
42+
})
3743
})
3844
})
3945

‎lib/gpg-cli.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ export class GpgCli {
1515
}
1616

1717
async import(ascPath: string): Promise<void> {
18-
await execOutput(this.name, ['--import', ascPath])
18+
await execOutput(this.name, ['--import', ascPath], { silent: false, failOnStdErr: false })
1919
}
2020

2121
async verify(sigPath: string, binPath: string): Promise<void> {
22-
await execOutput(this.name, ['--verify', sigPath, binPath])
22+
await execOutput(this.name, ['--verify', sigPath, binPath], { silent: false, failOnStdErr: false })
2323
}
2424

2525
async help(): Promise<string> {

‎lib/trdl-cli.test.ts‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,4 +157,13 @@ describe('trdl-cli.ts', function () {
157157
expect(libExec.execOutput).toHaveBeenCalledWith(cliName, ['list'])
158158
})
159159
})
160+
describe('version', function () {
161+
it('should work', async function () {
162+
const stdout: string[] = ['1.2.3']
163+
libExec.execOutput.mockResolvedValueOnce({ stdout, stderr: [], exitCode: 0 })
164+
const result = await cli.version()
165+
expect(result).toEqual(stdout.join(''))
166+
expect(libExec.execOutput).toHaveBeenCalledWith(cliName, ['version'], { silent: false })
167+
})
168+
})
160169
})

0 commit comments

Comments
 (0)