""" This tests requests for Air Purifiers. All tests inherit from the TestBase class which contains the fixtures and methods needed to run the tests. The tests are automatically parametrized by `pytest_generate_tests` in conftest.py. The two methods that are parametrized are `test_details` and `test_methods`. The class variables are used to build the list of devices, test methods and arguments. The `helpers.call_api` method is patched to return a mock response. The method, endpoint, headers and json arguments are recorded in YAML files in the api directory, categorized in folders by module and files by the class name. The default is to record requests that do not exist and compare requests that already exist. If the API changes, set the overwrite argument to True in order to overwrite the existing YAML file with the new request. See Also -------- `utils.TestBase` - Base class for all tests, containing mock objects `confest.pytest_generate_tests` - Parametrizes tests based on method names & class attributes `call_json_fans` - Contains API responses """ import logging import pytest import pyvesync.const as const from pyvesync.base_devices.purifier_base import VeSyncPurifier from base_test_cases import TestBase from utils import assert_test, parse_args import call_json_purifiers logger = logging.getLogger(__name__) logger.setLevel(logging.DEBUG) class TestAirPurifiers(TestBase): """Air Purifier testing class. This class tests Air Purifier device details and methods. The methods are parametrized from the class variables using `pytest_generate_tests`. The call_json_fans module contains the responses for the API requests. The device is instantiated from the details provided by `call_json.DeviceList.device_list_item()`. Inherits from `utils.TestBase`. Instance Attributes ------------------- self.manager : VeSync Instantiated VeSync object self.mock_api : Mock Mock with patched `helpers.call_api` method self.caplog : LogCaptureFixture Pytest fixture for capturing logs Class Attributes --------------- device : str Name of product class - air_purifiers air_purifiers : list List of setup_entry's for air purifiers, this variable is named after the device variable value base_methods : List[List[str, Dict[str, Any]]] List of common methods for all devices device_methods : Dict[List[List[str, Dict[str, Any]]]] Dictionary of methods specific to device types Methods -------- test_details() Test the device details API request and response test_methods() Test device methods API request and response Examples -------- >>> device = 'air_purifiers' >>> air_purifiers = call_json_fans.AIR_MODELS >>> base_methods = [['turn_on'], ['turn_off'], ['update']] >>> device_methods = { 'ESWD16': [['method1'], ['method2', {'kwargs': 'value'}]] } """ device = "air_purifiers" air_purifiers = call_json_purifiers.PURIFIER_MODELS base_methods = [ ["turn_on"], ["turn_off"], ["set_sleep_mode"], ["set_manual_mode"], ["set_fan_speed", {"speed": 3}], ] # TODO: Add timer tests device_methods = { "Core200S": [["set_sleep_mode"],], "Core300S": [["set_auto_mode"], ['set_sleep_mode'], ["turn_on_display"], ["turn_off_display"]], "Core400S": [["set_auto_mode"], ['set_sleep_mode'], ["turn_on_display"], ["turn_off_display"]], "Core600S": [["set_auto_mode"], ['set_sleep_mode'], ["turn_on_display"], ["turn_off_display"]], "LV-PUR131S": [["set_auto_mode"], ['set_sleep_mode'], ["turn_on_display"], ["turn_off_display"]], "LV-RH131S": [["set_auto_mode"], ['set_sleep_mode'], ["turn_on_display"], ["turn_off_display"]], "LAP-V102S": [["set_auto_mode"], ['set_sleep_mode'], ['set_pet_mode'], ["turn_on_display"], ["turn_off_display"]], "LAP-V201S": [["set_auto_mode"], ['set_sleep_mode'], ['set_pet_mode'], ["turn_on_display"], ["turn_off_display"]], "EL551S": [["set_auto_mode"], ["set_sleep_mode"], ["set_turbo_mode"], ["turn_on_display"], ["turn_off_display"]], "LAP-B851S-WUS": [["set_auto_mode"], ['set_sleep_mode'], ["turn_on_display"], ["turn_off_display"]], } def test_details(self, setup_entry, method): """Test the device details API request and response. This method is automatically parametrized by `pytest_generate_tests` based on class variables `device` (name of product class - air_purifiers), device name (air_purifiers) list of device types. Example: >>> device = 'air_purifiers' >>> air_purifiers = call_json_fans.AIR_MODELS See Also -------- `utils.TestBase` class docstring `call_json_fans` module docstring Notes ------ The device is instantiated using the `call_json.DeviceList.device_list_item()` method. The device details contain the default values set in `utils.Defaults` """ # Set return value for call_api based on call_json_fan.DETAILS_RESPONSES return_dict = call_json_purifiers.DETAILS_RESPONSES[setup_entry] return_val = (return_dict, 200) self.mock_api.return_value = return_val # Instantiate device from device list return item fan_obj = self.get_device("air_purifiers", setup_entry) assert isinstance(fan_obj, VeSyncPurifier) method_call = getattr(fan_obj, method) self.run_in_loop(method_call) # Test state attributes assert fan_obj.state.device_status == const.DeviceStatus.ON assert fan_obj.state.mode == call_json_purifiers.PurifierDefaults.purifier_mode assert fan_obj.state.fan_level == call_json_purifiers.PurifierDefaults.fan_level # Parse mock_api args tuple from arg, kwargs to kwargs all_kwargs = parse_args(self.mock_api) # Assert request matches recorded request or write new records assert assert_test( method_call, all_kwargs, setup_entry, self.write_api, self.overwrite ) def test_methods(self, setup_entry, method): """Test device methods API request and response. This method is automatically parametrized by `pytest_generate_tests` based on class variables `device` (name of product class - air_purifiers), device name (air_purifiers) list of setup_entry's, `base_methods` - list of methods for all devices, and `device_methods` - list of methods for each device type. Example: >>> base_methods = [['turn_on'], ['turn_off'], ['update']] >>> device_methods = { 'setup_entry': [['method1'], ['method2', {'kwargs': 'value'}]] } Notes ----- The response can be a callable that accepts the `kwargs` argument to sync the device response with the API response. In some cases the API returns data from the method call, such as `get_yearly_energy`, in other cases the API returns a simple confirmation the command was successful. See Also -------- `TestBase` class method `call_json_fans` module """ # TODO: FIX `clear_timer` recorded API request in yaml if method[0] == "clear_timer": pytest.skip("Incorrect clear_timer API request") # Get method name and kwargs from method fixture method_name = method[0] if len(method) == 2 and isinstance(method[1], dict): method_kwargs = method[1] else: method_kwargs = {} # Set return value for call_api based on call_json_fans.METHOD_RESPONSES method_response = call_json_purifiers.METHOD_RESPONSES[setup_entry][method_name] if callable(method_response): if method_kwargs: return_dict = method_response(method_kwargs) else: return_dict = method_response() else: return_dict = method_response self.mock_api.return_value = (return_dict, 200) # Get device configuration from call_json.DeviceList.device_list_item() fan_obj = self.get_device("air_purifiers", setup_entry) assert isinstance(fan_obj, VeSyncPurifier) # Get method from device object method_call = getattr(fan_obj, method_name) # Ensure method runs based on device configuration if method_name == "turn_on": fan_obj.state.device_status = const.DeviceStatus.OFF elif method_name == "turn_off": fan_obj.state.device_status = const.DeviceStatus.ON elif method_name == "set_fan_speed": fan_obj.state.mode = const.PurifierModes.MANUAL elif method_name in ["set_auto_mode", "set_sleep_mode", "set_pet_mode", "set_turbo_mode"]: fan_obj.state.mode = const.PurifierModes.MANUAL elif method_name == "set_manual_mode": fan_obj.state.mode = const.PurifierModes.AUTO elif method_name in ["turn_on_display"]: fan_obj.state.display_set_status = const.DeviceStatus.OFF elif method_name in ["turn_off_display"]: fan_obj.state.display_set_status = const.DeviceStatus.ON # Call method with kwargs if defined if method_kwargs: self.run_in_loop(method_call, **method_kwargs) else: self.run_in_loop(method_call) if method_name == "turn_on": assert fan_obj.state.device_status == const.DeviceStatus.ON elif method_name == "turn_off": assert fan_obj.state.device_status == const.DeviceStatus.OFF elif method_name == "set_fan_speed": assert fan_obj.state.fan_level == method_kwargs["speed"] elif method_name in ["set_auto_mode"]: assert fan_obj.state.mode == const.PurifierModes.AUTO elif method_name in ["set_sleep_mode"]: assert fan_obj.state.mode == const.PurifierModes.SLEEP elif method_name in ["set_pet_mode"]: assert fan_obj.state.mode == const.PurifierModes.PET elif method_name in ["set_turbo_mode"]: assert fan_obj.state.mode == const.PurifierModes.TURBO elif method_name in ["turn_on_display"]: assert fan_obj.state.display_set_status == const.DeviceStatus.ON elif method_name in ["turn_off_display"]: assert fan_obj.state.display_set_status == const.DeviceStatus.OFF # Parse arguments from mock_api call into a dictionary all_kwargs = parse_args(self.mock_api) # Assert request matches recorded request or write new records assert assert_test( method_call, all_kwargs, setup_entry, self.write_api, self.overwrite )