nixos/home-assistant: fix bug causing config file not to be written (including `http.server_port`) #82480

matt-snider · 2020-03-13T11:08:38Z

Motivation for this change

This fixes #82076 by ensuring that the configuration.yaml file is always (over)written. I think this approach simplifies things a bit, and to me aligns more with what I would assume "default config" means. I'm not sure it's the right way though, since it changes the behaviour of applyDefaultConfig.

It would be great to get some feedback on a few points in particular:

Would is be better to set defaultConfig to a subset of the contents of the default configuration.yaml file plus the port and timezone? For now I just have frontend in there. This might be less of a breaking change but it would mean keeping up to date when home-assistant changes that file. For reference, this is what that file looks like:

# Configure a default setup of Home Assistant (frontend, api, etc)
default_config:

# Uncomment this if you are using SSL/TLS, running in Docker container, etc.
# http:
#   base_url: example.duckdns.org:8123

# Text to speech
tts:
  - platform: google_translate

# These files all start off empty
group: !include groups.yaml
automation: !include automations.yaml
script: !include scripts.yaml
scene: !include scenes.yaml

Tests: I've never written nixos tests before, so I don't know if this is the right approach, or whether this kind of test is necessary. Either way, it was useful to debug the problem.

NOTE: some of the home-assistant tests seem to be failing currently, but this appears to be caused by #82441

Things done

…viour If the `config` option is not set, the `port` option has no effect. This is caused by the condition `cfg.config != null` not passing, resulting in the default `configuration.yaml` file not being overwritten. If `time.timeZone` isn't set, it also appears to cause home-assistant to error out. Another issue is that the `defaultConfig` doesn't currently set `frontend` which means in the minimal setup with just `port` set, we still won't be able to reach the frontend.

stale · 2020-09-27T12:07:36Z

Hello, I'm a bot and I thank you in the name of the community for your contributions.

Nixpkgs is a busy repository, and unfortunately sometimes PRs get left behind for too long. Nevertheless, we'd like to help committers reach the PRs that are still important. This PR has had no activity for 180 days, and so I marked it as stale, but you can rest assured it will never be closed by a non-human.

If this is still important to you and you'd like to remove the stale label, we ask that you leave a comment. Your comment can be as simple as "still important to me". But there's a bit more you can do:

If you received an approval by an unprivileged maintainer and you are just waiting for a merge, you can @ mention someone with merge permissions and ask them to help. You might be able to find someone relevant by using Git blame on the relevant files, or via GitHub's web interface. You can see if someone's a member of the nixpkgs-committers team, by hovering with the mouse over their username on the web interface, or by searching them directly on the list.

If your PR wasn't reviewed at all, it might help to find someone who's perhaps a user of the package or module you are changing, or alternatively, ask once more for a review by the maintainer of the package/module this is about. If you don't know any, you can use Git blame on the relevant files, or GitHub's web interface to find someone who touched the relevant files in the past.

If your PR has had reviews and nevertheless got stale, make sure you've responded to all of the reviewer's requests / questions. Usually when PR authors show responsibility and dedication, reviewers (privileged or not) show dedication as well. If you've pushed a change, it's possible the reviewer wasn't notified about your push via email, so you can always officially request them for a review, or just @ mention them and say you've addressed their comments.

Lastly, you can always ask for help at our Discourse Forum, or more specifically, at this thread or at #nixos' IRC channel.

matt-snider · 2020-09-27T14:21:53Z

@colemickens or @dotlambda does this change make sense to either of you?

colemickens · 2020-09-28T00:38:59Z

I'm not sure I'm familiar enough, or having enough time, to review this well. cc: @Mic92 even though I think they've seen it.

aanderse · 2020-12-15T23:14:08Z

ping @colemickens @dotlambda @Mic92 @peterhoeg

I'm sure @matt-snider would appreciate a review very much so. Is anyone able to sacrifice some time and help out with this? ❤️

Mic92 · 2020-12-16T20:57:04Z

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

