Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor of Origins API Tests for Improved Robustness and Efficiency #122

Merged
merged 2 commits into from
Mar 12, 2025
Merged

Refactor of Origins API Tests for Improved Robustness and Efficiency #122

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b67b1f7
Refactored originsAPI tests for improving efficiency
yashkohli88 Feb 22, 2025
3972cb6
Update for better readability
yashkohli88 Mar 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 58 additions & 37 deletions tools/integration/test/integration/e2e-test-service/originsTest.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@

const assert = require('assert')
const { callFetchWithRetry: callFetch } = require('../../../lib/fetch')
const { devApiBaseUrl, prodApiBaseUrl, getComponents, origins } = require('../testConfig')
const { devApiBaseUrl, getComponents, origins } = require('../testConfig')

const ORIGIN_EXCLUSION_LIST = ['go/golang', 'debsrc/debian', 'maven/mavengoogle']
const ORIGIN_REVISIONS_EXCLUSION_LIST = ['debsrc/debian']

const MAVEN_COMPONENT_GROUP_ID = 'maven/mavencentral/org.apache.httpcomponents'
const MAVEN_COMPONENT_PARTIAL_GROUP_ID = 'maven/mavencentral/org.apache.httpcompon'
const MAVEN_COMPONENT_GROUP_ID = 'maven/mavencentral/org.apache.httpcomponents//'
const MAVEN_COMPONENT_PARTIAL_GROUP_ID = 'maven/org.apache.httpcompone'
const GRADLE_COMPONENT_ENDPOINT = 'gradleplugin/io.github.lognet.grpc-spring-boot'

;(async function validateOriginsApi() {
Expand All @@ -20,52 +20,60 @@ const GRADLE_COMPONENT_ENDPOINT = 'gradleplugin/io.github.lognet.grpc-spring-boo

afterEach(() => new Promise(resolve => setTimeout(resolve, origins.timeout / 2)))

components.filter(isOriginAllowed).forEach(component => {
it(`Validates Origins API response for ${component}`, () => compareOrigins(component))
components.filter(isComponentIncluded).forEach(component => {
it(`Validates Origins API response for ${component}`, () => validateOriginResponses(component))
})

components.filter(isOriginWithRevisionsAllowed).forEach(component => {
it(`Validates Origins API response with revisions for ${component}`, () => compareOriginsWithRevisions(component))
components.filter(isComponentIncludedWithRevisions).forEach(component => {
it(`Validates Origins API response with revisions for ${component}`, () =>
validateOriginResponsesWithRevisions(component))
})

it('Validates Origins API response for a Maven component with only a group ID', () =>
compareOrigins(MAVEN_COMPONENT_GROUP_ID))
validateOriginResponses(MAVEN_COMPONENT_GROUP_ID))

it('Validates Origins API response for a Maven component with a partial group ID for suggestion checks', () =>
compareOrigins(MAVEN_COMPONENT_PARTIAL_GROUP_ID))
validateEndpointWithRevisions(MAVEN_COMPONENT_PARTIAL_GROUP_ID, 'httpcore'))

it('Validates Origins API response for a Gradle plugin component', () =>
compareEndpoints(GRADLE_COMPONENT_ENDPOINT))
validateEndpointResponses(GRADLE_COMPONENT_ENDPOINT, 'io.github.lognet.grpc-spring-boot'))

it('Validates Origins API with revisions response for a Gradle plugin component', () =>
compareEndpoints(`${GRADLE_COMPONENT_ENDPOINT}/revisions`))
validateEndpointWithRevisions(GRADLE_COMPONENT_ENDPOINT, '4.6.0'))
})
})()

