kiara/Fediversity
1
0
Fork 0
forked from Fediversity/Fediversity
Code Pull requests Activity

model: add classes

Browse source 
remove _class for application requirements to allow iterating over values

rm function class

re-add nix-unit class
This commit is contained in:
Kiara Grouwstra 2025-07-19 12:18:03 +02:00
parent 1cc6a31c9c
commit eba4be2b1e
Signed by: kiara
SSH key fingerprint: SHA256:COspvLoLJ5WC5rFb9ZDe5urVCkK4LJZOsjfF4duRJFU
2 changed files with 166 additions and 124 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
deployment/data-model-test.nix
View file

@ -16,12 +16,15 @@ let
nixops4Deployment = inputs.nixops4.modules.nixops4Deployment.default; nixops4Deployment = inputs.nixops4.modules.nixops4Deployment.default;
in in
{ {
_class = "nix-unit";
test-eval = { test-eval = {
expr = expr =
let let
fediversity = eval ( fediversity = eval (
{ config, ... }: { config, ... }:
{ {
_class = "fediversity-settings";
config = { config = {
resources.nixos-configuration = { resources.nixos-configuration = {
description = "An entire NixOS configuration"; description = "An entire NixOS configuration";
@ -51,6 +54,7 @@ in
}; };
}; };
resources.login-shell = { resources.login-shell = {
_class = "fediversity-resource";
description = "The operator needs to be able to log into the shell"; description = "The operator needs to be able to log into the shell";
request = request =
{ ... }: { ... }:
@ -104,10 +108,12 @@ in
applications.hello = applications.hello =
{ ... }: { ... }:
{ {
_class = "fediversity-application";
description = ''Command-line tool that will print "Hello, world!" on the terminal''; description = ''Command-line tool that will print "Hello, world!" on the terminal'';
module = module =
{ ... }: { ... }:
{ {
_class = "fediversity-application-config";
options = { options = {
enable = lib.mkEnableOption "Hello in the shell"; enable = lib.mkEnableOption "Hello in the shell";
}; };
@ -121,15 +127,18 @@ in
environments.single-nixos-vm = environments.single-nixos-vm =
{ config, ... }: { config, ... }:
{ {
_class = "fediversity-environment";
resources.shell.login-shell.username = "operator"; resources.shell.login-shell.username = "operator";
implementation = implementation =
requests: requests:
{ providers, ... }: { providers, ... }:
{ {
_class = "nixops4Deployment";
providers = { providers = {
inherit (inputs.nixops4.modules.nixops4Provider) local; inherit (inputs.nixops4.modules.nixops4Provider) local;
}; };
resources.the-machine = { resources.the-machine = {
_class = "nixops4Resource";
type = providers.local.exec; type = providers.local.exec;
imports = [ imports = [
inputs.nixops4-nixos.modules.nixops4Resource.nixos inputs.nixops4-nixos.modules.nixops4Resource.nixos
@ -137,6 +146,7 @@ in
nixos.module = nixos.module =
{ ... }: { ... }:
{ {
_class = "nixos";
users.users = config.resources.shell.login-shell.apply ( users.users = config.resources.shell.login-shell.apply (
lib.filterAttrs (_name: value: value ? login-shell) requests lib.filterAttrs (_name: value: value ? login-shell) requests
); );
@ -150,6 +160,7 @@ in
type = config.configuration; type = config.configuration;
readOnly = true; readOnly = true;
default = { default = {
_class = "fediversity-configuration";
enable = true; enable = true;
applications.hello.enable = true; applications.hello.enable = true;
}; };

85
deployment/data-model.nix
View file

@ -10,13 +10,14 @@ let
attrsOf attrsOf
attrTag attrTag
deferredModuleWith deferredModuleWith
submodule submoduleWith
optionType optionType
functionTo functionTo
; ;
functionType = import ./function.nix; functionType = import ./function.nix;
application-resources = { application-requirements = {
_class = "fediversity-application-requirements";
options.resources = mkOption { options.resources = mkOption {
# TODO: maybe transpose, and group the resources by type instead # TODO: maybe transpose, and group the resources by type instead
type = attrsOf ( type = attrsOf (
@ -26,16 +27,16 @@ let
}; };
in in
{ {
_class = "nixops4Deployment"; _class = "fediversity-settings";
options = { options = {
resources = mkOption { resources = mkOption {
description = "Collection of deployment resources that can be required by applications and policed by hosting providers"; description = "Collection of deployment resources that can be required by applications and policed by hosting providers";
type = attrsOf ( type = attrsOf (submoduleWith {
submodule ( class = "fediversity-resource";
modules = [
(
{ ... }: { ... }:
{ {
_class = "fediversity-resource";
options = { options = {
description = mkOption { description = mkOption {
description = "Description of the resource to help application module authors and hosting providers to work with it"; description = "Description of the resource to help application module authors and hosting providers to work with it";
@ -47,10 +48,10 @@ in
}; };
policy = mkOption { policy = mkOption {
description = "Options for configuring the resource policy for the hosting provider, a description of how the resource is made available"; description = "Options for configuring the resource policy for the hosting provider, a description of how the resource is made available";
type = deferredModuleWith { type = submoduleWith {
staticModules = [ class = "fediversity-resource-policy";
modules = [
{ {
_class = "fediversity-resource-policy";
options.apply = mkOption { options.apply = mkOption {
description = "Apply the policy to a request"; description = "Apply the policy to a request";
}; };
@ -61,13 +62,15 @@ in
}; };
} }
) )
); ];
});
}; };
applications = mkOption { applications = mkOption {
description = "Collection of Fediversity applications"; description = "Collection of Fediversity applications";
type = attrsOf ( type = attrsOf (submoduleWith {
submodule (application: { class = "fediversity-application";
_class = "fediversity-application"; modules = [
(application: {
options = { options = {
description = mkOption { description = mkOption {
description = "Description to be shown in the application overview"; description = "Description to be shown in the application overview";
@ -89,16 +92,20 @@ in
}; };
config-mapping = mkOption { config-mapping = mkOption {
description = "Function type for the mapping from application configuration to required resources"; description = "Function type for the mapping from application configuration to required resources";
type = submodule functionType; type = submoduleWith {
class = "module-function";
modules = [ functionType ];
};
readOnly = true; readOnly = true;
default = { default = {
input-type = application.config.module; input-type = application.config.module;
output-type = application-resources; output-type = application-requirements;
}; };
}; };
}; };
}) })
); ];
});
}; };
configuration = mkOption { configuration = mkOption {
description = "Configuration type declaring options to be set by operators"; description = "Configuration type declaring options to be set by operators";
@ -122,9 +129,10 @@ in
}; };
environments = mkOption { environments = mkOption {
description = "Run-time environments for Fediversity applications to be deployed to"; description = "Run-time environments for Fediversity applications to be deployed to";
type = attrsOf ( type = attrsOf (submoduleWith {
submodule (environment: { class = "fediversity-environment";
_class = "fediversity-environment"; modules = [
(environment: {
options = { options = {
resources = mkOption { resources = mkOption {
description = '' description = ''
@ -135,7 +143,15 @@ in
# TODO: maybe transpose, and group the resources by type instead # TODO: maybe transpose, and group the resources by type instead
type = attrsOf ( type = attrsOf (
attrTag ( attrTag (
lib.mapAttrs (_name: resource: mkOption { type = submodule resource.policy; }) config.resources lib.mapAttrs (
_name: resource:
mkOption {
type = submoduleWith {
class = "fediversity-resource-policy";
modules = [ resource.policy ];
};
}
) config.resources
) )
); );
}; };
@ -145,16 +161,22 @@ in
}; };
resource-mapping = mkOption { resource-mapping = mkOption {
description = "Function type for the mapping from resources to a (NixOps4) deployment"; description = "Function type for the mapping from resources to a (NixOps4) deployment";
type = submodule functionType; type = submoduleWith {
class = "module-function";
modules = [ functionType ];
};
readOnly = true; readOnly = true;
default = { default = {
input-type = application-resources; input-type = application-requirements;
output-type = nixops4Deployment; output-type = nixops4Deployment;
}; };
}; };
deployment = mkOption { deployment = mkOption {
description = "Generate a deployment from a configuration"; description = "Generate a deployment from a configuration";
type = functionTo (submodule environment.config.resource-mapping.output-type); type = functionTo (submoduleWith {
class = "nixops4Deployment";
modules = [ environment.config.resource-mapping.output-type ];
});
readOnly = true; readOnly = true;
default = default =
cfg: cfg:
@ -169,13 +191,17 @@ in
}; };
}; };
}) })
); ];
});
}; };
configuration = mkOption { configuration = mkOption {
description = "Configuration type declaring options to be set by operators"; description = "Configuration type declaring options to be set by operators";
type = optionType; type = optionType;
readOnly = true; readOnly = true;
default = submodule { default = submoduleWith {
class = "fediversity-configuration";
modules = [
{
options = { options = {
enable = lib.mkEnableOption { enable = lib.mkEnableOption {
description = "your Fediversity configuration"; description = "your Fediversity configuration";
@ -184,11 +210,16 @@ in
_name: application: _name: application:
mkOption { mkOption {
description = application.description; description = application.description;
type = submodule application.module; type = submoduleWith {
class = "fediversity-application-config";
modules = [ application.module ];
};
default = { }; default = { };
} }
) config.applications; ) config.applications;
}; };
}
];
}; };
}; };
}; };