workbench | profiles: simplify jq profile definition

Author: deepfire

nix/workbench/profile.sh

@@ -30,13 +30,13 @@ case "$op" in
 
     all-profiles | generate-all | all )
         with_era_profiles '
-          map (profiles(.; null; null; []))
+          map (generate_all_era_profiles(.; null; null))
           | add
         ';;
 
     all-profile-names | names | all-names )
         with_era_profiles '
-          map (profile_names(.; null; null; []))
+          map (generate_all_era_profiles(.; null; null) | map(.name))
           | add
         ';;
 
@@ -45,7 +45,9 @@ case "$op" in
         local name=${1:?$usage}
 
         with_era_profiles '
-          map (has_profile(.; null; null; []; $name))
+          map (generate_all_era_profiles(.; null; null)
+               | map (.name == $name)
+               | any)
           | any
         ' --exit-status --arg name "$name" >/dev/null
         ;;

nix/workbench/profiles/adhoc.jq

@@ -470,4 +470,24 @@ def all_profile_variants:
   , $scenario_chainsync * $chaindb_early_alonzo * $p2p *
     { name: "chainsync-early-alonzo-p2p"
     }
+
+  ## Last, but not least, the profile used by "nix-shell -A devops":
+  , { name: "devops"
+    , scenario:               "idle"
+    , genesis:
+      { slot_duration:         0.2
+      , parameter_k:           10
+      , epoch_length:          1000
+      , active_slots_coeff:    0.1
+      , genesis_future_offset: "10 seconds"
+      , utxo:                  0
+
+      , shelley:
+        { updateQuorum:        1
+        }
+      }
+    , analysis:
+      { type:                  null
+      }
+    }
   ];

nix/workbench/profiles/defaults.jq renamed to nix/workbench/profiles/prof0-defaults.jq

@@ -1,4 +1,4 @@
-include "defaults";
+include "prof0-defaults";
 include "genesis";
 include "lib";
 

nix/workbench/profiles/variants.jq renamed to nix/workbench/profiles/prof1-variants.jq

@@ -17,8 +17,8 @@
 ##  - era-dependent defaults for the aforementioned sections:
 ##    - profiles/defaults.jq
 ##
-##  - overlaid with generated profile variants + ad-hoc profiles:
-##    - profiles/variants.jq and profiles/adhoc.jq
+##  - overlaid with generated profile variants (including adhoc profiles):
+##    - profiles/variants.jq
 ##
 ##  - each then further overlaid with derived parameters, computed from the above:
 ##    - profiles/derived.jq
@@ -58,39 +58,54 @@
 ## ..which simply calls ./profiles.nix with {} params.
 ##
 
-include "topology";
-include "defaults";
-include "adhoc";
-include "variants";
-include "derived";
+include "prof0-defaults";
+include "prof1-variants";
+include "prof2-derived";
 
-def compute_profiles($era; $mcompo; $topo; $extra_profiles):
+##
+## This is the workbench's entry point for everything profile.
+##
+##  generate_all_era_profiles :: Era -> Maybe Composition -> Topology -> Map Name Profile
+##
+def generate_all_era_profiles($era; $mcompo; $topo):
     ($mcompo // topology_composition($topo // {}) // {}) as $compo
 
-  ## Profiles are variants + custom (or aux) profiles:
-  | all_profile_variants + adhoc_profiles + $extra_profiles
-  | map (## Each profile extends defaults:
+  | all_profile_variants
+  | map (## Each profile is defined as extension of defaults:
          era_defaults($era) * .
 
-         ## Profiles can define their own cluster composition.
+         ## Profiles define their own cluster composition:
          | . * { composition: (.composition // $compo) }
 
-         ## Compute the derived params.
+         ## Finally, compute the derived ("computed") params.
          | add_derived_params
         );
-
-def profiles($era; $mcompo; $topo; $extra_profiles):
-  compute_profiles($era; $mcompo; $topo; $extra_profiles)
   | map (## Assemble into a dictionary..
            { "\(.name)": .
            })
   | add;
 
-def profile_names($era; $mcompo; $topo; $extra_profiles):
-  compute_profiles($era; $mcompo; $topo; $extra_profiles)
-  | map (.name);
 
-def has_profile($era; $mcompo; $topo; $extra_profiles; $name):
-  compute_profiles($era; $mcompo; $topo; $extra_profiles)
-  | map (.name == $name)
-  | any;
+## Cluster composition is an extract from the topology,
+## that classifies nodes into BFT, regular pools and dense pools,
+## based on the 'pools' field.
+##
+## Testable with:
+##
+##   jq -n 'include "composition" { search: "nix/workbench/profiles" }; topology_composition({ coreNodes: { bft1: { pools: 0 } } })'
+##
+def topology_composition($topo):
+    $topo
+  | (.Producers // .coreNodes // {})
+  | to_entries
+  | map (.value.pools // 0)
+  | length                           as $n_hosts
+  | map (select (. == 0))            as $bfts
+  | map (select (. != 0))            as $pools
+  | ($pools | map (select (. == 1))) as $singular_pools
+  | ($pools | map (select (.  > 1))) as $dense_pools
+  | ($singular_pools | length)       as $n_singular_hosts
+  | { n_bft_hosts:      ($bfts           | length)
+    , n_singular_hosts: ($singular_pools | length)
+    , n_dense_hosts:    ($dense_pools    | length)
+    };