@@ -225,7 +228,7 @@ in {
    systemd.services.home-assistant = {
      description = "Home Assistant";
      after = [ "network.target" ];
-      preStart = optionalString (cfg.config != null) (if cfg.configWritable then ''


So the actual bug fix is this line?

Yeah but I believe frontend missing was also causing issues. It's been quite a while though and it's not that fresh anymore. I'll have to spend some time going through and running it in various situations.

Mic92 · 2020-12-16T21:00:36Z

nixos/tests/home-assistant-config.nix

+    hassMinimal = mkHass {};
+
+    hassTimeZone = mkHass {
+      machineAttrs = { time.timeZone = "UTC"; };
+    };
+
+    hassNoDefault = mkHass {
+      hassAttrs = { applyDefaultConfig = false; };
+    };


I don't think we are going to need all those tests. They don't test much but still needs to be maintained and they are expensive to evaluate. It would be fine if they only would generate the configuration but they spawn actual VMs.

Hey @Mic92 thanks for the feedback. This was my feeling as well, but I wasn't sure how to do unit tests in Nix. Perhaps I just missed some examples or documentation. Is there anything you could point me to that might help?

aanderse · 2020-12-16T21:39:59Z

Thank you @Mic92!

stale · 2021-06-22T15:23:05Z

I marked this as stale due to inactivity. → More info

aanderse · 2021-06-23T00:27:11Z

@matt-snider what do you need to push this through to the finish line?

matt-snider · 2021-06-24T08:43:07Z

@aanderse Thanks for following up! I think the main suggestion from @Mic92 was to remove the tests. Otherwise, from his comment "So the actual bug fix is this line?", I interpret that a more minimal change would be preferable. That's understandable, since it probably would have allowed this to be more easily approved.

Perhaps we should just close this PR, since it's over a year old, and I haven't run it with newer versions of home assistant. It doesn't seem to affect many people, judging by activity on this PR and the original issue.

aanderse · 2021-06-26T20:38:25Z

Sorry things didn't go super smooth.

matt-snider · 2021-06-27T08:18:31Z

@aanderse Not at all. I should have been more proactive with this one.

Thank you for all the work you and many others do on Nix. It really is an incredible project! I'd like to help out more but you know... time management :-/

matt-snider added 2 commits March 13, 2020 11:49

nixos/home-assistant: add tests to ensure config is properly generated

aa25cf7

ofborg bot added 6.topic: nixos 8.has: module (update) 10.rebuild-darwin: 0 10.rebuild-linux: 1-10 labels Mar 13, 2020

Mic92 requested review from dotlambda and colemickens March 31, 2020 11:56

stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Sep 27, 2020

stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Sep 27, 2020

Mic92 reviewed Dec 16, 2020

View reviewed changes

matt-snider mentioned this pull request Jan 16, 2021

nixos/etesync-dav: init module #83479

Merged

10 tasks

mweinelt added this to To do in Home Assistant via automation May 4, 2021

stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jun 22, 2021

stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jun 23, 2021

matt-snider closed this Jun 27, 2021

Home Assistant automation moved this from Incoming to Done Jun 27, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

nixos/home-assistant: fix bug causing config file not to be written (including `http.server_port`) #82480

nixos/home-assistant: fix bug causing config file not to be written (including `http.server_port`) #82480

matt-snider commented Mar 13, 2020 •

edited

stale bot commented Sep 27, 2020

matt-snider commented Sep 27, 2020

colemickens commented Sep 28, 2020

aanderse commented Dec 15, 2020

Mic92 Dec 16, 2020

matt-snider Dec 22, 2020

Mic92 Dec 16, 2020

matt-snider Dec 22, 2020

aanderse commented Dec 16, 2020

stale bot commented Jun 22, 2021

aanderse commented Jun 23, 2021

matt-snider commented Jun 24, 2021

aanderse commented Jun 26, 2021

matt-snider commented Jun 27, 2021

nixos/home-assistant: fix bug causing config file not to be written (including http.server_port) #82480

nixos/home-assistant: fix bug causing config file not to be written (including http.server_port) #82480

Conversation

matt-snider commented Mar 13, 2020 • edited

Motivation for this change

Things done

stale bot commented Sep 27, 2020

matt-snider commented Sep 27, 2020

colemickens commented Sep 28, 2020

aanderse commented Dec 15, 2020

Mic92 Dec 16, 2020

Choose a reason for hiding this comment

matt-snider Dec 22, 2020

Choose a reason for hiding this comment

Mic92 Dec 16, 2020

Choose a reason for hiding this comment

matt-snider Dec 22, 2020

Choose a reason for hiding this comment

aanderse commented Dec 16, 2020

stale bot commented Jun 22, 2021

aanderse commented Jun 23, 2021

matt-snider commented Jun 24, 2021

aanderse commented Jun 26, 2021

matt-snider commented Jun 27, 2021

nixos/home-assistant: fix bug causing config file not to be written (including `http.server_port`) #82480

nixos/home-assistant: fix bug causing config file not to be written (including `http.server_port`) #82480

matt-snider commented Mar 13, 2020 •

edited