nixpkgs/pkgs/servers/home-assistant/default.nix

454 lines
11 KiB
Nix
Raw Normal View History

{ stdenv
, lib
, fetchFromGitHub
, python3
, nixosTests
# Look up dependencies of specified components in component-packages.nix
2019-12-20 07:25:56 +00:00
, extraComponents ? [ ]
# Additional packages to add to propagatedBuildInputs
2018-01-14 21:26:52 +00:00
, 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
2018-01-14 21:26:52 +00:00
, skipPip ? true }:
let
defaultOverrides = [
2018-06-26 20:36:14 +00:00
# Override the version of some packages pinned in Home Assistant's setup.py
2018-11-10 12:42:15 +00:00
2020-10-08 21:13:48 +00:00
# Pinned due to API changes in astral>=2.0, required by the sun/moon plugins
2021-04-19 16:35:11 +00:00
# https://github.com/home-assistant/core/pull/48573; Remove >= 2021.5
(mkOverride "astral" "1.10.1"
"d2a67243c4503131c856cafb1b1276de52a86e5b8a1d507b7e08bee51cb67bf1")
# Pinned due to API changes in iaqualink>=2.0, remove after
# https://github.com/home-assistant/core/pull/48137 was merged
(self: super: {
iaqualink = super.iaqualink.overridePythonAttrs (oldAttrs: rec {
version = "0.3.4";
src = fetchFromGitHub {
owner = "flz";
repo = "iaqualink-py";
rev = "v${version}";
sha256 = "16mn6nd9x3hm6j6da99qhwbqs95hh8wx21r1h1m9csl76z77n9lh";
};
checkInputs = oldAttrs.checkInputs ++ [ python3.pkgs.asynctest ];
});
})
# Pinned due to API changes in pylilterbot>=2021.3.0
2021-04-19 16:35:11 +00:00
# https://github.com/home-assistant/core/pull/48300; Remove >= 2021.5
(self: super: {
pylitterbot = super.pylitterbot.overridePythonAttrs (oldAttrs: rec {
version = "2021.2.8";
src = fetchFromGitHub {
owner = "natekspencer";
repo = "pylitterbot";
rev = version;
sha256 = "142lhijm51v11cd0lhcfdnjdd143jxi2hjsrqdq0rrbbnmj6mymp";
};
# had no tests before 2021.3.0
doCheck = false;
});
})
# Pinned due to bug in ring-doorbell 0.7.0
# https://github.com/tchellomello/python-ring-doorbell/issues/240
(mkOverride "ring-doorbell" "0.6.2"
"fbd537722a27b3b854c26506d894b7399bb8dc57ff36083285971227a2d46560")
# Pinned due to API changes in pyruckus>0.12
(self: super: {
pyruckus = super.pyruckus.overridePythonAttrs (oldAttrs: rec {
version = "0.12";
src = fetchFromGitHub {
owner = "gabe565";
repo = "pyruckus";
rev = version;
sha256 = "0ykv6r6blbj3fg9fplk9i7xclkv5d93rwvx0fm5s8ms9f2s9ih8z";
};
});
})
# 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;
2018-05-11 17:39:37 +00:00
src = oldAttrs.src.override {
inherit version sha256;
2018-05-11 17:39:37 +00:00
};
});
2018-01-14 21:26:52 +00:00
};
py = python3.override {
# Put packageOverrides at the start so they are applied after defaultOverrides
packageOverrides = lib.foldr lib.composeExtensions (self: super: { }) ([ packageOverrides ] ++ defaultOverrides);
2018-01-14 21:26:52 +00:00
};
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;
2018-01-14 21:26:52 +00:00
# Ensure that we are using a consistent package set
extraBuildInputs = extraPackages py.pkgs;
# Don't forget to run parse-requirements.py after updating
2021-04-19 16:35:11 +00:00
hassVersion = "2021.4.6";
2018-01-14 21:26:52 +00:00
in with py.pkgs; buildPythonApplication rec {
pname = "homeassistant";
version = assert (componentPackages.version == hassVersion); hassVersion;
2018-01-14 21:26:52 +00:00
2020-10-07 18:28:25 +00:00
# check REQUIRED_PYTHON_VER in homeassistant/const.py
2021-03-03 21:21:01 +00:00
disabled = pythonOlder "3.8";
2020-02-26 15:51:25 +00:00
# don't try and fail to strip 6600+ python files, it takes minutes!
dontStrip = true;
inherit availableComponents;
2018-01-14 21:26:52 +00:00
# PyPI tarball is missing tests/ directory
src = fetchFromGitHub {
owner = "home-assistant";
2020-05-20 21:41:42 +00:00
repo = "core";
2018-01-14 21:26:52 +00:00
rev = version;
2021-04-19 16:35:11 +00:00
sha256 = "1s1slwcqls2prz9kgyhggs8xi3x7ghwdi33j983kvpg0gva7d2f0";
2018-01-14 21:26:52 +00:00
};
2020-11-04 11:52:54 +00:00
# leave this in, so users don't have to constantly update their downstream patch handling
patches = [
];
2020-11-04 11:52:54 +00:00
2020-08-18 08:07:27 +00:00
postPatch = ''
substituteInPlace setup.py \
2021-04-07 18:34:08 +00:00
--replace "awesomeversion==21.2.3" "awesomeversion" \
--replace "bcrypt==3.1.7" "bcrypt" \
2021-03-03 21:21:01 +00:00
--replace "cryptography==3.3.2" "cryptography" \
2020-12-11 13:30:12 +00:00
--replace "pip>=8.0.3,<20.3" "pip" \
2021-04-07 18:34:08 +00:00
--replace "pytz>=2021.1" "pytz" \
2021-02-03 17:57:09 +00:00
--replace "pyyaml==5.4.1" "pyyaml" \
2021-04-07 18:34:08 +00:00
--replace "ruamel.yaml==0.15.100" "ruamel.yaml"
2020-10-07 18:28:25 +00:00
substituteInPlace tests/test_config.py --replace '"/usr"' '"/build/media"'
2020-08-18 08:07:27 +00:00
'';
2018-01-14 21:26:52 +00:00
propagatedBuildInputs = [
# Only packages required in setup.py + hass-frontend
aiohttp
astral
async-timeout
attrs
2021-02-05 13:48:53 +00:00
awesomeversion
bcrypt
certifi
ciso8601
cryptography
hass-frontend
httpx
jinja2
pip
pyjwt
python-slugify
pytz
pyyaml
requests
ruamel_yaml
voluptuous
voluptuous-serialize
yarl
] ++ componentBuildInputs ++ extraBuildInputs;
2018-01-14 21:26:52 +00:00
makeWrapperArgs = lib.optional skipPip "--add-flags --skip-pip";
2020-05-06 06:27:19 +00:00
# upstream only tests on Linux, so do we.
doCheck = stdenv.isLinux;
2018-01-14 21:26:52 +00:00
checkInputs = [
# test infrastructure
asynctest
pytest-aiohttp
pytest-rerunfailures
pytest-xdist
pytestCheckHook
requests-mock
# component dependencies
pyotp
respx
] ++ lib.concatMap (component: getPackages component py.pkgs) componentTests;
2019-12-20 07:25:56 +00:00
# We can reasonably test components that don't communicate with any network
# services. Before adding new components to this list make sure we have all
# its dependencies packaged and listed in ./component-packages.nix.
componentTests = [
"accuweather"
2021-04-01 19:16:42 +00:00
"airly"
2021-04-07 18:34:08 +00:00
"analytics"
"alert"
"api"
"auth"
"automation"
2021-04-03 13:15:49 +00:00
"axis"
"bayesian"
"binary_sensor"
"caldav"
"calendar"
"camera"
2021-04-07 13:30:34 +00:00
"cast"
"climate"
"cloud"
"comfoconnect"
"command_line"
"config"
"configurator"
"conversation"
2021-02-03 17:57:09 +00:00
"counter"
"cover"
2021-03-22 23:12:47 +00:00
"deconz"
"default_config"
"demo"
"derivative"
"device_automation"
"device_sun_light_trigger"
"device_tracker"
"devolo_home_control"
2021-02-03 17:57:09 +00:00
"dhcp"
"discovery"
2021-04-21 21:55:09 +00:00
"dsmr"
2021-04-11 14:24:21 +00:00
"econet"
"emulated_hue"
"esphome"
"fan"
2021-03-03 21:21:01 +00:00
"faa_delays"
"ffmpeg"
"file"
"filesize"
"filter"
"flux"
"folder"
"folder_watcher"
2021-04-03 16:23:36 +00:00
"freebox"
"fritzbox"
"fritzbox_callmonitor"
"frontend"
"generic"
"generic_thermostat"
"geo_json_events"
"geo_location"
"group"
"hddtemp"
"history"
"history_stats"
2021-04-07 18:34:08 +00:00
"home_plus_control"
2021-04-03 13:57:40 +00:00
"homekit"
2021-03-03 21:21:01 +00:00
"homekit_controller"
"homeassistant"
"homematic"
"homematicip_cloud"
"html5"
"http"
"hue"
2021-04-21 21:19:47 +00:00
"hyperion"
2021-03-21 00:08:49 +00:00
"iaqualink"
"ifttt"
"image"
"image_processing"
"influxdb"
"input_boolean"
"input_datetime"
"input_text"
"input_number"
"input_select"
"intent"
"intent_script"
"ipp"
2021-03-03 21:21:01 +00:00
"kmtronic"
"kodi"
"light"
2021-04-07 18:34:08 +00:00
"litterrobot"
"local_file"
"local_ip"
"lock"
"logbook"
"logentries"
"logger"
"lovelace"
"lutron_caseta"
"manual"
"manual_mqtt"
2021-03-03 21:21:01 +00:00
"mazda"
"media_player"
"media_source"
"met"
"minecraft_server"
"mobile_app"
"modbus"
"moon"
"mqtt"
"mqtt_eventstream"
"mqtt_json"
"mqtt_room"
"mqtt_statestream"
2021-03-03 21:21:01 +00:00
"mullvad"
2021-04-13 01:06:39 +00:00
"nexia"
"notify"
2021-03-20 22:49:26 +00:00
"notion"
"number"
2021-04-09 16:49:21 +00:00
"omnilogic"
"ozw"
"panel_custom"
"panel_iframe"
"persistent_notification"
"person"
2021-03-03 21:21:01 +00:00
"plaato"
"prometheus"
"proximity"
"push"
"python_script"
"random"
"recorder"
"rest"
"rest_command"
2021-03-03 21:21:01 +00:00
"rituals_perfume_genie"
"rmvtransport"
"rss_feed_template"
"ruckus_unleashed"
"safe_mode"
"scene"
2021-04-07 18:34:08 +00:00
"screenlogic"
"script"
"search"
"shell_command"
"shopping_list"
"simplisafe"
"simulated"
2021-04-11 17:02:46 +00:00
"sleepiq"
2021-03-22 23:41:26 +00:00
"sma"
"sensor"
2021-03-03 21:21:01 +00:00
"smarttub"
"smtp"
2021-04-04 19:52:01 +00:00
"smappee"
2021-03-24 22:49:55 +00:00
"solaredge"
"sonos"
2021-04-01 13:42:31 +00:00
"spotify"
"sql"
"ssdp"
"stream"
2021-03-22 23:55:41 +00:00
"subaru"
"sun"
"switch"
"system_health"
"system_log"
"tag"
"tasmota"
"tcp"
"template"
"threshold"
"time_date"
2021-02-03 17:57:09 +00:00
"timer"
"tod"
2021-04-07 18:34:08 +00:00
"trace"
"tts"
"universal"
"updater"
"upnp"
"uptime"
"vacuum"
2021-04-01 08:57:50 +00:00
"verisure"
"weather"
2021-02-03 17:57:09 +00:00
"webhook"
"websocket_api"
2021-03-20 07:59:10 +00:00
"wemo"
"wled"
"workday"
"worldclock"
2021-04-13 11:17:51 +00:00
"yeelight"
"zeroconf"
"zha"
"zone"
"zwave"
];
pytestFlagsArray = [
# limit amout of runners to reduce race conditions
"-n auto"
# retry racy tests that end in "RuntimeError: Event loop is closed"
"--reruns 3"
"--only-rerun RuntimeError"
# assign tests grouped by file to workers
"--dist loadfile"
# tests are located in tests/
"tests"
2021-04-07 18:34:08 +00:00
# screenlogic/test_config_flow.py: Tries to send out UDP broadcasts
"--deselect tests/components/screenlogic/test_config_flow.py::test_form_cannot_connect"
# dynamically add packages required for component tests
] ++ map (component: "tests/components/" + component) componentTests;
disabledTestPaths = [
# don't bulk test all components
"tests/components"
# pyotp since v2.4.0 complains about the short mock keys, hass pins v2.3.0
"tests/auth/mfa_modules/test_notify.py"
];
disabledTests = [
# AssertionError: assert 1 == 0
2021-03-03 21:21:01 +00:00
"test_error_posted_as_event"
"test_merge"
# ModuleNotFoundError: No module named 'pyqwikswitch'
"test_merge_id_schema"
2021-01-06 18:57:47 +00:00
# keyring.errors.NoKeyringError: No recommended backend was available.
"test_secrets_from_unrelated_fails"
"test_secrets_credstash"
2021-03-03 21:21:01 +00:00
# generic/test_camera.py: AssertionError: 500 == 200
"test_fetching_without_verify_ssl"
"test_fetching_url_with_verify_ssl"
2021-04-07 18:34:08 +00:00
# util/test_package.py: AssertionError on package.is_installed('homeassistant>=999.999.999')
"test_check_package_version_does_not_match"
];
preCheck = ''
2021-04-07 18:34:08 +00:00
export HOME="$TEMPDIR"
# the tests require the existance of a media dir
mkdir /build/media
# error out when component test directory is missing, otherwise hidden by xdist execution :(
for component in ${lib.concatStringsSep " " (map lib.escapeShellArg componentTests)}; do
test -d "tests/components/$component" || {
>2& echo "ERROR: Tests for component '$component' were enabled, but they do not exist!"
exit 1
}
done
2018-01-14 21:26:52 +00:00
'';
2020-05-06 06:39:44 +00:00
passthru = {
inherit (py.pkgs) hass-frontend;
2020-06-20 10:05:30 +00:00
tests = {
inherit (nixosTests) home-assistant;
};
2020-05-06 06:39:44 +00:00
};
2018-02-10 22:19:19 +00:00
meta = with lib; {
homepage = "https://home-assistant.io/";
description = "Open source home automation that puts local control and privacy first";
2018-01-14 21:26:52 +00:00
license = licenses.asl20;
maintainers = teams.home-assistant.members;
platforms = platforms.linux;
2018-01-14 21:26:52 +00:00
};
}