commit 491e332feb1b968af7f67f890577c99a7e0d46bc · pyrox.dev/nixpkgs

+81 -19

nixos/modules/services/home-automation/home-assistant.nix

···

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

     

       2
       2
       -
       

     

       3
       3
       -
       with lib;

     

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

     

       4
       2
        
       

     

       5
       3
        
       let

     

       4
       4
       +
         inherit (lib)

     

       5
       5
       +
           any

     

       6
       6
       +
           attrByPath

     

       7
       7
       +
           attrValues

     

       8
       8
       +
           concatMap

     

       9
       9
       +
           converge

     

       10
       10
       +
           elem

     

       11
       11
       +
           escapeShellArg

     

       12
       12
       +
           escapeShellArgs

     

       13
       13
       +
           filter

     

       14
       14
       +
           filterAttrsRecursive

     

       15
       15
       +
           hasAttrByPath

     

       16
       16
       +
           isAttrs

     

       17
       17
       +
           isDerivation

     

       18
       18
       +
           isList

     

       19
       19
       +
           literalExpression

     

       20
       20
       +
           mkEnableOption

     

       21
       21
       +
           mkIf

     

       22
       22
       +
           mkMerge

     

       23
       23
       +
           mkOption

     

       24
       24
       +
           mkRemovedOptionModule

     

       25
       25
       +
           mkRenamedOptionModule

     

       26
       26
       +
           optionals

     

       27
       27
       +
           optionalString

     

       28
       28
       +
           recursiveUpdate

     

       29
       29
       +
           singleton

     

       30
       30
       +
           splitString

     

       31
       31
       +
           types

     

       32
       32
       +
           unique

     

       33
       33
       +
         ;

     

       34
       34
       +
       

     

       35
       35
       +
         inherit (utils)

     

       36
       36
       +
           escapeSystemdExecArgs

     

       37
       37
       +
         ;

     

       38
       38
       +
       

     

       6
       39
        
         cfg = config.services.home-assistant;

     

       7
       40
        
         format = pkgs.formats.yaml {};

     

       8
       41
        
       

     
···

       17
       50
        
       

     

       18
       51
        
         # Filter null values from the configuration, so that we can still advertise

     

       19
       52
        
         # optional options in the config attribute.

     

       20
       20
       -
         filteredConfig = lib.converge (lib.filterAttrsRecursive (_: v: ! elem v [ null ])) (lib.recursiveUpdate customLovelaceModulesResources (cfg.config or {}));

     

       53
       53
       +
         filteredConfig = converge (filterAttrsRecursive (_: v: ! elem v [ null ])) (recursiveUpdate customLovelaceModulesResources (cfg.config or {}));

     

       21
       54
        
         configFile = renderYAMLFile "configuration.yaml" filteredConfig;

     

       22
       55
        
       

     

       23
       56
        
         lovelaceConfigFile = renderYAMLFile "ui-lovelace.yaml" cfg.lovelaceConfig;

     
···

       42
       75
        
           if isDerivation config then

     

       43
       76
        
             [ ]

     

       44
       77
        
           else if isAttrs config then

     

       45
       45
       -
             optional (config ? platform) config.platform

     

       78
       78
       +
             optionals (config ? platform) [ config.platform ]

     

       46
       79
        
             ++ concatMap usedPlatforms (attrValues config)

     

       47
       80
        
           else if isList config then

     

       48
       81
        
             concatMap usedPlatforms config

     
···

       67
       100
        
           extraComponents = oldArgs.extraComponents or [] ++ extraComponents;

     

       68
       101
        
           extraPackages = ps: (oldArgs.extraPackages or (_: []) ps)

     

       69
       102
        
             ++ (cfg.extraPackages ps)

     

       70
       70
       -
             ++ (lib.concatMap (component: component.propagatedBuildInputs or []) cfg.customComponents);

     

       103
       103
       +
             ++ (concatMap (component: component.propagatedBuildInputs or []) cfg.customComponents);

     

       71
       104
        
         }));

     

       72
       105
        
       

     

       73
       106
        
         # Create a directory that holds all lovelace modules

     
