Skip to content

Commit 93397be

Browse files
dsamedsame
authored
Fix Install on Windows is very slow (#393)
* Fix Install on Windows is very slow * Add unit test * Improve readability * Add e2e test * fix lint * Fix unit tests * Fix unit tests * limit to github hosted runners * test hosted version of go * AzDev environment * rename lnkSrc * refactor conditions * improve tests * refactoring * Fix e2e test * improve isHosted readability
1 parent 27eec5b commit 93397be

File tree

5 files changed

+291
-12
lines changed

5 files changed

+291
-12
lines changed

‎.github/workflows/windows-validation.yml‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
name: Validate Windows installation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths-ignore:
8+
- '**.md'
9+
pull_request:
10+
paths-ignore:
11+
- '**.md'
12+
13+
jobs:
14+
create-link-if-not-default:
15+
runs-on: windows-latest
16+
name: 'Validate if symlink is created'
17+
strategy:
18+
matrix:
19+
cache: [false, true]
20+
go: [1.20.1]
21+
steps:
22+
- uses: actions/checkout@v3
23+
24+
- name: 'Setup ${{ matrix.cache }}, cache: ${{ matrix.go }}'
25+
uses: ./
26+
with:
27+
go-version: ${{ matrix.go }}
28+
cache: ${{ matrix.cache }}
29+
30+
- name: 'Drive C: should have zero size link'
31+
run: |
32+
du -m -s 'C:\hostedtoolcache\windows\go\${{ matrix.go }}\x64'
33+
# make sure drive c: contains only a link
34+
size=$(du -m -s 'C:\hostedtoolcache\windows\go\${{ matrix.go }}\x64'|cut -f1 -d$'\t')
35+
if [ $size -ne 0 ];then
36+
echo 'Size of the link created on drive c: must be 0'
37+
exit 1
38+
fi
39+
shell: bash
40+
41+
# Drive D: is small, take care the action does not eat up the space
42+
- name: 'Drive D: space usage should be below 1G'
43+
run: |
44+
du -m -s 'D:\hostedtoolcache\windows\go\${{ matrix.go }}\x64'
45+
size=$(du -m -s 'D:\hostedtoolcache\windows\go\${{ matrix.go }}\x64'|cut -f1 -d$'\t')
46+
# make sure archive does not take lot of space
47+
if [ $size -gt 999 ];then
48+
echo 'Size of installed on drive d: go is too big';
49+
exit 1
50+
fi
51+
shell: bash
52+
53+
# make sure the Go installation has not been changed to the end user
54+
- name: Test paths and environments
55+
run: |
56+
echo $PATH
57+
which go
58+
go version
59+
go env
60+
if [ $(which go) != '/c/hostedtoolcache/windows/go/${{ matrix.go }}/x64/bin/go' ];then
61+
echo 'which go should return "/c/hostedtoolcache/windows/go/${{ matrix.go }}/x64/bin/go"'
62+
exit 1
63+
fi
64+
if [ $(go env GOROOT) != 'C:\hostedtoolcache\windows\go\${{ matrix.go }}\x64' ];then
65+
echo 'go env GOROOT should return "C:\hostedtoolcache\windows\go\${{ matrix.go }}\x64"'
66+
exit 1
67+
fi
68+
shell: bash
69+
70+
find-default-go:
71+
name: 'Find default go version'
72+
runs-on: windows-latest
73+
outputs:
74+
version: ${{ steps.goversion.outputs.version }}
75+
steps:
76+
- run: |
77+
version=`go env GOVERSION|sed s/^go//`
78+
echo "default go version: $version"
79+
echo "version=$version" >> "$GITHUB_OUTPUT"
80+
id: goversion
81+
shell: bash
82+
83+
dont-create-link-if-default:
84+
name: 'Validate if symlink is not created for default go'
85+
runs-on: windows-latest
86+
needs: find-default-go
87+
strategy:
88+
matrix:
89+
cache: [false, true]
90+
steps:
91+
- uses: actions/checkout@v3
92+
93+
- name: 'Setup default go, cache: ${{ matrix.cache }}'
94+
uses: ./
95+
with:
96+
go-version: ${{ needs.find-default-go.outputs.version }}
97+
cache: ${{ matrix.cache }}
98+
99+
- name: 'Drive C: should have Go installation, cache: ${{ matrix.cache}}'
100+
run: |
101+
size=$(du -m -s 'C:\hostedtoolcache\windows\go\${{ needs.find-default-go.outputs.version }}\x64'|cut -f1 -d$'\t')
102+
if [ $size -eq 0 ];then
103+
echo 'Size of the hosted go installed on drive c: must be above zero'
104+
exit 1
105+
fi
106+
shell: bash
107+
108+
- name: 'Drive D: should not have Go installation, cache: ${{ matrix.cache}}'
109+
run: |
110+
if [ -e 'D:\hostedtoolcache\windows\go\${{ needs.find-default-go.outputs.version }}\x64' ];then
111+
echo 'D:\hostedtoolcache\windows\go\${{ needs.find-default-go.outputs.version }}\x64 should not exist for hosted version of go';
112+
exit 1
113+
fi
114+
shell: bash

‎__tests__/setup-go.test.ts‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import * as io from '@actions/io';
33
import * as tc from '@actions/tool-cache';
44
import fs from 'fs';
55
import cp from 'child_process';
6-
import osm from 'os';
6+
import osm, {type} from 'os';
77
import path from 'path';
88
import * as main from '../src/main';
99
import * as im from '../src/installer';
@@ -16,6 +16,8 @@ const matcherRegExp = new RegExp(matcherPattern.regexp);
1616
const win32Join = path.win32.join;
1717
const posixJoin = path.posix.join;
1818

19+
jest.setTimeout(10000);
20+
1921
describe('setup-go', () => {
2022
let inputs = {} as any;
2123
let os = {} as any;
@@ -39,6 +41,8 @@ describe('setup-go', () => {
3941
let existsSpy: jest.SpyInstance;
4042
let readFileSpy: jest.SpyInstance;
4143
let mkdirpSpy: jest.SpyInstance;
44+
let mkdirSpy: jest.SpyInstance;
45+
let symlinkSpy: jest.SpyInstance;
4246
let execSpy: jest.SpyInstance;
4347
let getManifestSpy: jest.SpyInstance;
4448
let getAllVersionsSpy: jest.SpyInstance;
@@ -92,6 +96,11 @@ describe('setup-go', () => {
9296
readFileSpy = jest.spyOn(fs, 'readFileSync');
9397
mkdirpSpy = jest.spyOn(io, 'mkdirP');
9498

99+
// fs
100+
mkdirSpy = jest.spyOn(fs, 'mkdir');
101+
symlinkSpy = jest.spyOn(fs, 'symlinkSync');
102+
symlinkSpy.mockImplementation(() => {});
103+
95104
// gets
96105
getManifestSpy.mockImplementation(() => <tc.IToolRelease[]>goTestManifest);
97106

‎__tests__/windows-toolcache.test.ts‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
import fs from 'fs';
2+
import * as io from '@actions/io';
3+
import * as tc from '@actions/tool-cache';
4+
import path from 'path';
5+
6+
describe('Windows performance workaround', () => {
7+
let mkdirSpy: jest.SpyInstance;
8+
let symlinkSpy: jest.SpyInstance;
9+
let statSpy: jest.SpyInstance;
10+
let readdirSpy: jest.SpyInstance;
11+
let writeFileSpy: jest.SpyInstance;
12+
let rmRFSpy: jest.SpyInstance;
13+
let mkdirPSpy: jest.SpyInstance;
14+
let cpSpy: jest.SpyInstance;
15+
16+
let runnerToolCache: string | undefined;
17+
beforeEach(() => {
18+
mkdirSpy = jest.spyOn(fs, 'mkdir');
19+
symlinkSpy = jest.spyOn(fs, 'symlinkSync');
20+
statSpy = jest.spyOn(fs, 'statSync');
21+
readdirSpy = jest.spyOn(fs, 'readdirSync');
22+
writeFileSpy = jest.spyOn(fs, 'writeFileSync');
23+
rmRFSpy = jest.spyOn(io, 'rmRF');
24+
mkdirPSpy = jest.spyOn(io, 'mkdirP');
25+
cpSpy = jest.spyOn(io, 'cp');
26+
27+
// default implementations
28+
// @ts-ignore - not implement unused methods
29+
statSpy.mockImplementation(() => ({
30+
isDirectory: () => true
31+
}));
32+
readdirSpy.mockImplementation(() => []);
33+
writeFileSpy.mockImplementation(() => {});
34+
mkdirSpy.mockImplementation(() => {});
35+
symlinkSpy.mockImplementation(() => {});
36+
rmRFSpy.mockImplementation(() => Promise.resolve());
37+
mkdirPSpy.mockImplementation(() => Promise.resolve());
38+
cpSpy.mockImplementation(() => Promise.resolve());
39+
40+
runnerToolCache = process.env['RUNNER_TOOL_CACHE'];
41+
});
42+
afterEach(() => {
43+
jest.clearAllMocks();
44+
process.env['RUNNER_TOOL_CACHE'] = runnerToolCache;
45+
});
46+
// cacheWindowsToolkitDir depends on implementation of tc.cacheDir
47+
// with the assumption that target dir is passed by RUNNER_TOOL_CACHE environment variable
48+
// Make sure the implementation has not been changed
49+
it('addExecutablesToCache should depend on env[RUNNER_TOOL_CACHE]', async () => {
50+
process.env['RUNNER_TOOL_CACHE'] = '/faked-hostedtoolcache1';
51+
const cacheDir1 = await tc.cacheDir('/qzx', 'go', '1.2.3', 'arch');
52+
expect(cacheDir1).toBe(
53+
path.join('/', 'faked-hostedtoolcache1', 'go', '1.2.3', 'arch')
54+
);
55+
56+
process.env['RUNNER_TOOL_CACHE'] = '/faked-hostedtoolcache2';
57+
const cacheDir2 = await tc.cacheDir('/qzx', 'go', '1.2.3', 'arch');
58+
expect(cacheDir2).toBe(
59+
path.join('/', 'faked-hostedtoolcache2', 'go', '1.2.3', 'arch')
60+
);
61+
});
62+
});

‎dist/setup/index.js‎

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61488,6 +61488,46 @@ function resolveVersionFromManifest(versionSpec, stable, auth, arch, manifest) {
6148861488
}
6148961489
});
6149061490
}
61491+
// for github hosted windows runner handle latency of OS drive
61492+
// by avoiding write operations to C:
61493+
function cacheWindowsDir(extPath, tool, version, arch) {
61494+
return __awaiter(this, void 0, void 0, function* () {
61495+
if (os_1.default.platform() !== 'win32')
61496+
return false;
61497+
// make sure the action runs in the hosted environment
61498+
if (process.env['RUNNER_ENVIRONMENT'] !== 'github-hosted' &&
61499+
process.env['AGENT_ISSELFHOSTED'] === '1')
61500+
return false;
61501+
const defaultToolCacheRoot = process.env['RUNNER_TOOL_CACHE'];
61502+
if (!defaultToolCacheRoot)
61503+
return false;
61504+
if (!fs_1.default.existsSync('d:\\') || !fs_1.default.existsSync('c:\\'))
61505+
return false;
61506+
const actualToolCacheRoot = defaultToolCacheRoot
61507+
.replace('C:', 'D:')
61508+
.replace('c:', 'd:');
61509+
// make toolcache root to be on drive d:
61510+
process.env['RUNNER_TOOL_CACHE'] = actualToolCacheRoot;
61511+
const actualToolCacheDir = yield tc.cacheDir(extPath, tool, version, arch);
61512+
// create a link from c: to d:
61513+
const defaultToolCacheDir = actualToolCacheDir.replace(actualToolCacheRoot, defaultToolCacheRoot);
61514+
fs_1.default.mkdirSync(path.dirname(defaultToolCacheDir), { recursive: true });
61515+
fs_1.default.symlinkSync(actualToolCacheDir, defaultToolCacheDir, 'junction');
61516+
core.info(`Created link ${defaultToolCacheDir} => ${actualToolCacheDir}`);
61517+
// make outer code to continue using toolcache as if it were installed on c:
61518+
// restore toolcache root to default drive c:
61519+
process.env['RUNNER_TOOL_CACHE'] = defaultToolCacheRoot;
61520+
return defaultToolCacheDir;
61521+
});
61522+
}
61523+
function addExecutablesToToolCache(extPath, info, arch) {
61524+
return __awaiter(this, void 0, void 0, function* () {
61525+
const tool = 'go';
61526+
const version = makeSemver(info.resolvedVersion);
61527+
return ((yield cacheWindowsDir(extPath, tool, version, arch)) ||
61528+
(yield tc.cacheDir(extPath, tool, version, arch)));
61529+
});
61530+
}
6149161531
function installGoVersion(info, auth, arch) {
6149261532
return __awaiter(this, void 0, void 0, function* () {
6149361533
core.info(`Acquiring ${info.resolvedVersion} from ${info.downloadUrl}`);
@@ -61503,9 +61543,9 @@ function installGoVersion(info, auth, arch) {
6150361543
extPath = path.join(extPath, 'go');
6150461544
}
6150561545
core.info('Adding to the cache ...');
61506-
const cachedDir = yield tc.cacheDir(extPath, 'go', makeSemver(info.resolvedVersion), arch);
61507-
core.info(`Successfully cached go to ${cachedDir}`);
61508-
return cachedDir;
61546+
const toolCacheDir = yield addExecutablesToToolCache(extPath, info, arch);
61547+
core.info(`Successfully cached go to ${toolCacheDir}`);
61548+
return toolCacheDir;
6150961549
});
6151061550
}
6151161551
function extractGoArchive(archivePath) {

‎src/installer.ts‎

Lines changed: 62 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,64 @@ async function resolveVersionFromManifest(
164164
}
165165
}
166166

167+
// for github hosted windows runner handle latency of OS drive
168+
// by avoiding write operations to C:
169+
async function cacheWindowsDir(
170+
extPath: string,
171+
tool: string,
172+
version: string,
173+
arch: string
174+
): Promise<string | false> {
175+
if (os.platform() !== 'win32') return false;
176+
177+
// make sure the action runs in the hosted environment
178+
if (
179+
process.env['RUNNER_ENVIRONMENT'] !== 'github-hosted' &&
180+
process.env['AGENT_ISSELFHOSTED'] === '1'
181+
)
182+
return false;
183+
184+
const defaultToolCacheRoot = process.env['RUNNER_TOOL_CACHE'];
185+
if (!defaultToolCacheRoot) return false;
186+
187+
if (!fs.existsSync('d:\\') || !fs.existsSync('c:\\')) return false;
188+
189+
const actualToolCacheRoot = defaultToolCacheRoot
190+
.replace('C:', 'D:')
191+
.replace('c:', 'd:');
192+
// make toolcache root to be on drive d:
193+
process.env['RUNNER_TOOL_CACHE'] = actualToolCacheRoot;
194+
195+
const actualToolCacheDir = await tc.cacheDir(extPath, tool, version, arch);
196+
197+
// create a link from c: to d:
198+
const defaultToolCacheDir = actualToolCacheDir.replace(
199+
actualToolCacheRoot,
200+
defaultToolCacheRoot
201+
);
202+
fs.mkdirSync(path.dirname(defaultToolCacheDir), {recursive: true});
203+
fs.symlinkSync(actualToolCacheDir, defaultToolCacheDir, 'junction');
204+
core.info(`Created link ${defaultToolCacheDir} => ${actualToolCacheDir}`);
205+
206+
// make outer code to continue using toolcache as if it were installed on c:
207+
// restore toolcache root to default drive c:
208+
process.env['RUNNER_TOOL_CACHE'] = defaultToolCacheRoot;
209+
return defaultToolCacheDir;
210+
}
211+
212+
async function addExecutablesToToolCache(
213+
extPath: string,
214+
info: IGoVersionInfo,
215+
arch: string
216+
): Promise<string> {
217+
const tool = 'go';
218+
const version = makeSemver(info.resolvedVersion);
219+
return (
220+
(await cacheWindowsDir(extPath, tool, version, arch)) ||
221+
(await tc.cacheDir(extPath, tool, version, arch))
222+
);
223+
}
224+
167225
async function installGoVersion(
168226
info: IGoVersionInfo,
169227
auth: string | undefined,
@@ -186,14 +244,10 @@ async function installGoVersion(
186244
}
187245

188246
core.info('Adding to the cache ...');
189-
const cachedDir = await tc.cacheDir(
190-
extPath,
191-
'go',
192-
makeSemver(info.resolvedVersion),
193-
arch
194-
);
195-
core.info(`Successfully cached go to ${cachedDir}`);
196-
return cachedDir;
247+
const toolCacheDir = await addExecutablesToToolCache(extPath, info, arch);
248+
core.info(`Successfully cached go to ${toolCacheDir}`);
249+
250+
return toolCacheDir;
197251
}
198252

199253
export async function extractGoArchive(archivePath: string): Promise<string> {

0 commit comments

Comments
 (0)