Compare commits

...

22 commits

Author SHA1 Message Date
4c9db0d540
[HACK] comment environment resources type, making the test go through 2025-07-22 19:12:58 +02:00
63d668a69d
[HACK] explicitly set resource options, as defaults seem insufficient 2025-07-22 19:12:58 +02:00
d24738133f
[HACK] explicitly pass instantiated policy to apply 2025-07-22 19:12:58 +02:00
0b4aa2e084
[HACK] unwire deployment resource-mapping output-type, fixes error: Expected a module, but found a value of type "option-type" 2025-07-22 19:12:58 +02:00
91c5d16f06
[HACK] swap out nixops4 deployments for raw nixos modules
rm deployment

rm imports
2025-07-22 19:12:58 +02:00
a8fdc72460
reproduce nixops4-nixos importing issue: The option environments.single-nixos-vm.deployment.<function body>.resources.the-machine.nixos' does not exist`
add comment explaining our nixops4 type problem
2025-07-22 19:12:58 +02:00
5ab9f3afeb
swap out dummy module for actual import
clean deployment module a bit

simplify imports
2025-07-22 19:12:58 +02:00
f7da88c919
model: [DUMMY] use mock deployment to temporarily simplify the problem
type policy.apply

remove `apply`'s optionType, fixes duplicate definition error
2025-07-22 19:12:58 +02:00
9b5eb50fbc
environment: fix implementation type 2025-07-22 19:12:58 +02:00
3efe6f347f
pass resourceProviderSystem to nixops4Deployment 2025-07-22 19:12:58 +02:00
cd097a7afd
resolve resource mapping input discrepancy according to actual implementation, adjusting the type accordingly 2025-07-22 19:12:58 +02:00
e668239f8a
properly flatten out application layer at users.users 2025-07-22 19:12:58 +02:00
4f024c8030
fix application resource type 2025-07-22 19:12:58 +02:00
7ec11ebde8
fix application-requirements 2025-07-22 19:12:58 +02:00
a6fc12709d
resolve rebase 2025-07-22 19:12:58 +02:00
cce6a06bf3
untangle applications from function type, as they seem to not need the introspection (and may type-check input without it) 2025-07-22 19:12:58 +02:00
9f43c8a278
make packages filter return a list 2025-07-22 19:12:56 +02:00
8173f65f18
add trivial unit test for deployment - now to find how to make it work!
test proper expectation

test proper expectation

settle for counting packages over comparing them, solves an infinite recursion
2025-07-22 19:12:52 +02:00
1b3dc70466
fix environment deployment 2025-07-22 19:12:51 +02:00
eba4be2b1e
model: add classes
remove _class for application requirements to allow iterating over values

rm function class

re-add nix-unit class
2025-07-22 19:12:50 +02:00
1cc6a31c9c
use submodule to turn module into type for functionTo 2025-07-22 19:12:48 +02:00
c94d575392
use mapAttrs right
`mapAttrs'` takes two args rather than a set, whereas if only the val
changes `mapAttrs (_: v: ...)` should do
2025-07-22 19:12:47 +02:00
3 changed files with 196 additions and 205 deletions

View file

@ -9,8 +9,6 @@ let
git-hooks git-hooks
gitignore gitignore
; ;
inherit (import sources.flake-inputs) import-flake;
inputs = (import-flake { src = ./.; }).inputs;
inherit (pkgs) lib; inherit (pkgs) lib;
inherit (import sources.flake-inputs) import-flake; inherit (import sources.flake-inputs) import-flake;
inherit ((import-flake { src = ./.; }).inputs) nixops4; inherit ((import-flake { src = ./.; }).inputs) nixops4;
@ -80,7 +78,6 @@ in
# re-export inputs so they can be overridden granularly # re-export inputs so they can be overridden granularly
# (they can't be accessed from the outside any other way) # (they can't be accessed from the outside any other way)
inherit inherit
inputs
sources sources
system system
pkgs pkgs

View file

