nixpkgs/pkgs/servers/home-assistant/default.nix
2021-01-15 18:14:15 +01:00

205 lines
6.2 KiB
Nix

{ stdenv, nixosTests, lib, fetchurl, fetchFromGitHub, fetchpatch, python3, protobuf3_6
# Look up dependencies of specified components in component-packages.nix
, extraComponents ? [ ]
# Additional packages to add to propagatedBuildInputs
, extraPackages ? ps: []
# Override Python packages using
# self: super: { pkg = super.pkg.overridePythonAttrs (oldAttrs: { ... }); }
# Applied after defaultOverrides
, packageOverrides ? self: super: {
}
# Skip pip install of required packages on startup
, skipPip ? true }:
let
defaultOverrides = [
# Override the version of some packages pinned in Home Assistant's setup.py
# Pinned due to API changes in astral>=2.0, required by the sun/moon plugins
# https://github.com/home-assistant/core/issues/36636
(mkOverride "astral" "1.10.1"
"d2a67243c4503131c856cafb1b1276de52a86e5b8a1d507b7e08bee51cb67bf1")
# hass-frontend does not exist in python3.pkgs
(self: super: {
hass-frontend = self.callPackage ./frontend.nix { };
})
];
mkOverride = attrname: version: sha256:
self: super: {
${attrname} = super.${attrname}.overridePythonAttrs (oldAttrs: {
inherit version;
src = oldAttrs.src.override {
inherit version sha256;
};
});
};
py = python3.override {
# Put packageOverrides at the start so they are applied after defaultOverrides
packageOverrides = lib.foldr lib.composeExtensions (self: super: { }) ([ packageOverrides ] ++ defaultOverrides);
};
componentPackages = import ./component-packages.nix;
availableComponents = builtins.attrNames componentPackages.components;
getPackages = component: builtins.getAttr component componentPackages.components;
componentBuildInputs = lib.concatMap (component: getPackages component py.pkgs) extraComponents;
# Ensure that we are using a consistent package set
extraBuildInputs = extraPackages py.pkgs;
# Don't forget to run parse-requirements.py after updating
hassVersion = "2021.1.3";
in with py.pkgs; buildPythonApplication rec {
pname = "homeassistant";
version = assert (componentPackages.version == hassVersion); hassVersion;
# check REQUIRED_PYTHON_VER in homeassistant/const.py
disabled = pythonOlder "3.7.1";
# don't try and fail to strip 6600+ python files, it takes minutes!
dontStrip = true;
inherit availableComponents;
# PyPI tarball is missing tests/ directory
src = fetchFromGitHub {
owner = "home-assistant";
repo = "core";
rev = version;
sha256 = "168njrzvqr3wn1xk02q1yn1f90mf1hds6m8lffgkql8m6a6576hn";
};
# leave this in, so users don't have to constantly update their downstream patch handling
patches = [];
postPatch = ''
substituteInPlace setup.py \
--replace "aiohttp==3.7.1" "aiohttp>=3.6.3" \
--replace "attrs==19.3.0" "attrs>=19.3.0" \
--replace "bcrypt==3.1.7" "bcrypt>=3.1.7" \
--replace "cryptography==3.2" "cryptography" \
--replace "pip>=8.0.3,<20.3" "pip" \
--replace "requests==2.25.0" "requests>=2.24.0" \
--replace "ruamel.yaml==0.15.100" "ruamel.yaml>=0.15.100"
substituteInPlace tests/test_config.py --replace '"/usr"' '"/build/media"'
'';
propagatedBuildInputs = [
# From setup.py
aiohttp astral async-timeout attrs bcrypt certifi ciso8601 httpx jinja2
pyjwt cryptography pip python-slugify pytz pyyaml requests ruamel_yaml
setuptools voluptuous voluptuous-serialize yarl
# From default_config. frontend, http, image, mobile_app and recorder components as well as
# the auth.mfa_modules.totp module
aiohttp-cors defusedxml distro emoji hass-frontend pynacl pillow pyotp
pyqrcode sqlalchemy
] ++ componentBuildInputs ++ extraBuildInputs;
# upstream only tests on Linux, so do we.
doCheck = stdenv.isLinux;
checkInputs = [
asynctest pytestCheckHook pytest-aiohttp pytest_xdist requests-mock hass-nabucasa netdisco pydispatcher
];
# We cannot test all components, since they'd introduce lots of dependencies, some of which are unpackaged,
# but we should test very common stuff, like what's in `default_config`.
componentTests = [
"api"
"automation"
"config"
"configurator"
"default_config"
"demo"
"discovery"
"frontend"
"group"
"history"
"homeassistant"
"http"
"input_boolean"
"input_datetime"
"input_text"
"input_number"
"input_select"
"logbook"
"logger"
"media_source"
"mobile_app"
"person"
"scene"
"script"
"shell_command"
"ssdp"
"sun"
"system_health"
"system_log"
"tag"
"websocket_api"
"zeroconf"
"zone"
];
pytestFlagsArray = [
"-n auto"
# don't bulk test all components
"--ignore tests/components"
# prone to race conditions due to parallel file access
"--ignore tests/test_config.py"
# tries to import unpackaged dependencies
"--ignore tests/test_loader.py"
# pyotp since v2.4.0 complains about the short mock keys, hass pins v2.3.0
"--ignore tests/auth/mfa_modules/test_notify.py"
"tests"
] ++ map (component: "tests/components/" + component) componentTests;
disabledTests = [
# AssertionError: merge_log_err.call_count != 0
"test_merge"
# ModuleNotFoundError: No module named 'pyqwikswitch'
"test_merge_id_schema"
# AssertionError: assert 'unknown' == 'not_home'
"test_device_tracker_not_home"
# Racy https://github.com/home-assistant/core/issues/41425
"test_cached_event_message"
# ValueError: count must be a positive integer (got 0)
"test_media_view"
# AssertionError: len(events) == 1
"test_error_posted_as_event"
# keyring.errors.NoKeyringError: No recommended backend was available.
"test_secrets_from_unrelated_fails"
"test_secrets_credstash"
];
preCheck = ''
# the tests require the existance of a media dir
mkdir /build/media
'';
makeWrapperArgs = lib.optional skipPip "--add-flags --skip-pip";
passthru = {
inherit (py.pkgs) hass-frontend;
tests = {
inherit (nixosTests) home-assistant;
};
};
meta = with lib; {
homepage = "https://home-assistant.io/";
description = "Open source home automation that puts local control and privacy first";
license = licenses.asl20;
maintainers = with maintainers; [ dotlambda globin mic92 hexa ];
};
}