Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
60 changes: 60 additions & 0 deletions e2e/linkRewrite.test.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
// cSpell:ignore keda litmuschaos
import assert from 'node:assert/strict';
import { after, before, describe, it } from 'node:test';
import { execFileSync } from 'node:child_process';
import { mkdtemp, readFile, rm } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import path from 'node:path';
import url from 'node:url';

const __dirname = path.dirname(url.fileURLToPath(import.meta.url));
const repoRoot = path.join(__dirname, '..');

// Unit tests (lib/docusaurusConfigPreprocessor.test.mts,
// lib/remarkRewriteLinks/index.test.mts) cover the pure rewrite functions in
// isolation. Neither one proves the rewrites actually survive being wired
// into Docusaurus's real build pipeline (plugin registration, option
// shape, remark plugin ordering). This suite runs the genuine
// `docusaurus build` against this repo's own content and asserts the
// known-affected pages render the rewritten links, so a wiring regression
// fails here even when the unit tests still pass.
describe('production build applies the link-rewrite plugins end-to-end', () => {
let outDir;

before(async () => {
outDir = await mkdtemp(path.join(tmpdir(), 'techdocs-e2e-build-'));
execFileSync('npx', ['docusaurus', 'build', '--out-dir', outDir], {
cwd: repoRoot,
env: { ...process.env, BUILD_ENV: 'dev' },
stdio: 'inherit',
});
});

after(async () => {
if (outDir) await rm(outDir, { recursive: true, force: true });
});

it('strips .md from a site-absolute /docs link imported from README.md', async () => {
const html = await readFile(path.join(outDir, 'index.html'), 'utf-8');
assert.match(html, /href="\/docs\/assistance\/"/);
});

it('rewrites a cross-plugin analyses -> docs .md link to a trailing slash', async () => {
const html = await readFile(
path.join(outDir, 'analyses/2024/keda/analysis/index.html'),
'utf-8',
);
assert.match(html, /href="\/docs\/analysis\/criteria\/"/);
});

it('rewrites an unbundled .csv asset link to its GitHub blob URL', async () => {
const html = await readFile(
path.join(outDir, 'analyses/2023/backstage/index.html'),
'utf-8',
);
assert.match(
html,
/https:\/\/github\.com\/cncf\/techdocs\/blob\/main\/analyses\/2023\/backstage\/backstage-doc-survey\.csv/,
);
});
});
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
"seq": "bash -c 'for cmd in \"$@\"; do npm run $cmd || exit 1; done' - ",
"serve": "npm run docus:serve",
"test:coverage": "c8 --reporter=text --reporter=lcov --exclude 'docusaurus.config.ts' --exclude 'lib/testHelpers/**' --check-coverage --lines 100 --statements 100 --branches 100 --functions 100 npm run test:unit",
"test:e2e": "node --test 'e2e/**/*.test.mjs'",
"test:unit": "node --experimental-strip-types --experimental-test-module-mocks --test 'lib/**/*.test.mts' 'scripts/**/*.test.mjs'",
"test": "npm run check && npm run test:unit",
"typecheck": "tsc",
Expand Down
Loading