1
0
mirror of synced 2025-12-30 12:02:01 -05:00
Files
docs/tests/unit/versions.js
Grace Park e3f8f71c42 Rest api versioning redo (#33011)
Co-authored-by: Rachael Sewell <rachmari@github.com>
Co-authored-by: Sarah Edwards <skedwards88@github.com>
Co-authored-by: Grace Park <gracepark@Graces-MacBook-Pro-2.local>
Co-authored-by: Sarah Schneider <sarahs@users.noreply.github.com>
Co-authored-by: Sarah Schneider <sarahs@github.com>
2022-11-28 11:55:02 -08:00

63 lines
2.4 KiB
JavaScript

import path from 'path'
import { readdir } from 'fs/promises'
import { jest } from '@jest/globals'
import revalidator from 'revalidator'
import { allVersions } from '../../lib/all-versions.js'
import { latest } from '../../lib/enterprise-server-releases.js'
import schema from '../helpers/schemas/versions-schema.js'
import nonEnterpriseDefaultVersion from '../../lib/non-enterprise-default-version.js'
jest.useFakeTimers({ legacyFakeTimers: true })
describe('versions module', () => {
test('is an object with versions as keys', () => {
expect(nonEnterpriseDefaultVersion in allVersions).toBe(true)
expect(`enterprise-server@${latest}` in allVersions).toBe(true)
})
test('every version is valid', () => {
Object.values(allVersions).forEach((versionObj) => {
const { valid, errors } = revalidator.validate(versionObj, schema)
const expectation = JSON.stringify({ versionObj, errors }, null, 2)
expect(valid, expectation).toBe(true)
})
})
test('check that the correct REST API versions are versioned and/or unversioned', async () => {
const dereferencedPath = path.join(process.cwd(), 'lib/rest/static/dereferenced')
const files = await readdir(dereferencedPath)
for (const file of files) {
const version = file.replace('.deref.json', '')
const versionObj = Object.values(allVersions).find((versionObj) =>
version.startsWith(versionObj.openApiVersionName)
)
const dateRegex = /\d{4}-\d{2}-\d{2}/
const isApiVersioned = dateRegex.test(version)
if (isApiVersioned) {
const apiVersion = version.split(`${versionObj.openApiVersionName}.`)[1]
expect(versionObj.apiVersions).toContain(apiVersion)
expect()
} else {
expect(version).toBe(versionObj.openApiVersionName)
}
}
})
test('check REST api calendar date versioned versions set to correct latestApiVersion', () => {
Object.values(allVersions).forEach((versionObj) => {
if (versionObj.apiVersions.length > 0) {
const latestApiVersion = versionObj.latestApiVersion
const apiVersions = versionObj.apiVersions
expect(apiVersions).toContain(latestApiVersion)
const latestApiDate = new Date(latestApiVersion).getTime()
for (const version of apiVersions) {
expect(latestApiDate).toBeGreaterThanOrEqual(new Date(version).getTime())
}
}
})
})
})