Refactor GDS integration.

Author: fniephaus

__tests__/gds.test.ts

@@ -1,19 +1,30 @@
 import * as path from 'path'
+import * as c from '../src/constants'
 import {
   downloadGraalVMViaGDSByJavaVersion,
   downloadGraalVMViaGDSByJavaVersionEELegacy,
   fetchArtifact,
   fetchArtifactByJavaVersion,
   fetchArtifactEE
 } from '../src/gds'
-import { expect, test } from '@jest/globals'
+import { afterAll, beforeAll, expect, test } from '@jest/globals'
 import { fileURLToPath } from 'url'
 
 const TEST_USER_AGENT = 'GraalVMGitHubActionTest/1.0.4'
+const originalGDSTarget = { ...c.GDS_TARGET }
 
 const dirname = path.dirname(fileURLToPath(import.meta.url))
 process.env['RUNNER_TEMP'] = path.join(dirname, 'TEMP')
 
+beforeAll(() => {
+  // The asserted artifact IDs are Linux amd64 artifacts.
+  Object.assign(c.GDS_TARGET, { os: 'linux', arch: 'amd64' })
+})
+
+afterAll(() => {
+  Object.assign(c.GDS_TARGET, originalGDSTarget)
+})
+
 test('fetch artifacts', async () => {
   let artifact
   // Test innovation releases
@@ -28,32 +39,31 @@ test('fetch artifacts', async () => {
 })
 
 test('fetch artifacts by java version', async () => {
-  let artifact = await fetchArtifactByJavaVersion(TEST_USER_AGENT, 'isBase:True', '17.0.12')
+  let artifact = await fetchArtifactByJavaVersion(TEST_USER_AGENT, '17.0.12')
   expect(artifact.id).toBe('1C351E8F41BB8E9EE0631518000AE5F2')
   expect(artifact.checksum).toBe('b6f3dace24cf1960ec790216f4c86f00d4f43df64e4e8b548f6382f04894713f')
-  artifact = await fetchArtifactByJavaVersion(TEST_USER_AGENT, 'isBase:True', '17')
+  artifact = await fetchArtifactByJavaVersion(TEST_USER_AGENT, '17')
   expect(artifact.checksum).toHaveLength('b6f3dace24cf1960ec790216f4c86f00d4f43df64e4e8b548f6382f04894713f'.length)
 })
 
 test('errors when downloading artifacts', async () => {
   await expect(downloadGraalVMViaGDSByJavaVersion('invalid', '17')).rejects.toThrow(
     'The provided "gds-token" was rejected (reason: "Invalid download token", opc-request-id: '
   )
-  await expect(downloadGraalVMViaGDSByJavaVersion('invalid', '1')).rejects.toThrow('Unable to find GraalVM for JDK 1')
+  await expect(downloadGraalVMViaGDSByJavaVersion('invalid', '1')).rejects.toThrow(
+    "Unable to find GDS artifact. Are you sure java-version: '1' is correct?"
+  )
 })
 
 test('fetch legacy artifacts', async () => {
-  let artifact = await fetchArtifactEE(TEST_USER_AGENT, 'isBase:True', '22.1.0', '11')
+  let artifact = await fetchArtifactEE(TEST_USER_AGENT, '22.1.0', '11')
   expect(artifact.id).toBe('DCECD1C1B0B5B8DBE0536E16000A5C74')
   expect(artifact.checksum).toBe('4280782f6c7fcabe0ba707e8389cbfaf7bbe6b0cf634d309e6efcd1b172e3ce6')
-  artifact = await fetchArtifactEE(TEST_USER_AGENT, 'isBase:True', '22.1.0', '17')
+  artifact = await fetchArtifactEE(TEST_USER_AGENT, '22.1.0', '17')
   expect(artifact.id).toBe('DCECD2068882A0E9E0536E16000A9504')
   expect(artifact.checksum).toBe('e897add7d94bc456a61e6f927e831dff759efa3392a4b69c720dd3debc8f947d')
 
-  await expect(fetchArtifactEE(TEST_USER_AGENT, 'isBase:False', '22.1.0', '11')).rejects.toThrow(
-    'Found more than one GDS artifact'
-  )
-  await expect(fetchArtifactEE(TEST_USER_AGENT, 'isBase:True', '1.0.0', '11')).rejects.toThrow(
+  await expect(fetchArtifactEE(TEST_USER_AGENT, '1.0.0', '11')).rejects.toThrow(
     'Unable to find JDK11-based GraalVM EE 1.0.0'
   )
 })

dist/main.js

@@ -42,8 +42,28 @@ export const GRAALVM_RELEASES_REPO = 'graalvm-ce-builds'
 
 export const MANDREL_NAMESPACE = 'mandrel-'
 
-export const GDS_BASE = 'https://gds.oracle.com/api/20220101'
-export const GDS_GRAALVM_PRODUCT_ID = 'D53FAE8052773FFAE0530F15000AA6C6'
+const GDS_BASE = 'https://gds.oracle.com/api/20220101'
+const GDS_GRAALVM_PRODUCT_ID = 'D53FAE8052773FFAE0530F15000AA6C6'
+const GDS_ARTIFACTS_BASE = `${GDS_BASE}/artifacts?productId=${GDS_GRAALVM_PRODUCT_ID}&metadata=edition:ee&metadata=isBase:True&status=PUBLISHED&responseFields=id&responseFields=checksum`
+/* Latest is currently based on timeCreated. Eventually, we should sortBy=m:version when version sorting is fixed. */
+export const GDS_LAST_FILTER = '&sortBy=timeCreated&sortOrder=DESC'
+export const GDS_LATEST_FILTER = `${GDS_LAST_FILTER}&limit=1`
+export const GDS_USER_AGENT = `GraalVMGitHubAction/${ACTION_VERSION} (arch:${GRAALVM_ARCH}; os:${GRAALVM_PLATFORM})`
+
+/**
+ * Target platform used for GDS artifact queries. The binding remains constant,
+ * while tests may temporarily replace these fields for fixture-specific IDs.
+ */
+export const GDS_TARGET = {
+  arch: GRAALVM_ARCH,
+  os: IS_MACOS ? 'macos' : GRAALVM_PLATFORM
+}
+
+const gdsJDKFilter = (jdkMajorVersion: string | number) =>
+  `&metadata=java:jdk${jdkMajorVersion}&metadata=os:${GDS_TARGET.os}&metadata=arch:${GDS_TARGET.arch}`
+export const gdsArtifactQueryUrl = (jdkMajorVersion: string | number, filter: string) =>
+  `${GDS_ARTIFACTS_BASE}${gdsJDKFilter(jdkMajorVersion)}${filter}`
+export const gdsArtifactDownloadUrl = (artifactId: string) => `${GDS_BASE}/artifacts/${artifactId}/content`
 
 export const ENV_GITHUB_EVENT_NAME = 'GITHUB_EVENT_NAME'
 export const EVENT_NAME_PULL_REQUEST = 'pull_request'