yadunut/clan-core
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request 'Feat(jsonschema): simplify isRequired, look into default and defaultText' (#3861) from json-schema into main

Browse Source 
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/3861
This commit is contained in:
hsjobeki
2025-06-04 18:34:40 +00:00
parent 33f3f36742 e8608f5af3
commit 22db6ace21
4 changed files with 475 additions and 461 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
lib/jsonschema/default.nix
View File

@@ -7,6 +7,8 @@
"package"
],
includeDefaults ? true,
filterSchema ?
schema: lib.filterAttrsRecursive (name: _value: name != "$exportedModuleInfo") schema,
header ? {
"$schema" = "http://json-schema.org/draft-07/schema#";
},
@@ -59,7 +61,7 @@ rec {
inherit specialArgs;
};
in
parseOptions evaled.options { };
(_parseOptions evaled.options { });
# get default value from option
@@ -88,20 +90,28 @@ rec {
let
subOptions = option.type.getSubOptions option.loc;
in
parseOptions subOptions {
_parseOptions subOptions {
addHeader = false;
path = option.loc ++ prefix;
};
parseOptions = opts: args: filterSchema (_parseOptions opts args);
makeModuleInfo =
{
path,
required,
defaultText ? null,
}:
...
}@attrs:
let
sanitizedAttrs = removeAttrs attrs (lib.optionals (defaultText != null) [ "default" ]);
in
{
"$exportedModuleInfo" =
{
inherit path;
sanitizedAttrs
// {
inherit path required;
}
// lib.optionalAttrs (defaultText != null) {
inherit defaultText;
@@ -109,7 +119,7 @@ rec {
};
# parses a set of evaluated nixos options to a jsonschema
parseOptions =
_parseOptions =
options:
{
# The top-level header object should specify at least the schema version
@@ -119,13 +129,20 @@ rec {
path ? [ ],
}:
let
options' = filterInvisibleOpts (filterExcludedAttrs (clean options));
options' = (filterInvisibleOpts (filterExcludedAttrs (clean options)));
# parse options to jsonschema properties
properties = lib.mapAttrs (_name: option: (parseOption' (path ++ [ _name ]) option)) options';
properties = (lib.mapAttrs (_name: option: (parseOption' (path ++ [ _name ]) option)) options');
# TODO: figure out how to handle if prop.anyOf is used
isRequired = prop: !(prop ? default || prop."$exportedModuleInfo".required or false);
requiredProps = lib.filterAttrs (_: prop: isRequired prop) properties;
required = lib.optionalAttrs (requiredProps != { }) { required = lib.attrNames requiredProps; };
isRequired = prop: prop."$exportedModuleInfo".required or true;
requiredProps = lib.filterAttrs (_: prop: isRequired prop) (properties);
# json schema spec 6.5.3: required
# The value of this keyword MUST be an array. Elements of this array, if any, MUST be strings, and MUST be unique.
# ...
# Omitting this keyword has the same behavior as an empty array.
required = {
required = lib.attrNames requiredProps;
};
header' = if addHeader then header else { };
# freeformType is a special type
@@ -133,7 +150,7 @@ rec {
checkFreeformDefs =
defs:
if (builtins.length defs) != 1 then
throw "parseOptions: freeformType definitions not supported"
throw "_parseOptions: freeformType definitions not supported"
else
defs;
# It seems that freeformType has [ null ]
@@ -148,15 +165,9 @@ rec {
}
else
{ };
# Metadata about the module that is made available to the schema via '$propagatedModuleInfo'
exportedModuleInfo = makeModuleInfo {
inherit path;
};
in
# return jsonschema
header'
// exportedModuleInfo
// required
// {
type = "object";
@@ -169,8 +180,10 @@ rec {
parseOption = parseOption' [ ];
parseOption' =
currentPath: option:
# lib.trace
(
let
default = getDefaultFrom option;
default = (getDefaultFrom (option));
example = lib.optionalAttrs (option ? example) {
examples =
if (builtins.typeOf option.example) == "list" then option.example else [ option.example ];
@@ -178,10 +191,15 @@ rec {
description = lib.optionalAttrs (option ? description) {
description = option.description.text or option.description;
};
exposedModuleInfo = makeModuleInfo {
exposedModuleInfo = (
makeModuleInfo {
path = option.loc;
defaultText = option.defaultText or null;
};
required = !(option.defaultText or null != null || option ? default);
default = option.default or null;
}
);
# default =
in
# either type
# TODO: if all nested options are excluded, the parent should be excluded too
@@ -208,7 +226,7 @@ rec {
# handle nested options (not a submodule)
# foo.bar = mkOption { type = str; };
else if !option ? _type then
(parseOptions option {
(_parseOptions option {
addHeader = false;
path = currentPath;
})
@@ -388,13 +406,7 @@ rec {
# return jsonschema property definition for attrs
then
default
// (lib.recursiveUpdate exposedModuleInfo (
lib.optionalAttrs (!default ? default) {
"$exportedModuleInfo" = {
required = true;
};
}
))
// exposedModuleInfo
// example
// description
// {
@@ -436,20 +448,9 @@ rec {
# return jsonschema property definition for submodule
# then (lib.attrNames (option.type.getSubOptions option.loc).opt)
then
(lib.recursiveUpdate exposedModuleInfo (
if (default ? default) then
default
else
{
"$exportedModuleInfo" = {
required = true;
};
}
))
// example
// description
// parseSubOptions { inherit option; }
default // exposedModuleInfo // example // description // parseSubOptions ({ inherit option; })
# throw error if option type is not supported
else
notSupported option;
notSupported option
);
}

30
lib/jsonschema/example-schema.json
View File

@@ -1,40 +1,33 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$exportedModuleInfo": { "path": [] },
"type": "object",
"additionalProperties": false,
"required": ["services", "userModules"],
"properties": {
"name": {
"$exportedModuleInfo": { "path": ["name"] },
"type": "string",
"default": "John Doe",
"description": "The name of the user"
},
"age": {
"$exportedModuleInfo": { "path": ["age"] },
"type": "integer",
"default": 42,
"description": "The age of the user"
},
"isAdmin": {
"$exportedModuleInfo": { "path": ["isAdmin"] },
"type": "boolean",
"default": false,
"description": "Is the user an admin?"
},
"kernelModules": {
"$exportedModuleInfo": { "path": ["kernelModules"] },
"type": "array",
"items": {
"$exportedModuleInfo": { "path": ["kernelModules"] },
"type": "string"
},
"default": ["nvme", "xhci_pci", "ahci"],
"description": "A list of enabled kernel modules"
},
"userIds": {
"$exportedModuleInfo": { "path": ["userIds"] },
"type": "object",
"default": {
"horst": 1,
@@ -42,23 +35,17 @@
"albrecht": 3
},
"additionalProperties": {
"$exportedModuleInfo": { "path": ["userIds"] },
"type": "integer"
},
"description": "Some attributes"
},
"userModules": {
"$exportedModuleInfo": { "path": ["userModules"] },
"type": "object",
"additionalProperties": {
"$exportedModuleInfo": { "path": ["userModules", "<name>"] },
"additionalProperties": false,
"type": "object",
"properties": {
"foo": {
"$exportedModuleInfo": {
"path": ["userModules", "<name>", "foo"]
},
"type": [
"boolean",
"integer",
@@ -74,55 +61,44 @@
}
},
"colour": {
"$exportedModuleInfo": { "path": ["colour"] },
"default": "red",
"description": "The colour of the user",
"enum": ["red", "blue", "green"]
},
"services": {
"$exportedModuleInfo": { "path": ["services"] },
"type": "object",
"additionalProperties": false,
"properties": {
"opt": {
"$exportedModuleInfo": { "path": ["services", "opt"] },
"type": "string",
"default": "foo",
"description": "A submodule option"
}
}
},
"required": []
},
"programs": {
"$exportedModuleInfo": { "path": ["programs"] },
"type": "object",
"additionalProperties": false,
"properties": {
"opt": {
"$exportedModuleInfo": { "path": ["programs", "opt"] },
"type": "string",
"default": "bar",
"description": "Another submodule option"
}
},
"required": [],
"default": {}
},
"destinations": {
"$exportedModuleInfo": { "path": ["destinations"] },
"additionalProperties": {
"$exportedModuleInfo": { "path": ["destinations", "<name>"] },
"properties": {
"name": {
"$exportedModuleInfo": {
"path": ["destinations", "<name>", "name"]
},
"default": "‹name›",
"description": "the name of the backup job",
"type": "string"
},
"repo": {
"$exportedModuleInfo": {
"path": ["destinations", "<name>", "repo"]
},
"description": "the borgbackup repository to backup to",
"type": "string"
}

274
lib/jsonschema/test_parseOption.nix
View File

@@ -7,29 +7,31 @@
let
description = "Test Description";
# Wrap the parseOption function to reduce the surface that needs to be migrated, when '$exportedModuleInfo' changes
parseOption = opt: filterSchema (slib.parseOption opt);
evalType =
type: default:
(evalModuleOptions {
options.opt = lib.mkOption {
inherit type description;
default = default;
};
}).opt;
evalModuleOptions =
module:
let
evaledConfig = lib.evalModules {
modules = [
{
options.opt = lib.mkOption {
inherit type;
inherit default;
inherit description;
};
}
module
];
};
in
evaledConfig.options.opt;
evaledConfig.options;
# All options should have the same path
commonModuleInfo = {
"$exportedModuleInfo" = {
path = [ "opt" ];
};
};
filterSchema =
schema: lib.filterAttrsRecursive (name: _value: name != "$exportedModuleInfo") schema;
in
{
testNoDefaultNoDescription =
@@ -39,8 +41,8 @@ in
};
in
{
expr = slib.parseOption evaledConfig.options.opt;
expected = commonModuleInfo // {
expr = parseOption evaledConfig.options.opt;
expected = {
type = "boolean";
};
};
@@ -62,8 +64,8 @@ in
};
in
{
expr = slib.parseOption evaledConfig.options.opt;
expected = commonModuleInfo // {
expr = parseOption evaledConfig.options.opt;
expected = {
type = "boolean";
inherit description;
};
@@ -74,8 +76,8 @@ in
default = false;
in
{
expr = slib.parseOption (evalType lib.types.bool default);
expected = commonModuleInfo // {
expr = parseOption (evalType lib.types.bool default);
expected = {
type = "boolean";
inherit default description;
};
@@ -86,8 +88,8 @@ in
default = "hello";
in
{
expr = slib.parseOption (evalType lib.types.str default);
expected = commonModuleInfo // {
expr = parseOption (evalType lib.types.str default);
expected = {
type = "string";
inherit default description;
};
@@ -98,8 +100,8 @@ in
default = 42;
in
{
expr = slib.parseOption (evalType lib.types.int default);
expected = commonModuleInfo // {
expr = parseOption (evalType lib.types.int default);
expected = {
type = "integer";
inherit default description;
};
@@ -110,8 +112,8 @@ in
default = 42.42;
in
{
expr = slib.parseOption (evalType lib.types.float default);
expected = commonModuleInfo // {
expr = parseOption (evalType lib.types.float default);
expected = {
type = "number";
inherit default description;
};
@@ -127,8 +129,8 @@ in
];
in
{
expr = slib.parseOption (evalType (lib.types.enum values) default);
expected = commonModuleInfo // {
expr = parseOption (evalType (lib.types.enum values) default);
expected = {
enum = values;
inherit default description;
};
@@ -143,14 +145,11 @@ in
];
in
{
expr = slib.parseOption (evalType (lib.types.listOf lib.types.int) default);
expected = commonModuleInfo // {
expr = parseOption (evalType (lib.types.listOf lib.types.int) default);
expected = {
type = "array";
items = {
type = "integer";
"$exportedModuleInfo" = {
path = [ "opt" ];
};
};
inherit default description;
};
@@ -165,13 +164,10 @@ in
];
in
{
expr = slib.parseOption (evalType (lib.types.listOf lib.types.unspecified) default);
expected = commonModuleInfo // {
expr = parseOption (evalType (lib.types.listOf lib.types.unspecified) default);
expected = {
type = "array";
items = {
"$exportedModuleInfo" = {
path = [ "opt" ];
};
type = [
"boolean"
"integer"
@@ -195,8 +191,8 @@ in
};
in
{
expr = slib.parseOption (evalType (lib.types.attrs) default);
expected = commonModuleInfo // {
expr = parseOption (evalType (lib.types.attrs) default);
expected = {
type = "object";
additionalProperties = true;
inherit default description;
@@ -212,13 +208,11 @@ in
};
in
{
expr = slib.parseOption (evalType (lib.types.attrsOf lib.types.int) default);
expected = commonModuleInfo // {
expr = parseOption (evalType (lib.types.attrsOf lib.types.int) default);
expected = {
type = "object";
additionalProperties = {
"$exportedModuleInfo" = {
path = [ "opt" ];
};
type = "integer";
};
inherit default description;
@@ -234,13 +228,11 @@ in
};
in
{
expr = slib.parseOption (evalType (lib.types.lazyAttrsOf lib.types.int) default);
expected = commonModuleInfo // {
expr = parseOption (evalType (lib.types.lazyAttrsOf lib.types.int) default);
expected = {
type = "object";
additionalProperties = {
"$exportedModuleInfo" = {
path = [ "opt" ];
};
type = "integer";
};
inherit default description;
@@ -252,14 +244,17 @@ in
default = null; # null is a valid value for this type
in
{
expr = slib.parseOption (evalType (lib.types.nullOr lib.types.bool) default);
expected = commonModuleInfo // {
expr = parseOption (evalType (lib.types.nullOr lib.types.bool) default);
expected = {
oneOf = [
{ type = "null"; }
{
type = "boolean";
"$exportedModuleInfo" = {
path = [ "opt" ];
default = null;
defaultText = null;
required = true;
};
}
];
@@ -272,19 +267,25 @@ in
default = null; # null is a valid value for this type
in
{
expr = slib.parseOption (evalType (lib.types.nullOr (lib.types.nullOr lib.types.bool)) default);
expected = commonModuleInfo // {
expr = parseOption (evalType (lib.types.nullOr (lib.types.nullOr lib.types.bool)) default);
expected = {
oneOf = [
{ type = "null"; }
{
"$exportedModuleInfo" = {
default = null;
defaultText = null;
path = [ "opt" ];
required = true;
};
oneOf = [
{ type = "null"; }
{
"$exportedModuleInfo" = {
default = null;
defaultText = null;
path = [ "opt" ];
required = true;
};
type = "boolean";
}
@@ -306,8 +307,8 @@ in
};
in
{
expr = slib.parseOption (evalType (lib.types.submodule subModule) { });
expected = commonModuleInfo // {
expr = parseOption (evalType (lib.types.submodule subModule) { });
expected = {
type = "object";
additionalProperties = false;
description = "Test Description";
@@ -316,14 +317,9 @@ in
type = "boolean";
default = true;
inherit description;
"$exportedModuleInfo" = {
path = [
"opt"
"opt"
];
};
};
};
required = [ ];
default = { };
};
};
@@ -331,32 +327,28 @@ in
testSubmoduleOptionWithoutDefault =
let
subModule = {
options.opt = lib.mkOption {
options.foo = lib.mkOption {
type = lib.types.bool;
inherit description;
};
};
opt = evalType (lib.types.submodule subModule) { };
in
{
expr = slib.parseOption (evalType (lib.types.submodule subModule) { });
expected = commonModuleInfo // {
inherit opt;
expr = parseOption (opt);
expected = {
type = "object";
additionalProperties = false;
description = "Test Description";
properties = {
opt = {
foo = {
type = "boolean";
inherit description;
"$exportedModuleInfo" = {
path = [
"opt"
"opt"
];
};
};
};
default = { };
required = [ "opt" ];
required = [ "foo" ];
};
};
@@ -375,32 +367,21 @@ in
};
in
{
expr = slib.parseOption (evalType (lib.types.attrsOf (lib.types.submodule subModule)) default);
expected = commonModuleInfo // {
expr = parseOption (evalType (lib.types.attrsOf (lib.types.submodule subModule)) default);
expected = {
type = "object";
additionalProperties = {
"$exportedModuleInfo" = {
path = [
"opt"
"<name>"
];
};
type = "object";
additionalProperties = false;
properties = {
opt = {
"$exportedModuleInfo" = {
path = [
"opt"
"<name>"
"opt"
];
};
type = "boolean";
default = true;
inherit description;
};
};
required = [ ];
};
inherit default description;
};
@@ -421,13 +402,10 @@ in
];
in
{
expr = slib.parseOption (evalType (lib.types.listOf (lib.types.submodule subModule)) default);
expected = commonModuleInfo // {
expr = parseOption (evalType (lib.types.listOf (lib.types.submodule subModule)) default);
expected = {
type = "array";
items = {
"$exportedModuleInfo" = {
path = [ "opt" ];
};
type = "object";
additionalProperties = false;
properties = {
@@ -435,15 +413,9 @@ in
type = "boolean";
default = true;
inherit description;
"$exportedModuleInfo" = {
path = [
"opt"
"*"
"opt"
];
};
};
};
required = [ ];
};
inherit default description;
};
@@ -454,18 +426,24 @@ in
default = "foo";
in
{
expr = slib.parseOption (evalType (lib.types.either lib.types.bool lib.types.str) default);
expected = commonModuleInfo // {
expr = parseOption (evalType (lib.types.either lib.types.bool lib.types.str) default);
expected = {
oneOf = [
{
"$exportedModuleInfo" = {
path = [ "opt" ];
default = null;
defaultText = null;
required = true;
};
type = "boolean";
}
{
"$exportedModuleInfo" = {
path = [ "opt" ];
default = null;
defaultText = null;
required = true;
};
type = "string";
}
@@ -479,8 +457,8 @@ in
default = "foo";
in
{
expr = slib.parseOption (evalType lib.types.anything default);
expected = commonModuleInfo // {
expr = parseOption (evalType lib.types.anything default);
expected = {
inherit default description;
type = [
"boolean"
@@ -499,8 +477,8 @@ in
default = "foo";
in
{
expr = slib.parseOption (evalType lib.types.unspecified default);
expected = commonModuleInfo // {
expr = parseOption (evalType lib.types.unspecified default);
expected = {
inherit default description;
type = [
"boolean"
@@ -519,8 +497,8 @@ in
default = "foo";
in
{
expr = slib.parseOption (evalType lib.types.raw default);
expected = commonModuleInfo // {
expr = parseOption (evalType lib.types.raw default);
expected = {
inherit default description;
type = [
"boolean"
@@ -533,4 +511,84 @@ in
];
};
};
test_option_with_default_text = {
expr = (
parseOption (evalModuleOptions {
options.opt = lib.mkOption {
type = lib.types.bool;
defaultText = "This option is a optional, but we cannot assign a default value to it yet.";
};
})
);
expected = {
additionalProperties = false;
properties = {
opt = {
type = "boolean";
};
};
# opt is not required, because it has a defaultText
required = [ ];
type = "object";
};
};
test_nested_option_with_default_text = {
expr = (
parseOption (evalModuleOptions {
options.opt = lib.mkOption {
type = lib.types.submodule {
options = {
foo = lib.mkOption {
type = lib.types.bool;
defaultText = "Not required";
};
};
};
defaultText = "Not required";
};
})
);
expected = {
additionalProperties = false;
properties = {
opt = {
additionalProperties = false;
properties = {
foo = {
type = "boolean";
};
};
required = [ ];
type = "object";
};
};
required = [ ];
type = "object";
};
};
# Default MUST not be evaluated if defaultText is present
test_default_lazyness = {
expr = (
parseOption (evalModuleOptions {
options.opt = lib.mkOption {
type = lib.types.bool;
default = throw "This option is lazy";
defaultText = "This option is lazy";
};
})
);
expected = {
additionalProperties = false;
properties = {
opt = {
type = "boolean";
};
};
required = [ ];
type = "object";
};
};
}

41
lib/jsonschema/test_parseOptions.nix
View File

@@ -4,9 +4,13 @@
lib ? (import <nixpkgs> { }).lib,
slib ? (import ./. { inherit lib; } { }),
}:
let
filterSchema =
schema: lib.filterAttrsRecursive (name: _value: name != "$exportedModuleInfo") schema;
in
{
testParseOptions = {
expr = slib.parseModule ./example-interface.nix;
expr = filterSchema (slib.parseModule ./example-interface.nix);
expected = builtins.fromJSON (builtins.readFile ./example-schema.json);
};
@@ -27,36 +31,18 @@
};
in
{
expr = slib.parseOptions evaled.options { };
expr = filterSchema (slib.parseOptions evaled.options { });
expected = {
"$schema" = "http://json-schema.org/draft-07/schema#";
"$exportedModuleInfo" = {
path = [ ];
};
additionalProperties = false;
properties = {
foo = {
"$exportedModuleInfo" = {
path = [ "foo" ];
};
additionalProperties = false;
properties = {
bar = {
"$exportedModuleInfo" = {
path = [
"foo"
"bar"
];
};
type = "boolean";
};
baz = {
"$exportedModuleInfo" = {
path = [
"foo"
"baz"
];
};
type = "boolean";
default = false;
};
@@ -78,7 +64,7 @@
};
in
{
expr =
expr = filterSchema (
slib.parseOptions
(lib.evalModules {
modules = [
@@ -91,29 +77,22 @@
default
];
}).options
{ };
{ }
);
expected = {
"$schema" = "http://json-schema.org/draft-07/schema#";
"$exportedModuleInfo" = {
path = [ ];
};
additionalProperties = {
"$exportedModuleInfo" = {
path = [ ];
};
type = "integer";
};
properties = {
enable = {
"$exportedModuleInfo" = {
path = [ "enable" ];
};
default = false;
description = "Whether to enable enable this.";
examples = [ true ];
type = "boolean";
};
};
required = [ ];
type = "object";
};
};