···

       93
       126
        
       

     

       94
       127
        
         meta = {

     

       95
       128
        
           buildDocsInSandbox = false;

     

       96
       96
       -
           maintainers = teams.home-assistant.members;

     

       129
       129
       +
           maintainers = lib.teams.home-assistant.members;

     

       97
       130
        
         };

     

       98
       131
        
       

     

       99
       132
        
         options.services.home-assistant = {

     

       100
       133
        
           # Running home-assistant on NixOS is considered an installation method that is unsupported by the upstream project.

     

       101
       134
        
           # https://github.com/home-assistant/architecture/blob/master/adr/0012-define-supported-installation-method.md#decision

     

       102
       135
        
           enable = mkEnableOption "Home Assistant. Please note that this installation method is unsupported upstream";

     

       136
       136
       +
       

     

       137
       137
       +
           extraArgs = mkOption {

     

       138
       138
       +
             type = types.listOf types.str;

     

       139
       139
       +
             default = [ ];

     

       140
       140
       +
             example = [ "--debug" ];

     

       141
       141
       +
             description = ''

     

       142
       142
       +
               Extra arguments to pass to the hass executable.

     

       143
       143
       +
             '';

     

       144
       144
       +
           };

     

       103
       145
        
       

     

       104
       146
        
           configDir = mkOption {

     

       105
       147
        
             default = "/var/lib/hass";

     
···

       471
       513
        
           networking.firewall.allowedTCPPorts = mkIf cfg.openFirewall [ cfg.config.http.server_port ];

     

       472
       514
        
       

     

       473
       515
        
           # symlink the configuration to /etc/home-assistant

     

       474
       474
       -
           environment.etc = lib.mkMerge [

     

       475
       475
       -
             (lib.mkIf (cfg.config != null && !cfg.configWritable) {

     

       516
       516
       +
           environment.etc = mkMerge [

     

       517
       517
       +
             (mkIf (cfg.config != null && !cfg.configWritable) {

     

       476
       518
        
               "home-assistant/configuration.yaml".source = configFile;

     

       477
       519
        
             })

     

       478
       520
        
       

     

       479
       479
       -
             (lib.mkIf (cfg.lovelaceConfig != null && !cfg.lovelaceConfigWritable) {

     

       521
       521
       +
             (mkIf (cfg.lovelaceConfig != null && !cfg.lovelaceConfigWritable) {

     

       480
       522
        
               "home-assistant/ui-lovelace.yaml".source = lovelaceConfigFile;

     

       481
       523
        
             })

     

       482
       524
        
           ];

     
···

       491
       533
        
               "mysql.service"

     

       492
       534
        
               "postgresql.service"

     

       493
       535
        
             ];

     

       494
       494
       -
             reloadTriggers = lib.optional (cfg.config != null) configFile

     

       495
       495
       -
             ++ lib.optional (cfg.lovelaceConfig != null) lovelaceConfigFile;

     

       536
       536
       +
             reloadTriggers = optionals (cfg.config != null) [ configFile ]

     

       537
       537
       +
             ++ optionals (cfg.lovelaceConfig != null) [ lovelaceConfigFile ];

     

       496
       538
        
       

     

       497
       539
        
             preStart = let

     

       498
       540
        
               copyConfig = if cfg.configWritable then ''

     
···

       541
       583
        
             environment.PYTHONPATH = package.pythonPath;

     

       542
       584
        
             serviceConfig = let

     

       543
       585
        
               # List of capabilities to equip home-assistant with, depending on configured components

     

       544
       544
       -
               capabilities = lib.unique ([

     

       586
       586
       +
               capabilities = unique ([

     

       545
       587
        
                 # Empty string first, so we will never accidentally have an empty capability bounding set

     

       546
       588
        
                 # https://github.com/NixOS/nixpkgs/issues/120617#issuecomment-830685115

     

       547
       589
        
                 ""

     

       548
       548
       -
               ] ++ lib.optionals (builtins.any useComponent componentsUsingBluetooth) [

     

       590
       590
       +
               ] ++ optionals (any useComponent componentsUsingBluetooth) [

     

       549
       591
        
                 # Required for interaction with hci devices and bluetooth sockets, identified by bluetooth-adapters dependency

     

       550
       592
        
                 # https://www.home-assistant.io/integrations/bluetooth_le_tracker/#rootless-setup-on-core-installs

     

       551
       593
        
                 "CAP_NET_ADMIN"

     

       552
       594
        
                 "CAP_NET_RAW"

     

       553
       553
       -
               ] ++ lib.optionals (useComponent "emulated_hue") [

     

       595
       595
       +
               ] ++ optionals (useComponent "emulated_hue") [

     

       554
       596
        
                 # Alexa looks for the service on port 80

     

       555
       597
        
                 # https://www.home-assistant.io/integrations/emulated_hue

     

       556
       598
        
                 "CAP_NET_BIND_SERVICE"

     

       557
       557
       -
               ] ++ lib.optionals (useComponent "nmap_tracker") [

     

       599
       599
       +
               ] ++ optionals (useComponent "nmap_tracker") [

     

       558
       600
        
                 # https://www.home-assistant.io/integrations/nmap_tracker#linux-capabilities

     

       559
       601
        
                 "CAP_NET_ADMIN"

     

       560
       602
        
                 "CAP_NET_BIND_SERVICE"

     
···

       582
       624
        
                 "inkbird"

     

       583
       625
        
                 "improv_ble"

     

       584
       626
        
                 "keymitt_ble"

     

       585
       585
       -
                 "leaone-ble"

     

       627
       627
       +
                 "ld2410_ble"

     

       628
       628
       +
                 "leaone"

     

       586
       629
        
                 "led_ble"

     

       587
       630
        
                 "medcom_ble"

     

       588
       631
        
                 "melnor"

     

       589
       632
        
                 "moat"

     

       590
       633
        
                 "mopeka"

     

       634
       634
       +
                 "motionblinds_ble"

     

       591
       635
        
                 "oralb"

     

       592
       636
        
                 "private_ble_device"

     

       593
       637
        
                 "qingping"

     
···

       621
       665
        
                 # mostly the ones using config flows already.

     

       622
       666
        
                 "acer_projector"

     

       623
       667
        
                 "alarmdecoder"

     

       668
       668
       +
                 "aurora_abb_powerone"

     

       624
       669
        
                 "blackbird"

     

       670
       670
       +
                 "bryant_evolution"

     

       671
       671
       +
                 "crownstone"

     

       625
       672
        
                 "deconz"

     

       626
       673
        
                 "dsmr"

     

       627
       674
        
                 "edl21"

     

       628
       675
        
                 "elkm1"

     

       629
       676
        
                 "elv"

     

       630
       677
        
                 "enocean"

     

       678
       678
       +
                 "homeassistant_hardware"

     

       679
       679
       +
                 "homeassistant_yellow"

     

       631
       680
        
                 "firmata"

     

       632
       681
        
                 "flexit"

     

       633
       682
        
                 "gpsd"

     

       634
       683
        
                 "insteon"

     

       635
       684
        
                 "kwb"

     

       636
       685
        
                 "lacrosse"

     

       686
       686
       +
                 "landisgyr_heat_meter"

     

       637
       687
        
                 "modbus"

     

       638
       688
        
                 "modem_callerid"

     

       639
       689
        
                 "mysensors"

     

       640
       690
        
                 "nad"

     

       641
       691
        
                 "numato"

     

       692
       692
       +
                 "nut"

     

       693
       693
       +
                 "opentherm_gw"

     

       642
       694
        
                 "otbr"

     

       695
       695
       +
                 "rainforst_raven"

     

       643
       696
        
                 "rflink"

     

       644
       697
        
                 "rfxtrx"

     

       645
       698
        
                 "scsgate"

     
···

       655
       708
        
                 "zwave_js"

     

       656
       709
        
               ];

     

       657
       710
        
             in {

     

       658
       658
       -
               ExecStart = "${package}/bin/hass --config '${cfg.configDir}'";

     

       659
       659
       -
               ExecReload = "${pkgs.coreutils}/bin/kill -HUP $MAINPID";

     

       711
       711
       +
               ExecStart = escapeSystemdExecArgs ([

     

       712
       712
       +
                 (lib.getExe package)

     

       713
       713
       +
                 "--config" cfg.configDir

     

       714
       714
       +
               ] ++ cfg.extraArgs);

     

       715
       715
       +
               ExecReload = (escapeSystemdExecArgs [

     

       716
       716
       +
                 (lib.getExe' pkgs.coreutils "kill")

     

       717
       717
       +
                 "-HUP"

     

       718
       718
       +
               ]) + " $MAINPID";

     

       660
       719
        
               User = "hass";

     

       661
       720
        
               Group = "hass";

     

       662
       721
        
               WorkingDirectory = cfg.configDir;

     

       663
       722
        
               Restart = "on-failure";

     

       723
       723
       +
       

     

       724
       724
       +
               # Signal handling

     

       725
       725
       +
               # homeassistant/helpers/signal.py

     

       664
       726
        
               RestartForceExitStatus = "100";

     

       665
       727
        
               SuccessExitStatus = "100";

     

       666
       728
        
               KillSignal = "SIGINT";

+1 -1

nixos/tests/all-tests.nix

···

       456
       456
        
         hitch = handleTest ./hitch {};

     

       457
       457
        
         hledger-web = handleTest ./hledger-web.nix {};

     

       458
       458
        
         hockeypuck = handleTest ./hockeypuck.nix { };

     

       459
       459
       -
         home-assistant = handleTest ./home-assistant.nix {};

     

       459
       459
       +
         home-assistant = runTest ./home-assistant.nix;

     

       460
       460
        
         hostname = handleTest ./hostname.nix {};

     

       461
       461
        
         hound = handleTest ./hound.nix {};

     

       462
       462
        
         hub = handleTest ./git/hub.nix {};

+12 -9

nixos/tests/home-assistant.nix

···

       1
       1
       -
       import ./make-test-python.nix ({ pkgs, lib, ... }:

     

       1
       1
       +
       {

     

       2
       2
       +
         lib,

     

       3
       3
       +
         ...

     

       4
       4
       +
       }:

     

       2
       5
        
       

     

       3
       6
        
       let

     

       4
       7
        
         configDir = "/var/lib/foobar";

     
···

       122
       125
        
           # Cause a configuration change that requires a service restart as we added a new runtime dependency

     

       123
       126
        
           specialisation.newFeature = {

     

       124
       127
        
             inheritParentConfig = true;

     

       125
       125
       -
             configuration.services.home-assistant.config.backup = {};

     

       128
       128
       +
             configuration.services.home-assistant.config.prometheus = {};

     

       126
       129
        
           };

     

       127
       130
        
       

     

       128
       131
        
           specialisation.removeCustomThings = {

     
···

       206
       209
        
           with subtest("Check extra components are considered in systemd unit hardening"):

     

       207
       210
        
               hass.succeed("systemctl show -p DeviceAllow home-assistant.service | grep -q char-ttyUSB")

     

       208
       211
        
       

     

       209
       209
       -
           with subtest("Check service reloads when configuration changes"):

     

       212
       212
       +
           with subtest("Check service restart from SIGHUP"):

     

       210
       213
        
               pid = hass.succeed("systemctl show --property=MainPID home-assistant.service")

     

       211
       214
        
               cursor = get_journal_cursor()

     

       212
       215
        
               hass.succeed("${system}/specialisation/differentName/bin/switch-to-configuration test")

     

       216
       216
       +
               wait_for_homeassistant(cursor)

     

       213
       217
        
               new_pid = hass.succeed("systemctl show --property=MainPID home-assistant.service")

     

       214
       214
       -
               assert pid == new_pid, "The PID of the process should not change between process reloads"

     

       215
       215
       -
               wait_for_homeassistant(cursor)

     

       218
       218
       +
               assert pid != new_pid, "The PID of the process must change after sending SIGHUP"

     

       216
       219
        
       

     

       217
       220
        
           with subtest("Check service restarts when dependencies change"):

     

       218
       221
        
               pid = new_pid

     

       219
       222
        
               cursor = get_journal_cursor()

     

       220
       223
        
               hass.succeed("${system}/specialisation/newFeature/bin/switch-to-configuration test")

     

       221
       221
       -
               new_pid = hass.succeed("systemctl show --property=MainPID home-assistant.service")

     

       222
       222
       -
               assert pid != new_pid, "The PID of the process should change when its PYTHONPATH changess"

     

       223
       224
        
               wait_for_homeassistant(cursor)

     

       225
       225
       +
               new_pid = hass.succeed("systemctl show --property=MainPID home-assistant.service")

     

       226
       226
       +
               assert pid != new_pid, "The PID of the process must change when its PYTHONPATH changess"

     

       224
       227
        
       

     

       225
       228
        
           with subtest("Check that new components get setup after restart"):

     

       226
       229
        
               journal = get_journal_since(cursor)

     

       227
       227
       -
               for domain in ["backup"]:

     

       230
       230
       +
               for domain in ["prometheus"]:

     

       228
       231
        
                   assert f"Setup of domain {domain} took" in journal, f"{domain} setup missing"

     

       229
       232
        
       

     

       230
       233
        
           with subtest("Check custom components and custom lovelace modules get removed"):

     
···

       242
       245
        
               hass.log(hass.succeed("systemctl cat home-assistant.service"))

     

       243
       246
        
               hass.log(hass.succeed("systemd-analyze security home-assistant.service"))

     

       244
       247
        
         '';

     

       245
       245
       -
       })

     

       248
       248
       +
       }