@ -1,7 +1,7 @@
let let
inherit (import ../default.nix { }) pkgs inputs; inherit (import ../default.nix { }) pkgs inputs;
inherit (pkgs) lib; inherit (pkgs) lib;
inherit (lib) mkOption; inherit (lib) mkOption types;
eval = eval =
module: module:
(lib.evalModules { (lib.evalModules {
@ -13,15 +13,17 @@ let
./data-model.nix ./data-model.nix
]; ];
}).config; }).config;
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";
@ -35,7 +37,7 @@ in
}; };
policy = policy =
{ config, ... }: { ... }:
{ {
_class = "fediversity-resource-policy"; _class = "fediversity-resource-policy";
@ -45,12 +47,13 @@ in
}; };
apply = mkOption { apply = mkOption {
type = with types; functionTo raw; type = with types; functionTo raw;
default = requests: lib.mkMerge (requests ++ [ config.extra-config ]); default = policy: requests: lib.mkMerge (requests ++ [ policy.extra-config ]);
}; };
}; };
}; };
}; };
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 =
{ ... }: { ... }:
@ -69,7 +72,7 @@ in
}; };
}; };
policy = policy =
{ config, ... }: { ... }:
{ {
_class = "fediversity-resource-policy"; _class = "fediversity-resource-policy";
options = { options = {
@ -85,16 +88,16 @@ in
apply = mkOption { apply = mkOption {
type = with types; functionTo raw; # TODO: splice out the user type from NixOS type = with types; functionTo raw; # TODO: splice out the user type from NixOS
default = default =
requests: policy: requests:
let let
# Filter out requests that need wheel if policy doesn't allow it # Filter out requests that need wheel if policy doesn't allow it
validRequests = lib.filterAttrs (_name: req: !req.wheel || config.wheel) requests; validRequests = lib.filterAttrs (_name: req: !req.wheel || policy.wheel) requests;
in in
lib.optionalAttrs (validRequests != { }) { lib.optionalAttrs (validRequests != { }) {
${config.username} = { ${policy.username} = {
isNormalUser = true; isNormalUser = true;
packages = with lib; concatMapAttrs (_name: request: attrValues request.packages) validRequests; packages = with lib; concatMap (request: attrValues request.packages) (attrValues validRequests);
extraGroups = lib.optional config.wheel "wheel"; extraGroups = lib.optional policy.wheel "wheel";
}; };
}; };
}; };
@ -104,64 +107,58 @@ 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";
}; };
}; };
implementation = resources =
cfg: cfg:
lib.optionalAttrs cfg.enable { lib.optionalAttrs cfg.enable {
dummy.login-shell.packages.hello = pkgs.hello; dummy.login-shell.packages.hello = pkgs.hello;
}; };
}; };
environments.single-nixos-vm = environments.single-nixos-vm = environment: {
{ config, ... }: _class = "fediversity-environment";
{ resources.shell.login-shell = {
resources.shell.login-shell.username = "operator"; username = "operator";
implementation = wheel = false; # FIXME: why do i need to make this explicit, if a default was supposed to be set?
requests:
{ providers, ... }:
{
providers = {
inherit (inputs.nixops4.modules.nixops4Provider) local;
};
resources.the-machine = {
type = providers.local.exec;
imports = [
inputs.nixops4-nixos.modules.nixops4Resource.nixos
];
nixos.module =
{ ... }:
{
users.users = config.resources.shell.login-shell.apply (
lib.filterAttrs (_name: value: value ? login-shell) requests
);
};
};
};
}; };
implementation = requests: {
_class = "nixos";
users.users = (
config.resources.login-shell.policy.apply environment.config.resources.shell.login-shell (
lib.concatMapAttrs (
_application: resources:
lib.mapAttrs (_k: lib.getAttr "login-shell") (
lib.filterAttrs (_name: value: value ? login-shell) resources
)
) requests
)
);
};
};
}; };
options = { options = {
example-configuration = mkOption { example-configuration = mkOption {
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;
}; };
}; };
}; example-deployment = mkOption {
environments.single-nixos-vm = { type = types.raw;
readOnly = true;
}; default = config.environments.single-nixos-vm.deployment config.example-configuration;
configurations.example = { };
enable = true;
applications.hello.enable = true;
# default = config.environments.single-nixos-vm.deployment config.example-configuration;
}; };
} }
); );
@ -170,12 +167,14 @@ in
inherit (fediversity) inherit (fediversity)
example-configuration example-configuration
; ;
num-packages = lib.lists.length fediversity.example-deployment.users.users.operator.packages;
}; };
expected = { expected = {
example-configuration = { example-configuration = {
enable = true; enable = true;
applications.hello.enable = true; applications.hello.enable = true;
}; };
num-packages = 1;
}; };
}; };
} }

