FilesExpand file tree

 main

/

util.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

270 lines (223 loc) · 7.72 KB

 main

/

util.ts

Copy path

Top

File metadata and controls

• Code
• Blame

270 lines (223 loc) · 7.72 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

import os from 'os';

import path from 'path';

import * as fs from 'fs';

import * as semver from 'semver';

import * as cache from '@actions/cache';

import * as core from '@actions/core';

import * as tc from '@actions/tool-cache';

import {INPUT_JOB_STATUS, DISTRIBUTIONS_ONLY_MAJOR_VERSION} from './constants';

import {OutgoingHttpHeaders} from 'http';

export function getTempDir() {

const tempDirectory = process.env['RUNNER_TEMP'] || os.tmpdir();

return tempDirectory;

}

export function getBooleanInput(inputName: string, defaultValue = false) {

return (

(core.getInput(inputName) || String(defaultValue)).toUpperCase() === 'TRUE'

);

}

export function getVersionFromToolcachePath(toolPath: string) {

if (toolPath) {

return path.basename(path.dirname(toolPath));

}

return toolPath;

}

export async function extractJdkFile(toolPath: string, extension?: string) {

if (!extension) {

extension = toolPath.endsWith('.tar.gz')

? 'tar.gz'

: path.extname(toolPath);

if (extension.startsWith('.')) {

extension = extension.substring(1);

}

}

switch (extension) {

case 'tar.gz':

case 'tar':

return await tc.extractTar(toolPath);

case 'zip':

return await tc.extractZip(toolPath);

default:

return await tc.extract7z(toolPath);

}

}

export function getDownloadArchiveExtension() {

return process.platform === 'win32' ? 'zip' : 'tar.gz';

}

export function isVersionSatisfies(range: string, version: string): boolean {

// Some distributions (e.g. JetBrains Runtime) publish 4-segment versions

// like '17.0.8.1+1080.1' that semver rejects. If the candidate version

// isn't valid semver, it can't match — bail out rather than letting

// compareBuild / satisfies throw.

if (!semver.valid(version)) {

return false;

}

if (semver.valid(range)) {

// if full version with build digit is provided as a range (such as '1.2.3+4')

// we should check for exact equal via compareBuild

// since semver.satisfies doesn't handle 4th digit

const semRange = semver.parse(range);

if (semRange && semRange.build?.length > 0) {

return semver.compareBuild(range, version) === 0;

}

}

return semver.satisfies(version, range);

}

export function getToolcachePath(

toolName: string,

version: string,

architecture: string

) {

const toolcacheRoot = process.env['RUNNER_TOOL_CACHE'] ?? '';

const fullPath = path.join(toolcacheRoot, toolName, version, architecture);

if (fs.existsSync(fullPath)) {

return fullPath;

}

return null;

}

export function isJobStatusSuccess() {

const jobStatus = core.getInput(INPUT_JOB_STATUS);

return jobStatus === 'success';

}

export function isGhes(): boolean {

const ghUrl = new URL(

process.env['GITHUB_SERVER_URL'] || 'https://github.com'

);

const hostname = ghUrl.hostname.trimEnd().toUpperCase();

const isGitHubHost = hostname === 'GITHUB.COM';

const isGitHubEnterpriseCloudHost = hostname.endsWith('.GHE.COM');

const isLocalHost = hostname.endsWith('.LOCALHOST');

return !isGitHubHost && !isGitHubEnterpriseCloudHost && !isLocalHost;

}

export function isCacheFeatureAvailable(): boolean {

if (cache.isFeatureAvailable()) {

return true;

}

if (isGhes()) {

core.warning(

'Caching is only supported on GHES version >= 3.5. If you are on a version >= 3.5, please check with your GHES admin if the Actions cache service is enabled or not.'

);

return false;

}

core.warning(

'The runner was not able to contact the cache service. Caching will be skipped'

);

return false;

}

