data model: add classes

specifies classes in the data model, raising these to from `_class`
model attributes to `subModuleWith`'s `class` parameter where possible.

note: resource policy has remained as to use `deferredModuleWith`
(rather than `submoduleWith`) to ensure evaluation will go thru.

deployment/data-model-test.nix

@@ -68,24 +68,26 @@ in
                         default = false;
                       };
                     };
-                    config.resource-type = types.raw; # TODO: splice out the user type from NixOS
+                    config = {
-                    config.apply =
+                      resource-type = types.raw; # TODO: splice out the user type from NixOS
-                      requests:
+                      apply =
-                      let
+                        requests:
-                        # Filter out requests that need wheel if policy doesn't allow it
+                        let
-                        validRequests = lib.filterAttrs (
+                          # Filter out requests that need wheel if policy doesn't allow it
-                          _name: req: !req.login-shell.wheel || config.wheel
+                          validRequests = lib.filterAttrs (
-                        ) requests.resources;
+                            _name: req: !req.login-shell.wheel || config.wheel
-                      in
+                          ) requests.resources;
-                      lib.optionalAttrs (validRequests != { }) {
+                        in
-                        ${config.username} = {
+                        lib.optionalAttrs (validRequests != { }) {
-                          isNormalUser = true;
+                          ${config.username} = {
-                          packages =
+                            isNormalUser = true;
-                            with lib;
+                            packages =
-                            attrValues (concatMapAttrs (_name: request: request.login-shell.packages) validRequests);
+                              with lib;
-                          extraGroups = lib.optional config.wheel "wheel";
+                              attrValues (concatMapAttrs (_name: request: request.login-shell.packages) validRequests);
+                            extraGroups = lib.optional config.wheel "wheel";
+                          };
                         };
-                      };
+                    };
                   };
               };
               applications.hello =
@@ -151,7 +153,7 @@ in
           }
         );
         resources = fediversity.applications.hello.resources fediversity.example-configuration.applications.hello;
