add raises note

Also change behaviour of the `from_option` method to fallback to
disabled instead of raising exception on unknown option
This commit is contained in:
Evgenii Alekseev 2022-04-17 05:44:46 +03:00
parent 5b6ba721fe
commit e2f7e9cf28
62 changed files with 245 additions and 99 deletions

View File

@ -42,6 +42,9 @@ class Packages(Properties):
Args:
result(Result): build result
Raises:
NotImplementedError: not implemented method
"""
raise NotImplementedError
@ -51,6 +54,9 @@ class Packages(Properties):
Returns:
Set[str]: list of known packages
Raises:
NotImplementedError: not implemented method
"""
raise NotImplementedError
@ -116,7 +122,7 @@ class Packages(Properties):
add package from remote sources (e.g. HTTP)
Args:
source(str):
source(str): remote URL of the package archive
"""
dst = self.repository.paths.packages / Path(source).name # URL is path, is not it?
response = requests.get(source, stream=True)

View File

@ -41,6 +41,9 @@ class Repository(Properties):
Args:
result(Result): build result
Raises:
NotImplementedError: not implemented method
"""
raise NotImplementedError

View File

@ -53,6 +53,9 @@ class Handler:
Returns:
List[str]: list of architectures for which tree is created
Raises:
MissingArchitecture: if no architecture set and automatic detection is not allowed or failed
"""
if not cls.ALLOW_AUTO_ARCHITECTURE_RUN and args.architecture is None:
# for some parsers (e.g. config) we need to run with specific architecture
@ -105,6 +108,9 @@ class Handler:
Returns:
int: 0 on success, 1 otherwise
Raises:
MultipleArchitectures: if more than one architecture supplied and no multi architecture supported
"""
architectures = cls.architectures_extract(args)
@ -133,6 +139,9 @@ class Handler:
configuration(Configuration): configuration instance
no_report(bool): force disable reporting
unsafe(bool): if set no user check will be performed before path creation
Raises:
NotImplementedError: not implemented method
"""
raise NotImplementedError
@ -144,6 +153,9 @@ class Handler:
Args:
enabled(bool): if False no check will be performed
predicate(bool): indicates condition on which exception should be thrown
Raises:
ExitCode: if result is empty and check is enabled
"""
if enabled and predicate:
raise ExitCode()

View File

@ -82,7 +82,7 @@ class Patch(Handler):
Args:
application(Application): application instance
package_base(Optional[str]): package base
exit_code(bool): raise ExitCode on empty search result
exit_code(bool): exit with error on empty search result
"""
patches = application.database.patches_list(package_base)
Patch.check_if_empty(exit_code, not patches)

View File

@ -75,6 +75,9 @@ class Search(Handler):
Returns:
List[AURPackage]: sorted list for packages
Raises:
InvalidOption: if search fields is not in list of allowed ones
"""
if sort_by not in Search.SORT_FIELDS:
raise InvalidOption(sort_by)

View File

@ -24,7 +24,6 @@ from typing import List, Type
from ahriman.application.handlers.handler import Handler
from ahriman.core.configuration import Configuration
from ahriman.core.exceptions import ExitCode
from ahriman.core.formatters.string_printer import StringPrinter
@ -67,8 +66,7 @@ class UnsafeCommands(Handler):
parser(argparse.ArgumentParser): generated argument parser
"""
args = parser.parse_args(shlex.split(command))
if args.command in unsafe_commands:
raise ExitCode()
UnsafeCommands.check_if_empty(True, args.command in unsafe_commands)
@staticmethod
def get_unsafe_commands(parser: argparse.ArgumentParser) -> List[str]:

View File

@ -124,6 +124,9 @@ class Lock:
def create(self) -> None:
"""
create lock file
Raises:
DuplicateRun: if lock exists and no force flag supplied
"""
if self.path is None:
return

View File

@ -63,6 +63,9 @@ class AUR(Remote):
Returns:
List[AURPackage]: list of parsed packages
Raises:
InvalidPackageInfo: for error API response
"""
response_type = response["type"]
if response_type == "error":

View File

@ -58,6 +58,9 @@ class Official(Remote):
Returns:
List[AURPackage]: list of parsed packages
Raises:
InvalidPackageInfo: for error API response
"""
if not response["valid"]:
raise InvalidPackageInfo("API validation error")

View File

@ -98,6 +98,9 @@ class Remote:
Returns:
AURPackage: package which match the package name
Raises:
NotImplementedError: not implemented method
"""
raise NotImplementedError
@ -110,5 +113,8 @@ class Remote:
Returns:
List[AURPackage]: list of packages which match the criteria
Raises:
NotImplementedError: not implemented method
"""
raise NotImplementedError

View File

@ -79,6 +79,9 @@ class OAuth(Mapping):
Returns:
Type[aioauth_client.OAuth2Client]: loaded provider type
Raises:
InvalidOption: in case if invalid OAuth provider name supplied
"""
provider: Type[aioauth_client.OAuth2Client] = getattr(aioauth_client, name)
try:

