core/tests/components/frontend/test_storage.py

"""The tests for frontend storage."""
import pytest

from homeassistant.setup import async_setup_component
from homeassistant.components.frontend import storage


@pytest.fixture(autouse=True)
def setup_frontend(hass):
    """Fixture to setup the frontend."""
    hass.loop.run_until_complete(async_setup_component(hass, 'frontend', {}))


async def test_get_user_data_empty(hass, hass_ws_client, hass_storage):
    """Test get_user_data command."""
    client = await hass_ws_client(hass)

    await client.send_json({
        'id': 5,
        'type': 'frontend/get_user_data',
        'key': 'non-existing-key',
    })

    res = await client.receive_json()
    assert res['success'], res
    assert res['result']['value'] is None


async def test_get_user_data(hass, hass_ws_client, hass_admin_user,
                             hass_storage):
    """Test get_user_data command."""
    storage_key = storage.STORAGE_KEY_USER_DATA.format(hass_admin_user.id)
    hass_storage[storage_key] = {
        'key': storage_key,
        'version': 1,
        'data': {
            'test-key': 'test-value',
            'test-complex': [{'foo': 'bar'}]
        }
    }

    client = await hass_ws_client(hass)

    # Get a simple string key

    await client.send_json({
        'id': 6,
        'type': 'frontend/get_user_data',
        'key': 'test-key',
    })

    res = await client.receive_json()
    assert res['success'], res
    assert res['result']['value'] == 'test-value'

    # Get a more complex key

    await client.send_json({
        'id': 7,
        'type': 'frontend/get_user_data',
        'key': 'test-complex',
    })

    res = await client.receive_json()
    assert res['success'], res
    assert res['result']['value'][0]['foo'] == 'bar'

    # Get all data (no key)

    await client.send_json({
        'id': 8,
        'type': 'frontend/get_user_data',
    })

    res = await client.receive_json()
    assert res['success'], res
    assert res['result']['value']['test-key'] == 'test-value'
    assert res['result']['value']['test-complex'][0]['foo'] == 'bar'


async def test_set_user_data_empty(hass, hass_ws_client, hass_storage):
    """Test set_user_data command."""
    client = await hass_ws_client(hass)

    # test creating

    await client.send_json({
        'id': 6,
        'type': 'frontend/get_user_data',
        'key': 'test-key',
    })

    res = await client.receive_json()
    assert res['success'], res
    assert res['result']['value'] is None

    await client.send_json({
        'id': 7,
        'type': 'frontend/set_user_data',
        'key': 'test-key',
        'value': 'test-value'
    })

    res = await client.receive_json()
    assert res['success'], res

    await client.send_json({
        'id': 8,
        'type': 'frontend/get_user_data',
        'key': 'test-key',
    })

    res = await client.receive_json()
    assert res['success'], res
    assert res['result']['value'] == 'test-value'


async def test_set_user_data(hass, hass_ws_client, hass_storage,
                             hass_admin_user):
    """Test set_user_data command with initial data."""
    storage_key = storage.STORAGE_KEY_USER_DATA.format(hass_admin_user.id)
    hass_storage[storage_key] = {
        'version': 1,
        'data': {
            'test-key': 'test-value',
            'test-complex': 'string',
        }
    }

    client = await hass_ws_client(hass)

    # test creating

    await client.send_json({
        'id': 5,
        'type': 'frontend/set_user_data',
        'key': 'test-non-existent-key',
        'value': 'test-value-new'
    })

    res = await client.receive_json()
    assert res['success'], res

    await client.send_json({
        'id': 6,
        'type': 'frontend/get_user_data',
        'key': 'test-non-existent-key',
    })

    res = await client.receive_json()
    assert res['success'], res
    assert res['result']['value'] == 'test-value-new'

    # test updating with complex data

    await client.send_json({
        'id': 7,
        'type': 'frontend/set_user_data',
        'key': 'test-complex',
        'value': [{'foo': 'bar'}]
    })

    res = await client.receive_json()
    assert res['success'], res

    await client.send_json({
        'id': 8,
        'type': 'frontend/get_user_data',
        'key': 'test-complex',
    })

    res = await client.receive_json()
    assert res['success'], res
    assert res['result']['value'][0]['foo'] == 'bar'

    # ensure other existing key was not modified

    await client.send_json({
        'id': 9,
        'type': 'frontend/get_user_data',
        'key': 'test-key',
    })

    res = await client.receive_json()
    assert res['success'], res
    assert res['result']['value'] == 'test-value'