arcanis/ahriman
1
0
Fork 0
mirror of https://github.com/arcan1s/ahriman.git synced 2025-11-04 07:43:42 +00:00
Code Issues Projects Releases Wiki Activity

Docs update (#61)

Browse Source 
* Improve sphinx documentation

* update faq formatting

* fix setup doc

* fix docs according to the generated htmls
This commit is contained in:
Evgenii Alekseev
2022-05-05 20:24:24 +03:00
committed by Evgeniy Alekseev
parent 304690e0d0
commit 33e9fea47c
89 changed files with 5471 additions and 5304 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
tests/ahriman/conftest.py
View File

@ -235,12 +235,13 @@ def database(configuration: Configuration) -> SQLite:
@pytest.fixture
def package_ahriman(package_description_ahriman: PackageDescription) -> Package:
def package_ahriman(package_description_ahriman: PackageDescription, remote_source: RemoteSource) -> Package:
"""
package fixture
Args:
package_description_ahriman(PackageDescription): description fixture
remote_source(RemoteSource): remote source fixture
Returns:
Package: package test instance
@ -249,7 +250,7 @@ def package_ahriman(package_description_ahriman: PackageDescription) -> Package:
return Package(
base="ahriman",
version="1.7.0-1",
remote=RemoteSource.from_remote(PackageSource.AUR, "ahriman", "aur"),
remote=remote_source,
packages=packages)
@ -274,7 +275,7 @@ def package_python_schedule(
return Package(
base="python-schedule",
version="1.0.0-2",
remote=RemoteSource.from_remote(PackageSource.AUR, "python-schedule", "aur"),
remote=RemoteSource.from_source(PackageSource.AUR, "python-schedule", "aur"),
packages=packages)
@ -363,17 +364,14 @@ def pacman(configuration: Configuration) -> Pacman:
@pytest.fixture
def remote_source(package_ahriman: Package) -> RemoteSource:
def remote_source() -> RemoteSource:
"""
remote source fixture
Args:
package_ahriman(Package): package fixture
Returns:
RemoteSource: remote source test instance
"""
return RemoteSource.from_remote(PackageSource.AUR, "ahriman", "aur")
return RemoteSource.from_source(PackageSource.AUR, "ahriman", "aur")
@pytest.fixture

2
tests/ahriman/core/database/data/test_package_remotes.py
View File

@ -60,7 +60,7 @@ def test_migrate_package_remotes_no_remotes(package_ahriman: Package, connection
"ahriman.core.database.operations.package_operations.PackageOperations._packages_get_select_package_bases",
return_value={package_ahriman.base: package_ahriman})
mocker.patch("pathlib.Path.exists", return_value=False)
mocker.patch("ahriman.models.remote_source.RemoteSource.from_remote", return_value=None)
mocker.patch("ahriman.models.remote_source.RemoteSource.from_source", return_value=None)
migrate_package_remotes(connection, repository_paths)
connection.execute.assert_not_called()

2
tests/ahriman/core/database/operations/test_package_operations.py
View File

@ -183,7 +183,7 @@ def test_remote_update_update(database: SQLite, package_ahriman: Package) -> Non
must perform package remote update for existing package
"""
database.remote_update(package_ahriman)
remote_source = RemoteSource.from_remote(PackageSource.Repository, package_ahriman.base, "community")
remote_source = RemoteSource.from_source(PackageSource.Repository, package_ahriman.base, "community")
package_ahriman.remote = remote_source
database.remote_update(package_ahriman)

2
tests/ahriman/core/repository/test_update_handler.py
View File

@ -35,7 +35,7 @@ def test_updates_aur_official(update_handler: UpdateHandler, package_ahriman: Pa
"""
must provide updates based on repository data
"""
package_ahriman.remote = RemoteSource.from_remote(PackageSource.Repository, package_ahriman.base, "community")
package_ahriman.remote = RemoteSource.from_source(PackageSource.Repository, package_ahriman.base, "community")
mocker.patch("ahriman.core.repository.update_handler.UpdateHandler.packages", return_value=[package_ahriman])
mocker.patch("ahriman.models.package.Package.is_outdated", return_value=True)
mocker.patch("ahriman.models.package.Package.from_official", return_value=package_ahriman)

2
tests/ahriman/models/conftest.py
View File

@ -71,7 +71,7 @@ def package_tpacpi_bat_git() -> Package:
return Package(
base="tpacpi-bat-git",
version="3.1.r12.g4959b52-1",
remote=RemoteSource.from_remote(PackageSource.AUR, "tpacpi-bat-git", "aur"),
remote=RemoteSource.from_source(PackageSource.AUR, "tpacpi-bat-git", "aur"),
packages={"tpacpi-bat-git": PackageDescription()})

18
tests/ahriman/models/test_remote_source.py
View File

@ -42,14 +42,14 @@ def test_from_json_empty() -> None:
assert RemoteSource.from_json({}) is None
def test_from_remote_aur(package_ahriman: Package, mocker: MockerFixture) -> None:
def test_from_source_aur(package_ahriman: Package, mocker: MockerFixture) -> None:
"""
must construct remote from AUR source
"""
remote_git_url_mock = mocker.patch("ahriman.core.alpm.remote.aur.AUR.remote_git_url")
remote_web_url_mock = mocker.patch("ahriman.core.alpm.remote.aur.AUR.remote_web_url")
remote = RemoteSource.from_remote(PackageSource.AUR, package_ahriman.base, "aur")
remote = RemoteSource.from_source(PackageSource.AUR, package_ahriman.base, "aur")
remote_git_url_mock.assert_called_once_with(package_ahriman.base, "aur")
remote_web_url_mock.assert_called_once_with(package_ahriman.base)
assert remote.pkgbuild_dir == Path(".")
@ -57,14 +57,14 @@ def test_from_remote_aur(package_ahriman: Package, mocker: MockerFixture) -> Non
assert remote.source == PackageSource.AUR
def test_from_remote_official(package_ahriman: Package, mocker: MockerFixture) -> None:
def test_from_source_official(package_ahriman: Package, mocker: MockerFixture) -> None:
"""
must construct remote from official repository source
"""
remote_git_url_mock = mocker.patch("ahriman.core.alpm.remote.official.Official.remote_git_url")
remote_web_url_mock = mocker.patch("ahriman.core.alpm.remote.official.Official.remote_web_url")
remote = RemoteSource.from_remote(PackageSource.Repository, package_ahriman.base, "community")
remote = RemoteSource.from_source(PackageSource.Repository, package_ahriman.base, "community")
remote_git_url_mock.assert_called_once_with(package_ahriman.base, "community")
remote_web_url_mock.assert_called_once_with(package_ahriman.base)
assert remote.pkgbuild_dir == Path("trunk")
@ -72,11 +72,11 @@ def test_from_remote_official(package_ahriman: Package, mocker: MockerFixture) -
assert remote.source == PackageSource.Repository
def test_from_remote_other() -> None:
def test_from_source_other() -> None:
"""
must return None in case if source is not one of AUR or Repository
"""
assert RemoteSource.from_remote(PackageSource.Archive, "package", "repository") is None
assert RemoteSource.from_remote(PackageSource.Directory, "package", "repository") is None
assert RemoteSource.from_remote(PackageSource.Local, "package", "repository") is None
assert RemoteSource.from_remote(PackageSource.Remote, "package", "repository") is None
assert RemoteSource.from_source(PackageSource.Archive, "package", "repository") is None
assert RemoteSource.from_source(PackageSource.Directory, "package", "repository") is None
assert RemoteSource.from_source(PackageSource.Local, "package", "repository") is None
assert RemoteSource.from_source(PackageSource.Remote, "package", "repository") is None