"""Test blueprint importing.""" import json from pathlib import Path import pytest from homeassistant.components.blueprint import importer from homeassistant.exceptions import HomeAssistantError from tests.common import load_fixture @pytest.fixture(scope="session") def community_post(): """Topic JSON with a codeblock marked as auto syntax.""" return load_fixture("blueprint/community_post.json") COMMUNITY_POST_INPUTS = { "remote": { "name": "Remote", "description": "IKEA remote to use", "selector": { "device": { "integration": "zha", "manufacturer": "IKEA of Sweden", "model": "TRADFRI remote control", "multiple": False, } }, }, "light": { "name": "Light(s)", "description": "The light(s) to control", "selector": {"target": {"entity": {"domain": "light"}}}, }, "force_brightness": { "name": "Force turn on brightness", "description": 'Force the brightness to the set level below, when the "on" button on the remote is pushed and lights turn on.\n', "default": False, "selector": {"boolean": {}}, }, "brightness": { "name": "Brightness", "description": "Brightness of the light(s) when turning on", "default": 50, "selector": { "number": { "min": 0.0, "max": 100.0, "mode": "slider", "step": 1.0, "unit_of_measurement": "%", } }, }, "button_left_short": { "name": "Left button - short press", "description": "Action to run on short left button press", "default": [], "selector": {"action": {}}, }, "button_left_long": { "name": "Left button - long press", "description": "Action to run on long left button press", "default": [], "selector": {"action": {}}, }, "button_right_short": { "name": "Right button - short press", "description": "Action to run on short right button press", "default": [], "selector": {"action": {}}, }, "button_right_long": { "name": "Right button - long press", "description": "Action to run on long right button press", "default": [], "selector": {"action": {}}, }, } def test_get_community_post_import_url(): """Test variations of generating import forum url.""" assert ( importer._get_community_post_import_url( "https://community.home-assistant.io/t/test-topic/123" ) == "https://community.home-assistant.io/t/test-topic/123.json" ) assert ( importer._get_community_post_import_url( "https://community.home-assistant.io/t/test-topic/123/2" ) == "https://community.home-assistant.io/t/test-topic/123.json" ) def test_get_github_import_url(): """Test getting github import url.""" assert ( importer._get_github_import_url( "https://github.com/balloob/home-assistant-config/blob/main/blueprints/automation/motion_light.yaml" ) == "https://raw.githubusercontent.com/balloob/home-assistant-config/main/blueprints/automation/motion_light.yaml" ) assert ( importer._get_github_import_url( "https://raw.githubusercontent.com/balloob/home-assistant-config/main/blueprints/automation/motion_light.yaml" ) == "https://raw.githubusercontent.com/balloob/home-assistant-config/main/blueprints/automation/motion_light.yaml" ) def test_extract_blueprint_from_community_topic(community_post): """Test extracting blueprint.""" imported_blueprint = importer._extract_blueprint_from_community_topic( "http://example.com", json.loads(community_post) ) assert imported_blueprint is not None assert imported_blueprint.blueprint.domain == "automation" assert imported_blueprint.blueprint.inputs == COMMUNITY_POST_INPUTS def test_extract_blueprint_from_community_topic_invalid_yaml(): """Test extracting blueprint with invalid YAML.""" with pytest.raises(HomeAssistantError): importer._extract_blueprint_from_community_topic( "http://example.com", { "post_stream": { "posts": [ {"cooked": 'invalid: yaml: 2'} ] } }, ) def test_extract_blueprint_from_community_topic_wrong_lang(): """Test extracting blueprint with invalid YAML.""" with pytest.raises(importer.HomeAssistantError): assert importer._extract_blueprint_from_community_topic( "http://example.com", { "post_stream": { "posts": [ {"cooked": 'invalid yaml + 2'} ] } }, ) async def test_fetch_blueprint_from_community_url(hass, aioclient_mock, community_post): """Test fetching blueprint from url.""" aioclient_mock.get( "https://community.home-assistant.io/t/test-topic/123.json", text=community_post ) imported_blueprint = await importer.fetch_blueprint_from_url( hass, "https://community.home-assistant.io/t/test-topic/123/2" ) assert isinstance(imported_blueprint, importer.ImportedBlueprint) assert imported_blueprint.blueprint.domain == "automation" assert imported_blueprint.blueprint.inputs == COMMUNITY_POST_INPUTS assert ( imported_blueprint.suggested_filename == "frenck/zha-ikea-five-button-remote-for-lights" ) assert ( imported_blueprint.blueprint.metadata["source_url"] == "https://community.home-assistant.io/t/test-topic/123/2" ) assert "gt;" not in imported_blueprint.raw_data @pytest.mark.parametrize( "url", ( "https://raw.githubusercontent.com/balloob/home-assistant-config/main/blueprints/automation/motion_light.yaml", "https://github.com/balloob/home-assistant-config/blob/main/blueprints/automation/motion_light.yaml", ), ) async def test_fetch_blueprint_from_github_url(hass, aioclient_mock, url): """Test fetching blueprint from url.""" aioclient_mock.get( "https://raw.githubusercontent.com/balloob/home-assistant-config/main/blueprints/automation/motion_light.yaml", text=Path( hass.config.path("blueprints/automation/test_event_service.yaml") ).read_text(), ) imported_blueprint = await importer.fetch_blueprint_from_url(hass, url) assert isinstance(imported_blueprint, importer.ImportedBlueprint) assert imported_blueprint.blueprint.domain == "automation" assert imported_blueprint.blueprint.inputs == { "service_to_call": None, "trigger_event": {"selector": {"text": {}}}, } assert imported_blueprint.suggested_filename == "balloob/motion_light" assert imported_blueprint.blueprint.metadata["source_url"] == url async def test_fetch_blueprint_from_github_gist_url(hass, aioclient_mock): """Test fetching blueprint from url.""" aioclient_mock.get( "https://api.github.com/gists/e717ce85dd0d2f1bdcdfc884ea25a344", text=load_fixture("blueprint/github_gist.json"), ) url = "https://gist.github.com/balloob/e717ce85dd0d2f1bdcdfc884ea25a344" imported_blueprint = await importer.fetch_blueprint_from_url(hass, url) assert isinstance(imported_blueprint, importer.ImportedBlueprint) assert imported_blueprint.blueprint.domain == "automation" assert imported_blueprint.blueprint.inputs == { "motion_entity": { "name": "Motion Sensor", "selector": { "entity": { "domain": "binary_sensor", "device_class": "motion", "multiple": False, } }, }, "light_entity": { "name": "Light", "selector": {"entity": {"domain": "light", "multiple": False}}, }, } assert imported_blueprint.suggested_filename == "balloob/motion_light" assert imported_blueprint.blueprint.metadata["source_url"] == url