View File

@ -166,7 +166,7 @@ class Sources:
Args:
sources_dir(Path): local path to git repository
*pattern(str):
*pattern(str): glob patterns
Returns:
str: patch as plain text

View File

@ -115,6 +115,9 @@ class Configuration(configparser.RawConfigParser):
Returns:
List[str]: list of string from the parsed string
Raises:
ValueError: in case if option value contains unclosed quotes
"""
def generator() -> Generator[str, None, None]:
quote_mark = None
@ -170,6 +173,9 @@ class Configuration(configparser.RawConfigParser):
Returns:
Tuple[Path, str]: configuration root path and architecture if loaded
Raises:
InitializeException: in case if architecture and/or path are not set
"""
if self.path is None or self.architecture is None:
raise InitializeException("Configuration path and/or architecture are not set")
@ -204,6 +210,9 @@ class Configuration(configparser.RawConfigParser):
Returns:
Tuple[str, str]: section name and found type name
Raises:
configparser.NoSectionError: in case if no section found
"""
group_type = self.get(section, "type", fallback=None) # new-style logic
if group_type is not None:

View File

@ -97,6 +97,9 @@ class Report:
Args:
packages(Iterable[Package]): list of packages to generate report
result(Result): build result
Raises:
ReportFailed: in case of any report unmatched exception
"""
try:
self.generate(packages, result)

View File

@ -36,6 +36,9 @@ class Cleaner(Properties):
Returns:
List[Path]: list of filenames from the directory
Raises:
NotImplementedError: not implemented method
"""
raise NotImplementedError

View File

@ -45,6 +45,9 @@ class Executor(Cleaner):
Returns:
List[Package]: list of read packages
Raises:
NotImplementedError: not implemented method
"""
raise NotImplementedError
@ -54,6 +57,9 @@ class Executor(Cleaner):
Returns:
List[Package]: list of packages properties
Raises:
NotImplementedError: not implemented method
"""
raise NotImplementedError

View File

@ -82,7 +82,7 @@ class Repository(Executor, UpdateHandler):
extract list of packages which depends on specified package
Args:
depends_on(Optional[Iterable[str]]):
depends_on(Optional[Iterable[str]]): dependencies of the packages
Returns:
List[Package]: list of repository packages which depend on specified packages

View File

@ -36,6 +36,9 @@ class UpdateHandler(Cleaner):
Returns:
List[Package]: list of packages properties
Raises:
NotImplementedError: not implemented method
"""
raise NotImplementedError

View File

@ -94,10 +94,12 @@ class GPG:
Returns:
Tuple[Set[SignSettings], Optional[str]]: tuple of sign targets and default PGP key
"""
targets = {
SignSettings.from_option(option)
for option in configuration.getlist("sign", "target")
}
targets: Set[SignSettings] = set()
for option in configuration.getlist("sign", "target"):
target = SignSettings.from_option(option)
if target == SignSettings.Disabled:
continue
targets.add(target)
default_key = configuration.get("sign", "key") if targets else None
return targets, default_key

View File

@ -73,10 +73,13 @@ class Watcher:
get current package base build status
Args:
base(str):
base(str): package base
Returns:
Tuple[Package, BuildStatus]: package and its status
Raises:
UnknownPackage: if no package found
"""
try:
return self.known[base]
@ -117,6 +120,9 @@ class Watcher:
package_base(str): package base to update
status(BuildStatusEnum): new build status
package(Optional[Package]): optional new package description. In case if not set current properties will be used
Raises:
UnknownPackage: if no package found
"""
if package is None:
try:

View File

@ -102,7 +102,7 @@ class HttpUpload(Upload):
Args:
method(str): request method
url(str): request url
**kwargs(Any):
**kwargs(Any): request parameters to be passed as is
Returns:
requests.Response: request response object

View File

@ -46,7 +46,7 @@ class S3(Upload):
Args:
architecture(str): repository architecture
configuration(Configuration): configuration instance
section(str):
section(str): settings section name
"""
Upload.__init__(self, architecture, configuration)
self.bucket = self.get_bucket(configuration, section)

View File

