bamanker/setup-graalvm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Support new GraalVM for JDK17/JDK20 release

Browse Source 
This commit adds support for the new GraalVM for JDK17/JDK20 release, including the new Oracle GraalVM distribution.
For this, users only need to specify the 'java-version' option and the new 'distribution' option.
The 'version' option is now marked as optional and kept for compatibility with older GraalVM releases and Mandrel.
This commit is contained in:
Fabio Niephaus
2023-06-16 09:19:49 +02:00
committed by Fabio Niephaus
parent 2f50b91043
commit c871f91ee0
14 changed files with 756 additions and 216 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
src/constants.ts
View File

@@ -3,6 +3,7 @@ import * as otypes from '@octokit/types'
export const INPUT_VERSION = 'version'
export const INPUT_GDS_TOKEN = 'gds-token'
export const INPUT_JAVA_VERSION = 'java-version'
export const INPUT_DISTRIBUTION = 'distribution'
export const INPUT_COMPONENTS = 'components'
export const INPUT_GITHUB_TOKEN = 'github-token'
export const INPUT_SET_JAVA_HOME = 'set-java-home'
@@ -14,15 +15,22 @@ export const IS_LINUX = process.platform === 'linux'
export const IS_MACOS = process.platform === 'darwin'
export const IS_WINDOWS = process.platform === 'win32'
export const DISTRIBUTION_GRAALVM = 'graalvm'
export const DISTRIBUTION_GRAALVM_COMMUNITY = 'graalvm-community'
export const DISTRIBUTION_MANDREL = 'mandrel'
export const VERSION_DEV = 'dev'
export const VERSION_LATEST = 'latest'
export const JDK_ARCH = determineJDKArchitecture()
export const JDK_PLATFORM = determineJDKPlatform()
export const JDK_HOME_SUFFIX = IS_MACOS ? '/Contents/Home' : ''
export const GRAALVM_ARCH = determineGraalVMArchitecture()
export const GRAALVM_FILE_EXTENSION = IS_WINDOWS ? '.zip' : '.tar.gz'
export const GRAALVM_GH_USER = 'graalvm'
export const GRAALVM_PLATFORM = IS_WINDOWS ? 'windows' : process.platform
export const GRAALVM_RELEASES_REPO = 'graalvm-ce-builds'
export const JDK_HOME_SUFFIX = IS_MACOS ? '/Contents/Home' : ''
export const MANDREL_NAMESPACE = 'mandrel-'
@@ -32,9 +40,46 @@ export const GDS_GRAALVM_PRODUCT_ID = 'D53FAE8052773FFAE0530F15000AA6C6'
export const ENV_GITHUB_EVENT_NAME = 'GITHUB_EVENT_NAME'
export const EVENT_NAME_PULL_REQUEST = 'pull_request'
export const ERROR_HINT =
'If you think this is a mistake, please file an issue at: https://github.com/graalvm/setup-graalvm/issues.'
export type LatestReleaseResponse =
otypes.Endpoints['GET /repos/{owner}/{repo}/releases/latest']['response']
export type MatchingRefsResponse =
otypes.Endpoints['GET /repos/{owner}/{repo}/git/matching-refs/{ref}']['response']
function determineJDKArchitecture(): string {
switch (process.arch) {
case 'x64': {
return 'x64'
}
case 'arm64': {
return 'aarch64'
}
default: {
throw new Error(`Unsupported architecture: ${process.arch}`)
}
}
}
function determineJDKPlatform(): string {
switch (process.platform) {
case 'linux': {
return 'linux'
}
case 'darwin': {
return 'macos'
}
case 'win32': {
return 'windows'
}
default: {
throw new Error(`Unsupported platform: ${process.platform}`)
}
}
}
function determineGraalVMArchitecture(): string {
switch (process.arch) {
case 'x64': {

11
src/features/check-for-updates.ts
View File

@@ -8,6 +8,17 @@ export async function checkForUpdates(
graalVMVersion: string,
javaVersion: string
): Promise<void> {
if (
graalVMVersion.length > 0 &&
(javaVersion === '17' || javaVersion === '19')
) {
const recommendedJDK = javaVersion === '17' ? '17' : '20'
core.notice(
`A new GraalVM release is available! Please consider upgrading to GraalVM for JDK ${recommendedJDK}. Release notes: https://www.graalvm.org/release-notes/JDK_${recommendedJDK}/`
)
return
}
if (graalVMVersion.startsWith('22.3.') && javaVersion === '11') {
core.notice(
'Please consider upgrading your project to Java 17+. GraalVM 22.3.X releases are the last to support JDK11: https://github.com/oracle/graal/issues/5063'

1
src/features/reports.ts
View File

@@ -88,6 +88,7 @@ export async function setUpNativeImageBuildReports(
const isSupported =
graalVMVersion === c.VERSION_LATEST ||
graalVMVersion === c.VERSION_DEV ||
graalVMVersion.length === 0 ||
(!graalVMVersion.startsWith(c.MANDREL_NAMESPACE) &&
gte(toSemVer(graalVMVersion), '22.2.0'))
if (!isSupported) {

2
src/gds.ts
View File

@@ -27,7 +27,7 @@ interface GDSErrorResponse {
readonly message: string
}
export async function downloadGraalVMEE(
export async function downloadGraalVMEELegacy(
gdsToken: string,
version: string,
javaVersion: string

210
src/graalvm.ts
View File

@@ -3,78 +3,129 @@ import {
downloadAndExtractJDK,
downloadExtractAndCacheJDK,
getLatestRelease,
getMatchingTags,
getTaggedRelease
} from './utils'
import {downloadGraalVMEE} from './gds'
import {downloadGraalVMEELegacy} from './gds'
import {downloadTool} from '@actions/tool-cache'
import {basename} from 'path'
import {gt} from 'semver'
const GRAALVM_DL_BASE = 'https://download.oracle.com/graalvm'
const GRAALVM_CE_DL_BASE = `https://github.com/graalvm/${c.GRAALVM_RELEASES_REPO}/releases/download`
const GRAALVM_REPO_DEV_BUILDS = 'graalvm-ce-dev-builds'
const GRAALVM_JDK_TAG_PREFIX = 'jdk-'
const GRAALVM_TAG_PREFIX = 'vm-'
export async function setUpGraalVMLatest(
gdsToken: string,
javaVersion: string
): Promise<string> {
const lockedVersion = '22.3.1'
if (gdsToken.length > 0) {
return setUpGraalVMRelease(gdsToken, lockedVersion, javaVersion)
}
const latestRelease = await getTaggedRelease(
c.GRAALVM_RELEASES_REPO,
GRAALVM_TAG_PREFIX + lockedVersion
)
const version = findGraalVMVersion(latestRelease)
return setUpGraalVMRelease(gdsToken, version, javaVersion)
}
// Support for GraalVM for JDK 17 and later
export function findGraalVMVersion(release: c.LatestReleaseResponse['data']) {
const tag_name = release.tag_name
if (!tag_name.startsWith(GRAALVM_TAG_PREFIX)) {
throw new Error(`Could not find latest GraalVM release: ${tag_name}`)
}
return tag_name.substring(GRAALVM_TAG_PREFIX.length, tag_name.length)
}
export async function setUpGraalVMDevBuild(
gdsToken: string,
javaVersion: string
export async function setUpGraalVMJDK(
javaVersionOrDev: string
): Promise<string> {
if (gdsToken.length > 0) {
throw new Error('Downloading GraalVM EE dev builds is not supported')
if (javaVersionOrDev === c.VERSION_DEV) {
return setUpGraalVMJDKDevBuild()
}
const latestDevBuild = await getLatestRelease(GRAALVM_REPO_DEV_BUILDS)
let resolvedJavaVersion
if (javaVersion == c.VERSION_DEV) {
resolvedJavaVersion = findHighestJavaVersion(latestDevBuild, c.VERSION_DEV)
const javaVersion = javaVersionOrDev
const toolName = determineToolName(javaVersion, false)
let downloadUrl: string
if (javaVersion.includes('.')) {
const majorJavaVersion = javaVersion.split('.')[0]
downloadUrl = `${GRAALVM_DL_BASE}/${majorJavaVersion}/archive/${toolName}${c.GRAALVM_FILE_EXTENSION}`
} else {
resolvedJavaVersion = javaVersion
downloadUrl = `${GRAALVM_DL_BASE}/${javaVersion}/latest/${toolName}${c.GRAALVM_FILE_EXTENSION}`
}
const downloader = async () => downloadGraalVMJDK(downloadUrl, javaVersion)
return downloadExtractAndCacheJDK(downloader, toolName, javaVersion)
}
export async function setUpGraalVMJDKCE(
javaVersionOrDev: string
): Promise<string> {
if (javaVersionOrDev === c.VERSION_DEV) {
return setUpGraalVMJDKDevBuild()
}
let javaVersion = javaVersionOrDev
if (!javaVersion.includes('.')) {
javaVersion = await findLatestGraalVMJDKCEJavaVersion(javaVersion)
}
if (javaVersion.split('.').length != 3) {
throw new Error(
`java-version set to '${javaVersionOrDev}', which was resolved to '${javaVersion}'. Please make sure the java-version is set correctly. ${c.ERROR_HINT}`
)
}
const toolName = determineToolName(javaVersion, true)
const downloadUrl = `${GRAALVM_CE_DL_BASE}/jdk-${javaVersion}/${toolName}${c.GRAALVM_FILE_EXTENSION}`
const downloader = async () => downloadGraalVMJDK(downloadUrl, javaVersion)
return downloadExtractAndCacheJDK(downloader, toolName, javaVersion)
}
export async function findLatestGraalVMJDKCEJavaVersion(
majorJavaVersion: string
): Promise<string> {
const matchingRefs = await getMatchingTags(
`${GRAALVM_JDK_TAG_PREFIX}${majorJavaVersion}`
)
const lowestNonExistingVersion = '0.0.1'
let highestVersion = lowestNonExistingVersion
const versionNumberStartIndex = `refs/tags/${GRAALVM_JDK_TAG_PREFIX}`.length
for (const matchingRef of matchingRefs) {
const currentVersion = matchingRef.ref.substring(versionNumberStartIndex)
if (gt(currentVersion, highestVersion)) {
highestVersion = currentVersion
}
}
if (highestVersion === lowestNonExistingVersion) {
throw new Error(
`Unable to find the latest Java version for '${majorJavaVersion}'. Please make sure the java-version is set correctly. ${c.ERROR_HINT}`
)
}
return highestVersion
}
function determineToolName(javaVersion: string, isCommunity: boolean) {
return `graalvm${isCommunity ? '-community' : ''}-jdk-${javaVersion}_${
c.JDK_PLATFORM
}-${c.JDK_ARCH}_bin`
}
async function downloadGraalVMJDK(
downloadUrl: string,
javaVersion: string
): Promise<string> {
try {
return await downloadTool(downloadUrl)
} catch (error) {
if (error instanceof Error && error.message.includes('404')) {
// Not Found
throw new Error(
`Failed to download ${basename(
downloadUrl
)}. Are you sure java-version: '${javaVersion}' is correct?`
)
}
throw new Error(
`Failed to download ${basename(downloadUrl)} (error: ${error}).`
)
}
}
// Support for GraalVM dev builds
export async function setUpGraalVMJDKDevBuild(): Promise<string> {
const latestDevBuild = await getLatestRelease(GRAALVM_REPO_DEV_BUILDS)
const resolvedJavaVersion = findHighestJavaVersion(
latestDevBuild,
c.VERSION_DEV
)
const downloadUrl = findDownloadUrl(latestDevBuild, resolvedJavaVersion)
return downloadAndExtractJDK(downloadUrl)
}
export async function setUpGraalVMRelease(
gdsToken: string,
version: string,
javaVersion: string
): Promise<string> {
const isEE = gdsToken.length > 0
const toolName = determineToolName(isEE, version, javaVersion)
let downloader: () => Promise<string>
if (isEE) {
downloader = async () => downloadGraalVMEE(gdsToken, version, javaVersion)
} else {
downloader = async () => downloadGraalVMCE(version, javaVersion)
}
return downloadExtractAndCacheJDK(downloader, toolName, version)
}
export function findHighestJavaVersion(
release: c.LatestReleaseResponse['data'],
version: string
): string {
const graalVMIdentifierPattern = determineGraalVMIdentifier(
const graalVMIdentifierPattern = determineGraalVMLegacyIdentifier(
false,
version,
'(\\d+)'
@@ -104,11 +155,54 @@ export function findHighestJavaVersion(
}
}
// Support for GraalVM 22.X releases and earlier
export async function setUpGraalVMLatest(
gdsToken: string,
javaVersion: string
): Promise<string> {
const lockedVersion = '22.3.1'
if (gdsToken.length > 0) {
return setUpGraalVMRelease(gdsToken, lockedVersion, javaVersion)
}
const latestRelease = await getTaggedRelease(
c.GRAALVM_RELEASES_REPO,
GRAALVM_TAG_PREFIX + lockedVersion
)
const version = findGraalVMVersion(latestRelease)
return setUpGraalVMRelease(gdsToken, version, javaVersion)
}
export function findGraalVMVersion(release: c.LatestReleaseResponse['data']) {
const tag_name = release.tag_name
if (!tag_name.startsWith(GRAALVM_TAG_PREFIX)) {
throw new Error(`Could not find latest GraalVM release: ${tag_name}`)
}
return tag_name.substring(GRAALVM_TAG_PREFIX.length, tag_name.length)
}
export async function setUpGraalVMRelease(
gdsToken: string,
version: string,
javaVersion: string
): Promise<string> {
const isEE = gdsToken.length > 0
const toolName = determineLegacyToolName(isEE, version, javaVersion)
let downloader: () => Promise<string>
if (isEE) {
downloader = async () =>
downloadGraalVMEELegacy(gdsToken, version, javaVersion)
} else {
downloader = async () => downloadGraalVMCELegacy(version, javaVersion)
}
return downloadExtractAndCacheJDK(downloader, toolName, version)
}
function findDownloadUrl(
release: c.LatestReleaseResponse['data'],
javaVersion: string
): string {
const graalVMIdentifier = determineGraalVMIdentifier(
const graalVMIdentifier = determineGraalVMLegacyIdentifier(
false,
c.VERSION_DEV,
javaVersion
@@ -120,21 +214,21 @@ function findDownloadUrl(
}
}
throw new Error(
`Could not find GraalVM dev build for Java ${javaVersion}. It may no longer be available, so please consider upgrading the Java version. If you think this is a mistake, please file an issue at: https://github.com/graalvm/setup-graalvm/issues.`
`Could not find GraalVM dev build for Java ${javaVersion}. It may no longer be available, so please consider upgrading the Java version. ${c.ERROR_HINT}`
)
}
function determineGraalVMIdentifier(
function determineGraalVMLegacyIdentifier(
isEE: boolean,
version: string,
javaVersion: string
): string {
return `${determineToolName(isEE, version, javaVersion)}-${
return `${determineLegacyToolName(isEE, version, javaVersion)}-${
c.GRAALVM_ARCH
}-${version}`
}
function determineToolName(
function determineLegacyToolName(
isEE: boolean,
version: string,
javaVersion: string
@@ -143,11 +237,11 @@ function determineToolName(
return `graalvm-${infix}-java${javaVersion}-${c.GRAALVM_PLATFORM}`
}
async function downloadGraalVMCE(
async function downloadGraalVMCELegacy(
version: string,
javaVersion: string
): Promise<string> {
const graalVMIdentifier = determineGraalVMIdentifier(
const graalVMIdentifier = determineGraalVMLegacyIdentifier(
false,
version,
javaVersion

89
src/main.ts
View File

@@ -14,9 +14,10 @@ import {setUpNativeImageBuildReports} from './features/reports'
async function run(): Promise<void> {
try {
const graalvmVersion = core.getInput(c.INPUT_VERSION, {required: true})
const gdsToken = core.getInput(c.INPUT_GDS_TOKEN)
const javaVersion = core.getInput(c.INPUT_JAVA_VERSION, {required: true})
const distribution = core.getInput(c.INPUT_DISTRIBUTION)
const graalvmVersion = core.getInput(c.INPUT_VERSION)
const gdsToken = core.getInput(c.INPUT_GDS_TOKEN)
const componentsString: string = core.getInput(c.INPUT_COMPONENTS)
const components: string[] =
componentsString.length > 0
@@ -38,27 +39,71 @@ async function run(): Promise<void> {
// Download or build GraalVM
let graalVMHome
switch (graalvmVersion) {
case c.VERSION_LATEST:
graalVMHome = await graalvm.setUpGraalVMLatest(gdsToken, javaVersion)
break
case c.VERSION_DEV:
graalVMHome = await graalvm.setUpGraalVMDevBuild(gdsToken, javaVersion)
break
default:
if (graalvmVersion.startsWith(c.MANDREL_NAMESPACE)) {
graalVMHome = await setUpMandrel(graalvmVersion, javaVersion)
} else {
if (enableCheckForUpdates) {
await checkForUpdates(graalvmVersion, javaVersion)
}
graalVMHome = await graalvm.setUpGraalVMRelease(
gdsToken,
graalvmVersion,
javaVersion
if (distribution.length > 0 || graalvmVersion.length == 0) {
switch (distribution) {
case c.DISTRIBUTION_GRAALVM:
graalVMHome = await graalvm.setUpGraalVMJDK(javaVersion)
break
case c.DISTRIBUTION_GRAALVM_COMMUNITY:
graalVMHome = await graalvm.setUpGraalVMJDKCE(javaVersion)
break
case c.DISTRIBUTION_MANDREL:
throw new Error(
`Mandrel requires the 'version' option (see https://github.com/graalvm/setup-graalvm/tree/main#options).`
)
}
break
case '':
if (javaVersion === c.VERSION_DEV) {
core.info(
`This build is using the GraalVM Community Edition. To select a specific distribution, use the 'distribution' option (see https://github.com/graalvm/setup-graalvm/tree/main#options).`
)
graalVMHome = await graalvm.setUpGraalVMJDKDevBuild()
} else {
core.info(
`This build is using the new Oracle GraalVM. To select a specific distribution, use the 'distribution' option (see https://github.com/graalvm/setup-graalvm/tree/main#options).`
)
graalVMHome = await graalvm.setUpGraalVMJDK(javaVersion)
}
default:
throw new Error(`Unsupported distribution: ${distribution}`)
}
} else {
switch (graalvmVersion) {
case c.VERSION_LATEST:
if (javaVersion.startsWith('17') || javaVersion.startsWith('20')) {
core.info(
`This build is using the new Oracle GraalVM. To select a specific distribution, use the 'distribution' option (see https://github.com/graalvm/setup-graalvm/tree/main#options).`
)
graalVMHome = await graalvm.setUpGraalVMJDK(javaVersion)
} else {
graalVMHome = await graalvm.setUpGraalVMLatest(
gdsToken,
javaVersion
)
}
break
case c.VERSION_DEV:
if (gdsToken.length > 0) {
throw new Error(
'Downloading GraalVM EE dev builds is not supported'
)
}
graalVMHome = await graalvm.setUpGraalVMJDKDevBuild()
break
default:
if (graalvmVersion.startsWith(c.MANDREL_NAMESPACE)) {
graalVMHome = await setUpMandrel(graalvmVersion, javaVersion)
} else {
if (enableCheckForUpdates) {
await checkForUpdates(graalvmVersion, javaVersion)
}
graalVMHome = await graalvm.setUpGraalVMRelease(
gdsToken,
graalvmVersion,
javaVersion
)
}
break
}
}
// Activate GraalVM

18
src/utils.ts
View File

@@ -63,6 +63,24 @@ export async function getTaggedRelease(
).data
}
export async function getMatchingTags(
tagPrefix: string
): Promise<c.MatchingRefsResponse['data']> {
const githubToken = getGitHubToken()
const options = githubToken.length > 0 ? {auth: githubToken} : {}
const octokit = new GitHubDotCom(options)
return (
await octokit.request(
'GET /repos/{owner}/{repo}/git/matching-refs/tags/{tagPrefix}',
{
owner: c.GRAALVM_GH_USER,
repo: c.GRAALVM_RELEASES_REPO,
tagPrefix
}
)
).data
}
export async function downloadAndExtractJDK(
downloadUrl: string
): Promise<string> {