From f730f96024eb466ee55c33cf6ffad56f0281600f Mon Sep 17 00:00:00 2001 From: Jose Ramirez Date: Mon, 17 Oct 2022 10:09:37 -0400 Subject: [PATCH] Convert darksky unittest tests to pytest (#79868) Co-authored-by: Martin Hjelmare --- tests/components/darksky/test_sensor.py | 189 +++++++++-------------- tests/components/darksky/test_weather.py | 67 +++----- 2 files changed, 98 insertions(+), 158 deletions(-) diff --git a/tests/components/darksky/test_sensor.py b/tests/components/darksky/test_sensor.py index 02bc392cd68..3d1f8fb26bc 100644 --- a/tests/components/darksky/test_sensor.py +++ b/tests/components/darksky/test_sensor.py @@ -1,17 +1,14 @@ """The tests for the Dark Sky platform.""" from datetime import timedelta import re -import unittest -from unittest.mock import MagicMock, patch +from unittest.mock import patch import forecastio -from requests.exceptions import HTTPError -import requests_mock +from requests.exceptions import ConnectionError as ConnectError -from homeassistant.components.darksky import sensor as darksky -from homeassistant.setup import setup_component +from homeassistant.setup import async_setup_component -from tests.common import get_test_home_assistant, load_fixture +from tests.common import load_fixture VALID_CONFIG_MINIMAL = { "sensor": { @@ -69,140 +66,100 @@ INVALID_CONFIG_LANG = { } } -VALID_CONFIG_ALERTS = { - "sensor": { - "platform": "darksky", - "api_key": "foo", - "forecast": [1, 2], - "hourly_forecast": [1, 2], - "monitored_conditions": ["summary", "icon", "temperature_high", "alerts"], - "scan_interval": timedelta(seconds=120), - } -} +async def test_setup_with_config(hass, requests_mock): + """Test the platform setup with configuration.""" + with patch("homeassistant.components.darksky.sensor.forecastio.load_forecast"): + assert await async_setup_component(hass, "sensor", VALID_CONFIG_MINIMAL) + await hass.async_block_till_done() -def load_forecastMock(key, lat, lon, units, lang): # pylint: disable=invalid-name - """Mock darksky forecast loading.""" - return "" - - -class TestDarkSkySetup(unittest.TestCase): - """Test the Dark Sky platform.""" - - def add_entities(self, new_entities, update_before_add=False): - """Mock add entities.""" - if update_before_add: - for entity in new_entities: - entity.update() - - for entity in new_entities: - self.entities.append(entity) - - def setUp(self): - """Initialize values for this testcase class.""" - self.hass = get_test_home_assistant() - self.key = "foo" - self.lat = self.hass.config.latitude = 37.8267 - self.lon = self.hass.config.longitude = -122.423 - self.entities = [] - self.addCleanup(self.tear_down_cleanup) - - def tear_down_cleanup(self): - """Stop everything that was started.""" - self.hass.stop() - - @patch( - "homeassistant.components.darksky.sensor.forecastio.load_forecast", - new=load_forecastMock, - ) - def test_setup_with_config(self): - """Test the platform setup with configuration.""" - setup_component(self.hass, "sensor", VALID_CONFIG_MINIMAL) - self.hass.block_till_done() - - state = self.hass.states.get("sensor.dark_sky_summary") + state = hass.states.get("sensor.dark_sky_summary") assert state is not None - def test_setup_with_invalid_config(self): - """Test the platform setup with invalid configuration.""" - setup_component(self.hass, "sensor", INVALID_CONFIG_MINIMAL) - self.hass.block_till_done() - state = self.hass.states.get("sensor.dark_sky_summary") - assert state is None +async def test_setup_with_invalid_config(hass): + """Test the platform setup with invalid configuration.""" + assert await async_setup_component(hass, "sensor", INVALID_CONFIG_MINIMAL) + await hass.async_block_till_done() - @patch( - "homeassistant.components.darksky.sensor.forecastio.load_forecast", - new=load_forecastMock, - ) - def test_setup_with_language_config(self): - """Test the platform setup with language configuration.""" - setup_component(self.hass, "sensor", VALID_CONFIG_LANG_DE) - self.hass.block_till_done() + state = hass.states.get("sensor.dark_sky_summary") + assert state is None - state = self.hass.states.get("sensor.dark_sky_summary") + +async def test_setup_with_language_config(hass): + """Test the platform setup with language configuration.""" + with patch("homeassistant.components.darksky.sensor.forecastio.load_forecast"): + assert await async_setup_component(hass, "sensor", VALID_CONFIG_LANG_DE) + await hass.async_block_till_done() + + state = hass.states.get("sensor.dark_sky_summary") assert state is not None - def test_setup_with_invalid_language_config(self): - """Test the platform setup with language configuration.""" - setup_component(self.hass, "sensor", INVALID_CONFIG_LANG) - self.hass.block_till_done() - state = self.hass.states.get("sensor.dark_sky_summary") +async def test_setup_with_invalid_language_config(hass): + """Test the platform setup with language configuration.""" + assert await async_setup_component(hass, "sensor", INVALID_CONFIG_LANG) + await hass.async_block_till_done() + + state = hass.states.get("sensor.dark_sky_summary") + assert state is None + + +async def test_setup_bad_api_key(hass, requests_mock): + """Test for handling a bad API key.""" + # The Dark Sky API wrapper that we use raises an HTTP error + # when you try to use a bad (or no) API key. + url = "https://api.darksky.net/forecast/{}/{},{}?units=auto".format( + "foo", str(hass.config.latitude), str(hass.config.longitude) + ) + msg = f"400 Client Error: Bad Request for url: {url}" + requests_mock.get(url, text=msg, status_code=400) + + assert await async_setup_component( + hass, "sensor", {"sensor": {"platform": "darksky", "api_key": "foo"}} + ) + await hass.async_block_till_done() + + assert hass.states.get("sensor.dark_sky_summary") is None + + +async def test_connection_error(hass): + """Test setting up with a connection error.""" + with patch( + "homeassistant.components.darksky.sensor.forecastio.load_forecast", + side_effect=ConnectError(), + ): + await async_setup_component(hass, "sensor", VALID_CONFIG_MINIMAL) + await hass.async_block_till_done() + + state = hass.states.get("sensor.dark_sky_summary") assert state is None - @patch("forecastio.api.get_forecast") - def test_setup_bad_api_key(self, mock_get_forecast): - """Test for handling a bad API key.""" - # The Dark Sky API wrapper that we use raises an HTTP error - # when you try to use a bad (or no) API key. - url = "https://api.darksky.net/forecast/{}/{},{}?units=auto".format( - self.key, str(self.lat), str(self.lon) - ) - msg = f"400 Client Error: Bad Request for url: {url}" - mock_get_forecast.side_effect = HTTPError(msg) - response = darksky.setup_platform( - self.hass, VALID_CONFIG_MINIMAL["sensor"], MagicMock() - ) - assert not response - - @patch( - "homeassistant.components.darksky.sensor.forecastio.load_forecast", - new=load_forecastMock, - ) - def test_setup_with_alerts_config(self): - """Test the platform setup with alert configuration.""" - setup_component(self.hass, "sensor", VALID_CONFIG_ALERTS) - self.hass.block_till_done() - - state = self.hass.states.get("sensor.dark_sky_alerts") - assert state.state == "0" - - @requests_mock.Mocker() - @patch("forecastio.api.get_forecast", wraps=forecastio.api.get_forecast) - def test_setup(self, mock_req, mock_get_forecast): - """Test for successfully setting up the forecast.io platform.""" +async def test_setup(hass, requests_mock): + """Test for successfully setting up the forecast.io platform.""" + with patch( + "forecastio.api.get_forecast", wraps=forecastio.api.get_forecast + ) as mock_get_forecast: uri = ( r"https://api.(darksky.net|forecast.io)\/forecast\/(\w+)\/" r"(-?\d+\.?\d*),(-?\d+\.?\d*)" ) - mock_req.get(re.compile(uri), text=load_fixture("darksky.json")) + requests_mock.get(re.compile(uri), text=load_fixture("darksky.json")) - assert setup_component(self.hass, "sensor", VALID_CONFIG_MINIMAL) - self.hass.block_till_done() + assert await async_setup_component(hass, "sensor", VALID_CONFIG_MINIMAL) + await hass.async_block_till_done() - assert mock_get_forecast.called assert mock_get_forecast.call_count == 1 - assert len(self.hass.states.entity_ids()) == 13 + assert len(hass.states.async_entity_ids()) == 13 - state = self.hass.states.get("sensor.dark_sky_summary") + state = hass.states.get("sensor.dark_sky_summary") assert state is not None assert state.state == "Clear" assert state.attributes.get("friendly_name") == "Dark Sky Summary" - state = self.hass.states.get("sensor.dark_sky_alerts") + state = hass.states.get("sensor.dark_sky_alerts") assert state.state == "2" - state = self.hass.states.get("sensor.dark_sky_daytime_high_temperature_1d") + state = hass.states.get("sensor.dark_sky_daytime_high_temperature_1d") assert state is not None assert state.attributes.get("device_class") == "temperature" diff --git a/tests/components/darksky/test_weather.py b/tests/components/darksky/test_weather.py index 9a1b3912b87..4a982577d48 100644 --- a/tests/components/darksky/test_weather.py +++ b/tests/components/darksky/test_weather.py @@ -1,67 +1,50 @@ """The tests for the Dark Sky weather component.""" import re -import unittest from unittest.mock import patch import forecastio -from requests.exceptions import ConnectionError -import requests_mock +from requests.exceptions import ConnectionError as ConnectError from homeassistant.components import weather -from homeassistant.setup import setup_component -from homeassistant.util.unit_system import METRIC_SYSTEM +from homeassistant.setup import async_setup_component -from tests.common import get_test_home_assistant, load_fixture +from tests.common import load_fixture -class TestDarkSky(unittest.TestCase): - """Test the Dark Sky weather component.""" - - def setUp(self): - """Set up things to be run when tests are started.""" - self.hass = get_test_home_assistant() - self.hass.config.units = METRIC_SYSTEM - self.lat = self.hass.config.latitude = 37.8267 - self.lon = self.hass.config.longitude = -122.423 - self.addCleanup(self.tear_down_cleanup) - - def tear_down_cleanup(self): - """Stop down everything that was started.""" - self.hass.stop() - - @requests_mock.Mocker() - @patch("forecastio.api.get_forecast", wraps=forecastio.api.get_forecast) - def test_setup(self, mock_req, mock_get_forecast): - """Test for successfully setting up the forecast.io platform.""" - uri = ( - r"https://api.(darksky.net|forecast.io)\/forecast\/(\w+)\/" - r"(-?\d+\.?\d*),(-?\d+\.?\d*)" +async def test_setup(hass, requests_mock): + """Test for successfully setting up the forecast.io platform.""" + with patch( + "forecastio.api.get_forecast", wraps=forecastio.api.get_forecast + ) as mock_get_forecast: + requests_mock.get( + re.compile( + r"https://api.(darksky.net|forecast.io)\/forecast\/(\w+)\/" + r"(-?\d+\.?\d*),(-?\d+\.?\d*)" + ), + text=load_fixture("darksky.json"), ) - mock_req.get(re.compile(uri), text=load_fixture("darksky.json")) - assert setup_component( - self.hass, + assert await async_setup_component( + hass, weather.DOMAIN, {"weather": {"name": "test", "platform": "darksky", "api_key": "foo"}}, ) - self.hass.block_till_done() + await hass.async_block_till_done() - assert mock_get_forecast.called assert mock_get_forecast.call_count == 1 - - state = self.hass.states.get("weather.test") + state = hass.states.get("weather.test") assert state.state == "sunny" - @patch("forecastio.load_forecast", side_effect=ConnectionError()) - def test_failed_setup(self, mock_load_forecast): - """Test to ensure that a network error does not break component state.""" - assert setup_component( - self.hass, +async def test_failed_setup(hass): + """Test to ensure that a network error does not break component state.""" + with patch("forecastio.load_forecast", side_effect=ConnectError()): + assert await async_setup_component( + hass, weather.DOMAIN, {"weather": {"name": "test", "platform": "darksky", "api_key": "foo"}}, ) - self.hass.block_till_done() + await hass.async_block_till_done() - state = self.hass.states.get("weather.test") + state = hass.states.get("weather.test") assert state.state == "unavailable"