function extractIds(response) {
return response.map(item => item.id)
function isValueInResponse(response, value) {
return response.some(item => item?.id?.includes(value))
}

function assertResponsesMatch(actual, expected) {
const sortedActualIds = extractIds(actual).sort()
const sortedExpectedIds = extractIds(expected).sort()
function isRevisionInResponse(response, value) {
return response.some(item => item?.sha?.includes(value)) || response.some(item => item.includes(value))
}

function assertPackageResponse(actual, value) {
assert.ok(actual.length > 0, `No matching package returned`)
assert.ok(isValueInResponse(actual, value), `Response does not contain expected package`)
}

assert.deepStrictEqual(sortedActualIds, sortedExpectedIds)
function assertRevisionResponse(actual, value) {
assert.ok(actual.length > 0, `No matching version returned`)
assert.ok(isRevisionInResponse(actual, value), `Response does not contain expected version`)
}

function isCoordinateAllowed(coordinate, exclusionList) {
return !exclusionList.some(excluded => coordinate.includes(excluded))
function exclusionFilter(item, exclusionList) {
return !exclusionList.some(excluded => item.includes(excluded))
}

function isOriginAllowed(coordinate) {
return isCoordinateAllowed(coordinate, ORIGIN_EXCLUSION_LIST)
function isComponentIncluded(coordinate) {
return exclusionFilter(coordinate, ORIGIN_EXCLUSION_LIST)
}

function isOriginWithRevisionsAllowed(coordinate) {
return isCoordinateAllowed(coordinate, ORIGIN_REVISIONS_EXCLUSION_LIST)
function isComponentIncludedWithRevisions(coordinate) {
return exclusionFilter(coordinate, ORIGIN_REVISIONS_EXCLUSION_LIST)
}

function getProviderType(type, provider) {
function resolveProviderType(type, provider) {
switch (type) {
case 'git':
case 'gem':
Expand All @@ -81,8 +89,13 @@ function getProviderType(type, provider) {

function parseCoordinates(coordinates) {
const [type, provider, namespaceOrEmpty, name, version] = coordinates.split('/')
const namespace = namespaceOrEmpty === '-' ? '' : namespaceOrEmpty
return { type, provider, namespace, name, version }
return {
type,
provider,
namespace: namespaceOrEmpty === '-' ? '' : namespaceOrEmpty,
name,
version
}
}

function buildCondaUrl(coordinates) {
Expand All @@ -92,24 +105,32 @@ function buildCondaUrl(coordinates) {

function buildOriginUrl(coordinates) {
const { type, provider, namespace, name } = parseCoordinates(coordinates)
const resolvedType = getProviderType(type, provider)
const resolvedType = resolveProviderType(type, provider)
return `${resolvedType}${namespace ? `/${namespace}` : ''}${name ? `/${name}` : ''}`
}

async function compareEndpoints(endpoint) {
const [devResponse, prodResponse] = await Promise.all([
callFetch(`${devApiBaseUrl}/origins/${endpoint}`).then(res => res.json()),
callFetch(`${prodApiBaseUrl}/origins/${endpoint}`).then(res => res.json())
])
assertResponsesMatch(devResponse, prodResponse)
async function validateEndpointResponses(endpoint, expectedValue) {
const devResponse = await callFetch(`${devApiBaseUrl}/origins/${endpoint}`).then(res => res.json())
assertPackageResponse(devResponse, expectedValue)
}

async function compareOriginsWithRevisions(coordinates) {
async function validateEndpointWithRevisions(endpoint, expectedValue) {
const devResponse = await callFetch(`${devApiBaseUrl}/origins/${endpoint}/revisions`).then(res => res.json())
assertRevisionResponse(devResponse, expectedValue)
}

async function validateOriginResponsesWithRevisions(coordinates) {
const originUrl = buildOriginUrl(coordinates)
await compareEndpoints(`${originUrl}/revisions`)
const version = normalizeVersion(coordinates.split('/').at(-1))
await validateEndpointWithRevisions(originUrl, version)
}

async function compareOrigins(coordinates) {
async function validateOriginResponses(coordinates) {
const originUrl = coordinates.startsWith('conda/') ? buildCondaUrl(coordinates) : buildOriginUrl(coordinates)
await compareEndpoints(`${originUrl}`)
const componentName = coordinates.split('/').at(-2)
await validateEndpointResponses(originUrl, componentName)
}

function normalizeVersion(version) {
return version.replace(/_[\w]+$/, '').replace(/^v/, '')
}