openstackclient: add module (#4530)

Co-authored-by: Sumner Evans <me@sumnerevans.com>

modules/lib/maintainers.nix

@@ -420,6 +420,11 @@
     keys =
       [{ fingerprint = "75F0 AB7C FE01 D077 AEE6  CAFD 353E 4A18 EE0F AB72"; }];
   };
+  tensor5 = {
+    github = "tensor5";
+    githubId = 1545895;
+    name = "Nicola Squartini";
+  };
   toastal = {
     email = "toastal+nix@posteo.net";
     matrix = "@toastal:matrix.org";

modules/misc/news.nix

@@ -1274,6 +1274,13 @@ in
         '';
       }
 
+      {
+        time = "2023-10-04T18:35:42+00:00";
+        message = ''
+          A new module is available: 'programs.openstackclient'.
+        '';
+      }
+
       {
         time = "2023-10-17T06:33:24+00:00";
         condition = hostPlatform.isLinux;

modules/modules.nix

@@ -165,6 +165,7 @@ let
     ./programs/offlineimap.nix
     ./programs/oh-my-posh.nix
     ./programs/opam.nix
+    ./programs/openstackclient.nix
     ./programs/pandoc.nix
     ./programs/papis.nix
     ./programs/password-store.nix

modules/programs/openstackclient.nix

@@ -0,0 +1,73 @@
+{ config, lib, pkgs, ... }:
+
+let
+  cfg = config.programs.openstackclient;
+  yamlFormat = pkgs.formats.yaml { };
+in {
+  meta.maintainers = [ lib.hm.maintainers.tensor5 ];
+
+  options.programs.openstackclient = {
+    enable = lib.mkEnableOption "OpenStack command-line client";
+
+    package = lib.mkPackageOption pkgs "openstackclient" { };
+
+    clouds = lib.mkOption {
+      type = lib.types.submodule { freeformType = yamlFormat.type; };
+      default = { };
+      example = lib.literalExpression ''
+        {
+          my-infra = {
+            cloud = "example-cloud";
+            auth = {
+              project_id = "0123456789abcdef0123456789abcdef";
+              username = "openstack";
+            };
+            region_name = "XXX";
+            interface = "internal";
+          };
+        }
+      '';
+      description = ''
+        Configuration needed to connect to one or more clouds.
+
+        Do not include passwords here as they will be publicly readable in the Nix store.
+        Configuration written to {file}`$XDG_CONFIG_HOME/openstack/clouds.yaml`.
+        See <https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#clouds-yaml>.
+      '';
+    };
+
+    publicClouds = lib.mkOption {
+      type = lib.types.submodule { freeformType = yamlFormat.type; };
+      default = { };
+      example = lib.literalExpression ''
+        {
+          example-cloud = {
+            auth = {
+              auth_url = "https://identity.cloud.example.com/v2.0";
+            };
+          };
+        };
+      '';
+      description = ''
+        Public information about clouds.
+
+        Configuration written to {file}`$XDG_CONFIG_HOME/openstack/clouds-public.yaml`.
+        See <https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#clouds-public-yaml>.
+      '';
+    };
+  };
+
+  config = lib.mkIf cfg.enable {
+    home.packages = [ cfg.package ];
+
+    xdg.configFile."openstack/clouds.yaml".source = yamlFormat.generate
+      "openstackclient-clouds-yaml-${config.home.username}" {
+        clouds = cfg.clouds;
+      };
+
+    xdg.configFile."openstack/clouds-public.yaml".source = yamlFormat.generate
+      "openstackclient-clouds-public-yaml-${config.home.username}" {
+        public-clouds = cfg.publicClouds;
+      };
+  };
+}

tests/default.nix

@@ -118,6 +118,7 @@ import nmt {
     ./modules/programs/nnn
     ./modules/programs/nushell
     ./modules/programs/oh-my-posh
+    ./modules/programs/openstackclient
     ./modules/programs/pandoc
     ./modules/programs/papis
     ./modules/programs/pet

tests/modules/programs/openstackclient/clouds-public.yaml

@@ -0,0 +1,4 @@
+public-clouds:
+  example-cloud:
+    auth:
+      auth_url: https://identity.cloud.example.com/v2.0

tests/modules/programs/openstackclient/clouds.yaml

@@ -0,0 +1,8 @@
+clouds:
+  my-infra:
+    auth:
+      project_id: 0123456789abcdef0123456789abcdef
+      username: openstack
+    cloud: example-cloud
+    interface: internal
+    region_name: XXX

tests/modules/programs/openstackclient/default.nix

@@ -0,0 +1 @@
+{ openstackclient = ./openstackclient.nix; }

tests/modules/programs/openstackclient/openstackclient.nix

@@ -0,0 +1,35 @@
+{ ... }:
+
+{
+  programs.openstackclient = {
+    enable = true;
+    clouds = {
+      my-infra = {
+        cloud = "example-cloud";
+        auth = {
+          project_id = "0123456789abcdef0123456789abcdef";
+          username = "openstack";
+        };
+        region_name = "XXX";
+        interface = "internal";
+      };
+    };
+    publicClouds = {
+      example-cloud = {
+        auth = { auth_url = "https://identity.cloud.example.com/v2.0"; };
+      };
+    };
+
+  };
+
+  test.stubs.openstackclient = { };
+
+  nmt.script = ''
+    assertFileExists home-files/.config/openstack/clouds.yaml
+    assertFileContent home-files/.config/openstack/clouds.yaml \
+      ${./clouds.yaml}
+    assertFileExists home-files/.config/openstack/clouds-public.yaml
+    assertFileContent home-files/.config/openstack/clouds-public.yaml \
+      ${./clouds-public.yaml}
+  '';
+}