777 lines
29 KiB
JavaScript
777 lines
29 KiB
JavaScript
import { fileURLToPath } from 'url'
|
|
import path from 'path'
|
|
import cheerio from 'cheerio'
|
|
import { describe, expect } from '@jest/globals'
|
|
|
|
import Page, { FrontmatterErrorsError } from '../../lib/page.js'
|
|
import { allVersions } from '../../lib/all-versions.js'
|
|
import enterpriseServerReleases, { latest } from '../../lib/enterprise-server-releases.js'
|
|
import nonEnterpriseDefaultVersion from '../../lib/non-enterprise-default-version.js'
|
|
|
|
const __dirname = path.dirname(fileURLToPath(import.meta.url))
|
|
const enterpriseServerVersions = Object.keys(allVersions).filter((v) =>
|
|
v.startsWith('enterprise-server@')
|
|
)
|
|
|
|
// get the `free-pro-team` segment of `free-pro-team@latest`
|
|
const nonEnterpriseDefaultPlan = nonEnterpriseDefaultVersion.split('@')[0]
|
|
|
|
const opts = {
|
|
relativePath:
|
|
'pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md',
|
|
basePath: path.join(__dirname, '../../content'),
|
|
languageCode: 'en',
|
|
}
|
|
|
|
describe('Page class', () => {
|
|
test('preserves file path info', async () => {
|
|
const page = await Page.init(opts)
|
|
expect(page.relativePath).toBe(opts.relativePath)
|
|
expect(page.fullPath.includes(page.relativePath)).toBe(true)
|
|
})
|
|
|
|
describe('showMiniToc page property', () => {
|
|
let article, articleWithFM, tocPage
|
|
|
|
beforeAll(async () => {
|
|
article = await Page.init({
|
|
relativePath: 'sample-article.md',
|
|
basePath: path.join(__dirname, '../fixtures'),
|
|
languageCode: 'en',
|
|
})
|
|
|
|
articleWithFM = await Page.init({
|
|
showMiniToc: false,
|
|
relativePath: article.relativePath,
|
|
basePath: article.basePath,
|
|
languageCode: article.languageCode,
|
|
})
|
|
|
|
tocPage = await Page.init({
|
|
relativePath: 'sample-toc-index.md',
|
|
basePath: path.join(__dirname, '../fixtures'),
|
|
languageCode: 'en',
|
|
})
|
|
})
|
|
|
|
test('is true by default on articles', () => {
|
|
expect(article.showMiniToc).toBe(true)
|
|
})
|
|
|
|
test('is false on articles when set in frontmatter', () => {
|
|
expect(articleWithFM.showMiniToc).toBe(false)
|
|
})
|
|
|
|
// products, categories, and map topics have index.md pages
|
|
test('is undefined by default on index.md pages', () => {
|
|
expect(tocPage.showMiniToc).toBeUndefined()
|
|
})
|
|
})
|
|
|
|
describe('page.render(context)', () => {
|
|
test('rewrites links to include the current language prefix and version', async () => {
|
|
const page = await Page.init(opts)
|
|
const context = {
|
|
page: { version: `enterprise-server@${enterpriseServerReleases.latest}` },
|
|
currentVersion: `enterprise-server@${enterpriseServerReleases.latest}`,
|
|
currentPath:
|
|
'/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches',
|
|
currentLanguage: 'en',
|
|
}
|
|
const rendered = await page.render(context)
|
|
const $ = cheerio.load(rendered)
|
|
expect(
|
|
page.markdown.includes(
|
|
'(/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)'
|
|
)
|
|
).toBe(true)
|
|
expect(
|
|
page.markdown.includes(
|
|
'(/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)'
|
|
)
|
|
).toBe(false)
|
|
expect(
|
|
$(
|
|
'a[href="/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests"]'
|
|
).length
|
|
).toBe(0)
|
|
expect(
|
|
$(
|
|
`a[href="/en/${`enterprise-server@${enterpriseServerReleases.latest}`}/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests"]`
|
|
).length
|
|
).toBeGreaterThan(0)
|
|
})
|
|
|
|
// Much of this test is based on making sure we don't
|
|
// repeat the bug introduced in issue 1545.
|
|
test('rewrites links correctly for unsupported enterprise-server links', async () => {
|
|
const page = await Page.init({
|
|
relativePath: 'page-with-deprecated-enterprise-links.md',
|
|
basePath: path.join(__dirname, '../fixtures'),
|
|
languageCode: 'en',
|
|
})
|
|
const context = {
|
|
page: { version: `enterprise-server@${enterpriseServerReleases.latest}` },
|
|
currentVersion: `enterprise-server@${enterpriseServerReleases.latest}`,
|
|
currentPath: '/en/page-with-deprecated-enterprise-links',
|
|
currentLanguage: 'en',
|
|
}
|
|
const rendered = await page.render(context)
|
|
// That page only contains exactly 2 links. And we can know
|
|
// exactly what we expect each one to be.
|
|
const $ = cheerio.load(rendered)
|
|
const first = $('a[href]').first()
|
|
expect(first.text()).toBe('Version 2.22')
|
|
expect(first.attr('href')).toBe('/en/enterprise-server@2.22')
|
|
const last = $('a[href]').last()
|
|
expect(last.text()).toBe('Version 3.2')
|
|
expect(last.attr('href')).toBe('/en/enterprise-server@3.2')
|
|
})
|
|
|
|
test('rewrites links in the intro to include the current language prefix and version', async () => {
|
|
const page = await Page.init(opts)
|
|
page.rawIntro =
|
|
'[Pull requests](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)'
|
|
const context = {
|
|
page: { version: nonEnterpriseDefaultVersion },
|
|
currentVersion: nonEnterpriseDefaultVersion,
|
|
currentPath:
|
|
'/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches',
|
|
currentLanguage: 'en',
|
|
}
|
|
// This is needed because unit tests are weird. The page.render()
|
|
// method is dependent on module global cache.
|
|
// We need to fudge the `currentPath` so it appears to be different.
|
|
context.currentPath += Math.random()
|
|
await page.render(context)
|
|
const $ = cheerio.load(page.intro)
|
|
expect(
|
|
$(
|
|
'a[href="/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests"]'
|
|
).length
|
|
).toBe(0)
|
|
expect(
|
|
$(
|
|
'a[href="/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests"]'
|
|
).length
|
|
).toBeGreaterThan(0)
|
|
})
|
|
|
|
test('does not rewrite links that include deprecated enterprise release numbers', async () => {
|
|
const page = await Page.init({
|
|
relativePath:
|
|
'admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/migrating-from-github-enterprise-1110x-to-2123.md',
|
|
basePath: path.join(__dirname, '../../content'),
|
|
languageCode: 'en',
|
|
})
|
|
const context = {
|
|
page: { version: `enterprise-server@${enterpriseServerReleases.latest}` },
|
|
currentVersion: `enterprise-server@${enterpriseServerReleases.latest}`,
|
|
currentPath: `/en/enterprise-server@${enterpriseServerReleases.latest}/admin/enterprise-management/migrating-from-github-enterprise-1110x-to-2123`,
|
|
currentLanguage: 'en',
|
|
}
|
|
const rendered = await page.render(context)
|
|
const $ = cheerio.load(rendered)
|
|
expect(
|
|
page.markdown.includes(
|
|
'(/enterprise/11.10.340/admin/articles/upgrading-to-the-latest-release/)'
|
|
)
|
|
).toBe(true)
|
|
expect(
|
|
$(
|
|
`a[href="/en/enterprise-server@${enterpriseServerReleases.latest}/11.10.340/admin/articles/upgrading-to-the-latest-release"]`
|
|
).length
|
|
).toBe(0)
|
|
expect(
|
|
$('a[href="/en/enterprise/11.10.340/admin/articles/upgrading-to-the-latest-release"]')
|
|
.length
|
|
).toBeGreaterThan(0)
|
|
})
|
|
|
|
test('does not rewrite links to external redirects', async () => {
|
|
const page = await Page.init(opts)
|
|
page.markdown = `${page.markdown}\n\nSee [Capistrano](/capistrano).`
|
|
const context = {
|
|
page: { version: nonEnterpriseDefaultVersion },
|
|
currentVersion: nonEnterpriseDefaultVersion,
|
|
currentPath: `/en/${nonEnterpriseDefaultVersion}/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches`,
|
|
currentLanguage: 'en',
|
|
}
|
|
const rendered = await page.render(context)
|
|
const $ = cheerio.load(rendered)
|
|
expect($('a[href="/capistrano"]').length).toBe(1)
|
|
})
|
|
|
|
// Most of our Liquid versioning tests are in https://github.com/docs/render-content,
|
|
// But they don't have access to our currently supported versions, which we're testing here.
|
|
// This test ensures that this works as expected: {% if enterpriseServerVersions contains currentVersion %}
|
|
test('renders the expected Enterprise Server versioned content', async () => {
|
|
const page = await Page.init({
|
|
relativePath: 'page-versioned-for-all-enterprise-releases.md',
|
|
basePath: path.join(__dirname, '../fixtures'),
|
|
languageCode: 'en',
|
|
})
|
|
// set version to the latest enterprise version
|
|
const context = {
|
|
currentVersion: `enterprise-server@${enterpriseServerReleases.latest}`,
|
|
currentLanguage: 'en',
|
|
enterpriseServerVersions,
|
|
}
|
|
context.currentPath = `/${context.currentLanguage}/${context.currentVersion}/${page.relativePath}`
|
|
let rendered = await page.render(context)
|
|
let $ = cheerio.load(rendered)
|
|
expect($.text()).toBe(
|
|
'This text should render on any actively supported version of Enterprise Server'
|
|
)
|
|
expect($.text()).not.toBe('This text should only render on non-Enterprise')
|
|
|
|
// change version to the oldest enterprise version, re-render, and test again;
|
|
// the results should be the same
|
|
context.currentVersion = `enterprise-server@${enterpriseServerReleases.oldestSupported}`
|
|
context.currentPath = `/${context.currentLanguage}/${context.currentVersion}/${page.relativePath}`
|
|
rendered = await page.render(context)
|
|
$ = cheerio.load(rendered)
|
|
expect($.text()).toBe(
|
|
'This text should render on any actively supported version of Enterprise Server'
|
|
)
|
|
expect($.text()).not.toBe('This text should only render on non-Enterprise')
|
|
|
|
// change version to non-enterprise, re-render, and test again;
|
|
// the results should be the opposite
|
|
context.currentVersion = nonEnterpriseDefaultVersion
|
|
context.currentPath = `/${context.currentLanguage}/${context.currentVersion}/${page.relativePath}`
|
|
rendered = await page.render(context)
|
|
$ = cheerio.load(rendered)
|
|
expect($.text()).not.toBe(
|
|
'This text should render on any actively supported version of Enterprise Server'
|
|
)
|
|
expect($.text()).toBe('This text should only render on non-Enterprise')
|
|
})
|
|
|
|
test('support next to-be-released Enterprise Server version in frontmatter', async () => {
|
|
// This fixture has `enterprise-server: '>=3.1'` hardcoded in the frontmatter
|
|
const page = await Page.init({
|
|
relativePath: 'page-versioned-for-next-enterprise-release.md',
|
|
basePath: path.join(__dirname, '../fixtures'),
|
|
languageCode: 'en',
|
|
})
|
|
// set version to 3.0
|
|
const context = {
|
|
currentVersion: 'enterprise-server@3.0',
|
|
currentLanguage: 'en',
|
|
}
|
|
await expect(() => {
|
|
return page.render(context)
|
|
}).not.toThrow()
|
|
})
|
|
})
|
|
|
|
test('preserves `languageCode`', async () => {
|
|
const page = await Page.init(opts)
|
|
expect(page.languageCode).toBe('en')
|
|
})
|
|
|
|
test('parentProductId getter', async () => {
|
|
let page = await Page.init({
|
|
relativePath: 'github/some-category/some-article.md',
|
|
basePath: path.join(__dirname, '../fixtures/products'),
|
|
languageCode: 'en',
|
|
})
|
|
expect(page.parentProductId).toBe('github')
|
|
|
|
page = await Page.init({
|
|
relativePath: 'actions/some-category/some-article.md',
|
|
basePath: path.join(__dirname, '../fixtures/products'),
|
|
languageCode: 'en',
|
|
})
|
|
expect(page.parentProductId).toBe('actions')
|
|
|
|
page = await Page.init({
|
|
relativePath: 'admin/some-category/some-article.md',
|
|
basePath: path.join(__dirname, '../fixtures/products'),
|
|
languageCode: 'en',
|
|
})
|
|
expect(page.parentProductId).toBe('admin')
|
|
})
|
|
|
|
describe('permalinks', () => {
|
|
test('is an array', async () => {
|
|
const page = await Page.init(opts)
|
|
expect(Array.isArray(page.permalinks)).toBe(true)
|
|
})
|
|
|
|
test('has a key for every supported enterprise version (and no deprecated versions)', async () => {
|
|
const page = await Page.init(opts)
|
|
const pageVersions = page.permalinks.map((permalink) => permalink.pageVersion)
|
|
expect(
|
|
enterpriseServerReleases.supported.every((version) =>
|
|
pageVersions.includes(`enterprise-server@${version}`)
|
|
)
|
|
).toBe(true)
|
|
expect(
|
|
enterpriseServerReleases.deprecated.every(
|
|
(version) => !pageVersions.includes(`enterprise-server@${version}`)
|
|
)
|
|
).toBe(true)
|
|
})
|
|
|
|
test('sets versioned values', async () => {
|
|
const page = await Page.init(opts)
|
|
const expectedPath =
|
|
'pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches'
|
|
expect(
|
|
page.permalinks.find((permalink) => permalink.pageVersion === nonEnterpriseDefaultVersion)
|
|
.href
|
|
).toBe(`/en/${expectedPath}`)
|
|
expect(
|
|
page.permalinks.find(
|
|
(permalink) =>
|
|
permalink.pageVersion ===
|
|
`enterprise-server@${enterpriseServerReleases.oldestSupported}`
|
|
).href
|
|
).toBe(`/en/enterprise-server@${enterpriseServerReleases.oldestSupported}/${expectedPath}`)
|
|
})
|
|
|
|
test('homepage permalinks', async () => {
|
|
const page = await Page.init({
|
|
relativePath: 'index.md',
|
|
basePath: path.join(__dirname, '../../content'),
|
|
languageCode: 'en',
|
|
})
|
|
expect(
|
|
page.permalinks.find((permalink) => permalink.pageVersion === nonEnterpriseDefaultVersion)
|
|
.href
|
|
).toBe('/en')
|
|
expect(
|
|
page.permalinks.find(
|
|
(permalink) =>
|
|
permalink.pageVersion ===
|
|
`enterprise-server@${enterpriseServerReleases.oldestSupported}`
|
|
).href
|
|
).toBe(`/en/enterprise-server@${enterpriseServerReleases.oldestSupported}`)
|
|
})
|
|
|
|
test('permalinks for enterprise-only pages', async () => {
|
|
const page = await Page.init({
|
|
relativePath: 'products/admin/some-category/some-article.md',
|
|
basePath: path.join(__dirname, '../fixtures'),
|
|
languageCode: 'en',
|
|
})
|
|
expect(
|
|
page.permalinks.find(
|
|
(permalink) =>
|
|
permalink.pageVersion === `enterprise-server@${enterpriseServerReleases.latest}`
|
|
).href
|
|
).toBe(
|
|
`/en/enterprise-server@${enterpriseServerReleases.latest}/products/admin/some-category/some-article`
|
|
)
|
|
const pageVersions = page.permalinks.map((permalink) => permalink.pageVersion)
|
|
expect(pageVersions.length).toBeGreaterThan(1)
|
|
expect(pageVersions.includes(nonEnterpriseDefaultVersion)).toBe(false)
|
|
})
|
|
|
|
test('permalinks for non-GitHub.com products without Enterprise versions', async () => {
|
|
const page = await Page.init({
|
|
relativePath: 'products/actions/some-category/some-article.md',
|
|
basePath: path.join(__dirname, '../fixtures'),
|
|
languageCode: 'en',
|
|
})
|
|
expect(
|
|
page.permalinks.find((permalink) => permalink.pageVersion === nonEnterpriseDefaultVersion)
|
|
.href
|
|
).toBe('/en/products/actions/some-category/some-article')
|
|
expect(page.permalinks.length).toBe(1)
|
|
})
|
|
})
|
|
|
|
describe('learning tracks', () => {
|
|
let page
|
|
|
|
beforeEach(async () => {
|
|
page = await Page.init({
|
|
relativePath: 'article-with-learning-tracks.md',
|
|
basePath: path.join(__dirname, '../fixtures'),
|
|
languageCode: 'en',
|
|
})
|
|
})
|
|
|
|
it('includes learning tracks specified in frontmatter', async () => {
|
|
expect(page.learningTracks).toStrictEqual([
|
|
'track_1',
|
|
'track_2',
|
|
'non_existing_track',
|
|
'{% if currentVersion == "free-pro-team@latest" %}dotcom_only_track{% endif %}',
|
|
'{% if currentVersion != "free-pro-team@latest" %}enterprise_only_track{% endif %}',
|
|
])
|
|
})
|
|
|
|
// Docs Engineering issue: 970
|
|
it.skip('renders learning tracks that have been defined', async () => {
|
|
// getLinkData.mockImplementation((guides) => { return guides })
|
|
const guides = ['/path/guide1', '/path/guide2']
|
|
const context = {
|
|
currentLanguage: 'en',
|
|
currentProduct: 'snowbird',
|
|
currentVersion: nonEnterpriseDefaultVersion,
|
|
enterpriseServerVersions,
|
|
site: {
|
|
data: {
|
|
'learning-tracks': {
|
|
snowbird: {
|
|
track_1: {
|
|
title: 'title',
|
|
description: 'description',
|
|
guides,
|
|
featured_track:
|
|
'{% if currentVersion == "free-pro-team@latest" %}true{% else %}false{% endif %}',
|
|
},
|
|
track_2: {
|
|
title: 'title',
|
|
description: 'description',
|
|
guides,
|
|
featured_track:
|
|
'{% if enterpriseServerVersions contains currentVersion %}true{% else %}false{% endif %}',
|
|
},
|
|
dotcom_only_track: {
|
|
title: 'title',
|
|
description: 'description',
|
|
guides,
|
|
},
|
|
enterprise_only_track: {
|
|
title: 'title',
|
|
description: 'description',
|
|
guides,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
// Test that Liquid versioning is respected during rendering.
|
|
// Start with Dotcom.
|
|
await page.render(context)
|
|
// To actually render the guides in this test, we would have to load context.pages and context.redirects;
|
|
// To avoid that we can just test that the function was called with the expected data.
|
|
// expect(getLinkData).toHaveBeenCalledWith(guides, context)
|
|
// Tracks for dotcom should exclude enterprise_only_track and the featured track_1.
|
|
expect(page.learningTracks).toHaveLength(2)
|
|
const dotcomTrackNames = page.learningTracks.map((t) => t.trackName)
|
|
expect(dotcomTrackNames.includes('track_2')).toBe(true)
|
|
expect(dotcomTrackNames.includes('dotcom_only_track')).toBe(true)
|
|
expect(page.featuredTrack.trackName === 'track_1').toBeTruthy()
|
|
expect(page.featuredTrack.trackName === 'track_2').toBeFalsy()
|
|
|
|
// Switch to Enterprise.
|
|
context.currentVersion = `enterprise-server@${latest}`
|
|
await page.render(context)
|
|
// Tracks for enterprise should exclude dotcom_only_track and the featured track_2.
|
|
expect(page.learningTracks).toHaveLength(2)
|
|
const ghesTrackNames = page.learningTracks.map((t) => t.trackName)
|
|
expect(ghesTrackNames.includes('track_1')).toBe(true)
|
|
expect(ghesTrackNames.includes('enterprise_only_track')).toBe(true)
|
|
expect(page.featuredTrack.trackName === 'track_1').toBeFalsy()
|
|
expect(page.featuredTrack.trackName === 'track_2').toBeTruthy()
|
|
})
|
|
})
|
|
|
|
describe('includeGuides', () => {
|
|
let page
|
|
|
|
beforeEach(async () => {
|
|
page = await Page.init({
|
|
relativePath: 'article-with-includeGuides.md',
|
|
basePath: path.join(__dirname, '../fixtures'),
|
|
languageCode: 'en',
|
|
})
|
|
})
|
|
|
|
it('includes guide paths specified in frontmatter', async () => {
|
|
expect(page.includeGuides).toStrictEqual(['/path/guide1', '/path/guide2', '/path/guide3'])
|
|
})
|
|
|
|
// Docs Engineering issue: 971
|
|
it.skip('renders guides and topics', async () => {
|
|
/* getLinkData.mockImplementation(() => {
|
|
return [{
|
|
page: { topics: ['Spring', 'Summer'] }
|
|
}, {
|
|
page: { topics: ['Summer', 'Fall'] }
|
|
}, {
|
|
page: { topics: ['Fall', 'Winter'] }
|
|
}]
|
|
}) */
|
|
// const guides = ['/path/guide1', '/path/guide2', '/path/guide3']
|
|
const context = {
|
|
currentVersion: nonEnterpriseDefaultVersion,
|
|
currentLanguage: 'en',
|
|
}
|
|
await page.render(context)
|
|
// expect(getLinkData).toHaveBeenCalledWith(guides, context)
|
|
expect(page.includeGuides).toHaveLength(3)
|
|
expect(page.allTopics).toHaveLength(4)
|
|
expect(page.allTopics).toEqual(expect.arrayContaining(['Spring', 'Summer', 'Fall', 'Winter']))
|
|
})
|
|
})
|
|
|
|
describe('videos', () => {
|
|
let page
|
|
|
|
beforeEach(async () => {
|
|
page = await Page.init({
|
|
relativePath: 'article-with-videos.md',
|
|
basePath: path.join(__dirname, '../fixtures'),
|
|
languageCode: 'en',
|
|
})
|
|
})
|
|
|
|
it('includes videos specified in the featuredLinks frontmatter', async () => {
|
|
expect(page.featuredLinks.videos).toStrictEqual([
|
|
{
|
|
title: 'codespaces',
|
|
href: 'https://www.youtube-nocookie.com/embed/_W9B7qc9lVc',
|
|
},
|
|
{
|
|
title: 'more codespaces',
|
|
href: 'https://www.youtube-nocookie.com/embed/_W9B7qc9lVc',
|
|
},
|
|
{
|
|
title: 'even more codespaces',
|
|
href: 'https://www.youtube-nocookie.com/embed/_W9B7qc9lVc',
|
|
},
|
|
])
|
|
|
|
expect(page.featuredLinks.videosHeading).toBe('Custom Videos heading')
|
|
})
|
|
})
|
|
|
|
describe('introLinks', () => {
|
|
it('includes the links specified in the introLinks frontmatter', async () => {
|
|
const page = await Page.init({
|
|
relativePath: 'article-with-introLinks.md',
|
|
basePath: path.join(__dirname, '../fixtures'),
|
|
languageCode: 'en',
|
|
})
|
|
|
|
expect(page.introLinks).toStrictEqual({
|
|
overview: 'https://github.com',
|
|
'custom link!': 'https://github.com/features',
|
|
})
|
|
})
|
|
})
|
|
|
|
describe('Page.parseFrontmatter()', () => {
|
|
it('throws an error on bad input', () => {
|
|
const markdown = null
|
|
expect(() => {
|
|
Page.parseFrontmatter('some/file.md', markdown)
|
|
}).toThrow()
|
|
})
|
|
})
|
|
|
|
describe('Page.getLanguageVariants()', () => {
|
|
it('returns an array of language variants of the given URL', () => {
|
|
const variants = Page.getLanguageVariants('/en')
|
|
expect(variants.every((variant) => variant.name)).toBe(true)
|
|
expect(variants.every((variant) => variant.code)).toBe(true)
|
|
expect(variants.every((variant) => variant.href)).toBe(true)
|
|
})
|
|
|
|
it('works for the homepage', () => {
|
|
const variants = Page.getLanguageVariants('/en')
|
|
expect(variants.find(({ code }) => code === 'en').href).toBe('/en')
|
|
})
|
|
})
|
|
|
|
describe('page.versions frontmatter', () => {
|
|
// Docs Engineering issue: 972
|
|
test.skip('pages that apply to older enterprise versions', async () => {
|
|
// There are none of these in the content at this time!
|
|
})
|
|
// Docs Engineering issue: 972
|
|
test.skip('pages that apply to newer enterprise versions', async () => {
|
|
// There are none of these in the content at this time!
|
|
})
|
|
|
|
test('pages that use short names in versions frontmatter', async () => {
|
|
const page = await Page.init({
|
|
relativePath: 'short-versions.md',
|
|
basePath: path.join(__dirname, '../fixtures'),
|
|
languageCode: 'en',
|
|
})
|
|
expect(page.versions.fpt).toBe('*')
|
|
expect(page.versions.ghes).toBe('>3.0')
|
|
expect(page.versions.ghae).toBeUndefined()
|
|
expect(page.applicableVersions.includes('free-pro-team@latest')).toBe(true)
|
|
expect(page.applicableVersions.includes(`enterprise-server@${latest}`)).toBe(true)
|
|
expect(page.applicableVersions.includes(`github-ae@latest`)).toBe(false)
|
|
})
|
|
|
|
test('index page', async () => {
|
|
const page = await Page.init({
|
|
relativePath: 'index.md',
|
|
basePath: path.join(__dirname, '../../content'),
|
|
languageCode: 'en',
|
|
})
|
|
expect(page.versions).toBe('*')
|
|
})
|
|
|
|
test('enterprise admin index page', async () => {
|
|
const page = await Page.init({
|
|
relativePath: 'admin/index.md',
|
|
basePath: path.join(__dirname, '../../content'),
|
|
languageCode: 'en',
|
|
})
|
|
|
|
expect(nonEnterpriseDefaultPlan in page.versions).toBe(false)
|
|
expect(page.versions.ghes).toBe('*')
|
|
})
|
|
|
|
test('feature versions frontmatter', async () => {
|
|
// This fixture file has the frontmatter:
|
|
//
|
|
// versions:
|
|
// fpt: '*'
|
|
// ghes: '*'
|
|
// feature: 'placeholder'
|
|
//
|
|
// and placeholder.yml has:
|
|
//
|
|
// versions:
|
|
// ghes: '<3.0'
|
|
// ghae: '*'
|
|
//
|
|
// So we expect to get the versioning from both.
|
|
const page = await Page.init({
|
|
relativePath: 'feature-versions-frontmatter.md',
|
|
basePath: path.join(__dirname, '../fixtures'),
|
|
languageCode: 'en',
|
|
})
|
|
|
|
// Test the raw page data.
|
|
expect(page.versions.fpt).toBe('*')
|
|
expect(page.versions.ghes).toBe('>2.21')
|
|
expect(page.versions.ghae).toBeUndefined()
|
|
|
|
// Test the resolved versioning, where GHES releases specified in frontmatter and in
|
|
// feature versions are combined (i.e., one doesn't overwrite the other).
|
|
// We can't test that GHES 2.21 is _not_ included here (which it shouldn't be),
|
|
// because lib/get-applicable-versions only returns currently supported versions,
|
|
// so as soon as 2.21 is deprecated, a test for that _not_ to exist will not be meaningful.
|
|
// But by testing that the _latest_ GHES version is returned, we can ensure that the
|
|
// the frontmatter GHES `*` is not being overwritten by the placeholder's GHES `<3.0`.
|
|
expect(page.applicableVersions.includes('free-pro-team@latest')).toBe(true)
|
|
expect(page.applicableVersions.includes(`enterprise-server@${latest}`)).toBe(true)
|
|
expect(page.applicableVersions.includes('github-ae@latest')).toBe(true)
|
|
expect(page.applicableVersions.includes('feature')).toBe(false)
|
|
expect(page.applicableVersions.includes('placeholder')).toBe(false)
|
|
})
|
|
})
|
|
|
|
describe('platform specific content', () => {
|
|
test('page.defaultPlatform frontmatter', async () => {
|
|
const page = await Page.init({
|
|
relativePath:
|
|
'actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md',
|
|
basePath: path.join(__dirname, '../../content'),
|
|
languageCode: 'en',
|
|
})
|
|
expect(page.defaultPlatform).toBeDefined()
|
|
expect(page.defaultPlatform).toBe('linux')
|
|
})
|
|
})
|
|
|
|
describe('tool specific content', () => {
|
|
test('page.defaultTool frontmatter', async () => {
|
|
const page = await Page.init({
|
|
relativePath: 'default-tool.md',
|
|
basePath: path.join(__dirname, '../fixtures'),
|
|
languageCode: 'en',
|
|
})
|
|
expect(page.defaultTool).toBeDefined()
|
|
expect(page.defaultTool).toBe('cli')
|
|
})
|
|
})
|
|
})
|
|
|
|
describe('catches errors thrown in Page class', () => {
|
|
test('frontmatter parsing error', async () => {
|
|
async function getPage() {
|
|
return await Page.init({
|
|
relativePath: 'page-with-frontmatter-error.md',
|
|
basePath: path.join(__dirname, '../fixtures'),
|
|
languageCode: 'en',
|
|
})
|
|
}
|
|
|
|
await expect(getPage).rejects.toThrow(FrontmatterErrorsError)
|
|
})
|
|
|
|
test('missing versions frontmatter', async () => {
|
|
async function getPage() {
|
|
return await Page.init({
|
|
relativePath: 'page-with-missing-product-versions.md',
|
|
basePath: path.join(__dirname, '../fixtures'),
|
|
languageCode: 'en',
|
|
})
|
|
}
|
|
|
|
await expect(getPage).rejects.toThrowError('versions')
|
|
})
|
|
|
|
// TODO - UNSKIP WHEN GHAE IS UPDATED WITH SEMVER VERSIONING
|
|
test.skip('invalid versions frontmatter', async () => {
|
|
async function getPage() {
|
|
return await Page.init({
|
|
relativePath: 'page-with-invalid-product-version.md',
|
|
basePath: path.join(__dirname, '../fixtures'),
|
|
languageCode: 'en',
|
|
})
|
|
}
|
|
|
|
await expect(getPage).rejects.toThrowError('versions')
|
|
})
|
|
|
|
test('English page with a version in frontmatter that its parent product is not available in', async () => {
|
|
async function getPage() {
|
|
return await Page.init({
|
|
relativePath: 'admin/some-category/some-article-with-mismatched-versions-frontmatter.md',
|
|
basePath: path.join(__dirname, '../fixtures/products'),
|
|
languageCode: 'en',
|
|
})
|
|
}
|
|
|
|
expect(getPage).rejects.toThrowError(/`versions` frontmatter.*? product is not available in/)
|
|
})
|
|
|
|
describe('versionining optional attributes', () => {
|
|
test("re-rendering set appropriate 'product', 'permissions', 'learningTracks'", async () => {
|
|
const page = await Page.init({
|
|
relativePath: 'page-with-optional-attributes.md',
|
|
basePath: path.join(__dirname, '../fixtures'),
|
|
languageCode: 'en',
|
|
})
|
|
const context = {
|
|
page: { version: `enterprise-server@3.2` },
|
|
currentVersion: `enterprise-server@3.2`,
|
|
currentProduct: 'snowbird',
|
|
currentLanguage: 'en',
|
|
currentPath: '/en/enterprise-server@3.2/optional/attributes',
|
|
fpt: false, // what the shortVersions contextualizer does
|
|
}
|
|
|
|
await page.render(context)
|
|
expect(page.product).toBe('')
|
|
expect(page.permissions).toBe('')
|
|
|
|
// Change to FPT
|
|
context.page.version = nonEnterpriseDefaultVersion
|
|
context.version = nonEnterpriseDefaultVersion
|
|
context.currentPath = '/en/optional/attributes'
|
|
context.fpt = true
|
|
await page.render(context)
|
|
expect(page.product).toContain('FPT rulez!')
|
|
expect(page.permissions).toContain('FPT only!')
|
|
})
|
|
})
|
|
})
|