@ -85,6 +85,9 @@ class Upload:
Args:
path(Path): local path to sync
built_packages(Iterable[Package]): list of packages which has just been built
Raises:
SyncFailed: in case of any synchronization unmatched exception
"""
try:
self.sync(path, built_packages)

View File

@ -48,6 +48,9 @@ def check_output(*args: str, exception: Optional[Exception], cwd: Optional[Path]
Returns:
str: command output
Raises:
subprocess.CalledProcessError: if subprocess ended with status code different from 0 and no exception supplied
"""
def log(single: str) -> None:
if logger is not None:
@ -91,6 +94,9 @@ def check_user(paths: RepositoryPaths, unsafe: bool) -> None:
Args:
paths(RepositoryPaths): repository paths object
unsafe(bool): if set no user check will be performed before path creation
Raises:
UnsafeRun: if root uid differs from current uid and check is enabled
"""
if not paths.root.exists():
return # no directory found, skip check
@ -187,6 +193,9 @@ def pretty_size(size: Optional[float], level: int = 0) -> str:
Returns:
str: pretty printable size as string
Raises:
InvalidOption: if size is more than 1TiB
"""
def str_level() -> str:
if level == 0:

View File

@ -22,8 +22,6 @@ from __future__ import annotations
from enum import Enum
from typing import Type
from ahriman.core.exceptions import InvalidOption
class AuthSettings(Enum):
"""
@ -50,13 +48,11 @@ class AuthSettings(Enum):
Returns:
AuthSettings: parsed value
"""
if value.lower() in ("disabled", "no"):
return cls.Disabled
if value.lower() in ("configuration", "mapping"):
return cls.Configuration
if value.lower() in ('oauth', 'oauth2'):
return cls.OAuth
raise InvalidOption(value)
return cls.Disabled
@property
def is_enabled(self) -> bool:

View File

@ -40,6 +40,9 @@ class MigrationResult:
"""
Returns:
bool: True in case if it requires migrations and False otherwise
Raises:
MigrationError: if old version is newer than new one or negative
"""
self.validate()
return self.new_version > self.old_version

View File

@ -161,6 +161,9 @@ class Package:
Returns:
Package: package properties
Raises:
InvalidPackageInfo: if there are parsing errors
"""
srcinfo, errors = parse_srcinfo((path / ".SRCINFO").read_text())
if errors:
@ -219,6 +222,9 @@ class Package:
Returns:
Package: package properties
Raises:
InvalidPackageInfo: if supplied package source is not valid
"""
try:
resolved_source = source.resolve(package)
@ -246,6 +252,9 @@ class Package:
Returns:
Set[str]: list of package dependencies including makedepends array, but excluding packages from this base
Raises:
InvalidPackageInfo: if there are parsing errors
"""
# additional function to remove versions from dependencies
def extract_packages(raw_packages_list: List[str]) -> Set[str]:
@ -277,6 +286,9 @@ class Package:
Returns:
str: package version if package is not VCS and current version according to VCS otherwise
Raises:
InvalidPackageInfo: if there are parsing errors
"""
if not self.is_vcs:
return self.version

View File

@ -22,8 +22,6 @@ from __future__ import annotations
from enum import Enum
from typing import Type
from ahriman.core.exceptions import InvalidOption
class ReportSettings(Enum):
"""
@ -62,4 +60,4 @@ class ReportSettings(Enum):
return cls.Console
if value.lower() in ("telegram",):
return cls.Telegram
raise InvalidOption(value)
return cls.Disabled

View File

@ -133,6 +133,9 @@ class RepositoryPaths:
Args:
path(Path): path to be chown
Raises:
InvalidPath: if path does not belong to root
"""
def set_owner(current: Path) -> None:
uid, gid = self.owner(current)

View File

@ -95,6 +95,9 @@ class Result:
Returns:
Result: updated instance
Raises:
SuccessFailed: if there is previously failed package which is masked as success
"""
for base, package in other._failed.items():
if base in self._success:

View File

@ -22,18 +22,18 @@ from __future__ import annotations
from enum import Enum
from typing import Type
from ahriman.core.exceptions import InvalidOption
class SignSettings(Enum):
"""
sign targets enumeration
Attributes:
Disabled(SignSettings): (class attribute) option which generates no report for testing purpose
Packages(SignSettings): (class attribute) sign each package
Repository(SignSettings): (class attribute) sign repository database file
"""
Disabled = "disabled"
Packages = "pacakges"
Repository = "repository"
@ -47,9 +47,12 @@ class SignSettings(Enum):
Returns:
SignSettings: parsed value
Raises:
InvalidOption: if unsupported option suppled
"""
if value.lower() in ("package", "packages", "sign-package"):
return cls.Packages
if value.lower() in ("repository", "sign-repository"):
return cls.Repository
raise InvalidOption(value)
return cls.Disabled

