Compare commits

..

5 Commits

Author SHA1 Message Date
9c1e9ecbdc Release 2.14.1 2024-09-04 22:01:04 +03:00
4b2f6bbee9 bug: fix removal of the packages
It has been broken since reporter improvements, because it effectivelly
1) didn't call remove functions in database
2) used empty repository identifier for web service

With those changes it also raises exception when you try to call id on
empty identifier
2024-09-04 21:50:33 +03:00
fd8c8a00d0 chore: small contributing guide update 2024-09-04 21:49:31 +03:00
eaf1984eb3 refactor: fix some IDE warnings 2024-09-04 21:49:31 +03:00
794dddccd9 build: update pytest configuration to suppress deprecation warnings 2024-09-04 21:49:31 +03:00
133 changed files with 5583 additions and 7601 deletions

View File

@ -36,7 +36,6 @@ Again, the most checks can be performed by `tox` command, though some additional
Notes: Notes:
Very important note about this function Very important note about this function
Probably multi-line
Args: Args:
argument(str): an argument. This argument has argument(str): an argument. This argument has
@ -71,7 +70,6 @@ Again, the most checks can be performed by `tox` command, though some additional
Attributes: Attributes:
CLAZZ_ATTRIBUTE(int): (class attribute) a brand-new class attribute CLAZZ_ATTRIBUTE(int): (class attribute) a brand-new class attribute
instance_attribute(str): an instance attribute instance_attribute(str): an instance attribute
with the long description
Examples: Examples:
Very informative class usage example, e.g.:: Very informative class usage example, e.g.::
@ -94,7 +92,7 @@ Again, the most checks can be performed by `tox` command, though some additional
``` ```
* Type annotations are the must, even for local functions. For the function argument `self` (for instance methods) and `cls` (for class methods) should not be annotated. * Type annotations are the must, even for local functions. For the function argument `self` (for instance methods) and `cls` (for class methods) should not be annotated.
* For collection types built-in classes must be used if possible (e.g. `dict` instead of `typing.Dict`, `tuple` instead of `typing.Tuple`). In case if built-in type is not available, but `collections.abc` provides interface, it must be used (e.g. `collections.abc.Awaitable` instead of `typing.Awaitable`, `collections.abc.Iterable` instead of `typing.Iterable`). For union classes, the bar operator (`|`) must be used (e.g. `float | int` instead of `typing.Union[float, int]`), which also includes `typing.Optional` (e.g. `str | None` instead of `Optional[str]`). * For collection types built-in classes must be used if possible (e.g. `dict` instead of `typing.Dict`, `tuple` instead of `typing.Tuple`). In case if built-in type is not available, but `collections.abc` provides interface, it must be used (e.g. `collections.abc.Awaitable` instead of `typing.Awaitable`, `collections.abc.Iterable` instead of `typing.Iterable`). For union classes, the bar operator (`|`) must be used (e.g. `float | int` instead of `typing.Union[float, int]`), which also includes `typinng.Optional` (e.g. `str | None` instead of `Optional[str]`).
* `classmethod` should (almost) always return `Self`. In case of mypy warning (e.g. if there is a branch in which function doesn't return the instance of `cls`) consider using `staticmethod` instead. * `classmethod` should (almost) always return `Self`. In case of mypy warning (e.g. if there is a branch in which function doesn't return the instance of `cls`) consider using `staticmethod` instead.
* Recommended order of function definitions in class: * Recommended order of function definitions in class:
@ -134,7 +132,7 @@ Again, the most checks can be performed by `tox` command, though some additional
* For any path interactions `pathlib.Path` must be used. * For any path interactions `pathlib.Path` must be used.
* Configuration interactions must go through `ahriman.core.configuration.Configuration` class instance. * Configuration interactions must go through `ahriman.core.configuration.Configuration` class instance.
* In case if class load requires some actions, it is recommended to create class method which can be used for class instantiating. * In case if class load requires some actions, it is recommended to create class method which can be used for class instantiating.
* The code must follow the exception safety, unless it is explicitly asked by end user. It means that most exceptions must be handled and printed to log, no other actions must be done (e.g. raising another exception). * The most (expected) exceptions must be handled and printed to log, allowing service to continue work. However, fatal and (in some cases) unexpected exceptions may lead to the application termination.
* Exceptions without parameters should be raised without parentheses, e.g.: * Exceptions without parameters should be raised without parentheses, e.g.:
```python ```python

View File

