commit 70073985ae856f777639a4742943f48b317d7799 · pyrox.dev/nixpkgs

nixos/doc/manual/release-notes/rl-2305.section.md

···

       34
       34
        
       

     

       35
       35
        
       - [fzf](https://github.com/junegunn/fzf), a command line fuzzyfinder. Available as [programs.fzf](#opt-programs.fzf.fuzzyCompletion).

     

       36
       36
        
       

     

       37
       37
       +
       - [gemstash](https://github.com/rubygems/gemstash), a RubyGems.org cache and private gem server. Available as [services.gemstash](#opt-services.gemstash.enable).

     

       38
       38
       +
       

     

       37
       39
        
       - [gmediarender](https://github.com/hzeller/gmrender-resurrect), a simple, headless UPnP/DLNA renderer.  Available as [services.gmediarender](options.html#opt-services.gmediarender.enable).

     

       38
       40
        
       

     

       39
       41
        
       - [stevenblack-blocklist](https://github.com/StevenBlack/hosts), A unified hosts file with base extensions for blocking unwanted websites. Available as [networking.stevenblack](options.html#opt-networking.stevenblack.enable).

nixos/modules/module-list.nix

···

       439
       439
        
         ./services/development/blackfire.nix

     

       440
       440
        
         ./services/development/bloop.nix

     

       441
       441
        
         ./services/development/distccd.nix

     

       442
       442
       +
         ./services/development/gemstash.nix

     

       442
       443
        
         ./services/development/hoogle.nix

     

       443
       444
        
         ./services/development/jupyter/default.nix

     

       444
       445
        
         ./services/development/jupyterhub/default.nix

+103

nixos/modules/services/development/gemstash.nix

···

       1
       1
       +
       { lib, pkgs, config, ... }:

     

       2
       2
       +
       with lib;

     

       3
       3
       +
       

     

       4
       4
       +
       let

     

       5
       5
       +
         settingsFormat = pkgs.formats.yaml { };

     

       6
       6
       +
       

     

       7
       7
       +
         # gemstash uses a yaml config where the keys are ruby symbols,

     

       8
       8
       +
         # which means they start with ':'. This would be annoying to use

     

       9
       9
       +
         # on the nix side, so we rewrite plain names instead.

     

       10
       10
       +
         prefixColon = s: listToAttrs (map

     

       11
       11
       +
           (attrName: {

     

       12
       12
       +
             name = ":${attrName}";

     

       13
       13
       +
             value =

     

       14
       14
       +
               if isAttrs s.${attrName}

     

       15
       15
       +
               then prefixColon s."${attrName}"

     

       16
       16
       +
               else s."${attrName}";

     

       17
       17
       +
           })

     

       18
       18
       +
           (attrNames s));

     

       19
       19
       +
       

     

       20
       20
       +
         # parse the port number out of the tcp://ip:port bind setting string

     

       21
       21
       +
         parseBindPort = bind: strings.toInt (last (strings.splitString ":" bind));

     

       22
       22
       +
       

     

       23
       23
       +
         cfg = config.services.gemstash;

     

       24
       24
       +
       in

     

       25
       25
       +
       {

     

       26
       26
       +
         options.services.gemstash = {

     

       27
       27
       +
           enable = mkEnableOption (lib.mdDoc "gemstash service");

     

       28
       28
       +
       

     

       29
       29
       +
           openFirewall = mkOption {

     

       30
       30
       +
             type = types.bool;

     

       31
       31
       +
             default = false;

     

       32
       32
       +
             description = lib.mdDoc ''

     

       33
       33
       +
               Whether to open the firewall for the port in {option}`services.gemstash.bind`.

     

       34
       34
       +
             '';

     

       35
       35
       +
           };

     

       36
       36
       +
       

     

       37
       37
       +
           settings = mkOption {

     

       38
       38
       +
             default = {};

     

       39
       39
       +
             description = lib.mdDoc ''

     

       40
       40
       +
               Configuration for Gemstash. The details can be found at in

     

       41
       41
       +
               [gemstash documentation](https://github.com/rubygems/gemstash/blob/master/man/gemstash-configuration.5.md).

     

       42
       42
       +
               Each key set here is automatically prefixed with ":" to match the gemstash expectations.

     

       43
       43
       +
             '';

     

       44
       44
       +
             type = types.submodule {

     

       45
       45
       +
               freeformType = settingsFormat.type;

     

       46
       46
       +
               options = {

     

       47
       47
       +
                 base_path = mkOption {

     

       48
       48
       +
                   type = types.path;

     

       49
       49
       +
                   default = "/var/lib/gemstash";

     

       50
       50
       +
                   description = lib.mdDoc "Path to store the gem files and the sqlite database. If left unchanged, the directory will be created.";

     

       51
       51
       +
                 };

     

       52
       52
       +
                 bind = mkOption {

     

       53
       53
       +
                   type = types.str;

     

       54
       54
       +
                   default = "tcp://0.0.0.0:9292";

     

       55
       55
       +
                   description = lib.mdDoc "Host and port combination for the server to listen on.";

     

       56
       56
       +
                 };

     

       57
       57
       +
                 db_adapter = mkOption {

     

       58
       58
       +
                   type = types.nullOr (types.enum [ "sqlite3" "postgres" "mysql" "mysql2" ]);

     

       59
       59
       +
                   default = null;

     

       60
       60
       +
                   description = lib.mdDoc "Which database type to use. For choices other than sqlite3, the dbUrl has to be specified as well.";

     

       61
       61
       +
                 };

     

       62
       62
       +
                 db_url = mkOption {

     

       63
       63
       +
                   type = types.nullOr types.str;

     

       64
       64
       +
                   default = null;

     

       65
       65
       +
                   description = lib.mdDoc "The database to connect to when using postgres, mysql, or mysql2.";

     

       66
       66
       +
                 };

     

       67
       67
       +
               };

     

       68
       68
       +
             };

     

       69
       69
       +
           };

     

       70
       70
       +
         };

     

       71
       71
       +
       

     

       72
       72
       +
         config =

     

       73
       73
       +
           mkIf cfg.enable {

     

       74
       74
       +
             users = {

     

       75
       75
       +
               users.gemstash = {

     

       76
       76
       +
                 group = "gemstash";

     

       77
       77
       +
                 isSystemUser = true;

     

       78
       78
       +
               };

     

       79
       79
       +
               groups.gemstash = { };

     

       80
       80
       +
             };

     

       81
       81
       +
       

     

       82
       82
       +
             networking.firewall.allowedTCPPorts = mkIf cfg.openFirewall [ (parseBindPort cfg.settings.bind) ];

     

       83
       83
       +
       

     

       84
       84
       +
             systemd.services.gemstash = {

     

       85
       85
       +
               wantedBy = [ "multi-user.target" ];

     

       86
       86
       +
               after = [ "network.target" ];

     

       87
       87
       +
               serviceConfig = mkMerge [

     

       88
       88
       +
                 {

     

       89
       89
       +
                   ExecStart = "${pkgs.gemstash}/bin/gemstash start --no-daemonize --config-file ${settingsFormat.generate "gemstash.yaml" (prefixColon cfg.settings)}";

     

       90
       90
       +
                   NoNewPrivileges = true;

     

       91
       91
       +
                   User = "gemstash";

     

       92
       92
       +
                   Group = "gemstash";

     

       93
       93
       +
                   PrivateTmp = true;

     

       94
       94
       +
                   RestrictSUIDSGID = true;

     

       95
       95
       +
                   LockPersonality = true;

     

       96
       96
       +
                 }

     

       97
       97
       +
                 (mkIf (cfg.settings.base_path == "/var/lib/gemstash") {

     

       98
       98
       +
                   StateDirectory = "gemstash";

     

       99
       99
       +
                 })

     

       100
       100
       +
               ];

     

       101
       101
       +
             };

     

       102
       102
       +
           };

     

       103
       103
       +
       }

nixos/tests/all-tests.nix

···

       238
       238
        
         ft2-clone = handleTest ./ft2-clone.nix {};

     

       239
       239
        
         mimir = handleTest ./mimir.nix {};

     

       240
       240
        
         garage = handleTest ./garage {};

     

       241
       241
       +
         gemstash = handleTest ./gemstash.nix {};

     

       241
       242
        
         gerrit = handleTest ./gerrit.nix {};

     

       242
       243
        
         geth = handleTest ./geth.nix {};

     

       243
       244
        
         ghostunnel = handleTest ./ghostunnel.nix {};

+51

nixos/tests/gemstash.nix

···

       1
       1
       +
       { system ? builtins.currentSystem, config ? { }

     

       2
       2
       +
       , pkgs ? import ../.. { inherit system config; } }:

     

       3
       3
       +
       

     

       4
       4
       +
       with import ../lib/testing-python.nix { inherit system pkgs; };

     

       5
       5
       +
       with pkgs.lib;

     

       6
       6
       +
       

     

       7
       7
       +
       let common_meta = { maintainers = [ maintainers.viraptor ]; };

     

       8
       8
       +
       in

     

       9
       9
       +
       {

     

       10
       10
       +
         gemstash_works = makeTest {

     

       11
       11
       +
           name = "gemstash-works";

     

       12
       12
       +
           meta = common_meta;

     

       13
       13
       +
       

     

       14
       14
       +
           nodes.machine = { config, pkgs, ... }: {

     

       15
       15
       +
             services.gemstash = {

     

       16
       16
       +
               enable = true;

     

       17
       17
       +
             };

     

       18
       18
       +
           };

     

       19
       19
       +
       

     

       20
       20
       +
           # gemstash responds to http requests

     

       21
       21
       +
           testScript = ''

     

       22
       22
       +
             machine.wait_for_unit("gemstash.service")

     

       23
       23
       +
             machine.wait_for_file("/var/lib/gemstash")

     

       24
       24
       +
             machine.wait_for_open_port(9292)

     

       25
       25
       +
             machine.succeed("curl http://localhost:9292")

     

       26
       26
       +
           '';

     

       27
       27
       +
         };

     

       28
       28
       +
       

     

       29
       29
       +
         gemstash_custom_port = makeTest {

     

       30
       30
       +
           name = "gemstash-custom-port";

     

       31
       31
       +
           meta = common_meta;

     

       32
       32
       +
       

     

       33
       33
       +
           nodes.machine = { config, pkgs, ... }: {

     

       34
       34
       +
             services.gemstash = {

     

       35
       35
       +
               enable = true;

     

       36
       36
       +
               openFirewall = true;

     

       37
       37
       +
               settings = {

     

       38
       38
       +
                 bind = "tcp://0.0.0.0:12345";

     

       39
       39
       +
               };

     

       40
       40
       +
             };

     

       41
       41
       +
           };

     

       42
       42
       +
       

     

       43
       43
       +
           # gemstash responds to http requests

     

       44
       44
       +
           testScript = ''

     

       45
       45
       +
             machine.wait_for_unit("gemstash.service")

     

       46
       46
       +
             machine.wait_for_file("/var/lib/gemstash")

     

       47
       47
       +
             machine.wait_for_open_port(12345)

     

       48
       48
       +
             machine.succeed("curl http://localhost:12345")

     

       49
       49
       +
           '';

     

       50
       50
       +
         };

     

       51
       51
       +
       }

+5 -2

pkgs/development/tools/gemstash/default.nix

···

       1
       1
       -
       { lib, bundlerApp, bundlerUpdateScript }:

     

       1
       1
       +
       { lib, bundlerApp, bundlerUpdateScript, nixosTests }:

     

       2
       2
        
       

     

       3
       3
        
       bundlerApp rec {

     

       4
       4
        
         pname = "gemstash";

     

       5
       5
        
         gemdir = ./.;

     

       6
       6
        
         exes = [ pname ];

     

       7
       7
        
       

     

       8
       8
       -
         passthru.updateScript = bundlerUpdateScript pname;

     

       8
       8
       +
         passthru = {

     

       9
       9
       +
           updateScript = bundlerUpdateScript pname;

     

       10
       10
       +
           tests = { inherit (nixosTests) gemstash; };

     

       11
       11
       +
         };

     

       9
       12
        
       

     

       10
       13
        
         meta = with lib; {

     

       11
       14
        
           description = "A cache for RubyGems.org and a private gem server";