Mullvad VPN (#44189)

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: Franck Nijhof <git@frenck.dev>

.coveragerc

@@ -586,6 +586,9 @@ omit =
     homeassistant/components/mpd/media_player.py
     homeassistant/components/mqtt_room/sensor.py
     homeassistant/components/msteams/notify.py
+    homeassistant/components/mullvad/__init__.py
+    homeassistant/components/mullvad/binary_sensor.py
+    homeassistant/components/nest/const.py
     homeassistant/components/mvglive/sensor.py
     homeassistant/components/mychevy/*
     homeassistant/components/mycroft/*

CODEOWNERS

@@ -293,6 +293,7 @@ homeassistant/components/motion_blinds/* @starkillerOG
 homeassistant/components/mpd/* @fabaff
 homeassistant/components/mqtt/* @emontnemery
 homeassistant/components/msteams/* @peroyvind
+homeassistant/components/mullvad/* @meichthys
 homeassistant/components/my/* @home-assistant/core
 homeassistant/components/myq/* @bdraco
 homeassistant/components/mysensors/* @MartinHjelmare @functionpointer

homeassistant/components/mullvad/__init__.py

@@ -0,0 +1,63 @@
+"""The Mullvad VPN integration."""
+import asyncio
+from datetime import timedelta
+import logging
+
+import async_timeout
+from mullvad_api import MullvadAPI
+
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers import update_coordinator
+
+from .const import DOMAIN
+
+PLATFORMS = ["binary_sensor"]
+
+
+async def async_setup(hass: HomeAssistant, config: dict):
+    """Set up the Mullvad VPN integration."""
+
+    return True
+
+
+async def async_setup_entry(hass: HomeAssistant, entry: dict):
+    """Set up Mullvad VPN integration."""
+
+    async def async_get_mullvad_api_data():
+        with async_timeout.timeout(10):
+            api = await hass.async_add_executor_job(MullvadAPI)
+            return api.data
+
+    hass.data[DOMAIN] = update_coordinator.DataUpdateCoordinator(
+        hass,
+        logging.getLogger(__name__),
+        name=DOMAIN,
+        update_method=async_get_mullvad_api_data,
+        update_interval=timedelta(minutes=1),
+    )
+    await hass.data[DOMAIN].async_refresh()
+
+    for component in PLATFORMS:
+        hass.async_create_task(
+            hass.config_entries.async_forward_entry_setup(entry, component)
+        )
+
+    return True
+
+
+async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry):
+    """Unload a config entry."""
+    unload_ok = all(
+        await asyncio.gather(
+            *[
+                hass.config_entries.async_forward_entry_unload(entry, component)
+                for component in PLATFORMS
+            ]
+        )
+    )
+
+    if unload_ok:
+        del hass.data[DOMAIN]
+
+    return unload_ok

homeassistant/components/mullvad/binary_sensor.py

@@ -0,0 +1,52 @@
+"""Setup Mullvad VPN Binary Sensors."""
+from homeassistant.components.binary_sensor import (
+    DEVICE_CLASS_CONNECTIVITY,
+    BinarySensorEntity,
+)
+from homeassistant.const import CONF_DEVICE_CLASS, CONF_ID, CONF_NAME
+from homeassistant.helpers.update_coordinator import CoordinatorEntity
+
+from .const import DOMAIN
+
+BINARY_SENSORS = (
+    {
+        CONF_ID: "mullvad_exit_ip",
+        CONF_NAME: "Mullvad Exit IP",
+        CONF_DEVICE_CLASS: DEVICE_CLASS_CONNECTIVITY,
+    },
+)
+
+
+async def async_setup_entry(hass, config_entry, async_add_entities):
+    """Defer sensor setup to the shared sensor module."""
+    coordinator = hass.data[DOMAIN]
+
+    async_add_entities(
+        MullvadBinarySensor(coordinator, sensor) for sensor in BINARY_SENSORS
+    )
+
+
+class MullvadBinarySensor(CoordinatorEntity, BinarySensorEntity):
+    """Represents a Mullvad binary sensor."""
+
+    def __init__(self, coordinator, sensor):  # pylint: disable=super-init-not-called
+        """Initialize the Mullvad binary sensor."""
+        super().__init__(coordinator)
+        self.id = sensor[CONF_ID]
+        self._name = sensor[CONF_NAME]
+        self._device_class = sensor[CONF_DEVICE_CLASS]
+
+    @property
+    def device_class(self):
+        """Return the device class for this binary sensor."""
+        return self._device_class
+
+    @property
+    def name(self):
+        """Return the name for this binary sensor."""
+        return self._name
+
+    @property
+    def state(self):
+        """Return the state for this binary sensor."""
+        return self.coordinator.data[self.id]

homeassistant/components/mullvad/config_flow.py

@@ -0,0 +1,25 @@
+"""Config flow for Mullvad VPN integration."""
+import logging
+
+from homeassistant import config_entries
+
+from .const import DOMAIN  # pylint:disable=unused-import
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
+    """Handle a config flow for Mullvad VPN."""
+
+    VERSION = 1
+    CONNECTION_CLASS = config_entries.CONN_CLASS_CLOUD_POLL
+
+    async def async_step_user(self, user_input=None):
+        """Handle the initial step."""
+        if self.hass.config_entries.async_entries(DOMAIN):
+            return self.async_abort(reason="already_configured")
+
+        if user_input is not None:
+            return self.async_create_entry(title="Mullvad VPN", data=user_input)
+
+        return self.async_show_form(step_id="user")

homeassistant/components/mullvad/const.py

@@ -0,0 +1,3 @@
+"""Constants for the Mullvad VPN integration."""
+
+DOMAIN = "mullvad"

homeassistant/components/mullvad/manifest.json

@@ -0,0 +1,12 @@
+{
+  "domain": "mullvad",
+  "name": "Mullvad VPN",
+  "config_flow": true,
+  "documentation": "https://www.home-assistant.io/integrations/mullvad",
+  "requirements": [
+    "mullvad-api==1.0.0"
+  ],
+  "codeowners": [
+    "@meichthys"
+  ]
+}

homeassistant/components/mullvad/strings.json

@@ -0,0 +1,22 @@
+{
+  "config": {
+    "abort": {
+      "already_configured": "[%key:common::config_flow::abort::already_configured_device%]"
+    },
+    "error": {
+      "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
+      "invalid_auth": "[%key:common::config_flow::error::invalid_auth%]",
+      "unknown": "[%key:common::config_flow::error::unknown%]"
+    },
+    "step": {
+      "user": {
+        "description": "Set up the Mullvad VPN integration?",
+        "data": {
+          "host": "[%key:common::config_flow::data::host%]",
+          "password": "[%key:common::config_flow::data::password%]",
+          "username": "[%key:common::config_flow::data::username%]"
+        }
+      }
+    }
+  }
+}

homeassistant/components/mullvad/translations/en.json

@@ -0,0 +1,22 @@
+{
+    "config": {
+        "abort": {
+            "already_configured": "Device is already configured"
+        },
+        "error": {
+            "cannot_connect": "Failed to connect",
+            "invalid_auth": "Invalid authentication",
+            "unknown": "Unexpected error"
+        },
+        "step": {
+            "user": {
+                "data": {
+                    "host": "Host",
+                    "password": "Password",
+                    "username": "Username"
+                },
+                "description": "Set up the Mullvad VPN integration?"
+            }
+        }
+    }
+}

homeassistant/generated/config_flows.py

@@ -143,6 +143,7 @@ FLOWS = [
     "monoprice",
     "motion_blinds",
     "mqtt",
+    "mullvad",
     "myq",
     "mysensors",
     "neato",

requirements_all.txt

@@ -955,6 +955,9 @@ mitemp_bt==0.0.3
 # homeassistant.components.motion_blinds
 motionblinds==0.4.8
 
+# homeassistant.components.mullvad
+mullvad-api==1.0.0
+
 # homeassistant.components.tts
 mutagen==1.45.1
 

requirements_test_all.txt

@@ -500,6 +500,9 @@ minio==4.0.9
 # homeassistant.components.motion_blinds
 motionblinds==0.4.8
 
+# homeassistant.components.mullvad
+mullvad-api==1.0.0
+
 # homeassistant.components.tts
 mutagen==1.45.1
 

tests/components/mullvad/__init__.py

@@ -0,0 +1 @@
+"""Tests for the mullvad component."""

tests/components/mullvad/test_config_flow.py

@@ -0,0 +1,46 @@
+"""Test the Mullvad config flow."""
+from unittest.mock import patch
+
+from homeassistant import config_entries, setup
+from homeassistant.components.mullvad.const import DOMAIN
+
+from tests.common import MockConfigEntry
+
+
+async def test_form_user(hass):
+    """Test we can setup by the user."""
+    await setup.async_setup_component(hass, DOMAIN, {})
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN, context={"source": config_entries.SOURCE_USER}
+    )
+    assert result["type"] == "form"
+    assert result["errors"] is None
+
+    with patch(
+        "homeassistant.components.mullvad.async_setup", return_value=True
+    ) as mock_setup, patch(
+        "homeassistant.components.mullvad.async_setup_entry",
+        return_value=True,
+    ) as mock_setup_entry:
+        result2 = await hass.config_entries.flow.async_configure(
+            result["flow_id"],
+            {},
+        )
+        await hass.async_block_till_done()
+
+    assert result2["type"] == "create_entry"
+    assert result2["title"] == "Mullvad VPN"
+    assert result2["data"] == {}
+    assert len(mock_setup.mock_calls) == 0
+    assert len(mock_setup_entry.mock_calls) == 1
+
+
+async def test_form_user_only_once(hass):
+    """Test we can setup by the user only once."""
+    MockConfigEntry(domain=DOMAIN).add_to_hass(hass)
+    await setup.async_setup_component(hass, "persistent_notification", {})
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN, context={"source": config_entries.SOURCE_USER}
+    )
+    assert result["type"] == "abort"
+    assert result["reason"] == "already_configured"