Add local auth provider (#14365)
* Add local auth provider * Lint * Docstring
This commit is contained in:
1 parent
6e831138b4
commit
ea01b127c2
7 files changed
+501
-36
No files matched your search
@@ -0,0 +1,124 @@
|
||||
"""Test the Home Assistant local auth provider."""
|
||||
from unittest.mock import patch, mock_open
|
||||
|
||||
import pytest
|
||||
|
||||
from homeassistant import data_entry_flow
|
||||
from homeassistant.auth_providers import homeassistant as hass_auth
|
||||
|
||||
|
||||
MOCK_PATH = '/bla/users.json'
|
||||
JSON__OPEN_PATH = 'homeassistant.util.json.open'
|
||||
|
||||
|
||||
def test_initialize_empty_config_file_not_found():
|
||||
"""Test that we initialize an empty config."""
|
||||
with patch('homeassistant.util.json.open', side_effect=FileNotFoundError):
|
||||
data = hass_auth.load_data(MOCK_PATH)
|
||||
|
||||
assert data is not None
|
||||
|
||||
|
||||
def test_adding_user():
|
||||
"""Test adding a user."""
|
||||
data = hass_auth.Data(MOCK_PATH, None)
|
||||
data.add_user('test-user', 'test-pass')
|
||||
data.validate_login('test-user', 'test-pass')
|
||||
|
||||
|
||||
def test_adding_user_duplicate_username():
|
||||
"""Test adding a user."""
|
||||
data = hass_auth.Data(MOCK_PATH, None)
|
||||
data.add_user('test-user', 'test-pass')
|
||||
with pytest.raises(hass_auth.InvalidUser):
|
||||
data.add_user('test-user', 'other-pass')
|
||||
|
||||
|
||||
def test_validating_password_invalid_user():
|
||||
"""Test validating an invalid user."""
|
||||
data = hass_auth.Data(MOCK_PATH, None)
|
||||
|
||||
with pytest.raises(hass_auth.InvalidAuth):
|
||||
data.validate_login('non-existing', 'pw')
|
||||
|
||||
|
||||
def test_validating_password_invalid_password():
|
||||
"""Test validating an invalid user."""
|
||||
data = hass_auth.Data(MOCK_PATH, None)
|
||||
data.add_user('test-user', 'test-pass')
|
||||
|
||||
with pytest.raises(hass_auth.InvalidAuth):
|
||||
data.validate_login('test-user', 'invalid-pass')
|
||||
|
||||
|
||||
def test_changing_password():
|
||||
"""Test adding a user."""
|
||||
user = 'test-user'
|
||||
data = hass_auth.Data(MOCK_PATH, None)
|
||||
data.add_user(user, 'test-pass')
|
||||
data.change_password(user, 'new-pass')
|
||||
|
||||
with pytest.raises(hass_auth.InvalidAuth):
|
||||
data.validate_login(user, 'test-pass')
|
||||
|
||||
data.validate_login(user, 'new-pass')
|
||||
|
||||
|
||||
def test_changing_password_raises_invalid_user():
|
||||
"""Test that we initialize an empty config."""
|
||||
data = hass_auth.Data(MOCK_PATH, None)
|
||||
|
||||
with pytest.raises(hass_auth.InvalidUser):
|
||||
data.change_password('non-existing', 'pw')
|
||||
|
||||
|
||||
async def test_login_flow_validates(hass):
|
||||
"""Test login flow."""
|
||||
data = hass_auth.Data(MOCK_PATH, None)
|
||||
data.add_user('test-user', 'test-pass')
|
||||
|
||||
provider = hass_auth.HassAuthProvider(hass, None, {})
|
||||
flow = hass_auth.LoginFlow(provider)
|
||||
result = await flow.async_step_init()
|
||||
assert result['type'] == data_entry_flow.RESULT_TYPE_FORM
|
||||
|
||||
with patch.object(provider, '_auth_data', return_value=data):
|
||||
result = await flow.async_step_init({
|
||||
'username': 'incorrect-user',
|
||||
'password': 'test-pass',
|
||||
})
|
||||
assert result['type'] == data_entry_flow.RESULT_TYPE_FORM
|
||||
assert result['errors']['base'] == 'invalid_auth'
|
||||
|
||||
result = await flow.async_step_init({
|
||||
'username': 'test-user',
|
||||
'password': 'incorrect-pass',
|
||||
})
|
||||
assert result['type'] == data_entry_flow.RESULT_TYPE_FORM
|
||||
assert result['errors']['base'] == 'invalid_auth'
|
||||
|
||||
result = await flow.async_step_init({
|
||||
'username': 'test-user',
|
||||
'password': 'test-pass',
|
||||
})
|
||||
assert result['type'] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
|
||||
|
||||
|
||||
async def test_saving_loading(hass):
|
||||
"""Test saving and loading JSON."""
|
||||
data = hass_auth.Data(MOCK_PATH, None)
|
||||
data.add_user('test-user', 'test-pass')
|
||||
data.add_user('second-user', 'second-pass')
|
||||
|
||||
with patch(JSON__OPEN_PATH, mock_open(), create=True) as mock_write:
|
||||
await hass.async_add_job(data.save)
|
||||
|
||||
# Mock open calls are: open file, context enter, write, context leave
|
||||
written = mock_write.mock_calls[2][1][0]
|
||||
|
||||
with patch('os.path.isfile', return_value=True), \
|
||||
patch(JSON__OPEN_PATH, mock_open(read_data=written), create=True):
|
||||
await hass.async_add_job(hass_auth.load_data, MOCK_PATH)
|
||||
|
||||
data.validate_login('test-user', 'test-pass')
|
||||
data.validate_login('second-user', 'second-pass')
|
||||
@@ -19,7 +19,7 @@ def store():
|
||||
@pytest.fixture
|
||||
def provider(store):
|
||||
"""Mock provider."""
|
||||
return insecure_example.ExampleAuthProvider(store, {
|
||||
return insecure_example.ExampleAuthProvider(None, store, {
|
||||
'type': 'insecure_example',
|
||||
'users': [
|
||||
{
|
||||
@@ -64,20 +64,16 @@ async def test_match_existing_credentials(store, provider):
|
||||
|
||||
async def test_verify_username(provider):
|
||||
"""Test we raise if incorrect user specified."""
|
||||
with pytest.raises(auth.InvalidUser):
|
||||
await provider.async_get_or_create_credentials({
|
||||
'username': 'non-existing-user',
|
||||
'password': 'password-test',
|
||||
})
|
||||
with pytest.raises(insecure_example.InvalidAuthError):
|
||||
await provider.async_validate_login(
|
||||
'non-existing-user', 'password-test')
|
||||
|
||||
|
||||
async def test_verify_password(provider):
|
||||
"""Test we raise if incorrect user specified."""
|
||||
with pytest.raises(auth.InvalidPassword):
|
||||
await provider.async_get_or_create_credentials({
|
||||
'username': 'user-test',
|
||||
'password': 'incorrect-password',
|
||||
})
|
||||
with pytest.raises(insecure_example.InvalidAuthError):
|
||||
await provider.async_validate_login(
|
||||
'user-test', 'incorrect-password')
|
||||
|
||||
|
||||
async def test_utf_8_username_password(provider):
|
||||
|
||||
@@ -0,0 +1,100 @@
|
||||
"""Test the auth script to manage local users."""
|
||||
from unittest.mock import Mock, patch
|
||||
|
||||
import pytest
|
||||
|
||||
from homeassistant.scripts import auth as script_auth
|
||||
from homeassistant.auth_providers import homeassistant as hass_auth
|
||||
|
||||
MOCK_PATH = '/bla/users.json'
|
||||
|
||||
|
||||
def test_list_user(capsys):
|
||||
"""Test we can list users."""
|
||||
data = hass_auth.Data(MOCK_PATH, None)
|
||||
data.add_user('test-user', 'test-pass')
|
||||
data.add_user('second-user', 'second-pass')
|
||||
|
||||
script_auth.list_users(data, None)
|
||||
|
||||
captured = capsys.readouterr()
|
||||
|
||||
assert captured.out == '\n'.join([
|
||||
'test-user',
|
||||
'second-user',
|
||||
'',
|
||||
'Total users: 2',
|
||||
''
|
||||
])
|
||||
|
||||
|
||||
def test_add_user(capsys):
|
||||
"""Test we can add a user."""
|
||||
data = hass_auth.Data(MOCK_PATH, None)
|
||||
|
||||
with patch.object(data, 'save') as mock_save:
|
||||
script_auth.add_user(
|
||||
data, Mock(username='paulus', password='test-pass'))
|
||||
|
||||
assert len(mock_save.mock_calls) == 1
|
||||
|
||||
captured = capsys.readouterr()
|
||||
assert captured.out == 'User created\n'
|
||||
|
||||
assert len(data.users) == 1
|
||||
data.validate_login('paulus', 'test-pass')
|
||||
|
||||
|
||||
def test_validate_login(capsys):
|
||||
"""Test we can validate a user login."""
|
||||
data = hass_auth.Data(MOCK_PATH, None)
|
||||
data.add_user('test-user', 'test-pass')
|
||||
|
||||
script_auth.validate_login(
|
||||
data, Mock(username='test-user', password='test-pass'))
|
||||
captured = capsys.readouterr()
|
||||
assert captured.out == 'Auth valid\n'
|
||||
|
||||
script_auth.validate_login(
|
||||
data, Mock(username='test-user', password='invalid-pass'))
|
||||
captured = capsys.readouterr()
|
||||
assert captured.out == 'Auth invalid\n'
|
||||
|
||||
script_auth.validate_login(
|
||||
data, Mock(username='invalid-user', password='test-pass'))
|
||||
captured = capsys.readouterr()
|
||||
assert captured.out == 'Auth invalid\n'
|
||||
|
||||
|
||||
def test_change_password(capsys):
|
||||
"""Test we can change a password."""
|
||||
data = hass_auth.Data(MOCK_PATH, None)
|
||||
data.add_user('test-user', 'test-pass')
|
||||
|
||||
with patch.object(data, 'save') as mock_save:
|
||||
script_auth.change_password(
|
||||
data, Mock(username='test-user', new_password='new-pass'))
|
||||
|
||||
assert len(mock_save.mock_calls) == 1
|
||||
captured = capsys.readouterr()
|
||||
assert captured.out == 'Password changed\n'
|
||||
data.validate_login('test-user', 'new-pass')
|
||||
with pytest.raises(hass_auth.InvalidAuth):
|
||||
data.validate_login('test-user', 'test-pass')
|
||||
|
||||
|
||||
def test_change_password_invalid_user(capsys):
|
||||
"""Test changing password of non-existing user."""
|
||||
data = hass_auth.Data(MOCK_PATH, None)
|
||||
data.add_user('test-user', 'test-pass')
|
||||
|
||||
with patch.object(data, 'save') as mock_save:
|
||||
script_auth.change_password(
|
||||
data, Mock(username='invalid-user', new_password='new-pass'))
|
||||
|
||||
assert len(mock_save.mock_calls) == 0
|
||||
captured = capsys.readouterr()
|
||||
assert captured.out == 'User not found\n'
|
||||
data.validate_login('test-user', 'test-pass')
|
||||
with pytest.raises(hass_auth.InvalidAuth):
|
||||
data.validate_login('invalid-user', 'new-pass')
|
||||
Reference in new issue
Block a user