-        hello-shell = (resources).resources.hello.login-shell;
+        hello-shell = resources.resources.hello.login-shell;
         environment = fediversity.environments.single-nixos-vm.resources.operator-environment.login-shell;
         result = mkDeployment {
           modules = [
@@ -160,7 +162,7 @@ in
         };
 
       in
-      rec {
+      {
         number-of-resources = with lib; length (attrNames fediversity.resources);
         inherit (fediversity) example-configuration;
         hello-package-exists = hello-shell.packages ? hello;
@@ -172,7 +174,7 @@ in
           in
           {
             inherit (operator) isNormalUser;
-            packages = with lib; map (p: "${p.pname}") operator.packages;
+            packages = map (p: "${p.pname}") operator.packages;
             extraGroups = operator.extraGroups;
           };
         deployment = {

deployment/data-model.nix

@@ -11,12 +11,14 @@ let
     attrTag
     deferredModuleWith
     submodule
+    submoduleWith
     optionType
     functionTo
     ;
 
   functionType = import ./function.nix;
   application-resources = submodule {
+    _class = "fediversity-application-requirements";
     options.resources = mkOption {
       # TODO: maybe transpose, and group the resources by type instead
       type = attrsOf (
@@ -40,141 +42,163 @@ let
   };
 in
 {
-  _class = "nixops4Deployment";
+  _class = "fediversity-settings";
 
   options = {
     resources = mkOption {
       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 {
+              _class = "fediversity-resource";
-                description = "Description of the resource to help application module authors and hosting providers to work with it";
+              options = {
-                type = types.str;
+                description = mkOption {
-              };
+                  description = "Description of the resource to help application module authors and hosting providers to work with it";
-              request = mkOption {
+                  type = types.str;
-                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"; } ]; };
+                request = mkOption {
-              };
+                  description = "Options for declaring resource requirements by an application, a description of how the resource is consumed or accessed";
-              policy = mkOption {
+                  type = deferredModuleWith { staticModules = [ { _class = "fediversity-resource-request"; } ]; };
-                description = "Options for configuring the resource policy for the hosting provider, a description of how the resource is made available";
+                };
-                type = deferredModuleWith {
+                policy = mkOption {
-                  staticModules = [
+                  description = "Options for configuring the resource policy for the hosting provider, a description of how the resource is made available";
-                    (policy: {
+                  type = deferredModuleWith {
-                      _class = "fediversity-resource-policy";
+                    staticModules = [
-                      options.resource-type = mkOption {
+                      (policy: {
-                        description = "The type of resource this policy configures";
+                        _class = "fediversity-resource-policy";
-                        type = types.optionType;
+                        options.resource-type = mkOption {
-                      };
+                          description = "The type of resource this policy configures";
-                      # TODO(@fricklerhandwerk): we may want to make the function type explict here: `request -> resource-type`
+                          type = types.optionType;
-                      # and then also rename this to be consistent with the application's resource mapping
+                        };
-                      options.apply = mkOption {
+                        # TODO(@fricklerhandwerk): we may want to make the function type explict here: `request -> resource-type`
-                        description = "Apply the policy to a request";
+                        # and then also rename this to be consistent with the application's resource mapping
-                        type = with types; functionTo policy.config.resource-type;
+                        options.apply = mkOption {
-                      };
+                          description = "Apply the policy to a request";
-                    })
+                          type = functionTo policy.config.resource-type;
-                  ];
+                        };
+                      })
+                    ];
+                  };
                 };
               };
-            };
+            }
-          }
+          )
-        )
+        ];
-      );
+      });
     };
     applications = mkOption {
       description = "Collection of Fediversity applications";
-      type = attrsOf (
+      type = attrsOf (submoduleWith {
-        submodule (application: {
+        class = "fediversity-application";
-          _class = "fediversity-application";
+        modules = [
-          options = {
+          (application: {
-            description = mkOption {
+            _class = "fediversity-application";
-              description = "Description to be shown in the application overview";
+            options = {
-              type = types.str;
+              description = mkOption {
-            };
+                description = "Description to be shown in the application overview";
-            module = mkOption {
+                type = types.str;
-              description = "Operator-facing configuration options for the application";
+              };
-              type = deferredModuleWith { staticModules = [ { _class = "fediversity-application-config"; } ]; };
+              module = mkOption {
-            };
+                description = "Operator-facing configuration options for the application";
-            implementation = mkOption {
+                type = deferredModuleWith { staticModules = [ { _class = "fediversity-application-config"; } ]; };
-              description = "Mapping of application configuration to deployment resources, a description of what an application needs to run";
+              };
-              type = application.config.config-mapping.function-type;
+              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 = "Compute resources required by an application";
+              };
-              type = functionTo application.config.config-mapping.output-type;
+              resources = mkOption {
-              readOnly = true;
+                description = "Compute resources required by an application";
-              default = input: (application.config.implementation input).output;
+                type = functionTo application.config.config-mapping.output-type;
-            };
+                readOnly = true;
-            # TODO(@fricklerhandwerk): this needs a better name, it's just the type
+                default = input: (application.config.implementation input).output;
-            config-mapping = mkOption {
+              };
-              description = "Function type for the mapping from application configuration to required resources";
+              # TODO(@fricklerhandwerk): this needs a better name, it's just the type
-              type = submodule functionType;
+              config-mapping = mkOption {
-              readOnly = true;
+                description = "Function type for the mapping from application configuration to required resources";
-              default = {
+                type = submoduleWith {
-                input-type = submodule application.config.module;
+                  class = "module-function";
-                output-type = application-resources;
+                  modules = [ functionType ];
+                };
+                readOnly = true;
+                default = {
+                  input-type = submodule application.config.module;
+                  output-type = application-resources;
+                };
               };
             };
-          };
+          })
-        })
+        ];
-      );
+      });
     };
     environments = mkOption {
       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
+                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 = environment.config.resource-mapping.function-type;
+              };
+              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 = application-resources;
+                  output-type = nixops4Deployment;
+                };
+              };
+              # TODO(@fricklerhandwerk): maybe this should be a separate thing such as `fediversity-setup`,
+              # which makes explicit which applications and environments are available.
+              # then the deployments can simply be the result of the function application baked into this module.
+              deployment = mkOption {
+                description = "Generate a deployment from a configuration, by applying an environment's resource policies to the applications' resource mappings";
+                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;
 
-                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: mkOption { type = submodule 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;
               };
             };
-            # TODO(@fricklerhandwerk): maybe this should be a separate thing such as `fediversity-setup`,
+          })
-            # which makes explicit which applications and environments are available.
+        ];
-            # then the deployments can simply be the result of the function application baked into this module.
+      });
-            deployment = mkOption {
-              description = "Generate a deployment from a configuration, by applying an environment's resource policies to the applications' resource mappings";
-              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";
@@ -189,7 +213,10 @@ in
             _name: application:
             mkOption {
               description = application.description;
-              type = submodule application.module;
+              type = submoduleWith {
+                class = "fediversity-application-config";
+                modules = [ application.module ];
+              };
               default = { };
             }
           ) config.applications;