export function getVersionFromFileContent(

content: string,

distributionName: string,

versionFile: string

): string | null {

let javaVersionRegExp: RegExp;

function getFileName(versionFile: string) {

return path.basename(versionFile);

}

const versionFileName = getFileName(versionFile);

if (versionFileName == '.tool-versions') {

javaVersionRegExp =

/^java\s+(?:\S*-)?(?<version>\d+(?:\.\d+)*([+_.-](?:openj9[-._]?\d[\w.-]*|java\d+|jre[-_\w]*|OpenJDK\d+[\w_.-]*|[a-z0-9]+))*)/im;

} else if (versionFileName == '.sdkmanrc') {

javaVersionRegExp = /^java\s*=\s*(?<version>[^-]+)/m;

} else {

javaVersionRegExp = /(?<version>(?<=(^|\s|-))(\d+\S*))(\s|$)/;

}

const capturedVersion = content.match(javaVersionRegExp)?.groups?.version

? (content.match(javaVersionRegExp)?.groups?.version as string)

: '';

core.debug(

`Parsed version '${capturedVersion}' from file '${versionFileName}'`

);

if (!capturedVersion) {

return null;

}

const tentativeVersion = avoidOldNotation(capturedVersion);

const rawVersion = tentativeVersion.split('-')[0];

let version = semver.validRange(rawVersion)

? tentativeVersion

: semver.coerce(tentativeVersion);

core.debug(`Range version from file is '${version}'`);

if (!version) {

return null;

}

if (DISTRIBUTIONS_ONLY_MAJOR_VERSION.includes(distributionName)) {

const coerceVersion = semver.coerce(version) ?? version;

version = semver.major(coerceVersion).toString();

}

return version.toString();

}

// By convention, action expects version 8 in the format `8.*` instead of `1.8`

function avoidOldNotation(content: string): string {

return content.startsWith('1.') ? content.substring(2) : content;

}

export function convertVersionToSemver(version: number[] | string) {

// Some distributions may use semver-like notation (12.10.2.1, 12.10.2.1.1)

const versionArray = Array.isArray(version) ? version : version.split('.');

const mainVersion = versionArray.slice(0, 3).join('.');

if (versionArray.length > 3) {

return `${mainVersion}+${versionArray.slice(3).join('.')}`;

}

return mainVersion;

}

export function getGitHubHttpHeaders(): OutgoingHttpHeaders {

const resolvedToken = core.getInput('token') || process.env.GITHUB_TOKEN;

const auth = !resolvedToken ? undefined : `token ${resolvedToken}`;

const headers: OutgoingHttpHeaders = {

accept: 'application/vnd.github.VERSION.raw'

};

if (auth) {

headers.authorization = auth;

}

return headers;

}

export const MAX_PAGINATION_PAGES = 1000;

export function getNextPageUrlFromLinkHeader(

headers?: Record<string, string | string[] | undefined>

): string | null {

if (!headers) {

return null;

}

const linkHeader = headers.link ?? headers.Link;

if (!linkHeader) {

return null;

}

const normalizedLinkHeader = Array.isArray(linkHeader)

? linkHeader.join(',')

: linkHeader;

// Split into individual link-values and find the one with rel="next"

// RFC 8288 allows rel to appear anywhere among the parameters

const linkValues = normalizedLinkHeader.split(/,(?=\s*<)/);

for (const linkValue of linkValues) {

const urlMatch = linkValue.match(/<([^>]+)>/);

if (!urlMatch) continue;

const params = linkValue.slice(urlMatch[0].length);

// Use word boundary to match "next" as a standalone relation type

// RFC 8288 allows space-separated relation types like rel="next prev"

if (/;\s*rel="?[^"]*\bnext\b/i.test(params)) {

return urlMatch[1];

}

}

return null;

}

export function validatePaginationUrl(

url: string,

allowedOrigin: string

): boolean {

try {

const parsed = new URL(url);

const allowed = new URL(allowedOrigin);

return parsed.origin === allowed.origin;

} catch {

return false;

}

}

// Rename archive to add extension because after downloading

// archive does not contain extension type and it leads to some issues

// on Windows runners without PowerShell Core.

//

// For default PowerShell Windows it should contain extension type to unpack it.

export function renameWinArchive(javaArchivePath: string): string {

const javaArchivePathRenamed = `${javaArchivePath}.zip`;

fs.renameSync(javaArchivePath, javaArchivePathRenamed);

return javaArchivePathRenamed;

}