View File

@ -22,8 +22,6 @@ from __future__ import annotations
from enum import Enum
from typing import Type
from ahriman.core.exceptions import InvalidOption
class UploadSettings(Enum):
"""
@ -58,4 +56,4 @@ class UploadSettings(Enum):
return cls.S3
if value.lower() in ("github",):
return cls.Github
raise InvalidOption(value)
return cls.Disabled

View File

@ -44,8 +44,8 @@ def exception_handler(logger: Logger) -> MiddlewareType:
except HTTPServerError as e:
logger.exception("server exception during performing request to %s", request.path)
return json_response(data={"error": e.reason}, status=e.status_code)
except HTTPException:
raise # just raise 2xx and 3xx codes
except HTTPException: # just raise 2xx and 3xx codes
raise
except Exception as e:
logger.exception("unknown exception during performing request to %s", request.path)
return json_response(data={"error": str(e)}, status=500)

View File

@ -41,6 +41,10 @@ class AddView(BaseView):
{
"packages": "ahriman" # either list of packages or package name as in AUR
}
Raises:
HTTPBadRequest: if bad data is supplied
HTTPFound: in case of success response
"""
try:
data = await self.extract_data(["packages"])

View File

@ -41,6 +41,10 @@ class RemoveView(BaseView):
{
"packages": "ahriman", # either list of packages or package name
}
Raises:
HTTPBadRequest: if bad data is supplied
HTTPFound: in case of success response
"""
try:
data = await self.extract_data(["packages"])

View File

@ -41,6 +41,10 @@ class RequestView(BaseView):
{
"packages": "ahriman" # either list of packages or package name as in AUR
}
Raises:
HTTPBadRequest: if bad data is supplied
HTTPFound: in case of success response
"""
try:
data = await self.extract_data(["packages"])

View File

@ -45,6 +45,9 @@ class SearchView(BaseView):
Returns:
Response: 200 with found package bases and descriptions sorted by base
Raises:
HTTPNotFound: if no packages found
"""
search: List[str] = self.request.query.getall("for", default=[])
packages = AUR.multisearch(*search)

View File

@ -54,6 +54,10 @@ class AhrimanView(BaseView):
{
"status": "unknown", # service status string, must be valid `BuildStatusEnum`
}
Raises:
HTTPBadRequest: if bad data is supplied
HTTPNoContent: in case of success response
"""
try:
data = await self.extract_data()

View File

@ -46,6 +46,9 @@ class PackageView(BaseView):
Returns:
Response: 200 with package description on success
Raises:
HTTPNotFound: if no package was found
"""
base = self.request.match_info["package"]
@ -65,6 +68,9 @@ class PackageView(BaseView):
async def delete(self) -> None:
"""
delete package base from status page
Raises:
HTTPNoContent: on success response
"""
base = self.request.match_info["package"]
self.service.remove(base)
@ -81,6 +87,10 @@ class PackageView(BaseView):
"package": {} # package body (use `dataclasses.asdict` to generate one), optional.
# Must be supplied in case if package base is unknown
}
Raises:
HTTPBadRequest: if bad data is supplied
HTTPNoContent: in case of success response
"""
base = self.request.match_info["package"]
data = await self.extract_data()

View File

@ -54,6 +54,9 @@ class PackagesView(BaseView):
async def post(self) -> None:
"""
reload all packages from repository. No parameters supported here
Raises:
HTTPNoContent: on success response
"""
self.service.load()

View File

@ -42,6 +42,11 @@ class LoginView(BaseView):
In case if code provided it will do a request to get user email. In case if no code provided it will redirect
to authorization url provided by OAuth client
Raises:
HTTPFound: on success response
HTTPMethodNotAllowed: in case if method is used, but OAuth is disabled
HTTPUnauthorized: if case of authorization error
"""
from ahriman.core.auth.oauth import OAuth
@ -71,6 +76,10 @@ class LoginView(BaseView):
"username": "username" # username to use for login
"password": "pa55w0rd" # password to use for login
}
Raises:
HTTPFound: on success response
HTTPUnauthorized: if case of authorization error
"""
data = await self.extract_data()
username = data.get("username")

View File

@ -37,6 +37,9 @@ class LogoutView(BaseView):
async def post(self) -> None:
"""
logout user from the service. No parameters supported here
Raises:
HTTPFound: on success response
"""
await check_authorized(self.request)
await forget(self.request, HTTPFound("/"))

View File

