|
| 1 | +import test from 'node:test'; |
| 2 | +import assert from 'node:assert/strict'; |
| 3 | +import { spawnSync } from 'node:child_process'; |
| 4 | +import { |
| 5 | + existsSync, |
| 6 | + mkdirSync, |
| 7 | + rmSync, |
| 8 | + rmdirSync, |
| 9 | + writeFileSync, |
| 10 | +} from 'node:fs'; |
| 11 | +import { dirname, join } from 'node:path'; |
| 12 | +import { fileURLToPath } from 'node:url'; |
| 13 | + |
| 14 | +const siteDir = fileURLToPath(new URL('../', import.meta.url)); |
| 15 | + |
| 16 | +// Build to a scratch dir so this test never races with tests that read |
| 17 | +// public/ (node --test runs test files concurrently). Kept after the run |
| 18 | +// for inspection; cleared at start. |
| 19 | +const outDir = join(siteDir, 'tmp', 'test-no-deprecations'); |
| 20 | + |
| 21 | +function buildSite() { |
| 22 | + const res = spawnSync(`npm run build -- -d ${outDir}`, { |
| 23 | + cwd: siteDir, |
| 24 | + shell: true, |
| 25 | + encoding: 'utf8', |
| 26 | + }); |
| 27 | + const output = `${res.stdout ?? ''}${res.stderr ?? ''}`; |
| 28 | + const deprecations = output |
| 29 | + .split('\n') |
| 30 | + .filter((line) => /deprecated/i.test(line)); |
| 31 | + return { res, output, deprecations }; |
| 32 | +} |
| 33 | + |
| 34 | +test('site build logs no Hugo deprecation notices', (t) => { |
| 35 | + // The `_hugo-dev` script builds with `--logLevel info`, the level at which |
| 36 | + // Hugo first reports deprecated API usage. |
| 37 | + rmSync(outDir, { recursive: true, force: true }); |
| 38 | + const { res, output, deprecations } = buildSite(); |
| 39 | + assert.equal(res.status, 0, `Build failed:\n${output}`); |
| 40 | + assert.deepEqual(deprecations, [], 'Hugo build logged deprecation notice(s)'); |
| 41 | + t.diagnostic(`Scanned ${output.split('\n').length} build-log lines`); |
| 42 | +}); |
| 43 | + |
| 44 | +// Sanity check that the test above can actually detect deprecation notices: |
| 45 | +// seed a deprecated API call via the theme's head-end hook and ensure that |
| 46 | +// Hugo reports it. Guards against, e.g., Hugo demoting deprecation notices |
| 47 | +// below the info log level. |
| 48 | +test('build with seeded deprecated API call logs a deprecation notice', (t) => { |
| 49 | + const hookPath = join( |
| 50 | + siteDir, |
| 51 | + 'layouts', |
| 52 | + '_partials', |
| 53 | + 'hooks', |
| 54 | + 'head-end.html', |
| 55 | + ); |
| 56 | + assert.ok( |
| 57 | + !existsSync(hookPath), |
| 58 | + `${hookPath} already exists; this test needs to create it`, |
| 59 | + ); |
| 60 | + mkdirSync(dirname(hookPath), { recursive: true }); |
| 61 | + writeFileSync( |
| 62 | + hookPath, |
| 63 | + '{{/* Temporary file seeded by no-deprecations.test.mjs. */}}\n' + |
| 64 | + '{{ .Language.LanguageName }}\n', |
| 65 | + ); |
| 66 | + try { |
| 67 | + const { res, output, deprecations } = buildSite(); |
| 68 | + assert.equal(res.status, 0, `Seeded build failed:\n${output}`); |
| 69 | + assert.ok( |
| 70 | + deprecations.length > 0, |
| 71 | + 'Seeded deprecated API call was not reported by the Hugo build', |
| 72 | + ); |
| 73 | + t.diagnostic(`Seeded deprecation reported as: ${deprecations[0].trim()}`); |
| 74 | + } finally { |
| 75 | + rmSync(hookPath, { force: true }); |
| 76 | + // Prune test-created dirs only if empty (rmdirSync refuses to delete |
| 77 | + // non-empty directories), in case other hooks/partials are added later. |
| 78 | + for (const dir of [dirname(hookPath), dirname(dirname(hookPath))]) { |
| 79 | + try { |
| 80 | + rmdirSync(dir); |
| 81 | + } catch { |
| 82 | + break; // Directory not empty; leave it (and its parents) in place. |
| 83 | + } |
| 84 | + } |
| 85 | + } |
| 86 | +}); |
0 commit comments