Skip to content

test: run test-config-json-schema in default builds #66827

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

Open
marco-ippolito wants to merge 2 commits into
base: main
Choose a base branch
from
+97 −12
Open

test: run test-config-json-schema in default builds #66827

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
30fdc70
doc: update node-config-schema.json
marco-ippolito Oct 18, 2026
8ac821e
test: run test-config-json-schema in default builds
marco-ippolito Oct 18, 2026
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
89 changes: 85 additions & 4 deletions doc/node-config-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,21 @@
"type": "boolean",
"description": "allow use of child process when any permissions are set"
},
"allow-env": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"minItems": 1,
"items": {
"type": "string"
}
}
],
"description": "allow access to environment variables when any permissions are set"
},
"allow-ffi": {
"type": "boolean",
"description": "allow use of FFI when any permissions are set"
Expand All @@ -137,6 +152,10 @@
],
"description": "allow permissions to read the filesystem"
},
"allow-fs-vfs": {
"type": "boolean",
"description": "allow mounting a virtual file system when any permissions are set"
},
"allow-fs-write": {
"oneOf": [
{
Expand Down Expand Up @@ -296,6 +315,10 @@
"type": "boolean",
"description": "enable FIPS crypto at startup"
},
"enable-fips-indicator-events": {
"type": "boolean",
"description": "publish FIPS indicator results to the crypto.fips.indicator diagnostics channel"
},
"enable-source-maps": {
"type": "boolean",
"description": "Source Map V3 support for stack traces"
Expand Down Expand Up @@ -332,6 +355,10 @@
"type": "boolean",
"description": "experimental ES Module import.meta.resolve() parentURL support"
},
"experimental-import-text": {
"type": "boolean",
"description": "experimental support for importing source as text with import attributes"
},
"experimental-loader": {
"oneOf": [
{
Expand All @@ -347,6 +374,10 @@
],
"description": "use the specified module as a custom loader"
},
"experimental-package-map": {
"type": "string",
"description": "use the specified file for package map resolution"
},
"experimental-print-required-tla": {
"type": "boolean",
"description": "Print pending top-level await. If --require-module is true, evaluate asynchronous graphs loaded by `require()` but do not run the microtasks, in order to find and print top-level await in the graph"
Expand All @@ -367,13 +398,17 @@
"type": "boolean",
"description": "experimental iterable streams API (node:stream/iter)"
},
"experimental-vfs": {
"type": "boolean",
"description": "experimental node:vfs module"
},
"experimental-vm-modules": {
"type": "boolean",
"description": "experimental ES Module support in vm module"
},
"experimental-websocket": {
"experimental-web-worker": {
"type": "boolean",
"description": "experimental WebSocket API"
"description": "experimental Web Worker API"
},
"experimental-webstorage": {
"type": "boolean",
Expand All @@ -393,7 +428,7 @@
},
"force-fips": {
"type": "boolean",
"description": "force FIPS crypto (cannot be disabled)"
"description": "force FIPS crypto (optional mode: provider or strict)"
},
"force-node-api-uncaught-exceptions-policy": {
"type": "boolean",
Expand Down Expand Up @@ -651,6 +686,10 @@
],
"description": "include files in coverage report that match this glob pattern"
},
"test-coverage-include-all": {
"type": "boolean",
"description": "include source files that were never loaded in the coverage report"
},
"test-coverage-lines": {
"type": "number",
"description": "the line coverage minimum threshold"
Expand Down Expand Up @@ -857,7 +896,7 @@
},
"use-largepages": {
"type": "string",
"description": "This option is no longer supported and a no-op. Options are 'off' (default), 'on' (report a warning to stderr), or 'silent' (same as 'off')."
"description": "This option is no longer supported and a no-op. It still accepts these values for compatibility: 'off' (default), 'on' (report a warning to stderr), or 'silent' (same as 'off')."
},
"use-openssl-ca": {
"type": "boolean",
Expand Down Expand Up @@ -906,6 +945,10 @@
"type": "boolean",
"description": "preserve outputs on watch mode restart"
},
"worker-snapshot": {
"type": "boolean",
"description": "start worker threads from the bootstrapped context in the built-in startup snapshot"
},
"zero-fill-buffers": {
"type": "boolean",
"description": "automatically zero-fill all newly allocated Buffer instances"
Expand All @@ -929,6 +972,21 @@
"type": "boolean",
"description": "allow use of child process when any permissions are set"
},
"allow-env": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"minItems": 1,
"items": {
"type": "string"
}
}
],
"description": "allow access to environment variables when any permissions are set"
},
"allow-ffi": {
"type": "boolean",
"description": "allow use of FFI when any permissions are set"
Expand All @@ -948,6 +1006,10 @@
],
"description": "allow permissions to read the filesystem"
},
"allow-fs-vfs": {
"type": "boolean",
"description": "allow mounting a virtual file system when any permissions are set"
},
"allow-fs-write": {
"oneOf": [
{
Expand Down Expand Up @@ -1002,6 +1064,21 @@
"type": "boolean",
"description": "enable module mocking in the test runner"
},
"experimental-test-tag-filter": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"minItems": 1,
"items": {
"type": "string"
}
}
],
"description": "run tests matching the given tag filter expression"
},
"test": {
"type": "boolean",
"description": "launch test runner on startup"
Expand Down Expand Up @@ -1048,6 +1125,10 @@
],
"description": "include files in coverage report that match this glob pattern"
},
"test-coverage-include-all": {
"type": "boolean",
"description": "include source files that were never loaded in the coverage report"
},
"test-coverage-lines": {
"type": "number",
"description": "the line coverage minimum threshold"
Expand Down
20 changes: 12 additions & 8 deletions test/parallel/test-config-json-schema.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,17 @@ if (!common.hasIntl) {
common.skip('missing Intl');
}

if (!common.hasQuic) {
common.skip('this test requires QUIC');
}

if (process.config.variables.icu_small) {
common.skip('this test assumes full ICU build');
}

if (process.config.variables.node_quic) {
if (!common.hasFFI) {
common.skip('missing FFI');
}

// The JSON schema is generated from a build with the default configuration
// options, where these are disabled and their options are not available.
if (common.hasQuic || common.hasDtls || common.hasV8Sandbox) {
common.skip('this test assumes default configuration options');
}

Expand All @@ -39,7 +41,9 @@ const {
const schemaInDoc = require('../../doc/node-config-schema.json');
const assert = require('assert');

const schema = generateConfigJsonSchema();
// Round-trip through JSON so that the null-prototype objects returned by
// generateConfigJsonSchema() show up as plain objects in the diff.
const schema = JSON.parse(JSON.stringify(generateConfigJsonSchema()));

// This assertion ensures that whenever we add a new env option, we also add it
// to the JSON schema. The function getEnvOptionsInputType() returns all the available
Expand All @@ -48,5 +52,5 @@ const schema = generateConfigJsonSchema();
// To regenerate the JSON schema, run:
// out/Release/node --expose-internals tools/doc/generate-json-schema.mjs
// And then run make doc to update the out/doc/node-config-schema.json file.
assert.strictEqual(JSON.stringify(schema), JSON.stringify(schemaInDoc), 'JSON schema is outdated.' +
'Run `out/Release/node --expose-internals tools/doc/generate-json-schema.mjs` to update it.');
assert.deepStrictEqual(schema, schemaInDoc, 'JSON schema is outdated. Run ' +
'`out/Release/node --expose-internals tools/doc/generate-json-schema.mjs` to update it.');
Loading