mirror of
https://github.com/arcan1s/ahriman.git
synced 2026-04-07 11:03:37 +00:00
Compare commits
4 Commits
437ae2c16c
...
2.20.0rc7
| Author | SHA1 | Date | |
|---|---|---|---|
| f5c12d03ec | |||
| 606ee2fb0e | |||
| 875e9cf58a | |||
| a809a4b67f |
77
docs/_static/architecture.dot
vendored
77
docs/_static/architecture.dot
vendored
@@ -138,11 +138,12 @@ digraph G {
|
|||||||
ahriman_core_http [fillcolor="blue",fontcolor="white",label="ahriman\.\ncore\.\nhttp",shape="box"];
|
ahriman_core_http [fillcolor="blue",fontcolor="white",label="ahriman\.\ncore\.\nhttp",shape="box"];
|
||||||
ahriman_core_http_sync_ahriman_client [fillcolor="blue",fontcolor="white",label="ahriman\.\ncore\.\nhttp\.\nsync_ahriman_client",shape="box"];
|
ahriman_core_http_sync_ahriman_client [fillcolor="blue",fontcolor="white",label="ahriman\.\ncore\.\nhttp\.\nsync_ahriman_client",shape="box"];
|
||||||
ahriman_core_http_sync_http_client [fillcolor="#933f24",fontcolor="#ffffff",label="ahriman\.\ncore\.\nhttp\.\nsync_http_client"];
|
ahriman_core_http_sync_http_client [fillcolor="#933f24",fontcolor="#ffffff",label="ahriman\.\ncore\.\nhttp\.\nsync_http_client"];
|
||||||
ahriman_core_log [fillcolor="#e53b05",fontcolor="#ffffff",label="ahriman\.\ncore\.\nlog"];
|
ahriman_core_log [fillcolor="blue",fontcolor="white",label="ahriman\.\ncore\.\nlog",shape="box"];
|
||||||
ahriman_core_log_http_log_handler [fillcolor="#914730",fontcolor="#ffffff",label="ahriman\.\ncore\.\nlog\.\nhttp_log_handler"];
|
ahriman_core_log_http_log_handler [fillcolor="#914730",fontcolor="#ffffff",label="ahriman\.\ncore\.\nlog\.\nhttp_log_handler"];
|
||||||
ahriman_core_log_journal_handler [fillcolor="#ac6149",fontcolor="#ffffff",label="ahriman\.\ncore\.\nlog\.\njournal_handler"];
|
ahriman_core_log_journal_handler [fillcolor="#ac6149",fontcolor="#ffffff",label="ahriman\.\ncore\.\nlog\.\njournal_handler"];
|
||||||
ahriman_core_log_lazy_logging [fillcolor="#b85a3d",fontcolor="#ffffff",label="ahriman\.\ncore\.\nlog\.\nlazy_logging"];
|
ahriman_core_log_lazy_logging [fillcolor="blue",fontcolor="white",label="ahriman\.\ncore\.\nlog\.\nlazy_logging",shape="box"];
|
||||||
ahriman_core_log_log_loader [fillcolor="#82402b",fontcolor="#ffffff",label="ahriman\.\ncore\.\nlog\.\nlog_loader"];
|
ahriman_core_log_log_context [fillcolor="#db582f",fontcolor="#ffffff",label="ahriman\.\ncore\.\nlog\.\nlog_context"];
|
||||||
|
ahriman_core_log_log_loader [fillcolor="#7a3c28",fontcolor="#ffffff",label="ahriman\.\ncore\.\nlog\.\nlog_loader"];
|
||||||
ahriman_core_module_loader [fillcolor="#ce5e3b",fontcolor="#ffffff",label="ahriman\.\ncore\.\nmodule_loader"];
|
ahriman_core_module_loader [fillcolor="#ce5e3b",fontcolor="#ffffff",label="ahriman\.\ncore\.\nmodule_loader"];
|
||||||
ahriman_core_report [fillcolor="blue",fontcolor="white",label="ahriman\.\ncore\.\nreport",shape="box"];
|
ahriman_core_report [fillcolor="blue",fontcolor="white",label="ahriman\.\ncore\.\nreport",shape="box"];
|
||||||
ahriman_core_report_console [fillcolor="blue",fontcolor="white",label="ahriman\.\ncore\.\nreport\.\nconsole",shape="box"];
|
ahriman_core_report_console [fillcolor="blue",fontcolor="white",label="ahriman\.\ncore\.\nreport\.\nconsole",shape="box"];
|
||||||
@@ -242,10 +243,11 @@ digraph G {
|
|||||||
ahriman_web_apispec_info [fillcolor="#a14f35",fontcolor="#ffffff",label="ahriman\.\nweb\.\napispec\.\ninfo"];
|
ahriman_web_apispec_info [fillcolor="#a14f35",fontcolor="#ffffff",label="ahriman\.\nweb\.\napispec\.\ninfo"];
|
||||||
ahriman_web_cors [fillcolor="#b0573a",fontcolor="#ffffff",label="ahriman\.\nweb\.\ncors"];
|
ahriman_web_cors [fillcolor="#b0573a",fontcolor="#ffffff",label="ahriman\.\nweb\.\ncors"];
|
||||||
ahriman_web_keys [fillcolor="#823017",fontcolor="#ffffff",label="ahriman\.\nweb\.\nkeys"];
|
ahriman_web_keys [fillcolor="#823017",fontcolor="#ffffff",label="ahriman\.\nweb\.\nkeys"];
|
||||||
ahriman_web_middlewares [fillcolor="#e9410c",fontcolor="#ffffff",label="ahriman\.\nweb\.\nmiddlewares"];
|
ahriman_web_middlewares [fillcolor="#ef3e06",fontcolor="#ffffff",label="ahriman\.\nweb\.\nmiddlewares"];
|
||||||
ahriman_web_middlewares_auth_handler [fillcolor="#733826",fontcolor="#ffffff",label="ahriman\.\nweb\.\nmiddlewares\.\nauth_handler"];
|
ahriman_web_middlewares_auth_handler [fillcolor="#733826",fontcolor="#ffffff",label="ahriman\.\nweb\.\nmiddlewares\.\nauth_handler"];
|
||||||
ahriman_web_middlewares_exception_handler [fillcolor="#994b33",fontcolor="#ffffff",label="ahriman\.\nweb\.\nmiddlewares\.\nexception_handler"];
|
ahriman_web_middlewares_exception_handler [fillcolor="#994b33",fontcolor="#ffffff",label="ahriman\.\nweb\.\nmiddlewares\.\nexception_handler"];
|
||||||
ahriman_web_middlewares_metrics_handler [fillcolor="#a34628",fontcolor="#ffffff",label="ahriman\.\nweb\.\nmiddlewares\.\nmetrics_handler"];
|
ahriman_web_middlewares_metrics_handler [fillcolor="#a34628",fontcolor="#ffffff",label="ahriman\.\nweb\.\nmiddlewares\.\nmetrics_handler"];
|
||||||
|
ahriman_web_middlewares_request_id_handler [fillcolor="#8a442e",fontcolor="#ffffff",label="ahriman\.\nweb\.\nmiddlewares\.\nrequest_id_handler"];
|
||||||
ahriman_web_routes [fillcolor="#8a442e",fontcolor="#ffffff",label="ahriman\.\nweb\.\nroutes"];
|
ahriman_web_routes [fillcolor="#8a442e",fontcolor="#ffffff",label="ahriman\.\nweb\.\nroutes"];
|
||||||
ahriman_web_schemas [fillcolor="blue",fontcolor="white",label="ahriman\.\nweb\.\nschemas",shape="box"];
|
ahriman_web_schemas [fillcolor="blue",fontcolor="white",label="ahriman\.\nweb\.\nschemas",shape="box"];
|
||||||
ahriman_web_schemas_any_schema [fillcolor="#b85a3d",fontcolor="#ffffff",label="ahriman\.\nweb\.\nschemas\.\nany_schema"];
|
ahriman_web_schemas_any_schema [fillcolor="#b85a3d",fontcolor="#ffffff",label="ahriman\.\nweb\.\nschemas\.\nany_schema"];
|
||||||
@@ -493,6 +495,7 @@ digraph G {
|
|||||||
ahriman_core -> ahriman_models_worker [fillcolor="#ef3e06",minlen="2"];
|
ahriman_core -> ahriman_models_worker [fillcolor="#ef3e06",minlen="2"];
|
||||||
ahriman_core -> ahriman_web_keys [fillcolor="#ef3e06",minlen="2"];
|
ahriman_core -> ahriman_web_keys [fillcolor="#ef3e06",minlen="2"];
|
||||||
ahriman_core -> ahriman_web_middlewares_auth_handler [fillcolor="#ef3e06",minlen="3"];
|
ahriman_core -> ahriman_web_middlewares_auth_handler [fillcolor="#ef3e06",minlen="3"];
|
||||||
|
ahriman_core -> ahriman_web_middlewares_request_id_handler [fillcolor="#ef3e06",minlen="3"];
|
||||||
ahriman_core -> ahriman_web_routes [fillcolor="#ef3e06",minlen="2"];
|
ahriman_core -> ahriman_web_routes [fillcolor="#ef3e06",minlen="2"];
|
||||||
ahriman_core -> ahriman_web_server_info [fillcolor="#ef3e06",minlen="2"];
|
ahriman_core -> ahriman_web_server_info [fillcolor="#ef3e06",minlen="2"];
|
||||||
ahriman_core -> ahriman_web_views_api_docs [fillcolor="#ef3e06",minlen="3"];
|
ahriman_core -> ahriman_web_views_api_docs [fillcolor="#ef3e06",minlen="3"];
|
||||||
@@ -848,35 +851,39 @@ digraph G {
|
|||||||
ahriman_core_http_sync_ahriman_client -> ahriman_core_http [fillcolor="blue",weight="3"];
|
ahriman_core_http_sync_ahriman_client -> ahriman_core_http [fillcolor="blue",weight="3"];
|
||||||
ahriman_core_http_sync_http_client -> ahriman_core_http [fillcolor="#933f24",weight="3"];
|
ahriman_core_http_sync_http_client -> ahriman_core_http [fillcolor="#933f24",weight="3"];
|
||||||
ahriman_core_http_sync_http_client -> ahriman_core_http_sync_ahriman_client [fillcolor="#933f24",weight="3"];
|
ahriman_core_http_sync_http_client -> ahriman_core_http_sync_ahriman_client [fillcolor="#933f24",weight="3"];
|
||||||
ahriman_core_log -> ahriman_application_application_application_properties [fillcolor="#e53b05",minlen="3"];
|
ahriman_core_log -> ahriman_application_application_application_properties [fillcolor="blue",minlen="3"];
|
||||||
ahriman_core_log -> ahriman_application_application_workers_updater [fillcolor="#e53b05",minlen="3"];
|
ahriman_core_log -> ahriman_application_application_workers_updater [fillcolor="blue",minlen="3"];
|
||||||
ahriman_core_log -> ahriman_application_handlers_handler [fillcolor="#e53b05",minlen="3"];
|
ahriman_core_log -> ahriman_application_handlers_handler [fillcolor="blue",minlen="3"];
|
||||||
ahriman_core_log -> ahriman_application_lock [fillcolor="#e53b05",minlen="2"];
|
ahriman_core_log -> ahriman_application_lock [fillcolor="blue",minlen="2"];
|
||||||
ahriman_core_log -> ahriman_core_alpm_pacman [fillcolor="#e53b05",minlen="2",weight="2"];
|
ahriman_core_log -> ahriman_core_alpm_pacman [fillcolor="blue",minlen="2",weight="2"];
|
||||||
ahriman_core_log -> ahriman_core_alpm_repo [fillcolor="#e53b05",minlen="2",weight="2"];
|
ahriman_core_log -> ahriman_core_alpm_repo [fillcolor="blue",minlen="2",weight="2"];
|
||||||
ahriman_core_log -> ahriman_core_archive_archive_tree [fillcolor="#e53b05",minlen="2",weight="2"];
|
ahriman_core_log -> ahriman_core_archive_archive_tree [fillcolor="blue",minlen="2",weight="2"];
|
||||||
ahriman_core_log -> ahriman_core_auth_auth [fillcolor="#e53b05",minlen="2",weight="2"];
|
ahriman_core_log -> ahriman_core_auth_auth [fillcolor="blue",minlen="2",weight="2"];
|
||||||
ahriman_core_log -> ahriman_core_build_tools_package_version [fillcolor="#e53b05",minlen="2",weight="2"];
|
ahriman_core_log -> ahriman_core_build_tools_package_version [fillcolor="blue",minlen="2",weight="2"];
|
||||||
ahriman_core_log -> ahriman_core_build_tools_sources [fillcolor="#e53b05",minlen="2",weight="2"];
|
ahriman_core_log -> ahriman_core_build_tools_sources [fillcolor="blue",minlen="2",weight="2"];
|
||||||
ahriman_core_log -> ahriman_core_build_tools_task [fillcolor="#e53b05",minlen="2",weight="2"];
|
ahriman_core_log -> ahriman_core_build_tools_task [fillcolor="blue",minlen="2",weight="2"];
|
||||||
ahriman_core_log -> ahriman_core_database_migrations [fillcolor="#e53b05",minlen="2",weight="2"];
|
ahriman_core_log -> ahriman_core_database_migrations [fillcolor="blue",minlen="2",weight="2"];
|
||||||
ahriman_core_log -> ahriman_core_database_operations_operations [fillcolor="#e53b05",minlen="2",weight="2"];
|
ahriman_core_log -> ahriman_core_database_operations_operations [fillcolor="blue",minlen="2",weight="2"];
|
||||||
ahriman_core_log -> ahriman_core_distributed_workers_cache [fillcolor="#e53b05",minlen="2",weight="2"];
|
ahriman_core_log -> ahriman_core_distributed_workers_cache [fillcolor="blue",minlen="2",weight="2"];
|
||||||
ahriman_core_log -> ahriman_core_gitremote_remote_pull [fillcolor="#e53b05",minlen="2",weight="2"];
|
ahriman_core_log -> ahriman_core_gitremote_remote_pull [fillcolor="blue",minlen="2",weight="2"];
|
||||||
ahriman_core_log -> ahriman_core_gitremote_remote_push [fillcolor="#e53b05",minlen="2",weight="2"];
|
ahriman_core_log -> ahriman_core_gitremote_remote_push [fillcolor="blue",minlen="2",weight="2"];
|
||||||
ahriman_core_log -> ahriman_core_http_sync_http_client [fillcolor="#e53b05",minlen="2",weight="2"];
|
ahriman_core_log -> ahriman_core_http_sync_http_client [fillcolor="blue",minlen="2",weight="2"];
|
||||||
ahriman_core_log -> ahriman_core_report_report [fillcolor="#e53b05",minlen="2",weight="2"];
|
ahriman_core_log -> ahriman_core_report_report [fillcolor="blue",minlen="2",weight="2"];
|
||||||
ahriman_core_log -> ahriman_core_repository_repository_properties [fillcolor="#e53b05",minlen="2",weight="2"];
|
ahriman_core_log -> ahriman_core_repository_repository_properties [fillcolor="blue",minlen="2",weight="2"];
|
||||||
ahriman_core_log -> ahriman_core_spawn [fillcolor="#e53b05",weight="2"];
|
ahriman_core_log -> ahriman_core_spawn [fillcolor="blue",weight="2"];
|
||||||
ahriman_core_log -> ahriman_core_status_watcher [fillcolor="#e53b05",minlen="2",weight="2"];
|
ahriman_core_log -> ahriman_core_status_watcher [fillcolor="blue",minlen="2",weight="2"];
|
||||||
ahriman_core_log -> ahriman_core_triggers_trigger [fillcolor="#e53b05",minlen="2",weight="2"];
|
ahriman_core_log -> ahriman_core_triggers_trigger [fillcolor="blue",minlen="2",weight="2"];
|
||||||
ahriman_core_log -> ahriman_core_triggers_trigger_loader [fillcolor="#e53b05",minlen="2",weight="2"];
|
ahriman_core_log -> ahriman_core_triggers_trigger_loader [fillcolor="blue",minlen="2",weight="2"];
|
||||||
ahriman_core_log -> ahriman_core_upload_upload [fillcolor="#e53b05",minlen="2",weight="2"];
|
ahriman_core_log -> ahriman_core_upload_upload [fillcolor="blue",minlen="2",weight="2"];
|
||||||
ahriman_core_log -> ahriman_models_package [fillcolor="#e53b05",minlen="2"];
|
ahriman_core_log -> ahriman_models_package [fillcolor="blue",minlen="2"];
|
||||||
ahriman_core_log -> ahriman_models_repository_paths [fillcolor="#e53b05",minlen="2"];
|
ahriman_core_log -> ahriman_models_repository_paths [fillcolor="blue",minlen="2"];
|
||||||
|
ahriman_core_log -> ahriman_web_middlewares_request_id_handler [fillcolor="blue",minlen="3"];
|
||||||
ahriman_core_log_http_log_handler -> ahriman_core_log_log_loader [fillcolor="#914730",weight="3"];
|
ahriman_core_log_http_log_handler -> ahriman_core_log_log_loader [fillcolor="#914730",weight="3"];
|
||||||
ahriman_core_log_lazy_logging -> ahriman_core_log [fillcolor="#b85a3d",weight="3"];
|
ahriman_core_log_lazy_logging -> ahriman_core_log [fillcolor="blue",weight="3"];
|
||||||
ahriman_core_log_log_loader -> ahriman_application_handlers_handler [fillcolor="#82402b",minlen="3"];
|
ahriman_core_log_log_context -> ahriman_core_log_lazy_logging [fillcolor="#db582f",weight="3"];
|
||||||
|
ahriman_core_log_log_context -> ahriman_core_log_log_loader [fillcolor="#db582f",weight="3"];
|
||||||
|
ahriman_core_log_log_context -> ahriman_web_middlewares_request_id_handler [fillcolor="#db582f",minlen="3"];
|
||||||
|
ahriman_core_log_log_loader -> ahriman_application_handlers_handler [fillcolor="#7a3c28",minlen="3"];
|
||||||
ahriman_core_module_loader -> ahriman_application_ahriman [fillcolor="#ce5e3b",minlen="2"];
|
ahriman_core_module_loader -> ahriman_application_ahriman [fillcolor="#ce5e3b",minlen="2"];
|
||||||
ahriman_core_module_loader -> ahriman_web_routes [fillcolor="#ce5e3b",minlen="2"];
|
ahriman_core_module_loader -> ahriman_web_routes [fillcolor="#ce5e3b",minlen="2"];
|
||||||
ahriman_core_report_console -> ahriman_core_report_report [fillcolor="blue",weight="3"];
|
ahriman_core_report_console -> ahriman_core_report_report [fillcolor="blue",weight="3"];
|
||||||
@@ -1779,12 +1786,13 @@ digraph G {
|
|||||||
ahriman_web_keys -> ahriman_web_apispec_info [fillcolor="#823017",minlen="2",weight="2"];
|
ahriman_web_keys -> ahriman_web_apispec_info [fillcolor="#823017",minlen="2",weight="2"];
|
||||||
ahriman_web_keys -> ahriman_web_views_base [fillcolor="#823017",minlen="2",weight="2"];
|
ahriman_web_keys -> ahriman_web_views_base [fillcolor="#823017",minlen="2",weight="2"];
|
||||||
ahriman_web_keys -> ahriman_web_web [fillcolor="#823017",weight="2"];
|
ahriman_web_keys -> ahriman_web_web [fillcolor="#823017",weight="2"];
|
||||||
ahriman_web_middlewares -> ahriman_web_views_v1_status_metrics [fillcolor="#e9410c",minlen="2",weight="2"];
|
ahriman_web_middlewares -> ahriman_web_views_v1_status_metrics [fillcolor="#ef3e06",minlen="2",weight="2"];
|
||||||
ahriman_web_middlewares -> ahriman_web_web [fillcolor="#e9410c",weight="2"];
|
ahriman_web_middlewares -> ahriman_web_web [fillcolor="#ef3e06",weight="2"];
|
||||||
ahriman_web_middlewares_auth_handler -> ahriman_web_web [fillcolor="#733826",minlen="2",weight="2"];
|
ahriman_web_middlewares_auth_handler -> ahriman_web_web [fillcolor="#733826",minlen="2",weight="2"];
|
||||||
ahriman_web_middlewares_exception_handler -> ahriman_web_web [fillcolor="#994b33",minlen="2",weight="2"];
|
ahriman_web_middlewares_exception_handler -> ahriman_web_web [fillcolor="#994b33",minlen="2",weight="2"];
|
||||||
ahriman_web_middlewares_metrics_handler -> ahriman_web_views_v1_status_metrics [fillcolor="#a34628",minlen="2",weight="2"];
|
ahriman_web_middlewares_metrics_handler -> ahriman_web_views_v1_status_metrics [fillcolor="#a34628",minlen="2",weight="2"];
|
||||||
ahriman_web_middlewares_metrics_handler -> ahriman_web_web [fillcolor="#a34628",minlen="2",weight="2"];
|
ahriman_web_middlewares_metrics_handler -> ahriman_web_web [fillcolor="#a34628",minlen="2",weight="2"];
|
||||||
|
ahriman_web_middlewares_request_id_handler -> ahriman_web_web [fillcolor="#8a442e",minlen="2",weight="2"];
|
||||||
ahriman_web_routes -> ahriman_web_web [fillcolor="#8a442e",weight="2"];
|
ahriman_web_routes -> ahriman_web_web [fillcolor="#8a442e",weight="2"];
|
||||||
ahriman_web_schemas -> ahriman_web_apispec_decorators [fillcolor="blue",minlen="2",weight="2"];
|
ahriman_web_schemas -> ahriman_web_apispec_decorators [fillcolor="blue",minlen="2",weight="2"];
|
||||||
ahriman_web_schemas -> ahriman_web_views_v1_auditlog_events [fillcolor="blue",minlen="2",weight="2"];
|
ahriman_web_schemas -> ahriman_web_views_v1_auditlog_events [fillcolor="blue",minlen="2",weight="2"];
|
||||||
@@ -1939,6 +1947,7 @@ digraph G {
|
|||||||
aiohttp -> ahriman_web_middlewares_auth_handler [fillcolor="#f9b506",minlen="3"];
|
aiohttp -> ahriman_web_middlewares_auth_handler [fillcolor="#f9b506",minlen="3"];
|
||||||
aiohttp -> ahriman_web_middlewares_exception_handler [fillcolor="#f9b506",minlen="3"];
|
aiohttp -> ahriman_web_middlewares_exception_handler [fillcolor="#f9b506",minlen="3"];
|
||||||
aiohttp -> ahriman_web_middlewares_metrics_handler [fillcolor="#f9b506",minlen="3"];
|
aiohttp -> ahriman_web_middlewares_metrics_handler [fillcolor="#f9b506",minlen="3"];
|
||||||
|
aiohttp -> ahriman_web_middlewares_request_id_handler [fillcolor="#f9b506",minlen="3"];
|
||||||
aiohttp -> ahriman_web_routes [fillcolor="#f9b506",minlen="2"];
|
aiohttp -> ahriman_web_routes [fillcolor="#f9b506",minlen="2"];
|
||||||
aiohttp -> ahriman_web_views_api_swagger [fillcolor="#f9b506",minlen="3"];
|
aiohttp -> ahriman_web_views_api_swagger [fillcolor="#f9b506",minlen="3"];
|
||||||
aiohttp -> ahriman_web_views_base [fillcolor="#f9b506",minlen="3"];
|
aiohttp -> ahriman_web_views_base [fillcolor="#f9b506",minlen="3"];
|
||||||
|
|||||||
@@ -28,6 +28,14 @@ ahriman.core.log.lazy\_logging module
|
|||||||
:no-undoc-members:
|
:no-undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
ahriman.core.log.log\_context module
|
||||||
|
------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: ahriman.core.log.log_context
|
||||||
|
:members:
|
||||||
|
:no-undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
ahriman.core.log.log\_loader module
|
ahriman.core.log.log\_loader module
|
||||||
-----------------------------------
|
-----------------------------------
|
||||||
|
|
||||||
|
|||||||
@@ -28,6 +28,14 @@ ahriman.web.middlewares.metrics\_handler module
|
|||||||
:no-undoc-members:
|
:no-undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
ahriman.web.middlewares.request\_id\_handler module
|
||||||
|
---------------------------------------------------
|
||||||
|
|
||||||
|
.. automodule:: ahriman.web.middlewares.request_id_handler
|
||||||
|
:members:
|
||||||
|
:no-undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
Module contents
|
Module contents
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
|
|||||||
@@ -9,7 +9,8 @@ Packages have strict rules of importing:
|
|||||||
* ``ahriman.application`` package must not be used outside of this package.
|
* ``ahriman.application`` package must not be used outside of this package.
|
||||||
* ``ahriman.core`` and ``ahriman.models`` packages don't have any import restriction. Actually we would like to totally restrict importing of ``core`` package from ``models``, but it is impossible at the moment.
|
* ``ahriman.core`` and ``ahriman.models`` packages don't have any import restriction. Actually we would like to totally restrict importing of ``core`` package from ``models``, but it is impossible at the moment.
|
||||||
* ``ahriman.web`` package is allowed to be imported from ``ahriman.application`` (web handler only, only ``ahriman.web.web`` methods).
|
* ``ahriman.web`` package is allowed to be imported from ``ahriman.application`` (web handler only, only ``ahriman.web.web`` methods).
|
||||||
* The idea remains the same for all imports, if an package requires some specific dependencies, it must be imported locally to keep dependencies optional.
|
|
||||||
|
The idea remains the same for all imports, if a package requires some specific dependencies, it must be imported locally to keep dependencies optional.
|
||||||
|
|
||||||
Full dependency diagram:
|
Full dependency diagram:
|
||||||
|
|
||||||
@@ -42,7 +43,7 @@ This package contains everything required for the most of application actions an
|
|||||||
* ``ahriman.core.gitremote`` is a package with remote PKGBUILD triggers. Should not be called directly.
|
* ``ahriman.core.gitremote`` is a package with remote PKGBUILD triggers. Should not be called directly.
|
||||||
* ``ahriman.core.housekeeping`` package provides few triggers for removing old data.
|
* ``ahriman.core.housekeeping`` package provides few triggers for removing old data.
|
||||||
* ``ahriman.core.http`` package provides HTTP clients which can be used later by other classes.
|
* ``ahriman.core.http`` package provides HTTP clients which can be used later by other classes.
|
||||||
* ``ahriman.core.log`` is a log utils package. It includes logger loader class, custom HTTP based logger and some wrappers.
|
* ``ahriman.core.log`` is a log utils package. It includes logger loader class, custom HTTP based logger, log context for injecting context variables into log records and some wrappers.
|
||||||
* ``ahriman.core.report`` is a package with reporting triggers. Should not be called directly.
|
* ``ahriman.core.report`` is a package with reporting triggers. Should not be called directly.
|
||||||
* ``ahriman.core.repository`` contains several traits and base repository (``ahriman.core.repository.Repository`` class) implementation.
|
* ``ahriman.core.repository`` contains several traits and base repository (``ahriman.core.repository.Repository`` class) implementation.
|
||||||
* ``ahriman.core.sign`` package provides sign feature (only gpg calls are available).
|
* ``ahriman.core.sign`` package provides sign feature (only gpg calls are available).
|
||||||
@@ -85,6 +86,7 @@ Application run
|
|||||||
#. Call ``Handler.execute`` method.
|
#. Call ``Handler.execute`` method.
|
||||||
#. Define list of architectures to run. In case if there is more than one architecture specified run several subprocesses or continue in current process otherwise. Class attribute ``ALLOW_MULTI_ARCHITECTURE_RUN`` controls whether the application can be run in multiple processes or not - this feature is required for some handlers (e.g. ``Config``, which utilizes stdout to print messages).
|
#. Define list of architectures to run. In case if there is more than one architecture specified run several subprocesses or continue in current process otherwise. Class attribute ``ALLOW_MULTI_ARCHITECTURE_RUN`` controls whether the application can be run in multiple processes or not - this feature is required for some handlers (e.g. ``Config``, which utilizes stdout to print messages).
|
||||||
#. In each child process call lock functions.
|
#. In each child process call lock functions.
|
||||||
|
#. Load configuration and install logging.
|
||||||
#. After success checks pass control to ``Handler.run`` method defined by specific handler class.
|
#. After success checks pass control to ``Handler.run`` method defined by specific handler class.
|
||||||
#. Return result (success or failure) of each subprocess and exit from application.
|
#. Return result (success or failure) of each subprocess and exit from application.
|
||||||
#. Some handlers may override their status and throw ``ExitCode`` exception. This exception is just silently suppressed and changes application exit code to ``1``.
|
#. Some handlers may override their status and throw ``ExitCode`` exception. This exception is just silently suppressed and changes application exit code to ``1``.
|
||||||
@@ -159,12 +161,12 @@ Having default root as ``/var/lib/ahriman`` (differs from container though), the
|
|||||||
├── aur.files -> aur.files.tar.gz
|
├── aur.files -> aur.files.tar.gz
|
||||||
└── aur.files.tar.gz
|
└── aur.files.tar.gz
|
||||||
|
|
||||||
There are multiple subdirectories, some of them are commons for any repository, but some of them are not.
|
There are multiple subdirectories, some of them are common for any repository, but some of them are not.
|
||||||
|
|
||||||
* ``archive`` is the package archive directory. It is common for all repositories and architectures and contains two subdirectories:
|
* ``archive`` is the package archive directory. It is common for all repositories and architectures and contains two subdirectories:
|
||||||
|
|
||||||
* ``archive/packages/{first_letter}/{package_base}`` stores the actual built package files and their signatures.
|
* ``archive/packages/{first_letter}/{package_base}`` stores the actual built package files and their signatures.
|
||||||
* ``archive/repos/{YYYY}/{MM}/{DD}/{repository}/{architecture}`` contains daily repository snapshots. Each snapshot is a repository database with symlinks pointing to the corresponding packages in the ``archive/packages`` tree.
|
* ``archive/repos/{YYYY}/{MM}/{DD}/{repository}/{architecture}`` contains daily repository snapshots. Each snapshot is a repository database with symlinks pointing to the corresponding packages in the ``archive/packages`` tree. These directories only appear if ``ahriman.core.archive.ArchiveTrigger`` is enabled.
|
||||||
|
|
||||||
The archive also allows the build process to skip rebuilding a package if a matching version already exists.
|
The archive also allows the build process to skip rebuilding a package if a matching version already exists.
|
||||||
|
|
||||||
@@ -239,9 +241,9 @@ Check outdated packages
|
|||||||
There are few ways for packages to be marked as out-of-date and hence requiring rebuild. Those are following:
|
There are few ways for packages to be marked as out-of-date and hence requiring rebuild. Those are following:
|
||||||
|
|
||||||
#. User requested update of the package. It can be caused by calling ``package-add`` subcommand (or ``package-update`` with arguments).
|
#. User requested update of the package. It can be caused by calling ``package-add`` subcommand (or ``package-update`` with arguments).
|
||||||
#. The most common way for packages to be marked as out-of-dated is that the version in AUR (or the official repositories) is newer than in the repository.
|
#. The most common way for packages to be marked as out-of-date is that the version in AUR (or the official repositories) is newer than in the repository.
|
||||||
#. In addition to the above, if package is named as VCS (e.g. has suffix ``-git``) and the last update was more than specified threshold ago, the service will also try to fetch sources and check if the revision is newer than the built one.
|
#. In addition to the above, if package is named as VCS (e.g. has suffix ``-git``) and the last update was more than specified threshold ago, the service will also try to fetch sources and check if the revision is newer than the built one.
|
||||||
#. In addition, there is ability to check if the dependencies of the package have been updated (e.g. if linked library has been renamed or the modules directory - e.g. in case of python and ruby packages - has been changed). And if so, the package will be marked as out-of-dated as well.
|
#. In addition, there is ability to check if the dependencies of the package have been updated (e.g. if linked library has been renamed or the modules directory - e.g. in case of python and ruby packages - has been changed). And if so, the package will be marked as out-of-date as well.
|
||||||
|
|
||||||
Update packages
|
Update packages
|
||||||
^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^
|
||||||
@@ -255,6 +257,7 @@ This feature is divided into the following stages: check AUR for updates and run
|
|||||||
|
|
||||||
#. Download package data from AUR.
|
#. Download package data from AUR.
|
||||||
#. Bump ``pkgrel`` if there is duplicate version in the local repository (see explanation below).
|
#. Bump ``pkgrel`` if there is duplicate version in the local repository (see explanation below).
|
||||||
|
#. Check if there is already built package of the same version in archive (cross-repository support). If so, then just copy built archives and skip steps below.
|
||||||
#. Build every package in clean chroot.
|
#. Build every package in clean chroot.
|
||||||
#. Sign packages if required.
|
#. Sign packages if required.
|
||||||
#. Add packages to database and sign database if required.
|
#. Add packages to database and sign database if required.
|
||||||
@@ -313,7 +316,7 @@ Having the initial dependencies tree, the application is looking for packages wh
|
|||||||
|
|
||||||
Those paths are also filtered by regular expressions set in the configuration.
|
Those paths are also filtered by regular expressions set in the configuration.
|
||||||
|
|
||||||
All those implicit dependencies are stored in the database and extracted on each check. In case if any of the repository packages doesn't contain any entry anymore (e.g. so version has been changed or modules directory has been changed), the dependent package will be marked as out-of-dated.
|
All those implicit dependencies are stored in the database and extracted on each check. In case if any of the repository packages doesn't contain any entry anymore (e.g. so version has been changed or modules directory has been changed), the dependent package will be marked as out-of-date.
|
||||||
|
|
||||||
Core functions reference
|
Core functions reference
|
||||||
------------------------
|
------------------------
|
||||||
@@ -344,6 +347,8 @@ The ``_Context`` class itself mimics default collection interface (as is ``Mappi
|
|||||||
|
|
||||||
In order to provide statically typed interface, the ``ahriman.models.context_key.ContextKey`` class is used for both ``_Content.get`` and ``_Content.set`` methods; the context instance itself, however, does not store information about types.
|
In order to provide statically typed interface, the ``ahriman.models.context_key.ContextKey`` class is used for both ``_Content.get`` and ``_Content.set`` methods; the context instance itself, however, does not store information about types.
|
||||||
|
|
||||||
|
Logging module has its own context variables, which are required to be registered in advance to avoid possible race conditions.
|
||||||
|
|
||||||
Submodules
|
Submodules
|
||||||
^^^^^^^^^^
|
^^^^^^^^^^
|
||||||
|
|
||||||
@@ -370,7 +375,7 @@ Passwords must be stored in database as ``hash(password + salt)``, where ``passw
|
|||||||
|
|
||||||
means that there is user ``username`` with ``read`` access and password ``password`` hashed by ``sha512`` with salt ``salt``.
|
means that there is user ``username`` with ``read`` access and password ``password`` hashed by ``sha512`` with salt ``salt``.
|
||||||
|
|
||||||
OAuth provider uses library definitions (``aioauth-client``) in order *authenticate* users. It still requires user permission to be set in database, thus it inherits mapping provider without any changes. Whereas we could override ``check_credentials`` (authentication method) by something custom, OAuth flow is a bit more complex than just forward request, thus we have to implement the flow in login form.
|
OAuth provider uses library definitions (``aioauth-client``) in order to *authenticate* users. It still requires user permission to be set in database, thus it inherits mapping provider without any changes. Whereas we could override ``check_credentials`` (authentication method) by something custom, OAuth flow is a bit more complex than just forward request, thus we have to implement the flow in login form.
|
||||||
|
|
||||||
OAuth's implementation also allows authenticating users via username + password (in the same way as mapping does) though it is not recommended for end-users and password must be left blank. In particular this feature can be used by service reporting (aka robots).
|
OAuth's implementation also allows authenticating users via username + password (in the same way as mapping does) though it is not recommended for end-users and password must be left blank. In particular this feature can be used by service reporting (aka robots).
|
||||||
|
|
||||||
@@ -383,7 +388,7 @@ Triggers
|
|||||||
|
|
||||||
Triggers are extensions which can be used in order to perform any actions on application start, after the update process and, finally, before the application exit.
|
Triggers are extensions which can be used in order to perform any actions on application start, after the update process and, finally, before the application exit.
|
||||||
|
|
||||||
The main idea is to load classes by their full path (e.g. ``ahriman.core.upload.UploadTrigger``) by using ``importlib``: get the last part of the import and treat it as class name, join remain part by ``.`` and interpret as module path, import module and extract attribute from it.
|
The main idea is to load classes by their full path (e.g. ``ahriman.core.upload.UploadTrigger``) by using ``importlib``: get the last part of the import and treat it as class name, join the remaining part by ``.`` and interpret as module path, import module and extract attribute from it.
|
||||||
|
|
||||||
The loaded triggers will be called with ``ahriman.models.result.Result`` and ``list[Packages]`` arguments, which describes the process result and current repository packages respectively. Any exception raised will be suppressed and will generate an exception message in logs.
|
The loaded triggers will be called with ``ahriman.models.result.Result`` and ``list[Packages]`` arguments, which describes the process result and current repository packages respectively. Any exception raised will be suppressed and will generate an exception message in logs.
|
||||||
|
|
||||||
@@ -407,7 +412,7 @@ PKGBUILD parsing
|
|||||||
|
|
||||||
The application provides a house-made shell parser ``ahriman.core.alpm.pkgbuild_parser.PkgbuildParser`` to process PKGBUILDs and extract package data from them. It relies on the ``shlex.shlex`` parser with some configuration tweaks and adds some token post-processing.
|
The application provides a house-made shell parser ``ahriman.core.alpm.pkgbuild_parser.PkgbuildParser`` to process PKGBUILDs and extract package data from them. It relies on the ``shlex.shlex`` parser with some configuration tweaks and adds some token post-processing.
|
||||||
|
|
||||||
#. During the parser process, firstly, it extract next token from the source file (basically, the word) and tries to match it to the variable assignment. If so, then just processes accordingly.
|
#. During the parser process, firstly, it extracts the next token from the source file (basically, the word) and tries to match it to the variable assignment. If so, then just processes accordingly.
|
||||||
#. If it is not an assignment, the parser checks if the token was quoted.
|
#. If it is not an assignment, the parser checks if the token was quoted.
|
||||||
#. If it wasn't quoted then the parser tries to match the array starts (two consecutive tokens like ``array=`` and ``(``) or it is function (``function``, ``()`` and ``{``).
|
#. If it wasn't quoted then the parser tries to match the array starts (two consecutive tokens like ``array=`` and ``(``) or it is function (``function``, ``()`` and ``{``).
|
||||||
#. The arrays are processed until the next closing bracket ``)``. After extraction, the parser tries to expand an array according to bash rules (``prefix{first,second}suffix`` constructions).
|
#. The arrays are processed until the next closing bracket ``)``. After extraction, the parser tries to expand an array according to bash rules (``prefix{first,second}suffix`` constructions).
|
||||||
@@ -445,7 +450,7 @@ Web application requires the following python packages to be installed:
|
|||||||
Middlewares
|
Middlewares
|
||||||
^^^^^^^^^^^
|
^^^^^^^^^^^
|
||||||
|
|
||||||
Service provides some custom middlewares, e.g. logging every exception (except for user ones) and user authorization.
|
Service provides some custom middlewares, e.g. logging every exception (except for user ones), user authorization and request tracing via ``X-Request-ID`` header.
|
||||||
|
|
||||||
HEAD and OPTIONS requests
|
HEAD and OPTIONS requests
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
@@ -457,7 +462,7 @@ On the other side, ``OPTIONS`` method is implemented in the ``ahriman.web.middle
|
|||||||
Web views
|
Web views
|
||||||
^^^^^^^^^
|
^^^^^^^^^
|
||||||
|
|
||||||
All web views are defined in separated package and derived from ``ahriman.web.views.base.Base`` class which provides typed interfaces for web application.
|
All web views are defined in a separate package and derived from ``ahriman.web.views.base.Base`` class which provides typed interfaces for web application.
|
||||||
|
|
||||||
REST API supports only JSON data.
|
REST API supports only JSON data.
|
||||||
|
|
||||||
@@ -476,7 +481,7 @@ The views are also divided by supporting API versions (e.g. ``v1``, ``v2``).
|
|||||||
Templating
|
Templating
|
||||||
^^^^^^^^^^
|
^^^^^^^^^^
|
||||||
|
|
||||||
Package provides base jinja templates which can be overridden by settings. Vanilla templates actively use bootstrap library.
|
Package provides base jinja templates which can be overridden by settings. The default web interface is a React application. The classic bootstrap-based template is still available as ``build-status-classic.jinja2`` and can be enabled via the ``web.template`` configuration option.
|
||||||
|
|
||||||
Requests and scopes
|
Requests and scopes
|
||||||
^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
"name": "ahriman-frontend",
|
"name": "ahriman-frontend",
|
||||||
"private": true,
|
"private": true,
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"version": "2.20.0-rc6",
|
"version": "2.20.0-rc7",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "tsc && vite build",
|
"build": "tsc && vite build",
|
||||||
"dev": "vite",
|
"dev": "vite",
|
||||||
|
|||||||
@@ -40,6 +40,7 @@ export class Client {
|
|||||||
|
|
||||||
const headers: Record<string, string> = {
|
const headers: Record<string, string> = {
|
||||||
Accept: "application/json",
|
Accept: "application/json",
|
||||||
|
"X-Request-ID": crypto.randomUUID(),
|
||||||
};
|
};
|
||||||
if (json !== undefined) {
|
if (json !== undefined) {
|
||||||
headers["Content-Type"] = "application/json";
|
headers["Content-Type"] = "application/json";
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
pkgbase='ahriman'
|
pkgbase='ahriman'
|
||||||
pkgname=('ahriman' 'ahriman-core' 'ahriman-triggers' 'ahriman-web')
|
pkgname=('ahriman' 'ahriman-core' 'ahriman-triggers' 'ahriman-web')
|
||||||
pkgver=2.20.0rc6
|
pkgver=2.20.0rc7
|
||||||
pkgrel=1
|
pkgrel=1
|
||||||
pkgdesc="ArcH linux ReposItory MANager"
|
pkgdesc="ArcH linux ReposItory MANager"
|
||||||
arch=('any')
|
arch=('any')
|
||||||
|
|||||||
@@ -26,10 +26,12 @@ formatter = syslog_format
|
|||||||
args = ("/dev/log",)
|
args = ("/dev/log",)
|
||||||
|
|
||||||
[formatter_generic_format]
|
[formatter_generic_format]
|
||||||
format = [%(levelname)s %(asctime)s] [%(name)s]: %(message)s
|
format = [{levelname} {asctime}] [{name}]: {message}
|
||||||
|
style = {
|
||||||
|
|
||||||
[formatter_syslog_format]
|
[formatter_syslog_format]
|
||||||
format = [%(levelname)s] [%(name)s]: %(message)s
|
format = [{levelname}] [{name}]: {message}
|
||||||
|
style = {
|
||||||
|
|
||||||
[logger_root]
|
[logger_root]
|
||||||
level = DEBUG
|
level = DEBUG
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
.TH AHRIMAN "1" "2026\-03\-06" "ahriman 2.20.0rc6" "ArcH linux ReposItory MANager"
|
.TH AHRIMAN "1" "2026\-03\-08" "ahriman 2.20.0rc7" "ArcH linux ReposItory MANager"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
ahriman \- ArcH linux ReposItory MANager
|
ahriman \- ArcH linux ReposItory MANager
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
|
|||||||
@@ -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.20.0rc6"
|
__version__ = "2.20.0rc7"
|
||||||
|
|||||||
@@ -19,6 +19,7 @@
|
|||||||
#
|
#
|
||||||
import contextlib
|
import contextlib
|
||||||
import requests
|
import requests
|
||||||
|
import uuid
|
||||||
|
|
||||||
from requests.adapters import BaseAdapter
|
from requests.adapters import BaseAdapter
|
||||||
from urllib.parse import urlparse
|
from urllib.parse import urlparse
|
||||||
@@ -60,6 +61,15 @@ class SyncAhrimanClient(SyncHttpClient):
|
|||||||
|
|
||||||
return adapters
|
return adapters
|
||||||
|
|
||||||
|
def headers(self) -> dict[str, str]:
|
||||||
|
"""
|
||||||
|
additional request headers
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
dict[str, str]: additional request headers defined by class
|
||||||
|
"""
|
||||||
|
return SyncHttpClient.headers(self) | {"X-Request-ID": str(uuid.uuid4())}
|
||||||
|
|
||||||
def on_session_creation(self, session: requests.Session) -> None:
|
def on_session_creation(self, session: requests.Session) -> None:
|
||||||
"""
|
"""
|
||||||
method which will be called on session creation
|
method which will be called on session creation
|
||||||
|
|||||||
@@ -144,6 +144,15 @@ class SyncHttpClient(LazyLogging):
|
|||||||
"https://": HTTPAdapter(max_retries=self.retry),
|
"https://": HTTPAdapter(max_retries=self.retry),
|
||||||
}
|
}
|
||||||
|
|
||||||
|
def headers(self) -> dict[str, str]:
|
||||||
|
"""
|
||||||
|
additional request headers
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
dict[str, str]: additional request headers defined by class
|
||||||
|
"""
|
||||||
|
return {}
|
||||||
|
|
||||||
def make_request(self, method: Literal["DELETE", "GET", "HEAD", "POST", "PUT"], url: str, *,
|
def make_request(self, method: Literal["DELETE", "GET", "HEAD", "POST", "PUT"], url: str, *,
|
||||||
headers: dict[str, str] | None = None,
|
headers: dict[str, str] | None = None,
|
||||||
params: list[tuple[str, str]] | None = None,
|
params: list[tuple[str, str]] | None = None,
|
||||||
@@ -178,6 +187,9 @@ class SyncHttpClient(LazyLogging):
|
|||||||
if session is None:
|
if session is None:
|
||||||
session = self.session
|
session = self.session
|
||||||
|
|
||||||
|
if additional_headers := self.headers():
|
||||||
|
headers = additional_headers | (headers or {})
|
||||||
|
|
||||||
try:
|
try:
|
||||||
response = session.request(method, url, params=params, data=data, headers=headers, files=files, json=json,
|
response = session.request(method, url, params=params, data=data, headers=headers, files=files, json=json,
|
||||||
stream=stream, auth=self.auth, timeout=self.timeout)
|
stream=stream, auth=self.auth, timeout=self.timeout)
|
||||||
|
|||||||
@@ -24,6 +24,7 @@ from collections.abc import Iterator
|
|||||||
from functools import cached_property
|
from functools import cached_property
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
|
from ahriman.core.log.log_context import LogContext
|
||||||
from ahriman.models.log_record_id import LogRecordId
|
from ahriman.models.log_record_id import LogRecordId
|
||||||
|
|
||||||
|
|
||||||
@@ -54,30 +55,20 @@ class LazyLogging:
|
|||||||
prefix = "" if clazz.__module__ is None else f"{clazz.__module__}."
|
prefix = "" if clazz.__module__ is None else f"{clazz.__module__}."
|
||||||
return f"{prefix}{clazz.__qualname__}"
|
return f"{prefix}{clazz.__qualname__}"
|
||||||
|
|
||||||
@staticmethod
|
@contextlib.contextmanager
|
||||||
def _package_logger_reset() -> None:
|
def in_context(self, name: str, value: Any) -> Iterator[None]:
|
||||||
"""
|
"""
|
||||||
reset package logger to empty one
|
execute function while setting log context. The context will be reset after the execution
|
||||||
"""
|
|
||||||
logging.setLogRecordFactory(logging.LogRecord)
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def _package_logger_set(package_base: str, version: str | None) -> None:
|
|
||||||
"""
|
|
||||||
set package base as extra info to the logger
|
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
package_base(str): package base
|
name(str): attribute name to set on log records
|
||||||
version(str | None): package version if available
|
value(Any): current value of the context variable
|
||||||
"""
|
"""
|
||||||
current_factory = logging.getLogRecordFactory()
|
token = LogContext.set(name, value)
|
||||||
|
try:
|
||||||
def package_record_factory(*args: Any, **kwargs: Any) -> logging.LogRecord:
|
yield
|
||||||
record = current_factory(*args, **kwargs)
|
finally:
|
||||||
record.package_id = LogRecordId(package_base, version or "<unknown>")
|
LogContext.reset(name, token)
|
||||||
return record
|
|
||||||
|
|
||||||
logging.setLogRecordFactory(package_record_factory)
|
|
||||||
|
|
||||||
@contextlib.contextmanager
|
@contextlib.contextmanager
|
||||||
def in_package_context(self, package_base: str, version: str | None) -> Iterator[None]:
|
def in_package_context(self, package_base: str, version: str | None) -> Iterator[None]:
|
||||||
@@ -94,8 +85,5 @@ class LazyLogging:
|
|||||||
>>> with self.in_package_context(package.base, package.version):
|
>>> with self.in_package_context(package.base, package.version):
|
||||||
>>> build_package(package)
|
>>> build_package(package)
|
||||||
"""
|
"""
|
||||||
try:
|
with self.in_context("package_id", LogRecordId(package_base, version or "<unknown>")):
|
||||||
self._package_logger_set(package_base, version)
|
|
||||||
yield
|
yield
|
||||||
finally:
|
|
||||||
self._package_logger_reset()
|
|
||||||
|
|||||||
108
src/ahriman/core/log/log_context.py
Normal file
108
src/ahriman/core/log/log_context.py
Normal file
@@ -0,0 +1,108 @@
|
|||||||
|
#
|
||||||
|
# Copyright (c) 2021-2026 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 contextvars
|
||||||
|
import logging
|
||||||
|
|
||||||
|
from typing import Any, ClassVar, TypeVar, cast
|
||||||
|
|
||||||
|
|
||||||
|
T = TypeVar("T")
|
||||||
|
|
||||||
|
|
||||||
|
class LogContext:
|
||||||
|
"""
|
||||||
|
logging context manager which provides context variables injection into log records
|
||||||
|
"""
|
||||||
|
|
||||||
|
_context: ClassVar[dict[str, contextvars.ContextVar[Any]]] = {}
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def get(cls, name: str) -> T | None:
|
||||||
|
"""
|
||||||
|
get context variable if available
|
||||||
|
|
||||||
|
Args:
|
||||||
|
name(str): name of the context variable
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
T | None: context variable if available and ``None`` otherwise
|
||||||
|
"""
|
||||||
|
if (variable := cls._context.get(name)) is not None:
|
||||||
|
return cast(T | None, variable.get())
|
||||||
|
return None
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def log_record_factory(cls, *args: Any, **kwargs: Any) -> logging.LogRecord:
|
||||||
|
"""
|
||||||
|
log record factory which injects all registered context variables into log records
|
||||||
|
|
||||||
|
Args:
|
||||||
|
*args(Any): positional arguments for the log factory
|
||||||
|
**kwargs(Any): keyword arguments for the log factory
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
logging.LogRecord: log record with context variables set as attributes
|
||||||
|
"""
|
||||||
|
record = logging.LogRecord(*args, **kwargs)
|
||||||
|
|
||||||
|
for name, variable in cls._context.items():
|
||||||
|
if (value := variable.get()) is not None:
|
||||||
|
setattr(record, name, value)
|
||||||
|
|
||||||
|
return record
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def register(cls, name: str) -> contextvars.ContextVar[T]:
|
||||||
|
"""
|
||||||
|
(re)create context variable for log records
|
||||||
|
|
||||||
|
Args:
|
||||||
|
name(str): name of the context variable
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
contextvars.ContextVar[T]: created context variable
|
||||||
|
"""
|
||||||
|
variable = cls._context[name] = contextvars.ContextVar(name, default=None)
|
||||||
|
return variable
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def reset(cls, name: str, token: contextvars.Token[T]) -> None:
|
||||||
|
"""
|
||||||
|
reset context variable to its previous value
|
||||||
|
|
||||||
|
Args:
|
||||||
|
name(str): attribute name to reset on log records
|
||||||
|
token(contextvars.Token[T]): previously registered token
|
||||||
|
"""
|
||||||
|
cls._context[name].reset(token)
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def set(cls, name: str, value: T) -> contextvars.Token[T]:
|
||||||
|
"""
|
||||||
|
set context variable for log records. This value will be automatically emitted with each log record
|
||||||
|
|
||||||
|
Args:
|
||||||
|
name(str): attribute name to set on log records
|
||||||
|
value(T): current value of the context variable
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
contextvars.Token[T]: token created with this value
|
||||||
|
"""
|
||||||
|
return cls._context[name].set(value)
|
||||||
@@ -21,10 +21,11 @@ import logging
|
|||||||
|
|
||||||
from logging.config import fileConfig
|
from logging.config import fileConfig
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import ClassVar
|
from typing import ClassVar, Literal
|
||||||
|
|
||||||
from ahriman.core.configuration import Configuration
|
from ahriman.core.configuration import Configuration
|
||||||
from ahriman.core.log.http_log_handler import HttpLogHandler
|
from ahriman.core.log.http_log_handler import HttpLogHandler
|
||||||
|
from ahriman.core.log.log_context import LogContext
|
||||||
from ahriman.models.log_handler import LogHandler
|
from ahriman.models.log_handler import LogHandler
|
||||||
from ahriman.models.repository_id import RepositoryId
|
from ahriman.models.repository_id import RepositoryId
|
||||||
|
|
||||||
@@ -36,11 +37,13 @@ class LogLoader:
|
|||||||
Attributes:
|
Attributes:
|
||||||
DEFAULT_LOG_FORMAT(str): (class attribute) default log format (in case of fallback)
|
DEFAULT_LOG_FORMAT(str): (class attribute) default log format (in case of fallback)
|
||||||
DEFAULT_LOG_LEVEL(int): (class attribute) default log level (in case of fallback)
|
DEFAULT_LOG_LEVEL(int): (class attribute) default log level (in case of fallback)
|
||||||
|
DEFAULT_LOG_STYLE(str): (class attribute) default log style (in case of fallback)
|
||||||
DEFAULT_SYSLOG_DEVICE(Path): (class attribute) default path to syslog device
|
DEFAULT_SYSLOG_DEVICE(Path): (class attribute) default path to syslog device
|
||||||
"""
|
"""
|
||||||
|
|
||||||
DEFAULT_LOG_FORMAT: ClassVar[str] = "[%(levelname)s %(asctime)s] [%(name)s]: %(message)s"
|
DEFAULT_LOG_FORMAT: ClassVar[str] = "[{levelname} {asctime}] [{name}]: {message}"
|
||||||
DEFAULT_LOG_LEVEL: ClassVar[int] = logging.DEBUG
|
DEFAULT_LOG_LEVEL: ClassVar[int] = logging.DEBUG
|
||||||
|
DEFAULT_LOG_STYLE: ClassVar[Literal["%", "{", "$"]] = "{"
|
||||||
DEFAULT_SYSLOG_DEVICE: ClassVar[Path] = Path("/") / "dev" / "log"
|
DEFAULT_SYSLOG_DEVICE: ClassVar[Path] = Path("/") / "dev" / "log"
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
@@ -100,10 +103,22 @@ class LogLoader:
|
|||||||
fileConfig(log_configuration, disable_existing_loggers=True)
|
fileConfig(log_configuration, disable_existing_loggers=True)
|
||||||
logging.debug("using %s logger", default_handler)
|
logging.debug("using %s logger", default_handler)
|
||||||
except Exception:
|
except Exception:
|
||||||
logging.basicConfig(filename=None, format=LogLoader.DEFAULT_LOG_FORMAT, level=LogLoader.DEFAULT_LOG_LEVEL)
|
logging.basicConfig(filename=None, format=LogLoader.DEFAULT_LOG_FORMAT,
|
||||||
|
style=LogLoader.DEFAULT_LOG_STYLE, level=LogLoader.DEFAULT_LOG_LEVEL)
|
||||||
logging.exception("could not load logging from configuration, fallback to stderr")
|
logging.exception("could not load logging from configuration, fallback to stderr")
|
||||||
|
|
||||||
HttpLogHandler.load(repository_id, configuration, report=report)
|
HttpLogHandler.load(repository_id, configuration, report=report)
|
||||||
|
LogLoader.register_context()
|
||||||
|
|
||||||
if quiet:
|
if quiet:
|
||||||
logging.disable(logging.WARNING) # only print errors here
|
logging.disable(logging.WARNING) # only print errors here
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def register_context() -> None:
|
||||||
|
"""
|
||||||
|
register logging context
|
||||||
|
"""
|
||||||
|
# predefined context variables
|
||||||
|
for variable in ("package_id", "request_id"):
|
||||||
|
LogContext.register(variable)
|
||||||
|
logging.setLogRecordFactory(LogContext.log_record_factory)
|
||||||
|
|||||||
51
src/ahriman/web/middlewares/request_id_handler.py
Normal file
51
src/ahriman/web/middlewares/request_id_handler.py
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
#
|
||||||
|
# Copyright (c) 2021-2026 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 uuid
|
||||||
|
|
||||||
|
from aiohttp.typedefs import Middleware
|
||||||
|
from aiohttp.web import Request, StreamResponse, middleware
|
||||||
|
|
||||||
|
from ahriman.core.log.log_context import LogContext
|
||||||
|
from ahriman.web.middlewares import HandlerType
|
||||||
|
|
||||||
|
|
||||||
|
__all__ = ["request_id_handler"]
|
||||||
|
|
||||||
|
|
||||||
|
def request_id_handler() -> Middleware:
|
||||||
|
"""
|
||||||
|
middleware to trace request id header
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Middleware: request id processing middleware
|
||||||
|
"""
|
||||||
|
@middleware
|
||||||
|
async def handle(request: Request, handler: HandlerType) -> StreamResponse:
|
||||||
|
request_id = request.headers.getone("X-Request-ID", str(uuid.uuid4()))
|
||||||
|
|
||||||
|
token = LogContext.set("request_id", request_id)
|
||||||
|
try:
|
||||||
|
response = await handler(request)
|
||||||
|
response.headers["X-Request-ID"] = request_id
|
||||||
|
return response
|
||||||
|
finally:
|
||||||
|
LogContext.reset("request_id", token)
|
||||||
|
|
||||||
|
return handle
|
||||||
@@ -38,6 +38,7 @@ from ahriman.web.cors import setup_cors
|
|||||||
from ahriman.web.keys import AuthKey, ConfigurationKey, SpawnKey, WatcherKey, WorkersKey
|
from ahriman.web.keys import AuthKey, ConfigurationKey, SpawnKey, WatcherKey, WorkersKey
|
||||||
from ahriman.web.middlewares.exception_handler import exception_handler
|
from ahriman.web.middlewares.exception_handler import exception_handler
|
||||||
from ahriman.web.middlewares.metrics_handler import metrics_handler
|
from ahriman.web.middlewares.metrics_handler import metrics_handler
|
||||||
|
from ahriman.web.middlewares.request_id_handler import request_id_handler
|
||||||
from ahriman.web.routes import setup_routes
|
from ahriman.web.routes import setup_routes
|
||||||
|
|
||||||
|
|
||||||
@@ -146,6 +147,7 @@ def setup_server(configuration: Configuration, spawner: Spawn, repositories: lis
|
|||||||
application.on_startup.append(_on_startup)
|
application.on_startup.append(_on_startup)
|
||||||
|
|
||||||
application.middlewares.append(normalize_path_middleware(append_slash=False, remove_slash=True))
|
application.middlewares.append(normalize_path_middleware(append_slash=False, remove_slash=True))
|
||||||
|
application.middlewares.append(request_id_handler())
|
||||||
application.middlewares.append(exception_handler(application.logger))
|
application.middlewares.append(exception_handler(application.logger))
|
||||||
application.middlewares.append(metrics_handler())
|
application.middlewares.append(metrics_handler())
|
||||||
|
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ from ahriman.core.auth import Auth
|
|||||||
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.database.migrations import Migrations
|
from ahriman.core.database.migrations import Migrations
|
||||||
|
from ahriman.core.log.log_loader import LogLoader
|
||||||
from ahriman.core.repository import Repository
|
from ahriman.core.repository import Repository
|
||||||
from ahriman.core.spawn import Spawn
|
from ahriman.core.spawn import Spawn
|
||||||
from ahriman.core.status import Client
|
from ahriman.core.status import Client
|
||||||
@@ -124,6 +125,14 @@ def import_error(package: str, components: list[str], mocker: MockerFixture) ->
|
|||||||
|
|
||||||
|
|
||||||
# generic fixtures
|
# generic fixtures
|
||||||
|
@pytest.fixture(autouse=True)
|
||||||
|
def _register_log_context() -> None:
|
||||||
|
"""
|
||||||
|
register log context variables and factory
|
||||||
|
"""
|
||||||
|
LogLoader.register_context()
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def aur_package_ahriman() -> AURPackage:
|
def aur_package_ahriman() -> AURPackage:
|
||||||
"""
|
"""
|
||||||
|
|||||||
@@ -30,6 +30,13 @@ def test_login_url(ahriman_client: SyncAhrimanClient) -> None:
|
|||||||
assert ahriman_client._login_url().endswith("/api/v1/login")
|
assert ahriman_client._login_url().endswith("/api/v1/login")
|
||||||
|
|
||||||
|
|
||||||
|
def test_headers(ahriman_client: SyncAhrimanClient) -> None:
|
||||||
|
"""
|
||||||
|
must inject request id header
|
||||||
|
"""
|
||||||
|
assert "X-Request-ID" in ahriman_client.headers()
|
||||||
|
|
||||||
|
|
||||||
def test_on_session_creation(ahriman_client: SyncAhrimanClient, user: User, mocker: MockerFixture) -> None:
|
def test_on_session_creation(ahriman_client: SyncAhrimanClient, user: User, mocker: MockerFixture) -> None:
|
||||||
"""
|
"""
|
||||||
must log in user on start
|
must log in user on start
|
||||||
|
|||||||
@@ -94,6 +94,13 @@ def test_adapters() -> None:
|
|||||||
assert all(adapter.max_retries == client.retry for adapter in adapters.values())
|
assert all(adapter.max_retries == client.retry for adapter in adapters.values())
|
||||||
|
|
||||||
|
|
||||||
|
def test_headers() -> None:
|
||||||
|
"""
|
||||||
|
must return empty additional headers
|
||||||
|
"""
|
||||||
|
assert SyncHttpClient().headers() == {}
|
||||||
|
|
||||||
|
|
||||||
def test_make_request(mocker: MockerFixture) -> None:
|
def test_make_request(mocker: MockerFixture) -> None:
|
||||||
"""
|
"""
|
||||||
must make HTTP request
|
must make HTTP request
|
||||||
@@ -194,6 +201,20 @@ def test_make_request_session() -> None:
|
|||||||
stream=None, auth=None, timeout=client.timeout)
|
stream=None, auth=None, timeout=client.timeout)
|
||||||
|
|
||||||
|
|
||||||
|
def test_make_request_with_additional_headers(mocker: MockerFixture) -> None:
|
||||||
|
"""
|
||||||
|
must merge additional headers into request
|
||||||
|
"""
|
||||||
|
request_mock = mocker.patch("requests.Session.request")
|
||||||
|
mocker.patch("ahriman.core.http.sync_http_client.SyncHttpClient.headers", return_value={"X-Custom": "value"})
|
||||||
|
client = SyncHttpClient()
|
||||||
|
|
||||||
|
client.make_request("GET", "url")
|
||||||
|
request_mock.assert_called_once_with(
|
||||||
|
"GET", "url", params=None, data=None, headers={"X-Custom": "value"}, files=None, json=None,
|
||||||
|
stream=None, auth=None, timeout=client.timeout)
|
||||||
|
|
||||||
|
|
||||||
def test_on_session_creation() -> None:
|
def test_on_session_creation() -> None:
|
||||||
"""
|
"""
|
||||||
must do nothing on start
|
must do nothing on start
|
||||||
|
|||||||
@@ -1,8 +1,6 @@
|
|||||||
import logging
|
import logging
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from pytest_mock import MockerFixture
|
|
||||||
|
|
||||||
from ahriman.core.alpm.repo import Repo
|
from ahriman.core.alpm.repo import Repo
|
||||||
from ahriman.core.build_tools.task import Task
|
from ahriman.core.build_tools.task import Task
|
||||||
from ahriman.core.database import SQLite
|
from ahriman.core.database import SQLite
|
||||||
@@ -30,59 +28,46 @@ def test_logger_name(database: SQLite, repo: Repo, task_ahriman: Task) -> None:
|
|||||||
assert task_ahriman.logger_name == "ahriman.core.build_tools.task.Task"
|
assert task_ahriman.logger_name == "ahriman.core.build_tools.task.Task"
|
||||||
|
|
||||||
|
|
||||||
def test_package_logger_set_reset(database: SQLite) -> None:
|
def test_in_context(database: SQLite) -> None:
|
||||||
"""
|
"""
|
||||||
must set and reset package base attribute
|
must set and reset generic log context
|
||||||
"""
|
"""
|
||||||
log_record_id = LogRecordId("base", "version")
|
with database.in_context("package_id", "42"):
|
||||||
|
|
||||||
database._package_logger_set(log_record_id.package_base, log_record_id.version)
|
|
||||||
record = logging.makeLogRecord({})
|
record = logging.makeLogRecord({})
|
||||||
assert record.package_id == log_record_id
|
assert record.package_id == "42"
|
||||||
|
|
||||||
database._package_logger_reset()
|
|
||||||
record = logging.makeLogRecord({})
|
record = logging.makeLogRecord({})
|
||||||
with pytest.raises(AttributeError):
|
assert not hasattr(record, "package_id")
|
||||||
assert record.package_id
|
|
||||||
|
|
||||||
|
|
||||||
def test_in_package_context(database: SQLite, package_ahriman: Package, mocker: MockerFixture) -> None:
|
def test_in_context_failed(database: SQLite) -> None:
|
||||||
|
"""
|
||||||
|
must reset context even if exception occurs
|
||||||
|
"""
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
with database.in_context("package_id", "42"):
|
||||||
|
raise ValueError()
|
||||||
|
|
||||||
|
record = logging.makeLogRecord({})
|
||||||
|
assert not hasattr(record, "package_id")
|
||||||
|
|
||||||
|
|
||||||
|
def test_in_package_context(database: SQLite, package_ahriman: Package) -> None:
|
||||||
"""
|
"""
|
||||||
must set package log context
|
must set package log context
|
||||||
"""
|
"""
|
||||||
set_mock = mocker.patch("ahriman.core.log.LazyLogging._package_logger_set")
|
|
||||||
reset_mock = mocker.patch("ahriman.core.log.LazyLogging._package_logger_reset")
|
|
||||||
|
|
||||||
with database.in_package_context(package_ahriman.base, package_ahriman.version):
|
with database.in_package_context(package_ahriman.base, package_ahriman.version):
|
||||||
pass
|
record = logging.makeLogRecord({})
|
||||||
|
assert record.package_id == LogRecordId(package_ahriman.base, package_ahriman.version)
|
||||||
|
|
||||||
set_mock.assert_called_once_with(package_ahriman.base, package_ahriman.version)
|
record = logging.makeLogRecord({})
|
||||||
reset_mock.assert_called_once_with()
|
assert not hasattr(record, "package_id")
|
||||||
|
|
||||||
|
|
||||||
def test_in_package_context_empty_version(database: SQLite, package_ahriman: Package, mocker: MockerFixture) -> None:
|
def test_in_package_context_empty_version(database: SQLite, package_ahriman: Package) -> None:
|
||||||
"""
|
"""
|
||||||
must set package log context with empty version
|
must set package log context with empty version
|
||||||
"""
|
"""
|
||||||
set_mock = mocker.patch("ahriman.core.log.LazyLogging._package_logger_set")
|
|
||||||
reset_mock = mocker.patch("ahriman.core.log.LazyLogging._package_logger_reset")
|
|
||||||
|
|
||||||
with database.in_package_context(package_ahriman.base, None):
|
with database.in_package_context(package_ahriman.base, None):
|
||||||
pass
|
record = logging.makeLogRecord({})
|
||||||
|
assert record.package_id == LogRecordId(package_ahriman.base, "<unknown>")
|
||||||
set_mock.assert_called_once_with(package_ahriman.base, None)
|
|
||||||
reset_mock.assert_called_once_with()
|
|
||||||
|
|
||||||
|
|
||||||
def test_in_package_context_failed(database: SQLite, package_ahriman: Package, mocker: MockerFixture) -> None:
|
|
||||||
"""
|
|
||||||
must reset package context even if exception occurs
|
|
||||||
"""
|
|
||||||
mocker.patch("ahriman.core.log.LazyLogging._package_logger_set")
|
|
||||||
reset_mock = mocker.patch("ahriman.core.log.LazyLogging._package_logger_reset")
|
|
||||||
|
|
||||||
with pytest.raises(ValueError):
|
|
||||||
with database.in_package_context(package_ahriman.base, ""):
|
|
||||||
raise ValueError()
|
|
||||||
|
|
||||||
reset_mock.assert_called_once_with()
|
|
||||||
|
|||||||
75
tests/ahriman/core/log/test_log_context.py
Normal file
75
tests/ahriman/core/log/test_log_context.py
Normal file
@@ -0,0 +1,75 @@
|
|||||||
|
import logging
|
||||||
|
|
||||||
|
from ahriman.core.log.log_context import LogContext
|
||||||
|
|
||||||
|
|
||||||
|
def test_get() -> None:
|
||||||
|
"""
|
||||||
|
must get context variable value
|
||||||
|
"""
|
||||||
|
token = LogContext.set("package_id", "value")
|
||||||
|
assert LogContext.get("package_id") == "value"
|
||||||
|
LogContext.reset("package_id", token)
|
||||||
|
|
||||||
|
|
||||||
|
def test_get_empty() -> None:
|
||||||
|
"""
|
||||||
|
must return None when context variable is unknown or not set
|
||||||
|
"""
|
||||||
|
assert LogContext.get("package_id") is None
|
||||||
|
assert LogContext.get("random") is None
|
||||||
|
|
||||||
|
|
||||||
|
def test_log_record_factory() -> None:
|
||||||
|
"""
|
||||||
|
must inject all registered context variables into log records
|
||||||
|
"""
|
||||||
|
package_token = LogContext.set("package_id", "package")
|
||||||
|
|
||||||
|
record = logging.makeLogRecord({})
|
||||||
|
assert record.package_id == "package"
|
||||||
|
|
||||||
|
LogContext.reset("package_id", package_token)
|
||||||
|
|
||||||
|
|
||||||
|
def test_log_record_factory_empty() -> None:
|
||||||
|
"""
|
||||||
|
must not inject context variable when value is None
|
||||||
|
"""
|
||||||
|
record = logging.makeLogRecord({})
|
||||||
|
assert not hasattr(record, "package_id")
|
||||||
|
|
||||||
|
|
||||||
|
def test_register() -> None:
|
||||||
|
"""
|
||||||
|
must register a context variable
|
||||||
|
"""
|
||||||
|
variable = LogContext.register("random")
|
||||||
|
|
||||||
|
assert "random" in LogContext._context
|
||||||
|
assert LogContext._context["random"] is variable
|
||||||
|
|
||||||
|
del LogContext._context["random"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_reset() -> None:
|
||||||
|
"""
|
||||||
|
must reset context variable so it is no longer injected
|
||||||
|
"""
|
||||||
|
token = LogContext.set("package_id", "value")
|
||||||
|
LogContext.reset("package_id", token)
|
||||||
|
|
||||||
|
record = logging.makeLogRecord({})
|
||||||
|
assert not hasattr(record, "package_id")
|
||||||
|
|
||||||
|
|
||||||
|
def test_set() -> None:
|
||||||
|
"""
|
||||||
|
must set context variable and inject it into log records
|
||||||
|
"""
|
||||||
|
token = LogContext.set("package_id", "value")
|
||||||
|
|
||||||
|
record = logging.makeLogRecord({})
|
||||||
|
assert record.package_id == "value"
|
||||||
|
|
||||||
|
LogContext.reset("package_id", token)
|
||||||
@@ -7,6 +7,7 @@ from pytest_mock import MockerFixture
|
|||||||
from systemd.journal import JournalHandler
|
from systemd.journal import JournalHandler
|
||||||
|
|
||||||
from ahriman.core.configuration import Configuration
|
from ahriman.core.configuration import Configuration
|
||||||
|
from ahriman.core.log.log_context import LogContext
|
||||||
from ahriman.core.log.log_loader import LogLoader
|
from ahriman.core.log.log_loader import LogLoader
|
||||||
from ahriman.models.log_handler import LogHandler
|
from ahriman.models.log_handler import LogHandler
|
||||||
|
|
||||||
@@ -75,3 +76,13 @@ def test_load_quiet(configuration: Configuration, mocker: MockerFixture) -> None
|
|||||||
_, repository_id = configuration.check_loaded()
|
_, repository_id = configuration.check_loaded()
|
||||||
LogLoader.load(repository_id, configuration, LogHandler.Journald, quiet=True, report=False)
|
LogLoader.load(repository_id, configuration, LogHandler.Journald, quiet=True, report=False)
|
||||||
disable_mock.assert_called_once_with(logging.WARNING)
|
disable_mock.assert_called_once_with(logging.WARNING)
|
||||||
|
|
||||||
|
|
||||||
|
def test_register_context() -> None:
|
||||||
|
"""
|
||||||
|
must register predefined context variables and install log record factory
|
||||||
|
"""
|
||||||
|
LogLoader.register_context()
|
||||||
|
assert "package_id" in LogContext._context
|
||||||
|
assert "request_id" in LogContext._context
|
||||||
|
assert logging.getLogRecordFactory().__func__ is LogContext.log_record_factory.__func__
|
||||||
|
|||||||
43
tests/ahriman/web/middlewares/test_request_id_handler.py
Normal file
43
tests/ahriman/web/middlewares/test_request_id_handler.py
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
import logging
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from unittest.mock import AsyncMock, MagicMock
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
from ahriman.web.middlewares.request_id_handler import request_id_handler
|
||||||
|
|
||||||
|
|
||||||
|
async def test_request_id_handler() -> None:
|
||||||
|
"""
|
||||||
|
must use request id from request if available
|
||||||
|
"""
|
||||||
|
request = pytest.helpers.request("", "", "")
|
||||||
|
request.headers = MagicMock()
|
||||||
|
request.headers.getone.return_value = "request_id"
|
||||||
|
|
||||||
|
response = MagicMock()
|
||||||
|
response.headers = {}
|
||||||
|
|
||||||
|
async def check_handler(_: Any) -> MagicMock:
|
||||||
|
record = logging.makeLogRecord({})
|
||||||
|
assert record.request_id == "request_id"
|
||||||
|
return response
|
||||||
|
|
||||||
|
handler = request_id_handler()
|
||||||
|
await handler(request, check_handler)
|
||||||
|
assert response.headers["X-Request-ID"] == "request_id"
|
||||||
|
|
||||||
|
|
||||||
|
async def test_request_id_handler_generate() -> None:
|
||||||
|
"""
|
||||||
|
must generate request id and set it in response header
|
||||||
|
"""
|
||||||
|
request = pytest.helpers.request("", "", "")
|
||||||
|
|
||||||
|
response = MagicMock()
|
||||||
|
response.headers = {}
|
||||||
|
request_handler = AsyncMock(return_value=response)
|
||||||
|
|
||||||
|
handler = request_id_handler()
|
||||||
|
await handler(request, request_handler)
|
||||||
|
assert "X-Request-ID" in response.headers
|
||||||
Reference in New Issue
Block a user