View file

@ -1,7 +1,6 @@
{ {
lib, lib,
config, config,
inputs,
... ...
}: }:
let let
@ -10,188 +9,184 @@ let
attrsOf attrsOf
attrTag attrTag
deferredModuleWith deferredModuleWith
submodule submoduleWith
optionType optionType
functionTo functionTo
raw
; ;
functionType = import ./function.nix; functionType = import ./function.nix;
application-resources = {
options.resources = mkOption { configuration = mkOption {
# TODO: maybe transpose, and group the resources by type instead description = "Configuration type declaring options to be set by operators";
type = attrsOf ( type = optionType;
attrTag (lib.mapAttrs (_name: resource: mkOption { type = resource.request; }) config.resources) readOnly = true;
); default = submoduleWith {
class = "fediversity-configuration";
modules = [
{
options = {
enable = lib.mkEnableOption {
description = "your Fediversity configuration";
};
applications = lib.mapAttrs (
_name: application:
mkOption {
description = application.description;
type = submoduleWith {
class = "fediversity-application-config";
modules = [ application.module ];
};
default = { };
}
) config.applications;
};
}
];
}; };
}; };
in in
{ {
_class = "nixops4Deployment"; _class = "fediversity-settings";
options = { options = {
inherit configuration;
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 = { {
description = mkOption { options = {
description = "Description of the resource to help application module authors and hosting providers to work with it"; description = mkOption {
type = types.str; description = "Description of the resource to help application module authors and hosting providers to work with it";
}; type = types.str;
request = mkOption { };
description = "Options for declaring resource requirements by an application, a description of how the resource is consumed or accessed"; request = mkOption {
type = deferredModuleWith { staticModules = [ { _class = "fediversity-resource-request"; } ]; }; description = "Options for declaring resource requirements by an application, a description of how the resource is consumed or accessed";
}; type = deferredModuleWith { staticModules = [ { _class = "fediversity-resource-request"; } ]; };
policy = mkOption { };
description = "Options for configuring the resource policy for the hosting provider, a description of how the resource is made available"; policy = mkOption {
type = deferredModuleWith { description = "Options for configuring the resource policy for the hosting provider, a description of how the resource is made available";
staticModules = [ type = submoduleWith {
{ class = "fediversity-resource-policy";
_class = "fediversity-resource-policy"; modules = [
options.apply = mkOption { {
description = "Apply the policy to a request"; options.apply = mkOption {
}; description = "Apply the policy to a request";
} };
]; }
];
};
}; };
}; };
}; }
} )
) ];
); });
}; };
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 = [
options = { {
description = mkOption { options = {
description = "Description to be shown in the application overview"; description = mkOption {
type = types.str; description = "Description to be shown in the application overview";
}; type = types.str;
module = mkOption { };
description = "Operator-facing configuration options for the application"; module = mkOption {
type = deferredModuleWith { staticModules = [ { _class = "fediversity-application-config"; } ]; }; description = "Operator-facing configuration options for the application";
}; type = deferredModuleWith { staticModules = [ { _class = "fediversity-application-config"; } ]; };
implementation = mkOption { };
description = "Mapping of application configuration to deployment resources, a description of what an application needs to run"; resources = mkOption {
type = application.config.config-mapping.function-type; description = "Mapping of application configuration to deployment resources, a description of what an application needs to run";
}; # TODO: maybe transpose, and group the resources by type instead
resources = mkOption { type = functionTo (
description = "Compute resources required by an application"; attrsOf (
type = functionTo application.config.config-mapping.output-type; attrTag (
readOnly = true; lib.mapAttrs (
default = input: (application.config.implementation input).output; _name: resource: mkOption { type = types.submodule resource.request; }
}; ) config.resources
config-mapping = mkOption { )
description = "Function type for the mapping from application configuration to required resources"; )
type = submodule functionType; );
readOnly = true;
default = {
input-type = application.config.module;
output-type = application-resources;
}; };
}; };
}; }
}) ];
); });
};
configuration = mkOption {
description = "Configuration type declaring options to be set by operators";
type = optionType;
readOnly = true;
default = submodule {
options = {
enable = lib.mkEnableOption {
description = "your Fediversity configuration";
};
applications = lib.mapAttrs (
_name: application:
mkOption {
description = application.description;
type = submodule application.module;
default = { };
}
) config.applications;
};
};
}; };
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 = [
options = { (environment: {
resources = mkOption { options = {
description = '' resources = mkOption {
Resources made available by the hosting provider, and their policies. description = ''
Resources made available by the hosting provider, and their policies.
Setting this is optional, but provides a place to declare that information for programmatic use in the resource mapping.
'';
# TODO: maybe transpose, and group the resources by type instead
# # FIXME: error: The option `environments.single-nixos-vm.resources.shell.login-shell.apply' does not exist. Definition values:
# # - In `<unknown-file>': <function>
# # However there are no options defined in `environments.single-nixos-vm.resources.shell.login-shell'. Are you sure you've
# # declared your options properly? This can happen if you e.g. declared your options in `types.submodule'
# # under `config' rather than `options'.
# type = attrsOf (
# attrTag (
# lib.mapAttrs (
# _name: resource:
# mkOption {
# type = submoduleWith {
# class = "fediversity-resource-policy";
# modules = [ resource.policy ];
# };
# }
# ) config.resources
# )
# );
};
implementation = mkOption {
description = "Mapping of resources required by applications to available resources; the result can be deployed";
type = functionTo raw;
};
resource-mapping = mkOption {
description = "Function type for the mapping from resources to a (NixOps4) deployment";
type = submoduleWith {
class = "module-function";
modules = [ functionType ];
};
readOnly = true;
default = {
input-type = configuration;
output-type = raw;
};
};
deployment = mkOption {
description = "Generate a deployment from a configuration";
type = functionTo raw;
readOnly = true;
default =
cfg:
# TODO: check cfg.enable.true
let
required-resources = lib.mapAttrs (
name: application-settings: config.applications.${name}.resources application-settings
) cfg.applications;
in
(environment.config.implementation required-resources);
Setting this is optional, but provides a place to declare that information for programmatic use in the resource mapping.
'';
# TODO: maybe transpose, and group the resources by type instead
type = attrsOf (
attrTag (
lib.mapAttrs' (name: resource: {
${name} = mkOption { type = resource.policy; };
}) config.resources
)
);
};
implementation = mkOption {
description = "Mapping of resources required by applications to available resources; the result can be deployed";
type = environment.config.resource-mapping.function-type;
};
resource-mapping = mkOption {
description = "Function type for the mapping from resources to a (NixOps4) deployment";
type = submodule functionType;
readOnly = true;
default = {
input-type = application-resources;
output-type = nixops4Deployment;
}; };
}; };
deployment = mkOption { })
description = "Generate a deployment from a configuration"; ];
type = functionTo environment.config.resource-mapping.output-type; });
readOnly = true;
default =
cfg:
# TODO: check cfg.enable.true
let
required-resources = lib.mapAttrs (
name: application-settings: config.applications.${name}.resources application-settings
) cfg.applications;
in
(environment.config.implementation required-resources).output;
};
};
})
);
};
configuration = mkOption {
description = "Configuration type declaring options to be set by operators";
type = optionType;
readOnly = true;
default = submodule {
options = {
enable = lib.mkEnableOption {
description = "your Fediversity configuration";
};
applications = lib.mapAttrs (
_name: application:
mkOption {
description = application.description;
type = submodule application.module;
default = { };
}
) config.applications;
};
};
}; };
}; };
} }