@ -2,7 +2,7 @@
[![tests status](https://github.com/arcan1s/ahriman/actions/workflows/tests.yml/badge.svg)](https://github.com/arcan1s/ahriman/actions/workflows/tests.yml) [![tests status](https://github.com/arcan1s/ahriman/actions/workflows/tests.yml/badge.svg)](https://github.com/arcan1s/ahriman/actions/workflows/tests.yml)
[![setup status](https://github.com/arcan1s/ahriman/actions/workflows/setup.yml/badge.svg)](https://github.com/arcan1s/ahriman/actions/workflows/setup.yml) [![setup status](https://github.com/arcan1s/ahriman/actions/workflows/setup.yml/badge.svg)](https://github.com/arcan1s/ahriman/actions/workflows/setup.yml)
[![Docker Image Version (latest semver)](https://img.shields.io/docker/v/arcan1s/ahriman?label=Docker%20image&sort=semver)](https://hub.docker.com/r/arcan1s/ahriman) [![Docker Image Version (latest semver)](https://img.shields.io/docker/v/arcan1s/ahriman?label=Docker%20image)](https://hub.docker.com/r/arcan1s/ahriman)
[![CodeFactor](https://www.codefactor.io/repository/github/arcan1s/ahriman/badge)](https://www.codefactor.io/repository/github/arcan1s/ahriman) [![CodeFactor](https://www.codefactor.io/repository/github/arcan1s/ahriman/badge)](https://www.codefactor.io/repository/github/arcan1s/ahriman)
[![Documentation Status](https://readthedocs.org/projects/ahriman/badge/?version=latest)](https://ahriman.readthedocs.io) [![Documentation Status](https://readthedocs.org/projects/ahriman/badge/?version=latest)](https://ahriman.readthedocs.io)
@ -40,3 +40,5 @@ The application provides reasonable defaults which allow to use it out-of-box; h
* [Build status page](https://ahriman-demo.arcanis.me). You can log in as `demo` user by using `demo` password. However, you will not be able to run tasks. [HTTP API documentation](https://ahriman-demo.arcanis.me/api-docs) is also available. * [Build status page](https://ahriman-demo.arcanis.me). You can log in as `demo` user by using `demo` password. However, you will not be able to run tasks. [HTTP API documentation](https://ahriman-demo.arcanis.me/api-docs) is also available.
* [Repository index](https://repo.arcanis.me/arcanisrepo/x86_64/). * [Repository index](https://repo.arcanis.me/arcanisrepo/x86_64/).
* [Telegram feed](https://t.me/arcanisrepo). * [Telegram feed](https://t.me/arcanisrepo).
Do you have any success story? You can [share it](https://github.com/arcan1s/ahriman/issues/new?template=04-discussion.md)!

View File

@ -8,6 +8,9 @@ cat <<EOF > "/etc/ahriman.ini.d/00-docker.ini"
[repository] [repository]
root = $AHRIMAN_REPOSITORY_ROOT root = $AHRIMAN_REPOSITORY_ROOT
[settings]
database = $AHRIMAN_REPOSITORY_ROOT/ahriman.db
[web] [web]
host = $AHRIMAN_HOST host = $AHRIMAN_HOST

File diff suppressed because it is too large Load Diff

Before

Width:  |  Height:  |  Size: 1.2 MiB

After

Width:  |  Height:  |  Size: 1.2 MiB

View File

@ -4,14 +4,6 @@ ahriman.core.build\_tools package
Submodules Submodules
---------- ----------
ahriman.core.build\_tools.package\_archive module
-------------------------------------------------
.. automodule:: ahriman.core.build_tools.package_archive
:members:
:no-undoc-members:
:show-inheritance:
ahriman.core.build\_tools.sources module ahriman.core.build\_tools.sources module
---------------------------------------- ----------------------------------------

View File

@ -116,14 +116,6 @@ ahriman.core.database.migrations.m013\_dependencies module
:no-undoc-members: :no-undoc-members:
:show-inheritance: :show-inheritance:
ahriman.core.database.migrations.m014\_auditlog module
------------------------------------------------------
.. automodule:: ahriman.core.database.migrations.m014_auditlog
:members:
:no-undoc-members:
:show-inheritance:
Module contents Module contents
--------------- ---------------

View File

@ -36,14 +36,6 @@ ahriman.core.database.operations.dependencies\_operations module
:no-undoc-members: :no-undoc-members:
:show-inheritance: :show-inheritance:
ahriman.core.database.operations.event\_operations module
---------------------------------------------------------
.. automodule:: ahriman.core.database.operations.event_operations
:members:
:no-undoc-members:
:show-inheritance:
ahriman.core.database.operations.logs\_operations module ahriman.core.database.operations.logs\_operations module
-------------------------------------------------------- --------------------------------------------------------

View File

@ -60,14 +60,6 @@ ahriman.core.report.report\_trigger module
:no-undoc-members: :no-undoc-members:
:show-inheritance: :show-inheritance:
ahriman.core.report.rss module
------------------------------
.. automodule:: ahriman.core.report.rss
:members:
:no-undoc-members:
:show-inheritance:
ahriman.core.report.telegram module ahriman.core.report.telegram module
----------------------------------- -----------------------------------

View File

@ -12,14 +12,6 @@ ahriman.core.repository.cleaner module
:no-undoc-members: :no-undoc-members:
:show-inheritance: :show-inheritance:
ahriman.core.repository.event\_logger module
--------------------------------------------
.. automodule:: ahriman.core.repository.event_logger
:members:
:no-undoc-members:
:show-inheritance:
ahriman.core.repository.executor module ahriman.core.repository.executor module
--------------------------------------- ---------------------------------------

View File

@ -68,14 +68,6 @@ ahriman.models.dependencies module
:no-undoc-members: :no-undoc-members:
:show-inheritance: :show-inheritance:
ahriman.models.event module
---------------------------
.. automodule:: ahriman.models.event
:members:
:no-undoc-members:
:show-inheritance:
ahriman.models.filesystem\_package module ahriman.models.filesystem\_package module
----------------------------------------- -----------------------------------------
@ -108,14 +100,6 @@ ahriman.models.log\_record\_id module
:no-undoc-members: :no-undoc-members:
:show-inheritance: :show-inheritance:
ahriman.models.metrics\_timer module
------------------------------------
.. automodule:: ahriman.models.metrics_timer
:members:
:no-undoc-members:
:show-inheritance:
ahriman.models.migration module ahriman.models.migration module
------------------------------- -------------------------------
@ -140,6 +124,14 @@ ahriman.models.package module
:no-undoc-members: :no-undoc-members:
:show-inheritance: :show-inheritance:
ahriman.models.package\_archive module
--------------------------------------
.. automodule:: ahriman.models.package_archive
:members:
:no-undoc-members:
:show-inheritance:
ahriman.models.package\_description module ahriman.models.package\_description module
------------------------------------------ ------------------------------------------

View File

@ -60,22 +60,6 @@ ahriman.web.schemas.error\_schema module
:no-undoc-members: :no-undoc-members:
:show-inheritance: :show-inheritance:
ahriman.web.schemas.event\_schema module
----------------------------------------
.. automodule:: ahriman.web.schemas.event_schema
:members:
:no-undoc-members:
:show-inheritance:
ahriman.web.schemas.event\_search\_schema module
------------------------------------------------
.. automodule:: ahriman.web.schemas.event_search_schema
:members:
:no-undoc-members:
:show-inheritance:
ahriman.web.schemas.file\_schema module ahriman.web.schemas.file\_schema module
--------------------------------------- ---------------------------------------

View File

@ -1,21 +0,0 @@
ahriman.web.views.v1.auditlog package
=====================================
Submodules
----------
ahriman.web.views.v1.auditlog.events module
-------------------------------------------
.. automodule:: ahriman.web.views.v1.auditlog.events
:members:
:no-undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: ahriman.web.views.v1.auditlog
:members:
:no-undoc-members:
:show-inheritance:

View File

@ -7,7 +7,6 @@ Subpackages
.. toctree:: .. toctree::
:maxdepth: 4 :maxdepth: 4
ahriman.web.views.v1.auditlog
ahriman.web.views.v1.distributed ahriman.web.views.v1.distributed
ahriman.web.views.v1.packages ahriman.web.views.v1.packages
ahriman.web.views.v1.service ahriman.web.views.v1.service

View File

@ -17,33 +17,14 @@ There are two variable types which have been added to default ones, they are pat
Path values, except for casting to ``pathlib.Path`` type, will be also expanded to absolute paths relative to the configuration path. E.g. if path is set to ``ahriman.ini.d/logging.ini`` and root configuration path is ``/etc/ahriman.ini``, the value will be expanded to ``/etc/ahriman.ini.d/logging.ini``. In order to disable path expand, use the full path, e.g. ``/etc/ahriman.ini.d/logging.ini``. Path values, except for casting to ``pathlib.Path`` type, will be also expanded to absolute paths relative to the configuration path. E.g. if path is set to ``ahriman.ini.d/logging.ini`` and root configuration path is ``/etc/ahriman.ini``, the value will be expanded to ``/etc/ahriman.ini.d/logging.ini``. In order to disable path expand, use the full path, e.g. ``/etc/ahriman.ini.d/logging.ini``.
Configuration allows string interpolation from the same configuration file, e.g.: Configuration allows string interpolation from environment variables, e.g.:
.. code-block:: ini
[section]
key = ${anoher_key}
another_key = value
will read value for the ``section.key`` option from ``section.another_key``. In case if the cross-section reference is required, the ``${section:another_key}`` notation must be used. It also allows string interpolation from environment variables, e.g.:
.. code-block:: ini .. code-block:: ini
[section] [section]
key = $SECRET key = $SECRET
will try to read value from ``SECRET`` environment variable. In case if the required environment variable wasn't found, it will keep original value (i.e. ``$SECRET`` in the example). Dollar sign can be set as ``$$``. All those interpolations will be applied in succession and - expected to be - recursively, e.g. the following configuration: will try to read value from ``SECRET`` environment variable. In case if the required environment variable wasn't found, it will keep original value (i.e. ``$SECRET`` in the example). Dollar sign can be set as ``$$``.
.. code-block:: ini
[section1]
key = ${section2:key}
[section2]
key = ${home}
home = $HOME
will eventually lead ``section1.key`` option to be set to the value of ``HOME`` environment variable (if available).
There is also additional subcommand which will allow to validate configuration and print found errors. In order to do so, run ``service-config-validate`` subcommand, e.g.: There is also additional subcommand which will allow to validate configuration and print found errors. In order to do so, run ``service-config-validate`` subcommand, e.g.:
@ -100,13 +81,14 @@ Authorized users are stored inside internal database, if any of external provide
Build related configuration. Group name can refer to architecture, e.g. ``build:x86_64`` can be used for x86_64 architecture specific settings. Build related configuration. Group name can refer to architecture, e.g. ``build:x86_64`` can be used for x86_64 architecture specific settings.
* ``allowed_scan_paths`` - paths to be used for implicit dependencies scan, scape separated list of paths, optional.
* ``archbuild_flags`` - additional flags passed to ``archbuild`` command, space separated list of strings, optional. * ``archbuild_flags`` - additional flags passed to ``archbuild`` command, space separated list of strings, optional.
* ``blacklisted_scan_paths`` - paths to be excluded for implicit dependencies scan, scape separated list of paths, optional. Normally all elements of this option must be child paths of any of ``allowed_scan_paths`` element.
* ``build_command`` - default build command, string, required. * ``build_command`` - default build command, string, required.
* ``ignore_packages`` - list packages to ignore during a regular update (manual update will still work), space separated list of strings, optional. * ``ignore_packages`` - list packages to ignore during a regular update (manual update will still work), space separated list of strings, optional.
* ``include_debug_packages`` - distribute debug packages, boolean, optional, default ``yes``. * ``include_debug_packages`` - distribute debug packages, boolean, optional, default ``yes``.
* ``makepkg_flags`` - additional flags passed to ``makepkg`` command, space separated list of strings, optional. * ``makepkg_flags`` - additional flags passed to ``makepkg`` command, space separated list of strings, optional.
* ``makechrootpkg_flags`` - additional flags passed to ``makechrootpkg`` command, space separated list of strings, optional. * ``makechrootpkg_flags`` - additional flags passed to ``makechrootpkg`` command, space separated list of strings, optional.
* ``scan_paths`` - paths to be used for implicit dependencies scan, space separated list of strings, optional. If any of those paths is matched against the path, it will be added to the allowed list.
* ``triggers`` - list of ``ahriman.core.triggers.Trigger`` class implementation (e.g. ``ahriman.core.report.ReportTrigger ahriman.core.upload.UploadTrigger``) which will be loaded and run at the end of processing, space separated list of strings, optional. You can also specify triggers by their paths, e.g. ``/usr/lib/python3.10/site-packages/ahriman/core/report/report.py.ReportTrigger``. Triggers are run in the order of definition. * ``triggers`` - list of ``ahriman.core.triggers.Trigger`` class implementation (e.g. ``ahriman.core.report.ReportTrigger ahriman.core.upload.UploadTrigger``) which will be loaded and run at the end of processing, space separated list of strings, optional. You can also specify triggers by their paths, e.g. ``/usr/lib/python3.10/site-packages/ahriman/core/report/report.py.ReportTrigger``. Triggers are run in the order of definition.
* ``triggers_known`` - optional list of ``ahriman.core.triggers.Trigger`` class implementations which are not run automatically and used only for trigger discovery and configuration validation. * ``triggers_known`` - optional list of ``ahriman.core.triggers.Trigger`` class implementations which are not run automatically and used only for trigger discovery and configuration validation.
* ``vcs_allowed_age`` - maximal age in seconds of the VCS packages before their version will be updated with its remote source, integer, optional, default is 7 days. * ``vcs_allowed_age`` - maximal age in seconds of the VCS packages before their version will be updated with its remote source, integer, optional, default is 7 days.
@ -270,7 +252,6 @@ Section name must be either ``email`` (plus optional architecture name, e.g. ``e
* ``password`` - SMTP password to authenticate, string, optional. * ``password`` - SMTP password to authenticate, string, optional.
* ``port`` - SMTP port for sending emails, integer, required. * ``port`` - SMTP port for sending emails, integer, required.
* ``receivers`` - SMTP receiver addresses, space separated list of strings, required. * ``receivers`` - SMTP receiver addresses, space separated list of strings, required.
* ``rss_url`` - link to RSS feed, string, optional.
* ``sender`` - SMTP sender address, string, required. * ``sender`` - SMTP sender address, string, required.
* ``ssl`` - SSL mode for SMTP connection, one of ``ssl``, ``starttls``, ``disabled``, optional, default ``disabled``. * ``ssl`` - SSL mode for SMTP connection, one of ``ssl``, ``starttls``, ``disabled``, optional, default ``disabled``.
* ``template`` - Jinja2 template name, string, required. * ``template`` - Jinja2 template name, string, required.
@ -286,8 +267,7 @@ Section name must be either ``html`` (plus optional architecture name, e.g. ``ht
* ``type`` - type of the report, string, optional, must be set to ``html`` if exists. * ``type`` - type of the report, string, optional, must be set to ``html`` if exists.
* ``homepage`` - link to homepage, string, optional. * ``homepage`` - link to homepage, string, optional.
* ``link_path`` - prefix for HTML links, string, required. * ``link_path`` - prefix for HTML links, string, required.
* ``path`` - path to HTML report file, string, required. * ``path`` - path to html report file, string, required.
* ``rss_url`` - link to RSS feed, string, optional.
* ``template`` - Jinja2 template name, string, required. * ``template`` - Jinja2 template name, string, required.
* ``templates`` - path to templates directories, space separated list of paths, required. * ``templates`` - path to templates directories, space separated list of paths, required.
@ -302,20 +282,6 @@ Section name must be either ``remote-call`` (plus optional architecture name, e.
* ``manual`` - update manually built packages, boolean, optional, default ``no``. * ``manual`` - update manually built packages, boolean, optional, default ``no``.
* ``wait_timeout`` - maximum amount of time in seconds to be waited before remote process will be terminated, integer, optional, default ``-1``. * ``wait_timeout`` - maximum amount of time in seconds to be waited before remote process will be terminated, integer, optional, default ``-1``.
``rss`` type
^^^^^^^^^^^^
Section name must be either ``rss`` (plus optional architecture name, e.g. ``rss:x86_64``) or random name with ``type`` set.
* ``type`` - type of the report, string, optional, must be set to ``rss`` if exists.
* ``homepage`` - link to homepage, string, optional.
* ``link_path`` - prefix for HTML links, string, required.
* ``max_entries`` - maximal amount of entries to be included to the report, negative means no limit, integer, optional, default ``-1``.
* ``path`` - path to generated RSS file, string, required.
* ``rss_url`` - link to RSS feed, string, optional.
* ``template`` - Jinja2 template name, string, required.
* ``templates`` - path to templates directories, space separated list of paths, required.
``telegram`` type ``telegram`` type
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^
@ -326,7 +292,6 @@ Section name must be either ``telegram`` (plus optional architecture name, e.g.
* ``chat_id`` - telegram chat id, either string with ``@`` or integer value, required. * ``chat_id`` - telegram chat id, either string with ``@`` or integer value, required.
* ``homepage`` - link to homepage, string, optional. * ``homepage`` - link to homepage, string, optional.
* ``link_path`` - prefix for HTML links, string, required. * ``link_path`` - prefix for HTML links, string, required.
* ``rss_url`` - link to RSS feed, string, optional.
* ``template`` - Jinja2 template name, string, required. * ``template`` - Jinja2 template name, string, required.
* ``template_type`` - ``parse_mode`` to be passed to telegram API, one of ``MarkdownV2``, ``HTML``, ``Markdown``, string, optional, default ``HTML``. * ``template_type`` - ``parse_mode`` to be passed to telegram API, one of ``MarkdownV2``, ``HTML``, ``Markdown``, string, optional, default ``HTML``.
* ``templates`` - path to templates directories, space separated list of paths, required. * ``templates`` - path to templates directories, space separated list of paths, required.

View File

@ -292,7 +292,7 @@ Worker nodes (applicable for all workers) config (``worker.ini``) as:
Command to run worker nodes (considering there will be two workers, one is on ``8081`` port and other is on ``8082``): Command to run worker nodes (considering there will be two workers, one is on ``8081`` port and other is on ``8082``):
.. code-block:: shell .. code-block:: ini
docker run --privileged -p 8081:8081 -e AHRIMAN_PORT=8081 -v worker.ini:/etc/ahriman.ini.d/overrides.ini arcan1s/ahriman:latest web docker run --privileged -p 8081:8081 -e AHRIMAN_PORT=8081 -v worker.ini:/etc/ahriman.ini.d/overrides.ini arcan1s/ahriman:latest web
docker run --privileged -p 8082:8082 -e AHRIMAN_PORT=8082 -v worker.ini:/etc/ahriman.ini.d/overrides.ini arcan1s/ahriman:latest web docker run --privileged -p 8082:8082 -e AHRIMAN_PORT=8082 -v worker.ini:/etc/ahriman.ini.d/overrides.ini arcan1s/ahriman:latest web

View File

@ -379,7 +379,7 @@ After the success build the application extracts all linked libraries and used d
In order to disable this check completely, the ``--no-check-files`` flag can be used. In order to disable this check completely, the ``--no-check-files`` flag can be used.
In addition, there is possibility to control paths which will be used for checking, by using option ``build.scan_paths``, which supports regular expressions. Leaving ``build.scan_paths`` blank will effectively disable any check too. In addition, there is possibility to control paths which will be used for checking, by using options ``build.allowed_scan_paths`` and ``build.blacklisted_scan_paths``. Leaving ``build.allowed_scan_paths`` blank will effectively disable any check too.
How to install built packages How to install built packages
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

View File

@ -47,7 +47,7 @@ How to generate index page for S3
target = html target = html
[html] [html]
path = ${repository:root}/repository/aur-clone/x86_64/index.html path = /var/lib/ahriman/repository/aur-clone/x86_64/index.html
link_path = http://example.com/aur-clone/x86_64 link_path = http://example.com/aur-clone/x86_64
After these steps ``index.html`` file will be automatically synced to S3. After these steps ``index.html`` file will be automatically synced to S3.

View File

@ -1,7 +1,7 @@
# Maintainer: Evgeniy Alekseev # Maintainer: Evgeniy Alekseev
pkgname='ahriman' pkgname='ahriman'
pkgver=2.14.0 pkgver=2.14.1
pkgrel=1 pkgrel=1
pkgdesc="ArcH linux ReposItory MANager" pkgdesc="ArcH linux ReposItory MANager"
arch=('any') arch=('any')

View File

@ -6,7 +6,7 @@ logging = ahriman.ini.d/logging.ini
; Perform database migrations on the application start. Do not touch this option unless you know what are you doing. ; Perform database migrations on the application start. Do not touch this option unless you know what are you doing.
;apply_migrations = yes ;apply_migrations = yes
; Path to the application SQLite database. ; Path to the application SQLite database.
database = ${repository:root}/ahriman.db database = /var/lib/ahriman/ahriman.db
[alpm] [alpm]
; Path to pacman system database cache. ; Path to pacman system database cache.
@ -17,7 +17,7 @@ mirror = https://geo.mirror.pkgbuild.com/$repo/os/$arch
repositories = core extra multilib repositories = core extra multilib
; Pacman's root directory. In the most cases it must point to the system root. ; Pacman's root directory. In the most cases it must point to the system root.
root = / root = /
; Sync files databases too, which is required by deep dependencies check. ; Sync files databases too, which is required by deep dependencies check
sync_files_database = yes sync_files_database = yes
; Use local packages cache. If this option is enabled, the service will be able to synchronize databases (available ; Use local packages cache. If this option is enabled, the service will be able to synchronize databases (available
; as additional option for some subcommands). If set to no, databases must be synchronized manually. ; as additional option for some subcommands). If set to no, databases must be synchronized manually.
@ -50,20 +50,22 @@ allow_read_only = yes
;salt = ;salt =
[build] [build]
; List of paths to be used for implicit dependency scan
allowed_scan_paths = /usr/lib
; List of additional flags passed to archbuild command. ; List of additional flags passed to archbuild command.
;archbuild_flags = ;archbuild_flags =
; Path to build command. ; List of paths to be excluded for implicit dependency scan. Usually they should be subpaths of allowed_scan_paths
blacklisted_scan_paths = /usr/lib/cmake
; Path to build command
;build_command = ;build_command =
; List of packages to be ignored during automatic updates. ; List of packages to be ignored during automatic updates.
;ignore_packages = ;ignore_packages =
; Include debug packages. ; Include debug packages
;include_debug_packages = yes ;include_debug_packages = yes
; List of additional flags passed to makechrootpkg command. ; List of additional flags passed to makechrootpkg command.
;makechrootpkg_flags = ;makechrootpkg_flags =
; List of additional flags passed to makepkg command. ; List of additional flags passed to makepkg command.
makepkg_flags = --nocolor --ignorearch makepkg_flags = --nocolor --ignorearch
; List of paths to be used for implicit dependency scan. Regular expressions are supported.
scan_paths = ^usr/lib(?!/cmake).*$
; List of enabled triggers in the order of calls. ; List of enabled triggers in the order of calls.
triggers = ahriman.core.gitremote.RemotePullTrigger ahriman.core.report.ReportTrigger ahriman.core.upload.UploadTrigger ahriman.core.gitremote.RemotePushTrigger triggers = ahriman.core.gitremote.RemotePullTrigger ahriman.core.report.ReportTrigger ahriman.core.upload.UploadTrigger ahriman.core.gitremote.RemotePushTrigger
; List of well-known triggers. Used only for configuration purposes. ; List of well-known triggers. Used only for configuration purposes.
@ -119,9 +121,9 @@ host = 127.0.0.1
; Disable status (e.g. package status, logs, etc) endpoints. Useful for build only modes. ; Disable status (e.g. package status, logs, etc) endpoints. Useful for build only modes.
;service_only = no ;service_only = no
; Path to directory with static files. ; Path to directory with static files.
static_path = ${templates}/static static_path = /usr/share/ahriman/templates/static
; List of directories with templates. ; List of directories with templates.
templates = ${prefix}/share/ahriman/templates templates = /usr/share/ahriman/templates
; Path to unix socket. If none set, unix socket will be disabled. ; Path to unix socket. If none set, unix socket will be disabled.
;unix_socket = ;unix_socket =
; Allow unix socket to be world readable. ; Allow unix socket to be world readable.
@ -212,14 +214,14 @@ target = console
; Console reporting trigger configuration sample. ; Console reporting trigger configuration sample.
[console] [console]
; Trigger type name. ; Trigger type name
;type = console ;type = console
; Use utf8 symbols in output. ; Use utf8 symbols in output.
use_utf = yes use_utf = yes
; Email reporting trigger configuration sample. ; Email reporting trigger configuration sample.
[email] [email]
; Trigger type name. ; Trigger type name
;type = email ;type = email
; Optional URL to the repository homepage. ; Optional URL to the repository homepage.
;homepage= ;homepage=
@ -235,8 +237,6 @@ use_utf = yes
;port = ;port =
; List of emails to receive the reports. ; List of emails to receive the reports.
;receivers = ;receivers =
; Optional link to the RSS feed.
;rss_url =
; Sender email. ; Sender email.
;sender = ;sender =
; SMTP server SSL mode, one of ssl, starttls, disabled. ; SMTP server SSL mode, one of ssl, starttls, disabled.
@ -246,13 +246,13 @@ template = email-index.jinja2
; Template name to be used for full packages list generation (same as HTML report). ; Template name to be used for full packages list generation (same as HTML report).
;template_full = ;template_full =
; List of directories with templates. ; List of directories with templates.
templates = ${prefix}/share/ahriman/templates templates = /usr/share/ahriman/templates
; SMTP user. ; SMTP user.
;user = ;user =
; HTML reporting trigger configuration sample. ; HTML reporting trigger configuration sample.
[html] [html]
; Trigger type name. ; Trigger type name
;type = html ;type = html
; Optional URL to the repository homepage. ; Optional URL to the repository homepage.
;homepage= ;homepage=
@ -260,16 +260,14 @@ templates = ${prefix}/share/ahriman/templates
;link_path = ;link_path =
; Output path for the HTML report. ; Output path for the HTML report.
;path = ;path =
; Optional link to the RSS feed.
;rss_url =
; Template name to be used. ; Template name to be used.
template = repo-index.jinja2 template = repo-index.jinja2
; List of directories with templates. ; List of directories with templates.
templates = ${prefix}/share/ahriman/templates templates = /usr/share/ahriman/templates
; Remote service callback trigger configuration sample. ; Remote service callback trigger configuration sample.
[remote-call] [remote-call]
; Trigger type name. ; Trigger type name
;type = remote-call ;type = remote-call
; Call for AUR packages update. ; Call for AUR packages update.
;aur = no ;aur = no
@ -280,26 +278,9 @@ templates = ${prefix}/share/ahriman/templates
; Wait until remote process will be terminated in seconds. ; Wait until remote process will be terminated in seconds.
;wait_timeout = -1 ;wait_timeout = -1
; RSS reporting trigger configuration sample.
[rss]
; Trigger type name.
;type = rss
; Optional URL to the repository homepage.
;homepage=
; Prefix for packages links. Link to a package will be formed as link_path / filename.
;link_path =
; Output path for the RSS report.
;path =
; Optional link to the RSS feed.
;rss_url =
; Template name to be used.
template = rss.jinja2
; List of directories with templates.
templates = ${prefix}/share/ahriman/templates
; Telegram reporting trigger configuration sample. ; Telegram reporting trigger configuration sample.
[telegram] [telegram]
; Trigger type name. ; Trigger type name
;type = telegram ;type = telegram
; Telegram bot API key. ; Telegram bot API key.
;api_key = ;api_key =
@ -309,14 +290,12 @@ templates = ${prefix}/share/ahriman/templates
;homepage= ;homepage=
; Prefix for packages links. Link to a package will be formed as link_path / filename. ; Prefix for packages links. Link to a package will be formed as link_path / filename.
;link_path = ;link_path =
; Optional link to the RSS feed.
;rss_url =
; Template name to be used. ; Template name to be used.
template = telegram-index.jinja2 template = telegram-index.jinja2
; Telegram specific template mode, one of MarkdownV2, HTML or Markdown. ; Telegram specific template mode, one of MarkdownV2, HTML or Markdown.
;template_type = HTML ;template_type = HTML
; List of directories with templates. ; List of directories with templates.
templates = ${prefix}/share/ahriman/templates templates = /usr/share/ahriman/templates
; HTTP request timeout in seconds. ; HTTP request timeout in seconds.
;timeout = 30 ;timeout = 30
@ -327,7 +306,7 @@ target =
; GitHub upload trigger configuration sample. ; GitHub upload trigger configuration sample.
[github] [github]
; Trigger type name. ; Trigger type name
;type = github ;type = github
; GitHub repository owner username. ; GitHub repository owner username.
;owner = ;owner =
@ -344,14 +323,14 @@ target =
; Remote instance upload trigger configuration sample. ; Remote instance upload trigger configuration sample.
[remote-service] [remote-service]
; Trigger type name. ; Trigger type name
;type = remote-service ;type = remote-service
; HTTP request timeout in seconds. ; HTTP request timeout in seconds.
;timeout = 30 ;timeout = 30
; rsync upload trigger configuration sample. ; rsync upload trigger configuration sample.
[rsync] [rsync]
; Trigger type name. ; Trigger type name
;type = rsync ;type = rsync
; rsync command to run. ; rsync command to run.
command = rsync --archive --compress --partial --delete command = rsync --archive --compress --partial --delete
@ -361,7 +340,7 @@ command = rsync --archive --compress --partial --delete
; S3 upload trigger configuration sample. ; S3 upload trigger configuration sample.
[s3] [s3]
; Trigger type name. ; Trigger type name
;type = s3 ;type = s3
; AWS services access key. ; AWS services access key.
;access_key = ;access_key =

View File

@ -1,5 +1,5 @@
[loggers] [loggers]
keys = root,http,stderr,boto3,botocore,nose,s3transfer,sql keys = root,http,stderr,boto3,botocore,nose,s3transfer
[handlers] [handlers]
keys = console_handler,journald_handler,syslog_handler keys = console_handler,journald_handler,syslog_handler
@ -64,8 +64,3 @@ propagate = 0
level = INFO level = INFO
qualname = s3transfer qualname = s3transfer
propagate = 0 propagate = 0
[logger_sql]
level = INFO
qualname = sql
propagate = 0

View File

@ -7,10 +7,6 @@
{% include "utils/style.jinja2" %} {% include "utils/style.jinja2" %}
{% include "user-style.jinja2" ignore missing %} {% include "user-style.jinja2" ignore missing %}
{% if rss_url is not none %}
<link rel="alternate" href="{{ rss_url }}" type="application/rss+xml">
{% endif %}
</head> </head>
<body> <body>

View File

@ -1,27 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
<title>{{ repository }}: Recent package updates</title>
{% if homepage is not none %}
<link>{{ homepage }}</link>
{% endif %}
<description>Recently updated packages in the {{ repository }}.</description>
{% if rss_url is not none %}
<atom:link href="{{ rss_url }}" rel="self"/>
{% endif %}
<language>en-us</language>
<lastBuildDate>{{ last_update }}</lastBuildDate>
{% for package in packages %}
<item>
<title>{{ package.name }} {{ package.version }} {{ package.architecture }}</title>
<link>{{ link_path }}/{{ package.filename }}</link>
<description>{{ package.description }}</description>
<pubDate>{{ package.build_date }}</pubDate>
<guid isPermaLink="false">{{ package.tag }}</guid>
<category>{{ repository }}</category>
<category>{{ package.architecture }}</category>
</item>
{% endfor %}
</channel>
</rss>

View File

@ -1,4 +1,4 @@
.TH AHRIMAN "1" "2024\-08\-23" "ahriman" "Generated Python Manual" .TH AHRIMAN "1" "2024\-09\-04" "ahriman" "Generated Python Manual"
.SH NAME .SH NAME
ahriman ahriman
.SH SYNOPSIS .SH SYNOPSIS

View File

@ -2,5 +2,5 @@
target = html target = html
[html] [html]
path = ${repository:root}/repository/ahriman-demo/x86_64/index.html path = /var/lib/ahriman/ahriman/repository/ahriman-demo/x86_64/index.html
link_path = http://localhost:8080/repo/ahriman-demo/x86_64 link_path = http://localhost:8080/repo/ahriman-demo/x86_64

View File

@ -17,4 +17,4 @@
# You should have received a copy of the GNU General Public License # You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>. # along with this program. If not, see <http://www.gnu.org/licenses/>.
# #
__version__ = "2.14.0" __version__ = "2.14.1"

View File

@ -120,7 +120,8 @@ class Application(ApplicationPackages, ApplicationRepository):
process_dependencies(bool): if no set, dependencies will not be processed process_dependencies(bool): if no set, dependencies will not be processed
Returns: Returns:
list[Package]: updated packages list. Packager for dependencies will be copied from the original package list[Package]: updated packages list. Packager for dependencies will be copied from
original package
Examples: Examples:
In the most cases, in order to avoid build failure, it is required to add missing packages, which can be In the most cases, in order to avoid build failure, it is required to add missing packages, which can be

View File

@ -59,7 +59,7 @@ class Handler:
repository_id(RepositoryId): repository unique identifier repository_id(RepositoryId): repository unique identifier
Returns: Returns:
bool: ``True`` on success, ``False`` otherwise bool: True on success, False otherwise
""" """
try: try:
configuration = Configuration.from_path(args.configuration, repository_id) configuration = Configuration.from_path(args.configuration, repository_id)
@ -129,7 +129,7 @@ class Handler:
check condition and flag and raise ExitCode exception in case if it is enabled and condition match check condition and flag and raise ExitCode exception in case if it is enabled and condition match
Args: Args:
enabled(bool): if ``False`` no check will be performed enabled(bool): if False no check will be performed
predicate(bool): indicates condition on which exception should be thrown predicate(bool): indicates condition on which exception should be thrown
Raises: Raises:

View File

@ -59,7 +59,7 @@ class Lock(LazyLogging):
>>> configuration = Configuration() >>> configuration = Configuration()
>>> try: >>> try:
>>> with Lock(args, RepositoryId("x86_64", "aur-clone"), configuration): >>> with Lock(args, RepositoryId("x86_64", "aur-clone"), configuration):
>>> do_something() >>> perform_actions()
>>> except Exception as exception: >>> except Exception as exception:
>>> handle_exceptions(exception) >>> handle_exceptions(exception)
""" """
@ -75,7 +75,9 @@ class Lock(LazyLogging):
""" """
self.path: Path | None = None self.path: Path | None = None
if args.lock is not None: if args.lock is not None:
self.path = args.lock.with_stem(f"{args.lock.stem}_{repository_id.id}") self.path = args.lock
if not repository_id.is_empty:
self.path = self.path.with_stem(f"{args.lock.stem}_{repository_id.id}")
if not self.path.is_absolute(): if not self.path.is_absolute():
# prepend full path to the lock file # prepend full path to the lock file
self.path = Path("/") / "run" / "ahriman" / self.path self.path = Path("/") / "run" / "ahriman" / self.path
@ -97,7 +99,7 @@ class Lock(LazyLogging):
fd(int): file descriptor: fd(int): file descriptor:
Returns: Returns:
bool: ``True`` in case if file is locked and ``False`` otherwise bool: True in case if file is locked and False otherwise
""" """
try: try:
fcntl.flock(fd, fcntl.LOCK_EX | fcntl.LOCK_NB) fcntl.flock(fd, fcntl.LOCK_EX | fcntl.LOCK_NB)
@ -119,7 +121,7 @@ class Lock(LazyLogging):
watch until lock disappear watch until lock disappear
Returns: Returns:
bool: ``True`` in case if file is locked and ``False`` otherwise bool: True in case if file is locked and False otherwise
""" """
# there are reasons why we are not using inotify here. First of all, if we would use it, it would bring to # there are reasons why we are not using inotify here. First of all, if we would use it, it would bring to
# race conditions because multiple processes will be notified at the same time. Secondly, it is good library, # race conditions because multiple processes will be notified at the same time. Secondly, it is good library,
@ -223,7 +225,7 @@ class Lock(LazyLogging):
exc_tb(TracebackType): exception traceback if any exc_tb(TracebackType): exception traceback if any
Returns: Returns:
Literal[False]: always ``False`` (do not suppress any exception) Literal[False]: always False (do not suppress any exception)
""" """
self.clear() self.clear()
status = BuildStatusEnum.Success if exc_val is None else BuildStatusEnum.Failed status = BuildStatusEnum.Success if exc_val is None else BuildStatusEnum.Failed

View File

@ -102,7 +102,7 @@ class PacmanDatabase(SyncHttpClient):
local_path(Path): path to locally stored file local_path(Path): path to locally stored file
Returns: Returns:
bool: ``True`` in case if remote file is newer than local file bool: True in case if remote file is newer than local file
Raises: Raises:
PacmanError: in case if no last-modified header was found PacmanError: in case if no last-modified header was found

View File

@ -96,7 +96,7 @@ class Auth(LazyLogging):
password(str | None): entered password password(str | None): entered password
Returns: Returns:
bool: ``True`` in case if password matches, ``False`` otherwise bool: True in case if password matches, False otherwise
""" """
del username, password del username, password
return True return True
@ -109,7 +109,7 @@ class Auth(LazyLogging):
username(str): username username(str): username
Returns: Returns:
bool: ``True`` in case if user is known and can be authorized and ``False`` otherwise bool: True in case if user is known and can be authorized and False otherwise
""" """
del username del username
return True return True
@ -124,7 +124,7 @@ class Auth(LazyLogging):
context(str | None): URI request path context(str | None): URI request path
Returns: Returns:
bool: ``True`` in case if user is allowed to do this request and ``False`` otherwise bool: True in case if user is allowed to do this request and False otherwise
""" """
del username, required, context del username, required, context
return True return True

View File

@ -38,7 +38,7 @@ async def authorized_userid(*args: Any, **kwargs: Any) -> Any:
**kwargs(Any): named argument list as provided by authorized_userid function **kwargs(Any): named argument list as provided by authorized_userid function
Returns: Returns:
Any: ``None`` in case if no aiohttp_security module found and function call otherwise Any: None in case if no aiohttp_security module found and function call otherwise
""" """
if _has_aiohttp_security: if _has_aiohttp_security:
return await aiohttp_security.authorized_userid(*args, **kwargs) # pylint: disable=no-value-for-parameter return await aiohttp_security.authorized_userid(*args, **kwargs) # pylint: disable=no-value-for-parameter
@ -54,7 +54,7 @@ async def check_authorized(*args: Any, **kwargs: Any) -> Any:
**kwargs(Any): named argument list as provided by authorized_userid function **kwargs(Any): named argument list as provided by authorized_userid function
Returns: Returns:
Any: ``None`` in case if no aiohttp_security module found and function call otherwise Any: None in case if no aiohttp_security module found and function call otherwise
""" """
if _has_aiohttp_security: if _has_aiohttp_security:
return await aiohttp_security.check_authorized(*args, **kwargs) # pylint: disable=no-value-for-parameter return await aiohttp_security.check_authorized(*args, **kwargs) # pylint: disable=no-value-for-parameter
@ -70,7 +70,7 @@ async def forget(*args: Any, **kwargs: Any) -> Any:
**kwargs(Any): named argument list as provided by authorized_userid function **kwargs(Any): named argument list as provided by authorized_userid function
Returns: Returns:
Any: ``None`` in case if no aiohttp_security module found and function call otherwise Any: None in case if no aiohttp_security module found and function call otherwise
""" """
if _has_aiohttp_security: if _has_aiohttp_security:
return await aiohttp_security.forget(*args, **kwargs) # pylint: disable=no-value-for-parameter return await aiohttp_security.forget(*args, **kwargs) # pylint: disable=no-value-for-parameter
@ -86,7 +86,7 @@ async def remember(*args: Any, **kwargs: Any) -> Any:
**kwargs(Any): named argument list as provided by authorized_userid function **kwargs(Any): named argument list as provided by authorized_userid function
Returns: Returns:
Any: ``None`` in case if no aiohttp_security module found and function call otherwise Any: None in case if no aiohttp_security module found and function call otherwise
""" """
if _has_aiohttp_security: if _has_aiohttp_security:
return await aiohttp_security.remember(*args, **kwargs) # pylint: disable=no-value-for-parameter return await aiohttp_security.remember(*args, **kwargs) # pylint: disable=no-value-for-parameter

View File

@ -57,7 +57,7 @@ class Mapping(Auth):
password(str | None): entered password password(str | None): entered password
Returns: Returns:
bool: ``True`` in case if password matches, ``False`` otherwise bool: True in case if password matches, False otherwise
""" """
if password is None: if password is None:
return False # invalid data supplied return False # invalid data supplied
@ -72,7 +72,7 @@ class Mapping(Auth):
username(str): username username(str): username
Returns: Returns:
User | None: user descriptor if username is known and ``None`` otherwise User | None: user descriptor if username is known and None otherwise
""" """
return self.database.user_get(username) return self.database.user_get(username)
@ -84,7 +84,7 @@ class Mapping(Auth):
username(str): username username(str): username
Returns: Returns:
bool: ``True`` in case if user is known and can be authorized and ``False`` otherwise bool: True in case if user is known and can be authorized and False otherwise
""" """
return username is not None and self.get_user(username) is not None return username is not None and self.get_user(username) is not None
@ -98,7 +98,7 @@ class Mapping(Auth):
context(str | None): URI request path context(str | None): URI request path
Returns: Returns:
bool: ``True`` in case if user is allowed to do this request and ``False`` otherwise bool: True in case if user is allowed to do this request and False otherwise
""" """
user = self.get_user(username) user = self.get_user(username)
return user is not None and user.verify_access(required) return user is not None and user.verify_access(required)

View File

@ -79,7 +79,7 @@ class PAM(Mapping):
password(str | None): entered password password(str | None): entered password
Returns: Returns:
bool: ``True`` in case if password matches, ``False`` otherwise bool: True in case if password matches, False otherwise
""" """
if password is None: if password is None:
return False # invalid data supplied return False # invalid data supplied
@ -101,7 +101,7 @@ class PAM(Mapping):
username(str): username username(str): username
Returns: Returns:
bool: ``True`` in case if user is known and can be authorized and ``False`` otherwise bool: True in case if user is known and can be authorized and False otherwise
""" """
try: try:
_ = getpwnam(username) _ = getpwnam(username)
@ -119,7 +119,7 @@ class PAM(Mapping):
context(str | None): URI request path context(str | None): URI request path
Returns: Returns:
bool: ``True`` in case if user is allowed to do this request and ``False`` otherwise bool: True in case if user is allowed to do this request and False otherwise
""" """
# this method is basically inverted, first we check overrides in database and then fallback to the PAM logic # this method is basically inverted, first we check overrides in database and then fallback to the PAM logic
if (user := self.get_user(username)) is not None: if (user := self.get_user(username)) is not None:

View File

@ -138,7 +138,7 @@ class Sources(LazyLogging):
sources_dir(Path): local path to git repository sources_dir(Path): local path to git repository
Returns: Returns:
bool: ``True`` in case if there is any remote and false otherwise bool: True in case if there is any remote and false otherwise
""" """
instance = Sources() instance = Sources()
remotes = check_output(*instance.git(), "remote", cwd=sources_dir, logger=instance.logger) remotes = check_output(*instance.git(), "remote", cwd=sources_dir, logger=instance.logger)
@ -261,7 +261,7 @@ class Sources(LazyLogging):
commit_author(tuple[str, str] | None, optional): optional commit author if any (Default value = None) commit_author(tuple[str, str] | None, optional): optional commit author if any (Default value = None)
Returns: Returns:
bool: ``True`` in case if changes have been committed and ``False`` otherwise bool: True in case if changes have been committed and False otherwise
""" """
if not self.has_changes(sources_dir): if not self.has_changes(sources_dir):
return False # nothing to commit return False # nothing to commit
@ -351,7 +351,7 @@ class Sources(LazyLogging):
sources_dir(Path): local path to git repository sources_dir(Path): local path to git repository
Returns: Returns:
bool: ``True`` if there are uncommitted changes and ``False`` otherwise bool: True if there are uncommitted changes and False otherwise
""" """
# there is --exit-code argument to diff, however, there might be other process errors # there is --exit-code argument to diff, however, there might be other process errors
changes = check_output(*self.git(), "diff", "--cached", "--name-only", cwd=sources_dir, logger=self.logger) changes = check_output(*self.git(), "diff", "--cached", "--name-only", cwd=sources_dir, logger=self.logger)

View File

@ -46,8 +46,7 @@ class Configuration(configparser.RawConfigParser):
Examples: Examples:
Configuration class provides additional method in order to handle application configuration. Since this class is Configuration class provides additional method in order to handle application configuration. Since this class is
derived from built-in :class:`configparser.RawConfigParser` class, the same flow is applicable here. derived from built-in :class:`configparser.RawConfigParser` class, the same flow is applicable here.
Nevertheless, it is recommended to use :func:`from_path()` class method which also calls initialization Nevertheless, it is recommended to use :func:`from_path` class method which also calls initialization methods::
methods::
>>> from pathlib import Path >>> from pathlib import Path
>>> >>>
@ -58,7 +57,7 @@ class Configuration(configparser.RawConfigParser):
The configuration instance loaded in this way will contain only sections which are defined for the specified The configuration instance loaded in this way will contain only sections which are defined for the specified
architecture according to the merge rules. Moreover, the architecture names will be removed from section names. architecture according to the merge rules. Moreover, the architecture names will be removed from section names.
In order to get current settings, the :func:`check_loaded()` method can be used. This method will raise an In order to get current settings, the :func:`check_loaded` method can be used. This method will raise an
:exc:`ahriman.core.exceptions.InitializeError` in case if configuration was not yet loaded:: :exc:`ahriman.core.exceptions.InitializeError` in case if configuration was not yet loaded::
>>> path, repository_id = configuration.check_loaded() >>> path, repository_id = configuration.check_loaded()
@ -345,8 +344,7 @@ class Configuration(configparser.RawConfigParser):
def set_option(self, section: str, option: str, value: str) -> None: def set_option(self, section: str, option: str, value: str) -> None:
""" """
set option. Unlike default :func:`configparser.RawConfigParser.set()` it also creates section if set option. Unlike default :func:`configparser.RawConfigParser.set` it also creates section if it does not exist
it does not exist
Args: Args:
section(str): section name section(str): section name

View File

@ -169,6 +169,14 @@ CONFIGURATION_SCHEMA: ConfigurationSchema = {
"build": { "build": {
"type": "dict", "type": "dict",
"schema": { "schema": {
"allowed_scan_paths": {
"type": "list",
"coerce": "list",
"schema": {
"type": "path",
"coerce": "absolute_path",
},
},
"archbuild_flags": { "archbuild_flags": {
"type": "list", "type": "list",
"coerce": "list", "coerce": "list",
@ -177,6 +185,14 @@ CONFIGURATION_SCHEMA: ConfigurationSchema = {
"empty": False, "empty": False,
}, },
}, },
"blacklisted_scan_paths": {
"type": "list",
"coerce": "list",
"schema": {
"type": "path",
"coerce": "absolute_path",
},
},
"build_command": { "build_command": {
"type": "string", "type": "string",
"required": True, "required": True,
@ -210,14 +226,6 @@ CONFIGURATION_SCHEMA: ConfigurationSchema = {
"empty": False, "empty": False,
}, },
}, },
"scan_paths": {
"type": "list",
"coerce": "list",
"schema": {
"type": "string",
"empty": False,
},
},
"triggers": { "triggers": {
"type": "list", "type": "list",
"coerce": "list", "coerce": "list",

View File

@ -19,93 +19,21 @@
# #
import configparser import configparser
import os import os
import sys
from collections.abc import Generator, Mapping, MutableMapping from collections.abc import Mapping, MutableMapping
from string import Template from string import Template
class ExtendedTemplate(Template):
"""
extension to the default :class:`Template` class, which also enabled braces regex to lookup in sections
Attributes:
braceidpattern(str): regular expression to match a colon inside braces
"""
braceidpattern = r"(?a:[_a-z0-9][_a-z0-9:]*)"
class ShellInterpolator(configparser.Interpolation): class ShellInterpolator(configparser.Interpolation):
""" """
custom string interpolator, because we cannot use defaults argument due to config validation custom string interpolator, because we cannot use defaults argument due to config validation
""" """
DATA_LINK_ESCAPE = "\x10"
@staticmethod
def _extract_variables(parser: MutableMapping[str, Mapping[str, str]], value: str,
defaults: Mapping[str, str]) -> Generator[tuple[str, str], None, None]:
"""
extract keys and values (if available) from the configuration. In case if a key is not available, it will be
silently skipped from the result
Args:
parser(MutableMapping[str, Mapping[str, str]]): option parser
value(str): source (not-converted) value
defaults(Mapping[str, str]): default values
Yields:
tuple[str, str]: variable name used for substitution and its value
"""
def identifiers() -> Generator[tuple[str | None, str], None, None]:
# extract all found identifiers and parse them
for identifier in ExtendedTemplate(value).get_identifiers():
match identifier.split(":"):
case [lookup_option]: # single option from the same section
yield None, lookup_option
case [lookup_section, lookup_option]: # reference to another section
yield lookup_section, lookup_option
for section, option in identifiers():
# key to be substituted
key = f"{section}:{option}" if section else option
if section is not None: # foreign section case
if section not in parser:
continue # section was not found, silently skip it
values = parser[section]
else: # same section
values = defaults
if (raw := values.get(option)) is not None:
yield key, raw
@staticmethod
def environment() -> dict[str, str]:
"""
extract environment variables
Returns:
dict[str, str]: environment variables and some custom variables
"""
return os.environ | {
"prefix": sys.prefix,
}
def before_get(self, parser: MutableMapping[str, Mapping[str, str]], section: str, option: str, value: str, def before_get(self, parser: MutableMapping[str, Mapping[str, str]], section: str, option: str, value: str,
defaults: Mapping[str, str]) -> str: defaults: Mapping[str, str]) -> str:
""" """
interpolate option value interpolate option value
Notes:
This method is using :class:`string.Template` class in order to render both cross-references and
environment variables, because it seems that it is the most legit way to handle it. In addition,
we are using shell-like variables in some cases (see :attr:`alpm.mirror` option), thus we would like
to keep them alive.
First this method resolves substitution from the configuration and then renders environment variables
Args: Args:
parser(MutableMapping[str, Mapping[str, str]]): option parser parser(MutableMapping[str, Mapping[str, str]]): option parser
section(str): section name section(str): section name
@ -116,15 +44,8 @@ class ShellInterpolator(configparser.Interpolation):
Returns: Returns:
str: substituted value str: substituted value
""" """
# because any substitution effectively replace escaped $ ($$) in result, we have to escape it manually # At the moment it seems that it is the most legit way to handle environment variables
escaped = value.replace("$$", self.DATA_LINK_ESCAPE) # Template behaviour is literally the same as shell
# In addition, we are using shell-like variables in some cases (see :attr:`alpm.mirror` option),
# resolve internal references # thus we would like to keep them alive
variables = dict(self._extract_variables(parser, value, defaults)) return Template(value).safe_substitute(os.environ)
internal = ExtendedTemplate(escaped).safe_substitute(variables)
# resolve enriched environment variables by using default Template class
environment = Template(internal).safe_substitute(self.environment())
# replace escaped values back
return environment.replace(self.DATA_LINK_ESCAPE, "$")

View File

@ -35,9 +35,8 @@ class Validator(RootValidator):
configuration(Configuration): configuration instance configuration(Configuration): configuration instance
""" """
types_mapping = RootValidator.types_mapping | { types_mapping = RootValidator.types_mapping.copy()
"path": TypeDefinition("path", (Path,), ()), types_mapping["path"] = TypeDefinition("path", (Path,), ())
}
def __init__(self, *args: Any, **kwargs: Any) -> None: def __init__(self, *args: Any, **kwargs: Any) -> None:
""" """
@ -150,7 +149,7 @@ class Validator(RootValidator):
check if paths exists check if paths exists
Args: Args:
constraint(bool): ``True`` in case if path must exist and ``False`` otherwise constraint(bool): True in case if path must exist and False otherwise
field(str): field name to be checked field(str): field name to be checked
value(Path): value to be checked value(Path): value to be checked

View File

@ -1,38 +0,0 @@
#
# Copyright (c) 2021-2024 ahriman team.
#
# This file is part of ahriman
# (see https://github.com/arcan1s/ahriman).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
__all__ = ["steps"]
steps = [
"""
create table auditlog (
created integer not null,
repository text not null,
event text not null,
object_id text not null,
message text,
data json
)
""",
"""
create index auditlog_created_repository_event_object_id
on auditlog (created, repository, event, object_id)
""",
]

View File

@ -21,7 +21,6 @@ from ahriman.core.database.operations.auth_operations import AuthOperations
from ahriman.core.database.operations.build_operations import BuildOperations from ahriman.core.database.operations.build_operations import BuildOperations
from ahriman.core.database.operations.changes_operations import ChangesOperations from ahriman.core.database.operations.changes_operations import ChangesOperations
from ahriman.core.database.operations.dependencies_operations import DependenciesOperations from ahriman.core.database.operations.dependencies_operations import DependenciesOperations
from ahriman.core.database.operations.event_operations import EventOperations
from ahriman.core.database.operations.logs_operations import LogsOperations from ahriman.core.database.operations.logs_operations import LogsOperations
from ahriman.core.database.operations.package_operations import PackageOperations from ahriman.core.database.operations.package_operations import PackageOperations
from ahriman.core.database.operations.patch_operations import PatchOperations from ahriman.core.database.operations.patch_operations import PatchOperations

View File

@ -39,7 +39,7 @@ class DependenciesOperations(Operations):
repository_id(RepositoryId, optional): repository unique identifier override (Default value = None) repository_id(RepositoryId, optional): repository unique identifier override (Default value = None)
Returns: Returns:
Dependencies: dependencies for the package base if available Dependencies: changes for the package base if available
""" """
repository_id = repository_id or self._repository_id repository_id = repository_id or self._repository_id

View File

@ -1,101 +0,0 @@
#
# Copyright (c) 2021-2024 ahriman team.
#
# This file is part of ahriman
# (see https://github.com/arcan1s/ahriman).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
from sqlite3 import Connection
from ahriman.core.database.operations.operations import Operations
from ahriman.models.event import Event, EventType
from ahriman.models.repository_id import RepositoryId
class EventOperations(Operations):
"""
operations for audit log table
"""
def event_get(self, event: str | EventType | None = None, object_id: str | None = None,
limit: int = -1, offset: int = 0, repository_id: RepositoryId | None = None) -> list[Event]:
"""
get list of events with filters applied
Args:
event(str | EventType | None, optional): filter by event type (Default value = None)
object_id(str | None, optional): filter by event object (Default value = None)
limit(int, optional): limit records to the specified count, -1 means unlimited (Default value = -1)
offset(int, optional): records offset (Default value = 0)
repository_id(RepositoryId, optional): repository unique identifier override (Default value = None)
Returns:
list[Event]: list of audit log events
"""
repository_id = repository_id or self._repository_id
def run(connection: Connection) -> list[Event]:
return [
Event.from_json(row)
for row in connection.execute(
"""
select created, event, object_id, message, data from (
select * from auditlog
where (:event is null or event = :event)
and (:object_id is null or object_id = :object_id)
and repository = :repository
order by created desc limit :limit offset :offset
) order by created asc
""",
{
"event": event,
"object_id": object_id,
"repository": repository_id.id,
"limit": limit,
"offset": offset,
}
)
]
return self.with_connection(run)
def event_insert(self, event: Event, repository_id: RepositoryId | None = None) -> None:
"""
insert audit log event
Args:
event(Event): event to insert
repository_id(RepositoryId, optional): repository unique identifier override (Default value = None)
"""
repository_id = repository_id or self._repository_id
def run(connection: Connection) -> None:
connection.execute(
"""
insert into auditlog
(created, repository, event, object_id, message, data)
values
(:created, :repository, :event, :object_id, :message, :data)
""",
{
"created": event.created,
"repository": repository_id.id,
"event": event.event,
"object_id": event.object_id,
"message": event.message,
"data": event.data,
})
return self.with_connection(run, commit=True)

View File

@ -50,11 +50,9 @@ class LogsOperations(Operations):
(row["created"], row["record"]) (row["created"], row["record"])
for row in connection.execute( for row in connection.execute(
""" """
select created, record from ( select created, record from logs
select * from logs where package_base = :package_base and repository = :repository
where package_base = :package_base and repository = :repository order by created limit :limit offset :offset
order by created desc limit :limit offset :offset
) order by created asc
""", """,
{ {
"package_base": package_base, "package_base": package_base,

View File

@ -46,22 +46,11 @@ class Operations(LazyLogging):
Args: Args:
path(Path): path to the database file path(Path): path to the database file
repository_id(RepositoryId): repository unique identifier repository_id(RepositoryId): repository unique identifier
repository_paths(RepositoryPaths): repository paths
""" """
self.path = path self.path = path
self._repository_id = repository_id self._repository_id = repository_id
self._repository_paths = repository_paths self._repository_paths = repository_paths
@property
def logger_name(self) -> str:
"""
extract logger name for the class
Returns:
str: logger name override
"""
return "sql"
@staticmethod @staticmethod
def factory(cursor: sqlite3.Cursor, row: tuple[Any, ...]) -> dict[str, Any]: def factory(cursor: sqlite3.Cursor, row: tuple[Any, ...]) -> dict[str, Any]:
""" """
@ -85,13 +74,12 @@ class Operations(LazyLogging):
Args: Args:
query(Callable[[Connection], T]): function to be called with connection query(Callable[[Connection], T]): function to be called with connection
commit(bool, optional): if ``True`` commit() will be called on success (Default value = False) commit(bool, optional): if True commit() will be called on success (Default value = False)
Returns: Returns:
T: result of the ``query`` call T: result of the ``query`` call
""" """
with sqlite3.connect(self.path, detect_types=sqlite3.PARSE_DECLTYPES) as connection: with sqlite3.connect(self.path, detect_types=sqlite3.PARSE_DECLTYPES) as connection:
connection.set_trace_callback(self.logger.debug)
connection.row_factory = self.factory connection.row_factory = self.factory
result = query(connection) result = query(connection)
if commit: if commit:

View File

@ -26,7 +26,8 @@ from typing import Self
from ahriman.core.configuration import Configuration from ahriman.core.configuration import Configuration
from ahriman.core.database.migrations import Migrations from ahriman.core.database.migrations import Migrations
from ahriman.core.database.operations import AuthOperations, BuildOperations, ChangesOperations, \ from ahriman.core.database.operations import AuthOperations, BuildOperations, ChangesOperations, \
DependenciesOperations, EventOperations, LogsOperations, PackageOperations, PatchOperations DependenciesOperations, LogsOperations, PackageOperations, PatchOperations
from ahriman.models.repository_id import RepositoryId
# pylint: disable=too-many-ancestors # pylint: disable=too-many-ancestors
@ -35,7 +36,6 @@ class SQLite(
BuildOperations, BuildOperations,
ChangesOperations, ChangesOperations,
DependenciesOperations, DependenciesOperations,
EventOperations,
LogsOperations, LogsOperations,
PackageOperations, PackageOperations,
PatchOperations): PatchOperations):
@ -103,23 +103,26 @@ class SQLite(
self.with_connection(lambda connection: Migrations.migrate(connection, configuration)) self.with_connection(lambda connection: Migrations.migrate(connection, configuration))
paths.chown(self.path) paths.chown(self.path)
def package_clear(self, package_base: str) -> None: def package_clear(self, package_base: str, repository_id: RepositoryId | None = None) -> None:
""" """
completely remove package from all tables completely remove package from all tables
Args: Args:
package_base(str): package base to remove package_base(str): package base to remove
repository_id(RepositoryId, optional): repository unique identifier override (Default value = None)
Examples: Examples:
This method completely removes the package from all tables and must be used, e.g. on package removal:: This method completely removes the package from all tables and must be used, e.g. on package removal::
>>> database.package_clear("ahriman") >>> database.package_clear("ahriman")
""" """
self.build_queue_clear(package_base) self.build_queue_clear(package_base, repository_id)
self.patches_remove(package_base, []) self.patches_remove(package_base, None)
self.logs_remove(package_base, None) self.logs_remove(package_base, None, repository_id)
self.changes_remove(package_base) self.changes_remove(package_base, repository_id)
self.dependencies_remove(package_base) self.dependencies_remove(package_base, repository_id)
self.package_remove(package_base, repository_id)
# remove local cache too # remove local cache too
self._repository_paths.tree_clear(package_base) self._repository_paths.tree_clear(package_base)

View File

@ -32,7 +32,7 @@ class BuildPrinter(StringPrinter):
Args: Args:
package(Package): built package package(Package): built package
is_success(bool): ``True`` in case if build has success status and ``False`` otherwise is_success(bool): True in case if build has success status and False otherwise
use_utf(bool): use utf instead of normal symbols use_utf(bool): use utf instead of normal symbols
""" """
StringPrinter.__init__(self, f"{self.sign(is_success, use_utf)} {package.base}") StringPrinter.__init__(self, f"{self.sign(is_success, use_utf)} {package.base}")
@ -43,7 +43,7 @@ class BuildPrinter(StringPrinter):
generate sign according to settings generate sign according to settings
Args: Args:
is_success(bool): ``True`` in case if build has success status and ``False`` otherwise is_success(bool): True in case if build has success status and False otherwise
use_utf(bool): use utf instead of normal symbols use_utf(bool): use utf instead of normal symbols
Returns: Returns:

View File

@ -57,7 +57,7 @@ class ChangesPrinter(Printer):
generate entry title from content generate entry title from content
Returns: Returns:
str | None: content title if it can be generated and ``None`` otherwise str | None: content title if it can be generated and None otherwise
""" """
if self.changes.is_empty: if self.changes.is_empty:
return None return None

View File

@ -63,7 +63,7 @@ class Printer:
generate entry title from content generate entry title from content
Returns: Returns:
str | None: content title if it can be generated and ``None`` otherwise str | None: content title if it can be generated and None otherwise
""" """
return None return None

View File

@ -42,6 +42,6 @@ class StringPrinter(Printer):
generate entry title from content generate entry title from content
Returns: Returns:
str | None: content title if it can be generated and ``None`` otherwise str | None: content title if it can be generated and None otherwise
""" """
return self.content return self.content

View File

@ -85,7 +85,7 @@ class SyncHttpClient(LazyLogging):
exception(requests.RequestException): exception raised exception(requests.RequestException): exception raised
Returns: Returns:
str: text of the response if it is not ``None`` and empty string otherwise str: text of the response if it is not None and empty string otherwise
""" """
result: str = exception.response.text if exception.response is not None else "" result: str = exception.response.text if exception.response is not None else ""
return result return result

View File

@ -29,8 +29,7 @@ from ahriman.models.repository_id import RepositoryId
class HttpLogHandler(logging.Handler): class HttpLogHandler(logging.Handler):
""" """
handler for the http logging. Because default :class:`logging.handlers.HTTPHandler` does not support cookies handler for the http logging. Because default :class:`logging.handlers.HTTPHandler` does not support cookies
authorization, we have to implement own handler which overrides the :func:`logging.handlers.HTTPHandler.emit()` authorization, we have to implement own handler which overrides the :func:`logging.handlers.HTTPHandler.emit` method
method
Attributes: Attributes:
reporter(Client): build status reporter instance reporter(Client): build status reporter instance

View File

@ -17,16 +17,14 @@
# You should have received a copy of the GNU General Public License # You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>. # along with this program. If not, see <http://www.gnu.org/licenses/>.
# #
import datetime
import jinja2 import jinja2
from collections.abc import Callable from collections.abc import Callable
from pathlib import Path from pathlib import Path
from typing import Any
from ahriman.core.configuration import Configuration from ahriman.core.configuration import Configuration
from ahriman.core.sign.gpg import GPG from ahriman.core.sign.gpg import GPG
from ahriman.core.utils import pretty_datetime, pretty_size, utcnow from ahriman.core.utils import pretty_datetime, pretty_size
from ahriman.models.repository_id import RepositoryId from ahriman.models.repository_id import RepositoryId
from ahriman.models.result import Result from ahriman.models.result import Result
from ahriman.models.sign_settings import SignSettings from ahriman.models.sign_settings import SignSettings
@ -39,34 +37,30 @@ class JinjaTemplate:
It uses jinja2 templates for report generation, the following variables are allowed: It uses jinja2 templates for report generation, the following variables are allowed:
* homepage - link to homepage, string, optional * homepage - link to homepage, string, optional
* last_update - report generation time, pretty printed datetime, required
* link_path - prefix fo packages to download, string, required * link_path - prefix fo packages to download, string, required
* has_package_signed - ``True`` in case if package sign enabled, ``False`` otherwise, required * has_package_signed - True in case if package sign enabled, False otherwise, required
* has_repo_signed - ``True`` in case if repository database sign enabled, ``False`` otherwise, required * has_repo_signed - True in case if repository database sign enabled, False otherwise, required
* packages - sorted list of packages properties, required * packages - sorted list of packages properties, required
* architecture, string * architecture, string
* archive_size, pretty printed size, string * archive_size, pretty printed size, string
* build_date, pretty printed datetime, string * build_date, pretty printed datetime, string
* depends, sorted list of strings * depends, sorted list of strings
* description, string * description, string
* filename, string * filename, string,
* groups, sorted list of strings * groups, sorted list of strings
* installed_size, pretty printed size, string * installed_size, pretty printed datetime, string
* licenses, sorted list of strings * licenses, sorted list of strings
* name, string * name, string
* tag, string
* url, string * url, string
* version, string * version, string
* pgp_key - default PGP key ID, string, optional * pgp_key - default PGP key ID, string, optional
* repository - repository name, string, required * repository - repository name, string, required
* rss_url - optional link to the RSS feed, string, optional
Attributes: Attributes:
default_pgp_key(str | None): default PGP key default_pgp_key(str | None): default PGP key
homepage(str | None): homepage link if any (for footer) homepage(str | None): homepage link if any (for footer)
link_path(str): prefix fo packages to download link_path(str): prefix fo packages to download
name(str): repository name name(str): repository name
rss_url(str | None): link to the RSS feed
sign_targets(set[SignSettings]): targets to sign enabled in configuration sign_targets(set[SignSettings]): targets to sign enabled in configuration
templates(list[Path]): list of directories with templates templates(list[Path]): list of directories with templates
""" """
@ -86,36 +80,8 @@ class JinjaTemplate:
self.homepage = configuration.get(section, "homepage", fallback=None) self.homepage = configuration.get(section, "homepage", fallback=None)
self.link_path = configuration.get(section, "link_path") self.link_path = configuration.get(section, "link_path")
self.name = repository_id.name self.name = repository_id.name
self.rss_url = configuration.get(section, "rss_url", fallback=None)
self.sign_targets, self.default_pgp_key = GPG.sign_options(configuration) self.sign_targets, self.default_pgp_key = GPG.sign_options(configuration)
@staticmethod
def format_datetime(timestamp: datetime.datetime | float | int | None) -> str:
"""
convert datetime object to string
Args:
timestamp(datetime.datetime | float | int | None): datetime to convert
Returns:
str: datetime as string representation
"""
return pretty_datetime(timestamp)
@staticmethod
def sort_content(content: list[dict[str, Any]]) -> list[dict[str, Any]]:
"""
sort content before rendering
Args:
content(list[dict[str, str]]): content of the template
Returns:
list[dict[str, str]]: sorted content according to comparator defined
"""
comparator: Callable[[dict[str, str]], str] = lambda item: item["filename"]
return sorted(content, key=comparator)
def make_html(self, result: Result, template_name: Path | str) -> str: def make_html(self, result: Result, template_name: Path | str) -> str:
""" """
generate report for the specified packages generate report for the specified packages
@ -138,7 +104,7 @@ class JinjaTemplate:
{ {
"architecture": properties.architecture or "", "architecture": properties.architecture or "",
"archive_size": pretty_size(properties.archive_size), "archive_size": pretty_size(properties.archive_size),
"build_date": self.format_datetime(properties.build_date), "build_date": pretty_datetime(properties.build_date),
"depends": properties.depends, "depends": properties.depends,
"description": properties.description or "", "description": properties.description or "",
"filename": properties.filename, "filename": properties.filename,
@ -146,20 +112,17 @@ class JinjaTemplate:
"installed_size": pretty_size(properties.installed_size), "installed_size": pretty_size(properties.installed_size),
"licenses": properties.licenses, "licenses": properties.licenses,
"name": package, "name": package,
"tag": f"tag:{self.name}:{properties.architecture}:{package}:{base.version}:{properties.build_date}",
"url": properties.url or "", "url": properties.url or "",
"version": base.version, "version": base.version
} for base in result.success for package, properties in base.packages.items() } for base in result.success for package, properties in base.packages.items()
] ]
comparator: Callable[[dict[str, str]], str] = lambda item: item["filename"]
return template.render( return template.render(
homepage=self.homepage, homepage=self.homepage,
last_update=self.format_datetime(utcnow()),
link_path=self.link_path, link_path=self.link_path,
has_package_signed=SignSettings.Packages in self.sign_targets, has_package_signed=SignSettings.Packages in self.sign_targets,
has_repo_signed=SignSettings.Repository in self.sign_targets, has_repo_signed=SignSettings.Repository in self.sign_targets,
packages=self.sort_content(content), packages=sorted(content, key=comparator),
pgp_key=self.default_pgp_key, pgp_key=self.default_pgp_key,
repository=self.name, repository=self.name)
rss_url=self.rss_url,
)

View File

@ -78,7 +78,7 @@ class RemoteCall(Report):
process_id(str): remote process id process_id(str): remote process id
Returns: Returns:
bool: ``True`` in case if remote process is alive and ``False`` otherwise bool: True in case if remote process is alive and False otherwise
""" """
try: try:
response = self.client.make_request("GET", f"{self.client.address}/api/v1/service/process/{process_id}") response = self.client.make_request("GET", f"{self.client.address}/api/v1/service/process/{process_id}")

View File

@ -66,7 +66,7 @@ class Report(LazyLogging):
self.configuration = configuration self.configuration = configuration
@staticmethod @staticmethod
def load(repository_id: RepositoryId, configuration: Configuration, target: str) -> Report: # pylint: disable=too-many-return-statements def load(repository_id: RepositoryId, configuration: Configuration, target: str) -> Report:
""" """
load client from settings load client from settings
@ -92,9 +92,6 @@ class Report(LazyLogging):
case ReportSettings.Telegram: case ReportSettings.Telegram:
from ahriman.core.report.telegram import Telegram from ahriman.core.report.telegram import Telegram
return Telegram(repository_id, configuration, section) return Telegram(repository_id, configuration, section)
case ReportSettings.RSS:
from ahriman.core.report.rss import RSS
return RSS(repository_id, configuration, section)
case ReportSettings.RemoteCall: case ReportSettings.RemoteCall:
from ahriman.core.report.remote_call import RemoteCall from ahriman.core.report.remote_call import RemoteCall
return RemoteCall(repository_id, configuration, section) return RemoteCall(repository_id, configuration, section)

View File

@ -116,11 +116,6 @@ class ReportTrigger(Trigger):
"required": True, "required": True,
"empty": False, "empty": False,
}, },
"rss_url": {
"type": "string",
"empty": False,
"is_url": ["http", "https"],
},
"sender": { "sender": {
"type": "string", "type": "string",
"required": True, "required": True,
@ -192,11 +187,6 @@ class ReportTrigger(Trigger):
"coerce": "absolute_path", "coerce": "absolute_path",
"required": True, "required": True,
}, },
"rss_url": {
"type": "string",
"empty": False,
"is_url": ["http", "https"],
},
"template": { "template": {
"type": "string", "type": "string",
"excludes": ["template_path"], "excludes": ["template_path"],
@ -253,11 +243,6 @@ class ReportTrigger(Trigger):
"empty": False, "empty": False,
"is_url": [], "is_url": [],
}, },
"rss_url": {
"type": "string",
"empty": False,
"is_url": ["http", "https"],
},
"template": { "template": {
"type": "string", "type": "string",
"excludes": ["template_path"], "excludes": ["template_path"],
@ -319,67 +304,7 @@ class ReportTrigger(Trigger):
"coerce": "integer", "coerce": "integer",
}, },
}, },
}, }
"rss": {
"type": "dict",
"schema": {
"type": {
"type": "string",
"allowed": ["rss"],
},
"homepage": {
"type": "string",
"empty": False,
"is_url": ["http", "https"],
},
"link_path": {
"type": "string",
"required": True,
"empty": False,
"is_url": [],
},
"max_entries": {
"type": "integer",
"coerce": "integer",
},
"path": {
"type": "path",
"coerce": "absolute_path",
"required": True,
},
"rss_url": {
"type": "string",
"empty": False,
"is_url": ["http", "https"],
},
"template": {
"type": "string",
"excludes": ["template_path"],
"dependencies": ["templates"],
"required": True,
"empty": False,
},
"template_path": {
"type": "path",
"coerce": "absolute_path",
"excludes": ["template"],
"required": True,
"path_exists": True,
"path_type": "file",
},
"templates": {
"type": "list",
"coerce": "list",
"schema": {
"type": "path",
"coerce": "absolute_path",
"path_exists": True,
"path_type": "dir",
},
"empty": False,
},
},
},
} }
def __init__(self, repository_id: RepositoryId, configuration: Configuration) -> None: def __init__(self, repository_id: RepositoryId, configuration: Configuration) -> None:

View File

@ -1,130 +0,0 @@
#
# Copyright (c) 2021-2024 ahriman team.
#
# This file is part of ahriman
# (see https://github.com/arcan1s/ahriman).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
import datetime
from collections.abc import Callable
from email.utils import format_datetime, parsedate_to_datetime
from typing import Any
from ahriman.core import context
from ahriman.core.configuration import Configuration
from ahriman.core.report.jinja_template import JinjaTemplate
from ahriman.core.report.report import Report
from ahriman.core.status import Client
from ahriman.models.event import EventType
from ahriman.models.package import Package
from ahriman.models.repository_id import RepositoryId
from ahriman.models.result import Result
class RSS(Report, JinjaTemplate):
"""
RSS report generator
Attributes:
max_entries(int): the maximal amount of entries in RSS
report_path(Path): output path to RSS report
template(str): name of the template
"""
def __init__(self, repository_id: RepositoryId, configuration: Configuration, section: str) -> None:
"""
default constructor
Args:
repository_id(RepositoryId): repository unique identifier
configuration(Configuration): configuration instance
section(str): settings section name
"""
Report.__init__(self, repository_id, configuration)
JinjaTemplate.__init__(self, repository_id, configuration, section)
self.max_entries = configuration.getint(section, "max_entries", fallback=-1)
self.report_path = configuration.getpath(section, "path")
self.template = configuration.get(section, "template")
@staticmethod
def format_datetime(timestamp: datetime.datetime | float | int | None) -> str:
"""
convert datetime object to string
Args:
timestamp(datetime.datetime | float | int | None): datetime to convert
Returns:
str: datetime as string representation
"""
if timestamp is None:
return ""
if isinstance(timestamp, (int, float)):
timestamp = datetime.datetime.fromtimestamp(timestamp, datetime.UTC)
return format_datetime(timestamp)
@staticmethod
def sort_content(content: list[dict[str, Any]]) -> list[dict[str, Any]]:
"""
sort content before rendering
Args:
content(list[dict[str, str]]): content of the template
Returns:
list[dict[str, str]]: sorted content according to comparator defined
"""
comparator: Callable[[dict[str, str]], datetime.datetime] = \
lambda item: parsedate_to_datetime(item["build_date"])
return sorted(content, key=comparator, reverse=True)
def content(self, packages: list[Package]) -> Result:
"""
extract result to be written to template
Args:
packages(list[Package]): list of packages to generate report
Returns:
Result: result descriptor
"""
ctx = context.get()
reporter = ctx.get(Client)
events = reporter.event_get(EventType.PackageUpdated, None, limit=self.max_entries)
known_packages = {package.base: package for package in packages}
result = Result()
for event in events:
package = known_packages.get(event.object_id)
if package is None:
continue # package not found
result.add_updated(package)
return result
def generate(self, packages: list[Package], result: Result) -> None:
"""
generate report for the specified packages
Args:
packages(list[Package]): list of packages to generate report
result(Result): build result
"""
result = self.content(packages)
rss = self.make_html(result, self.template)
self.report_path.write_text(rss, encoding="utf8")

View File

@ -1,84 +0,0 @@
#
# Copyright (c) 2021-2024 ahriman team.
#
# This file is part of ahriman
# (see https://github.com/arcan1s/ahriman).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
import contextlib
from typing import Generator
from ahriman.core.status import Client
from ahriman.models.event import Event, EventType
from ahriman.models.metrics_timer import MetricsTimer
class EventLogger:
"""
wrapper for logging events
Attributes:
reporter(Client): build status reporter instance
"""
reporter: Client
def event(self, package_base: str, event: EventType, message: str | None = None) -> None:
"""
log single event. For timed events use context manager :func:`in_event()` instead
Args:
package_base(str): package base name
event(EventType): event type to be logged on success action
message(str | None, optional): optional message describing the action (Default value = None)
Examples:
This method must be used as simple wrapper for :class:`ahriman.core.status.Client` methods, e.g.::
>>> do_something()
>>> self.event(package_base, EventType.PackageUpdated)
"""
self.reporter.event_add(Event(event, package_base, message))
@contextlib.contextmanager
def in_event(self, package_base: str, event: EventType, message: str | None = None,
failure: EventType | None = None) -> Generator[None, None, None]:
"""
perform action in package context and log event with time elapsed
Args:
package_base(str): package base name
event(EventType): event type to be logged on success action
message(str | None, optional): optional message describing the action (Default value = None)
failure(EventType | None, optional): event type to be logged on exception (Default value = None)
Examples:
This method must be used to perform action in context with time measurement::
>>> with self.in_event(package_base, EventType.PackageUpdated):
>>> do_something()
Additional parameter ``failure`` can be set in order to emit an event on exception occured. If none set
(default), then no event will be recorded on exception
"""
with MetricsTimer() as timer:
try:
yield
self.reporter.event_add(Event(event, package_base, message, took=timer.elapsed))
except Exception:
if failure is not None:
self.reporter.event_add(Event(failure, package_base, took=timer.elapsed))
raise

View File

@ -23,14 +23,13 @@ from collections.abc import Iterable
from pathlib import Path from pathlib import Path
from tempfile import TemporaryDirectory from tempfile import TemporaryDirectory
from ahriman.core.build_tools.package_archive import PackageArchive
from ahriman.core.build_tools.task import Task from ahriman.core.build_tools.task import Task
from ahriman.core.repository.cleaner import Cleaner from ahriman.core.repository.cleaner import Cleaner
from ahriman.core.repository.package_info import PackageInfo from ahriman.core.repository.package_info import PackageInfo
from ahriman.core.utils import safe_filename from ahriman.core.utils import safe_filename
from ahriman.models.changes import Changes from ahriman.models.changes import Changes
from ahriman.models.event import EventType
from ahriman.models.package import Package from ahriman.models.package import Package
from ahriman.models.package_archive import PackageArchive
from ahriman.models.package_description import PackageDescription from ahriman.models.package_description import PackageDescription
from ahriman.models.packagers import Packagers from ahriman.models.packagers import Packagers
from ahriman.models.result import Result from ahriman.models.result import Result
@ -76,17 +75,16 @@ class Executor(PackageInfo, Cleaner):
with self.in_package_context(single.base, local_versions.get(single.base)), \ with self.in_package_context(single.base, local_versions.get(single.base)), \
TemporaryDirectory(ignore_cleanup_errors=True) as dir_name: TemporaryDirectory(ignore_cleanup_errors=True) as dir_name:
try: try:
with self.in_event(single.base, EventType.PackageUpdated, failure=EventType.PackageUpdateFailed): packager = self.packager(packagers, single.base)
packager = self.packager(packagers, single.base) last_commit_sha = build_single(single, Path(dir_name), packager.packager_id)
last_commit_sha = build_single(single, Path(dir_name), packager.packager_id) # clear changes and update commit hash
# clear changes and update commit hash self.reporter.package_changes_update(single.base, Changes(last_commit_sha))
self.reporter.package_changes_update(single.base, Changes(last_commit_sha)) # update dependencies list
# update dependencies list package_archive = PackageArchive(self.paths.build_directory, single, self.pacman, self.scan_paths)
package_archive = PackageArchive(self.paths.build_root, single, self.pacman, self.scan_paths) dependencies = package_archive.depends_on()
dependencies = package_archive.depends_on() self.reporter.package_dependencies_update(single.base, dependencies)
self.reporter.package_dependencies_update(single.base, dependencies) # update result set
# update result set result.add_updated(single)
result.add_updated(single)
except Exception: except Exception:
self.reporter.set_failed(single.base) self.reporter.set_failed(single.base)
result.add_failed(single) result.add_failed(single)
@ -106,8 +104,7 @@ class Executor(PackageInfo, Cleaner):
""" """
def remove_base(package_base: str) -> None: def remove_base(package_base: str) -> None:
try: try:
with self.in_event(package_base, EventType.PackageRemoved): self.reporter.package_remove(package_base)
self.reporter.package_remove(package_base)
except Exception: except Exception:
self.logger.exception("could not remove base %s", package_base) self.logger.exception("could not remove base %s", package_base)

View File

@ -22,7 +22,6 @@ from ahriman.core.alpm.repo import Repo
from ahriman.core.configuration import Configuration from ahriman.core.configuration import Configuration
from ahriman.core.database import SQLite from ahriman.core.database import SQLite
from ahriman.core.log import LazyLogging from ahriman.core.log import LazyLogging
from ahriman.core.repository.event_logger import EventLogger
from ahriman.core.sign.gpg import GPG from ahriman.core.sign.gpg import GPG
from ahriman.core.status import Client from ahriman.core.status import Client
from ahriman.core.triggers import TriggerLoader from ahriman.core.triggers import TriggerLoader
@ -35,7 +34,7 @@ from ahriman.models.user import User
from ahriman.models.user_access import UserAccess from ahriman.models.user_access import UserAccess
class RepositoryProperties(EventLogger, LazyLogging): class RepositoryProperties(LazyLogging):
""" """
repository internal objects holder repository internal objects holder
@ -81,7 +80,10 @@ class RepositoryProperties(EventLogger, LazyLogging):
self.reporter = Client.load(repository_id, configuration, database, report=report) self.reporter = Client.load(repository_id, configuration, database, report=report)
self.triggers = TriggerLoader.load(repository_id, configuration) self.triggers = TriggerLoader.load(repository_id, configuration)
self.scan_paths = ScanPaths(configuration.getlist("build", "scan_paths", fallback=[])) self.scan_paths = ScanPaths(
allowed_paths=configuration.getpathlist("build", "allowed_scan_paths", fallback=[]),
blacklisted_paths=configuration.getpathlist("build", "blacklisted_scan_paths", fallback=[]),
)
@property @property
def architecture(self) -> str: def architecture(self) -> str:

View File

@ -23,7 +23,6 @@ from ahriman.core.build_tools.sources import Sources
from ahriman.core.exceptions import UnknownPackageError from ahriman.core.exceptions import UnknownPackageError
from ahriman.core.repository.cleaner import Cleaner from ahriman.core.repository.cleaner import Cleaner
from ahriman.core.repository.package_info import PackageInfo from ahriman.core.repository.package_info import PackageInfo
from ahriman.models.event import EventType
from ahriman.models.package import Package from ahriman.models.package import Package
from ahriman.models.package_source import PackageSource from ahriman.models.package_source import PackageSource
from ahriman.models.remote_source import RemoteSource from ahriman.models.remote_source import RemoteSource
@ -72,7 +71,6 @@ class UpdateHandler(PackageInfo, Cleaner):
vcs_allowed_age=self.vcs_allowed_age, vcs_allowed_age=self.vcs_allowed_age,
calculate_version=vcs): calculate_version=vcs):
self.reporter.set_pending(local.base) self.reporter.set_pending(local.base)
self.event(local.base, EventType.PackageOutdated, "Remote version is newer than local")
result.append(remote) result.append(remote)
except Exception: except Exception:
self.reporter.set_failed(local.base) self.reporter.set_failed(local.base)
@ -100,8 +98,8 @@ class UpdateHandler(PackageInfo, Cleaner):
return files return files
result: list[Package] = [] result: list[Package] = []
for local in self.packages(filter_packages): for package in self.packages(filter_packages):
dependencies = self.reporter.package_dependencies_get(local.base) dependencies = self.reporter.package_dependencies_get(package.base)
if not dependencies.paths: if not dependencies.paths:
continue # skip check if no package dependencies found continue # skip check if no package dependencies found
@ -114,10 +112,7 @@ class UpdateHandler(PackageInfo, Cleaner):
continue continue
# there are no packages found in filesystem with the same paths # there are no packages found in filesystem with the same paths
self.reporter.set_pending(local.base) result.append(package)
self.event(local.base, EventType.PackageOutdated, "Implicit dependencies are broken")
result.append(local)
break break
return result return result
@ -158,7 +153,6 @@ class UpdateHandler(PackageInfo, Cleaner):
vcs_allowed_age=self.vcs_allowed_age, vcs_allowed_age=self.vcs_allowed_age,
calculate_version=vcs): calculate_version=vcs):
self.reporter.set_pending(local.base) self.reporter.set_pending(local.base)
self.event(local.base, EventType.PackageOutdated, "Locally pulled sources are outdated")
result.append(remote) result.append(remote)
except Exception: except Exception:
self.logger.exception("could not process package at %s", cache_dir) self.logger.exception("could not process package at %s", cache_dir)
@ -182,7 +176,6 @@ class UpdateHandler(PackageInfo, Cleaner):
self.reporter.set_unknown(local) self.reporter.set_unknown(local)
else: else:
self.reporter.set_pending(local.base) self.reporter.set_pending(local.base)
self.event(local.base, EventType.PackageOutdated, "Manual update is requested")
except Exception: except Exception:
self.logger.exception("could not load packages from database") self.logger.exception("could not load packages from database")
self.clear_queue() self.clear_queue()

View File

@ -20,6 +20,7 @@
from __future__ import annotations from __future__ import annotations
import argparse import argparse
import time
import uuid import uuid
from collections.abc import Callable, Iterable from collections.abc import Callable, Iterable
@ -27,7 +28,6 @@ from multiprocessing import Process, Queue
from threading import Lock, Thread from threading import Lock, Thread
from ahriman.core.log import LazyLogging from ahriman.core.log import LazyLogging
from ahriman.models.metrics_timer import MetricsTimer
from ahriman.models.pkgbuild_patch import PkgbuildPatch from ahriman.models.pkgbuild_patch import PkgbuildPatch
from ahriman.models.process_status import ProcessStatus from ahriman.models.process_status import ProcessStatus
from ahriman.models.repository_id import RepositoryId from ahriman.models.repository_id import RepositoryId
@ -72,7 +72,7 @@ class Spawn(Thread, LazyLogging):
value(bool): command line argument value value(bool): command line argument value
Returns: Returns:
str: if ``value`` is ``True``, then returns positive flag and negative otherwise str: if ``value`` is True, then returns positive flag and negative otherwise
""" """
return name if value else f"no-{name}" return name if value else f"no-{name}"
@ -90,9 +90,11 @@ class Spawn(Thread, LazyLogging):
process_id(str): process unique identifier process_id(str): process unique identifier
queue(Queue[ProcessStatus | None]): output queue queue(Queue[ProcessStatus | None]): output queue
""" """
with MetricsTimer() as timer: start_time = time.monotonic()
result = callback(args, repository_id) result = callback(args, repository_id)
consumed_time = timer.elapsed stop_time = time.monotonic()
consumed_time = int(1000 * (stop_time - start_time))
queue.put(ProcessStatus(process_id, result, consumed_time)) queue.put(ProcessStatus(process_id, result, consumed_time))
@ -151,7 +153,7 @@ class Spawn(Thread, LazyLogging):
process_id(str): process id to be checked as returned by :func:`_spawn_process()` process_id(str): process id to be checked as returned by :func:`_spawn_process()`
Returns: Returns:
bool: ``True`` in case if process still counts as active and ``False`` otherwise bool: True in case if process still counts as active and False otherwise
""" """
with self._lock: with self._lock:
return process_id in self.active return process_id in self.active
@ -269,7 +271,7 @@ class Spawn(Thread, LazyLogging):
""" """
for terminated in iter(self.queue.get, None): for terminated in iter(self.queue.get, None):
self.logger.info("process %s has been terminated with status %s, consumed time %ss", self.logger.info("process %s has been terminated with status %s, consumed time %ss",
terminated.process_id, terminated.status, terminated.consumed_time) terminated.process_id, terminated.status, terminated.consumed_time / 1000)
with self._lock: with self._lock:
process = self.active.pop(terminated.process_id, None) process = self.active.pop(terminated.process_id, None)

View File

@ -25,7 +25,6 @@ from ahriman.core.database import SQLite
from ahriman.models.build_status import BuildStatus, BuildStatusEnum from ahriman.models.build_status import BuildStatus, BuildStatusEnum
from ahriman.models.changes import Changes from ahriman.models.changes import Changes
from ahriman.models.dependencies import Dependencies from ahriman.models.dependencies import Dependencies
from ahriman.models.event import Event, EventType
from ahriman.models.internal_status import InternalStatus from ahriman.models.internal_status import InternalStatus
from ahriman.models.log_record_id import LogRecordId from ahriman.models.log_record_id import LogRecordId
from ahriman.models.package import Package from ahriman.models.package import Package
@ -80,37 +79,6 @@ class Client:
return make_local_client() return make_local_client()
def event_add(self, event: Event) -> None:
"""
create new event
Args:
event(Event): audit log event
Raises:
NotImplementedError: not implemented method
"""
raise NotImplementedError
def event_get(self, event: str | EventType | None, object_id: str | None,
limit: int = -1, offset: int = 0) -> list[Event]:
"""
retrieve list of events
Args:
event(str | EventType | None): filter by event type
object_id(str | None): filter by event object
limit(int, optional): limit records to the specified count, -1 means unlimited (Default value = -1)
offset(int, optional): records offset (Default value = 0)
Returns:
list[Event]: list of audit log events
Raises:
NotImplementedError: not implemented method
"""
raise NotImplementedError
def package_changes_get(self, package_base: str) -> Changes: def package_changes_get(self, package_base: str) -> Changes:
""" """
get package changes get package changes
@ -216,7 +184,7 @@ class Client:
Args: Args:
package_base(str): package base package_base(str): package base
version(str | None): package version to remove logs. If ``None`` is set, all logs will be removed version(str | None): package version to remove logs. If None set, all logs will be removed
Raises: Raises:
NotImplementedError: not implemented method NotImplementedError: not implemented method
@ -245,7 +213,7 @@ class Client:
Args: Args:
package_base(str): package base to update package_base(str): package base to update
variable(str | None): patch name. If ``None`` is set, all patches will be removed variable(str | None): patch name. If None set, all patches will be removed
Raises: Raises:
NotImplementedError: not implemented method NotImplementedError: not implemented method

View File

@ -22,7 +22,6 @@ from ahriman.core.status import Client
from ahriman.models.build_status import BuildStatus, BuildStatusEnum from ahriman.models.build_status import BuildStatus, BuildStatusEnum
from ahriman.models.changes import Changes from ahriman.models.changes import Changes
from ahriman.models.dependencies import Dependencies from ahriman.models.dependencies import Dependencies
from ahriman.models.event import Event, EventType
from ahriman.models.log_record_id import LogRecordId from ahriman.models.log_record_id import LogRecordId
from ahriman.models.package import Package from ahriman.models.package import Package
from ahriman.models.pkgbuild_patch import PkgbuildPatch from ahriman.models.pkgbuild_patch import PkgbuildPatch
@ -49,31 +48,6 @@ class LocalClient(Client):
self.database = database self.database = database
self.repository_id = repository_id self.repository_id = repository_id
def event_add(self, event: Event) -> None:
"""
create new event
Args:
event(Event): audit log event
"""
self.database.event_insert(event, self.repository_id)
def event_get(self, event: str | EventType | None, object_id: str | None,
limit: int = -1, offset: int = 0) -> list[Event]:
"""
retrieve list of events
Args:
event(str | EventType | None): filter by event type
object_id(str | None): filter by event object
limit(int, optional): limit records to the specified count, -1 means unlimited (Default value = -1)
offset(int, optional): records offset (Default value = 0)
Returns:
list[Event]: list of audit log events
"""
return self.database.event_get(event, object_id, limit, offset, self.repository_id)
def package_changes_get(self, package_base: str) -> Changes: def package_changes_get(self, package_base: str) -> Changes:
""" """
get package changes get package changes
@ -164,7 +138,7 @@ class LocalClient(Client):
Args: Args:
package_base(str): package base package_base(str): package base
version(str | None): package version to remove logs. If ``None`` is set, all logs will be removed version(str | None): package version to remove logs. If None set, all logs will be removed
""" """
self.database.logs_remove(package_base, version, self.repository_id) self.database.logs_remove(package_base, version, self.repository_id)
@ -188,7 +162,7 @@ class LocalClient(Client):
Args: Args:
package_base(str): package base to update package_base(str): package base to update
variable(str | None): patch name. If ``None`` is set, all patches will be removed variable(str | None): patch name. If None set, all patches will be removed
""" """
variables = [variable] if variable is not None else None variables = [variable] if variable is not None else None
self.database.patches_remove(package_base, variables) self.database.patches_remove(package_base, variables)
@ -210,7 +184,7 @@ class LocalClient(Client):
Args: Args:
package_base(str): package base to remove package_base(str): package base to remove
""" """
self.database.package_clear(package_base) self.database.package_clear(package_base, self.repository_id)
def package_status_update(self, package_base: str, status: BuildStatusEnum) -> None: def package_status_update(self, package_base: str, status: BuildStatusEnum) -> None:
""" """

View File

@ -27,7 +27,6 @@ from ahriman.core.status import Client
from ahriman.models.build_status import BuildStatus, BuildStatusEnum from ahriman.models.build_status import BuildStatus, BuildStatusEnum
from ahriman.models.changes import Changes from ahriman.models.changes import Changes
from ahriman.models.dependencies import Dependencies from ahriman.models.dependencies import Dependencies
from ahriman.models.event import Event, EventType
from ahriman.models.log_record_id import LogRecordId from ahriman.models.log_record_id import LogRecordId
from ahriman.models.package import Package from ahriman.models.package import Package
from ahriman.models.pkgbuild_patch import PkgbuildPatch from ahriman.models.pkgbuild_patch import PkgbuildPatch
@ -69,10 +68,6 @@ class Watcher(LazyLogging):
with self._lock: with self._lock:
return list(self._known.values()) return list(self._known.values())
event_add: Callable[[Event], None]
event_get: Callable[[str | EventType | None, str | None, int, int], list[Event]]
def load(self) -> None: def load(self) -> None:
""" """
load packages from local database load packages from local database
@ -145,7 +140,6 @@ class Watcher(LazyLogging):
with self._lock: with self._lock:
self._known.pop(package_base, None) self._known.pop(package_base, None)
self.client.package_remove(package_base) self.client.package_remove(package_base)
self.package_logs_remove(package_base, None)
def package_status_update(self, package_base: str, status: BuildStatusEnum) -> None: def package_status_update(self, package_base: str, status: BuildStatusEnum) -> None:
""" """

View File

@ -27,7 +27,6 @@ from ahriman.core.status import Client
from ahriman.models.build_status import BuildStatus, BuildStatusEnum from ahriman.models.build_status import BuildStatus, BuildStatusEnum
from ahriman.models.changes import Changes from ahriman.models.changes import Changes
from ahriman.models.dependencies import Dependencies from ahriman.models.dependencies import Dependencies
from ahriman.models.event import Event, EventType
from ahriman.models.internal_status import InternalStatus from ahriman.models.internal_status import InternalStatus
from ahriman.models.log_record_id import LogRecordId from ahriman.models.log_record_id import LogRecordId
from ahriman.models.package import Package from ahriman.models.package import Package
@ -110,15 +109,6 @@ class WebClient(Client, SyncAhrimanClient):
""" """
return f"{self.address}/api/v1/packages/{urlencode(package_base)}/dependencies" return f"{self.address}/api/v1/packages/{urlencode(package_base)}/dependencies"
def _events_url(self) -> str:
"""
get url for the events api
Returns:
str: full url for web service for events
"""
return f"{self.address}/api/v1/events"
def _logs_url(self, package_base: str) -> str: def _logs_url(self, package_base: str) -> str:
""" """
get url for the logs api get url for the logs api
@ -167,44 +157,6 @@ class WebClient(Client, SyncAhrimanClient):
""" """
return f"{self.address}/api/v1/status" return f"{self.address}/api/v1/status"
def event_add(self, event: Event) -> None:
"""
create new event
Args:
event(Event): audit log event
"""
with contextlib.suppress(Exception):
self.make_request("POST", self._events_url(), params=self.repository_id.query(), json=event.view())
def event_get(self, event: str | EventType | None, object_id: str | None,
limit: int = -1, offset: int = 0) -> list[Event]:
"""
retrieve list of events
Args:
event(str | EventType | None): filter by event type
object_id(str | None): filter by event object
limit(int, optional): limit records to the specified count, -1 means unlimited (Default value = -1)
offset(int, optional): records offset (Default value = 0)
Returns:
list[Event]: list of audit log events
"""
query = self.repository_id.query() + [("limit", str(limit)), ("offset", str(offset))]
if event is not None:
query.append(("event", str(event)))
if object_id is not None:
query.append(("object_id", object_id))
with contextlib.suppress(Exception):
response = self.make_request("GET", self._events_url(), params=query)
response_json = response.json()
return [Event.from_json(event) for event in response_json]
return []
def package_changes_get(self, package_base: str) -> Changes: def package_changes_get(self, package_base: str) -> Changes:
""" """
get package changes get package changes
@ -322,9 +274,8 @@ class WebClient(Client, SyncAhrimanClient):
Returns: Returns:
list[tuple[float, str]]: package logs list[tuple[float, str]]: package logs
""" """
query = self.repository_id.query() + [("limit", str(limit)), ("offset", str(offset))]
with contextlib.suppress(Exception): with contextlib.suppress(Exception):
query = self.repository_id.query() + [("limit", str(limit)), ("offset", str(offset))]
response = self.make_request("GET", self._logs_url(package_base), params=query) response = self.make_request("GET", self._logs_url(package_base), params=query)
response_json = response.json() response_json = response.json()
@ -338,13 +289,12 @@ class WebClient(Client, SyncAhrimanClient):
Args: Args:
package_base(str): package base package_base(str): package base
version(str | None): package version to remove logs. If ``None`` is set, all logs will be removed version(str | None): package version to remove logs. If None set, all logs will be removed
""" """
query = self.repository_id.query()
if version is not None:
query += [("version", version)]
with contextlib.suppress(Exception): with contextlib.suppress(Exception):
query = self.repository_id.query()
if version is not None:
query += [("version", version)]
self.make_request("DELETE", self._logs_url(package_base), params=query) self.make_request("DELETE", self._logs_url(package_base), params=query)
def package_patches_get(self, package_base: str, variable: str | None) -> list[PkgbuildPatch]: def package_patches_get(self, package_base: str, variable: str | None) -> list[PkgbuildPatch]:
@ -373,7 +323,7 @@ class WebClient(Client, SyncAhrimanClient):
Args: Args:
package_base(str): package base to update package_base(str): package base to update
variable(str | None): patch name. If ``None`` is set, all patches will be removed variable(str | None): patch name. If None set, all patches will be removed
""" """
with contextlib.suppress(Exception): with contextlib.suppress(Exception):
self.make_request("DELETE", self._patches_url(package_base, variable or "")) self.make_request("DELETE", self._patches_url(package_base, variable or ""))
@ -411,7 +361,6 @@ class WebClient(Client, SyncAhrimanClient):
NotImplementedError: not implemented method NotImplementedError: not implemented method
""" """
payload = {"status": status.value} payload = {"status": status.value}
with contextlib.suppress(Exception): with contextlib.suppress(Exception):
self.make_request("POST", self._package_url(package_base), self.make_request("POST", self._package_url(package_base),
params=self.repository_id.query(), json=payload) params=self.repository_id.query(), json=payload)
@ -431,7 +380,6 @@ class WebClient(Client, SyncAhrimanClient):
"status": status.value, "status": status.value,
"package": package.view(), "package": package.view(),
} }
with contextlib.suppress(Exception): with contextlib.suppress(Exception):
self.make_request("POST", self._package_url(package.base), self.make_request("POST", self._package_url(package.base),
params=self.repository_id.query(), json=payload) params=self.repository_id.query(), json=payload)
@ -459,6 +407,5 @@ class WebClient(Client, SyncAhrimanClient):
status(BuildStatusEnum): current ahriman status status(BuildStatusEnum): current ahriman status
""" """
payload = {"status": status.value} payload = {"status": status.value}
with contextlib.suppress(Exception): with contextlib.suppress(Exception):
self.make_request("POST", self._status_url(), params=self.repository_id.query(), json=payload) self.make_request("POST", self._status_url(), params=self.repository_id.query(), json=payload)

View File

@ -64,7 +64,7 @@ class Leaf:
packages(Iterable[Leaf]): list of known leaves packages(Iterable[Leaf]): list of known leaves
Returns: Returns:
bool: ``True`` in case if package is dependency of others and ``False`` otherwise bool: True in case if package is dependency of others and False otherwise
""" """
for leaf in packages: for leaf in packages:
if leaf.dependencies.intersection(self.items): if leaf.dependencies.intersection(self.items):
@ -79,7 +79,7 @@ class Leaf:
packages(Iterable[Leaf]): list of known leaves packages(Iterable[Leaf]): list of known leaves
Returns: Returns:
bool: ``True`` if any of packages is dependency of the leaf, ``False`` otherwise bool: True if any of packages is dependency of the leaf, False otherwise
""" """
for leaf in packages: for leaf in packages:
if self.dependencies.intersection(leaf.items): if self.dependencies.intersection(leaf.items):

View File

@ -160,7 +160,7 @@ class GitHub(Upload, HttpUpload):
get release object if any get release object if any
Returns: Returns:
dict[str, Any] | None: GitHub API release object if release found and ``None`` otherwise dict[str, Any] | None: GitHub API release object if release found and None otherwise
""" """
url = f"https://api.github.com/repos/{self.github_owner}/{ url = f"https://api.github.com/repos/{self.github_owner}/{
self.github_repository}/releases/tags/{self.github_release_tag}" self.github_repository}/releases/tags/{self.github_release_tag}"

View File

@ -39,15 +39,14 @@ class Upload(LazyLogging):
Examples: Examples:
These classes provide the way to upload packages to remote sources as it is described in their implementations. These classes provide the way to upload packages to remote sources as it is described in their implementations.
Basic flow includes class instantiating by using the :func:`load()` method and then calling the :func:`run()` Basic flow includes class instantiating by using the :func:`load` method and then calling the :func:`run` method
method which wraps any internal exceptions into the :exc:`ahriman.core.exceptions.SynchronizationError` which wraps any internal exceptions into the :exc:`ahriman.core.exceptions.SynchronizationError` exception::
exception::
>>> configuration = Configuration() >>> configuration = Configuration()
>>> upload = Upload.load(RepositoryId("x86_64", "aur-clone"), configuration, "s3") >>> upload = Upload.load(RepositoryId("x86_64", "aur-clone"), configuration, "s3")
>>> upload.run(configuration.repository_paths.repository, []) >>> upload.run(configuration.repository_paths.repository, [])
Or in case if direct access to exception is required, the :func:`sync()` method can be used:: Or in case if direct access to exception is required, the :func:`sync` method can be used::
>>> try: >>> try:
>>> upload.sync(configuration.repository_paths.repository, []) >>> upload.sync(configuration.repository_paths.repository, [])

View File

@ -225,8 +225,8 @@ def extract_user() -> str | None:
extract user from system environment extract user from system environment
Returns: Returns:
str | None: SUDO_USER in case if set and USER otherwise. It can return ``None`` in case if environment has been str | None: SUDO_USER in case if set and USER otherwise. It can return None in case if environment has been
cleared before application start cleared before application start
""" """
return os.getenv("SUDO_USER") or os.getenv("DOAS_USER") or os.getenv("USER") return os.getenv("SUDO_USER") or os.getenv("DOAS_USER") or os.getenv("USER")
@ -295,7 +295,7 @@ def package_like(filename: Path) -> bool:
filename(Path): name of file to check filename(Path): name of file to check
Returns: Returns:
bool: ``True`` in case if name contains ``.pkg.`` and not signature, ``False`` otherwise bool: True in case if name contains ``.pkg.`` and not signature, False otherwise
""" """
name = filename.name name = filename.name
return not name.startswith(".") and ".pkg." in name and not name.endswith(".sig") return not name.startswith(".") and ".pkg." in name and not name.endswith(".sig")

View File

@ -44,7 +44,7 @@ class AuthSettings(StrEnum):
get enabled flag get enabled flag
Returns: Returns:
bool: ``False`` in case if authorization is disabled and ``True`` otherwise bool: False in case if authorization is disabled and True otherwise
""" """
return self != AuthSettings.Disabled return self != AuthSettings.Disabled

View File

@ -1,140 +0,0 @@
#
# Copyright (c) 2021-2024 ahriman team.
#
# This file is part of ahriman
# (see https://github.com/arcan1s/ahriman).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
from enum import StrEnum
from typing import Any, Self
from ahriman.core.utils import utcnow
class EventType(StrEnum):
"""
predefined event types
Attributes:
PackageOutdated(EventType): (class attribute) package has been marked as out-of-date
PackageRemoved(EventType): (class attribute) package has been removed
PackageUpdateFailed(EventType): (class attribute) package update has been failed
PackageUpdated(EventType): (class attribute) package has been updated
"""
PackageOutdated = "package-outdated"
PackageRemoved = "package-removed"
PackageUpdateFailed = "package-update-failed"
PackageUpdated = "package-updated"
class Event:
"""
audit log event
Attributes:
created(int): event timestamp
data(dict[str, Any]): event metadata
event(str | EventType): event type
message(str | None): event message if available
object_id(str): object identifier
"""
def __init__(self, event: str | EventType, object_id: str, message: str | None = None, created: int | None = None,
**kwargs: Any):
"""
default constructor
Args:
event(str | EventType): event type
object_id(str): object identifier
message(str | None): event message if available
created(int | None, optional): event timestamp (Default value = None)
**kwargs(Any): event metadata
"""
self.event = EventType(event) if event in EventType else event
self.object_id = object_id
self.created = created or int(utcnow().timestamp())
self.message = message
self.data = kwargs
@classmethod
def from_json(cls, dump: dict[str, Any]) -> Self:
"""
construct event from the json dump
Args:
dump(dict[str, Any]): json dump body
Returns:
Self: dependencies object
"""
return cls(
event=dump["event"],
object_id=dump["object_id"],
message=dump.get("message"),
created=dump.get("created"),
**dump.get("data", {}),
)
def get(self, key: str) -> Any:
"""
get a property
Args:
key(str): key to lookup in data
Returns:
Any: metadata property if available or ``None`` otherwise
"""
return self.data.get(key)
def view(self) -> dict[str, Any]:
"""
generate json event view
Returns:
dict[str, Any]: json-friendly dictionary
"""
dump = {
"event": self.event,
"object_id": self.object_id,
"created": self.created,
}
if self.message is not None:
dump["message"] = self.message
if self.data:
dump["data"] = self.data
return dump
def __eq__(self, other: Any) -> bool:
"""
check if other is the same object
Args:
other(Any): other object instance
Returns:
bool: ``True`` if the other object is the same and ``False`` otherwise
"""
if not isinstance(other, Event):
return False
return self.event == other.event \
and self.object_id == other.object_id \
and self.message == other.message \
and self.created == other.created \
and self.data == other.data

View File

@ -1,93 +0,0 @@
#
# Copyright (c) 2021-2024 ahriman team.
#
# This file is part of ahriman
# (see https://github.com/arcan1s/ahriman).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
import time
from types import TracebackType
from typing import Literal, Self
from ahriman.core.exceptions import InitializeError
class MetricsTimer:
"""
metrics implementation
Attributes:
start_time(float | None): timer start time in monotonic time
Examples:
This class implements simple timer which allows to measure the time elapsed of the function. Usually it should
be used like::
>>> with MetricsTimer() as timer:
>>> do_something()
>>> print("Time elapsed for first function: %f", timer.elapsed)
>>> do_something_different()
>>> print("Time elapsed for all functions: %f", timer.elapsed)
"""
def __init__(self) -> None:
"""
default constructor
"""
self.start_time: float | None = None
@property
def elapsed(self) -> float:
"""
get elapsed time since the start of the timer
Returns:
float: time elapsed in seconds
Raises:
InitializeError: in case if timer was not initialized correctly
"""
if self.start_time is None:
raise InitializeError("Timer must be started in the context manager")
stop_time = time.monotonic()
consumed_time_ms = int(1000 * (stop_time - self.start_time))
return consumed_time_ms / 1000
def __enter__(self) -> Self:
"""
start timer context
Returns:
Self: always instance of self
"""
self.start_time = time.monotonic()
return self
def __exit__(self, exc_type: type[Exception] | None, exc_val: Exception | None,
exc_tb: TracebackType) -> Literal[False]:
"""
finish timer context
Args:
exc_type(type[Exception] | None): exception type name if any
exc_val(Exception | None): exception raised if any
exc_tb(TracebackType): exception traceback if any
Returns:
Literal[False]: always ``False`` (do not suppress any exception)
"""
return False

View File

@ -41,7 +41,7 @@ class MigrationResult:
check migration and check if there are pending migrations check migration and check if there are pending migrations
Returns: Returns:
bool: ``True`` in case if it requires migrations and ``False`` otherwise bool: True in case if it requires migrations and False otherwise
""" """
self.validate() self.validate()
return self.new_version > self.old_version return self.new_version > self.old_version

View File

@ -158,13 +158,13 @@ class Package(LazyLogging):
get VCS flag based on the package base get VCS flag based on the package base
Returns: Returns:
bool: ``True`` in case if package base looks like VCS package and ``False`` otherwise bool: True in case if package base looks like VCS package and False otherwise
""" """
return self.base.endswith("-bzr") \ return self.base.endswith("-bzr") \
or self.base.endswith("-csv") \ or self.base.endswith("-csv")\
or self.base.endswith("-darcs") \ or self.base.endswith("-darcs")\
or self.base.endswith("-git") \ or self.base.endswith("-git")\
or self.base.endswith("-hg") \ or self.base.endswith("-hg")\
or self.base.endswith("-svn") or self.base.endswith("-svn")
@property @property
@ -358,7 +358,7 @@ class Package(LazyLogging):
Yields: Yields:
Path: list of paths of files which belong to the package and distributed together with this tarball. Path: list of paths of files which belong to the package and distributed together with this tarball.
All paths are relative to the ``path`` All paths are relative to the ``path``
Raises: Raises:
PackageInfoError: if there are parsing errors PackageInfoError: if there are parsing errors
@ -504,8 +504,8 @@ class Package(LazyLogging):
timestamp(float | int): timestamp to check build date against timestamp(float | int): timestamp to check build date against
Returns: Returns:
bool: ``True`` in case if package was built after the specified date and ``False`` otherwise. bool: True in case if package was built after the specified date and False otherwise. In case if build date
In case if build date is not set by any of packages, it returns False is not set by any of packages, it returns False
""" """
return any( return any(
package.build_date > timestamp package.build_date > timestamp
@ -528,7 +528,7 @@ class Package(LazyLogging):
(Default value = True) (Default value = True)
Returns: Returns:
bool: ``True`` if the package is out-of-dated and ``False`` otherwise bool: True if the package is out-of-dated and False otherwise
""" """
min_vcs_build_date = utcnow().timestamp() - vcs_allowed_age min_vcs_build_date = utcnow().timestamp() - vcs_allowed_age
if calculate_version and not self.is_newer_than(min_vcs_build_date): if calculate_version and not self.is_newer_than(min_vcs_build_date):
@ -550,8 +550,8 @@ class Package(LazyLogging):
Returns: Returns:
str | None: new generated package release version if any. In case if the release contains dot (e.g. 1.2), str | None: new generated package release version if any. In case if the release contains dot (e.g. 1.2),
the minor part will be incremented by 1. If the release does not contain major.minor notation, the minor the minor part will be incremented by 1. If the release does not contain major.minor notation, the minor
version equals to 1 will be appended version equals to 1 will be appended
""" """
if local_version is None: if local_version is None:
return None # local version not found, keep upstream pkgrel return None # local version not found, keep upstream pkgrel

View File

@ -17,6 +17,7 @@
# You should have received a copy of the GNU General Public License # You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>. # along with this program. If not, see <http://www.gnu.org/licenses/>.
# #
from dataclasses import dataclass
from elftools.elf.dynamic import DynamicSection from elftools.elf.dynamic import DynamicSection
from elftools.elf.elffile import ELFFile from elftools.elf.elffile import ELFFile
from pathlib import Path from pathlib import Path
@ -32,6 +33,7 @@ from ahriman.models.package import Package
from ahriman.models.scan_paths import ScanPaths from ahriman.models.scan_paths import ScanPaths
@dataclass
class PackageArchive: class PackageArchive:
""" """
helper for package archives helper for package archives
@ -43,20 +45,10 @@ class PackageArchive:
scan_paths(ScanPaths): scan paths holder scan_paths(ScanPaths): scan paths holder
""" """
def __init__(self, root: Path, package: Package, pacman: Pacman, scan_paths: ScanPaths) -> None: root: Path
""" package: Package
default constructor pacman: Pacman
scan_paths: ScanPaths
Args:
root(Path): path to root filesystem
package(Package): package descriptor
pacman(Pacman): alpm wrapper instance
scan_paths(ScanPaths): scan paths holder
"""
self.root = root
self.package = package
self.pacman = pacman
self.scan_paths = scan_paths
@staticmethod @staticmethod
def dynamic_needed(binary_path: Path) -> list[str]: def dynamic_needed(binary_path: Path) -> list[str]:
@ -171,7 +163,7 @@ class PackageArchive:
result: dict[Path, list[FilesystemPackage]] = {} result: dict[Path, list[FilesystemPackage]] = {}
# sort items from children directories to root # sort items from children directories to root
for path, packages in sorted(source.items(), reverse=True): for path, packages in reversed(sorted(source.items())):
# skip if this path belongs to the one of the base packages # skip if this path belongs to the one of the base packages
if any(package.package_name in base_packages for package in packages): if any(package.package_name in base_packages for package in packages):
continue continue
@ -236,7 +228,7 @@ class PackageArchive:
extract list of the installed packages and their content extract list of the installed packages and their content
Returns: Returns:
dict[str, FilesystemPackage]: map of package name to list of directories and files contained dict[str, FilesystemPackage]; map of package name to list of directories and files contained
by this package by this package
""" """
result = {} result = {}

View File

@ -55,7 +55,7 @@ class PkgbuildPatch:
parse key and define whether it function or not parse key and define whether it function or not
Returns: Returns:
bool: ``True`` in case if key ends with parentheses and ``False`` otherwise bool: True in case if key ends with parentheses and False otherwise
""" """
return self.key is not None and self.key.endswith("()") return self.key is not None and self.key.endswith("()")
@ -65,7 +65,7 @@ class PkgbuildPatch:
check if patch is full diff one or just single-variable patch check if patch is full diff one or just single-variable patch
Returns: Returns:
bool: ``True`` in case key set and ``False`` otherwise bool: True in case key set and False otherwise
""" """
return self.key is None return self.key is None

View File

@ -28,9 +28,9 @@ class ProcessStatus:
Attributes: Attributes:
process_id(str): unique process identifier process_id(str): unique process identifier
status(bool): process exit code status status(bool): process exit code status
consumed_time(float): consumed time in seconds consumed_time(int): consumed time in ms
""" """
process_id: str process_id: str
status: bool status: bool
consumed_time: float consumed_time: int

View File

@ -29,7 +29,7 @@ class Property:
Attributes: Attributes:
name(str): name of the property name(str): name of the property
value(Any): property value value(Any): property value
is_required(bool): if set to ``True`` then this property is required is_required(bool): if set to True then this property is required
indent(int): property indentation level indent(int): property indentation level
""" """

View File

@ -57,7 +57,7 @@ class RemoteSource:
check if source is remote check if source is remote
Returns: Returns:
bool: ``True`` in case if package is well-known remote source (e.g. AUR) and ``False`` otherwise bool: True in case if package is well-known remote source (e.g. AUR) and False otherwise
""" """
return self.source in (PackageSource.AUR, PackageSource.Repository) return self.source in (PackageSource.AUR, PackageSource.Repository)

View File

@ -32,7 +32,6 @@ class ReportSettings(StrEnum):
Email(ReportSettings): (class attribute) email report generation Email(ReportSettings): (class attribute) email report generation
Console(ReportSettings): (class attribute) print result to console Console(ReportSettings): (class attribute) print result to console
Telegram(ReportSettings): (class attribute) markdown report to telegram channel Telegram(ReportSettings): (class attribute) markdown report to telegram channel
RSS(ReportSettings): (class attribute) RSS report generation
RemoteCall(ReportSettings): (class attribute) remote ahriman server call RemoteCall(ReportSettings): (class attribute) remote ahriman server call
""" """
@ -41,11 +40,10 @@ class ReportSettings(StrEnum):
Email = "email" Email = "email"
Console = "console" Console = "console"
Telegram = "telegram" Telegram = "telegram"
RSS = "rss"
RemoteCall = "remote-call" RemoteCall = "remote-call"
@staticmethod @staticmethod
def from_option(value: str) -> ReportSettings: # pylint: disable=too-many-return-statements def from_option(value: str) -> ReportSettings:
""" """
construct value from configuration construct value from configuration
@ -64,8 +62,6 @@ class ReportSettings(StrEnum):
return ReportSettings.Console return ReportSettings.Console
case "telegram": case "telegram":
return ReportSettings.Telegram return ReportSettings.Telegram
case "rss":
return ReportSettings.RSS
case "ahriman" | "remote-call": case "ahriman" | "remote-call":
return ReportSettings.RemoteCall return ReportSettings.RemoteCall
case _: case _:

View File

@ -41,9 +41,12 @@ class RepositoryId:
Returns: Returns:
str: unique id for this repository str: unique id for this repository
Raises:
ValueError: if repository identifier is empty
""" """
if self.is_empty: if self.is_empty:
return "" raise ValueError("Repository ID is called on empty repository identifier")
return f"{self.architecture}-{self.name}" # basically the same as used for command line return f"{self.architecture}-{self.name}" # basically the same as used for command line
@property @property
@ -52,7 +55,7 @@ class RepositoryId:
check if all data is supplied for the loading check if all data is supplied for the loading
Returns: Returns:
bool: ``True`` in case if architecture or name are not set and ``False`` otherwise bool: True in case if architecture or name are not set and False otherwise
""" """
return not self.architecture or not self.name return not self.architecture or not self.name
@ -85,7 +88,7 @@ class RepositoryId:
other(Any): other object to compare other(Any): other object to compare
Returns: Returns:
bool: ``True`` in case if this is less than other and ``False`` otherwise bool: True in case if this is less than other and False otherwise
Raises: Raises:
TypeError: if other is different from RepositoryId type TypeError: if other is different from RepositoryId type

View File

@ -85,7 +85,7 @@ class RepositoryPaths(LazyLogging):
return Path(self.repository_id.name) / self.repository_id.architecture return Path(self.repository_id.name) / self.repository_id.architecture
@property @property
def build_root(self) -> Path: def build_directory(self) -> Path:
""" """
same as :attr:`chroot`, but exactly build chroot same as :attr:`chroot`, but exactly build chroot

View File

@ -82,7 +82,7 @@ class Result:
get if build result is empty or not get if build result is empty or not
Returns: Returns:
bool: ``True`` in case if success list is empty and ``False`` otherwise bool: True in case if success list is empty and False otherwise
""" """
return not self._added and not self._updated return not self._added and not self._updated
@ -191,7 +191,7 @@ class Result:
other(Any): other object instance other(Any): other object instance
Returns: Returns:
bool: ``True`` if the other object is the same and ``False`` otherwise bool: True if the other object is the same and False otherwise
""" """
if not isinstance(other, Result): if not isinstance(other, Result):
return False return False

View File

@ -17,33 +17,29 @@
# You should have received a copy of the GNU General Public License # You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>. # along with this program. If not, see <http://www.gnu.org/licenses/>.
# #
import re
from dataclasses import dataclass from dataclasses import dataclass
from functools import cached_property
from pathlib import Path from pathlib import Path
@dataclass(frozen=True) @dataclass(frozen=True, kw_only=True)
class ScanPaths: class ScanPaths:
""" """
paths used for scan filesystem paths used for scan filesystem
Attributes: Attributes:
paths(list[str]): list of regular expressions to be used to match paths allowed_paths(list[Path]): list of whitelisted paths
blacklisted_paths(list[Path]): list of paths to be skipped from scan
""" """
paths: list[str] allowed_paths: list[Path]
blacklisted_paths: list[Path]
@cached_property def __post_init__(self) -> None:
def patterns(self) -> list[re.Pattern[str]]:
""" """
compiled regular expressions compute relative to / paths
Returns:
list[re.Pattern]: a list of compiled regular expressions
""" """
return [re.compile(path) for path in self.paths] object.__setattr__(self, "allowed_paths", [path.relative_to("/") for path in self.allowed_paths])
object.__setattr__(self, "blacklisted_paths", [path.relative_to("/") for path in self.blacklisted_paths])
def is_allowed(self, path: Path) -> bool: def is_allowed(self, path: Path) -> bool:
""" """
@ -53,7 +49,10 @@ class ScanPaths:
path(Path): path to be checked path(Path): path to be checked
Returns: Returns:
bool: ``True`` in case if :attr:`paths` contains at least one element to which the path is matched bool: ``True`` in case if :attr:`allowed_paths` contains element which is parent for the path and
and ``False`` otherwise :attr:`blacklisted_paths` doesn't and ``False`` otherwise
""" """
return any(pattern.match(str(path)) for pattern in self.patterns) if any(path.is_relative_to(blacklisted) for blacklisted in self.blacklisted_paths):
return False # path is blacklisted
# check if we actually have to check this path
return any(path.is_relative_to(allowed) for allowed in self.allowed_paths)

View File

@ -98,7 +98,7 @@ class User:
salt(str): salt for hashed password salt(str): salt for hashed password
Returns: Returns:
bool: ``True`` in case if password matches, ``False`` otherwise bool: True in case if password matches, False otherwise
""" """
try: try:
verified: bool = self._HASHER.verify(password + salt, self.password) verified: bool = self._HASHER.verify(password + salt, self.password)
@ -131,7 +131,7 @@ class User:
required(UserAccess): required access level required(UserAccess): required access level
Returns: Returns:
bool: ``True`` in case if user is allowed to do this request and ``False`` otherwise bool: True in case if user is allowed to do this request and False otherwise
""" """
return self.access.permits(required) return self.access.permits(required)

View File

@ -47,7 +47,7 @@ class UserAccess(StrEnum):
other(UserAccess): other permission to compare other(UserAccess): other permission to compare
Returns: Returns:
bool: ``True`` in case if current permission allows the operation and ``False`` otherwise bool: True in case if current permission allows the operation and False otherwise
""" """
for member in UserAccess: for member in UserAccess:
if member == other: if member == other:

View File

@ -23,8 +23,6 @@ from collections.abc import Callable
from dataclasses import dataclass, field from dataclasses import dataclass, field
from typing import Literal, ParamSpec from typing import Literal, ParamSpec
from ahriman.models.metrics_timer import MetricsTimer
Params = ParamSpec("Params") Params = ParamSpec("Params")
@ -96,25 +94,25 @@ class Waiter:
Attributes: Attributes:
interval(float): interval in seconds between checks interval(float): interval in seconds between checks
start_time(float): monotonic time of the waiter start. More likely must not be assigned explicitly
wait_timeout(float): timeout in seconds to wait for. Negative value will result in immediate exit. Zero value wait_timeout(float): timeout in seconds to wait for. Negative value will result in immediate exit. Zero value
means infinite timeout means infinite timeout
""" """
wait_timeout: float wait_timeout: float
start_time: float = field(default_factory=time.monotonic, kw_only=True)
interval: float = field(default=10, kw_only=True) interval: float = field(default=10, kw_only=True)
def is_timed_out(self, elapsed: float) -> bool: def is_timed_out(self) -> bool:
""" """
check if timer is out check if timer is out
Attributes:
elapsed(float): elapsed time in seconds
Returns: Returns:
bool: ``True`` in case current monotonic time is more than :attr:`start_time` and :attr:`wait_timeout` bool: ``True`` in case current monotonic time is more than :attr:`start_time` and :attr:`wait_timeout`
doesn't equal to 0 doesn't equal to 0
""" """
return self.wait_timeout != 0 and elapsed > self.wait_timeout since_start = time.monotonic() - self.start_time
return self.wait_timeout != 0 and since_start > self.wait_timeout
def wait(self, in_progress: Callable[Params, bool], *args: Params.args, **kwargs: Params.kwargs) -> WaiterResult: def wait(self, in_progress: Callable[Params, bool], *args: Params.args, **kwargs: Params.kwargs) -> WaiterResult:
""" """
@ -128,10 +126,9 @@ class Waiter:
Returns: Returns:
WaiterResult: waiter result object WaiterResult: waiter result object
""" """
with MetricsTimer() as timer: while not (timed_out := self.is_timed_out()) and in_progress(*args, **kwargs):
while not (timed_out := self.is_timed_out(timer.elapsed)) and in_progress(*args, **kwargs): time.sleep(self.interval)
time.sleep(self.interval) took = time.monotonic() - self.start_time
took = timer.elapsed
if timed_out: if timed_out:
return WaiterTimedOut(took) return WaiterTimedOut(took)

View File

@ -63,7 +63,7 @@ class _AuthorizationPolicy(aiohttp_security.AbstractAuthorizationPolicy):
identity(str): username identity(str): username
Returns: Returns:
str | None: user identity (username) in case if user exists and ``None`` otherwise str | None: user identity (username) in case if user exists and None otherwise
""" """
return identity if await self.validator.known_username(identity) else None return identity if await self.validator.known_username(identity) else None
@ -77,7 +77,7 @@ class _AuthorizationPolicy(aiohttp_security.AbstractAuthorizationPolicy):
context(str | None, optional): URI request path (Default value = None) context(str | None, optional): URI request path (Default value = None)
Returns: Returns:
bool: ``True`` in case if user is allowed to perform this request and ``False`` otherwise bool: True in case if user is allowed to perform this request and False otherwise
""" """
# some methods for type checking and parent class compatibility # some methods for type checking and parent class compatibility
if identity is None or not isinstance(permission, UserAccess): if identity is None or not isinstance(permission, UserAccess):

View File

@ -38,7 +38,7 @@ def _is_templated_unauthorized(request: Request) -> bool:
request(Request): source request to check request(Request): source request to check
Returns: Returns:
bool: ``True`` in case if response should be rendered as html and ``False`` otherwise bool: True in case if response should be rendered as html and False otherwise
""" """
return request.path in ("/api/v1/login", "/api/v1/logout") \ return request.path in ("/api/v1/login", "/api/v1/logout") \
and "application/json" not in request.headers.getall("accept", []) and "application/json" not in request.headers.getall("accept", [])

View File

@ -24,8 +24,6 @@ from ahriman.web.schemas.changes_schema import ChangesSchema
from ahriman.web.schemas.counters_schema import CountersSchema from ahriman.web.schemas.counters_schema import CountersSchema
from ahriman.web.schemas.dependencies_schema import DependenciesSchema from ahriman.web.schemas.dependencies_schema import DependenciesSchema
from ahriman.web.schemas.error_schema import ErrorSchema from ahriman.web.schemas.error_schema import ErrorSchema
from ahriman.web.schemas.event_schema import EventSchema
from ahriman.web.schemas.event_search_schema import EventSearchSchema
from ahriman.web.schemas.file_schema import FileSchema from ahriman.web.schemas.file_schema import FileSchema
from ahriman.web.schemas.info_schema import InfoSchema from ahriman.web.schemas.info_schema import InfoSchema
from ahriman.web.schemas.internal_status_schema import InternalStatusSchema from ahriman.web.schemas.internal_status_schema import InternalStatusSchema

View File

@ -1,47 +0,0 @@
#
# Copyright (c) 2021-2024 ahriman team.
#
# This file is part of ahriman
# (see https://github.com/arcan1s/ahriman).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
from marshmallow import Schema, fields
from ahriman.models.event import EventType
class EventSchema(Schema):
"""
request/response event schema
"""
created = fields.Integer(required=True, metadata={
"description": "Event creation timestamp",
"example": 1680537091,
})
event = fields.String(required=True, metadata={
"description": "Event type",
"example": EventType.PackageUpdated,
})
object_id = fields.String(required=True, metadata={
"description": "Event object identifier",
"example": "ahriman",
})
message = fields.String(metadata={
"description": "Event message if available",
})
data = fields.Dict(keys=fields.String(), metadata={
"description": "Event metadata if available",
})

View File

@ -1,38 +0,0 @@
#
# Copyright (c) 2021-2024 ahriman team.
#
# This file is part of ahriman
# (see https://github.com/arcan1s/ahriman).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
from marshmallow import fields
from ahriman.models.event import EventType
from ahriman.web.schemas.pagination_schema import PaginationSchema
class EventSearchSchema(PaginationSchema):
"""
request event search schema
"""
event = fields.String(metadata={
"description": "Event type",
"example": EventType.PackageUpdated,
})
object_id = fields.String(metadata={
"description": "Event object identifier",
"example": "ahriman",
})

View File

@ -247,7 +247,7 @@ class BaseView(View, CorsViewMixin):
extract username from request if any extract username from request if any
Returns: Returns:
str | None: authorized username if any and ``None`` otherwise (e.g. if authorization is disabled) str | None: authorized username if any and None otherwise (e.g. if authorization is disabled)
""" """
try: # try to read from payload try: # try to read from payload
data: dict[str, str] = await self.request.json() # technically it is not, but we only need str here data: dict[str, str] = await self.request.json() # technically it is not, but we only need str here

View File

@ -1,19 +0,0 @@
#
# Copyright (c) 2021-2024 ahriman team.
#
# This file is part of ahriman
# (see https://github.com/arcan1s/ahriman).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#

View File

@ -1,104 +0,0 @@
#
# Copyright (c) 2021-2024 ahriman team.
#
# This file is part of ahriman
# (see https://github.com/arcan1s/ahriman).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
import aiohttp_apispec # type: ignore[import-untyped]
from aiohttp.web import HTTPBadRequest, HTTPNoContent, Response, json_response
from ahriman.models.event import Event
from ahriman.models.user_access import UserAccess
from ahriman.web.schemas import AuthSchema, ErrorSchema, EventSchema, EventSearchSchema
from ahriman.web.views.base import BaseView
class EventsView(BaseView):
"""
audit log view
Attributes:
GET_PERMISSION(UserAccess): (class attribute) get permissions of self
POST_PERMISSION(UserAccess): (class attribute) post permissions of self
"""
GET_PERMISSION = POST_PERMISSION = UserAccess.Full
ROUTES = ["/api/v1/events"]
@aiohttp_apispec.docs(
tags=["Audit log"],
summary="Get events",
description="Retrieve events from audit log",
responses={
200: {"description": "Success response", "schema": EventSchema(many=True)},
400: {"description": "Bad data is supplied", "schema": ErrorSchema},
401: {"description": "Authorization required", "schema": ErrorSchema},
403: {"description": "Access is forbidden", "schema": ErrorSchema},
500: {"description": "Internal server error", "schema": ErrorSchema},
},
security=[{"token": [GET_PERMISSION]}],
)
@aiohttp_apispec.cookies_schema(AuthSchema)
@aiohttp_apispec.querystring_schema(EventSearchSchema)
async def get(self) -> Response:
"""
get events list
Returns:
Response: 200 with workers list on success
"""
limit, offset = self.page()
event = self.request.query.get("event") or None
object_id = self.request.query.get("object_id") or None
events = self.service().event_get(event, object_id, limit, offset)
response = [event.view() for event in events]
return json_response(response)
@aiohttp_apispec.docs(
tags=["Audit log"],
summary="Create event",
description="Add new event to the audit log",
responses={
204: {"description": "Success response"},
400: {"description": "Bad data is supplied", "schema": ErrorSchema},
401: {"description": "Authorization required", "schema": ErrorSchema},
403: {"description": "Access is forbidden", "schema": ErrorSchema},
500: {"description": "Internal server error", "schema": ErrorSchema},
},
security=[{"token": [POST_PERMISSION]}],
)
@aiohttp_apispec.cookies_schema(AuthSchema)
@aiohttp_apispec.json_schema(EventSchema)
async def post(self) -> None:
"""
add new audit log event
Raises:
HTTPBadRequest: if bad data is supplied
HTTPNoContent: in case of success response
"""
try:
data = await self.request.json()
event = Event.from_json(data)
except Exception as ex:
raise HTTPBadRequest(reason=str(ex))
self.service().event_add(event)
raise HTTPNoContent

View File

@ -75,7 +75,6 @@ def test_schema(configuration: Configuration) -> None:
assert schema.pop("remote-push") assert schema.pop("remote-push")
assert schema.pop("remote-service") assert schema.pop("remote-service")
assert schema.pop("report") assert schema.pop("report")
assert schema.pop("rss")
assert schema.pop("rsync") assert schema.pop("rsync")
assert schema.pop("s3") assert schema.pop("s3")
assert schema.pop("telegram") assert schema.pop("telegram")

View File

@ -14,6 +14,7 @@ from ahriman.core.configuration import Configuration
from ahriman.core.exceptions import DuplicateRunError, UnsafeRunError from ahriman.core.exceptions import DuplicateRunError, UnsafeRunError
from ahriman.models.build_status import BuildStatus, BuildStatusEnum from ahriman.models.build_status import BuildStatus, BuildStatusEnum
from ahriman.models.internal_status import InternalStatus from ahriman.models.internal_status import InternalStatus
from ahriman.models.repository_id import RepositoryId
def test_path(args: argparse.Namespace, configuration: Configuration) -> None: def test_path(args: argparse.Namespace, configuration: Configuration) -> None:
@ -30,6 +31,8 @@ def test_path(args: argparse.Namespace, configuration: Configuration) -> None:
args.lock = Path("ahriman.pid") args.lock = Path("ahriman.pid")
assert Lock(args, repository_id, configuration).path == Path("/run/ahriman/ahriman_x86_64-aur-clone.pid") assert Lock(args, repository_id, configuration).path == Path("/run/ahriman/ahriman_x86_64-aur-clone.pid")
assert Lock(args, RepositoryId("", ""), configuration).path == Path("/run/ahriman/ahriman.pid")
with pytest.raises(ValueError): with pytest.raises(ValueError):
args.lock = Path("/") args.lock = Path("/")
assert Lock(args, repository_id, configuration).path # special case assert Lock(args, repository_id, configuration).path # special case

View File

@ -25,7 +25,6 @@ from ahriman.models.remote_source import RemoteSource
from ahriman.models.repository_id import RepositoryId from ahriman.models.repository_id import RepositoryId
from ahriman.models.repository_paths import RepositoryPaths from ahriman.models.repository_paths import RepositoryPaths
from ahriman.models.result import Result from ahriman.models.result import Result
from ahriman.models.scan_paths import ScanPaths
from ahriman.models.user import User from ahriman.models.user import User
from ahriman.models.user_access import UserAccess from ahriman.models.user_access import UserAccess
@ -588,20 +587,6 @@ def result(package_ahriman: Package) -> Result:
return result return result
@pytest.fixture
def scan_paths(configuration: Configuration) -> ScanPaths:
"""
scan paths fixture
Args:
configuration(Configuration): configuration test instance
Returns:
ScanPaths: scan paths test instance
"""
return ScanPaths(configuration.getlist("build", "scan_paths", fallback=[]))
@pytest.fixture @pytest.fixture
def spawner(configuration: Configuration) -> Spawn: def spawner(configuration: Configuration) -> Spawn:
""" """

View File

@ -1,35 +1,6 @@
import pytest import pytest
from pytest_mock import MockerFixture
from typing import Any
from ahriman.core.alpm.pacman import Pacman
from ahriman.core.build_tools.package_archive import PackageArchive
from ahriman.core.build_tools.sources import Sources from ahriman.core.build_tools.sources import Sources
from ahriman.models.package import Package
from ahriman.models.repository_paths import RepositoryPaths
from ahriman.models.scan_paths import ScanPaths
@pytest.fixture
def package_archive_ahriman(package_ahriman: Package, repository_paths: RepositoryPaths, pacman: Pacman,
scan_paths: ScanPaths, passwd: Any, mocker: MockerFixture) -> PackageArchive:
"""
package archive fixture
Args:
package_ahriman(Package): package test instance
repository_paths(RepositoryPaths): repository paths test instance
pacman(Pacman): pacman test instance
scan_paths(ScanPaths): scan paths test instance
passwd(Any): passwd structure test instance
mocker(MockerFixture): mocker object
Returns:
PackageArchive: package archive test instance
"""
mocker.patch("ahriman.models.repository_paths.getpwuid", return_value=passwd)
return PackageArchive(repository_paths.build_root, package_ahriman, pacman, scan_paths)
@pytest.fixture @pytest.fixture

View File

@ -1,65 +1,6 @@
import os import os
from ahriman.core.configuration import Configuration from ahriman.core.configuration.shell_interpolator import ShellInterpolator
from ahriman.core.configuration.shell_interpolator import ExtendedTemplate, ShellInterpolator
def _parser() -> dict[str, dict[str, str]]:
"""
parser mock
Returns:
dict[str, dict[str, str]]: options to be used as configparser mock
"""
return {
"section1": {
"home": "$HOME",
"key1": "value1",
"key4": "${home}",
},
"section2": {
"key2": "value2",
},
"section3": {
"key3": "${section1:home}",
"key5": "${section1:key4}",
},
}
def test_extended_template() -> None:
"""
must match colons in braces
"""
assert ExtendedTemplate("$key:value").get_identifiers() == ["key"]
assert ExtendedTemplate("${key:value}").get_identifiers() == ["key:value"]
def test_extract_variables() -> None:
"""
must extract variables list
"""
parser = _parser()
assert dict(ShellInterpolator._extract_variables(parser, "${key1}", parser["section1"])) == {
"key1": "value1",
}
assert not dict(ShellInterpolator._extract_variables(parser, "${key2}", parser["section1"]))
assert dict(ShellInterpolator._extract_variables(parser, "${section2:key2}", parser["section1"])) == {
"section2:key2": "value2",
}
assert not dict(ShellInterpolator._extract_variables(parser, "${section2:key1}", parser["section1"]))
assert not dict(ShellInterpolator._extract_variables(parser, "${section4:key1}", parser["section1"]))
def test_environment() -> None:
"""
must extend environment variables
"""
assert "HOME" in ShellInterpolator.environment()
assert "prefix" in ShellInterpolator.environment()
def test_before_get() -> None: def test_before_get() -> None:
@ -67,35 +8,8 @@ def test_before_get() -> None:
must correctly extract environment variables must correctly extract environment variables
""" """
interpolator = ShellInterpolator() interpolator = ShellInterpolator()
assert interpolator.before_get({}, "", "", "value", {}) == "value" assert interpolator.before_get({}, "", "", "value", {}) == "value"
assert interpolator.before_get({}, "", "", "$value", {}) == "$value" assert interpolator.before_get({}, "", "", "$value", {}) == "$value"
assert interpolator.before_get({}, "", "", "$HOME", {}) == os.environ["HOME"] assert interpolator.before_get({}, "", "", "$HOME", {}) == os.environ["HOME"]
def test_before_get_escaped() -> None:
"""
must correctly read escaped variables
"""
interpolator = ShellInterpolator()
assert interpolator.before_get({}, "", "", "$$HOME", {}) == "$HOME" assert interpolator.before_get({}, "", "", "$$HOME", {}) == "$HOME"
def test_before_get_reference() -> None:
"""
must correctly extract environment variables after resolving cross-reference
"""
interpolator = ShellInterpolator()
assert interpolator.before_get(_parser(), "", "", "${section1:home}", {}) == os.environ["HOME"]
def test_before_get_reference_recursive(configuration: Configuration) -> None:
"""
must correctly extract environment variables after resolving cross-reference recursively
"""
interpolator = ShellInterpolator()
for section, items in _parser().items():
for option, value in items.items():
configuration.set_option(section, option, value)
assert interpolator.before_get(configuration, "", "", "${section1:home}", {}) == os.environ["HOME"]
assert interpolator.before_get(configuration, "", "", "${section3:key5}", {}) == os.environ["HOME"]

Some files were not shown because too many files have changed in this diff Show More