mirror of
https://github.com/home-assistant/supervisor.git
synced 2025-11-09 19:09:41 +00:00
99c040520e
* Drop ensure_builtin_repositories With the new Repository classes we have the is_builtin property, so we can easily make sure that built-ins are not removed. This allows us to further cleanup the code by removing the ensure_builtin_repositories function and the ALL_BUILTIN_REPOSITORIES constant. * Make sure we add built-ins on load * Reuse default set and avoid unnecessary copy Reuse default set and avoid unnecessary copying during validation if the default is not being used.
361 lines
12 KiB
Python
361 lines
12 KiB
Python
"""Test add custom repository."""
|
|
|
|
import json
|
|
from unittest.mock import PropertyMock, patch
|
|
|
|
import pytest
|
|
|
|
from supervisor.addons.addon import Addon
|
|
from supervisor.coresys import CoreSys
|
|
from supervisor.exceptions import (
|
|
StoreError,
|
|
StoreGitCloneError,
|
|
StoreGitError,
|
|
StoreJobError,
|
|
StoreNotFound,
|
|
)
|
|
from supervisor.resolution.const import SuggestionType
|
|
from supervisor.store import StoreManager
|
|
from supervisor.store.addon import AddonStore
|
|
from supervisor.store.const import BuiltinRepository
|
|
from supervisor.store.repository import Repository
|
|
|
|
|
|
def get_repository_by_url(store_manager: StoreManager, url: str) -> Repository:
|
|
"""Test helper to get repository by URL."""
|
|
for repository in store_manager.all:
|
|
if repository.source == url:
|
|
return repository
|
|
raise StoreNotFound()
|
|
|
|
|
|
@pytest.fixture(autouse=True)
|
|
def _auto_supervisor_internet(supervisor_internet):
|
|
# Use the supervisor_internet fixture to ensure that all tests has internet access
|
|
pass
|
|
|
|
|
|
@pytest.mark.parametrize("use_update", [True, False])
|
|
async def test_add_valid_repository(
|
|
coresys: CoreSys, store_manager: StoreManager, use_update: bool
|
|
):
|
|
"""Test add custom repository."""
|
|
current = coresys.store.repository_urls
|
|
with (
|
|
patch("supervisor.store.git.GitRepo.load", return_value=None),
|
|
patch(
|
|
"supervisor.utils.common.read_yaml_file",
|
|
return_value={"name": "Awesome repository"},
|
|
),
|
|
patch("pathlib.Path.exists", return_value=True),
|
|
):
|
|
if use_update:
|
|
await store_manager.update_repositories(
|
|
set(current) | {"http://example.com"}
|
|
)
|
|
else:
|
|
await store_manager.add_repository("http://example.com")
|
|
|
|
assert get_repository_by_url(store_manager, "http://example.com").validate()
|
|
|
|
assert "http://example.com" in coresys.store.repository_urls
|
|
|
|
|
|
async def test_add_invalid_repository(coresys: CoreSys, store_manager: StoreManager):
|
|
"""Test add invalid custom repository."""
|
|
current = coresys.store.repository_urls
|
|
with (
|
|
patch("supervisor.store.git.GitRepo.load", return_value=None),
|
|
patch(
|
|
"pathlib.Path.read_text",
|
|
return_value="",
|
|
),
|
|
):
|
|
await store_manager.update_repositories(
|
|
set(current) | {"http://example.com"}, issue_on_error=True
|
|
)
|
|
|
|
assert not await get_repository_by_url(
|
|
store_manager, "http://example.com"
|
|
).validate()
|
|
|
|
assert "http://example.com" in coresys.store.repository_urls
|
|
assert coresys.resolution.suggestions[-1].type == SuggestionType.EXECUTE_REMOVE
|
|
|
|
|
|
@pytest.mark.parametrize("use_update", [True, False])
|
|
async def test_error_on_invalid_repository(
|
|
coresys: CoreSys, store_manager: StoreManager, use_update
|
|
):
|
|
"""Test invalid repository not added."""
|
|
current = coresys.store.repository_urls
|
|
with (
|
|
patch("supervisor.store.git.GitRepo.load", return_value=None),
|
|
patch(
|
|
"pathlib.Path.read_text",
|
|
return_value="",
|
|
),
|
|
pytest.raises(StoreError),
|
|
):
|
|
if use_update:
|
|
await store_manager.update_repositories(
|
|
set(current) | {"http://example.com"}
|
|
)
|
|
else:
|
|
await store_manager.add_repository("http://example.com")
|
|
|
|
assert "http://example.com" not in coresys.store.repository_urls
|
|
assert len(coresys.resolution.suggestions) == 0
|
|
|
|
|
|
async def test_add_invalid_repository_file(
|
|
coresys: CoreSys, store_manager: StoreManager
|
|
):
|
|
"""Test add invalid custom repository file."""
|
|
current = coresys.store.repository_urls
|
|
with (
|
|
patch("supervisor.store.git.GitRepo.load", return_value=None),
|
|
patch(
|
|
"pathlib.Path.read_text",
|
|
return_value=json.dumps({"name": "Awesome repository"}),
|
|
),
|
|
patch("pathlib.Path.exists", return_value=False),
|
|
):
|
|
await store_manager.update_repositories(
|
|
set(current) | {"http://example.com"}, issue_on_error=True
|
|
)
|
|
|
|
assert not await get_repository_by_url(
|
|
store_manager, "http://example.com"
|
|
).validate()
|
|
|
|
assert "http://example.com" in coresys.store.repository_urls
|
|
assert coresys.resolution.suggestions[-1].type == SuggestionType.EXECUTE_REMOVE
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"git_error,suggestion_type",
|
|
[
|
|
(StoreGitCloneError(), SuggestionType.EXECUTE_REMOVE),
|
|
(StoreGitError(), SuggestionType.EXECUTE_RESET),
|
|
],
|
|
)
|
|
async def test_add_repository_with_git_error(
|
|
coresys: CoreSys,
|
|
store_manager: StoreManager,
|
|
git_error: StoreGitError,
|
|
suggestion_type: SuggestionType,
|
|
):
|
|
"""Test repo added with issue on git error."""
|
|
current = coresys.store.repository_urls
|
|
with patch("supervisor.store.git.GitRepo.load", side_effect=git_error):
|
|
await store_manager.update_repositories(
|
|
set(current) | {"http://example.com"}, issue_on_error=True
|
|
)
|
|
|
|
assert "http://example.com" in coresys.store.repository_urls
|
|
assert coresys.resolution.suggestions[-1].type == suggestion_type
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"use_update,git_error",
|
|
[
|
|
(True, StoreGitCloneError()),
|
|
(True, StoreGitError()),
|
|
(False, StoreGitCloneError()),
|
|
(False, StoreGitError()),
|
|
],
|
|
)
|
|
async def test_error_on_repository_with_git_error(
|
|
coresys: CoreSys,
|
|
store_manager: StoreManager,
|
|
use_update: bool,
|
|
git_error: StoreGitError,
|
|
):
|
|
"""Test repo not added on git error."""
|
|
current = coresys.store.repository_urls
|
|
with (
|
|
patch("supervisor.store.git.GitRepo.load", side_effect=git_error),
|
|
pytest.raises(StoreError),
|
|
):
|
|
if use_update:
|
|
await store_manager.update_repositories(
|
|
set(current) | {"http://example.com"}
|
|
)
|
|
else:
|
|
await store_manager.add_repository("http://example.com")
|
|
|
|
assert "http://example.com" not in coresys.store.repository_urls
|
|
assert len(coresys.resolution.suggestions) == 0
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_preinstall_valid_repository(
|
|
coresys: CoreSys, store_manager: StoreManager
|
|
):
|
|
"""Test add core repository valid."""
|
|
with patch("supervisor.store.git.GitRepo.load", return_value=None):
|
|
await store_manager.update_repositories(
|
|
{repo.value for repo in BuiltinRepository}
|
|
)
|
|
|
|
def validate():
|
|
assert store_manager.get("core").validate()
|
|
assert store_manager.get("local").validate()
|
|
assert store_manager.get("a0d7b954").validate()
|
|
assert store_manager.get("5c53de3b").validate()
|
|
assert store_manager.get("d5369777").validate()
|
|
|
|
await coresys.run_in_executor(validate)
|
|
|
|
|
|
@pytest.mark.parametrize("use_update", [True, False])
|
|
async def test_remove_repository(
|
|
coresys: CoreSys,
|
|
store_manager: StoreManager,
|
|
test_repository: Repository,
|
|
use_update: bool,
|
|
):
|
|
"""Test removing a custom repository."""
|
|
assert test_repository.source in coresys.store.repository_urls
|
|
assert test_repository.slug in coresys.store.repositories
|
|
|
|
if use_update:
|
|
await store_manager.update_repositories(set())
|
|
else:
|
|
await store_manager.remove_repository(test_repository)
|
|
|
|
assert test_repository.source not in coresys.store.repository_urls
|
|
assert test_repository.slug not in coresys.addons.store
|
|
assert test_repository.slug not in coresys.store.repositories
|
|
|
|
|
|
@pytest.mark.parametrize("use_update", [True, False])
|
|
async def test_remove_used_repository(
|
|
coresys: CoreSys,
|
|
store_manager: StoreManager,
|
|
store_addon: AddonStore,
|
|
use_update: bool,
|
|
):
|
|
"""Test removing used custom repository."""
|
|
await coresys.addons.data.install(store_addon)
|
|
addon = Addon(coresys, store_addon.slug)
|
|
coresys.addons.local[addon.slug] = addon
|
|
|
|
assert store_addon.repository in coresys.store.repositories
|
|
|
|
with pytest.raises(
|
|
StoreError,
|
|
match="Can't remove 'https://github.com/awesome-developer/awesome-repo'. It's used by installed add-ons",
|
|
):
|
|
if use_update:
|
|
await store_manager.update_repositories(set())
|
|
else:
|
|
await store_manager.remove_repository(
|
|
coresys.store.repositories[store_addon.repository]
|
|
)
|
|
|
|
|
|
async def test_update_partial_error(coresys: CoreSys, store_manager: StoreManager):
|
|
"""Test partial error on update does partial save and errors."""
|
|
with patch("supervisor.store.repository.RepositoryGit.validate", return_value=True):
|
|
with patch("supervisor.store.git.GitRepo.load", return_value=None):
|
|
await store_manager.update_repositories(set())
|
|
|
|
store_manager.data.update.assert_called_once()
|
|
store_manager.data.update.reset_mock()
|
|
|
|
current = coresys.store.repository_urls
|
|
initial = len(current)
|
|
|
|
with (
|
|
patch(
|
|
"supervisor.store.git.GitRepo.load",
|
|
side_effect=[None, StoreGitError()],
|
|
),
|
|
pytest.raises(StoreError),
|
|
):
|
|
await store_manager.update_repositories(
|
|
set(current) | {"http://example.com", "http://example2.com"}
|
|
)
|
|
|
|
assert len(coresys.store.repository_urls) == initial + 1
|
|
store_manager.data.update.assert_called_once()
|
|
|
|
|
|
async def test_error_adding_duplicate(
|
|
coresys: CoreSys, store_manager: StoreManager, test_repository: Repository
|
|
):
|
|
"""Test adding a duplicate repository causes an error."""
|
|
assert test_repository.source in coresys.store.repository_urls
|
|
with (
|
|
patch("supervisor.store.repository.RepositoryGit.validate", return_value=True),
|
|
patch("supervisor.store.git.GitRepo.load", return_value=None),
|
|
pytest.raises(StoreError),
|
|
):
|
|
await store_manager.add_repository(test_repository.source)
|
|
|
|
|
|
async def test_add_with_update_repositories(
|
|
coresys: CoreSys, store_manager: StoreManager, test_repository: Repository
|
|
):
|
|
"""Test adding repositories to existing ones using update."""
|
|
assert test_repository.source in coresys.store.repository_urls
|
|
assert "http://example.com" not in coresys.store.repository_urls
|
|
|
|
with (
|
|
patch("supervisor.store.git.GitRepo.load", return_value=None),
|
|
patch(
|
|
"supervisor.utils.common.read_yaml_file",
|
|
return_value={"name": "Awesome repository"},
|
|
),
|
|
patch("pathlib.Path.exists", return_value=True),
|
|
):
|
|
await store_manager.update_repositories({"http://example.com"}, replace=False)
|
|
|
|
assert test_repository.source in coresys.store.repository_urls
|
|
assert "http://example.com" in coresys.store.repository_urls
|
|
|
|
|
|
@pytest.mark.parametrize("use_update", [True, False])
|
|
async def test_add_repository_fails_if_out_of_date(
|
|
coresys: CoreSys, store_manager: StoreManager, use_update: bool
|
|
):
|
|
"""Test adding a repository fails when supervisor not updated."""
|
|
with (
|
|
patch.object(
|
|
type(coresys.supervisor), "need_update", new=PropertyMock(return_value=True)
|
|
),
|
|
pytest.raises(StoreJobError),
|
|
):
|
|
if use_update:
|
|
await store_manager.update_repositories(
|
|
set(coresys.store.repository_urls) | {"http://example.com"}
|
|
)
|
|
else:
|
|
await store_manager.add_repository("http://example.com")
|
|
|
|
|
|
@pytest.mark.parametrize("need_update", [True, False])
|
|
async def test_repositories_loaded_ignore_updates(
|
|
coresys: CoreSys, store_manager: StoreManager, need_update: bool
|
|
):
|
|
"""Test repositories loaded whether or not supervisor needs an update."""
|
|
with (
|
|
patch("supervisor.store.git.GitRepo.load", return_value=None),
|
|
patch.object(
|
|
type(coresys.supervisor),
|
|
"need_update",
|
|
new=PropertyMock(return_value=need_update),
|
|
),
|
|
):
|
|
await store_manager.load()
|
|
|
|
assert len(coresys.resolution.issues) == 0
|
|
assert (
|
|
"https://github.com/hassio-addons/repository" in coresys.store.repository_urls
|
|
)
|
|
assert (
|
|
"https://github.com/hassio-addons/repository" in coresys.store.repository_urls
|
|
)
|