@ -49,6 +49,9 @@ async def on_startup(application: web.Application) -> None:
Args:
application(web.Application): web application instance
Raises:
InitializeException: in case if matched could not be loaded
"""
application.logger.info("server started")
try:

View File

@ -6,7 +6,6 @@ from pytest_mock import MockerFixture
from ahriman.application.ahriman import _parser
from ahriman.application.handlers import UnsafeCommands
from ahriman.core.configuration import Configuration
from ahriman.core.exceptions import ExitCode
def _default_args(args: argparse.Namespace) -> argparse.Namespace:
@ -53,19 +52,22 @@ def test_run_check(args: argparse.Namespace, configuration: Configuration, mocke
check_mock.assert_called_once_with("clean", ["command"], pytest.helpers.anyvar(int))
def test_check_unsafe() -> None:
def test_check_unsafe(mocker: MockerFixture) -> None:
"""
must check if command is unsafe
"""
with pytest.raises(ExitCode):
UnsafeCommands.check_unsafe("repo-clean", ["repo-clean"], _parser())
check_mock = mocker.patch("ahriman.application.handlers.handler.Handler.check_if_empty")
UnsafeCommands.check_unsafe("repo-clean", ["repo-clean"], _parser())
check_mock.assert_called_once_with(True, True)
def test_check_unsafe_safe() -> None:
def test_check_unsafe_safe(mocker: MockerFixture) -> None:
"""
must check if command is safe
"""
check_mock = mocker.patch("ahriman.application.handlers.handler.Handler.check_if_empty")
UnsafeCommands.check_unsafe("package-status", ["repo-clean"], _parser())
check_mock.assert_called_once_with(True, False)
def test_get_unsafe_commands() -> None:

View File

@ -220,7 +220,7 @@ def database(configuration: Configuration) -> SQLite:
database fixture
Args:
configuration(Configuration):
configuration(Configuration): configuration fixture
Returns:
SQLite: database test instance

View File

@ -4,6 +4,7 @@ import requests
from pathlib import Path
from pytest_mock import MockerFixture
from ahriman.core.configuration import Configuration
from ahriman.core.sign.gpg import GPG
from ahriman.models.sign_settings import SignSettings
@ -63,6 +64,18 @@ def test_sign_command(gpg_with_key: GPG) -> None:
assert gpg_with_key.sign_command(Path("a"), gpg_with_key.default_key)
def test_sign_options(configuration: Configuration) -> None:
"""
must correctly parse sign options
"""
configuration.set_option("sign", "target", "repository disabled")
configuration.set_option("sign", "key", "default-key")
target, default_key = GPG.sign_options(configuration)
assert target == {SignSettings.Repository}
assert default_key == "default-key"
def test_key_download(gpg: GPG, mocker: MockerFixture) -> None:
"""
must download the key from public server

View File

@ -1,15 +1,11 @@
import pytest
from ahriman.core.exceptions import InvalidOption
from ahriman.models.auth_settings import AuthSettings
def test_from_option_invalid() -> None:
"""
must raise exception on invalid option
return disabled on invalid option
"""
with pytest.raises(InvalidOption, match=".* `invalid`$"):
AuthSettings.from_option("invalid")
assert AuthSettings.from_option("invalid") == AuthSettings.Disabled
def test_from_option_valid() -> None:

View File

@ -1,15 +1,11 @@
import pytest
from ahriman.core.exceptions import InvalidOption
from ahriman.models.report_settings import ReportSettings
def test_from_option_invalid() -> None:
"""
must raise exception on invalid option
must return disabled on invalid option
"""
with pytest.raises(InvalidOption, match=".* `invalid`$"):
ReportSettings.from_option("invalid")
assert ReportSettings.from_option("invalid") == ReportSettings.Disabled
def test_from_option_valid() -> None:

View File

@ -1,15 +1,11 @@
import pytest
from ahriman.core.exceptions import InvalidOption
from ahriman.models.sign_settings import SignSettings
def test_from_option_invalid() -> None:
"""
must raise exception on invalid option
must return disabled on invalid option
"""
with pytest.raises(InvalidOption, match=".* `invalid`$"):
SignSettings.from_option("invalid")
assert SignSettings.from_option("invalid") == SignSettings.Disabled
def test_from_option_valid() -> None:

View File

@ -1,15 +1,11 @@
import pytest
from ahriman.core.exceptions import InvalidOption
from ahriman.models.upload_settings import UploadSettings
def test_from_option_invalid() -> None:
"""
must raise exception on invalid option
must return disabled on invalid option
"""
with pytest.raises(InvalidOption, match=".* `invalid`$"):
UploadSettings.from_option("invalid")
assert UploadSettings.from_option("invalid") == UploadSettings.Disabled
def test_from_option_valid() -> None: