confctl 2.2.2 → 3.0.0

data/man/style.css

@@ -0,0 +1,301 @@
+@import url('https://maxcdn.bootstrapcdn.com/bootstrap/2.3.2/css/bootstrap.min.css');
+
+@media all {
+  h1,
+  h2,
+  h3,
+  h4,
+  h5,
+  h6 {
+    margin-top: 1em;
+  }
+
+  /* deactivate external manual page cross-references */
+  a.md2man-reference:not([href]) {
+    color: inherit;
+    text-decoration: none;
+  }
+}
+
+@media screen {
+  body {
+    font-family: monospace;
+    text-align: justify;
+    max-width: 83ch; /* 80 chars, +3 for Bootstrap CSS */
+    margin: auto;
+  }
+
+  h1:first-child {
+    margin-top: -5em;
+    font-weight: normal;
+    font-size: smaller;
+    text-align: center;
+  }
+
+  h1:first-child > span.md2man-source {
+    float: right;
+  }
+
+  h1:first-child > span.md2man-title,
+  h1:first-child > span.md2man-section,
+  h1:first-child > span.md2man-manual,
+  h1:first-child > a.md2man-permalink {
+    display: none;
+  }
+
+  a.md2man-permalink {
+    float: left;
+    margin-left: -1em;
+    opacity: 0.25;
+    font-size: xx-large;
+  }
+
+  a.md2man-permalink:before {
+    content: '\2605'; /* ★ */
+  }
+
+  a.md2man-permalink:hover,
+  *:target > a.md2man-permalink {
+    opacity: inherit;
+  }
+
+  *:target > a.md2man-permalink {
+    color: red;
+  }
+}
+
+@media print {
+  .navbar:first-child {
+    display: none;
+  }
+
+  /* improve readability of revealed hyperlink URLs */
+  a:after {
+    font-family: monospace;
+  }
+
+  /* internal links and manual page cross-references */
+  a[href^='#'], a[href^='../man'] {
+    color: inherit;
+    font-weight: bolder;
+    text-decoration: none;
+  }
+
+  /* undo bootstrap's revealing of those hyperlinks */
+  a[href^='#']:after, a[href^='../man']:after {
+    content: none;
+  }
+}
+.highlight table td { padding: 5px; }
+.highlight table pre { margin: 0; }
+.highlight .cm {
+  color: #999988;
+  font-style: italic;
+}
+.highlight .cp {
+  color: #999999;
+  font-weight: bold;
+}
+.highlight .c1 {
+  color: #999988;
+  font-style: italic;
+}
+.highlight .cs {
+  color: #999999;
+  font-weight: bold;
+  font-style: italic;
+}
+.highlight .c, .highlight .ch, .highlight .cd, .highlight .cpf {
+  color: #999988;
+  font-style: italic;
+}
+.highlight .err {
+  color: #a61717;
+  background-color: #e3d2d2;
+}
+.highlight .gd {
+  color: #000000;
+  background-color: #ffdddd;
+}
+.highlight .ge {
+  color: #000000;
+  font-style: italic;
+}
+.highlight .gr {
+  color: #aa0000;
+}
+.highlight .gh {
+  color: #999999;
+}
+.highlight .gi {
+  color: #000000;
+  background-color: #ddffdd;
+}
+.highlight .go {
+  color: #888888;
+}
+.highlight .gp {
+  color: #555555;
+}
+.highlight .gs {
+  font-weight: bold;
+}
+.highlight .gu {
+  color: #aaaaaa;
+}
+.highlight .gt {
+  color: #aa0000;
+}
+.highlight .kc {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .kd {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .kn {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .kp {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .kr {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .kt {
+  color: #445588;
+  font-weight: bold;
+}
+.highlight .k, .highlight .kv {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .mf {
+  color: #009999;
+}
+.highlight .mh {
+  color: #009999;
+}
+.highlight .il {
+  color: #009999;
+}
+.highlight .mi {
+  color: #009999;
+}
+.highlight .mo {
+  color: #009999;
+}
+.highlight .m, .highlight .mb, .highlight .mx {
+  color: #009999;
+}
+.highlight .sa {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .sb {
+  color: #d14;
+}
+.highlight .sc {
+  color: #d14;
+}
+.highlight .sd {
+  color: #d14;
+}
+.highlight .s2 {
+  color: #d14;
+}
+.highlight .se {
+  color: #d14;
+}
+.highlight .sh {
+  color: #d14;
+}
+.highlight .si {
+  color: #d14;
+}
+.highlight .sx {
+  color: #d14;
+}
+.highlight .sr {
+  color: #009926;
+}
+.highlight .s1 {
+  color: #d14;
+}
+.highlight .ss {
+  color: #990073;
+}
+.highlight .s, .highlight .dl {
+  color: #d14;
+}
+.highlight .na {
+  color: #008080;
+}
+.highlight .bp {
+  color: #999999;
+}
+.highlight .nb {
+  color: #0086B3;
+}
+.highlight .nc {
+  color: #445588;
+  font-weight: bold;
+}
+.highlight .no {
+  color: #008080;
+}
+.highlight .nd {
+  color: #3c5d5d;
+  font-weight: bold;
+}
+.highlight .ni {
+  color: #800080;
+}
+.highlight .ne {
+  color: #990000;
+  font-weight: bold;
+}
+.highlight .nf, .highlight .fm {
+  color: #990000;
+  font-weight: bold;
+}
+.highlight .nl {
+  color: #990000;
+  font-weight: bold;
+}
+.highlight .nn {
+  color: #555555;
+}
+.highlight .nt {
+  color: #000080;
+}
+.highlight .vc {
+  color: #008080;
+}
+.highlight .vg {
+  color: #008080;
+}
+.highlight .vi {
+  color: #008080;
+}
+.highlight .nv, .highlight .vm {
+  color: #008080;
+}
+.highlight .ow {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .o {
+  color: #000000;
+  font-weight: bold;
+}
+.highlight .w {
+  color: #bbbbbb;
+}
+.highlight {
+  background-color: #f8f8f8;
+}

data/nix/evaluator.nix

@@ -4,11 +4,7 @@ let
 
   hasCorePkgs = (builtins.hasAttr "coreSwpins" arg) && (builtins.hasAttr "nixpkgs" arg.coreSwpins);
 
-  nixpkgs =
-    if hasCorePkgs then
-      import arg.coreSwpins.nixpkgs {}
-    else
-      import <nixpkgs> {};
+  nixpkgs = if hasCorePkgs then import arg.coreSwpins.nixpkgs { } else import <nixpkgs> { };
 
   machines = import ./machines.nix {
     inherit (arg) confDir;
@@ -18,38 +14,46 @@ let
   nameValuePairs = builtins.map (m: {
     name = m.name;
     value = {
-      inherit (m) name alias clusterName carrier metaConfig;
+      inherit (m)
+        name
+        alias
+        clusterName
+        carrier
+        metaConfig
+        ;
     };
   }) machines;
 
   machinesAttrs = builtins.listToAttrs nameValuePairs;
 
-  fullMachinesAttrs = builtins.listToAttrs (builtins.map (m: {
-    name = m.name;
-    value = m;
-  }) machines);
+  fullMachinesAttrs = builtins.listToAttrs (
+    builtins.map (m: {
+      name = m.name;
+      value = m;
+    }) machines
+  );
 
-  coreSwpins =
-    import ./lib/swpins/eval.nix {
-      inherit (arg) confDir;
-      name = "core";
-      dir = "";
-      channels = evalConfctl.config.confctl.swpins.core.channels;
-      pkgs = nixpkgs.pkgs;
-      lib = nixpkgs.lib;
-    };
+  coreSwpins = import ./lib/swpins/eval.nix {
+    inherit (arg) confDir;
+    name = "core";
+    dir = "";
+    channels = evalConfctl.config.confctl.swpins.core.channels;
+    pkgs = nixpkgs.pkgs;
+    lib = nixpkgs.lib;
+  };
 
   corePkgs =
     if hasCorePkgs then
       nixpkgs
     else if builtins.hasAttr "nixpkgs" coreSwpins.evaluated then
-      import coreSwpins.evaluated.nixpkgs {}
+      import coreSwpins.evaluated.nixpkgs { }
     else
       abort "Core swpins not set, run `confctl swpins core update`";
 
   coreLib = corePkgs.lib;
 
-  machineSwpins = m:
+  machineSwpins =
+    m:
     import ./lib/swpins/eval.nix {
       inherit (arg) confDir;
       name = m.name;
@@ -60,17 +64,22 @@ let
 
   coreSwpinsAttrs = coreSwpins.evaluated;
 
-  selectedSwpinsAttrs = builtins.listToAttrs (builtins.map (host: {
-    name = host;
-    value = (machineSwpins fullMachinesAttrs.${host}).evaluated;
-  }) arg.machines);
-
-  selectedToplevels = builtins.listToAttrs (builtins.map (host: {
-    name = host;
-    value = buildToplevel fullMachinesAttrs.${host};
-  }) arg.machines);
-
-  buildToplevel = machine:
+  selectedSwpinsAttrs = builtins.listToAttrs (
+    builtins.map (host: {
+      name = host;
+      value = (machineSwpins fullMachinesAttrs.${host}).evaluated;
+    }) arg.machines
+  );
+
+  selectedToplevels = builtins.listToAttrs (
+    builtins.map (host: {
+      name = host;
+      value = buildToplevel fullMachinesAttrs.${host};
+    }) arg.machines
+  );
+
+  buildToplevel =
+    machine:
     let
       machineConfig = (evalMachine machine).config;
 
@@ -81,7 +90,8 @@ let
           abort "Attribute 'config.${coreLib.concatStringsSep "." machine.build.attribute}' not found on machine ${machine.name}"
         else
           buildAttr;
-    in {
+    in
+    {
       attribute = result;
 
       autoRollback =
@@ -97,18 +107,22 @@ let
             ruby = nixpkgs.ruby;
           };
         in
-          if builtins.hasAttr "replaceVarsWith" corePkgs then
-            corePkgs.replaceVarsWith {
+        if builtins.hasAttr "replaceVarsWith" corePkgs then
+          corePkgs.replaceVarsWith {
+            inherit (args) src isExecutable;
+            inherit replacements;
+          }
+        else
+          corePkgs.substituteAll (
+            {
               inherit (args) src isExecutable;
-              inherit replacements;
             }
-          else
-            corePkgs.substituteAll ({
-              inherit (args) src isExecutable;
-            } // replacements);
+            // replacements
+          );
     };
 
-  evalMachine = machine:
+  evalMachine =
+    machine:
     let
       importPath = {
         nixos = <nixpkgs/nixos/lib/eval-config.nix>;
@@ -118,64 +132,74 @@ let
       evalConfig = import importPath.${machine.metaConfig.spin} {
         modules = machine.extraModules ++ [ machine.build.toplevel ];
       };
-    in evalConfig;
+    in
+    evalConfig;
 
   evalConfctl =
     let
       cfg = "${toString arg.confDir}/configs/confctl.nix";
-    in evalNixosModules ([
-      ./modules/confctl/generations.nix
-      ./modules/confctl/cli.nix
-      ./modules/confctl/nix.nix
-      ./modules/confctl/swpins.nix
-      "${toString arg.confDir}/configs/swpins.nix"
-    ] ++ nixpkgs.lib.optional (builtins.pathExists cfg) cfg);
+    in
+    evalNixosModules (
+      [
+        ./modules/confctl/generations.nix
+        ./modules/confctl/cli.nix
+        ./modules/confctl/nix.nix
+        ./modules/confctl/swpins.nix
+        "${toString arg.confDir}/configs/swpins.nix"
+      ]
+      ++ nixpkgs.lib.optional (builtins.pathExists cfg) cfg
+    );
 
   docToplevels = [
     "cluster."
     "confctl."
   ];
 
-  filterOption = o:
-    !o.internal && builtins.any (top: nixpkgs.lib.hasPrefix top o.name) docToplevels;
+  filterOption = o: !o.internal && builtins.any (top: nixpkgs.lib.hasPrefix top o.name) docToplevels;
 
   docModules =
     let
       userModules = "${toString arg.confDir}/modules/cluster/default.nix";
-    in evalNixosModules (
+    in
+    evalNixosModules (
       (import ./modules/module-list.nix).all
-      ++
-      (nixpkgs.lib.optional (builtins.pathExists userModules) userModules)
+      ++ (nixpkgs.lib.optional (builtins.pathExists userModules) userModules)
     );
 
-  docOptions =
-    builtins.filter filterOption (nixpkgs.lib.optionAttrSetToDocList docModules.options);
+  docOptions = builtins.filter filterOption (nixpkgs.lib.optionAttrSetToDocList docModules.options);
 
-  evalNixosModules = modules:
+  evalNixosModules =
+    modules:
     import <nixpkgs/nixos/lib/eval-config.nix> {
       modules = modules ++ [
-        ({ ... }:
-        {
-          _module.args = {
-            confLib = import ./lib {
-              confDir = "${toString arg.confDir}";
-              coreLib = nixpkgs.lib;
-              corePkgs = nixpkgs.pkgs;
+        (
+          { ... }:
+          {
+            _module.args = {
+              confLib = import ./lib {
+                confDir = "${toString arg.confDir}";
+                coreLib = nixpkgs.lib;
+                corePkgs = nixpkgs.pkgs;
+              };
             };
-          };
-        })
+          }
+        )
       ];
     };
 
   build = {
     # confctl settings
-    confctl = nixpkgs.writeText "confctl-settings.json" (builtins.toJSON { confctl = evalConfctl.config.confctl; });
+    confctl = nixpkgs.writeText "confctl-settings.json" (
+      builtins.toJSON { confctl = evalConfctl.config.confctl; }
+    );
 
     # List available nixos module options for documentation purposes
     moduleOptions = docOptions;
 
     # List of machines
-    list = { machines = builtins.map (m: m.name) machines; };
+    list = {
+      machines = builtins.map (m: m.name) machines;
+    };
 
     # List of machines in an attrset: host => config
     info = corePkgs.writeText "machine-list.json" (builtins.toJSON machinesAttrs);
@@ -193,4 +217,5 @@ let
     # be run with proper NIX_PATH with swpins
     toplevel = corePkgs.writeText "toplevels.json" (builtins.toJSON selectedToplevels);
   };
-in build.${arg.build}
+in
+build.${arg.build}

data/nix/flake/mk-confctl-devshell.nix

@@ -0,0 +1,85 @@
+{ nixpkgs }:
+
+{
+  system,
+  pkgs ? nixpkgs.legacyPackages.${system},
+  extraPackages ? [ ],
+}:
+let
+  ruby = if pkgs ? ruby_3_4 then pkgs.ruby_3_4 else pkgs.ruby;
+in
+pkgs.mkShell {
+  packages = [
+    pkgs.git
+    pkgs.ncurses
+    pkgs.openssl
+    ruby
+    pkgs.man-db
+    pkgs.groff
+    pkgs.less
+    pkgs.nix-prefetch-git
+    pkgs.nixfmt
+    pkgs.nixfmt-tree
+  ]
+  ++ extraPackages;
+
+  shellHook = ''
+    export CONFCTL="$PWD"
+    export GEM_ROOT="$PWD/.gems"
+    export GEM_HOME="$GEM_ROOT/ruby/$(ruby -e 'require "rbconfig"; print RbConfig::CONFIG["ruby_version"]')"
+    export GEM_PATH="$GEM_HOME"
+    export BUNDLE_PATH="$GEM_ROOT"
+    export BUNDLE_APP_CONFIG="$PWD/.bundle"
+    export RUBOCOP_CACHE_ROOT="$PWD/.rubocop_cache"
+
+    mkdir -p "$GEM_ROOT" "$GEM_HOME" "$PWD/.bin"
+    rm -f "$PWD/.bin/bundle" "$PWD/.bin/bundler"
+
+    export PATH="$PWD/.bin:$GEM_HOME/bin:$PATH"
+    export RUBYLIB="$CONFCTL/lib"
+    export MANPATH="$CONFCTL/man:$(man --path)"
+
+    bundler_version=""
+    if [ -f "$CONFCTL/Gemfile.lock" ]; then
+      bundler_version="$(awk '/^BUNDLED WITH$/{getline; sub(/^[[:space:]]+/, "", $0); print; exit}' "$CONFCTL/Gemfile.lock")"
+    fi
+
+    if [ -n "$bundler_version" ]; then
+      export BUNDLER_VERSION="$bundler_version"
+      if [ ! -x "$GEM_HOME/bin/bundle" ] \
+         || ! gem list -i bundler -v "$bundler_version" >/dev/null 2>&1; then
+        gem install --no-document bundler -v "$bundler_version" >/dev/null
+      fi
+    elif [ ! -x "$GEM_HOME/bin/bundle" ]; then
+      gem install --no-document bundler >/dev/null
+    fi
+    bundle_bin="$GEM_HOME/bin/bundle"
+
+    pushd "$CONFCTL" >/dev/null
+
+    "$bundle_bin" config set --local path "$BUNDLE_PATH" >/dev/null
+    "$bundle_bin" config set --local bin "$PWD/.bin" >/dev/null
+
+    # Purity disabled because of prism gem, which has a native extension.
+    NIX_ENFORCE_PURITY=0 "$bundle_bin" install >/dev/null
+
+    if "$bundle_bin" info rubocop >/dev/null 2>&1; then
+      "$bundle_bin" binstubs rubocop --force >/dev/null
+    fi
+
+    popd >/dev/null
+
+    cat > "$PWD/.bin/confctl" <<EOF
+    #!/usr/bin/env bash
+    export BUNDLE_GEMFILE="$CONFCTL/Gemfile"
+    bundle_bin="$GEM_HOME/bin/bundle"
+    exec "$bundle_bin" exec confctl "$@"
+    EOF
+    chmod +x "$PWD/.bin/confctl"
+
+    export PS1="(confctl) $PS1"
+
+    echo
+    echo "confctl development shell ready"
+  '';
+}