From 6bd1636bfa7e65f75b4837f2c473fe1d87f298f2 Mon Sep 17 00:00:00 2001 From: Evgenii Alekseev Date: Tue, 17 Oct 2023 03:53:33 +0300 Subject: [PATCH] feat: allow to use single web instance for all repositories (#114) * Allow to use single web instance for any repository * some improvements * drop includes from user home directory, introduce new variables to docker The old solution didn't actually work as expected, because devtools configuration belongs to filesystem (as well as sudo one), so it was still required to run setup command. In order to handle additional repositories, the POSTSETUP and PRESETUP commands variables have been introduced. FAQ has been updated as well * raise 404 in case if repository is unknown --- .github/workflows/setup.sh | 2 +- CONTRIBUTING.md | 1 + Dockerfile | 2 + docker/entrypoint.sh | 3 + docs/ahriman.application.handlers.rst | 8 + docs/ahriman.core.formatters.rst | 8 + docs/ahriman.models.rst | 8 + docs/ahriman.web.schemas.rst | 8 + docs/ahriman.web.views.v1.status.rst | 8 + docs/configuration.rst | 8 +- docs/faq.rst | 24 +- docs/migration.rst | 4 +- docs/setup.rst | 2 +- package/archlinux/PKGBUILD | 2 +- .../lib/systemd/system/ahriman-web.service | 12 + .../lib/systemd/system/ahriman-web@.service | 13 +- .../ahriman/templates/build-status.jinja2 | 31 +- .../build-status/key-import-modal.jinja2 | 34 +-- .../templates/build-status/login-modal.jinja2 | 18 +- .../build-status/package-add-modal.jinja2 | 47 ++- .../build-status/package-info-modal.jinja2 | 8 +- .../build-status/package-rebuild-modal.jinja2 | 26 +- .../templates/build-status/table.jinja2 | 63 +++- .../share/ahriman/templates/static/logo.svg | 70 +++++ .../templates/utils/bootstrap-scripts.jinja2 | 2 +- .../bash-completion/completions/_ahriman | 21 +- package/share/man/man1/ahriman.1 | 35 ++- package/share/zsh/site-functions/_ahriman | 20 +- src/ahriman/application/ahriman.py | 87 ++++-- .../application/application/application.py | 2 +- .../application/application_packages.py | 2 +- .../application/application_repository.py | 2 +- src/ahriman/application/handlers/__init__.py | 1 + src/ahriman/application/handlers/dump.py | 22 +- src/ahriman/application/handlers/handler.py | 110 +++---- .../application/handlers/repositories.py | 54 ++++ src/ahriman/application/handlers/search.py | 7 +- .../application/handlers/service_updates.py | 5 +- src/ahriman/application/handlers/setup.py | 8 +- .../application/handlers/status_update.py | 12 +- src/ahriman/application/handlers/web.py | 24 +- src/ahriman/application/lock.py | 5 +- src/ahriman/core/alpm/remote/aur.py | 8 +- src/ahriman/core/alpm/remote/official.py | 8 +- .../core/alpm/remote/official_syncdb.py | 7 +- src/ahriman/core/alpm/remote/remote.py | 23 +- .../core/configuration/configuration.py | 27 +- src/ahriman/core/configuration/schema.py | 1 - .../database/operations/build_operations.py | 6 +- .../database/operations/logs_operations.py | 27 +- .../core/database/operations/operations.py | 3 +- .../database/operations/package_operations.py | 94 ++++-- src/ahriman/core/formatters/__init__.py | 1 + .../core/formatters/repository_printer.py | 53 ++++ src/ahriman/core/log/http_log_handler.py | 12 +- src/ahriman/core/log/log_loader.py | 7 +- src/ahriman/core/report/remote_call.py | 14 +- .../core/repository/repository_properties.py | 2 +- src/ahriman/core/repository/update_handler.py | 2 +- src/ahriman/core/spawn.py | 73 +++-- src/ahriman/core/status/client.py | 6 +- src/ahriman/core/status/watcher.py | 31 +- src/ahriman/core/status/web_client.py | 24 +- src/ahriman/core/upload/remote_service.py | 5 +- src/ahriman/models/package.py | 7 +- src/ahriman/models/process_status.py | 36 +++ src/ahriman/models/repository_id.py | 21 ++ src/ahriman/web/schemas/__init__.py | 1 + .../web/schemas/internal_status_schema.py | 13 +- src/ahriman/web/schemas/log_schema.py | 5 +- .../web/schemas/package_status_schema.py | 7 + src/ahriman/web/schemas/pagination_schema.py | 6 +- .../web/schemas/repository_id_schema.py | 35 +++ src/ahriman/web/views/base.py | 62 +++- src/ahriman/web/views/index.py | 13 +- src/ahriman/web/views/v1/service/add.py | 7 +- src/ahriman/web/views/v1/service/pgp.py | 10 +- src/ahriman/web/views/v1/service/process.py | 2 +- src/ahriman/web/views/v1/service/rebuild.py | 7 +- src/ahriman/web/views/v1/service/remove.py | 7 +- src/ahriman/web/views/v1/service/request.py | 7 +- src/ahriman/web/views/v1/service/search.py | 2 +- src/ahriman/web/views/v1/service/update.py | 6 +- src/ahriman/web/views/v1/service/upload.py | 11 +- src/ahriman/web/views/v1/status/logs.py | 18 +- src/ahriman/web/views/v1/status/package.py | 22 +- src/ahriman/web/views/v1/status/packages.py | 17 +- .../web/views/v1/status/repositories.py | 65 ++++ src/ahriman/web/views/v1/status/status.py | 16 +- src/ahriman/web/views/v1/user/login.py | 2 +- src/ahriman/web/views/v2/status/logs.py | 11 +- src/ahriman/web/web.py | 27 +- .../application/test_application.py | 4 +- .../application/handlers/test_handler.py | 54 ++-- .../application/handlers/test_handler_dump.py | 46 +++ .../handlers/test_handler_repositories.py | 37 +++ .../handlers/test_handler_search.py | 4 +- .../handlers/test_handler_service_updates.py | 2 +- .../handlers/test_handler_setup.py | 12 +- .../handlers/test_handler_status_update.py | 7 +- .../application/handlers/test_handler_web.py | 28 +- tests/ahriman/application/test_ahriman.py | 289 ++++++++++-------- tests/ahriman/application/test_lock.py | 2 +- tests/ahriman/conftest.py | 15 +- tests/ahriman/core/alpm/remote/test_aur.py | 14 +- .../ahriman/core/alpm/remote/test_official.py | 16 +- .../core/alpm/remote/test_official_syncdb.py | 11 + .../core/configuration/test_configuration.py | 40 ++- .../operations/test_build_operations.py | 12 +- .../operations/test_logs_operations.py | 17 +- .../operations/test_package_operations.py | 52 ++-- tests/ahriman/core/formatters/conftest.py | 16 +- .../formatters/test_repository_printer.py | 15 + .../ahriman/core/log/test_http_log_handler.py | 23 +- tests/ahriman/core/log/test_log_loader.py | 12 +- tests/ahriman/core/report/test_remote_call.py | 12 +- .../core/repository/test_update_handler.py | 2 +- tests/ahriman/core/status/conftest.py | 3 +- tests/ahriman/core/status/test_client.py | 17 +- tests/ahriman/core/status/test_watcher.py | 37 +-- tests/ahriman/core/status/test_web_client.py | 29 +- tests/ahriman/core/test_spawn.py | 98 +++--- tests/ahriman/core/test_util.py | 1 + .../core/upload/test_remote_service.py | 18 +- tests/ahriman/models/test_migration.py | 34 --- tests/ahriman/models/test_migration_result.py | 34 +++ tests/ahriman/models/test_package.py | 5 +- tests/ahriman/models/test_process_status.py | 0 tests/ahriman/models/test_repository_id.py | 23 ++ tests/ahriman/web/conftest.py | 34 +-- .../web/schemas/test_repository_id_schema.py | 1 + tests/ahriman/web/test_web.py | 16 +- tests/ahriman/web/views/test_view_base.py | 63 +++- .../v1/service/test_view_v1_service_add.py | 5 +- .../service/test_view_v1_service_rebuild.py | 5 +- .../v1/service/test_view_v1_service_remove.py | 5 +- .../service/test_view_v1_service_request.py | 5 +- .../v1/service/test_view_v1_service_search.py | 2 +- .../v1/service/test_view_v1_service_update.py | 5 +- .../v1/status/test_view_v1_status_package.py | 29 +- .../test_view_v1_status_repositories.py | 37 +++ 141 files changed, 2037 insertions(+), 917 deletions(-) create mode 100644 package/lib/systemd/system/ahriman-web.service mode change 100644 => 120000 package/lib/systemd/system/ahriman-web@.service create mode 100644 package/share/ahriman/templates/static/logo.svg create mode 100644 src/ahriman/application/handlers/repositories.py create mode 100644 src/ahriman/core/formatters/repository_printer.py create mode 100644 src/ahriman/models/process_status.py create mode 100644 src/ahriman/web/schemas/repository_id_schema.py create mode 100644 src/ahriman/web/views/v1/status/repositories.py create mode 100644 tests/ahriman/application/handlers/test_handler_repositories.py create mode 100644 tests/ahriman/core/formatters/test_repository_printer.py create mode 100644 tests/ahriman/models/test_process_status.py create mode 100644 tests/ahriman/web/schemas/test_repository_id_schema.py create mode 100644 tests/ahriman/web/views/v1/status/test_view_v1_status_repositories.py diff --git a/.github/workflows/setup.sh b/.github/workflows/setup.sh index 0efece74..18e96b56 100755 --- a/.github/workflows/setup.sh +++ b/.github/workflows/setup.sh @@ -42,7 +42,7 @@ ahriman -a x86_64 -r "github" service-setup --packager "ahriman bot ``. * ``AHRIMAN_PACMAN_MIRROR`` - override pacman mirror server if set. * ``AHRIMAN_PORT`` - HTTP server port if any, default is empty. +* ``AHRIMAN_POSTSETUP_COMMAND`` - if set, the command which will be called (as root) after the setup command, but before any other actions. +* ``AHRIMAN_PRESETUP_COMMAND`` - if set, the command which will be called (as root) right before the setup command. * ``AHRIMAN_REPOSITORY`` - repository name, default is ``aur-clone``. * ``AHRIMAN_REPOSITORY_SERVER`` - optional override for the repository url. Useful if you would like to download packages from remote instead of local filesystem. * ``AHRIMAN_REPOSITORY_ROOT`` - repository root. Because of filesystem rights it is required to override default repository root. By default, it uses ``ahriman`` directory inside ahriman's home, which can be passed as mount volume. @@ -429,7 +431,7 @@ This command uses same rules as ``repo-update``, thus, e.g. requires ``--privile Web service setup ^^^^^^^^^^^^^^^^^ -Well for that you would need to have web container instance running forever; it can be achieved by the following command: +For that you would need to have web container instance running forever; it can be achieved by the following command: .. code-block:: shell @@ -451,6 +453,20 @@ Otherwise, you would need to pass ``AHRIMAN_PORT`` and mount container network t docker run --privileged --net=host -e AHRIMAN_PORT=8080 -v /path/to/local/repo:/var/lib/ahriman arcan1s/ahriman:latest +Mutli-repository web service +"""""""""""""""""""""""""""" + +Idea is pretty same as to just run web service. However, it is required to run setup commands for each repository, except for one which is specified by ``AHRIMAN_REPOSITORY`` and ``AHRIMAN_ARCHITECTURE`` variables. + +In order to create configuration for additional repositories, the ``AHRIMAN_POSTSETUP_COMMAND`` variable should be used, e.g.: + +.. code-block:: shell + + docker run --privileged -p 8080:8080 -e AHRIMAN_PORT=8080 -e AHRIMAN_UNIX_SOCKET=/var/lib/ahriman/ahriman/ahriman-web.sock -e AHRIMAN_POSTSETUP_COMMAND="ahriman --architecture x86_64 --repository aur-clone-v2 service-setup --build-as-user ahriman --packager 'ahriman bot '" -v /path/to/local/repo:/var/lib/ahriman arcan1s/ahriman:latest + +The command above will also create configuration for the repository named ``aur-clone-v2``. + +Note, however, that the command above is only required in case if the service is going to be used to run subprocesses. Otherwise, everything else (web interface, status, etc) will be handled as usual. Non-x86_64 architecture setup ----------------------------- @@ -1073,7 +1089,7 @@ How to setup web service port = 8080 #. - Start the web service ``systemctl enable --now ahriman-web@x86_64-aur-clone``. + Start the web service ``systemctl enable --now ahriman-web``. How to enable basic authorization ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -1130,7 +1146,7 @@ How to enable basic authorization sudo -u ahriman ahriman user-add -r full my-first-user #. - Restart web service ``systemctl restart ahriman-web@x86_64-aur-clone``. + Restart web service ``systemctl restart ahriman-web``. How to enable OAuth authorization ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -1176,7 +1192,7 @@ How to enable OAuth authorization When it will ask for the password leave it blank. #. - Restart web service ``systemctl restart ahriman-web@x86_64-aur-clone``. + Restart web service ``systemctl restart ahriman-web``. How to implement own interface ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/migration.rst b/docs/migration.rst index 265bf982..0a6ba9c8 100644 --- a/docs/migration.rst +++ b/docs/migration.rst @@ -54,6 +54,8 @@ In order to migrate to new filesystem tree the following actions are required: Alternatively it can be done by running ``service-setup`` command again. +#. If you didn't run setup command on the previous step, make sure to remove architecture reference from ``web`` section (if any). + #. Make sure to update remote synchronization services if any. Almost all of them rely on current repository tree by default, so you need to setup either redirects or configure to synchronize to the old locations (e.g. ``object_path`` option for S3 synchronization). @@ -63,4 +65,4 @@ In order to migrate to new filesystem tree the following actions are required: .. code-block:: shell sudo systemctl enable --now ahriman@x86_64-aur-clone.timer - sudo systemctl enable --now ahriman-web@x86_64-aur-clone + sudo systemctl enable --now ahriman-web diff --git a/docs/setup.rst b/docs/setup.rst index 34227cbd..c431046b 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -81,7 +81,7 @@ Initial setup .. code-block:: shell - systemctl enable --now ahriman-web@x86_64-aur-clone + systemctl enable --now ahriman-web #. Add packages by using ``ahriman package-add {package}`` command: diff --git a/package/archlinux/PKGBUILD b/package/archlinux/PKGBUILD index 44f4156d..5a87f515 100644 --- a/package/archlinux/PKGBUILD +++ b/package/archlinux/PKGBUILD @@ -46,7 +46,7 @@ package() { python -m installer --destdir="$pkgdir" "dist/$pkgname-$pkgver-py3-none-any.whl" # thanks too PEP517, which we all wanted, you need to install data files manually nowadays - pushd package && find . -type f -exec install -Dm644 "{}" "$pkgdir/usr/{}" \; && popd + pushd package && find . \( -type f -or -type l \) -exec install -Dm644 "{}" "$pkgdir/usr/{}" \; && popd # keep usr/share configs as reference and copy them to /etc install -Dm644 "$pkgdir/usr/share/$pkgname/settings/ahriman.ini" "$pkgdir/etc/ahriman.ini" diff --git a/package/lib/systemd/system/ahriman-web.service b/package/lib/systemd/system/ahriman-web.service new file mode 100644 index 00000000..eb7693d1 --- /dev/null +++ b/package/lib/systemd/system/ahriman-web.service @@ -0,0 +1,12 @@ +[Unit] +Description=ArcH linux ReposItory MANager web server +After=network.target + +[Service] +Type=simple +ExecStart=/usr/bin/ahriman web +User=ahriman +Group=ahriman + +[Install] +WantedBy=multi-user.target diff --git a/package/lib/systemd/system/ahriman-web@.service b/package/lib/systemd/system/ahriman-web@.service deleted file mode 100644 index 7b137599..00000000 --- a/package/lib/systemd/system/ahriman-web@.service +++ /dev/null @@ -1,12 +0,0 @@ -[Unit] -Description=ArcH linux ReposItory MANager web server (%i) -After=network.target - -[Service] -Type=simple -ExecStart=/usr/bin/ahriman --repository-id "%I" web -User=ahriman -Group=ahriman - -[Install] -WantedBy=multi-user.target diff --git a/package/lib/systemd/system/ahriman-web@.service b/package/lib/systemd/system/ahriman-web@.service new file mode 120000 index 00000000..c0d35a32 --- /dev/null +++ b/package/lib/systemd/system/ahriman-web@.service @@ -0,0 +1 @@ +ahriman-web.service \ No newline at end of file diff --git a/package/share/ahriman/templates/build-status.jinja2 b/package/share/ahriman/templates/build-status.jinja2 index 880db5d9..7fdf0d26 100644 --- a/package/share/ahriman/templates/build-status.jinja2 +++ b/package/share/ahriman/templates/build-status.jinja2 @@ -1,7 +1,7 @@ - {{ repository }} + ahriman @@ -16,7 +16,22 @@ {% include "utils/bootstrap-scripts.jinja2" %}
-

ahriman

+
@@ -31,28 +46,28 @@
  • -
  • -
  • -
  • -
- {% endif %} @@ -117,7 +132,7 @@ {% if auth.enabled %}
    {% if auth.username is none %} -
  • {{ auth.control|safe }}
    • +
  • {{ auth.control | safe }}
    • {% else %}
  • diff --git a/package/share/ahriman/templates/build-status/key-import-modal.jinja2 b/package/share/ahriman/templates/build-status/key-import-modal.jinja2 index 7def88d6..c06e6acc 100644 --- a/package/share/ahriman/templates/build-status/key-import-modal.jinja2 +++ b/package/share/ahriman/templates/build-status/key-import-modal.jinja2 @@ -8,21 +8,21 @@
    - +
    - +
    - +
    - +
    -
    +
    @@ -39,24 +39,24 @@ const keyImportModal = $("#key-import-modal"); const keyImportForm = $("#key-import-form"); keyImportModal.on("hidden.bs.modal", () => { - keyBodyInput.text(""); + keyImportBodyInput.text(""); keyImportForm.trigger("reset"); }); - const keyBodyInput = $("#key-body-input"); - const keyCopyButton = $("#key-copy-btn"); + const keyImportBodyInput = $("#key-import-body-input"); + const keyImportCopyButton = $("#key-import-copy-button"); - const keyFingerprintInput = $("#key-fingerprint-input"); - const keyServerInput = $("#key-server-input"); + const keyImportFingerprintInput = $("#key-import-fingerprint-input"); + const keyImportServerInput = $("#key-import-server-input"); async function copyPgpKey() { - const logs = keyBodyInput.text(); - await copyToClipboard(logs, keyCopyButton); + const logs = keyImportBodyInput.text(); + await copyToClipboard(logs, keyImportCopyButton); } function fetchPgpKey() { - const key = keyFingerprintInput.val(); - const server = keyServerInput.val(); + const key = keyImportFingerprintInput.val(); + const server = keyImportServerInput.val(); if (key && server) { $.ajax({ @@ -64,14 +64,14 @@ data: {"key": key, "server": server}, type: "GET", dataType: "json", - success: response => { keyBodyInput.text(response.key); }, + success: response => { keyImportBodyInput.text(response.key); }, }); } } function importPgpKey() { - const key = keyFingerprintInput.val(); - const server = keyServerInput.val(); + const key = keyImportFingerprintInput.val(); + const server = keyImportServerInput.val(); if (key && server) { $.ajax({ diff --git a/package/share/ahriman/templates/build-status/login-modal.jinja2 b/package/share/ahriman/templates/build-status/login-modal.jinja2 index 7e9a8416..7a94772b 100644 --- a/package/share/ahriman/templates/build-status/login-modal.jinja2 +++ b/package/share/ahriman/templates/build-status/login-modal.jinja2 @@ -8,18 +8,18 @@
    - -
    - + +
    +
    - -
    + +
    - +
    - +
    @@ -34,8 +34,8 @@
    diff --git a/package/share/ahriman/templates/build-status/package-info-modal.jinja2 b/package/share/ahriman/templates/build-status/package-info-modal.jinja2 index 38560a86..fbe9355a 100644 --- a/package/share/ahriman/templates/build-status/package-info-modal.jinja2 +++ b/package/share/ahriman/templates/build-status/package-info-modal.jinja2 @@ -6,7 +6,7 @@
    -
    +
    @@ -22,7 +22,7 @@ const packageInfo = $("#package-info"); const packageInfoLogsInput = $("#package-info-logs-input"); - const packageInfoLogsCopyButton = $("#logs-copy-btn"); + const packageInfoLogsCopyButton = $("#package-info-logs-copy-button"); async function copyLogs() { const logs = packageInfoLogsInput.text(); @@ -46,6 +46,10 @@ $.ajax({ url: `/api/v2/packages/${packageBase}/logs`, + data: { + architecture: repository.architecture, + repository: repository.repository, + }, type: "GET", dataType: "json", success: response => { diff --git a/package/share/ahriman/templates/build-status/package-rebuild-modal.jinja2 b/package/share/ahriman/templates/build-status/package-rebuild-modal.jinja2 index 2724128d..96c042ab 100644 --- a/package/share/ahriman/templates/build-status/package-rebuild-modal.jinja2 +++ b/package/share/ahriman/templates/build-status/package-rebuild-modal.jinja2 @@ -8,9 +8,19 @@
    - +
    - + +
    +
    +
    + +
    +
    @@ -25,17 +35,23 @@ diff --git a/package/share/ahriman/templates/build-status/table.jinja2 b/package/share/ahriman/templates/build-status/table.jinja2 index 64fab9f7..97140251 100644 --- a/package/share/ahriman/templates/build-status/table.jinja2 +++ b/package/share/ahriman/templates/build-status/table.jinja2 @@ -1,9 +1,21 @@ \ No newline at end of file diff --git a/package/share/ahriman/templates/static/logo.svg b/package/share/ahriman/templates/static/logo.svg new file mode 100644 index 00000000..4e34f7c9 --- /dev/null +++ b/package/share/ahriman/templates/static/logo.svg @@ -0,0 +1,70 @@ + + + + + + + + diff --git a/package/share/ahriman/templates/utils/bootstrap-scripts.jinja2 b/package/share/ahriman/templates/utils/bootstrap-scripts.jinja2 index fe090cde..e7f49dae 100644 --- a/package/share/ahriman/templates/utils/bootstrap-scripts.jinja2 +++ b/package/share/ahriman/templates/utils/bootstrap-scripts.jinja2 @@ -59,7 +59,7 @@ const [minDate, maxDate] = text.split(" - "); const buildDate = asOfStartOfDay(new Date(value)); - return (buildDate >= asOfStartOfDay(new Date(minDate))) && (buildDate <= asOfStartOfDay(new Date(maxDate))); + return (buildDate >= new Date(minDate)) && (buildDate <= new Date(maxDate)); } function filterList(index, value, field, data) { diff --git a/package/share/bash-completion/completions/_ahriman b/package/share/bash-completion/completions/_ahriman index 19797cb5..bda5a07e 100644 --- a/package/share/bash-completion/completions/_ahriman +++ b/package/share/bash-completion/completions/_ahriman @@ -1,6 +1,6 @@ # AUTOMATICALLY GENERATED by `shtab` -_shtab_ahriman_subparsers=('aur-search' 'search' 'help' 'help-commands-unsafe' 'help-updates' 'help-version' 'version' 'package-add' 'add' 'package-update' 'package-remove' 'remove' 'package-status' 'status' 'package-status-remove' 'package-status-update' 'status-update' 'patch-add' 'patch-list' 'patch-remove' 'patch-set-add' 'repo-backup' 'repo-check' 'check' 'repo-create-keyring' 'repo-create-mirrorlist' 'repo-daemon' 'daemon' 'repo-rebuild' 'rebuild' 'repo-remove-unknown' 'remove-unknown' 'repo-report' 'report' 'repo-restore' 'repo-sign' 'sign' 'repo-status-update' 'repo-sync' 'sync' 'repo-tree' 'repo-triggers' 'repo-update' 'update' 'service-clean' 'clean' 'repo-clean' 'service-config' 'config' 'repo-config' 'service-config-validate' 'config-validate' 'repo-config-validate' 'service-key-import' 'key-import' 'service-setup' 'init' 'repo-init' 'repo-setup' 'setup' 'service-shell' 'shell' 'service-tree-migrate' 'user-add' 'user-list' 'user-remove' 'web') +_shtab_ahriman_subparsers=('aur-search' 'search' 'help' 'help-commands-unsafe' 'help-updates' 'help-version' 'version' 'package-add' 'add' 'package-update' 'package-remove' 'remove' 'package-status' 'status' 'package-status-remove' 'package-status-update' 'status-update' 'patch-add' 'patch-list' 'patch-remove' 'patch-set-add' 'repo-backup' 'repo-check' 'check' 'repo-create-keyring' 'repo-create-mirrorlist' 'repo-daemon' 'daemon' 'repo-rebuild' 'rebuild' 'repo-remove-unknown' 'remove-unknown' 'repo-report' 'report' 'repo-restore' 'repo-sign' 'sign' 'repo-status-update' 'repo-sync' 'sync' 'repo-tree' 'repo-triggers' 'repo-update' 'update' 'service-clean' 'clean' 'repo-clean' 'service-config' 'config' 'repo-config' 'service-config-validate' 'config-validate' 'repo-config-validate' 'service-key-import' 'key-import' 'service-repositories' 'service-setup' 'init' 'repo-init' 'repo-setup' 'setup' 'service-shell' 'shell' 'service-tree-migrate' 'user-add' 'user-list' 'user-remove' 'web') _shtab_ahriman_option_strings=('-h' '--help' '-a' '--architecture' '-c' '--configuration' '--force' '-l' '--lock' '--log-handler' '-q' '--quiet' '--report' '--no-report' '-r' '--repository' '--unsafe' '--wait-timeout' '-V' '--version') _shtab_ahriman_aur_search_option_strings=('-h' '--help' '-e' '--exit-code' '--info' '--no-info' '--sort-by') @@ -50,14 +50,15 @@ _shtab_ahriman_update_option_strings=('-h' '--help' '--aur' '--no-aur' '--depend _shtab_ahriman_service_clean_option_strings=('-h' '--help' '--cache' '--no-cache' '--chroot' '--no-chroot' '--manual' '--no-manual' '--packages' '--no-packages' '--pacman' '--no-pacman') _shtab_ahriman_clean_option_strings=('-h' '--help' '--cache' '--no-cache' '--chroot' '--no-chroot' '--manual' '--no-manual' '--packages' '--no-packages' '--pacman' '--no-pacman') _shtab_ahriman_repo_clean_option_strings=('-h' '--help' '--cache' '--no-cache' '--chroot' '--no-chroot' '--manual' '--no-manual' '--packages' '--no-packages' '--pacman' '--no-pacman') -_shtab_ahriman_service_config_option_strings=('-h' '--help' '--secure' '--no-secure') -_shtab_ahriman_config_option_strings=('-h' '--help' '--secure' '--no-secure') -_shtab_ahriman_repo_config_option_strings=('-h' '--help' '--secure' '--no-secure') +_shtab_ahriman_service_config_option_strings=('-h' '--help' '--info' '--no-info' '--secure' '--no-secure') +_shtab_ahriman_config_option_strings=('-h' '--help' '--info' '--no-info' '--secure' '--no-secure') +_shtab_ahriman_repo_config_option_strings=('-h' '--help' '--info' '--no-info' '--secure' '--no-secure') _shtab_ahriman_service_config_validate_option_strings=('-h' '--help' '-e' '--exit-code') _shtab_ahriman_config_validate_option_strings=('-h' '--help' '-e' '--exit-code') _shtab_ahriman_repo_config_validate_option_strings=('-h' '--help' '-e' '--exit-code') _shtab_ahriman_service_key_import_option_strings=('-h' '--help' '--key-server') _shtab_ahriman_key_import_option_strings=('-h' '--help' '--key-server') +_shtab_ahriman_service_repositories_option_strings=('-h' '--help' '--id-only' '--no-id-only') _shtab_ahriman_service_setup_option_strings=('-h' '--help' '--build-as-user' '--from-configuration' '--generate-salt' '--no-generate-salt' '--makeflags-jobs' '--no-makeflags-jobs' '--mirror' '--multilib' '--no-multilib' '--packager' '--server' '--sign-key' '--sign-target' '--web-port' '--web-unix-socket') _shtab_ahriman_init_option_strings=('-h' '--help' '--build-as-user' '--from-configuration' '--generate-salt' '--no-generate-salt' '--makeflags-jobs' '--no-makeflags-jobs' '--mirror' '--multilib' '--no-multilib' '--packager' '--server' '--sign-key' '--sign-target' '--web-port' '--web-unix-socket') _shtab_ahriman_repo_init_option_strings=('-h' '--help' '--build-as-user' '--from-configuration' '--generate-salt' '--no-generate-salt' '--makeflags-jobs' '--no-makeflags-jobs' '--mirror' '--multilib' '--no-multilib' '--packager' '--server' '--sign-key' '--sign-target' '--web-port' '--web-unix-socket') @@ -73,7 +74,7 @@ _shtab_ahriman_web_option_strings=('-h' '--help') -_shtab_ahriman_pos_0_choices=('aur-search' 'search' 'help' 'help-commands-unsafe' 'help-updates' 'help-version' 'version' 'package-add' 'add' 'package-update' 'package-remove' 'remove' 'package-status' 'status' 'package-status-remove' 'package-status-update' 'status-update' 'patch-add' 'patch-list' 'patch-remove' 'patch-set-add' 'repo-backup' 'repo-check' 'check' 'repo-create-keyring' 'repo-create-mirrorlist' 'repo-daemon' 'daemon' 'repo-rebuild' 'rebuild' 'repo-remove-unknown' 'remove-unknown' 'repo-report' 'report' 'repo-restore' 'repo-sign' 'sign' 'repo-status-update' 'repo-sync' 'sync' 'repo-tree' 'repo-triggers' 'repo-update' 'update' 'service-clean' 'clean' 'repo-clean' 'service-config' 'config' 'repo-config' 'service-config-validate' 'config-validate' 'repo-config-validate' 'service-key-import' 'key-import' 'service-setup' 'init' 'repo-init' 'repo-setup' 'setup' 'service-shell' 'shell' 'service-tree-migrate' 'user-add' 'user-list' 'user-remove' 'web') +_shtab_ahriman_pos_0_choices=('aur-search' 'search' 'help' 'help-commands-unsafe' 'help-updates' 'help-version' 'version' 'package-add' 'add' 'package-update' 'package-remove' 'remove' 'package-status' 'status' 'package-status-remove' 'package-status-update' 'status-update' 'patch-add' 'patch-list' 'patch-remove' 'patch-set-add' 'repo-backup' 'repo-check' 'check' 'repo-create-keyring' 'repo-create-mirrorlist' 'repo-daemon' 'daemon' 'repo-rebuild' 'rebuild' 'repo-remove-unknown' 'remove-unknown' 'repo-report' 'report' 'repo-restore' 'repo-sign' 'sign' 'repo-status-update' 'repo-sync' 'sync' 'repo-tree' 'repo-triggers' 'repo-update' 'update' 'service-clean' 'clean' 'repo-clean' 'service-config' 'config' 'repo-config' 'service-config-validate' 'config-validate' 'repo-config-validate' 'service-key-import' 'key-import' 'service-repositories' 'service-setup' 'init' 'repo-init' 'repo-setup' 'setup' 'service-shell' 'shell' 'service-tree-migrate' 'user-add' 'user-list' 'user-remove' 'web') _shtab_ahriman___log_handler_choices=('console' 'syslog' 'journald') _shtab_ahriman_aur_search___sort_by_choices=('description' 'first_submitted' 'id' 'last_modified' 'maintainer' 'name' 'num_votes' 'out_of_date' 'package_base' 'package_base_id' 'popularity' 'repository' 'submitter' 'url' 'url_path' 'version') _shtab_ahriman_search___sort_by_choices=('description' 'first_submitted' 'id' 'last_modified' 'maintainer' 'name' 'num_votes' 'out_of_date' 'package_base' 'package_base_id' 'popularity' 'repository' 'submitter' 'url' 'url_path' 'version') @@ -400,14 +401,20 @@ _shtab_ahriman_repo_clean___pacman_nargs=0 _shtab_ahriman_repo_clean___no_pacman_nargs=0 _shtab_ahriman_service_config__h_nargs=0 _shtab_ahriman_service_config___help_nargs=0 +_shtab_ahriman_service_config___info_nargs=0 +_shtab_ahriman_service_config___no_info_nargs=0 _shtab_ahriman_service_config___secure_nargs=0 _shtab_ahriman_service_config___no_secure_nargs=0 _shtab_ahriman_config__h_nargs=0 _shtab_ahriman_config___help_nargs=0 +_shtab_ahriman_config___info_nargs=0 +_shtab_ahriman_config___no_info_nargs=0 _shtab_ahriman_config___secure_nargs=0 _shtab_ahriman_config___no_secure_nargs=0 _shtab_ahriman_repo_config__h_nargs=0 _shtab_ahriman_repo_config___help_nargs=0 +_shtab_ahriman_repo_config___info_nargs=0 +_shtab_ahriman_repo_config___no_info_nargs=0 _shtab_ahriman_repo_config___secure_nargs=0 _shtab_ahriman_repo_config___no_secure_nargs=0 _shtab_ahriman_service_config_validate__h_nargs=0 @@ -426,6 +433,10 @@ _shtab_ahriman_service_key_import__h_nargs=0 _shtab_ahriman_service_key_import___help_nargs=0 _shtab_ahriman_key_import__h_nargs=0 _shtab_ahriman_key_import___help_nargs=0 +_shtab_ahriman_service_repositories__h_nargs=0 +_shtab_ahriman_service_repositories___help_nargs=0 +_shtab_ahriman_service_repositories___id_only_nargs=0 +_shtab_ahriman_service_repositories___no_id_only_nargs=0 _shtab_ahriman_service_setup__h_nargs=0 _shtab_ahriman_service_setup___help_nargs=0 _shtab_ahriman_service_setup___generate_salt_nargs=0 diff --git a/package/share/man/man1/ahriman.1 b/package/share/man/man1/ahriman.1 index 6115d6bd..e0ad4c2e 100644 --- a/package/share/man/man1/ahriman.1 +++ b/package/share/man/man1/ahriman.1 @@ -1,16 +1,16 @@ -.TH AHRIMAN "1" "2023\-09\-02" "ahriman" "Generated Python Manual" +.TH AHRIMAN "1" "2023\-10\-09" "ahriman" "Generated Python Manual" .SH NAME ahriman .SH SYNOPSIS .B ahriman -[-h] [-a ARCHITECTURE] [-c CONFIGURATION] [--force] [-l LOCK] [--log-handler {console,syslog,journald}] [-q] [--report | --no-report] [-r REPOSITORY] [--unsafe] [--wait-timeout WAIT_TIMEOUT] [-V] {aur-search,search,help,help-commands-unsafe,help-updates,help-version,version,package-add,add,package-update,package-remove,remove,package-status,status,package-status-remove,package-status-update,status-update,patch-add,patch-list,patch-remove,patch-set-add,repo-backup,repo-check,check,repo-create-keyring,repo-create-mirrorlist,repo-daemon,daemon,repo-rebuild,rebuild,repo-remove-unknown,remove-unknown,repo-report,report,repo-restore,repo-sign,sign,repo-status-update,repo-sync,sync,repo-tree,repo-triggers,repo-update,update,service-clean,clean,repo-clean,service-config,config,repo-config,service-config-validate,config-validate,repo-config-validate,service-key-import,key-import,service-setup,init,repo-init,repo-setup,setup,service-shell,shell,service-tree-migrate,user-add,user-list,user-remove,web} ... +[-h] [-a ARCHITECTURE] [-c CONFIGURATION] [--force] [-l LOCK] [--log-handler {console,syslog,journald}] [-q] [--report | --no-report] [-r REPOSITORY] [--unsafe] [--wait-timeout WAIT_TIMEOUT] [-V] {aur-search,search,help,help-commands-unsafe,help-updates,help-version,version,package-add,add,package-update,package-remove,remove,package-status,status,package-status-remove,package-status-update,status-update,patch-add,patch-list,patch-remove,patch-set-add,repo-backup,repo-check,check,repo-create-keyring,repo-create-mirrorlist,repo-daemon,daemon,repo-rebuild,rebuild,repo-remove-unknown,remove-unknown,repo-report,report,repo-restore,repo-sign,sign,repo-status-update,repo-sync,sync,repo-tree,repo-triggers,repo-update,update,service-clean,clean,repo-clean,service-config,config,repo-config,service-config-validate,config-validate,repo-config-validate,service-key-import,key-import,service-repositories,service-setup,init,repo-init,repo-setup,setup,service-shell,shell,service-tree-migrate,user-add,user-list,user-remove,web} ... .SH DESCRIPTION ArcH linux ReposItory MANager .SH OPTIONS .TP \fB\-a\fR \fI\,ARCHITECTURE\/\fR, \fB\-\-architecture\fR \fI\,ARCHITECTURE\/\fR -target architectures. For several subcommands it can be used multiple times +filter by target architecture .TP \fB\-c\fR \fI\,CONFIGURATION\/\fR, \fB\-\-configuration\fR \fI\,CONFIGURATION\/\fR @@ -38,7 +38,7 @@ force enable or disable reporting to web service .TP \fB\-r\fR \fI\,REPOSITORY\/\fR, \fB\-\-repository\fR \fI\,REPOSITORY\/\fR -target repository. For several subcommands it can be used multiple times +filter by target repository .TP \fB\-\-unsafe\fR @@ -155,6 +155,9 @@ validate system configuration \fBahriman\fR \fI\,service\-key\-import\/\fR import PGP key .TP +\fBahriman\fR \fI\,service\-repositories\/\fR +show repositories +.TP \fBahriman\fR \fI\,service\-setup\/\fR initial service configuration .TP @@ -664,11 +667,23 @@ clear directory with built packages clear directory with pacman local database cache .SH COMMAND \fI\,'ahriman service\-config'\/\fR -usage: ahriman service\-config [\-h] [\-\-secure | \-\-no\-secure] +usage: ahriman service\-config [\-h] [\-\-info | \-\-no\-info] [\-\-secure | \-\-no\-secure] [section] [key] dump configuration for the specified architecture +.TP +\fBsection\fR +filter settings by section + +.TP +\fBkey\fR +filter settings by key + .SH OPTIONS \fI\,'ahriman service\-config'\/\fR +.TP +\fB\-\-info\fR, \fB\-\-no\-info\fR +show additional information, e.g. configuration files + .TP \fB\-\-secure\fR, \fB\-\-no\-secure\fR hide passwords and secrets from output @@ -697,6 +712,16 @@ PGP key to import from public server \fB\-\-key\-server\fR \fI\,KEY_SERVER\/\fR key server for key import +.SH COMMAND \fI\,'ahriman service\-repositories'\/\fR +usage: ahriman service\-repositories [\-h] [\-\-id\-only | \-\-no\-id\-only] + +list all available repositories + +.SH OPTIONS \fI\,'ahriman service\-repositories'\/\fR +.TP +\fB\-\-id\-only\fR, \fB\-\-no\-id\-only\fR +show machine readable identifier instead + .SH COMMAND \fI\,'ahriman service\-setup'\/\fR usage: ahriman service\-setup [\-h] [\-\-build\-as\-user BUILD_AS_USER] [\-\-from\-configuration FROM_CONFIGURATION] [\-\-generate\-salt | \-\-no\-generate\-salt] [\-\-makeflags\-jobs | \-\-no\-makeflags\-jobs] diff --git a/package/share/zsh/site-functions/_ahriman b/package/share/zsh/site-functions/_ahriman index d964add6..b4612f54 100644 --- a/package/share/zsh/site-functions/_ahriman +++ b/package/share/zsh/site-functions/_ahriman @@ -57,6 +57,7 @@ _shtab_ahriman_commands() { "service-config:dump configuration for the specified architecture" "service-config-validate:validate configuration and print found errors" "service-key-import:import PGP key from public sources to the repository user" + "service-repositories:list all available repositories" "service-setup:create initial service configuration, requires root" "service-shell:drop into python shell" "service-tree-migrate:migrate repository tree between versions" @@ -78,14 +79,14 @@ _shtab_ahriman_commands() { _shtab_ahriman_options=( "(- : *)"{-h,--help}"[show this help message and exit]" - "*"{-a,--architecture}"[target architectures. For several subcommands it can be used multiple times (default\: None)]:architecture:" + {-a,--architecture}"[filter by target architecture (default\: None)]:architecture:" {-c,--configuration}"[configuration path (default\: \/etc\/ahriman.ini)]:configuration:" "--force[force run, remove file lock (default\: False)]" {-l,--lock}"[lock file (default\: \/tmp\/ahriman.lock)]:lock:" "--log-handler[explicit log handler specification. If none set, the handler will be guessed from environment (default\: None)]:log_handler:(console syslog journald)" {-q,--quiet}"[force disable any logging (default\: False)]" {--report,--no-report}"[force enable or disable reporting to web service (default\: True)]:report:" - "*"{-r,--repository}"[target repository. For several subcommands it can be used multiple times (default\: None)]:repository:" + {-r,--repository}"[filter by target repository (default\: None)]:repository:" "--unsafe[allow to run ahriman as non-ahriman user. Some actions might be unavailable (default\: False)]" "--wait-timeout[wait for lock to be free. Negative value will lead to immediate application run even if there is lock file. In case of zero value, the application will wait infinitely (default\: -1)]:wait_timeout:" "(- : *)"{-V,--version}"[show program\'s version number and exit]" @@ -130,7 +131,10 @@ _shtab_ahriman_clean_options=( _shtab_ahriman_config_options=( "(- : *)"{-h,--help}"[show this help message and exit]" + {--info,--no-info}"[show additional information, e.g. configuration files (default\: True)]:info:" {--secure,--no-secure}"[hide passwords and secrets from output (default\: True)]:secure:" + ":filter settings by section (default\: None):" + ":filter settings by key (default\: None):" ) _shtab_ahriman_config_validate_options=( @@ -310,7 +314,10 @@ _shtab_ahriman_repo_clean_options=( _shtab_ahriman_repo_config_options=( "(- : *)"{-h,--help}"[show this help message and exit]" + {--info,--no-info}"[show additional information, e.g. configuration files (default\: True)]:info:" {--secure,--no-secure}"[hide passwords and secrets from output (default\: True)]:secure:" + ":filter settings by section (default\: None):" + ":filter settings by key (default\: None):" ) _shtab_ahriman_repo_config_validate_options=( @@ -457,7 +464,10 @@ _shtab_ahriman_service_clean_options=( _shtab_ahriman_service_config_options=( "(- : *)"{-h,--help}"[show this help message and exit]" + {--info,--no-info}"[show additional information, e.g. configuration files (default\: True)]:info:" {--secure,--no-secure}"[hide passwords and secrets from output (default\: True)]:secure:" + ":filter settings by section (default\: None):" + ":filter settings by key (default\: None):" ) _shtab_ahriman_service_config_validate_options=( @@ -471,6 +481,11 @@ _shtab_ahriman_service_key_import_options=( ":PGP key to import from public server:" ) +_shtab_ahriman_service_repositories_options=( + "(- : *)"{-h,--help}"[show this help message and exit]" + {--id-only,--no-id-only}"[show machine readable identifier instead (default\: False)]:id_only:" +) + _shtab_ahriman_service_setup_options=( "(- : *)"{-h,--help}"[show this help message and exit]" "--build-as-user[force makepkg user to the specific one (default\: None)]:build_as_user:" @@ -652,6 +667,7 @@ _shtab_ahriman() { service-config) _arguments -C -s $_shtab_ahriman_service_config_options ;; service-config-validate) _arguments -C -s $_shtab_ahriman_service_config_validate_options ;; service-key-import) _arguments -C -s $_shtab_ahriman_service_key_import_options ;; + service-repositories) _arguments -C -s $_shtab_ahriman_service_repositories_options ;; service-setup) _arguments -C -s $_shtab_ahriman_service_setup_options ;; service-shell) _arguments -C -s $_shtab_ahriman_service_shell_options ;; service-tree-migrate) _arguments -C -s $_shtab_ahriman_service_tree_migrate_options ;; diff --git a/src/ahriman/application/ahriman.py b/src/ahriman/application/ahriman.py index bf85efa3..687dc0b2 100644 --- a/src/ahriman/application/ahriman.py +++ b/src/ahriman/application/ahriman.py @@ -69,8 +69,7 @@ def _parser() -> argparse.ArgumentParser: parser = argparse.ArgumentParser(prog="ahriman", description="ArcH linux ReposItory MANager", epilog="Argument list can also be read from file by using @ prefix.", fromfile_prefix_chars="@", formatter_class=_formatter) - parser.add_argument("-a", "--architecture", help="target architectures. For several subcommands it can be used " - "multiple times", action="append") + parser.add_argument("-a", "--architecture", help="filter by target architecture") parser.add_argument("-c", "--configuration", help="configuration path", type=Path, default=Path("/etc") / "ahriman.ini") parser.add_argument("--force", help="force run, remove file lock", action="store_true") @@ -82,8 +81,7 @@ def _parser() -> argparse.ArgumentParser: parser.add_argument("-q", "--quiet", help="force disable any logging", action="store_true") parser.add_argument("--report", help="force enable or disable reporting to web service", action=argparse.BooleanOptionalAction, default=True) - parser.add_argument("-r", "--repository", help="target repository. For several subcommands it can be used " - "multiple times", action="append") + parser.add_argument("-r", "--repository", help="filter by target repository") # special secret argument for systemd unit. The issue is that systemd doesn't allow multiple arguments to template # name. This parameter accepts [[arch]-repo] in order to keep backward compatibility parser.add_argument("--repository-id", help=argparse.SUPPRESS) @@ -130,6 +128,7 @@ def _parser() -> argparse.ArgumentParser: _set_service_config_parser(subparsers) _set_service_config_validate_parser(subparsers) _set_service_key_import_parser(subparsers) + _set_service_repositories(subparsers) _set_service_setup_parser(subparsers) _set_service_shell_parser(subparsers) _set_service_tree_migrate_parser(subparsers) @@ -161,8 +160,8 @@ def _set_aur_search_parser(root: SubParserAction) -> argparse.ArgumentParser: parser.add_argument("--sort-by", help="sort field by this field. In case if two packages have the same value of " "the specified field, they will be always sorted by name", default="name", choices=sorted(handlers.Search.SORT_FIELDS)) - parser.set_defaults(handler=handlers.Search, architecture=[""], lock=None, quiet=True, report=False, - repository=[""], unsafe=True) + parser.set_defaults(handler=handlers.Search, architecture="", lock=None, quiet=True, report=False, + repository="", unsafe=True) return parser @@ -180,7 +179,7 @@ def _set_help_parser(root: SubParserAction) -> argparse.ArgumentParser: description="show help message for application or command and exit", formatter_class=_formatter) parser.add_argument("command", help="show help message for specific command", nargs="?") - parser.set_defaults(handler=handlers.Help, architecture=[""], lock=None, quiet=True, report=False, repository=[""], + parser.set_defaults(handler=handlers.Help, architecture="", lock=None, quiet=True, report=False, repository="", unsafe=True, parser=_parser) return parser @@ -199,8 +198,8 @@ def _set_help_commands_unsafe_parser(root: SubParserAction) -> argparse.Argument description="list unsafe commands as defined in default args", formatter_class=_formatter) parser.add_argument("command", help="instead of showing commands, just test command line for unsafe subcommand " "and return 0 in case if command is safe and 1 otherwise", nargs="*") - parser.set_defaults(handler=handlers.UnsafeCommands, architecture=[""], lock=None, quiet=True, report=False, - repository=[""], unsafe=True, parser=_parser) + parser.set_defaults(handler=handlers.UnsafeCommands, architecture="", lock=None, quiet=True, report=False, + repository="", unsafe=True, parser=_parser) return parser @@ -218,8 +217,8 @@ def _set_help_updates_parser(root: SubParserAction) -> argparse.ArgumentParser: description="request AUR for current version and compare with current service version", formatter_class=_formatter) parser.add_argument("-e", "--exit-code", help="return non-zero exit code if updates available", action="store_true") - parser.set_defaults(handler=handlers.ServiceUpdates, architecture=[""], lock=None, quiet=True, report=False, - repository=[""], unsafe=True) + parser.set_defaults(handler=handlers.ServiceUpdates, architecture="", lock=None, quiet=True, report=False, + repository="", unsafe=True) return parser @@ -235,8 +234,8 @@ def _set_help_version_parser(root: SubParserAction) -> argparse.ArgumentParser: """ parser = root.add_parser("help-version", aliases=["version"], help="application version", description="print application and its dependencies versions", formatter_class=_formatter) - parser.set_defaults(handler=handlers.Versions, architecture=[""], lock=None, quiet=True, report=False, - repository=[""], unsafe=True) + parser.set_defaults(handler=handlers.Versions, architecture="", lock=None, quiet=True, report=False, + repository="", unsafe=True) return parser @@ -387,8 +386,8 @@ def _set_patch_add_parser(root: SubParserAction) -> argparse.ArgumentParser: "it must end with ()") parser.add_argument("patch", help="path to file which contains function or variable value. If not set, " "the value will be read from stdin", type=Path, nargs="?") - parser.set_defaults(handler=handlers.Patch, action=Action.Update, architecture=[""], lock=None, report=False, - repository=[""]) + parser.set_defaults(handler=handlers.Patch, action=Action.Update, architecture="", lock=None, report=False, + repository="") return parser @@ -408,8 +407,8 @@ def _set_patch_list_parser(root: SubParserAction) -> argparse.ArgumentParser: parser.add_argument("-e", "--exit-code", help="return non-zero exit status if result is empty", action="store_true") parser.add_argument("-v", "--variable", help="if set, show only patches for specified PKGBUILD variables", action="append") - parser.set_defaults(handler=handlers.Patch, action=Action.List, architecture=[""], lock=None, report=False, - repository=[""], unsafe=True) + parser.set_defaults(handler=handlers.Patch, action=Action.List, architecture="", lock=None, report=False, + repository="", unsafe=True) return parser @@ -430,8 +429,8 @@ def _set_patch_remove_parser(root: SubParserAction) -> argparse.ArgumentParser: "to remove only specified PKGBUILD variables. In case if not set, " "it will remove all patches related to the package", action="append") - parser.set_defaults(handler=handlers.Patch, action=Action.Remove, architecture=[""], lock=None, report=False, - repository=[""]) + parser.set_defaults(handler=handlers.Patch, action=Action.Remove, architecture="", lock=None, report=False, + repository="") return parser @@ -455,8 +454,8 @@ def _set_patch_set_add_parser(root: SubParserAction) -> argparse.ArgumentParser: parser.add_argument("package", help="path to directory with changed files for patch addition/update", type=Path) parser.add_argument("-t", "--track", help="files which has to be tracked", action="append", default=["*.diff", "*.patch"]) - parser.set_defaults(handler=handlers.Patch, action=Action.Update, architecture=[""], lock=None, report=False, - repository=[""], variable=None) + parser.set_defaults(handler=handlers.Patch, action=Action.Update, architecture="", lock=None, report=False, + repository="", variable=None) return parser @@ -473,7 +472,7 @@ def _set_repo_backup_parser(root: SubParserAction) -> argparse.ArgumentParser: parser = root.add_parser("repo-backup", help="backup repository data", description="backup repository settings and database", formatter_class=_formatter) parser.add_argument("path", help="path of the output archive", type=Path) - parser.set_defaults(handler=handlers.Backup, architecture=[""], lock=None, report=False, repository=[""], + parser.set_defaults(handler=handlers.Backup, architecture="", lock=None, report=False, repository="", unsafe=True) return parser @@ -653,7 +652,7 @@ def _set_repo_restore_parser(root: SubParserAction) -> argparse.ArgumentParser: description="restore settings and database", formatter_class=_formatter) parser.add_argument("path", help="path of the input archive", type=Path) parser.add_argument("-o", "--output", help="root path of the extracted files", type=Path, default=Path("/")) - parser.set_defaults(handler=handlers.Restore, architecture=[""], lock=None, report=False, repository=[""], + parser.set_defaults(handler=handlers.Restore, architecture="", lock=None, report=False, repository="", unsafe=True) return parser @@ -830,6 +829,10 @@ def _set_service_config_parser(root: SubParserAction) -> argparse.ArgumentParser parser = root.add_parser("service-config", aliases=["config", "repo-config"], help="dump configuration", description="dump configuration for the specified architecture", formatter_class=_formatter) + parser.add_argument("section", help="filter settings by section", nargs="?") + parser.add_argument("key", help="filter settings by key", nargs="?") + parser.add_argument("--info", help="show additional information, e.g. configuration files", + action=argparse.BooleanOptionalAction, default=True) parser.add_argument("--secure", help="hide passwords and secrets from output", action=argparse.BooleanOptionalAction, default=True) parser.set_defaults(handler=handlers.Dump, lock=None, quiet=True, report=False, unsafe=True) @@ -875,7 +878,27 @@ def _set_service_key_import_parser(root: SubParserAction) -> argparse.ArgumentPa formatter_class=_formatter) parser.add_argument("--key-server", help="key server for key import", default="keyserver.ubuntu.com") parser.add_argument("key", help="PGP key to import from public server") - parser.set_defaults(handler=handlers.KeyImport, architecture=[""], lock=None, report=False, repository=[""]) + parser.set_defaults(handler=handlers.KeyImport, architecture="", lock=None, report=False, repository="") + return parser + + +def _set_service_repositories(root: SubParserAction) -> argparse.ArgumentParser: + """ + add parser for repositories listing + + Args: + root(SubParserAction): subparsers for the commands + + Returns: + argparse.ArgumentParser: created argument parser + """ + parser = root.add_parser("service-repositories", help="show repositories", + description="list all available repositories", + formatter_class=_formatter) + parser.add_argument("--id-only", help="show machine readable identifier instead", + action=argparse.BooleanOptionalAction, default=False) + parser.set_defaults(handler=handlers.Repositories, architecture="", lock=None, report=False, repository="", + unsafe=True) return parser @@ -971,8 +994,8 @@ def _set_user_add_parser(root: SubParserAction) -> argparse.ArgumentParser: "which is in particular must be used for OAuth2 authorization type.") parser.add_argument("-R", "--role", help="user access level", type=UserAccess, choices=enum_values(UserAccess), default=UserAccess.Read) - parser.set_defaults(handler=handlers.Users, action=Action.Update, architecture=[""], lock=None, quiet=True, - report=False, repository=[""]) + parser.set_defaults(handler=handlers.Users, action=Action.Update, architecture="", lock=None, quiet=True, + report=False, repository="") return parser @@ -992,8 +1015,8 @@ def _set_user_list_parser(root: SubParserAction) -> argparse.ArgumentParser: parser.add_argument("username", help="filter users by username", nargs="?") parser.add_argument("-e", "--exit-code", help="return non-zero exit status if result is empty", action="store_true") parser.add_argument("-R", "--role", help="filter users by role", type=UserAccess, choices=enum_values(UserAccess)) - parser.set_defaults(handler=handlers.Users, action=Action.List, architecture=[""], lock=None, quiet=True, - report=False, repository=[""], unsafe=True) + parser.set_defaults(handler=handlers.Users, action=Action.List, architecture="", lock=None, quiet=True, + report=False, repository="", unsafe=True) return parser @@ -1011,8 +1034,8 @@ def _set_user_remove_parser(root: SubParserAction) -> argparse.ArgumentParser: description="remove user from the user mapping and update the configuration", formatter_class=_formatter) parser.add_argument("username", help="username for web service") - parser.set_defaults(handler=handlers.Users, action=Action.Remove, architecture=[""], lock=None, quiet=True, - report=False, repository=[""]) + parser.set_defaults(handler=handlers.Users, action=Action.Remove, architecture="", lock=None, quiet=True, + report=False, repository="") return parser @@ -1027,8 +1050,8 @@ def _set_web_parser(root: SubParserAction) -> argparse.ArgumentParser: argparse.ArgumentParser: created argument parser """ parser = root.add_parser("web", help="web server", description="start web server", formatter_class=_formatter) - parser.set_defaults(handler=handlers.Web, lock=Path(tempfile.gettempdir()) / "ahriman-web.lock", report=False, - parser=_parser) + parser.set_defaults(handler=handlers.Web, architecture="", lock=Path(tempfile.gettempdir()) / "ahriman-web.lock", + report=False, repository="", parser=_parser) return parser diff --git a/src/ahriman/application/application/application.py b/src/ahriman/application/application/application.py index ff5c4ef0..295707ca 100644 --- a/src/ahriman/application/application/application.py +++ b/src/ahriman/application/application/application.py @@ -146,7 +146,7 @@ class Application(ApplicationPackages, ApplicationRepository): # there is local cache, load package from it package = Package.from_build(source_dir, self.repository.architecture, username) else: - package = Package.from_aur(package_name, self.repository.pacman, username) + package = Package.from_aur(package_name, username) with_dependencies[package.base] = package # register package in local database diff --git a/src/ahriman/application/application/application_packages.py b/src/ahriman/application/application/application_packages.py index 2a6f9572..32428c2a 100644 --- a/src/ahriman/application/application/application_packages.py +++ b/src/ahriman/application/application/application_packages.py @@ -63,7 +63,7 @@ class ApplicationPackages(ApplicationProperties): source(str): package base name username(str | None): optional override of username for build process """ - package = Package.from_aur(source, self.repository.pacman, username) + package = Package.from_aur(source, username) self.database.build_queue_insert(package) self.database.remote_update(package) diff --git a/src/ahriman/application/application/application_repository.py b/src/ahriman/application/application/application_repository.py index 73e0f63c..ca10c5ba 100644 --- a/src/ahriman/application/application/application_repository.py +++ b/src/ahriman/application/application/application_repository.py @@ -104,7 +104,7 @@ class ApplicationRepository(ApplicationProperties): packages: list[str] = [] for single in probe.packages: try: - _ = Package.from_aur(single, self.repository.pacman, None) + _ = Package.from_aur(single, None) except Exception: packages.append(single) return packages diff --git a/src/ahriman/application/handlers/__init__.py b/src/ahriman/application/handlers/__init__.py index e53de728..fa3cbabd 100644 --- a/src/ahriman/application/handlers/__init__.py +++ b/src/ahriman/application/handlers/__init__.py @@ -30,6 +30,7 @@ from ahriman.application.handlers.patch import Patch from ahriman.application.handlers.rebuild import Rebuild from ahriman.application.handlers.remove import Remove from ahriman.application.handlers.remove_unknown import RemoveUnknown +from ahriman.application.handlers.repositories import Repositories from ahriman.application.handlers.restore import Restore from ahriman.application.handlers.search import Search from ahriman.application.handlers.service_updates import ServiceUpdates diff --git a/src/ahriman/application/handlers/dump.py b/src/ahriman/application/handlers/dump.py index 9b455bd7..cdad09c7 100644 --- a/src/ahriman/application/handlers/dump.py +++ b/src/ahriman/application/handlers/dump.py @@ -44,12 +44,18 @@ class Dump(Handler): configuration(Configuration): configuration instance report(bool): force enable or disable reporting """ - root, _ = configuration.check_loaded() - ConfigurationPathsPrinter(root, configuration.includes)(verbose=True, separator=" = ") + if args.info: + root, _ = configuration.check_loaded() + ConfigurationPathsPrinter(root, configuration.includes)(verbose=True, separator=" = ") - # empty line - StringPrinter("")(verbose=False) - - dump = configuration.dump() - for section, values in sorted(dump.items()): - ConfigurationPrinter(section, values)(verbose=not args.secure, separator=" = ") + match (args.section, args.key): + case None, None: # full configuration + dump = configuration.dump() + for section, values in sorted(dump.items()): + ConfigurationPrinter(section, values)(verbose=not args.secure, separator=" = ") + case section, None: # section only + values = dict(configuration.items(section)) if configuration.has_section(section) else {} + ConfigurationPrinter(section, values)(verbose=not args.secure, separator=" = ") + case section, key: # key only + value = configuration.get(section, key, fallback="") + StringPrinter(value)(verbose=False) diff --git a/src/ahriman/application/handlers/handler.py b/src/ahriman/application/handlers/handler.py index 3e5dfdb2..928587b8 100644 --- a/src/ahriman/application/handlers/handler.py +++ b/src/ahriman/application/handlers/handler.py @@ -20,6 +20,7 @@ import argparse import logging +from collections.abc import Iterable from multiprocessing import Pool from ahriman.application.lock import Lock @@ -64,7 +65,7 @@ class Handler: configuration = Configuration.from_path(args.configuration, repository_id) log_handler = LogLoader.handler(args.log_handler) - LogLoader.load(configuration, log_handler, quiet=args.quiet, report=args.report) + LogLoader.load(repository_id, configuration, log_handler, quiet=args.quiet, report=args.report) with Lock(args, repository_id, configuration): cls.run(args, repository_id, configuration, report=args.report) @@ -105,59 +106,6 @@ class Handler: return 0 if all(result) else 1 - @classmethod - def repositories_extract(cls, args: argparse.Namespace) -> list[RepositoryId]: - """ - get known architectures - - Args: - args(argparse.Namespace): command line args - - Returns: - list[RepositoryId]: list of repository names and architectures for which tree is created - - Raises: - MissingArchitectureError: if no architecture set and automatic detection is not allowed or failed - """ - configuration = Configuration() - configuration.load(args.configuration) - # pylint, wtf??? - root = configuration.getpath("repository", "root") # pylint: disable=assignment-from-no-return - - # preparse systemd repository-id argument - # we are using unescaped values, so / is not allowed here, because it is impossible to separate if from dashes - if args.repository_id is not None: - # repository parts is optional for backward compatibility - architecture, *repository_parts = args.repository_id.split("/") - args.architecture = [architecture] - if repository_parts: - args.repository = ["-".join(repository_parts)] # replace slash with dash - - # extract repository names first - names = args.repository - if names is None: # try to read file system first - names = RepositoryPaths.known_repositories(root) - if not names: # try to read configuration now - names = [configuration.get("repository", "name")] - - # extract architecture names - if (architectures := args.architecture) is not None: - repositories = set( - RepositoryId(architecture, name) - for name in names - for architecture in architectures - ) - else: # try to read from file system - repositories = set( - RepositoryId(architecture, name) - for name in names - for architecture in RepositoryPaths.known_architectures(root, name) - ) - - if not repositories: - raise MissingArchitectureError(args.command) - return sorted(repositories) - @classmethod def run(cls, args: argparse.Namespace, repository_id: RepositoryId, configuration: Configuration, *, report: bool) -> None: @@ -189,3 +137,57 @@ class Handler: """ if enabled and predicate: raise ExitCode + + @staticmethod + def repositories_extract(args: argparse.Namespace) -> list[RepositoryId]: + """ + get known architectures + + Args: + args(argparse.Namespace): command line args + + Returns: + list[RepositoryId]: list of repository names and architectures for which tree is created + + Raises: + MissingArchitectureError: if no architecture set and automatic detection is not allowed or failed + """ + configuration = Configuration() + configuration.load(args.configuration) + # pylint, wtf??? + root = configuration.getpath("repository", "root") # pylint: disable=assignment-from-no-return + + # preparse systemd repository-id argument + # we are using unescaped values, so / is not allowed here, because it is impossible to separate if from dashes + if args.repository_id is not None: + separator = "/" if "/" in args.repository_id else "-" # systemd and non-systemd identifiers + # repository parts is optional for backward compatibility + architecture, *repository_parts = args.repository_id.split(separator) + args.architecture = architecture + if repository_parts: + args.repository = "-".join(repository_parts) # replace slash with dash + + # extract repository names first + if (from_args := args.repository) is not None: + repositories: Iterable[str] = [from_args] + elif (from_filesystem := RepositoryPaths.known_repositories(root)): + repositories = from_filesystem + else: # try to read configuration now + repositories = [configuration.get("repository", "name")] + + # extract architecture names + if (architecture := args.architecture) is not None: + parsed = set( + RepositoryId(architecture, repository) + for repository in repositories + ) + else: # try to read from file system + parsed = set( + RepositoryId(architecture, repository) + for repository in repositories + for architecture in RepositoryPaths.known_architectures(root, repository) + ) + + if not parsed: + raise MissingArchitectureError(args.command) + return sorted(parsed) diff --git a/src/ahriman/application/handlers/repositories.py b/src/ahriman/application/handlers/repositories.py new file mode 100644 index 00000000..317357b9 --- /dev/null +++ b/src/ahriman/application/handlers/repositories.py @@ -0,0 +1,54 @@ +# +# Copyright (c) 2021-2023 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 . +# +import argparse + +from ahriman.application.handlers import Handler +from ahriman.core.configuration import Configuration +from ahriman.core.formatters import RepositoryPrinter +from ahriman.models.repository_id import RepositoryId + + +class Repositories(Handler): + """ + repositories listing handler + """ + + ALLOW_MULTI_ARCHITECTURE_RUN = False # system-wide action + + @classmethod + def run(cls, args: argparse.Namespace, repository_id: RepositoryId, configuration: Configuration, *, + report: bool) -> None: + """ + callback for command line + + Args: + args(argparse.Namespace): command line args + repository_id(RepositoryId): repository unique identifier + configuration(Configuration): configuration instance + report(bool): force enable or disable reporting + """ + dummy_args = argparse.Namespace( + architecture=None, + configuration=args.configuration, + repository=None, + repository_id=None, + ) + for repository in cls.repositories_extract(dummy_args): + RepositoryPrinter(repository)(verbose=not args.id_only) diff --git a/src/ahriman/application/handlers/search.py b/src/ahriman/application/handlers/search.py index e8f8baab..ffbaa523 100644 --- a/src/ahriman/application/handlers/search.py +++ b/src/ahriman/application/handlers/search.py @@ -22,7 +22,6 @@ import argparse from dataclasses import fields from collections.abc import Callable, Iterable -from ahriman.application.application import Application from ahriman.application.handlers import Handler from ahriman.core.alpm.remote import AUR, Official from ahriman.core.configuration import Configuration @@ -59,10 +58,8 @@ class Search(Handler): configuration(Configuration): configuration instance report(bool): force enable or disable reporting """ - application = Application(repository_id, configuration, report=report) - - official_packages_list = Official.multisearch(*args.search, pacman=application.repository.pacman) - aur_packages_list = AUR.multisearch(*args.search, pacman=application.repository.pacman) + official_packages_list = Official.multisearch(*args.search) + aur_packages_list = AUR.multisearch(*args.search) Search.check_if_empty(args.exit_code, not official_packages_list and not aur_packages_list) for packages_list in (official_packages_list, aur_packages_list): diff --git a/src/ahriman/application/handlers/service_updates.py b/src/ahriman/application/handlers/service_updates.py index 0c7bf7d5..fc259728 100644 --- a/src/ahriman/application/handlers/service_updates.py +++ b/src/ahriman/application/handlers/service_updates.py @@ -20,7 +20,6 @@ import argparse from ahriman import __version__ -from ahriman.application.application import Application from ahriman.application.handlers import Handler from ahriman.core.configuration import Configuration from ahriman.core.formatters import UpdatePrinter @@ -47,9 +46,7 @@ class ServiceUpdates(Handler): configuration(Configuration): configuration instance report(bool): force enable or disable reporting """ - application = Application(repository_id, configuration, report=report) - - remote = Package.from_aur("ahriman", application.repository.pacman, None) + remote = Package.from_aur("ahriman", None) _, release = remote.version.rsplit("-", 1) # we don't store pkgrel locally, so we just append it local_version = f"{__version__}-{release}" diff --git a/src/ahriman/application/handlers/setup.py b/src/ahriman/application/handlers/setup.py index ee631c47..2888d2bb 100644 --- a/src/ahriman/application/handlers/setup.py +++ b/src/ahriman/application/handlers/setup.py @@ -126,16 +126,16 @@ class Setup(Handler): configuration.set_option(section, "target", " ".join([target.name.lower() for target in sign_targets])) configuration.set_option(section, "key", args.sign_key) - section = Configuration.section_name("web", repository_id.name, repository_id.architecture) if args.web_port is not None: - configuration.set_option(section, "port", str(args.web_port)) + configuration.set_option("web", "port", str(args.web_port)) if args.web_unix_socket is not None: - configuration.set_option(section, "unix_socket", str(args.web_unix_socket)) + configuration.set_option("web", "unix_socket", str(args.web_unix_socket)) if args.generate_salt: configuration.set_option("auth", "salt", User.generate_password(20)) - target = root.include / "00-setup-overrides.ini" + (root.include / "00-setup-overrides.ini").unlink(missing_ok=True) # remove old-style configuration + target = root.include / f"00-setup-overrides-{repository_id.id}.ini" with target.open("w") as ahriman_configuration: configuration.write(ahriman_configuration) diff --git a/src/ahriman/application/handlers/status_update.py b/src/ahriman/application/handlers/status_update.py index ff1f63f4..f448515e 100644 --- a/src/ahriman/application/handlers/status_update.py +++ b/src/ahriman/application/handlers/status_update.py @@ -45,14 +45,18 @@ class StatusUpdate(Handler): configuration(Configuration): configuration instance report(bool): force enable or disable reporting """ - # we are using reporter here - client = Application(repository_id, configuration, report=True).repository.reporter + application = Application(repository_id, configuration, report=True) + client = application.repository.reporter match args.action: case Action.Update if args.package: # update packages statuses - for package in args.package: - client.package_update(package, args.status) + packages = application.repository.packages() + for base in args.package: + if (local := next((package for package in packages if package.base == base), None)) is not None: + client.package_add(local, args.status) + else: + client.package_update(base, args.status) case Action.Update: # update service status client.status_update(args.status) diff --git a/src/ahriman/application/handlers/web.py b/src/ahriman/application/handlers/web.py index 7868c392..f35f0516 100644 --- a/src/ahriman/application/handlers/web.py +++ b/src/ahriman/application/handlers/web.py @@ -32,7 +32,7 @@ class Web(Handler): web server handler """ - ALLOW_MULTI_ARCHITECTURE_RUN = False # required to be able to spawn external processes + ALLOW_MULTI_ARCHITECTURE_RUN = False # system-wide action @classmethod def run(cls, args: argparse.Namespace, repository_id: RepositoryId, configuration: Configuration, *, @@ -47,13 +47,20 @@ class Web(Handler): report(bool): force enable or disable reporting """ # we are using local import for optional dependencies - from ahriman.web.web import run_server, setup_service + from ahriman.web.web import run_server, setup_server - spawner_args = Web.extract_arguments(args, repository_id, configuration) - spawner = Spawn(args.parser(), repository_id, list(spawner_args)) + spawner_args = Web.extract_arguments(args, configuration) + spawner = Spawn(args.parser(), list(spawner_args)) spawner.start() - application = setup_service(repository_id, configuration, spawner) + dummy_args = argparse.Namespace( + architecture=None, + configuration=args.configuration, + repository=None, + repository_id=None, + ) + repositories = cls.repositories_extract(dummy_args) + application = setup_server(configuration, spawner, repositories) run_server(application) # terminate spawn process at the last @@ -61,22 +68,17 @@ class Web(Handler): spawner.join() @staticmethod - def extract_arguments(args: argparse.Namespace, repository_id: RepositoryId, - configuration: Configuration) -> Generator[str, None, None]: + def extract_arguments(args: argparse.Namespace, configuration: Configuration) -> Generator[str, None, None]: """ extract list of arguments used for current command, except for command specific ones Args: args(argparse.Namespace): command line args - repository_id(RepositoryId): repository unique identifier configuration(Configuration): configuration instance Returns: Generator[str, None, None]: command line arguments which were used for this specific command """ - # read architecture from the same argument list - yield from ["--architecture", repository_id.architecture] - yield from ["--repository", repository_id.name] # read configuration path from current settings if (configuration_path := configuration.path) is not None: yield from ["--configuration", str(configuration_path)] diff --git a/src/ahriman/application/lock.py b/src/ahriman/application/lock.py index 084ef4ef..0143d2c9 100644 --- a/src/ahriman/application/lock.py +++ b/src/ahriman/application/lock.py @@ -70,16 +70,15 @@ class Lock(LazyLogging): repository_id(RepositoryId): repository unique identifier configuration(Configuration): configuration instance """ - lock_suffix = f"{repository_id.name}_{repository_id.architecture}" self.path: Path | None = \ - args.lock.with_stem(f"{args.lock.stem}_{lock_suffix}") if args.lock is not None else None + args.lock.with_stem(f"{args.lock.stem}_{repository_id.id}") if args.lock is not None else None self.force: bool = args.force self.unsafe: bool = args.unsafe self.wait_timeout: int = args.wait_timeout self.paths = configuration.repository_paths - self.reporter = Client.load(configuration, report=args.report) + self.reporter = Client.load(repository_id, configuration, report=args.report) def check_version(self) -> None: """ diff --git a/src/ahriman/core/alpm/remote/aur.py b/src/ahriman/core/alpm/remote/aur.py index 9930a79f..fe9d2c37 100644 --- a/src/ahriman/core/alpm/remote/aur.py +++ b/src/ahriman/core/alpm/remote/aur.py @@ -113,13 +113,13 @@ class AUR(Remote): response = self.make_request("GET", self.DEFAULT_RPC_URL, params=query) return self.parse_response(response.json()) - def package_info(self, package_name: str, *, pacman: Pacman) -> AURPackage: + def package_info(self, package_name: str, *, pacman: Pacman | None) -> AURPackage: """ get package info by its name Args: package_name(str): package name to search - pacman(Pacman): alpm wrapper instance + pacman(Pacman | None): alpm wrapper instance, required for official repositories search Returns: AURPackage: package which match the package name @@ -133,13 +133,13 @@ class AUR(Remote): except StopIteration: raise UnknownPackageError(package_name) from None - def package_search(self, *keywords: str, pacman: Pacman) -> list[AURPackage]: + def package_search(self, *keywords: str, pacman: Pacman | None) -> list[AURPackage]: """ search package in AUR web Args: *keywords(str): keywords to search - pacman(Pacman): alpm wrapper instance + pacman(Pacman | None): alpm wrapper instance, required for official repositories search Returns: list[AURPackage]: list of packages which match the criteria diff --git a/src/ahriman/core/alpm/remote/official.py b/src/ahriman/core/alpm/remote/official.py index e99344af..586b091d 100644 --- a/src/ahriman/core/alpm/remote/official.py +++ b/src/ahriman/core/alpm/remote/official.py @@ -107,13 +107,13 @@ class Official(Remote): response = self.make_request("GET", self.DEFAULT_RPC_URL, params=query) return self.parse_response(response.json()) - def package_info(self, package_name: str, *, pacman: Pacman) -> AURPackage: + def package_info(self, package_name: str, *, pacman: Pacman | None) -> AURPackage: """ get package info by its name Args: package_name(str): package name to search - pacman(Pacman): alpm wrapper instance + pacman(Pacman | None): alpm wrapper instance, required for official repositories search Returns: AURPackage: package which match the package name @@ -127,13 +127,13 @@ class Official(Remote): except StopIteration: raise UnknownPackageError(package_name) from None - def package_search(self, *keywords: str, pacman: Pacman) -> list[AURPackage]: + def package_search(self, *keywords: str, pacman: Pacman | None) -> list[AURPackage]: """ search package in AUR web Args: *keywords(str): keywords to search - pacman(Pacman): alpm wrapper instance + pacman(Pacman | None): alpm wrapper instance, required for official repositories search Returns: list[AURPackage]: list of packages which match the criteria diff --git a/src/ahriman/core/alpm/remote/official_syncdb.py b/src/ahriman/core/alpm/remote/official_syncdb.py index f310042b..333ba9e4 100644 --- a/src/ahriman/core/alpm/remote/official_syncdb.py +++ b/src/ahriman/core/alpm/remote/official_syncdb.py @@ -38,13 +38,13 @@ class OfficialSyncdb(Official): Still we leave search function based on the official repositories RPC. """ - def package_info(self, package_name: str, *, pacman: Pacman) -> AURPackage: + def package_info(self, package_name: str, *, pacman: Pacman | None) -> AURPackage: """ get package info by its name Args: package_name(str): package name to search - pacman(Pacman): alpm wrapper instance + pacman(Pacman | None): alpm wrapper instance, required for official repositories search Returns: AURPackage: package which match the package name @@ -52,6 +52,9 @@ class OfficialSyncdb(Official): Raises: UnknownPackageError: package doesn't exist """ + if pacman is None: + raise UnknownPackageError(package_name) + try: return next(AURPackage.from_pacman(package) for package in pacman.package_get(package_name)) except StopIteration: diff --git a/src/ahriman/core/alpm/remote/remote.py b/src/ahriman/core/alpm/remote/remote.py index 82afdf26..acce736c 100644 --- a/src/ahriman/core/alpm/remote/remote.py +++ b/src/ahriman/core/alpm/remote/remote.py @@ -40,13 +40,14 @@ class Remote(SyncHttpClient): """ @classmethod - def info(cls, package_name: str, *, pacman: Pacman) -> AURPackage: + def info(cls, package_name: str, *, pacman: Pacman | None = None) -> AURPackage: """ get package info by its name Args: package_name(str): package name to search - pacman(Pacman): alpm wrapper instance + pacman(Pacman | None, optional): alpm wrapper instance, required for official repositories search + (Default value = None) Returns: AURPackage: package which match the package name @@ -54,14 +55,15 @@ class Remote(SyncHttpClient): return cls().package_info(package_name, pacman=pacman) @classmethod - def multisearch(cls, *keywords: str, pacman: Pacman) -> list[AURPackage]: + def multisearch(cls, *keywords: str, pacman: Pacman | None = None) -> list[AURPackage]: """ search in remote repository by using API with multiple words. This method is required in order to handle https://bugs.archlinux.org/task/49133. In addition, short words will be dropped Args: *keywords(str): search terms, e.g. "ahriman", "is", "cool" - pacman(Pacman): alpm wrapper instance + pacman(Pacman | None, optional): alpm wrapper instance, required for official repositories search + (Default value = None) Returns: list[AURPackage]: list of packages each of them matches all search terms @@ -111,26 +113,27 @@ class Remote(SyncHttpClient): raise NotImplementedError @classmethod - def search(cls, *keywords: str, pacman: Pacman) -> list[AURPackage]: + def search(cls, *keywords: str, pacman: Pacman | None = None) -> list[AURPackage]: """ search package in AUR web Args: *keywords(str): search terms, e.g. "ahriman", "is", "cool" - pacman(Pacman): alpm wrapper instance + pacman(Pacman | None, optional): alpm wrapper instance, required for official repositories search + (Default value = None) Returns: list[AURPackage]: list of packages which match the criteria """ return cls().package_search(*keywords, pacman=pacman) - def package_info(self, package_name: str, *, pacman: Pacman) -> AURPackage: + def package_info(self, package_name: str, *, pacman: Pacman | None) -> AURPackage: """ get package info by its name Args: package_name(str): package name to search - pacman(Pacman): alpm wrapper instance + pacman(Pacman | None): alpm wrapper instance, required for official repositories search Returns: AURPackage: package which match the package name @@ -140,13 +143,13 @@ class Remote(SyncHttpClient): """ raise NotImplementedError - def package_search(self, *keywords: str, pacman: Pacman) -> list[AURPackage]: + def package_search(self, *keywords: str, pacman: Pacman | None) -> list[AURPackage]: """ search package in AUR web Args: *keywords(str): keywords to search - pacman(Pacman): alpm wrapper instance + pacman(Pacman | None): alpm wrapper instance, required for official repositories search Returns: list[AURPackage]: list of packages which match the criteria diff --git a/src/ahriman/core/configuration/configuration.py b/src/ahriman/core/configuration/configuration.py index 07a52f53..a861a1b9 100644 --- a/src/ahriman/core/configuration/configuration.py +++ b/src/ahriman/core/configuration/configuration.py @@ -63,7 +63,7 @@ class Configuration(configparser.RawConfigParser): >>> path, repository_id = configuration.check_loaded() """ - ARCHITECTURE_SPECIFIC_SECTIONS = ["alpm", "build", "sign", "web"] + ARCHITECTURE_SPECIFIC_SECTIONS = ["alpm", "build", "sign"] SYSTEM_CONFIGURATION_PATH = Path(sys.prefix) / "share" / "ahriman" / "settings" / "ahriman.ini" converters: dict[str, Callable[[str], Any]] # typing guard @@ -232,7 +232,7 @@ class Configuration(configparser.RawConfigParser): dict[str, dict[str, str]]: configuration dump for specific architecture """ return { - section: dict(self[section]) + section: dict(self.items(section)) for section in self.sections() } @@ -282,20 +282,27 @@ class Configuration(configparser.RawConfigParser): if not path.is_file(): # fallback to the system file path = self.SYSTEM_CONFIGURATION_PATH self.path = path - self.read(self.path) - self.load_includes() - def load_includes(self) -> None: + self.read(self.path) + self.load_includes() # load includes + + def load_includes(self, path: Path | None = None) -> None: """ - load configuration includes + load configuration includes from specified path + + Args: + path(Path | None, optional): path to directory with include files. If none set, the default path will be + used (Default value = None) """ self.includes = [] # reset state + try: - for path in sorted(self.include.glob("*.ini")): - if path == self.logging_path: + path = path or self.include + for include in sorted(path.glob("*.ini")): + if include == self.logging_path: continue # we don't want to load logging explicitly - self.read(path) - self.includes.append(path) + self.read(include) + self.includes.append(include) except (FileNotFoundError, configparser.NoOptionError, configparser.NoSectionError): pass diff --git a/src/ahriman/core/configuration/schema.py b/src/ahriman/core/configuration/schema.py index 55934fe5..12762fb8 100644 --- a/src/ahriman/core/configuration/schema.py +++ b/src/ahriman/core/configuration/schema.py @@ -42,7 +42,6 @@ CONFIGURATION_SCHEMA: ConfigurationSchema = { "include": { "type": "path", "coerce": "absolute_path", - "required": True, "path_exists": True, "path_type": "dir", }, diff --git a/src/ahriman/core/database/operations/build_operations.py b/src/ahriman/core/database/operations/build_operations.py index bc0ae350..dd56e382 100644 --- a/src/ahriman/core/database/operations/build_operations.py +++ b/src/ahriman/core/database/operations/build_operations.py @@ -43,7 +43,7 @@ class BuildOperations(Operations): """, { "package_base": package_base, - "repository": self.repository_id.id, + "repository": self._repository_id.id, }) return self.with_connection(run, commit=True) @@ -60,7 +60,7 @@ class BuildOperations(Operations): Package.from_json(row["properties"]) for row in connection.execute( """select properties from build_queue where repository = :repository""", - {"repository": self.repository_id.id} + {"repository": self._repository_id.id} ) ] @@ -86,7 +86,7 @@ class BuildOperations(Operations): { "package_base": package.base, "properties": package.view(), - "repository": self.repository_id.id, + "repository": self._repository_id.id, }) return self.with_connection(run, commit=True) diff --git a/src/ahriman/core/database/operations/logs_operations.py b/src/ahriman/core/database/operations/logs_operations.py index f4718b69..23ef5b19 100644 --- a/src/ahriman/core/database/operations/logs_operations.py +++ b/src/ahriman/core/database/operations/logs_operations.py @@ -21,6 +21,7 @@ from sqlite3 import Connection from ahriman.core.database.operations import Operations from ahriman.models.log_record_id import LogRecordId +from ahriman.models.repository_id import RepositoryId class LogsOperations(Operations): @@ -28,7 +29,8 @@ class LogsOperations(Operations): logs operations """ - def logs_get(self, package_base: str, limit: int = -1, offset: int = 0) -> list[tuple[float, str]]: + def logs_get(self, package_base: str, limit: int = -1, offset: int = 0, + repository_id: RepositoryId | None = None) -> list[tuple[float, str]]: """ extract logs for specified package base @@ -36,10 +38,13 @@ class LogsOperations(Operations): package_base(str): package base to extract logs 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) Return: list[tuple[float, str]]: sorted package log records and their timestamps """ + repository_id = repository_id or self._repository_id + def run(connection: Connection) -> list[tuple[float, str]]: return [ (row["created"], row["record"]) @@ -51,7 +56,7 @@ class LogsOperations(Operations): """, { "package_base": package_base, - "repository": self.repository_id.id, + "repository": repository_id.id, "limit": limit, "offset": offset, }) @@ -59,7 +64,8 @@ class LogsOperations(Operations): return self.with_connection(run) - def logs_insert(self, log_record_id: LogRecordId, created: float, record: str) -> None: + def logs_insert(self, log_record_id: LogRecordId, created: float, record: str, + repository_id: RepositoryId | None = None) -> None: """ write new log record to database @@ -67,7 +73,10 @@ class LogsOperations(Operations): log_record_id(LogRecordId): current log record id created(float): log created timestamp from log record attribute record(str): log record + 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( """ @@ -81,21 +90,23 @@ class LogsOperations(Operations): "version": log_record_id.version, "created": created, "record": record, - "repository": self.repository_id.id, + "repository": repository_id.id, } ) return self.with_connection(run, commit=True) - def logs_remove(self, package_base: str, version: str | None) -> None: + def logs_remove(self, package_base: str, version: str | None, repository_id: RepositoryId | None = None) -> None: """ remove log records for the specified package Args: package_base(str): package base to remove logs - version(str): package version. If set it will remove only logs belonging to another - version + version(str | None): package version. If set it will remove only logs belonging to another version + 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( """ @@ -107,7 +118,7 @@ class LogsOperations(Operations): { "package_base": package_base, "version": version, - "repository": self.repository_id.id, + "repository": repository_id.id, } ) diff --git a/src/ahriman/core/database/operations/operations.py b/src/ahriman/core/database/operations/operations.py index 4fbe4805..c70807cc 100644 --- a/src/ahriman/core/database/operations/operations.py +++ b/src/ahriman/core/database/operations/operations.py @@ -36,7 +36,6 @@ class Operations(LazyLogging): Attributes: path(Path): path to the database file - repository_id(RepositoryId): repository unique identifier to perform implicit filtering """ def __init__(self, path: Path, repository_id: RepositoryId) -> None: @@ -48,7 +47,7 @@ class Operations(LazyLogging): repository_id(RepositoryId): repository unique identifier """ self.path = path - self.repository_id = repository_id + self._repository_id = repository_id @staticmethod def factory(cursor: sqlite3.Cursor, row: tuple[Any, ...]) -> dict[str, Any]: diff --git a/src/ahriman/core/database/operations/package_operations.py b/src/ahriman/core/database/operations/package_operations.py index 7d7795d3..dc684aa1 100644 --- a/src/ahriman/core/database/operations/package_operations.py +++ b/src/ahriman/core/database/operations/package_operations.py @@ -25,6 +25,7 @@ from ahriman.models.build_status import BuildStatus from ahriman.models.package import Package from ahriman.models.package_description import PackageDescription from ahriman.models.remote_source import RemoteSource +from ahriman.models.repository_id import RepositoryId class PackageOperations(Operations): @@ -32,23 +33,25 @@ class PackageOperations(Operations): package operations """ - def _package_remove_package_base(self, connection: Connection, package_base: str) -> None: + def _package_remove_package_base(self, connection: Connection, package_base: str, + repository_id: RepositoryId) -> None: """ remove package base information Args: connection(Connection): database connection package_base(str): package base name + repository_id(RepositoryId): repository unique identifier """ connection.execute( """delete from package_statuses where package_base = :package_base and repository = :repository""", - {"package_base": package_base, "repository": self.repository_id.id}) + {"package_base": package_base, "repository": repository_id.id}) connection.execute( """delete from package_bases where package_base = :package_base and repository = :repository""", - {"package_base": package_base, "repository": self.repository_id.id}) + {"package_base": package_base, "repository": repository_id.id}) def _package_remove_packages(self, connection: Connection, package_base: str, - current_packages: Iterable[str]) -> None: + current_packages: Iterable[str], repository_id: RepositoryId) -> None: """ remove packages belong to the package base @@ -56,6 +59,7 @@ class PackageOperations(Operations): connection(Connection): database connection package_base(str): package base name current_packages(Iterable[str]): current packages list which has to be left in database + repository_id(RepositoryId): repository unique identifier """ packages = [ package @@ -63,20 +67,22 @@ class PackageOperations(Operations): """ select package, repository from packages where package_base = :package_base and repository = :repository""", - {"package_base": package_base, "repository": self.repository_id.id}) + {"package_base": package_base, "repository": repository_id.id}) if package["package"] not in current_packages ] connection.executemany( """delete from packages where package = :package and repository = :repository""", packages) - def _package_update_insert_base(self, connection: Connection, package: Package) -> None: + def _package_update_insert_base(self, connection: Connection, package: Package, + repository_id: RepositoryId) -> None: """ insert base package into table Args: connection(Connection): database connection package(Package): package properties + repository_id(RepositoryId): repository unique identifier """ connection.execute( """ @@ -97,17 +103,19 @@ class PackageOperations(Operations): "web_url": package.remote.web_url, "source": package.remote.source.value, "packager": package.packager, - "repository": self.repository_id.id, + "repository": repository_id.id, } ) - def _package_update_insert_packages(self, connection: Connection, package: Package) -> None: + def _package_update_insert_packages(self, connection: Connection, package: Package, + repository_id: RepositoryId) -> None: """ insert packages into table Args: connection(Connection): database connection package(Package): package properties + repository_id(RepositoryId): repository unique identifier """ package_list = [] for name, description in package.packages.items(): @@ -116,7 +124,7 @@ class PackageOperations(Operations): package_list.append({ "package": name, "package_base": package.base, - "repository": self.repository_id.id, + "repository": repository_id.id, **description.view(), }) connection.executemany( @@ -141,7 +149,8 @@ class PackageOperations(Operations): """, package_list) - def _package_update_insert_status(self, connection: Connection, package_base: str, status: BuildStatus) -> None: + def _package_update_insert_status(self, connection: Connection, package_base: str, status: BuildStatus, + repository_id: RepositoryId) -> None: """ insert base package status into table @@ -149,6 +158,7 @@ class PackageOperations(Operations): connection(Connection): database connection package_base(str): package base name status(BuildStatus): new build status + repository_id(RepositoryId): repository unique identifier """ connection.execute( """ @@ -163,15 +173,17 @@ class PackageOperations(Operations): "package_base": package_base, "status": status.status.value, "last_updated": status.timestamp, - "repository": self.repository_id.id, + "repository": repository_id.id, }) - def _packages_get_select_package_bases(self, connection: Connection) -> dict[str, Package]: + def _packages_get_select_package_bases(self, connection: Connection, + repository_id: RepositoryId) -> dict[str, Package]: """ select package bases from the table Args: connection(Connection): database connection + repository_id(RepositoryId): repository unique identifier Returns: dict[str, Package]: map of the package base to its descriptor (without packages themselves) @@ -185,36 +197,40 @@ class PackageOperations(Operations): packager=row["packager"] or None, ) for row in connection.execute( """select * from package_bases where repository = :repository""", - {"repository": self.repository_id.id} + {"repository": repository_id.id} ) } - def _packages_get_select_packages(self, connection: Connection, packages: dict[str, Package]) -> dict[str, Package]: + def _packages_get_select_packages(self, connection: Connection, packages: dict[str, Package], + repository_id: RepositoryId) -> dict[str, Package]: """ select packages from the table Args: connection(Connection): database connection packages(dict[str, Package]): packages descriptor map + repository_id(RepositoryId): repository unique identifier Returns: dict[str, Package]: map of the package base to its descriptor including individual packages """ for row in connection.execute( """select * from packages where repository = :repository""", - {"repository": self.repository_id.id} + {"repository": repository_id.id} ): if row["package_base"] not in packages: continue # normally must never happen though packages[row["package_base"]].packages[row["package"]] = PackageDescription.from_json(row) return packages - def _packages_get_select_statuses(self, connection: Connection) -> dict[str, BuildStatus]: + def _packages_get_select_statuses(self, connection: Connection, + repository_id: RepositoryId) -> dict[str, BuildStatus]: """ select package build statuses from the table Args: connection(Connection): database connection + repository_id(RepositoryId): repository unique identifier Returns: dict[str, BuildStatus]: map of the package base to its status @@ -223,50 +239,62 @@ class PackageOperations(Operations): row["package_base"]: BuildStatus.from_json({"status": row["status"], "timestamp": row["last_updated"]}) for row in connection.execute( """select * from package_statuses where repository = :repository""", - {"repository": self.repository_id.id} + {"repository": repository_id.id} ) } - def package_remove(self, package_base: str) -> None: + def package_remove(self, package_base: str, repository_id: RepositoryId | None = None) -> None: """ remove package from database Args: package_base(str): package base name + repository_id(RepositoryId, optional): repository unique identifier override (Default value = None) """ + repository_id = repository_id or self._repository_id + def run(connection: Connection) -> None: - self._package_remove_packages(connection, package_base, []) - self._package_remove_package_base(connection, package_base) + self._package_remove_packages(connection, package_base, [], repository_id) + self._package_remove_package_base(connection, package_base, repository_id) return self.with_connection(run, commit=True) - def package_update(self, package: Package, status: BuildStatus) -> None: + def package_update(self, package: Package, status: BuildStatus, repository_id: RepositoryId | None = None) -> None: """ update package status Args: package(Package): package properties status(BuildStatus): new build status + repository_id(RepositoryId, optional): repository unique identifier override (Default value = None) """ + repository_id = repository_id or self._repository_id + def run(connection: Connection) -> None: - self._package_update_insert_base(connection, package) - self._package_update_insert_status(connection, package.base, status) - self._package_update_insert_packages(connection, package) - self._package_remove_packages(connection, package.base, package.packages.keys()) + self._package_update_insert_base(connection, package, repository_id) + self._package_update_insert_status(connection, package.base, status, repository_id) + self._package_update_insert_packages(connection, package, repository_id) + self._package_remove_packages(connection, package.base, package.packages.keys(), repository_id) return self.with_connection(run, commit=True) - def packages_get(self) -> list[tuple[Package, BuildStatus]]: + def packages_get(self, repository_id: RepositoryId | None = None) -> list[tuple[Package, BuildStatus]]: """ get package list and their build statuses from database + Args: + repository_id(RepositoryId, optional): repository unique identifier override (Default value = None) + Return: list[tuple[Package, BuildStatus]]: list of package properties and their statuses """ + repository_id = repository_id or self._repository_id + def run(connection: Connection) -> Generator[tuple[Package, BuildStatus], None, None]: - packages = self._packages_get_select_package_bases(connection) - statuses = self._packages_get_select_statuses(connection) - for package_base, package in self._packages_get_select_packages(connection, packages).items(): + packages = self._packages_get_select_package_bases(connection, repository_id) + statuses = self._packages_get_select_statuses(connection, repository_id) + per_package_base = self._packages_get_select_packages(connection, packages, repository_id) + for package_base, package in per_package_base.items(): yield package, statuses.get(package_base, BuildStatus()) return self.with_connection(lambda connection: list(run(connection))) @@ -279,7 +307,7 @@ class PackageOperations(Operations): package(Package): package properties """ return self.with_connection( - lambda connection: self._package_update_insert_base(connection, package), + lambda connection: self._package_update_insert_base(connection, package, self._repository_id), commit=True) def remotes_get(self) -> dict[str, RemoteSource]: @@ -289,8 +317,10 @@ class PackageOperations(Operations): Returns: dict[str, RemoteSource]: map of package base to its remote sources """ - packages = self.with_connection(self._packages_get_select_package_bases) + def run(connection: Connection) -> dict[str, Package]: + return self._packages_get_select_package_bases(connection, self._repository_id) + return { package_base: package.remote - for package_base, package in packages.items() + for package_base, package in self.with_connection(run).items() } diff --git a/src/ahriman/core/formatters/__init__.py b/src/ahriman/core/formatters/__init__.py index 28939201..9b2cd067 100644 --- a/src/ahriman/core/formatters/__init__.py +++ b/src/ahriman/core/formatters/__init__.py @@ -26,6 +26,7 @@ from ahriman.core.formatters.configuration_paths_printer import ConfigurationPat from ahriman.core.formatters.configuration_printer import ConfigurationPrinter from ahriman.core.formatters.package_printer import PackagePrinter from ahriman.core.formatters.patch_printer import PatchPrinter +from ahriman.core.formatters.repository_printer import RepositoryPrinter from ahriman.core.formatters.status_printer import StatusPrinter from ahriman.core.formatters.tree_printer import TreePrinter from ahriman.core.formatters.update_printer import UpdatePrinter diff --git a/src/ahriman/core/formatters/repository_printer.py b/src/ahriman/core/formatters/repository_printer.py new file mode 100644 index 00000000..4719174d --- /dev/null +++ b/src/ahriman/core/formatters/repository_printer.py @@ -0,0 +1,53 @@ +# +# Copyright (c) 2021-2023 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 . +# +from ahriman.core.formatters import StringPrinter +from ahriman.models.property import Property +from ahriman.models.repository_id import RepositoryId + + +class RepositoryPrinter(StringPrinter): + """ + print repository unique identifier + + Attributes: + repository_id(RepositoryId): repository unique identifier + """ + + def __init__(self, repository_id: RepositoryId) -> None: + """ + default constructor + + Args: + repository_id(RepositoryId): repository unique identifier + """ + StringPrinter.__init__(self, repository_id.id) + self.repository_id = repository_id + + def properties(self) -> list[Property]: + """ + convert content into printable data + + Returns: + list[Property]: list of content properties + """ + return [ + Property("Name", self.repository_id.name), + Property("Architecture", self.repository_id.architecture), + ] diff --git a/src/ahriman/core/log/http_log_handler.py b/src/ahriman/core/log/http_log_handler.py index 6bab9d30..332f0459 100644 --- a/src/ahriman/core/log/http_log_handler.py +++ b/src/ahriman/core/log/http_log_handler.py @@ -22,6 +22,7 @@ import logging from typing import Self from ahriman.core.configuration import Configuration +from ahriman.models.repository_id import RepositoryId class HttpLogHandler(logging.Handler): @@ -34,11 +35,13 @@ class HttpLogHandler(logging.Handler): suppress_errors(bool): suppress logging errors (e.g. if no web server available) """ - def __init__(self, configuration: Configuration, *, report: bool, suppress_errors: bool) -> None: + def __init__(self, repository_id: RepositoryId, configuration: Configuration, *, + report: bool, suppress_errors: bool) -> None: """ default constructor Args: + repository_id(RepositoryId): repository unique identifier configuration(Configuration): configuration instance report(bool): force enable or disable reporting suppress_errors(bool): suppress logging errors (e.g. if no web server available) @@ -48,16 +51,17 @@ class HttpLogHandler(logging.Handler): # client has to be imported here because of circular imports from ahriman.core.status.client import Client - self.reporter = Client.load(configuration, report=report) + self.reporter = Client.load(repository_id, configuration, report=report) self.suppress_errors = suppress_errors @classmethod - def load(cls, configuration: Configuration, *, report: bool) -> Self: + def load(cls, repository_id: RepositoryId, configuration: Configuration, *, report: bool) -> Self: """ install logger. This function creates handler instance and adds it to the handler list in case if no other http handler found Args: + repository_id(RepositoryId): repository unique identifier configuration(Configuration): configuration instance report(bool): force enable or disable reporting @@ -69,7 +73,7 @@ class HttpLogHandler(logging.Handler): return handler # there is already registered instance suppress_errors = configuration.getboolean("settings", "suppress_http_log_errors", fallback=False) - handler = cls(configuration, report=report, suppress_errors=suppress_errors) + handler = cls(repository_id, configuration, report=report, suppress_errors=suppress_errors) root.addHandler(handler) return handler diff --git a/src/ahriman/core/log/log_loader.py b/src/ahriman/core/log/log_loader.py index 4e2424eb..928fbc40 100644 --- a/src/ahriman/core/log/log_loader.py +++ b/src/ahriman/core/log/log_loader.py @@ -25,6 +25,7 @@ from pathlib import Path from ahriman.core.configuration import Configuration from ahriman.core.log.http_log_handler import HttpLogHandler from ahriman.models.log_handler import LogHandler +from ahriman.models.repository_id import RepositoryId class LogLoader: @@ -68,11 +69,13 @@ class LogLoader: return LogHandler.Console @staticmethod - def load(configuration: Configuration, handler: LogHandler, *, quiet: bool, report: bool) -> None: + def load(repository_id: RepositoryId, configuration: Configuration, handler: LogHandler, *, + quiet: bool, report: bool) -> None: """ setup logging settings from configuration Args: + repository_id(RepositoryId): repository unique identifier configuration(Configuration): configuration instance handler(LogHandler): selected default log handler, which will be used if no handlers were set quiet(bool): force disable any log messages @@ -97,7 +100,7 @@ class LogLoader: logging.basicConfig(filename=None, format=LogLoader.DEFAULT_LOG_FORMAT, level=LogLoader.DEFAULT_LOG_LEVEL) logging.exception("could not load logging from configuration, fallback to stderr") - HttpLogHandler.load(configuration, report=report) + HttpLogHandler.load(repository_id, configuration, report=report) if quiet: logging.disable(logging.WARNING) # only print errors here diff --git a/src/ahriman/core/report/remote_call.py b/src/ahriman/core/report/remote_call.py index 55062686..40c9f577 100644 --- a/src/ahriman/core/report/remote_call.py +++ b/src/ahriman/core/report/remote_call.py @@ -51,7 +51,7 @@ class RemoteCall(Report): """ Report.__init__(self, repository_id, configuration) - self.client = WebClient(configuration) + self.client = WebClient(repository_id, configuration) self.update_aur = configuration.getboolean(section, "aur", fallback=False) self.update_local = configuration.getboolean(section, "local", fallback=False) @@ -100,11 +100,13 @@ class RemoteCall(Report): Returns: str: remote process id """ - response = self.client.make_request("POST", "/api/v1/service/update", json={ - "aur": self.update_aur, - "local": self.update_local, - "manual": self.update_manual, - }) + response = self.client.make_request("POST", "/api/v1/service/update", + params=self.repository_id.query(), + json={ + "aur": self.update_aur, + "local": self.update_local, + "manual": self.update_manual, + }) response_json = response.json() process_id: str = response_json["process_id"] diff --git a/src/ahriman/core/repository/repository_properties.py b/src/ahriman/core/repository/repository_properties.py index 26a78315..bbdc2e5d 100644 --- a/src/ahriman/core/repository/repository_properties.py +++ b/src/ahriman/core/repository/repository_properties.py @@ -75,7 +75,7 @@ class RepositoryProperties(LazyLogging): self.pacman = Pacman(repository_id, configuration, refresh_database=refresh_pacman_database) self.sign = GPG(configuration) self.repo = Repo(self.name, self.paths, self.sign.repository_sign_args) - self.reporter = Client.load(configuration, report=report) + self.reporter = Client.load(repository_id, configuration, report=report) self.triggers = TriggerLoader.load(repository_id, configuration) @property diff --git a/src/ahriman/core/repository/update_handler.py b/src/ahriman/core/repository/update_handler.py index 32f1ee01..c0c44a04 100644 --- a/src/ahriman/core/repository/update_handler.py +++ b/src/ahriman/core/repository/update_handler.py @@ -61,7 +61,7 @@ class UpdateHandler(Cleaner): try: if package.remote.source == PackageSource.Repository: return Package.from_official(probe, self.pacman, None) - return Package.from_aur(probe, self.pacman, None) + return Package.from_aur(probe, None) except UnknownPackageError: continue raise UnknownPackageError(package.base) diff --git a/src/ahriman/core/spawn.py b/src/ahriman/core/spawn.py index d50801b8..c126f490 100644 --- a/src/ahriman/core/spawn.py +++ b/src/ahriman/core/spawn.py @@ -28,6 +28,7 @@ from multiprocessing import Process, Queue from threading import Lock, Thread from ahriman.core.log import LazyLogging +from ahriman.models.process_status import ProcessStatus from ahriman.models.repository_id import RepositoryId @@ -39,22 +40,18 @@ class Spawn(Thread, LazyLogging): Attributes: active(dict[str, Process]): map of active child processes required to avoid zombies command_arguments(list[str]): base command line arguments - queue(Queue[tuple[str, bool, int]]): multiprocessing queue to read updates from processes - repository_id(RepositoryId): repository unique identifier + queue(Queue[ProcessStatus | None]): multiprocessing queue to read updates from processes """ - def __init__(self, args_parser: argparse.ArgumentParser, repository_id: RepositoryId, - command_arguments: list[str]) -> None: + def __init__(self, args_parser: argparse.ArgumentParser, command_arguments: list[str]) -> None: """ default constructor Args: args_parser(argparse.ArgumentParser): command line parser for the application - repository_id(RepositoryId): repository unique identifier command_arguments(list[str]): base command line arguments """ Thread.__init__(self, name="spawn") - self.repository_id = repository_id self.args_parser = args_parser self.command_arguments = command_arguments @@ -62,7 +59,7 @@ class Spawn(Thread, LazyLogging): self.lock = Lock() self.active: dict[str, Process] = {} # stupid pylint does not know that it is possible - self.queue: Queue[tuple[str, bool, int] | None] = Queue() # pylint: disable=unsubscriptable-object + self.queue: Queue[ProcessStatus | None] = Queue() # pylint: disable=unsubscriptable-object @staticmethod def boolean_action_argument(name: str, value: bool) -> str: @@ -80,16 +77,16 @@ class Spawn(Thread, LazyLogging): @staticmethod def process(callback: Callable[[argparse.Namespace, RepositoryId], bool], args: argparse.Namespace, - repository_id: RepositoryId, process_id: str, queue: Queue[tuple[str, bool, int]]) -> None: # pylint: disable=unsubscriptable-object + repository_id: RepositoryId, process_id: str, queue: Queue[ProcessStatus | None]) -> None: # pylint: disable=unsubscriptable-object """ helper to run external process Args: - callback(Callable[[argparse.Namespace, str], bool]): application run function (i.e. Handler.run method) + callback(Callable[[argparse.Namespace, str], bool]): application run function (i.e. ``Handler.call`` method) args(argparse.Namespace): command line arguments repository_id(RepositoryId): repository unique identifier process_id(str): process unique identifier - queue(Queue[tuple[str, bool, int]]): output queue + queue(Queue[ProcessStatus | None]): output queue """ start_time = time.monotonic() result = callback(args, repository_id) @@ -97,19 +94,20 @@ class Spawn(Thread, LazyLogging): consumed_time = int(1000 * (stop_time - start_time)) - queue.put((process_id, result, consumed_time)) + queue.put(ProcessStatus(process_id, result, consumed_time)) - def _spawn_process(self, command: str, *args: str, **kwargs: str | None) -> str: + def _spawn_process(self, repository_id: RepositoryId, command: str, *args: str, **kwargs: str | None) -> str: """ spawn external ahriman process with supplied arguments Args: + repository_id(RepositoryId): repository unique identifier command(str): subcommand to run *args(str): positional command arguments **kwargs(str): named command arguments Returns: - str: spawned process id + str: spawned process identifier """ # default arguments arguments = self.command_arguments[:] @@ -125,12 +123,14 @@ class Spawn(Thread, LazyLogging): arguments.append(value) process_id = str(uuid.uuid4()) - self.logger.info("full command line arguments of %s are %s", process_id, arguments) + self.logger.info("full command line arguments of %s are %s using repository %s", + process_id, arguments, repository_id) + parsed = self.args_parser.parse_args(arguments) callback = parsed.handler.call process = Process(target=self.process, - args=(callback, parsed, self.repository_id, process_id, self.queue), + args=(callback, parsed, repository_id, process_id, self.queue), daemon=True) process.start() @@ -160,66 +160,73 @@ class Spawn(Thread, LazyLogging): server(str | None): PGP key server Returns: - str: spawned process id + str: spawned process identifier """ kwargs = {} if server is None else {"key-server": server} - return self._spawn_process("service-key-import", key, **kwargs) + repository_id = RepositoryId("", "") + return self._spawn_process(repository_id, "service-key-import", key, **kwargs) - def packages_add(self, packages: Iterable[str], username: str | None, *, now: bool) -> str: + def packages_add(self, repository_id: RepositoryId, packages: Iterable[str], username: str | None, *, + now: bool) -> str: """ add packages Args: + repository_id(RepositoryId): repository unique identifier packages(Iterable[str]): packages list to add username(str | None): optional override of username for build process now(bool): build packages now Returns: - str: spawned process id + str: spawned process identifier """ kwargs = {"username": username} if now: kwargs["now"] = "" - return self._spawn_process("package-add", *packages, **kwargs) + return self._spawn_process(repository_id, "package-add", *packages, **kwargs) - def packages_rebuild(self, depends_on: str, username: str | None) -> str: + def packages_rebuild(self, repository_id: RepositoryId, depends_on: str, username: str | None) -> str: """ rebuild packages which depend on the specified package Args: + repository_id(RepositoryId): repository unique identifier depends_on(str): packages dependency username(str | None): optional override of username for build process Returns: - str: spawned process id + str: spawned process identifier """ kwargs = {"depends-on": depends_on, "username": username} - return self._spawn_process("repo-rebuild", **kwargs) + return self._spawn_process(repository_id, "repo-rebuild", **kwargs) - def packages_remove(self, packages: Iterable[str]) -> str: + def packages_remove(self, repository_id: RepositoryId, packages: Iterable[str]) -> str: """ remove packages Args: + repository_id(RepositoryId): repository unique identifier packages(Iterable[str]): packages list to remove Returns: - str: spawned process id + str: spawned process identifier """ - return self._spawn_process("package-remove", *packages) + return self._spawn_process(repository_id, "package-remove", *packages) - def packages_update(self, username: str | None, *, aur: bool, local: bool, manual: bool) -> str: + def packages_update(self, repository_id: RepositoryId, username: str | None, *, + aur: bool, local: bool, manual: bool) -> str: """ run full repository update Args: + repository_id(RepositoryId): repository unique identifier username(str | None): optional override of username for build process aur(bool): check for aur updates local(bool): check for local packages updates manual(bool): check for manual packages Returns: - str: spawned process id + str: spawned process identifier """ kwargs = { "username": username, @@ -227,18 +234,18 @@ class Spawn(Thread, LazyLogging): self.boolean_action_argument("local", local): "", self.boolean_action_argument("manual", manual): "", } - return self._spawn_process("repo-update", **kwargs) + return self._spawn_process(repository_id, "repo-update", **kwargs) def run(self) -> None: """ thread run method """ - for process_id, status, consumed_time in iter(self.queue.get, None): - self.logger.info("process %s has been terminated with status %s, consumed time %s", - process_id, status, consumed_time / 1000) + for terminated in iter(self.queue.get, None): + self.logger.info("process %s has been terminated with status %s, consumed time %ss", + terminated.process_id, terminated.status, terminated.consumed_time / 1000) with self.lock: - process = self.active.pop(process_id, None) + process = self.active.pop(terminated.process_id, None) if process is not None: process.join() diff --git a/src/ahriman/core/status/client.py b/src/ahriman/core/status/client.py index 6fea81be..681fcc29 100644 --- a/src/ahriman/core/status/client.py +++ b/src/ahriman/core/status/client.py @@ -26,6 +26,7 @@ from ahriman.models.build_status import BuildStatus, BuildStatusEnum from ahriman.models.internal_status import InternalStatus from ahriman.models.log_record_id import LogRecordId from ahriman.models.package import Package +from ahriman.models.repository_id import RepositoryId class Client: @@ -34,11 +35,12 @@ class Client: """ @staticmethod - def load(configuration: Configuration, *, report: bool) -> Client: + def load(repository_id: RepositoryId, configuration: Configuration, *, report: bool) -> Client: """ load client from settings Args: + repository_id(RepositoryId): repository unqiue identifier configuration(Configuration): configuration instance report(bool): force enable or disable reporting @@ -58,7 +60,7 @@ class Client: # but it will totally break used experience if address or (host and port) or socket: from ahriman.core.status.web_client import WebClient - return WebClient(configuration) + return WebClient(repository_id, configuration) return Client() def package_add(self, package: Package, status: BuildStatusEnum) -> None: diff --git a/src/ahriman/core/status/watcher.py b/src/ahriman/core/status/watcher.py index 05b35419..0c06fa5b 100644 --- a/src/ahriman/core/status/watcher.py +++ b/src/ahriman/core/status/watcher.py @@ -17,11 +17,9 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . # -from ahriman.core.configuration import Configuration from ahriman.core.database import SQLite from ahriman.core.exceptions import UnknownPackageError from ahriman.core.log import LazyLogging -from ahriman.core.repository import Repository from ahriman.models.build_status import BuildStatus, BuildStatusEnum from ahriman.models.log_record_id import LogRecordId from ahriman.models.package import Package @@ -36,23 +34,20 @@ class Watcher(LazyLogging): database(SQLite): database instance known(dict[str, tuple[Package, BuildStatus]]): list of known packages. For the most cases ``packages`` should be used instead - repository(Repository): repository object repository_id(RepositoryId): repository unique identifier status(BuildStatus): daemon status """ - def __init__(self, repository_id: RepositoryId, configuration: Configuration, database: SQLite) -> None: + def __init__(self, repository_id: RepositoryId, database: SQLite) -> None: """ default constructor Args: repository_id(RepositoryId): repository unique identifier - configuration(Configuration): configuration instance database(SQLite): database instance """ self.repository_id = repository_id self.database = database - self.repository = Repository.load(repository_id, configuration, database, report=False) self.known: dict[str, tuple[Package, BuildStatus]] = {} self.status = BuildStatus() @@ -72,20 +67,12 @@ class Watcher(LazyLogging): def load(self) -> None: """ - load packages from local repository. In case if last status is known, it will use it + load packages from local database """ - for package in self.repository.packages(): - # get status of build or assign unknown - if (current := self.known.get(package.base)) is not None: - _, status = current - else: - status = BuildStatus() + self.known = {} # reset state + for package, status in self.database.packages_get(self.repository_id): self.known[package.base] = (package, status) - for package, status in self.database.packages_get(): - if package.base in self.known: - self.known[package.base] = (package, status) - def logs_get(self, package_base: str, limit: int = -1, offset: int = 0) -> list[tuple[float, str]]: """ extract logs for the package base @@ -98,7 +85,7 @@ class Watcher(LazyLogging): Returns: list[tuple[float, str]]: package logs """ - return self.database.logs_get(package_base, limit, offset) + return self.database.logs_get(package_base, limit, offset, self.repository_id) def logs_remove(self, package_base: str, version: str | None) -> None: """ @@ -108,7 +95,7 @@ class Watcher(LazyLogging): package_base(str): package base version(str): package versio """ - self.database.logs_remove(package_base, version) + self.database.logs_remove(package_base, version, self.repository_id) def logs_update(self, log_record_id: LogRecordId, created: float, record: str) -> None: """ @@ -123,7 +110,7 @@ class Watcher(LazyLogging): # there is new log record, so we remove old ones self.logs_remove(log_record_id.package_base, log_record_id.version) self._last_log_record_id = log_record_id - self.database.logs_insert(log_record_id, created, record) + self.database.logs_insert(log_record_id, created, record, self.repository_id) def package_get(self, package_base: str) -> tuple[Package, BuildStatus]: """ @@ -151,7 +138,7 @@ class Watcher(LazyLogging): package_base(str): package base """ self.known.pop(package_base, None) - self.database.package_remove(package_base) + self.database.package_remove(package_base, self.repository_id) self.logs_remove(package_base, None) def package_update(self, package_base: str, status: BuildStatusEnum, package: Package | None) -> None: @@ -173,7 +160,7 @@ class Watcher(LazyLogging): raise UnknownPackageError(package_base) from None full_status = BuildStatus(status) self.known[package_base] = (package, full_status) - self.database.package_update(package, full_status) + self.database.package_update(package, full_status, self.repository_id) def status_update(self, status: BuildStatusEnum) -> None: """ diff --git a/src/ahriman/core/status/web_client.py b/src/ahriman/core/status/web_client.py index b256226c..0c0affe3 100644 --- a/src/ahriman/core/status/web_client.py +++ b/src/ahriman/core/status/web_client.py @@ -32,6 +32,7 @@ from ahriman.models.build_status import BuildStatus, BuildStatusEnum from ahriman.models.internal_status import InternalStatus from ahriman.models.log_record_id import LogRecordId from ahriman.models.package import Package +from ahriman.models.repository_id import RepositoryId class WebClient(Client, SyncHttpClient): @@ -40,19 +41,22 @@ class WebClient(Client, SyncHttpClient): Attributes: address(str): address of the web service + repository_id(RepositoryId): repository unique identifier use_unix_socket(bool): use websocket or not """ - def __init__(self, configuration: Configuration) -> None: + def __init__(self, repository_id: RepositoryId, configuration: Configuration) -> None: """ default constructor Args: + repository_id(RepositoryId): repository unique identifier configuration(Configuration): configuration instance """ suppress_errors = configuration.getboolean("settings", "suppress_http_log_errors", fallback=False) SyncHttpClient.__init__(self, configuration, "web", suppress_errors=suppress_errors) + self.repository_id = repository_id self.address, self.use_unix_socket = self.parse_address(configuration) @cached_property @@ -184,7 +188,8 @@ class WebClient(Client, SyncHttpClient): "package": package.view() } with contextlib.suppress(Exception): - self.make_request("POST", self._package_url(package.base), json=payload) + self.make_request("POST", self._package_url(package.base), + params=self.repository_id.query(), json=payload) def package_get(self, package_base: str | None) -> list[tuple[Package, BuildStatus]]: """ @@ -197,7 +202,8 @@ class WebClient(Client, SyncHttpClient): list[tuple[Package, BuildStatus]]: list of current package description and status if it has been found """ with contextlib.suppress(Exception): - response = self.make_request("GET", self._package_url(package_base or "")) + response = self.make_request("GET", self._package_url(package_base or ""), + params=self.repository_id.query()) response_json = response.json() return [ @@ -224,7 +230,8 @@ class WebClient(Client, SyncHttpClient): # this is special case, because we would like to do not suppress exception here # in case of exception raised it will be handled by upstream HttpLogHandler # In the other hand, we force to suppress all http logs here to avoid cyclic reporting - self.make_request("POST", self._logs_url(log_record_id.package_base), json=payload, suppress_errors=True) + self.make_request("POST", self._logs_url(log_record_id.package_base), + params=self.repository_id.query(), json=payload, suppress_errors=True) def package_remove(self, package_base: str) -> None: """ @@ -234,7 +241,7 @@ class WebClient(Client, SyncHttpClient): package_base(str): basename to remove """ with contextlib.suppress(Exception): - self.make_request("DELETE", self._package_url(package_base)) + self.make_request("DELETE", self._package_url(package_base), params=self.repository_id.query()) def package_update(self, package_base: str, status: BuildStatusEnum) -> None: """ @@ -246,7 +253,8 @@ class WebClient(Client, SyncHttpClient): """ payload = {"status": status.value} with contextlib.suppress(Exception): - self.make_request("POST", self._package_url(package_base), json=payload) + self.make_request("POST", self._package_url(package_base), + params=self.repository_id.query(), json=payload) def status_get(self) -> InternalStatus: """ @@ -256,7 +264,7 @@ class WebClient(Client, SyncHttpClient): InternalStatus: current internal (web) service status """ with contextlib.suppress(Exception): - response = self.make_request("GET", self._status_url()) + response = self.make_request("GET", self._status_url(), params=self.repository_id.query()) response_json = response.json() return InternalStatus.from_json(response_json) @@ -272,4 +280,4 @@ class WebClient(Client, SyncHttpClient): """ payload = {"status": status.value} with contextlib.suppress(Exception): - self.make_request("POST", self._status_url(), json=payload) + self.make_request("POST", self._status_url(), params=self.repository_id.query(), json=payload) diff --git a/src/ahriman/core/upload/remote_service.py b/src/ahriman/core/upload/remote_service.py index 507e7383..3476c105 100644 --- a/src/ahriman/core/upload/remote_service.py +++ b/src/ahriman/core/upload/remote_service.py @@ -51,7 +51,7 @@ class RemoteService(Upload, HttpUpload): """ Upload.__init__(self, repository_id, configuration) HttpUpload.__init__(self, configuration, section) - self.client = WebClient(configuration) + self.client = WebClient(repository_id, configuration) @cached_property def session(self) -> requests.Session: @@ -81,7 +81,8 @@ class RemoteService(Upload, HttpUpload): if signature_path is not None: files["signature"] = signature_path.name, signature_path.open("rb"), "application/octet-stream", {} - self.make_request("POST", f"{self.client.address}/api/v1/service/upload", files=files) + self.make_request("POST", f"{self.client.address}/api/v1/service/upload", + params=self.repository_id.query(), files=files) finally: for _, fd, _, _ in files.values(): fd.close() diff --git a/src/ahriman/models/package.py b/src/ahriman/models/package.py index 3b42c0c3..5f306ba2 100644 --- a/src/ahriman/models/package.py +++ b/src/ahriman/models/package.py @@ -214,19 +214,18 @@ class Package(LazyLogging): ) @classmethod - def from_aur(cls, name: str, pacman: Pacman, packager: str | None = None) -> Self: + def from_aur(cls, name: str, packager: str | None = None) -> Self: """ construct package properties from AUR page Args: name(str): package name (either base or normal name) - pacman(Pacman): alpm wrapper instance packager(str | None, optional): packager to be used for this build (Default value = None) Returns: Self: package properties """ - package = AUR.info(name, pacman=pacman) + package = AUR.info(name) remote = RemoteSource( source=PackageSource.AUR, @@ -331,7 +330,7 @@ class Package(LazyLogging): Returns: Self: package properties """ - package = OfficialSyncdb.info(name, pacman=pacman) if use_syncdb else Official.info(name, pacman=pacman) + package = OfficialSyncdb.info(name, pacman=pacman) if use_syncdb else Official.info(name) remote = RemoteSource( source=PackageSource.Repository, diff --git a/src/ahriman/models/process_status.py b/src/ahriman/models/process_status.py new file mode 100644 index 00000000..2a84864a --- /dev/null +++ b/src/ahriman/models/process_status.py @@ -0,0 +1,36 @@ +# +# Copyright (c) 2021-2023 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 . +# +from dataclasses import dataclass + + +@dataclass(frozen=True) +class ProcessStatus: + """ + terminated process status descriptor + + Attributes: + process_id(str): unique process identifier + status(bool): process exit code status + consumed_time(int): consumed time in ms + """ + + process_id: str + status: bool + consumed_time: int diff --git a/src/ahriman/models/repository_id.py b/src/ahriman/models/repository_id.py index 58dc272b..ac410828 100644 --- a/src/ahriman/models/repository_id.py +++ b/src/ahriman/models/repository_id.py @@ -54,6 +54,27 @@ class RepositoryId: """ return f"{self.architecture}-{self.name}" # basically the same as used for command line + def query(self) -> list[tuple[str, str]]: + """ + generate query parameters + + Returns: + list[tuple[str, str]]: json view as query parameters + """ + return list(self.view().items()) + + def view(self) -> dict[str, Any]: + """ + generate json package view + + Returns: + dict[str, Any]: json-friendly dictionary + """ + return { + "architecture": self.architecture, + "repository": self.name, + } + def __lt__(self, other: Any) -> bool: """ comparison operator for sorting diff --git a/src/ahriman/web/schemas/__init__.py b/src/ahriman/web/schemas/__init__.py index f6e582a8..3effcca8 100644 --- a/src/ahriman/web/schemas/__init__.py +++ b/src/ahriman/web/schemas/__init__.py @@ -38,6 +38,7 @@ from ahriman.web.schemas.pgp_key_schema import PGPKeySchema from ahriman.web.schemas.process_id_schema import ProcessIdSchema from ahriman.web.schemas.process_schema import ProcessSchema from ahriman.web.schemas.remote_schema import RemoteSchema +from ahriman.web.schemas.repository_id_schema import RepositoryIdSchema from ahriman.web.schemas.search_schema import SearchSchema from ahriman.web.schemas.status_schema import StatusSchema from ahriman.web.schemas.update_flags_schema import UpdateFlagsSchema diff --git a/src/ahriman/web/schemas/internal_status_schema.py b/src/ahriman/web/schemas/internal_status_schema.py index 0515a3e5..1bf2be33 100644 --- a/src/ahriman/web/schemas/internal_status_schema.py +++ b/src/ahriman/web/schemas/internal_status_schema.py @@ -17,29 +17,22 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . # -from marshmallow import Schema, fields +from marshmallow import fields from ahriman import __version__ from ahriman.web.schemas.counters_schema import CountersSchema +from ahriman.web.schemas.repository_id_schema import RepositoryIdSchema from ahriman.web.schemas.status_schema import StatusSchema -class InternalStatusSchema(Schema): +class InternalStatusSchema(RepositoryIdSchema): """ response service status schema """ - architecture = fields.String(required=True, metadata={ - "description": "Repository architecture", - "example": "x86_64", - }) packages = fields.Nested(CountersSchema(), required=True, metadata={ "description": "Repository package counters", }) - repository = fields.String(required=True, metadata={ - "description": "Repository name", - "example": "repo-clone", - }) status = fields.Nested(StatusSchema(), required=True, metadata={ "description": "Repository status as stored by web service", }) diff --git a/src/ahriman/web/schemas/log_schema.py b/src/ahriman/web/schemas/log_schema.py index a74dff3d..30aa8dc9 100644 --- a/src/ahriman/web/schemas/log_schema.py +++ b/src/ahriman/web/schemas/log_schema.py @@ -17,12 +17,13 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . # -from marshmallow import Schema, fields +from marshmallow import fields from ahriman import __version__ +from ahriman.web.schemas.repository_id_schema import RepositoryIdSchema -class LogSchema(Schema): +class LogSchema(RepositoryIdSchema): """ request package log schema """ diff --git a/src/ahriman/web/schemas/package_status_schema.py b/src/ahriman/web/schemas/package_status_schema.py index 33a44263..b76b4688 100644 --- a/src/ahriman/web/schemas/package_status_schema.py +++ b/src/ahriman/web/schemas/package_status_schema.py @@ -21,6 +21,7 @@ from marshmallow import Schema, fields from ahriman.models.build_status import BuildStatusEnum from ahriman.web.schemas.package_schema import PackageSchema +from ahriman.web.schemas.repository_id_schema import RepositoryIdSchema from ahriman.web.schemas.status_schema import StatusSchema @@ -35,6 +36,9 @@ class PackageStatusSimplifiedSchema(Schema): status = fields.Enum(BuildStatusEnum, by_value=True, required=True, metadata={ "description": "Current status", }) + repository = fields.Nested(RepositoryIdSchema(), required=True, metadata={ + "description": "Repository identifier", + }) class PackageStatusSchema(Schema): @@ -48,3 +52,6 @@ class PackageStatusSchema(Schema): status = fields.Nested(StatusSchema(), required=True, metadata={ "description": "Last package status", }) + repository = fields.Nested(RepositoryIdSchema(), required=True, metadata={ + "description": "Repository identifier", + }) diff --git a/src/ahriman/web/schemas/pagination_schema.py b/src/ahriman/web/schemas/pagination_schema.py index a3ee142b..bccf5604 100644 --- a/src/ahriman/web/schemas/pagination_schema.py +++ b/src/ahriman/web/schemas/pagination_schema.py @@ -17,10 +17,12 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . # -from marshmallow import Schema, fields +from marshmallow import fields + +from ahriman.web.schemas.repository_id_schema import RepositoryIdSchema -class PaginationSchema(Schema): +class PaginationSchema(RepositoryIdSchema): """ request pagination schema """ diff --git a/src/ahriman/web/schemas/repository_id_schema.py b/src/ahriman/web/schemas/repository_id_schema.py new file mode 100644 index 00000000..22dfaeba --- /dev/null +++ b/src/ahriman/web/schemas/repository_id_schema.py @@ -0,0 +1,35 @@ +# +# Copyright (c) 2021-2023 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 . +# +from marshmallow import Schema, fields + + +class RepositoryIdSchema(Schema): + """ + request and response repository unique identifier schema + """ + + architecture = fields.String(metadata={ + "description": "Repository architecture", + "example": "x86_64", + }) + repository = fields.String(metadata={ + "description": "Repository name", + "example": "aur-clone", + }) diff --git a/src/ahriman/web/views/base.py b/src/ahriman/web/views/base.py index dd15724a..75d3239b 100644 --- a/src/ahriman/web/views/base.py +++ b/src/ahriman/web/views/base.py @@ -18,14 +18,16 @@ # along with this program. If not, see . # from aiohttp_cors import CorsViewMixin # type: ignore[import-untyped] -from aiohttp.web import HTTPBadRequest, Request, StreamResponse, View +from aiohttp.web import HTTPBadRequest, HTTPNotFound, Request, StreamResponse, View from collections.abc import Awaitable, Callable from typing import Any, TypeVar from ahriman.core.auth import Auth from ahriman.core.configuration import Configuration +from ahriman.core.sign.gpg import GPG from ahriman.core.spawn import Spawn from ahriman.core.status.watcher import Watcher +from ahriman.models.repository_id import RepositoryId from ahriman.models.user_access import UserAccess @@ -56,15 +58,25 @@ class BaseView(View, CorsViewMixin): return configuration @property - def service(self) -> Watcher: + def services(self) -> dict[RepositoryId, Watcher]: """ - get status watcher instance + get all loaded watchers Returns: - Watcher: build status watcher instance + dict[RepositoryId, Watcher]: map of loaded watchers per known repository """ - watcher: Watcher = self.request.app["watcher"] - return watcher + watchers: dict[RepositoryId, Watcher] = self.request.app["watcher"] + return watchers + + @property + def sign(self) -> GPG: + """ + get GPG control instance + + Returns: + GPG: GPG wrapper instance + """ + return GPG(self.configuration) @property def spawner(self) -> Spawn: @@ -197,8 +209,8 @@ class BaseView(View, CorsViewMixin): HTTPBadRequest: if supplied parameters are invalid """ try: - limit = int(self.request.query.getone("limit", default=-1)) - offset = int(self.request.query.getone("offset", default=0)) + limit = int(self.request.query.get("limit", default=-1)) + offset = int(self.request.query.get("offset", default=0)) except Exception as ex: raise HTTPBadRequest(reason=str(ex)) @@ -210,6 +222,40 @@ class BaseView(View, CorsViewMixin): return limit, offset + def repository_id(self) -> RepositoryId: + """ + extract repository from request + + Returns: + RepositoryIde: repository if possible to construct and first one otherwise + """ + architecture = self.request.query.get("architecture") + name = self.request.query.get("repository") + + if architecture and name: + return RepositoryId(architecture, name) + return next(iter(sorted(self.services.keys()))) + + def service(self, repository_id: RepositoryId | None = None) -> Watcher: + """ + get status watcher instance + + Args: + repository_id(RepositoryId | None, optional): repository unique identifier (Default value = None) + + Returns: + Watcher: build status watcher instance. If no repository provided, it will return the first one + + Raises: + HTTPNotFound: if no repository found + """ + if repository_id is None: + repository_id = self.repository_id() + try: + return self.services[repository_id] + except KeyError: + raise HTTPNotFound(reason=f"Repository {repository_id.id} is unknown") + async def username(self) -> str | None: """ extract username from request if any diff --git a/src/ahriman/web/views/index.py b/src/ahriman/web/views/index.py index 63d5adb4..256b77f1 100644 --- a/src/ahriman/web/views/index.py +++ b/src/ahriman/web/views/index.py @@ -37,7 +37,10 @@ class IndexView(BaseView): * enabled - whether authorization is enabled by configuration or not, boolean, required * username - authenticated username if any, string, null means not authenticated * index_url - url to the repository index, string, optional - * repository - repository name, string, required + * repositories - list of repositories unique identifiers, required + * id - unique repository identifier, string, required + * repository - repository name, string, required + * architecture - repository architecture, string, required Attributes: GET_PERMISSION(UserAccess): (class attribute) get permissions of self @@ -64,5 +67,11 @@ class IndexView(BaseView): return { "auth": auth, "index_url": self.configuration.get("web", "index_url", fallback=None), - "repository": self.service.repository.name, + "repositories": [ + { + "id": repository.id, + **repository.view(), + } + for repository in sorted(self.services) + ] } diff --git a/src/ahriman/web/views/v1/service/add.py b/src/ahriman/web/views/v1/service/add.py index 6477befe..776c7d72 100644 --- a/src/ahriman/web/views/v1/service/add.py +++ b/src/ahriman/web/views/v1/service/add.py @@ -22,7 +22,7 @@ import aiohttp_apispec # type: ignore[import-untyped] from aiohttp.web import HTTPBadRequest, Response, json_response from ahriman.models.user_access import UserAccess -from ahriman.web.schemas import AuthSchema, ErrorSchema, PackageNamesSchema, ProcessIdSchema +from ahriman.web.schemas import AuthSchema, ErrorSchema, PackageNamesSchema, ProcessIdSchema, RepositoryIdSchema from ahriman.web.views.base import BaseView @@ -46,11 +46,13 @@ class AddView(BaseView): 400: {"description": "Bad data is supplied", "schema": ErrorSchema}, 401: {"description": "Authorization required", "schema": ErrorSchema}, 403: {"description": "Access is forbidden", "schema": ErrorSchema}, + 404: {"description": "Repository is unknown", "schema": ErrorSchema}, 500: {"description": "Internal server error", "schema": ErrorSchema}, }, security=[{"token": [POST_PERMISSION]}], ) @aiohttp_apispec.cookies_schema(AuthSchema) + @aiohttp_apispec.querystring_schema(RepositoryIdSchema) @aiohttp_apispec.json_schema(PackageNamesSchema) async def post(self) -> Response: """ @@ -68,7 +70,8 @@ class AddView(BaseView): except Exception as ex: raise HTTPBadRequest(reason=str(ex)) + repository_id = self.repository_id() username = await self.username() - process_id = self.spawner.packages_add(packages, username, now=True) + process_id = self.spawner.packages_add(repository_id, packages, username, now=True) return json_response({"process_id": process_id}) diff --git a/src/ahriman/web/views/v1/service/pgp.py b/src/ahriman/web/views/v1/service/pgp.py index 77db9870..8ab94c31 100644 --- a/src/ahriman/web/views/v1/service/pgp.py +++ b/src/ahriman/web/views/v1/service/pgp.py @@ -48,7 +48,7 @@ class PGPView(BaseView): 400: {"description": "Bad data is supplied", "schema": ErrorSchema}, 401: {"description": "Authorization required", "schema": ErrorSchema}, 403: {"description": "Access is forbidden", "schema": ErrorSchema}, - 404: {"description": "Package base is unknown", "schema": ErrorSchema}, + 404: {"description": "PGP key is unknown", "schema": ErrorSchema}, 500: {"description": "Internal server error", "schema": ErrorSchema}, }, security=[{"token": [GET_PERMISSION]}], @@ -67,15 +67,15 @@ class PGPView(BaseView): HTTPNotFound: if key wasn't found or service was unable to fetch it """ try: - key = self.get_non_empty(self.request.query.getone, "key") - server = self.get_non_empty(self.request.query.getone, "server") + key = self.get_non_empty(self.request.query.get, "key") + server = self.get_non_empty(self.request.query.get, "server") except Exception as ex: raise HTTPBadRequest(reason=str(ex)) try: - key = self.service.repository.sign.key_download(server, key) + key = self.sign.key_download(server, key) except Exception: - raise HTTPNotFound + raise HTTPNotFound(reason=f"Key {key} is unknown") return json_response({"key": key}) diff --git a/src/ahriman/web/views/v1/service/process.py b/src/ahriman/web/views/v1/service/process.py index 0ed53d81..c364f886 100644 --- a/src/ahriman/web/views/v1/service/process.py +++ b/src/ahriman/web/views/v1/service/process.py @@ -45,7 +45,7 @@ class ProcessView(BaseView): 200: {"description": "Success response", "schema": ProcessSchema}, 401: {"description": "Authorization required", "schema": ErrorSchema}, 403: {"description": "Access is forbidden", "schema": ErrorSchema}, - 404: {"description": "Not found", "schema": ErrorSchema}, + 404: {"description": "Process is unknown", "schema": ErrorSchema}, 500: {"description": "Internal server error", "schema": ErrorSchema}, }, security=[{"token": [GET_PERMISSION]}], diff --git a/src/ahriman/web/views/v1/service/rebuild.py b/src/ahriman/web/views/v1/service/rebuild.py index d9878ecb..cd41a974 100644 --- a/src/ahriman/web/views/v1/service/rebuild.py +++ b/src/ahriman/web/views/v1/service/rebuild.py @@ -22,7 +22,7 @@ import aiohttp_apispec # type: ignore[import-untyped] from aiohttp.web import HTTPBadRequest, Response, json_response from ahriman.models.user_access import UserAccess -from ahriman.web.schemas import AuthSchema, ErrorSchema, PackageNamesSchema, ProcessIdSchema +from ahriman.web.schemas import AuthSchema, ErrorSchema, PackageNamesSchema, ProcessIdSchema, RepositoryIdSchema from ahriman.web.views.base import BaseView @@ -46,11 +46,13 @@ class RebuildView(BaseView): 400: {"description": "Bad data is supplied", "schema": ErrorSchema}, 401: {"description": "Authorization required", "schema": ErrorSchema}, 403: {"description": "Access is forbidden", "schema": ErrorSchema}, + 404: {"description": "Repository is unknown", "schema": ErrorSchema}, 500: {"description": "Internal server error", "schema": ErrorSchema}, }, security=[{"token": [POST_PERMISSION]}], ) @aiohttp_apispec.cookies_schema(AuthSchema) + @aiohttp_apispec.querystring_schema(RepositoryIdSchema) @aiohttp_apispec.json_schema(PackageNamesSchema) async def post(self) -> Response: """ @@ -69,7 +71,8 @@ class RebuildView(BaseView): except Exception as ex: raise HTTPBadRequest(reason=str(ex)) + repository_id = self.repository_id() username = await self.username() - process_id = self.spawner.packages_rebuild(depends_on, username) + process_id = self.spawner.packages_rebuild(repository_id, depends_on, username) return json_response({"process_id": process_id}) diff --git a/src/ahriman/web/views/v1/service/remove.py b/src/ahriman/web/views/v1/service/remove.py index 953f89c8..ccbee7ac 100644 --- a/src/ahriman/web/views/v1/service/remove.py +++ b/src/ahriman/web/views/v1/service/remove.py @@ -22,7 +22,7 @@ import aiohttp_apispec # type: ignore[import-untyped] from aiohttp.web import HTTPBadRequest, Response, json_response from ahriman.models.user_access import UserAccess -from ahriman.web.schemas import AuthSchema, ErrorSchema, PackageNamesSchema, ProcessIdSchema +from ahriman.web.schemas import AuthSchema, ErrorSchema, PackageNamesSchema, ProcessIdSchema, RepositoryIdSchema from ahriman.web.views.base import BaseView @@ -46,11 +46,13 @@ class RemoveView(BaseView): 400: {"description": "Bad data is supplied", "schema": ErrorSchema}, 401: {"description": "Authorization required", "schema": ErrorSchema}, 403: {"description": "Access is forbidden", "schema": ErrorSchema}, + 404: {"description": "Repository is unknown", "schema": ErrorSchema}, 500: {"description": "Internal server error", "schema": ErrorSchema}, }, security=[{"token": [POST_PERMISSION]}], ) @aiohttp_apispec.cookies_schema(AuthSchema) + @aiohttp_apispec.querystring_schema(RepositoryIdSchema) @aiohttp_apispec.json_schema(PackageNamesSchema) async def post(self) -> Response: """ @@ -68,6 +70,7 @@ class RemoveView(BaseView): except Exception as ex: raise HTTPBadRequest(reason=str(ex)) - process_id = self.spawner.packages_remove(packages) + repository_id = self.repository_id() + process_id = self.spawner.packages_remove(repository_id, packages) return json_response({"process_id": process_id}) diff --git a/src/ahriman/web/views/v1/service/request.py b/src/ahriman/web/views/v1/service/request.py index 385e1c56..aa7eebf3 100644 --- a/src/ahriman/web/views/v1/service/request.py +++ b/src/ahriman/web/views/v1/service/request.py @@ -22,7 +22,7 @@ import aiohttp_apispec # type: ignore[import-untyped] from aiohttp.web import HTTPBadRequest, Response, json_response from ahriman.models.user_access import UserAccess -from ahriman.web.schemas import AuthSchema, ErrorSchema, PackageNamesSchema, ProcessIdSchema +from ahriman.web.schemas import AuthSchema, ErrorSchema, PackageNamesSchema, ProcessIdSchema, RepositoryIdSchema from ahriman.web.views.base import BaseView @@ -46,11 +46,13 @@ class RequestView(BaseView): 400: {"description": "Bad data is supplied", "schema": ErrorSchema}, 401: {"description": "Authorization required", "schema": ErrorSchema}, 403: {"description": "Access is forbidden", "schema": ErrorSchema}, + 404: {"description": "Repository is unknown", "schema": ErrorSchema}, 500: {"description": "Internal server error", "schema": ErrorSchema}, }, security=[{"token": [POST_PERMISSION]}], ) @aiohttp_apispec.cookies_schema(AuthSchema) + @aiohttp_apispec.querystring_schema(RepositoryIdSchema) @aiohttp_apispec.json_schema(PackageNamesSchema) async def post(self) -> Response: """ @@ -69,6 +71,7 @@ class RequestView(BaseView): raise HTTPBadRequest(reason=str(ex)) username = await self.username() - process_id = self.spawner.packages_add(packages, username, now=False) + repository_id = self.repository_id() + process_id = self.spawner.packages_add(repository_id, packages, username, now=False) return json_response({"process_id": process_id}) diff --git a/src/ahriman/web/views/v1/service/search.py b/src/ahriman/web/views/v1/service/search.py index ffa00c7f..ee08f42e 100644 --- a/src/ahriman/web/views/v1/service/search.py +++ b/src/ahriman/web/views/v1/service/search.py @@ -69,7 +69,7 @@ class SearchView(BaseView): """ try: search: list[str] = self.get_non_empty(lambda key: self.request.query.getall(key, default=[]), "for") - packages = AUR.multisearch(*search, pacman=self.service.repository.pacman) + packages = AUR.multisearch(*search) except Exception as ex: raise HTTPBadRequest(reason=str(ex)) diff --git a/src/ahriman/web/views/v1/service/update.py b/src/ahriman/web/views/v1/service/update.py index 5e661833..b7187eb8 100644 --- a/src/ahriman/web/views/v1/service/update.py +++ b/src/ahriman/web/views/v1/service/update.py @@ -22,7 +22,7 @@ import aiohttp_apispec # type: ignore[import-untyped] from aiohttp.web import HTTPBadRequest, Response, json_response from ahriman.models.user_access import UserAccess -from ahriman.web.schemas import AuthSchema, ErrorSchema, ProcessIdSchema, UpdateFlagsSchema +from ahriman.web.schemas import AuthSchema, ErrorSchema, ProcessIdSchema, UpdateFlagsSchema, RepositoryIdSchema from ahriman.web.views.base import BaseView @@ -46,11 +46,13 @@ class UpdateView(BaseView): 400: {"description": "Bad data is supplied", "schema": ErrorSchema}, 401: {"description": "Authorization required", "schema": ErrorSchema}, 403: {"description": "Access is forbidden", "schema": ErrorSchema}, + 404: {"description": "Repository is unknown", "schema": ErrorSchema}, 500: {"description": "Internal server error", "schema": ErrorSchema}, }, security=[{"token": [POST_PERMISSION]}], ) @aiohttp_apispec.cookies_schema(AuthSchema) + @aiohttp_apispec.querystring_schema(RepositoryIdSchema) @aiohttp_apispec.json_schema(UpdateFlagsSchema) async def post(self) -> Response: """ @@ -67,8 +69,10 @@ class UpdateView(BaseView): except Exception as ex: raise HTTPBadRequest(reason=str(ex)) + repository_id = self.repository_id() username = await self.username() process_id = self.spawner.packages_update( + repository_id, username, aur=data.get("aur", True), local=data.get("local", True), diff --git a/src/ahriman/web/views/v1/service/upload.py b/src/ahriman/web/views/v1/service/upload.py index 9744b74b..001957a6 100644 --- a/src/ahriman/web/views/v1/service/upload.py +++ b/src/ahriman/web/views/v1/service/upload.py @@ -25,8 +25,9 @@ from aiohttp.web import HTTPBadRequest, HTTPCreated, HTTPNotFound from pathlib import Path from tempfile import NamedTemporaryFile +from ahriman.models.repository_paths import RepositoryPaths from ahriman.models.user_access import UserAccess -from ahriman.web.schemas import AuthSchema, ErrorSchema, FileSchema +from ahriman.web.schemas import AuthSchema, ErrorSchema, FileSchema, RepositoryIdSchema from ahriman.web.views.base import BaseView @@ -100,12 +101,13 @@ class UploadView(BaseView): 400: {"description": "Bad data is supplied", "schema": ErrorSchema}, 401: {"description": "Authorization required", "schema": ErrorSchema}, 403: {"description": "Access is forbidden", "schema": ErrorSchema}, - 404: {"description": "Not found", "schema": ErrorSchema}, + 404: {"description": "Repository is unknown or endpoint is disabled", "schema": ErrorSchema}, 500: {"description": "Internal server error", "schema": ErrorSchema}, }, security=[{"token": [POST_PERMISSION]}], ) @aiohttp_apispec.cookies_schema(AuthSchema) + @aiohttp_apispec.querystring_schema(RepositoryIdSchema) @aiohttp_apispec.form_schema(FileSchema) async def post(self) -> None: """ @@ -125,7 +127,10 @@ class UploadView(BaseView): raise HTTPBadRequest(reason=str(ex)) max_body_size = self.configuration.getint("web", "max_body_size", fallback=None) - target = self.configuration.repository_paths.packages + + paths_root = self.configuration.repository_paths.root + repository_id = self.repository_id() + target = RepositoryPaths(paths_root, repository_id).packages files = [] while (part := await reader.next()) is not None: diff --git a/src/ahriman/web/views/v1/status/logs.py b/src/ahriman/web/views/v1/status/logs.py index 9b092945..0f6ce43c 100644 --- a/src/ahriman/web/views/v1/status/logs.py +++ b/src/ahriman/web/views/v1/status/logs.py @@ -25,7 +25,7 @@ from ahriman.core.exceptions import UnknownPackageError from ahriman.core.util import pretty_datetime from ahriman.models.log_record_id import LogRecordId from ahriman.models.user_access import UserAccess -from ahriman.web.schemas import AuthSchema, ErrorSchema, LogSchema, LogsSchema, PackageNameSchema +from ahriman.web.schemas import AuthSchema, ErrorSchema, LogSchema, LogsSchema, PackageNameSchema, RepositoryIdSchema from ahriman.web.views.base import BaseView @@ -51,12 +51,14 @@ class LogsView(BaseView): 204: {"description": "Success response"}, 401: {"description": "Authorization required", "schema": ErrorSchema}, 403: {"description": "Access is forbidden", "schema": ErrorSchema}, + 404: {"description": "Repository is unknown", "schema": ErrorSchema}, 500: {"description": "Internal server error", "schema": ErrorSchema}, }, security=[{"token": [DELETE_PERMISSION]}], ) @aiohttp_apispec.cookies_schema(AuthSchema) @aiohttp_apispec.match_info_schema(PackageNameSchema) + @aiohttp_apispec.querystring_schema(RepositoryIdSchema) async def delete(self) -> None: """ delete package logs @@ -65,7 +67,7 @@ class LogsView(BaseView): HTTPNoContent: on success response """ package_base = self.request.match_info["package"] - self.service.logs_remove(package_base, None) + self.service().logs_remove(package_base, None) raise HTTPNoContent @@ -77,13 +79,14 @@ class LogsView(BaseView): 200: {"description": "Success response", "schema": LogsSchema}, 401: {"description": "Authorization required", "schema": ErrorSchema}, 403: {"description": "Access is forbidden", "schema": ErrorSchema}, - 404: {"description": "Package base is unknown", "schema": ErrorSchema}, + 404: {"description": "Package base and/or repository are unknown", "schema": ErrorSchema}, 500: {"description": "Internal server error", "schema": ErrorSchema}, }, security=[{"token": [GET_PERMISSION]}], ) @aiohttp_apispec.cookies_schema(AuthSchema) @aiohttp_apispec.match_info_schema(PackageNameSchema) + @aiohttp_apispec.querystring_schema(RepositoryIdSchema) async def get(self) -> Response: """ get last package logs @@ -97,10 +100,10 @@ class LogsView(BaseView): package_base = self.request.match_info["package"] try: - _, status = self.service.package_get(package_base) + _, status = self.service().package_get(package_base) except UnknownPackageError: - raise HTTPNotFound - logs = self.service.logs_get(package_base) + raise HTTPNotFound(reason=f"Package {package_base} is unknown") + logs = self.service().logs_get(package_base) response = { "package_base": package_base, @@ -118,6 +121,7 @@ class LogsView(BaseView): 400: {"description": "Bad data is supplied", "schema": ErrorSchema}, 401: {"description": "Authorization required", "schema": ErrorSchema}, 403: {"description": "Access is forbidden", "schema": ErrorSchema}, + 404: {"description": "Repository is unknown", "schema": ErrorSchema}, 500: {"description": "Internal server error", "schema": ErrorSchema}, }, security=[{"token": [POST_PERMISSION]}], @@ -143,6 +147,6 @@ class LogsView(BaseView): except Exception as ex: raise HTTPBadRequest(reason=str(ex)) - self.service.logs_update(LogRecordId(package_base, version), created, record) + self.service().logs_update(LogRecordId(package_base, version), created, record) raise HTTPNoContent diff --git a/src/ahriman/web/views/v1/status/package.py b/src/ahriman/web/views/v1/status/package.py index 37d2471d..b7084331 100644 --- a/src/ahriman/web/views/v1/status/package.py +++ b/src/ahriman/web/views/v1/status/package.py @@ -25,7 +25,8 @@ from ahriman.core.exceptions import UnknownPackageError from ahriman.models.build_status import BuildStatusEnum from ahriman.models.package import Package from ahriman.models.user_access import UserAccess -from ahriman.web.schemas import AuthSchema, ErrorSchema, PackageNameSchema, PackageStatusSchema, PackageStatusSimplifiedSchema +from ahriman.web.schemas import AuthSchema, ErrorSchema, PackageNameSchema, PackageStatusSchema, \ + PackageStatusSimplifiedSchema, RepositoryIdSchema from ahriman.web.views.base import BaseView @@ -51,12 +52,14 @@ class PackageView(BaseView): 204: {"description": "Success response"}, 401: {"description": "Authorization required", "schema": ErrorSchema}, 403: {"description": "Access is forbidden", "schema": ErrorSchema}, + 404: {"description": "Repository is unknown", "schema": ErrorSchema}, 500: {"description": "Internal server error", "schema": ErrorSchema}, }, security=[{"token": [DELETE_PERMISSION]}], ) @aiohttp_apispec.cookies_schema(AuthSchema) @aiohttp_apispec.match_info_schema(PackageNameSchema) + @aiohttp_apispec.querystring_schema(RepositoryIdSchema) async def delete(self) -> None: """ delete package base from status page @@ -65,7 +68,7 @@ class PackageView(BaseView): HTTPNoContent: on success response """ package_base = self.request.match_info["package"] - self.service.package_remove(package_base) + self.service().package_remove(package_base) raise HTTPNoContent @@ -77,13 +80,14 @@ class PackageView(BaseView): 200: {"description": "Success response", "schema": PackageStatusSchema(many=True)}, 401: {"description": "Authorization required", "schema": ErrorSchema}, 403: {"description": "Access is forbidden", "schema": ErrorSchema}, - 404: {"description": "Package base is unknown", "schema": ErrorSchema}, + 404: {"description": "Package base and/or repository are unknown", "schema": ErrorSchema}, 500: {"description": "Internal server error", "schema": ErrorSchema}, }, security=[{"token": [GET_PERMISSION]}], ) @aiohttp_apispec.cookies_schema(AuthSchema) @aiohttp_apispec.match_info_schema(PackageNameSchema) + @aiohttp_apispec.querystring_schema(RepositoryIdSchema) async def get(self) -> Response: """ get current package base status @@ -95,16 +99,18 @@ class PackageView(BaseView): HTTPNotFound: if no package was found """ package_base = self.request.match_info["package"] + repository_id = self.repository_id() try: - package, status = self.service.package_get(package_base) + package, status = self.service(repository_id).package_get(package_base) except UnknownPackageError: - raise HTTPNotFound + raise HTTPNotFound(reason=f"Package {package_base} is unknown") response = [ { "package": package.view(), - "status": status.view() + "status": status.view(), + "repository": repository_id.view(), } ] return json_response(response) @@ -118,12 +124,14 @@ class PackageView(BaseView): 400: {"description": "Bad data is supplied", "schema": ErrorSchema}, 401: {"description": "Authorization required", "schema": ErrorSchema}, 403: {"description": "Access is forbidden", "schema": ErrorSchema}, + 404: {"description": "Repository is unknown", "schema": ErrorSchema}, 500: {"description": "Internal server error", "schema": ErrorSchema}, }, security=[{"token": [POST_PERMISSION]}], ) @aiohttp_apispec.cookies_schema(AuthSchema) @aiohttp_apispec.match_info_schema(PackageNameSchema) + @aiohttp_apispec.querystring_schema(RepositoryIdSchema) @aiohttp_apispec.json_schema(PackageStatusSimplifiedSchema) async def post(self) -> None: """ @@ -143,7 +151,7 @@ class PackageView(BaseView): raise HTTPBadRequest(reason=str(ex)) try: - self.service.package_update(package_base, status, package) + self.service().package_update(package_base, status, package) except UnknownPackageError: raise HTTPBadRequest(reason=f"Package {package_base} is unknown, but no package body set") diff --git a/src/ahriman/web/views/v1/status/packages.py b/src/ahriman/web/views/v1/status/packages.py index 77a522dc..c620846f 100644 --- a/src/ahriman/web/views/v1/status/packages.py +++ b/src/ahriman/web/views/v1/status/packages.py @@ -26,7 +26,7 @@ from aiohttp.web import HTTPNoContent, Response, json_response from ahriman.models.build_status import BuildStatus from ahriman.models.package import Package from ahriman.models.user_access import UserAccess -from ahriman.web.schemas import AuthSchema, ErrorSchema, PackageStatusSchema, PaginationSchema +from ahriman.web.schemas import AuthSchema, ErrorSchema, PackageStatusSchema, PaginationSchema, RepositoryIdSchema from ahriman.web.views.base import BaseView @@ -52,6 +52,7 @@ class PackagesView(BaseView): 400: {"description": "Bad data is supplied", "schema": ErrorSchema}, 401: {"description": "Authorization required", "schema": ErrorSchema}, 403: {"description": "Access is forbidden", "schema": ErrorSchema}, + 404: {"description": "Repository is unknown", "schema": ErrorSchema}, 500: {"description": "Internal server error", "schema": ErrorSchema}, }, security=[{"token": [GET_PERMISSION]}], @@ -68,12 +69,16 @@ class PackagesView(BaseView): limit, offset = self.page() stop = offset + limit if limit >= 0 else None - comparator: Callable[[tuple[Package, BuildStatus]], str] = lambda pair: pair[0].base + repository_id = self.repository_id() + packages = self.service(repository_id).packages + + comparator: Callable[[tuple[Package, BuildStatus]], str] = lambda items: items[0].base response = [ { "package": package.view(), - "status": status.view() - } for package, status in itertools.islice(sorted(self.service.packages, key=comparator), offset, stop) + "status": status.view(), + "repository": repository_id.view(), + } for package, status in itertools.islice(sorted(packages, key=comparator), offset, stop) ] return json_response(response) @@ -86,11 +91,13 @@ class PackagesView(BaseView): 204: {"description": "Success response"}, 401: {"description": "Authorization required", "schema": ErrorSchema}, 403: {"description": "Access is forbidden", "schema": ErrorSchema}, + 404: {"description": "Repository is unknown", "schema": ErrorSchema}, 500: {"description": "Internal server error", "schema": ErrorSchema}, }, security=[{"token": [POST_PERMISSION]}], ) @aiohttp_apispec.cookies_schema(AuthSchema) + @aiohttp_apispec.querystring_schema(RepositoryIdSchema) async def post(self) -> None: """ reload all packages from repository @@ -98,6 +105,6 @@ class PackagesView(BaseView): Raises: HTTPNoContent: on success response """ - self.service.load() + self.service().load() raise HTTPNoContent diff --git a/src/ahriman/web/views/v1/status/repositories.py b/src/ahriman/web/views/v1/status/repositories.py new file mode 100644 index 00000000..344a7401 --- /dev/null +++ b/src/ahriman/web/views/v1/status/repositories.py @@ -0,0 +1,65 @@ +# +# Copyright (c) 2021-2023 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 . +# +import aiohttp_apispec # type: ignore[import-untyped] + +from aiohttp.web import Response, json_response + +from ahriman.models.user_access import UserAccess +from ahriman.web.schemas import AuthSchema, ErrorSchema, RepositoryIdSchema +from ahriman.web.views.base import BaseView + + +class RepositoriesView(BaseView): + """ + repositories view + + Attributes: + GET_PERMISSION(UserAccess): (class attribute) get permissions of self + """ + + GET_PERMISSION = UserAccess.Read + ROUTES = ["/api/v1/repositories"] + + @aiohttp_apispec.docs( + tags=["Status"], + summary="Available repositories", + description="List available repositories", + responses={ + 200: {"description": "Success response", "schema": RepositoryIdSchema(many=True)}, + 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) + async def get(self) -> Response: + """ + get list of available repositories + + Returns: + Response: 200 with service status object + """ + repositories = [ + repository_id.view() + for repository_id in sorted(self.services) + ] + + return json_response(repositories) diff --git a/src/ahriman/web/views/v1/status/status.py b/src/ahriman/web/views/v1/status/status.py index b5252d84..d16ae49e 100644 --- a/src/ahriman/web/views/v1/status/status.py +++ b/src/ahriman/web/views/v1/status/status.py @@ -26,7 +26,7 @@ from ahriman.models.build_status import BuildStatusEnum from ahriman.models.counters import Counters from ahriman.models.internal_status import InternalStatus from ahriman.models.user_access import UserAccess -from ahriman.web.schemas import AuthSchema, ErrorSchema, InternalStatusSchema, StatusSchema +from ahriman.web.schemas import AuthSchema, ErrorSchema, InternalStatusSchema, StatusSchema, RepositoryIdSchema from ahriman.web.views.base import BaseView @@ -51,6 +51,7 @@ class StatusView(BaseView): 200: {"description": "Success response", "schema": InternalStatusSchema}, 401: {"description": "Authorization required", "schema": ErrorSchema}, 403: {"description": "Access is forbidden", "schema": ErrorSchema}, + 404: {"description": "Repository is unknown", "schema": ErrorSchema}, 500: {"description": "Internal server error", "schema": ErrorSchema}, }, security=[{"token": [GET_PERMISSION]}], @@ -63,12 +64,13 @@ class StatusView(BaseView): Returns: Response: 200 with service status object """ - counters = Counters.from_packages(self.service.packages) + repository_id = self.repository_id() + counters = Counters.from_packages(self.service(repository_id).packages) status = InternalStatus( - status=self.service.status, - architecture=self.service.repository_id.architecture, + status=self.service(repository_id).status, + architecture=repository_id.architecture, packages=counters, - repository=self.service.repository_id.name, + repository=repository_id.name, version=__version__, ) @@ -83,11 +85,13 @@ class StatusView(BaseView): 400: {"description": "Bad data is supplied", "schema": ErrorSchema}, 401: {"description": "Authorization required", "schema": ErrorSchema}, 403: {"description": "Access is forbidden", "schema": ErrorSchema}, + 404: {"description": "Repository is unknown", "schema": ErrorSchema}, 500: {"description": "Internal server error", "schema": ErrorSchema}, }, security=[{"token": [POST_PERMISSION]}], ) @aiohttp_apispec.cookies_schema(AuthSchema) + @aiohttp_apispec.querystring_schema(RepositoryIdSchema) @aiohttp_apispec.json_schema(StatusSchema) async def post(self) -> None: """ @@ -103,6 +107,6 @@ class StatusView(BaseView): except Exception as ex: raise HTTPBadRequest(reason=str(ex)) - self.service.status_update(status) + self.service().status_update(status) raise HTTPNoContent diff --git a/src/ahriman/web/views/v1/user/login.py b/src/ahriman/web/views/v1/user/login.py index 719cee00..9f197af5 100644 --- a/src/ahriman/web/views/v1/user/login.py +++ b/src/ahriman/web/views/v1/user/login.py @@ -75,7 +75,7 @@ class LoginView(BaseView): if not isinstance(oauth_provider, OAuth): # there is actually property, but mypy does not like it anyway raise HTTPMethodNotAllowed(self.request.method, ["POST"]) - code = self.request.query.getone("code", default=None) + code = self.request.query.get("code") if not code: raise HTTPFound(oauth_provider.get_oauth_url()) diff --git a/src/ahriman/web/views/v2/status/logs.py b/src/ahriman/web/views/v2/status/logs.py index 963dc6b0..c9e4a065 100644 --- a/src/ahriman/web/views/v2/status/logs.py +++ b/src/ahriman/web/views/v2/status/logs.py @@ -23,8 +23,7 @@ from aiohttp.web import HTTPNotFound, Response, json_response from ahriman.core.exceptions import UnknownPackageError from ahriman.models.user_access import UserAccess -from ahriman.web.schemas import AuthSchema, ErrorSchema, PackageNameSchema, PaginationSchema -from ahriman.web.schemas.logs_schema import LogsSchemaV2 +from ahriman.web.schemas import AuthSchema, ErrorSchema, LogsSchemaV2, PackageNameSchema, PaginationSchema from ahriman.web.views.base import BaseView @@ -48,7 +47,7 @@ class LogsView(BaseView): 400: {"description": "Bad data is supplied", "schema": ErrorSchema}, 401: {"description": "Authorization required", "schema": ErrorSchema}, 403: {"description": "Access is forbidden", "schema": ErrorSchema}, - 404: {"description": "Package base is unknown", "schema": ErrorSchema}, + 404: {"description": "Package base and/or repository are unknown", "schema": ErrorSchema}, 500: {"description": "Internal server error", "schema": ErrorSchema}, }, security=[{"token": [GET_PERMISSION]}], @@ -70,10 +69,10 @@ class LogsView(BaseView): limit, offset = self.page() try: - _, status = self.service.package_get(package_base) + _, status = self.service().package_get(package_base) except UnknownPackageError: - raise HTTPNotFound - logs = self.service.logs_get(package_base, limit, offset) + raise HTTPNotFound(reason=f"Package {package_base} is unknown") + logs = self.service().logs_get(package_base, limit, offset) response = { "package_base": package_base, diff --git a/src/ahriman/web/web.py b/src/ahriman/web/web.py index 2049df7e..07ca0b84 100644 --- a/src/ahriman/web/web.py +++ b/src/ahriman/web/web.py @@ -38,7 +38,7 @@ from ahriman.web.middlewares.exception_handler import exception_handler from ahriman.web.routes import setup_routes -__all__ = ["run_server", "setup_service"] +__all__ = ["run_server", "setup_server"] def _create_socket(configuration: Configuration, application: Application) -> socket.socket | None: @@ -95,8 +95,10 @@ async def _on_startup(application: Application) -> None: InitializeError: in case if matched could not be loaded """ application.logger.info("server started") + try: - application["watcher"].load() + for watcher in application["watcher"].values(): + watcher.load() except Exception: message = "could not load packages" application.logger.exception(message) @@ -121,17 +123,20 @@ def run_server(application: Application) -> None: access_log=logging.getLogger("http"), access_log_class=FilteredAccessLogger) -def setup_service(repository_id: RepositoryId, configuration: Configuration, spawner: Spawn) -> Application: +def setup_server(configuration: Configuration, spawner: Spawn, repositories: list[RepositoryId]) -> Application: """ create web application Args: - repository_id(RepositoryId): repository unique identifier configuration(Configuration): configuration instance spawner(Spawn): spawner thread + repositories(list[RepositoryId]): list of known repositories Returns: Application: web application instance + + Raises: + InitializeError: if no repositories set """ application = Application(logger=logging.getLogger(__name__)) application.on_shutdown.append(_on_shutdown) @@ -153,11 +158,15 @@ def setup_service(repository_id: RepositoryId, configuration: Configuration, spa application.logger.info("setup configuration") application["configuration"] = configuration - application.logger.info("setup database and perform migrations") - database = application["database"] = SQLite.load(configuration) - - application.logger.info("setup watcher") - application["watcher"] = Watcher(repository_id, configuration, database) + application.logger.info("setup watchers") + if not repositories: + raise InitializeError("No repositories configured, exiting") + database = SQLite.load(configuration) + watchers: dict[RepositoryId, Watcher] = {} + for repository_id in repositories: + application.logger.info("load repository %s", repository_id) + watchers[repository_id] = Watcher(repository_id, database) + application["watcher"] = watchers application.logger.info("setup process spawner") application["spawn"] = spawner diff --git a/tests/ahriman/application/application/test_application.py b/tests/ahriman/application/application/test_application.py index 981f1065..3a08e0ef 100644 --- a/tests/ahriman/application/application/test_application.py +++ b/tests/ahriman/application/application/test_application.py @@ -99,8 +99,8 @@ def test_with_dependencies(application: Application, package_ahriman: Package, p result = application.with_dependencies([package_ahriman], process_dependencies=True) assert {package.base: package for package in result} == packages package_aur_mock.assert_has_calls([ - MockCall(package_python_schedule.base, application.repository.pacman, package_ahriman.packager), - MockCall("python-installer", application.repository.pacman, package_ahriman.packager), + MockCall(package_python_schedule.base, package_ahriman.packager), + MockCall("python-installer", package_ahriman.packager), ], any_order=True) package_local_mock.assert_has_calls([ MockCall(application.repository.paths.cache_for("python"), "x86_64", package_ahriman.packager), diff --git a/tests/ahriman/application/handlers/test_handler.py b/tests/ahriman/application/handlers/test_handler.py index 7f513af5..36d7a3aa 100644 --- a/tests/ahriman/application/handlers/test_handler.py +++ b/tests/ahriman/application/handlers/test_handler.py @@ -30,7 +30,12 @@ def test_call(args: argparse.Namespace, configuration: Configuration, mocker: Mo assert Handler.call(args, repository_id) configuration_mock.assert_called_once_with(args.configuration, repository_id) log_handler_mock.assert_called_once_with(args.log_handler) - log_load_mock.assert_called_once_with(configuration, args.log_handler, quiet=args.quiet, report=args.report) + log_load_mock.assert_called_once_with( + repository_id, + configuration, + args.log_handler, + quiet=args.quiet, + report=args.report) enter_mock.assert_called_once_with() exit_mock.assert_called_once_with(None, None, None) @@ -115,13 +120,24 @@ def test_run(args: argparse.Namespace, configuration: Configuration) -> None: Handler.run(args, repository_id, configuration, report=True) +def test_check_if_empty() -> None: + """ + must raise exception in case if predicate is True and enabled + """ + Handler.check_if_empty(False, False) + Handler.check_if_empty(True, False) + Handler.check_if_empty(False, True) + with pytest.raises(ExitCode): + Handler.check_if_empty(True, True) + + def test_repositories_extract(args: argparse.Namespace, configuration: Configuration, mocker: MockerFixture) -> None: """ must generate list of available repositories based on flags """ - args.architecture = ["arch"] + args.architecture = "arch" args.configuration = configuration.path - args.repository = ["repo"] + args.repository = "repo" known_architectures_mock = mocker.patch("ahriman.models.repository_paths.RepositoryPaths.known_architectures") known_repositories_mock = mocker.patch("ahriman.models.repository_paths.RepositoryPaths.known_repositories") @@ -135,7 +151,7 @@ def test_repositories_extract_repository(args: argparse.Namespace, configuration """ must generate list of available repositories based on flags and tree """ - args.architecture = ["arch"] + args.architecture = "arch" args.configuration = configuration.path known_architectures_mock = mocker.patch("ahriman.models.repository_paths.RepositoryPaths.known_architectures") known_repositories_mock = mocker.patch("ahriman.models.repository_paths.RepositoryPaths.known_repositories", @@ -151,7 +167,7 @@ def test_repositories_extract_repository_legacy(args: argparse.Namespace, config """ must generate list of available repositories based on flags and tree """ - args.architecture = ["arch"] + args.architecture = "arch" args.configuration = configuration.path known_architectures_mock = mocker.patch("ahriman.models.repository_paths.RepositoryPaths.known_architectures") known_repositories_mock = mocker.patch("ahriman.models.repository_paths.RepositoryPaths.known_repositories", @@ -168,7 +184,7 @@ def test_repositories_extract_architecture(args: argparse.Namespace, configurati must read repository name from config """ args.configuration = configuration.path - args.repository = ["repo"] + args.repository = "repo" known_architectures_mock = mocker.patch("ahriman.models.repository_paths.RepositoryPaths.known_architectures", return_value={"arch"}) known_repositories_mock = mocker.patch("ahriman.models.repository_paths.RepositoryPaths.known_repositories") @@ -207,6 +223,21 @@ def test_repositories_extract_systemd(args: argparse.Namespace, configuration: C known_repositories_mock.assert_not_called() +def test_repositories_extract_systemd_with_dash(args: argparse.Namespace, configuration: Configuration, + mocker: MockerFixture) -> None: + """ + must extract repository list by using dash separated identifier + """ + args.configuration = configuration.path + args.repository_id = "i686-some-repo-name" + known_architectures_mock = mocker.patch("ahriman.models.repository_paths.RepositoryPaths.known_architectures") + known_repositories_mock = mocker.patch("ahriman.models.repository_paths.RepositoryPaths.known_repositories") + + assert Handler.repositories_extract(args) == [RepositoryId("i686", "some-repo-name")] + known_architectures_mock.assert_not_called() + known_repositories_mock.assert_not_called() + + def test_repositories_extract_systemd_legacy(args: argparse.Namespace, configuration: Configuration, mocker: MockerFixture) -> None: """ @@ -221,14 +252,3 @@ def test_repositories_extract_systemd_legacy(args: argparse.Namespace, configura assert Handler.repositories_extract(args) == [RepositoryId("i686", "aur-clone")] known_architectures_mock.assert_not_called() known_repositories_mock.assert_called_once_with(configuration.repository_paths.root) - - -def test_check_if_empty() -> None: - """ - must raise exception in case if predicate is True and enabled - """ - Handler.check_if_empty(False, False) - Handler.check_if_empty(True, False) - Handler.check_if_empty(False, True) - with pytest.raises(ExitCode): - Handler.check_if_empty(True, True) diff --git a/tests/ahriman/application/handlers/test_handler_dump.py b/tests/ahriman/application/handlers/test_handler_dump.py index 8816baa8..dcb5f1c1 100644 --- a/tests/ahriman/application/handlers/test_handler_dump.py +++ b/tests/ahriman/application/handlers/test_handler_dump.py @@ -1,4 +1,5 @@ import argparse +import pytest from pytest_mock import MockerFixture @@ -16,6 +17,9 @@ def _default_args(args: argparse.Namespace) -> argparse.Namespace: Returns: argparse.Namespace: generated arguments for these test cases """ + args.info = False + args.key = None + args.section = None args.secure = True return args @@ -35,6 +39,48 @@ def test_run(args: argparse.Namespace, configuration: Configuration, mocker: Moc print_mock.assert_called() +def test_run_info(args: argparse.Namespace, configuration: Configuration, mocker: MockerFixture) -> None: + """ + must run command with info + """ + args = _default_args(args) + args.info = True + print_mock = mocker.patch("ahriman.core.formatters.Printer.print") + + _, repository_id = configuration.check_loaded() + Dump.run(args, repository_id, configuration, report=False) + print_mock.assert_called() + + +def test_run_section(args: argparse.Namespace, configuration: Configuration, mocker: MockerFixture) -> None: + """ + must run command with filter by section + """ + args = _default_args(args) + args.section = "settings" + print_mock = mocker.patch("ahriman.core.formatters.Printer.print") + + _, repository_id = configuration.check_loaded() + Dump.run(args, repository_id, configuration, report=False) + print_mock.assert_called_once_with(verbose=False, log_fn=pytest.helpers.anyvar(int), separator=" = ") + + +def test_run_section_key(args: argparse.Namespace, configuration: Configuration, mocker: MockerFixture) -> None: + """ + must run command with filter by section and key + """ + args = _default_args(args) + args.section = "settings" + args.key = "include" + print_mock = mocker.patch("ahriman.core.formatters.Printer.print") + application_mock = mocker.patch("ahriman.core.configuration.Configuration.dump") + + _, repository_id = configuration.check_loaded() + Dump.run(args, repository_id, configuration, report=False) + application_mock.assert_not_called() + print_mock.assert_called_once_with(verbose=False, log_fn=pytest.helpers.anyvar(int), separator=": ") + + def test_disallow_multi_architecture_run() -> None: """ must not allow multi architecture run diff --git a/tests/ahriman/application/handlers/test_handler_repositories.py b/tests/ahriman/application/handlers/test_handler_repositories.py new file mode 100644 index 00000000..fb4f29ed --- /dev/null +++ b/tests/ahriman/application/handlers/test_handler_repositories.py @@ -0,0 +1,37 @@ +import argparse +import pytest + +from pytest_mock import MockerFixture + +from ahriman.application.handlers import Repositories +from ahriman.core.configuration import Configuration + + +def _default_args(args: argparse.Namespace) -> argparse.Namespace: + """ + default arguments for these test cases + + Args: + args(argparse.Namespace): command line arguments fixture + + Returns: + argparse.Namespace: generated arguments for these test cases + """ + args.configuration = None # doesn't matter actually + args.id_only = False + return args + + +def test_run(args: argparse.Namespace, configuration: Configuration, mocker: MockerFixture) -> None: + """ + must run command + """ + args = _default_args(args) + print_mock = mocker.patch("ahriman.core.formatters.Printer.print") + _, repository_id = configuration.check_loaded() + application_mock = mocker.patch("ahriman.application.handlers.Handler.repositories_extract", + return_value=[repository_id]) + + Repositories.run(args, repository_id, configuration, report=False) + application_mock.assert_called_once_with(pytest.helpers.anyvar(int)) + print_mock.assert_called_once_with(verbose=not args.id_only, log_fn=pytest.helpers.anyvar(int), separator=": ") diff --git a/tests/ahriman/application/handlers/test_handler_search.py b/tests/ahriman/application/handlers/test_handler_search.py index bf4fe07c..ef13318c 100644 --- a/tests/ahriman/application/handlers/test_handler_search.py +++ b/tests/ahriman/application/handlers/test_handler_search.py @@ -44,8 +44,8 @@ def test_run(args: argparse.Namespace, configuration: Configuration, repository: _, repository_id = configuration.check_loaded() Search.run(args, repository_id, configuration, report=False) - aur_search_mock.assert_called_once_with("ahriman", pacman=pytest.helpers.anyvar(int)) - official_search_mock.assert_called_once_with("ahriman", pacman=pytest.helpers.anyvar(int)) + aur_search_mock.assert_called_once_with("ahriman") + official_search_mock.assert_called_once_with("ahriman") check_mock.assert_called_once_with(False, False) print_mock.assert_has_calls([ MockCall(verbose=False, log_fn=pytest.helpers.anyvar(int), separator=": "), diff --git a/tests/ahriman/application/handlers/test_handler_service_updates.py b/tests/ahriman/application/handlers/test_handler_service_updates.py index 694c2697..e5c6b91b 100644 --- a/tests/ahriman/application/handlers/test_handler_service_updates.py +++ b/tests/ahriman/application/handlers/test_handler_service_updates.py @@ -38,7 +38,7 @@ def test_run(args: argparse.Namespace, configuration: Configuration, repository: _, repository_id = configuration.check_loaded() ServiceUpdates.run(args, repository_id, configuration, report=False) - package_mock.assert_called_once_with(package_ahriman.base, repository.pacman, None) + package_mock.assert_called_once_with(package_ahriman.base, None) application_mock.assert_called_once_with(verbose=True, log_fn=pytest.helpers.anyvar(int), separator=" -> ") check_mock.assert_called_once_with(args.exit_code, True) diff --git a/tests/ahriman/application/handlers/test_handler_setup.py b/tests/ahriman/application/handlers/test_handler_setup.py index 6f09a548..64648df5 100644 --- a/tests/ahriman/application/handlers/test_handler_setup.py +++ b/tests/ahriman/application/handlers/test_handler_setup.py @@ -25,7 +25,7 @@ def _default_args(args: argparse.Namespace) -> argparse.Namespace: Returns: argparse.Namespace: generated arguments for these test cases """ - args.architecture = ["x86_64"] + args.architecture = "x86_64" args.build_as_user = "ahriman" args.from_configuration = Path("/usr/share/devtools/pacman.conf.d/extra.conf") args.generate_salt = True @@ -33,7 +33,7 @@ def _default_args(args: argparse.Namespace) -> argparse.Namespace: args.mirror = "mirror" args.multilib = True args.packager = "John Doe " - args.repository = ["aur-clone"] + args.repository = "aur-clone" args.server = None args.sign_key = "key" args.sign_target = [SignSettings.Packages] @@ -127,6 +127,7 @@ def test_configuration_create_ahriman(args: argparse.Namespace, configuration: C mocker.patch("pathlib.Path.open") set_option_mock = mocker.patch("ahriman.core.configuration.Configuration.set_option") write_mock = mocker.patch("ahriman.core.configuration.Configuration.write") + remove_mock = mocker.patch("pathlib.Path.unlink", autospec=True) _, repository_id = configuration.check_loaded() command = Setup.build_command(repository_paths.root, repository_id) @@ -143,13 +144,12 @@ def test_configuration_create_ahriman(args: argparse.Namespace, configuration: C " ".join([target.name.lower() for target in args.sign_target])), MockCall(Configuration.section_name("sign", repository_id.name, repository_id.architecture), "key", args.sign_key), - MockCall(Configuration.section_name("web", repository_id.name, repository_id.architecture), "port", - str(args.web_port)), - MockCall(Configuration.section_name("web", repository_id.name, repository_id.architecture), "unix_socket", - str(args.web_unix_socket)), + MockCall("web", "port", str(args.web_port)), + MockCall("web", "unix_socket", str(args.web_unix_socket)), MockCall("auth", "salt", pytest.helpers.anyvar(str, strict=True)), ]) write_mock.assert_called_once_with(pytest.helpers.anyvar(int)) + remove_mock.assert_called_once_with(configuration.include / "00-setup-overrides.ini", missing_ok=True) def test_configuration_create_ahriman_no_multilib(args: argparse.Namespace, configuration: Configuration, diff --git a/tests/ahriman/application/handlers/test_handler_status_update.py b/tests/ahriman/application/handlers/test_handler_status_update.py index 427f1ca6..99a67f60 100644 --- a/tests/ahriman/application/handlers/test_handler_status_update.py +++ b/tests/ahriman/application/handlers/test_handler_status_update.py @@ -47,13 +47,16 @@ def test_run_packages(args: argparse.Namespace, configuration: Configuration, re must run command with specified packages """ args = _default_args(args) - args.package = [package_ahriman.base] + args.package = [package_ahriman.base, "package"] mocker.patch("ahriman.core.repository.Repository.load", return_value=repository) + mocker.patch("ahriman.core.repository.repository.Repository.packages", return_value=[package_ahriman]) + add_mock = mocker.patch("ahriman.core.status.client.Client.package_add") update_mock = mocker.patch("ahriman.core.status.client.Client.package_update") _, repository_id = configuration.check_loaded() StatusUpdate.run(args, repository_id, configuration, report=False) - update_mock.assert_called_once_with(package_ahriman.base, args.status) + add_mock.assert_called_once_with(package_ahriman, args.status) + update_mock.assert_called_once_with("package", args.status) def test_run_remove(args: argparse.Namespace, configuration: Configuration, repository: Repository, diff --git a/tests/ahriman/application/handlers/test_handler_web.py b/tests/ahriman/application/handlers/test_handler_web.py index 3090d375..79376ee6 100644 --- a/tests/ahriman/application/handlers/test_handler_web.py +++ b/tests/ahriman/application/handlers/test_handler_web.py @@ -20,6 +20,7 @@ def _default_args(args: argparse.Namespace) -> argparse.Namespace: argparse.Namespace: generated arguments for these test cases """ args.parser = lambda: True + args.configuration = None # doesn't matter actually args.force = False args.log_handler = None args.report = True @@ -35,15 +36,16 @@ def test_run(args: argparse.Namespace, configuration: Configuration, repository: """ args = _default_args(args) mocker.patch("ahriman.core.repository.Repository.load", return_value=repository) - setup_mock = mocker.patch("ahriman.web.web.setup_service") + setup_mock = mocker.patch("ahriman.web.web.setup_server") run_mock = mocker.patch("ahriman.web.web.run_server") start_mock = mocker.patch("ahriman.core.spawn.Spawn.start") stop_mock = mocker.patch("ahriman.core.spawn.Spawn.stop") join_mock = mocker.patch("ahriman.core.spawn.Spawn.join") - _, repository_id = configuration.check_loaded() + mocker.patch("ahriman.application.handlers.Handler.repositories_extract", return_value=[repository_id]) + Web.run(args, repository_id, configuration, report=False) - setup_mock.assert_called_once_with(repository_id, configuration, pytest.helpers.anyvar(int)) + setup_mock.assert_called_once_with(configuration, pytest.helpers.anyvar(int), [repository_id]) run_mock.assert_called_once_with(pytest.helpers.anyvar(int)) start_mock.assert_called_once_with() stop_mock.assert_called_once_with() @@ -54,35 +56,32 @@ def test_extract_arguments(args: argparse.Namespace, configuration: Configuratio """ must extract correct args """ - _, repository_id = configuration.check_loaded() expected = [ - "--architecture", repository_id.architecture, - "--repository", repository_id.name, "--configuration", str(configuration.path), ] probe = _default_args(args) - assert list(Web.extract_arguments(probe, repository_id, configuration)) == expected + assert list(Web.extract_arguments(probe, configuration)) == expected probe.force = True expected.extend(["--force"]) - assert list(Web.extract_arguments(probe, repository_id, configuration)) == expected + assert list(Web.extract_arguments(probe, configuration)) == expected probe.log_handler = LogHandler.Console expected.extend(["--log-handler", probe.log_handler.value]) - assert list(Web.extract_arguments(probe, repository_id, configuration)) == expected + assert list(Web.extract_arguments(probe, configuration)) == expected probe.quiet = True expected.extend(["--quiet"]) - assert list(Web.extract_arguments(probe, repository_id, configuration)) == expected + assert list(Web.extract_arguments(probe, configuration)) == expected probe.unsafe = True expected.extend(["--unsafe"]) - assert list(Web.extract_arguments(probe, repository_id, configuration)) == expected + assert list(Web.extract_arguments(probe, configuration)) == expected configuration.set_option("web", "wait_timeout", "60") expected.extend(["--wait-timeout", "60"]) - assert list(Web.extract_arguments(probe, repository_id, configuration)) == expected + assert list(Web.extract_arguments(probe, configuration)) == expected def test_extract_arguments_full(parser: argparse.ArgumentParser, configuration: Configuration): @@ -104,10 +103,7 @@ def test_extract_arguments_full(parser: argparse.ArgumentParser, configuration: value = action.type(value) setattr(args, action.dest, value) - _, repository_id = configuration.check_loaded() - assert list(Web.extract_arguments(args, repository_id, configuration)) == [ - "--architecture", repository_id.architecture, - "--repository", repository_id.name, + assert list(Web.extract_arguments(args, configuration)) == [ "--configuration", str(configuration.path), "--force", "--log-handler", "console", diff --git a/tests/ahriman/application/test_ahriman.py b/tests/ahriman/application/test_ahriman.py index ac966d56..e7cba747 100644 --- a/tests/ahriman/application/test_ahriman.py +++ b/tests/ahriman/application/test_ahriman.py @@ -67,14 +67,6 @@ def test_parser_option_architecture_empty(parser: argparse.ArgumentParser) -> No assert args.architecture is None -def test_parser_option_architecture_multiple(parser: argparse.ArgumentParser) -> None: - """ - must accept multiple architectures - """ - args = parser.parse_args(["-a", "x86_64", "-a", "i686", "service-config"]) - assert args.architecture == ["x86_64", "i686"] - - def test_parser_option_repository_empty(parser: argparse.ArgumentParser) -> None: """ must parse empty repository list as None @@ -83,24 +75,16 @@ def test_parser_option_repository_empty(parser: argparse.ArgumentParser) -> None assert args.repository is None -def test_parser_option_repository_multiple(parser: argparse.ArgumentParser) -> None: - """ - must accept multiple architectures - """ - args = parser.parse_args(["-r", "repo1", "-r", "repo2", "service-config"]) - assert args.repository == ["repo1", "repo2"] - - def test_subparsers_aur_search(parser: argparse.ArgumentParser) -> None: """ aur-search command must imply architecture list, lock, quiet, report, repository and unsafe """ args = parser.parse_args(["aur-search", "ahriman"]) - assert args.architecture == [""] + assert args.architecture == "" assert args.lock is None assert args.quiet assert not args.report - assert args.repository == [""] + assert args.repository == "" assert args.unsafe @@ -109,7 +93,7 @@ def test_subparsers_aur_search_option_architecture(parser: argparse.ArgumentPars aur-search command must correctly parse architecture list """ args = parser.parse_args(["-a", "x86_64", "aur-search", "ahriman"]) - assert args.architecture == [""] + assert args.architecture == "" def test_subparsers_aur_search_option_repository(parser: argparse.ArgumentParser) -> None: @@ -117,7 +101,7 @@ def test_subparsers_aur_search_option_repository(parser: argparse.ArgumentParser aur-search command must correctly parse repository list """ args = parser.parse_args(["-r", "repo", "aur-search", "ahriman"]) - assert args.repository == [""] + assert args.repository == "" def test_subparsers_help(parser: argparse.ArgumentParser) -> None: @@ -125,11 +109,11 @@ def test_subparsers_help(parser: argparse.ArgumentParser) -> None: help command must imply architecture list, lock, quiet, report, repository, unsafe and parser """ args = parser.parse_args(["help"]) - assert args.architecture == [""] + assert args.architecture == "" assert args.lock is None assert args.quiet assert not args.report - assert args.repository == [""] + assert args.repository == "" assert args.unsafe assert args.parser is not None and args.parser() @@ -139,7 +123,7 @@ def test_subparsers_help_option_architecture(parser: argparse.ArgumentParser) -> help command must correctly parse architecture list """ args = parser.parse_args(["-a", "x86_64", "help"]) - assert args.architecture == [""] + assert args.architecture == "" def test_subparsers_help_option_repository(parser: argparse.ArgumentParser) -> None: @@ -147,7 +131,7 @@ def test_subparsers_help_option_repository(parser: argparse.ArgumentParser) -> N help command must correctly parse repository list """ args = parser.parse_args(["-r", "repo", "help"]) - assert args.repository == [""] + assert args.repository == "" def test_subparsers_help_commands_unsafe(parser: argparse.ArgumentParser) -> None: @@ -155,11 +139,11 @@ def test_subparsers_help_commands_unsafe(parser: argparse.ArgumentParser) -> Non help-commands-unsafe command must imply architecture list, lock, quiet, report, repository, unsafe and parser """ args = parser.parse_args(["help-commands-unsafe"]) - assert args.architecture == [""] + assert args.architecture == "" assert args.lock is None assert args.quiet assert not args.report - assert args.repository == [""] + assert args.repository == "" assert args.unsafe assert args.parser is not None and args.parser() @@ -169,7 +153,7 @@ def test_subparsers_help_commands_unsafe_option_architecture(parser: argparse.Ar help-commands-unsafe command must correctly parse architecture list """ args = parser.parse_args(["-a", "x86_64", "help-commands-unsafe"]) - assert args.architecture == [""] + assert args.architecture == "" def test_subparsers_help_commands_unsafe_option_repository(parser: argparse.ArgumentParser) -> None: @@ -177,7 +161,7 @@ def test_subparsers_help_commands_unsafe_option_repository(parser: argparse.Argu help-commands-unsafe command must correctly parse repository list """ args = parser.parse_args(["-r", "repo", "help-commands-unsafe"]) - assert args.repository == [""] + assert args.repository == "" def test_subparsers_help_updates(parser: argparse.ArgumentParser) -> None: @@ -185,11 +169,11 @@ def test_subparsers_help_updates(parser: argparse.ArgumentParser) -> None: help-updates command must imply architecture list, lock, quiet, report, repository, and unsafe """ args = parser.parse_args(["help-updates"]) - assert args.architecture == [""] + assert args.architecture == "" assert args.lock is None assert args.quiet assert not args.report - assert args.repository == [""] + assert args.repository == "" assert args.unsafe @@ -198,7 +182,7 @@ def test_subparsers_help_updates_option_architecture(parser: argparse.ArgumentPa help-updates command must correctly parse architecture list """ args = parser.parse_args(["-a", "x86_64", "help-updates"]) - assert args.architecture == [""] + assert args.architecture == "" def test_subparsers_help_updates_option_repository(parser: argparse.ArgumentParser) -> None: @@ -206,7 +190,7 @@ def test_subparsers_help_updates_option_repository(parser: argparse.ArgumentPars help-updates command must correctly parse repository list """ args = parser.parse_args(["-r", "repo", "help-updates"]) - assert args.repository == [""] + assert args.repository == "" def test_subparsers_help_version(parser: argparse.ArgumentParser) -> None: @@ -214,11 +198,11 @@ def test_subparsers_help_version(parser: argparse.ArgumentParser) -> None: help-version command must imply architecture, lock, quiet, report, repository and unsafe """ args = parser.parse_args(["help-version"]) - assert args.architecture == [""] + assert args.architecture == "" assert args.lock is None assert args.quiet assert not args.report - assert args.repository == [""] + assert args.repository == "" assert args.unsafe @@ -227,7 +211,7 @@ def test_subparsers_help_version_option_architecture(parser: argparse.ArgumentPa help-version command must correctly parse architecture list """ args = parser.parse_args(["-a", "x86_64", "help-version"]) - assert args.architecture == [""] + assert args.architecture == "" def test_subparsers_help_version_option_repository(parser: argparse.ArgumentParser) -> None: @@ -235,7 +219,7 @@ def test_subparsers_help_version_option_repository(parser: argparse.ArgumentPars help-version command must correctly parse repository list """ args = parser.parse_args(["-r", "repo", "help-version"]) - assert args.repository == [""] + assert args.repository == "" def test_subparsers_package_add_option_architecture(parser: argparse.ArgumentParser) -> None: @@ -245,7 +229,7 @@ def test_subparsers_package_add_option_architecture(parser: argparse.ArgumentPar args = parser.parse_args(["package-add", "ahriman"]) assert args.architecture is None args = parser.parse_args(["-a", "x86_64", "package-add", "ahriman"]) - assert args.architecture == ["x86_64"] + assert args.architecture == "x86_64" def test_subparsers_package_add_option_repository(parser: argparse.ArgumentParser) -> None: @@ -255,7 +239,7 @@ def test_subparsers_package_add_option_repository(parser: argparse.ArgumentParse args = parser.parse_args(["package-add", "ahriman"]) assert args.repository is None args = parser.parse_args(["-r", "repo", "package-add", "ahriman"]) - assert args.repository == ["repo"] + assert args.repository == "repo" def test_subparsers_package_add_option_refresh(parser: argparse.ArgumentParser) -> None: @@ -277,7 +261,7 @@ def test_subparsers_package_remove_option_architecture(parser: argparse.Argument args = parser.parse_args(["package-remove", "ahriman"]) assert args.architecture is None args = parser.parse_args(["-a", "x86_64", "package-remove", "ahriman"]) - assert args.architecture == ["x86_64"] + assert args.architecture == "x86_64" def test_subparsers_package_remove_option_repository(parser: argparse.ArgumentParser) -> None: @@ -287,7 +271,7 @@ def test_subparsers_package_remove_option_repository(parser: argparse.ArgumentPa args = parser.parse_args(["package-remove", "ahriman"]) assert args.repository is None args = parser.parse_args(["-r", "repo", "package-remove", "ahriman"]) - assert args.repository == ["repo"] + assert args.repository == "repo" def test_subparsers_package_status(parser: argparse.ArgumentParser) -> None: @@ -295,11 +279,11 @@ def test_subparsers_package_status(parser: argparse.ArgumentParser) -> None: package-status command must imply lock, quiet, report and unsafe """ args = parser.parse_args(["-a", "x86_64", "-r", "repo", "package-status"]) - assert args.architecture == ["x86_64"] + assert args.architecture == "x86_64" assert args.lock is None assert args.quiet assert not args.report - assert args.repository == ["repo"] + assert args.repository == "repo" assert args.unsafe @@ -308,12 +292,12 @@ def test_subparsers_package_status_remove(parser: argparse.ArgumentParser) -> No package-status-remove command must imply action, lock, quiet, report and unsafe """ args = parser.parse_args(["-a", "x86_64", "-r", "repo", "package-status-remove", "ahriman"]) - assert args.architecture == ["x86_64"] + assert args.architecture == "x86_64" assert args.action == Action.Remove assert args.lock is None assert args.quiet assert not args.report - assert args.repository == ["repo"] + assert args.repository == "repo" assert args.unsafe @@ -322,12 +306,12 @@ def test_subparsers_package_status_update(parser: argparse.ArgumentParser) -> No package-status-update command must imply action, lock, quiet, report and unsafe """ args = parser.parse_args(["-a", "x86_64", "-r", "repo", "package-status-update"]) - assert args.architecture == ["x86_64"] + assert args.architecture == "x86_64" assert args.action == Action.Update assert args.lock is None assert args.quiet assert not args.report - assert args.repository == ["repo"] + assert args.repository == "repo" assert args.unsafe @@ -347,10 +331,10 @@ def test_subparsers_patch_add(parser: argparse.ArgumentParser) -> None: """ args = parser.parse_args(["patch-add", "ahriman", "version"]) assert args.action == Action.Update - assert args.architecture == [""] + assert args.architecture == "" assert args.lock is None assert not args.report - assert args.repository == [""] + assert args.repository == "" def test_subparsers_patch_add_option_architecture(parser: argparse.ArgumentParser) -> None: @@ -358,7 +342,7 @@ def test_subparsers_patch_add_option_architecture(parser: argparse.ArgumentParse patch-add command must correctly parse architecture list """ args = parser.parse_args(["-a", "x86_64", "patch-add", "ahriman", "version"]) - assert args.architecture == [""] + assert args.architecture == "" def test_subparsers_patch_add_option_repository(parser: argparse.ArgumentParser) -> None: @@ -366,7 +350,7 @@ def test_subparsers_patch_add_option_repository(parser: argparse.ArgumentParser) patch-add command must correctly parse repository list """ args = parser.parse_args(["-r", "repo", "patch-add", "ahriman", "version"]) - assert args.repository == [""] + assert args.repository == "" def test_subparsers_patch_list(parser: argparse.ArgumentParser) -> None: @@ -375,10 +359,10 @@ def test_subparsers_patch_list(parser: argparse.ArgumentParser) -> None: """ args = parser.parse_args(["patch-list", "ahriman"]) assert args.action == Action.List - assert args.architecture == [""] + assert args.architecture == "" assert args.lock is None assert not args.report - assert args.repository == [""] + assert args.repository == "" assert args.unsafe @@ -387,7 +371,7 @@ def test_subparsers_patch_list_option_architecture(parser: argparse.ArgumentPars patch-list command must correctly parse architecture list """ args = parser.parse_args(["-a", "x86_64", "patch-list", "ahriman"]) - assert args.architecture == [""] + assert args.architecture == "" def test_subparsers_patch_list_option_repository(parser: argparse.ArgumentParser) -> None: @@ -395,7 +379,7 @@ def test_subparsers_patch_list_option_repository(parser: argparse.ArgumentParser patch-list command must correctly parse repository list """ args = parser.parse_args(["-r", "repo", "patch-list", "ahriman"]) - assert args.repository == [""] + assert args.repository == "" def test_subparsers_patch_list_option_variable_empty(parser: argparse.ArgumentParser) -> None: @@ -420,10 +404,10 @@ def test_subparsers_patch_remove(parser: argparse.ArgumentParser) -> None: """ args = parser.parse_args(["patch-remove", "ahriman"]) assert args.action == Action.Remove - assert args.architecture == [""] + assert args.architecture == "" assert args.lock is None assert not args.report - assert args.repository == [""] + assert args.repository == "" def test_subparsers_patch_remove_option_architecture(parser: argparse.ArgumentParser) -> None: @@ -431,7 +415,7 @@ def test_subparsers_patch_remove_option_architecture(parser: argparse.ArgumentPa patch-remove command must correctly parse architecture list """ args = parser.parse_args(["-a", "x86_64", "patch-remove", "ahriman"]) - assert args.architecture == [""] + assert args.architecture == "" def test_subparsers_patch_remove_option_repository(parser: argparse.ArgumentParser) -> None: @@ -439,7 +423,7 @@ def test_subparsers_patch_remove_option_repository(parser: argparse.ArgumentPars patch-remove command must correctly parse repository list """ args = parser.parse_args(["-r", "repo", "patch-remove", "ahriman"]) - assert args.repository == [""] + assert args.repository == "" def test_subparsers_patch_remove_option_variable_empty(parser: argparse.ArgumentParser) -> None: @@ -464,10 +448,10 @@ def test_subparsers_patch_set_add(parser: argparse.ArgumentParser) -> None: """ args = parser.parse_args(["patch-set-add", "ahriman"]) assert args.action == Action.Update - assert args.architecture == [""] + assert args.architecture == "" assert args.lock is None assert not args.report - assert args.repository == [""] + assert args.repository == "" assert args.variable is None @@ -476,7 +460,7 @@ def test_subparsers_patch_set_add_option_architecture(parser: argparse.ArgumentP patch-set-add command must correctly parse architecture list """ args = parser.parse_args(["-a", "x86_64", "patch-set-add", "ahriman"]) - assert args.architecture == [""] + assert args.architecture == "" def test_subparsers_patch_set_add_option_package(parser: argparse.ArgumentParser) -> None: @@ -492,7 +476,7 @@ def test_subparsers_patch_set_add_option_repository(parser: argparse.ArgumentPar patch-set-add command must correctly parse repository list """ args = parser.parse_args(["-r", "repo", "patch-set-add", "ahriman"]) - assert args.repository == [""] + assert args.repository == "" def test_subparsers_patch_set_add_option_track(parser: argparse.ArgumentParser) -> None: @@ -508,10 +492,10 @@ def test_subparsers_repo_backup(parser: argparse.ArgumentParser) -> None: repo-backup command must imply architecture list, lock, report, repository and unsafe """ args = parser.parse_args(["repo-backup", "output.zip"]) - assert args.architecture == [""] + assert args.architecture == "" assert args.lock is None assert not args.report - assert args.repository == [""] + assert args.repository == "" assert args.unsafe @@ -520,7 +504,7 @@ def test_subparsers_repo_backup_option_architecture(parser: argparse.ArgumentPar repo-backup command must correctly parse architecture list """ args = parser.parse_args(["-a", "x86_64", "repo-backup", "output.zip"]) - assert args.architecture == [""] + assert args.architecture == "" def test_subparsers_repo_backup_option_repository(parser: argparse.ArgumentParser) -> None: @@ -528,7 +512,7 @@ def test_subparsers_repo_backup_option_repository(parser: argparse.ArgumentParse repo-backup command must correctly parse repository list """ args = parser.parse_args(["-r", "repo", "repo-backup", "output.zip"]) - assert args.repository == [""] + assert args.repository == "" def test_subparsers_repo_check(parser: argparse.ArgumentParser) -> None: @@ -550,7 +534,7 @@ def test_subparsers_repo_check_option_architecture(parser: argparse.ArgumentPars args = parser.parse_args(["repo-check"]) assert args.architecture is None args = parser.parse_args(["-a", "x86_64", "repo-check"]) - assert args.architecture == ["x86_64"] + assert args.architecture == "x86_64" def test_subparsers_repo_check_option_repository(parser: argparse.ArgumentParser) -> None: @@ -560,7 +544,7 @@ def test_subparsers_repo_check_option_repository(parser: argparse.ArgumentParser args = parser.parse_args(["repo-check"]) assert args.repository is None args = parser.parse_args(["-r", "repo", "repo-check"]) - assert args.repository == ["repo"] + assert args.repository == "repo" def test_subparsers_repo_check_option_refresh(parser: argparse.ArgumentParser) -> None: @@ -590,7 +574,7 @@ def test_subparsers_repo_create_keyring_option_architecture(parser: argparse.Arg args = parser.parse_args(["repo-create-keyring"]) assert args.architecture is None args = parser.parse_args(["-a", "x86_64", "repo-create-keyring"]) - assert args.architecture == ["x86_64"] + assert args.architecture == "x86_64" def test_subparsers_repo_create_keyring_option_repository(parser: argparse.ArgumentParser) -> None: @@ -600,7 +584,7 @@ def test_subparsers_repo_create_keyring_option_repository(parser: argparse.Argum args = parser.parse_args(["repo-create-keyring"]) assert args.repository is None args = parser.parse_args(["-r", "repo", "repo-create-keyring"]) - assert args.repository == ["repo"] + assert args.repository == "repo" def test_subparsers_repo_create_mirrorlist(parser: argparse.ArgumentParser) -> None: @@ -618,7 +602,7 @@ def test_subparsers_repo_create_mirrorlist_option_architecture(parser: argparse. args = parser.parse_args(["repo-create-mirrorlist"]) assert args.architecture is None args = parser.parse_args(["-a", "x86_64", "repo-create-mirrorlist"]) - assert args.architecture == ["x86_64"] + assert args.architecture == "x86_64" def test_subparsers_repo_create_mirrorlist_option_repository(parser: argparse.ArgumentParser) -> None: @@ -628,7 +612,7 @@ def test_subparsers_repo_create_mirrorlist_option_repository(parser: argparse.Ar args = parser.parse_args(["repo-create-mirrorlist"]) assert args.repository is None args = parser.parse_args(["-r", "repo", "repo-create-mirrorlist"]) - assert args.repository == ["repo"] + assert args.repository == "repo" def test_subparsers_repo_daemon(parser: argparse.ArgumentParser) -> None: @@ -670,7 +654,7 @@ def test_subparsers_repo_rebuild_option_architecture(parser: argparse.ArgumentPa args = parser.parse_args(["repo-rebuild"]) assert args.architecture is None args = parser.parse_args(["-a", "x86_64", "repo-rebuild"]) - assert args.architecture == ["x86_64"] + assert args.architecture == "x86_64" def test_subparsers_repo_rebuild_option_repository(parser: argparse.ArgumentParser) -> None: @@ -680,7 +664,7 @@ def test_subparsers_repo_rebuild_option_repository(parser: argparse.ArgumentPars args = parser.parse_args(["repo-rebuild"]) assert args.repository is None args = parser.parse_args(["-r", "repo", "repo-rebuild"]) - assert args.repository == ["repo"] + assert args.repository == "repo" def test_subparsers_repo_rebuild_option_depends_on_empty(parser: argparse.ArgumentParser) -> None: @@ -714,7 +698,7 @@ def test_subparsers_repo_remove_unknown_option_architecture(parser: argparse.Arg args = parser.parse_args(["repo-remove-unknown"]) assert args.architecture is None args = parser.parse_args(["-a", "x86_64", "repo-remove-unknown"]) - assert args.architecture == ["x86_64"] + assert args.architecture == "x86_64" def test_subparsers_repo_remove_unknown_option_repository(parser: argparse.ArgumentParser) -> None: @@ -724,7 +708,7 @@ def test_subparsers_repo_remove_unknown_option_repository(parser: argparse.Argum args = parser.parse_args(["repo-remove-unknown"]) assert args.repository is None args = parser.parse_args(["-r", "repo", "repo-remove-unknown"]) - assert args.repository == ["repo"] + assert args.repository == "repo" def test_subparsers_repo_report(parser: argparse.ArgumentParser) -> None: @@ -742,7 +726,7 @@ def test_subparsers_repo_report_option_architecture(parser: argparse.ArgumentPar args = parser.parse_args(["repo-report"]) assert args.architecture is None args = parser.parse_args(["-a", "x86_64", "repo-report"]) - assert args.architecture == ["x86_64"] + assert args.architecture == "x86_64" def test_subparsers_repo_report_option_repository(parser: argparse.ArgumentParser) -> None: @@ -752,7 +736,7 @@ def test_subparsers_repo_report_option_repository(parser: argparse.ArgumentParse args = parser.parse_args(["repo-report"]) assert args.repository is None args = parser.parse_args(["-r", "repo", "repo-report"]) - assert args.repository == ["repo"] + assert args.repository == "repo" def test_subparsers_repo_restore(parser: argparse.ArgumentParser) -> None: @@ -760,10 +744,10 @@ def test_subparsers_repo_restore(parser: argparse.ArgumentParser) -> None: repo-restore command must imply architecture list, lock, report, repository and unsafe """ args = parser.parse_args(["repo-restore", "output.zip"]) - assert args.architecture == [""] + assert args.architecture == "" assert args.lock is None assert not args.report - assert args.repository == [""] + assert args.repository == "" assert args.unsafe @@ -772,7 +756,7 @@ def test_subparsers_repo_restore_option_architecture(parser: argparse.ArgumentPa repo-restore command must correctly parse architecture list """ args = parser.parse_args(["-a", "x86_64", "repo-restore", "output.zip"]) - assert args.architecture == [""] + assert args.architecture == "" def test_subparsers_repo_restore_option_repository(parser: argparse.ArgumentParser) -> None: @@ -780,7 +764,7 @@ def test_subparsers_repo_restore_option_repository(parser: argparse.ArgumentPars repo-restore command must correctly parse repository list """ args = parser.parse_args(["-r", "repo", "repo-restore", "output.zip"]) - assert args.repository == [""] + assert args.repository == "" def test_subparsers_repo_sign_option_architecture(parser: argparse.ArgumentParser) -> None: @@ -790,7 +774,7 @@ def test_subparsers_repo_sign_option_architecture(parser: argparse.ArgumentParse args = parser.parse_args(["repo-sign"]) assert args.architecture is None args = parser.parse_args(["-a", "x86_64", "repo-sign"]) - assert args.architecture == ["x86_64"] + assert args.architecture == "x86_64" def test_subparsers_repo_sign_option_repository(parser: argparse.ArgumentParser) -> None: @@ -800,7 +784,7 @@ def test_subparsers_repo_sign_option_repository(parser: argparse.ArgumentParser) args = parser.parse_args(["repo-sign"]) assert args.repository is None args = parser.parse_args(["-r", "repo", "repo-sign"]) - assert args.repository == ["repo"] + assert args.repository == "repo" def test_subparsers_repo_status_update(parser: argparse.ArgumentParser) -> None: @@ -808,12 +792,12 @@ def test_subparsers_repo_status_update(parser: argparse.ArgumentParser) -> None: re[p-status-update command must imply action, lock, quiet, report, package and unsafe """ args = parser.parse_args(["-a", "x86_64", "-r", "repo", "package-status-update"]) - assert args.architecture == ["x86_64"] + assert args.architecture == "x86_64" assert args.action == Action.Update assert args.lock is None assert args.quiet assert not args.report - assert args.repository == ["repo"] + assert args.repository == "repo" assert not args.package assert args.unsafe @@ -843,7 +827,7 @@ def test_subparsers_repo_sync_option_architecture(parser: argparse.ArgumentParse args = parser.parse_args(["repo-sync"]) assert args.architecture is None args = parser.parse_args(["-a", "x86_64", "repo-sync"]) - assert args.architecture == ["x86_64"] + assert args.architecture == "x86_64" def test_subparsers_repo_sync_option_repository(parser: argparse.ArgumentParser) -> None: @@ -853,7 +837,7 @@ def test_subparsers_repo_sync_option_repository(parser: argparse.ArgumentParser) args = parser.parse_args(["repo-sync"]) assert args.repository is None args = parser.parse_args(["-r", "repo", "repo-sync"]) - assert args.repository == ["repo"] + assert args.repository == "repo" def test_subparsers_repo_tree(parser: argparse.ArgumentParser) -> None: @@ -874,7 +858,7 @@ def test_subparsers_repo_tree_option_architecture(parser: argparse.ArgumentParse args = parser.parse_args(["repo-tree"]) assert args.architecture is None args = parser.parse_args(["-a", "x86_64", "repo-tree"]) - assert args.architecture == ["x86_64"] + assert args.architecture == "x86_64" def test_subparsers_repo_tree_option_repository(parser: argparse.ArgumentParser) -> None: @@ -884,7 +868,7 @@ def test_subparsers_repo_tree_option_repository(parser: argparse.ArgumentParser) args = parser.parse_args(["repo-tree"]) assert args.repository is None args = parser.parse_args(["-r", "repo", "repo-tree"]) - assert args.repository == ["repo"] + assert args.repository == "repo" def test_subparsers_repo_tree_option_partitions(parser: argparse.ArgumentParser) -> None: @@ -904,7 +888,7 @@ def test_subparsers_repo_triggers_option_architecture(parser: argparse.ArgumentP args = parser.parse_args(["repo-triggers"]) assert args.architecture is None args = parser.parse_args(["-a", "x86_64", "repo-triggers"]) - assert args.architecture == ["x86_64"] + assert args.architecture == "x86_64" def test_subparsers_repo_triggers_option_repository(parser: argparse.ArgumentParser) -> None: @@ -914,7 +898,7 @@ def test_subparsers_repo_triggers_option_repository(parser: argparse.ArgumentPar args = parser.parse_args(["repo-triggers"]) assert args.repository is None args = parser.parse_args(["-r", "repo", "repo-triggers"]) - assert args.repository == ["repo"] + assert args.repository == "repo" def test_subparsers_repo_update_option_architecture(parser: argparse.ArgumentParser) -> None: @@ -924,7 +908,7 @@ def test_subparsers_repo_update_option_architecture(parser: argparse.ArgumentPar args = parser.parse_args(["repo-update"]) assert args.architecture is None args = parser.parse_args(["-a", "x86_64", "repo-update"]) - assert args.architecture == ["x86_64"] + assert args.architecture == "x86_64" def test_subparsers_repo_update_option_repository(parser: argparse.ArgumentParser) -> None: @@ -934,7 +918,7 @@ def test_subparsers_repo_update_option_repository(parser: argparse.ArgumentParse args = parser.parse_args(["repo-update"]) assert args.repository is None args = parser.parse_args(["-r", "repo", "repo-update"]) - assert args.repository == ["repo"] + assert args.repository == "repo" def test_subparsers_repo_update_option_refresh(parser: argparse.ArgumentParser) -> None: @@ -965,7 +949,7 @@ def test_subparsers_service_clean_option_architecture(parser: argparse.ArgumentP args = parser.parse_args(["service-clean"]) assert args.architecture is None args = parser.parse_args(["-a", "x86_64", "service-clean"]) - assert args.architecture == ["x86_64"] + assert args.architecture == "x86_64" def test_subparsers_service_clean_option_repository(parser: argparse.ArgumentParser) -> None: @@ -975,7 +959,7 @@ def test_subparsers_service_clean_option_repository(parser: argparse.ArgumentPar args = parser.parse_args(["service-clean"]) assert args.repository is None args = parser.parse_args(["-r", "repo", "service-clean"]) - assert args.repository == ["repo"] + assert args.repository == "repo" def test_subparsers_service_config(parser: argparse.ArgumentParser) -> None: @@ -983,24 +967,41 @@ def test_subparsers_service_config(parser: argparse.ArgumentParser) -> None: service-config command must imply lock, quiet, report and unsafe """ args = parser.parse_args(["-a", "x86_64", "-r", "repo", "service-config"]) - assert args.architecture == ["x86_64"] + assert args.architecture == "x86_64" assert args.lock is None assert args.quiet assert not args.report - assert args.repository == ["repo"] + assert args.repository == "repo" assert args.unsafe +def test_subparsers_service_config_option_section_key(parser: argparse.ArgumentParser) -> None: + """ + service-config command must parse optional section and key arguments + """ + args = parser.parse_args(["-a", "x86_64", "-r", "repo", "service-config"]) + assert args.section is None + assert args.key is None + + args = parser.parse_args(["-a", "x86_64", "-r", "repo", "service-config", "section"]) + assert args.section == "section" + assert args.key is None + + args = parser.parse_args(["-a", "x86_64", "-r", "repo", "service-config", "section", "key"]) + assert args.section == "section" + assert args.key == "key" + + def test_subparsers_service_config_validate(parser: argparse.ArgumentParser) -> None: """ service-config-validate command must imply lock, quiet, report and unsafe """ args = parser.parse_args(["-a", "x86_64", "-r", "repo", "service-config-validate"]) - assert args.architecture == ["x86_64"] + assert args.architecture == "x86_64" assert args.lock is None assert args.quiet assert not args.report - assert args.repository == ["repo"] + assert args.repository == "repo" assert args.unsafe @@ -1009,10 +1010,10 @@ def test_subparsers_service_key_import(parser: argparse.ArgumentParser) -> None: service-key-import command must imply architecture list, lock, report and repository """ args = parser.parse_args(["service-key-import", "key"]) - assert args.architecture == [""] + assert args.architecture == "" assert args.lock is None assert not args.report - assert args.repository == [""] + assert args.repository == "" def test_subparsers_service_key_import_option_architecture(parser: argparse.ArgumentParser) -> None: @@ -1020,7 +1021,7 @@ def test_subparsers_service_key_import_option_architecture(parser: argparse.Argu service-key-import command must correctly parse architecture list """ args = parser.parse_args(["-a", "x86_64", "service-key-import", "key"]) - assert args.architecture == [""] + assert args.architecture == "" def test_subparsers_service_key_import_option_repository(parser: argparse.ArgumentParser) -> None: @@ -1028,7 +1029,35 @@ def test_subparsers_service_key_import_option_repository(parser: argparse.Argume service-key-import command must correctly parse repository list """ args = parser.parse_args(["-r", "repo", "service-key-import", "key"]) - assert args.repository == [""] + assert args.repository == "" + + +def test_subparsers_service_repositories(parser: argparse.ArgumentParser) -> None: + """ + service-repositories command must imply architecture, lock, report, repository and unsafe + """ + args = parser.parse_args(["service-repositories"]) + assert args.architecture == "" + assert args.lock is None + assert not args.report + assert args.repository == "" + assert args.unsafe + + +def test_subparsers_service_repositories_option_architecture(parser: argparse.ArgumentParser) -> None: + """ + service-repositories command must correctly parse architecture list + """ + args = parser.parse_args(["-a", "x86_64", "service-repositories"]) + assert args.architecture == "" + + +def test_subparsers_service_repositories_option_repository(parser: argparse.ArgumentParser) -> None: + """ + service-repositories command must correctly parse repository list + """ + args = parser.parse_args(["-r", "repo", "service-repositories"]) + assert args.repository == "" def test_subparsers_service_setup(parser: argparse.ArgumentParser) -> None: @@ -1036,11 +1065,11 @@ def test_subparsers_service_setup(parser: argparse.ArgumentParser) -> None: service-setup command must imply lock, quiet, report and unsafe """ args = parser.parse_args(["-a", "x86_64", "-r", "repo", "service-setup", "--packager", "John Doe "]) - assert args.architecture == ["x86_64"] + assert args.architecture == "x86_64" assert args.lock is None assert args.quiet assert not args.report - assert args.repository == ["repo"] + assert args.repository == "repo" assert args.unsafe @@ -1107,11 +1136,11 @@ def test_subparsers_user_add(parser: argparse.ArgumentParser) -> None: """ args = parser.parse_args(["user-add", "username"]) assert args.action == Action.Update - assert args.architecture == [""] + assert args.architecture == "" assert args.lock is None assert args.quiet assert not args.report - assert args.repository == [""] + assert args.repository == "" def test_subparsers_user_add_option_architecture(parser: argparse.ArgumentParser) -> None: @@ -1119,7 +1148,7 @@ def test_subparsers_user_add_option_architecture(parser: argparse.ArgumentParser user-add command must correctly parse architecture list """ args = parser.parse_args(["-a", "x86_64", "user-add", "username"]) - assert args.architecture == [""] + assert args.architecture == "" def test_subparsers_user_add_option_repository(parser: argparse.ArgumentParser) -> None: @@ -1127,7 +1156,7 @@ def test_subparsers_user_add_option_repository(parser: argparse.ArgumentParser) user-add command must correctly parse repository list """ args = parser.parse_args(["-r", "repo", "user-add", "username"]) - assert args.repository == [""] + assert args.repository == "" def test_subparsers_user_add_option_role(parser: argparse.ArgumentParser) -> None: @@ -1146,11 +1175,11 @@ def test_subparsers_user_list(parser: argparse.ArgumentParser) -> None: """ args = parser.parse_args(["user-list"]) assert args.action == Action.List - assert args.architecture == [""] + assert args.architecture == "" assert args.lock is None assert args.quiet assert not args.report - assert args.repository == [""] + assert args.repository == "" assert args.unsafe @@ -1159,7 +1188,7 @@ def test_subparsers_user_list_option_architecture(parser: argparse.ArgumentParse user-list command must correctly parse architecture list """ args = parser.parse_args(["-a", "x86_64", "user-list"]) - assert args.architecture == [""] + assert args.architecture == "" def test_subparsers_user_list_option_repository(parser: argparse.ArgumentParser) -> None: @@ -1167,7 +1196,7 @@ def test_subparsers_user_list_option_repository(parser: argparse.ArgumentParser) user-list command must correctly parse repository list """ args = parser.parse_args(["-r", "repo", "user-list"]) - assert args.repository == [""] + assert args.repository == "" def test_subparsers_user_list_option_role(parser: argparse.ArgumentParser) -> None: @@ -1184,11 +1213,11 @@ def test_subparsers_user_remove(parser: argparse.ArgumentParser) -> None: """ args = parser.parse_args(["user-remove", "username"]) assert args.action == Action.Remove - assert args.architecture == [""] + assert args.architecture == "" assert args.lock is None assert args.quiet assert not args.report - assert args.repository == [""] + assert args.repository == "" def test_subparsers_user_remove_option_architecture(parser: argparse.ArgumentParser) -> None: @@ -1196,7 +1225,7 @@ def test_subparsers_user_remove_option_architecture(parser: argparse.ArgumentPar user-remove command must correctly parse architecture list """ args = parser.parse_args(["-a", "x86_64", "user-remove", "username"]) - assert args.architecture == [""] + assert args.architecture == "" def test_subparsers_user_remove_option_repository(parser: argparse.ArgumentParser) -> None: @@ -1204,20 +1233,36 @@ def test_subparsers_user_remove_option_repository(parser: argparse.ArgumentParse user-remove command must correctly parse repository list """ args = parser.parse_args(["-r", "repo", "user-remove", "username"]) - assert args.repository == [""] + assert args.repository == "" def test_subparsers_web(parser: argparse.ArgumentParser) -> None: """ - web command must imply report and parser + web command must imply architecture, report, repository and parser """ - args = parser.parse_args(["-a", "x86_64", "-r", "repo", "web"]) - assert args.architecture == ["x86_64"] + args = parser.parse_args(["web"]) + assert args.architecture == "" assert not args.report - assert args.repository == ["repo"] + assert args.repository == "" assert args.parser is not None and args.parser() +def test_subparsers_web_option_architecture(parser: argparse.ArgumentParser) -> None: + """ + web command must correctly parse architecture list + """ + args = parser.parse_args(["-a", "x86_64", "web"]) + assert args.architecture == "" + + +def test_subparsers_web_option_repository(parser: argparse.ArgumentParser) -> None: + """ + web command must correctly parse repository list + """ + args = parser.parse_args(["-r", "repo", "web"]) + assert args.repository == "" + + def test_run(args: argparse.Namespace, configuration: Configuration, mocker: MockerFixture) -> None: """ application must be run diff --git a/tests/ahriman/application/test_lock.py b/tests/ahriman/application/test_lock.py index 23851685..1f787c4d 100644 --- a/tests/ahriman/application/test_lock.py +++ b/tests/ahriman/application/test_lock.py @@ -23,7 +23,7 @@ def test_path(args: argparse.Namespace, configuration: Configuration) -> None: assert Lock(args, repository_id, configuration).path is None args.lock = Path("/run/ahriman.lock") - assert Lock(args, repository_id, configuration).path == Path("/run/ahriman_aur-clone_x86_64.lock") + assert Lock(args, repository_id, configuration).path == Path("/run/ahriman_x86_64-aur-clone.lock") with pytest.raises(ValueError): args.lock = Path("/") diff --git a/tests/ahriman/conftest.py b/tests/ahriman/conftest.py index 7a91d465..b6037f5a 100644 --- a/tests/ahriman/conftest.py +++ b/tests/ahriman/conftest.py @@ -541,10 +541,7 @@ def spawner(configuration: Configuration) -> Spawn: Returns: Spawn: spawner fixture """ - _, repository_id = configuration.check_loaded() - return Spawn(MagicMock(), repository_id, [ - "--architecture", "x86_64", - "--repository", repository_id.name, + return Spawn(MagicMock(), [ "--configuration", str(configuration.path), ]) @@ -561,19 +558,15 @@ def user() -> User: @pytest.fixture -def watcher(configuration: Configuration, database: SQLite, repository: Repository, mocker: MockerFixture) -> Watcher: +def watcher(repository_id: RepositoryId, database: SQLite, repository: Repository) -> Watcher: """ package status watcher fixture Args: - configuration(Configuration): configuration fixture + repository_id(RepositoryId): repository identifier fixture database(SQLite): database fixture - repository(Repository): repository fixture - mocker(MockerFixture): mocker object Returns: Watcher: package status watcher test instance """ - mocker.patch("ahriman.core.repository.Repository.load", return_value=repository) - _, repository_id = configuration.check_loaded() - return Watcher(repository_id, configuration, database) + return Watcher(repository_id, database) diff --git a/tests/ahriman/core/alpm/remote/test_aur.py b/tests/ahriman/core/alpm/remote/test_aur.py index fc3b76a7..55282ae7 100644 --- a/tests/ahriman/core/alpm/remote/test_aur.py +++ b/tests/ahriman/core/alpm/remote/test_aur.py @@ -6,7 +6,6 @@ from pathlib import Path from pytest_mock import MockerFixture from unittest.mock import MagicMock -from ahriman.core.alpm.pacman import Pacman from ahriman.core.alpm.remote import AUR from ahriman.core.exceptions import PackageInfoError, UnknownPackageError from ahriman.models.aur_package import AURPackage @@ -129,29 +128,28 @@ def test_aur_request_failed_http_error(aur: AUR, mocker: MockerFixture) -> None: aur.aur_request("info", "ahriman") -def test_package_info(aur: AUR, aur_package_ahriman: AURPackage, pacman: Pacman, mocker: MockerFixture) -> None: +def test_package_info(aur: AUR, aur_package_ahriman: AURPackage, mocker: MockerFixture) -> None: """ must make request for info """ request_mock = mocker.patch("ahriman.core.alpm.remote.AUR.aur_request", return_value=[aur_package_ahriman]) - assert aur.package_info(aur_package_ahriman.name, pacman=pacman) == aur_package_ahriman + assert aur.package_info(aur_package_ahriman.name, pacman=None) == aur_package_ahriman request_mock.assert_called_once_with("info", aur_package_ahriman.name) -def test_package_info_not_found(aur: AUR, aur_package_ahriman: AURPackage, pacman: Pacman, - mocker: MockerFixture) -> None: +def test_package_info_not_found(aur: AUR, aur_package_ahriman: AURPackage, mocker: MockerFixture) -> None: """ must raise UnknownPackage exception in case if no package was found """ mocker.patch("ahriman.core.alpm.remote.AUR.aur_request", return_value=[]) with pytest.raises(UnknownPackageError, match=aur_package_ahriman.name): - assert aur.package_info(aur_package_ahriman.name, pacman=pacman) + assert aur.package_info(aur_package_ahriman.name, pacman=None) -def test_package_search(aur: AUR, aur_package_ahriman: AURPackage, pacman: Pacman, mocker: MockerFixture) -> None: +def test_package_search(aur: AUR, aur_package_ahriman: AURPackage, mocker: MockerFixture) -> None: """ must make request for search """ request_mock = mocker.patch("ahriman.core.alpm.remote.AUR.aur_request", return_value=[aur_package_ahriman]) - assert aur.package_search(aur_package_ahriman.name, pacman=pacman) == [aur_package_ahriman] + assert aur.package_search(aur_package_ahriman.name, pacman=None) == [aur_package_ahriman] request_mock.assert_called_once_with("search", aur_package_ahriman.name, by="name-desc") diff --git a/tests/ahriman/core/alpm/remote/test_official.py b/tests/ahriman/core/alpm/remote/test_official.py index 23a23d91..bb178377 100644 --- a/tests/ahriman/core/alpm/remote/test_official.py +++ b/tests/ahriman/core/alpm/remote/test_official.py @@ -6,7 +6,6 @@ from pathlib import Path from pytest_mock import MockerFixture from unittest.mock import MagicMock -from ahriman.core.alpm.pacman import Pacman from ahriman.core.alpm.remote import Official from ahriman.core.exceptions import PackageInfoError, UnknownPackageError from ahriman.models.aur_package import AURPackage @@ -95,33 +94,30 @@ def test_arch_request_failed_http_error(official: Official, mocker: MockerFixtur official.arch_request("akonadi", by="q") -def test_package_info(official: Official, aur_package_akonadi: AURPackage, pacman: Pacman, - mocker: MockerFixture) -> None: +def test_package_info(official: Official, aur_package_akonadi: AURPackage, mocker: MockerFixture) -> None: """ must make request for info """ request_mock = mocker.patch("ahriman.core.alpm.remote.Official.arch_request", return_value=[aur_package_akonadi]) - assert official.package_info(aur_package_akonadi.name, pacman=pacman) == aur_package_akonadi + assert official.package_info(aur_package_akonadi.name, pacman=None) == aur_package_akonadi request_mock.assert_called_once_with(aur_package_akonadi.name, by="name") -def test_package_info_not_found(official: Official, aur_package_ahriman: AURPackage, pacman: Pacman, - mocker: MockerFixture) -> None: +def test_package_info_not_found(official: Official, aur_package_ahriman: AURPackage, mocker: MockerFixture) -> None: """ must raise UnknownPackage exception in case if no package was found """ mocker.patch("ahriman.core.alpm.remote.Official.arch_request", return_value=[]) with pytest.raises(UnknownPackageError, match=aur_package_ahriman.name): - assert official.package_info(aur_package_ahriman.name, pacman=pacman) + assert official.package_info(aur_package_ahriman.name, pacman=None) -def test_package_search(official: Official, aur_package_akonadi: AURPackage, pacman: Pacman, - mocker: MockerFixture) -> None: +def test_package_search(official: Official, aur_package_akonadi: AURPackage, mocker: MockerFixture) -> None: """ must make request for search """ request_mock = mocker.patch("ahriman.core.alpm.remote.Official.arch_request", return_value=[aur_package_akonadi]) - assert official.package_search(aur_package_akonadi.name, pacman=pacman) == [aur_package_akonadi] + assert official.package_search(aur_package_akonadi.name, pacman=None) == [aur_package_akonadi] request_mock.assert_called_once_with(aur_package_akonadi.name, by="q") diff --git a/tests/ahriman/core/alpm/remote/test_official_syncdb.py b/tests/ahriman/core/alpm/remote/test_official_syncdb.py index 26244d6f..e293c360 100644 --- a/tests/ahriman/core/alpm/remote/test_official_syncdb.py +++ b/tests/ahriman/core/alpm/remote/test_official_syncdb.py @@ -21,6 +21,17 @@ def test_package_info(official_syncdb: OfficialSyncdb, aur_package_akonadi: AURP assert package == aur_package_akonadi +def test_package_info_no_pacman(official_syncdb: OfficialSyncdb, aur_package_akonadi: AURPackage, + mocker: MockerFixture) -> None: + """ + must raise UnknownPackageError if no pacman set + """ + mocker.patch("ahriman.core.alpm.pacman.Pacman.package_get", return_value=[aur_package_akonadi]) + + with pytest.raises(UnknownPackageError, match=aur_package_akonadi.name): + official_syncdb.package_info(aur_package_akonadi.name, pacman=None) + + def test_package_info_not_found(official_syncdb: OfficialSyncdb, aur_package_akonadi: AURPackage, pacman: Pacman, mocker: MockerFixture) -> None: """ diff --git a/tests/ahriman/core/configuration/test_configuration.py b/tests/ahriman/core/configuration/test_configuration.py index d5b207cf..777d5c1b 100644 --- a/tests/ahriman/core/configuration/test_configuration.py +++ b/tests/ahriman/core/configuration/test_configuration.py @@ -37,6 +37,7 @@ def test_from_path(repository_id: RepositoryId, mocker: MockerFixture) -> None: must load configuration """ mocker.patch("pathlib.Path.is_file", return_value=True) + mocker.patch("ahriman.core.configuration.Configuration.get", return_value="ahriman.ini.d") read_mock = mocker.patch("ahriman.core.configuration.Configuration.read") load_includes_mock = mocker.patch("ahriman.core.configuration.Configuration.load_includes") path = Path("path") @@ -53,6 +54,7 @@ def test_from_path_file_missing(repository_id: RepositoryId, mocker: MockerFixtu """ mocker.patch("pathlib.Path.is_file", return_value=False) mocker.patch("ahriman.core.configuration.Configuration.load_includes") + mocker.patch("ahriman.core.configuration.Configuration.get", return_value="ahriman.ini.d") read_mock = mocker.patch("ahriman.core.configuration.Configuration.read") configuration = Configuration.from_path(Path("path"), repository_id) @@ -288,30 +290,58 @@ def test_gettype_from_section_no_section(configuration: Configuration) -> None: configuration.gettype("rsync:x86_64", configuration.repository_id) -def test_load_includes_missing(configuration: Configuration) -> None: +def test_load_includes(mocker: MockerFixture) -> None: + """ + must load includes + """ + mocker.patch.object(Configuration, "logging_path", Path("logging")) + read_mock = mocker.patch("ahriman.core.configuration.Configuration.read") + glob_mock = mocker.patch("pathlib.Path.glob", autospec=True, return_value=[Path("include"), Path("logging")]) + configuration = Configuration() + + configuration.load_includes(Path("path")) + glob_mock.assert_called_once_with(Path("path"), "*.ini") + read_mock.assert_called_once_with(Path("include")) + assert configuration.includes == [Path("include")] + + +def test_load_includes_missing() -> None: """ must not fail if not include directory found """ + configuration = Configuration() configuration.set_option("settings", "include", "path") configuration.load_includes() -def test_load_includes_no_option(configuration: Configuration) -> None: +def test_load_includes_no_option() -> None: """ must not fail if no option set """ - configuration.remove_option("settings", "include") + configuration = Configuration() + configuration.set_option("settings", "key", "value") configuration.load_includes() -def test_load_includes_no_section(configuration: Configuration) -> None: +def test_load_includes_no_section() -> None: """ must not fail if no section set """ - configuration.remove_section("settings") + configuration = Configuration() configuration.load_includes() +def test_load_includes_default_path(mocker: MockerFixture) -> None: + """ + must load includes from default path + """ + mocker.patch.object(Configuration, "include", Path("path")) + glob_mock = mocker.patch("pathlib.Path.glob", autospec=True, return_value=[]) + + Configuration().load_includes() + glob_mock.assert_called_once_with(Path("path"), "*.ini") + + def test_merge_sections_missing(configuration: Configuration) -> None: """ must merge create section if not exists diff --git a/tests/ahriman/core/database/operations/test_build_operations.py b/tests/ahriman/core/database/operations/test_build_operations.py index e155d379..185831f3 100644 --- a/tests/ahriman/core/database/operations/test_build_operations.py +++ b/tests/ahriman/core/database/operations/test_build_operations.py @@ -19,11 +19,11 @@ def test_build_queue_insert_clear_multi(database: SQLite, package_ahriman: Packa must clear all packages from queue for specific repository """ database.build_queue_insert(package_ahriman) - database.repository_id = RepositoryId("i686", database.repository_id.name) + database._repository_id = RepositoryId("i686", database._repository_id.name) database.build_queue_insert(package_ahriman) database.build_queue_clear(None) - database.repository_id = RepositoryId("x86_64", database.repository_id.name) + database._repository_id = RepositoryId("x86_64", database._repository_id.name) assert database.build_queue_get() == [package_ahriman] @@ -68,19 +68,19 @@ def test_build_queue_insert_multi(database: SQLite, package_ahriman: Package) -> assert database.build_queue_get() == [package_ahriman] package_ahriman.version = "2" - database.repository_id = RepositoryId("i686", database.repository_id.name) + database._repository_id = RepositoryId("i686", database._repository_id.name) database.build_queue_insert(package_ahriman) assert database.build_queue_get() == [package_ahriman] package_ahriman.version = "1" - database.repository_id = RepositoryId("x86_64", database.repository_id.name) + database._repository_id = RepositoryId("x86_64", database._repository_id.name) assert database.build_queue_get() == [package_ahriman] package_ahriman.version = "3" - database.repository_id = RepositoryId(database.repository_id.architecture, "repo") + database._repository_id = RepositoryId(database._repository_id.architecture, "repo") database.build_queue_insert(package_ahriman) assert database.build_queue_get() == [package_ahriman] package_ahriman.version = "1" - database.repository_id = RepositoryId(database.repository_id.architecture, "aur-clone") + database._repository_id = RepositoryId(database._repository_id.architecture, "aur-clone") assert database.build_queue_get() == [package_ahriman] diff --git a/tests/ahriman/core/database/operations/test_logs_operations.py b/tests/ahriman/core/database/operations/test_logs_operations.py index 984af42b..c05809e1 100644 --- a/tests/ahriman/core/database/operations/test_logs_operations.py +++ b/tests/ahriman/core/database/operations/test_logs_operations.py @@ -23,12 +23,11 @@ def test_logs_insert_remove_multi(database: SQLite, package_ahriman: Package) -> must clear logs for specified repository """ database.logs_insert(LogRecordId(package_ahriman.base, "1"), 42.0, "message 1") - database.repository_id = RepositoryId("i686", database.repository_id.name) - database.logs_insert(LogRecordId(package_ahriman.base, "1"), 43.0, "message 2") + database.logs_insert(LogRecordId(package_ahriman.base, "1"), 43.0, "message 2", + RepositoryId("i686", database._repository_id.name)) - database.logs_remove(package_ahriman.base, None) - assert not database.logs_get(package_ahriman.base) - database.repository_id = RepositoryId("x86_64", database.repository_id.name) + database.logs_remove(package_ahriman.base, None, RepositoryId("i686", database._repository_id.name)) + assert not database.logs_get(package_ahriman.base, repository_id=RepositoryId("i686", database._repository_id.name)) assert database.logs_get(package_ahriman.base) == [(42.0, "message 1")] @@ -68,9 +67,9 @@ def test_logs_insert_get_multi(database: SQLite, package_ahriman: Package) -> No must insert and get package logs for multiple repositories """ database.logs_insert(LogRecordId(package_ahriman.base, "1"), 42.0, "message 1") - database.repository_id = RepositoryId("i686", database.repository_id.name) - database.logs_insert(LogRecordId(package_ahriman.base, "1"), 43.0, "message 2") + database.logs_insert(LogRecordId(package_ahriman.base, "1"), 43.0, "message 2", + RepositoryId("i686", database._repository_id.name)) - assert database.logs_get(package_ahriman.base) == [(43.0, "message 2")] - database.repository_id = RepositoryId("x86_64", database.repository_id.name) + assert database.logs_get(package_ahriman.base, + repository_id=RepositoryId("i686", database._repository_id.name)) == [(43.0, "message 2")] assert database.logs_get(package_ahriman.base) == [(42.0, "message 1")] diff --git a/tests/ahriman/core/database/operations/test_package_operations.py b/tests/ahriman/core/database/operations/test_package_operations.py index b2ac37fb..e953f59d 100644 --- a/tests/ahriman/core/database/operations/test_package_operations.py +++ b/tests/ahriman/core/database/operations/test_package_operations.py @@ -15,10 +15,10 @@ def test_package_remove_package_base(database: SQLite, connection: Connection) - """ must remove package base """ - database._package_remove_package_base(connection, "package") + database._package_remove_package_base(connection, "package", database._repository_id) args = { "package_base": "package", - "repository": database.repository_id.id, + "repository": database._repository_id.id, } connection.execute.assert_has_calls([ MockCall(pytest.helpers.anyvar(str, strict=True), args), @@ -30,11 +30,12 @@ def test_package_remove_packages(database: SQLite, connection: Connection, packa """ must remove packages belong to base """ - database._package_remove_packages(connection, package_ahriman.base, package_ahriman.packages.keys()) + database._package_remove_packages(connection, package_ahriman.base, package_ahriman.packages.keys(), + database._repository_id) connection.execute.assert_called_once_with( pytest.helpers.anyvar(str, strict=True), { "package_base": package_ahriman.base, - "repository": database.repository_id.id, + "repository": database._repository_id.id, }) connection.executemany.assert_called_once_with(pytest.helpers.anyvar(str, strict=True), []) @@ -43,7 +44,7 @@ def test_package_update_insert_base(database: SQLite, connection: Connection, pa """ must insert base package """ - database._package_update_insert_base(connection, package_ahriman) + database._package_update_insert_base(connection, package_ahriman, database._repository_id) connection.execute.assert_called_once_with(pytest.helpers.anyvar(str, strict=True), pytest.helpers.anyvar(int)) @@ -51,7 +52,7 @@ def test_package_update_insert_packages(database: SQLite, connection: Connection """ must insert single packages """ - database._package_update_insert_packages(connection, package_ahriman) + database._package_update_insert_packages(connection, package_ahriman, database._repository_id) connection.executemany(pytest.helpers.anyvar(str, strict=True), pytest.helpers.anyvar(int)) @@ -61,7 +62,7 @@ def test_package_update_insert_packages_no_arch(database: SQLite, connection: Co must skip package insertion if no package architecture set """ package_ahriman.packages[package_ahriman.base].architecture = None - database._package_update_insert_packages(connection, package_ahriman) + database._package_update_insert_packages(connection, package_ahriman, database._repository_id) connection.executemany(pytest.helpers.anyvar(str, strict=True), []) @@ -69,7 +70,7 @@ def test_package_update_insert_status(database: SQLite, connection: Connection, """ must insert single package status """ - database._package_update_insert_status(connection, package_ahriman.base, BuildStatus()) + database._package_update_insert_status(connection, package_ahriman.base, BuildStatus(), database._repository_id) connection.execute(pytest.helpers.anyvar(str, strict=True), pytest.helpers.anyvar(int)) @@ -77,7 +78,7 @@ def test_packages_get_select_package_bases(database: SQLite, connection: Connect """ must select all bases """ - database._packages_get_select_package_bases(connection) + database._packages_get_select_package_bases(connection, database._repository_id) connection.execute(pytest.helpers.anyvar(str, strict=True)) @@ -85,7 +86,8 @@ def test_packages_get_select_packages(database: SQLite, connection: Connection, """ must select all packages """ - database._packages_get_select_packages(connection, {package_ahriman.base: package_ahriman}) + database._packages_get_select_packages(connection, {package_ahriman.base: package_ahriman}, + database._repository_id) connection.execute(pytest.helpers.anyvar(str, strict=True)) @@ -99,14 +101,15 @@ def test_packages_get_select_packages_skip(database: SQLite, connection: Connect view.update(properties.view()) connection.execute.return_value = [{"package_base": "random name"}, view] - database._packages_get_select_packages(connection, {package_ahriman.base: package_ahriman}) + database._packages_get_select_packages(connection, {package_ahriman.base: package_ahriman}, + database._repository_id) def test_packages_get_select_statuses(database: SQLite, connection: Connection) -> None: """ must select all statuses """ - database._packages_get_select_statuses(connection) + database._packages_get_select_statuses(connection, database._repository_id) connection.execute(pytest.helpers.anyvar(str, strict=True)) @@ -118,8 +121,10 @@ def test_package_remove(database: SQLite, package_ahriman: Package, mocker: Mock remove_packages_mock = mocker.patch("ahriman.core.database.SQLite._package_remove_packages") database.package_remove(package_ahriman.base) - remove_package_mock.assert_called_once_with(pytest.helpers.anyvar(int), package_ahriman.base) - remove_packages_mock.assert_called_once_with(pytest.helpers.anyvar(int), package_ahriman.base, []) + remove_package_mock.assert_called_once_with(pytest.helpers.anyvar(int), package_ahriman.base, + database._repository_id) + remove_packages_mock.assert_called_once_with(pytest.helpers.anyvar(int), package_ahriman.base, [], + database._repository_id) def test_package_update(database: SQLite, package_ahriman: Package, mocker: MockerFixture): @@ -133,11 +138,13 @@ def test_package_update(database: SQLite, package_ahriman: Package, mocker: Mock remove_packages_mock = mocker.patch("ahriman.core.database.SQLite._package_remove_packages") database.package_update(package_ahriman, status) - insert_base_mock.assert_called_once_with(pytest.helpers.anyvar(int), package_ahriman) - insert_status_mock.assert_called_once_with(pytest.helpers.anyvar(int), package_ahriman.base, status) - insert_packages_mock.assert_called_once_with(pytest.helpers.anyvar(int), package_ahriman) - remove_packages_mock.assert_called_once_with( - pytest.helpers.anyvar(int), package_ahriman.base, package_ahriman.packages.keys()) + insert_base_mock.assert_called_once_with(pytest.helpers.anyvar(int), package_ahriman, database._repository_id) + insert_status_mock.assert_called_once_with(pytest.helpers.anyvar(int), package_ahriman.base, status, + database._repository_id) + insert_packages_mock.assert_called_once_with(pytest.helpers.anyvar(int), package_ahriman, + database._repository_id) + remove_packages_mock.assert_called_once_with(pytest.helpers.anyvar(int), package_ahriman.base, + package_ahriman.packages.keys(), database._repository_id) def test_packages_get(database: SQLite, package_ahriman: Package, mocker: MockerFixture) -> None: @@ -150,9 +157,10 @@ def test_packages_get(database: SQLite, package_ahriman: Package, mocker: Mocker select_statuses_mock = mocker.patch("ahriman.core.database.SQLite._packages_get_select_statuses") database.packages_get() - select_bases_mock.assert_called_once_with(pytest.helpers.anyvar(int)) - select_statuses_mock.assert_called_once_with(pytest.helpers.anyvar(int)) - select_packages_mock.assert_called_once_with(pytest.helpers.anyvar(int), {package_ahriman.base: package_ahriman}) + select_bases_mock.assert_called_once_with(pytest.helpers.anyvar(int), database._repository_id) + select_statuses_mock.assert_called_once_with(pytest.helpers.anyvar(int), database._repository_id) + select_packages_mock.assert_called_once_with(pytest.helpers.anyvar(int), {package_ahriman.base: package_ahriman}, + database._repository_id) def test_package_update_get(database: SQLite, package_ahriman: Package) -> None: diff --git a/tests/ahriman/core/formatters/conftest.py b/tests/ahriman/core/formatters/conftest.py index 1cdfa3cb..e154e11c 100644 --- a/tests/ahriman/core/formatters/conftest.py +++ b/tests/ahriman/core/formatters/conftest.py @@ -3,12 +3,13 @@ import pytest from pathlib import Path from ahriman.core.formatters import AurPrinter, ConfigurationPrinter, ConfigurationPathsPrinter, PackagePrinter, \ - PatchPrinter, StatusPrinter, StringPrinter, TreePrinter, UpdatePrinter, UserPrinter, ValidationPrinter, \ - VersionPrinter + PatchPrinter, RepositoryPrinter, StatusPrinter, StringPrinter, TreePrinter, UpdatePrinter, UserPrinter, \ + ValidationPrinter, VersionPrinter from ahriman.models.aur_package import AURPackage from ahriman.models.build_status import BuildStatus from ahriman.models.package import Package from ahriman.models.pkgbuild_patch import PkgbuildPatch +from ahriman.models.repository_id import RepositoryId from ahriman.models.user import User @@ -76,6 +77,17 @@ def patch_printer(package_ahriman: Package) -> PatchPrinter: return PatchPrinter(package_ahriman.base, [PkgbuildPatch("key", "value")]) +@pytest.fixture +def repository_printer(repository_id: RepositoryId) -> RepositoryPrinter: + """ + fixture for repository printer + + Returns: + RepositoryPrinter: repository printer test instance + """ + return RepositoryPrinter(repository_id) + + @pytest.fixture def status_printer() -> StatusPrinter: """ diff --git a/tests/ahriman/core/formatters/test_repository_printer.py b/tests/ahriman/core/formatters/test_repository_printer.py new file mode 100644 index 00000000..0ab58a73 --- /dev/null +++ b/tests/ahriman/core/formatters/test_repository_printer.py @@ -0,0 +1,15 @@ +from ahriman.core.formatters import RepositoryPrinter + + +def test_properties(repository_printer: RepositoryPrinter) -> None: + """ + must return empty properties list + """ + assert repository_printer.properties() + + +def test_title(repository_printer: RepositoryPrinter) -> None: + """ + must return non-empty title + """ + assert repository_printer.title() is not None diff --git a/tests/ahriman/core/log/test_http_log_handler.py b/tests/ahriman/core/log/test_http_log_handler.py index fbe89adc..14df2bba 100644 --- a/tests/ahriman/core/log/test_http_log_handler.py +++ b/tests/ahriman/core/log/test_http_log_handler.py @@ -20,18 +20,20 @@ def test_load(configuration: Configuration, mocker: MockerFixture) -> None: add_mock = mocker.patch("logging.Logger.addHandler") load_mock = mocker.patch("ahriman.core.status.client.Client.load") - handler = HttpLogHandler.load(configuration, report=False) + _, repository_id = configuration.check_loaded() + handler = HttpLogHandler.load(repository_id, configuration, report=False) assert handler add_mock.assert_called_once_with(handler) - load_mock.assert_called_once_with(configuration, report=False) + load_mock.assert_called_once_with(repository_id, configuration, report=False) def test_load_exist(configuration: Configuration) -> None: """ must not load handler if already set """ - handler = HttpLogHandler.load(configuration, report=False) - new_handler = HttpLogHandler.load(configuration, report=False) + _, repository_id = configuration.check_loaded() + handler = HttpLogHandler.load(repository_id, configuration, report=False) + new_handler = HttpLogHandler.load(repository_id, configuration, report=False) assert handler is new_handler @@ -43,7 +45,8 @@ def test_emit(configuration: Configuration, log_record: logging.LogRecord, packa log_record_id = log_record.package_id = LogRecordId(package_ahriman.base, package_ahriman.version) log_mock = mocker.patch("ahriman.core.status.client.Client.package_logs") - handler = HttpLogHandler(configuration, report=False, suppress_errors=False) + _, repository_id = configuration.check_loaded() + handler = HttpLogHandler(repository_id, configuration, report=False, suppress_errors=False) handler.emit(log_record) log_mock.assert_called_once_with(log_record_id, log_record) @@ -57,7 +60,8 @@ def test_emit_failed(configuration: Configuration, log_record: logging.LogRecord log_record.package_id = LogRecordId(package_ahriman.base, package_ahriman.version) mocker.patch("ahriman.core.status.client.Client.package_logs", side_effect=Exception()) handle_error_mock = mocker.patch("logging.Handler.handleError") - handler = HttpLogHandler(configuration, report=False, suppress_errors=False) + _, repository_id = configuration.check_loaded() + handler = HttpLogHandler(repository_id, configuration, report=False, suppress_errors=False) handler.emit(log_record) handle_error_mock.assert_called_once_with(log_record) @@ -71,7 +75,8 @@ def test_emit_suppress_failed(configuration: Configuration, log_record: logging. log_record.package_id = LogRecordId(package_ahriman.base, package_ahriman.version) mocker.patch("ahriman.core.status.client.Client.package_logs", side_effect=Exception()) handle_error_mock = mocker.patch("logging.Handler.handleError") - handler = HttpLogHandler(configuration, report=False, suppress_errors=True) + _, repository_id = configuration.check_loaded() + handler = HttpLogHandler(repository_id, configuration, report=False, suppress_errors=True) handler.emit(log_record) handle_error_mock.assert_not_called() @@ -82,7 +87,9 @@ def test_emit_skip(configuration: Configuration, log_record: logging.LogRecord, must skip log record posting if no package base set """ log_mock = mocker.patch("ahriman.core.status.client.Client.package_logs") - handler = HttpLogHandler(configuration, report=False, suppress_errors=False) + + _, repository_id = configuration.check_loaded() + handler = HttpLogHandler(repository_id, configuration, report=False, suppress_errors=False) handler.emit(log_record) log_mock.assert_not_called() diff --git a/tests/ahriman/core/log/test_log_loader.py b/tests/ahriman/core/log/test_log_loader.py index 4e12eb26..c653da57 100644 --- a/tests/ahriman/core/log/test_log_loader.py +++ b/tests/ahriman/core/log/test_log_loader.py @@ -50,9 +50,10 @@ def test_load(configuration: Configuration, mocker: MockerFixture) -> None: logging_mock = mocker.patch("ahriman.core.log.log_loader.fileConfig", side_effect=fileConfig) http_log_mock = mocker.patch("ahriman.core.log.http_log_handler.HttpLogHandler.load") - LogLoader.load(configuration, LogHandler.Journald, quiet=False, report=False) + _, repository_id = configuration.check_loaded() + LogLoader.load(repository_id, configuration, LogHandler.Journald, quiet=False, report=False) logging_mock.assert_called_once_with(pytest.helpers.anyvar(int), disable_existing_loggers=True) - http_log_mock.assert_called_once_with(configuration, report=False) + http_log_mock.assert_called_once_with(repository_id, configuration, report=False) assert all(isinstance(handler, JournalHandler) for handler in logging.getLogger().handlers) @@ -61,7 +62,8 @@ def test_load_fallback(configuration: Configuration, mocker: MockerFixture) -> N must fall back to stderr without errors """ mocker.patch("ahriman.core.log.log_loader.fileConfig", side_effect=PermissionError()) - LogLoader.load(configuration, LogHandler.Journald, quiet=False, report=False) + _, repository_id = configuration.check_loaded() + LogLoader.load(repository_id, configuration, LogHandler.Journald, quiet=False, report=False) def test_load_quiet(configuration: Configuration, mocker: MockerFixture) -> None: @@ -69,5 +71,7 @@ def test_load_quiet(configuration: Configuration, mocker: MockerFixture) -> None must disable logging in case if quiet flag set """ disable_mock = mocker.patch("logging.disable") - LogLoader.load(configuration, LogHandler.Journald, quiet=True, report=False) + + _, repository_id = configuration.check_loaded() + LogLoader.load(repository_id, configuration, LogHandler.Journald, quiet=True, report=False) disable_mock.assert_called_once_with(logging.WARNING) diff --git a/tests/ahriman/core/report/test_remote_call.py b/tests/ahriman/core/report/test_remote_call.py index cd669eca..73e30351 100644 --- a/tests/ahriman/core/report/test_remote_call.py +++ b/tests/ahriman/core/report/test_remote_call.py @@ -79,11 +79,13 @@ def test_remote_update(remote_call: RemoteCall, mocker: MockerFixture) -> None: request_mock = mocker.patch("ahriman.core.status.web_client.WebClient.make_request", return_value=response_obj) assert remote_call.remote_update() == "id" - request_mock.assert_called_once_with("POST", "/api/v1/service/update", json={ - "aur": False, - "local": False, - "manual": True, - }) + request_mock.assert_called_once_with("POST", "/api/v1/service/update", + params=remote_call.repository_id.query(), + json={ + "aur": False, + "local": False, + "manual": True, + }) def test_remote_wait(remote_call: RemoteCall, mocker: MockerFixture) -> None: diff --git a/tests/ahriman/core/repository/test_update_handler.py b/tests/ahriman/core/repository/test_update_handler.py index 1d355b98..bda41426 100644 --- a/tests/ahriman/core/repository/test_update_handler.py +++ b/tests/ahriman/core/repository/test_update_handler.py @@ -89,7 +89,7 @@ def test_updates_aur_filter(update_handler: UpdateHandler, package_ahriman: Pack package_load_mock = mocker.patch("ahriman.models.package.Package.from_aur", return_value=package_ahriman) assert update_handler.updates_aur([package_ahriman.base], vcs=True) == [package_ahriman] - package_load_mock.assert_called_once_with(package_ahriman.base, update_handler.pacman, None) + package_load_mock.assert_called_once_with(package_ahriman.base, None) def test_updates_aur_ignore(update_handler: UpdateHandler, package_ahriman: Package, diff --git a/tests/ahriman/core/status/conftest.py b/tests/ahriman/core/status/conftest.py index 1ec63f6c..6f52d866 100644 --- a/tests/ahriman/core/status/conftest.py +++ b/tests/ahriman/core/status/conftest.py @@ -28,4 +28,5 @@ def web_client(configuration: Configuration) -> WebClient: WebClient: web client test instance """ configuration.set("web", "port", "8080") - return WebClient(configuration) + _, repository_id = configuration.check_loaded() + return WebClient(repository_id, configuration) diff --git a/tests/ahriman/core/status/test_client.py b/tests/ahriman/core/status/test_client.py index ceb361fe..86a1632d 100644 --- a/tests/ahriman/core/status/test_client.py +++ b/tests/ahriman/core/status/test_client.py @@ -15,7 +15,8 @@ def test_load_dummy_client(configuration: Configuration) -> None: """ must load dummy client if no settings set """ - assert not isinstance(Client.load(configuration, report=True), WebClient) + _, repository_id = configuration.check_loaded() + assert not isinstance(Client.load(repository_id, configuration, report=True), WebClient) def test_load_dummy_client_disabled(configuration: Configuration) -> None: @@ -24,7 +25,9 @@ def test_load_dummy_client_disabled(configuration: Configuration) -> None: """ configuration.set_option("web", "host", "localhost") configuration.set_option("web", "port", "8080") - assert not isinstance(Client.load(configuration, report=False), WebClient) + + _, repository_id = configuration.check_loaded() + assert not isinstance(Client.load(repository_id, configuration, report=False), WebClient) def test_load_full_client(configuration: Configuration) -> None: @@ -33,7 +36,9 @@ def test_load_full_client(configuration: Configuration) -> None: """ configuration.set_option("web", "host", "localhost") configuration.set_option("web", "port", "8080") - assert isinstance(Client.load(configuration, report=True), WebClient) + + _, repository_id = configuration.check_loaded() + assert isinstance(Client.load(repository_id, configuration, report=True), WebClient) def test_load_full_client_from_address(configuration: Configuration) -> None: @@ -41,7 +46,8 @@ def test_load_full_client_from_address(configuration: Configuration) -> None: must load full client by using address """ configuration.set_option("web", "address", "http://localhost:8080") - assert isinstance(Client.load(configuration, report=True), WebClient) + _, repository_id = configuration.check_loaded() + assert isinstance(Client.load(repository_id, configuration, report=True), WebClient) def test_load_full_client_from_unix_socket(configuration: Configuration) -> None: @@ -49,7 +55,8 @@ def test_load_full_client_from_unix_socket(configuration: Configuration) -> None must load full client by using unix socket """ configuration.set_option("web", "unix_socket", "/var/lib/ahriman/ahriman-web.sock") - assert isinstance(Client.load(configuration, report=True), WebClient) + _, repository_id = configuration.check_loaded() + assert isinstance(Client.load(repository_id, configuration, report=True), WebClient) def test_package_add(client: Client, package_ahriman: Package) -> None: diff --git a/tests/ahriman/core/status/test_watcher.py b/tests/ahriman/core/status/test_watcher.py index 0444268b..fbd3c95e 100644 --- a/tests/ahriman/core/status/test_watcher.py +++ b/tests/ahriman/core/status/test_watcher.py @@ -2,8 +2,6 @@ import pytest from pytest_mock import MockerFixture -from ahriman.core.configuration import Configuration -from ahriman.core.database import SQLite from ahriman.core.exceptions import UnknownPackageError from ahriman.core.status.watcher import Watcher from ahriman.models.build_status import BuildStatus, BuildStatusEnum @@ -11,27 +9,15 @@ from ahriman.models.log_record_id import LogRecordId from ahriman.models.package import Package -def test_force_no_report(configuration: Configuration, database: SQLite, mocker: MockerFixture) -> None: - """ - must force dummy report client - """ - configuration.set_option("web", "port", "8080") - load_mock = mocker.patch("ahriman.core.repository.Repository.load") - _, repository_id = configuration.check_loaded() - - Watcher(repository_id, configuration, database) - load_mock.assert_called_once_with(repository_id, configuration, database, report=False) - - def test_load(watcher: Watcher, package_ahriman: Package, mocker: MockerFixture) -> None: """ must correctly load packages """ - mocker.patch("ahriman.core.repository.repository.Repository.packages", return_value=[package_ahriman]) - cache_mock = mocker.patch("ahriman.core.database.SQLite.packages_get") + cache_mock = mocker.patch("ahriman.core.database.SQLite.packages_get", + return_value=[(package_ahriman, BuildStatus())]) watcher.load() - cache_mock.assert_called_once_with() + cache_mock.assert_called_once_with(watcher.repository_id) package, status = watcher.known[package_ahriman.base] assert package == package_ahriman assert status.status == BuildStatusEnum.Unknown @@ -42,7 +28,6 @@ def test_load_known(watcher: Watcher, package_ahriman: Package, mocker: MockerFi must correctly load packages with known statuses """ status = BuildStatus(BuildStatusEnum.Success) - mocker.patch("ahriman.core.repository.repository.Repository.packages", return_value=[package_ahriman]) mocker.patch("ahriman.core.database.SQLite.packages_get", return_value=[(package_ahriman, status)]) watcher.known = {package_ahriman.base: (package_ahriman, status)} @@ -57,7 +42,7 @@ def test_logs_get(watcher: Watcher, package_ahriman: Package, mocker: MockerFixt """ logs_mock = mocker.patch("ahriman.core.database.SQLite.logs_get") watcher.logs_get(package_ahriman.base, 1, 2) - logs_mock.assert_called_once_with(package_ahriman.base, 1, 2) + logs_mock.assert_called_once_with(package_ahriman.base, 1, 2, watcher.repository_id) def test_logs_remove(watcher: Watcher, package_ahriman: Package, mocker: MockerFixture) -> None: @@ -66,7 +51,7 @@ def test_logs_remove(watcher: Watcher, package_ahriman: Package, mocker: MockerF """ logs_mock = mocker.patch("ahriman.core.database.SQLite.logs_remove") watcher.logs_remove(package_ahriman.base, "42") - logs_mock.assert_called_once_with(package_ahriman.base, "42") + logs_mock.assert_called_once_with(package_ahriman.base, "42", watcher.repository_id) def test_logs_update_new(watcher: Watcher, package_ahriman: Package, mocker: MockerFixture) -> None: @@ -81,7 +66,7 @@ def test_logs_update_new(watcher: Watcher, package_ahriman: Package, mocker: Moc watcher.logs_update(log_record_id, 42.01, "log record") delete_mock.assert_called_once_with(package_ahriman.base, log_record_id.version) - insert_mock.assert_called_once_with(log_record_id, 42.01, "log record") + insert_mock.assert_called_once_with(log_record_id, 42.01, "log record", watcher.repository_id) assert watcher._last_log_record_id == log_record_id @@ -98,7 +83,7 @@ def test_logs_update_update(watcher: Watcher, package_ahriman: Package, mocker: watcher.logs_update(log_record_id, 42.01, "log record") delete_mock.assert_not_called() - insert_mock.assert_called_once_with(log_record_id, 42.01, "log record") + insert_mock.assert_called_once_with(log_record_id, 42.01, "log record", watcher.repository_id) def test_package_get(watcher: Watcher, package_ahriman: Package) -> None: @@ -129,7 +114,7 @@ def test_package_remove(watcher: Watcher, package_ahriman: Package, mocker: Mock watcher.package_remove(package_ahriman.base) assert not watcher.known - cache_mock.assert_called_once_with(package_ahriman.base) + cache_mock.assert_called_once_with(package_ahriman.base, watcher.repository_id) logs_mock.assert_called_once_with(package_ahriman.base, None) @@ -140,7 +125,7 @@ def test_package_remove_unknown(watcher: Watcher, package_ahriman: Package, mock cache_mock = mocker.patch("ahriman.core.database.SQLite.package_remove") watcher.package_remove(package_ahriman.base) - cache_mock.assert_called_once_with(package_ahriman.base) + cache_mock.assert_called_once_with(package_ahriman.base, watcher.repository_id) def test_package_update(watcher: Watcher, package_ahriman: Package, mocker: MockerFixture) -> None: @@ -150,7 +135,7 @@ def test_package_update(watcher: Watcher, package_ahriman: Package, mocker: Mock cache_mock = mocker.patch("ahriman.core.database.SQLite.package_update") watcher.package_update(package_ahriman.base, BuildStatusEnum.Unknown, package_ahriman) - cache_mock.assert_called_once_with(package_ahriman, pytest.helpers.anyvar(int)) + cache_mock.assert_called_once_with(package_ahriman, pytest.helpers.anyvar(int), watcher.repository_id) package, status = watcher.known[package_ahriman.base] assert package == package_ahriman assert status.status == BuildStatusEnum.Unknown @@ -164,7 +149,7 @@ def test_package_update_ping(watcher: Watcher, package_ahriman: Package, mocker: watcher.known = {package_ahriman.base: (package_ahriman, BuildStatus())} watcher.package_update(package_ahriman.base, BuildStatusEnum.Success, None) - cache_mock.assert_called_once_with(package_ahriman, pytest.helpers.anyvar(int)) + cache_mock.assert_called_once_with(package_ahriman, pytest.helpers.anyvar(int), watcher.repository_id) package, status = watcher.known[package_ahriman.base] assert package == package_ahriman assert status.status == BuildStatusEnum.Success diff --git a/tests/ahriman/core/status/test_web_client.py b/tests/ahriman/core/status/test_web_client.py index 04223b4b..40aeb64c 100644 --- a/tests/ahriman/core/status/test_web_client.py +++ b/tests/ahriman/core/status/test_web_client.py @@ -139,7 +139,8 @@ def test_package_add(web_client: WebClient, package_ahriman: Package, mocker: Mo payload = pytest.helpers.get_package_status(package_ahriman) web_client.package_add(package_ahriman, BuildStatusEnum.Unknown) - requests_mock.assert_called_once_with("POST", pytest.helpers.anyvar(str, True), json=payload) + requests_mock.assert_called_once_with("POST", pytest.helpers.anyvar(str, True), + params=web_client.repository_id.query(), json=payload) def test_package_add_failed(web_client: WebClient, package_ahriman: Package, mocker: MockerFixture) -> None: @@ -196,7 +197,7 @@ def test_package_get_all(web_client: WebClient, package_ahriman: Package, mocker return_value=response_obj) result = web_client.package_get(None) - requests_mock.assert_called_once_with("GET", web_client._package_url()) + requests_mock.assert_called_once_with("GET", web_client._package_url(), params=web_client.repository_id.query()) assert len(result) == len(response) assert (package_ahriman, BuildStatusEnum.Unknown) in [(package, status.status) for package, status in result] @@ -230,7 +231,8 @@ def test_package_get_single(web_client: WebClient, package_ahriman: Package, moc return_value=response_obj) result = web_client.package_get(package_ahriman.base) - requests_mock.assert_called_once_with("GET", web_client._package_url(package_ahriman.base)) + requests_mock.assert_called_once_with("GET", web_client._package_url(package_ahriman.base), + params=web_client.repository_id.query()) assert len(result) == len(response) assert (package_ahriman, BuildStatusEnum.Unknown) in [(package, status.status) for package, status in result] @@ -248,8 +250,8 @@ def test_package_logs(web_client: WebClient, log_record: logging.LogRecord, pack } web_client.package_logs(LogRecordId(package_ahriman.base, package_ahriman.version), log_record) - requests_mock.assert_called_once_with("POST", pytest.helpers.anyvar(str, True), json=payload, - suppress_errors=True) + requests_mock.assert_called_once_with("POST", pytest.helpers.anyvar(str, True), + params=web_client.repository_id.query(), json=payload, suppress_errors=True) def test_package_logs_failed(web_client: WebClient, log_record: logging.LogRecord, package_ahriman: Package, @@ -281,7 +283,8 @@ def test_package_remove(web_client: WebClient, package_ahriman: Package, mocker: requests_mock = mocker.patch("ahriman.core.status.web_client.WebClient.make_request") web_client.package_remove(package_ahriman.base) - requests_mock.assert_called_once_with("DELETE", pytest.helpers.anyvar(str, True)) + requests_mock.assert_called_once_with("DELETE", pytest.helpers.anyvar(str, True), + params=web_client.repository_id.query()) def test_package_remove_failed(web_client: WebClient, package_ahriman: Package, mocker: MockerFixture) -> None: @@ -308,8 +311,10 @@ def test_package_update(web_client: WebClient, package_ahriman: Package, mocker: requests_mock = mocker.patch("ahriman.core.status.web_client.WebClient.make_request") web_client.package_update(package_ahriman.base, BuildStatusEnum.Unknown) - requests_mock.assert_called_once_with("POST", pytest.helpers.anyvar(str, True), json={ - "status": BuildStatusEnum.Unknown.value + requests_mock.assert_called_once_with("POST", pytest.helpers.anyvar(str, True), + params=web_client.repository_id.query(), + json={ + "status": BuildStatusEnum.Unknown.value, }) @@ -343,7 +348,7 @@ def test_status_get(web_client: WebClient, mocker: MockerFixture) -> None: return_value=response_obj) result = web_client.status_get() - requests_mock.assert_called_once_with("GET", web_client._status_url()) + requests_mock.assert_called_once_with("GET", web_client._status_url(), params=web_client.repository_id.query()) assert result.architecture == "x86_64" @@ -370,8 +375,10 @@ def test_status_update(web_client: WebClient, mocker: MockerFixture) -> None: requests_mock = mocker.patch("ahriman.core.status.web_client.WebClient.make_request") web_client.status_update(BuildStatusEnum.Unknown) - requests_mock.assert_called_once_with("POST", pytest.helpers.anyvar(str, True), json={ - "status": BuildStatusEnum.Unknown.value + requests_mock.assert_called_once_with("POST", pytest.helpers.anyvar(str, True), + params=web_client.repository_id.query(), + json={ + "status": BuildStatusEnum.Unknown.value, }) diff --git a/tests/ahriman/core/test_spawn.py b/tests/ahriman/core/test_spawn.py index dd137a09..00349c90 100644 --- a/tests/ahriman/core/test_spawn.py +++ b/tests/ahriman/core/test_spawn.py @@ -1,7 +1,11 @@ +import pytest + from pytest_mock import MockerFixture -from unittest.mock import MagicMock, call as MockCall +from unittest.mock import MagicMock from ahriman.core.spawn import Spawn +from ahriman.models.process_status import ProcessStatus +from ahriman.models.repository_id import RepositoryId def test_boolean_action_argument() -> None: @@ -12,7 +16,7 @@ def test_boolean_action_argument() -> None: assert Spawn.boolean_action_argument("option", False) == "no-option" -def test_process(spawner: Spawn) -> None: +def test_process(spawner: Spawn, repository_id: RepositoryId) -> None: """ must process external process run correctly """ @@ -20,39 +24,39 @@ def test_process(spawner: Spawn) -> None: callback = MagicMock() callback.return_value = True - spawner.process(callback, args, spawner.repository_id, "id", spawner.queue) + spawner.process(callback, args, repository_id, "id", spawner.queue) - callback.assert_called_once_with(args, spawner.repository_id) - (uuid, status, time) = spawner.queue.get() - assert uuid == "id" - assert status - assert time >= 0 + callback.assert_called_once_with(args, repository_id) + status = spawner.queue.get() + assert status.process_id == "id" + assert status.status + assert status.consumed_time >= 0 assert spawner.queue.empty() -def test_process_error(spawner: Spawn) -> None: +def test_process_error(spawner: Spawn, repository_id: RepositoryId) -> None: """ must process external run with error correctly """ callback = MagicMock() callback.return_value = False - spawner.process(callback, MagicMock(), spawner.repository_id, "id", spawner.queue) + spawner.process(callback, MagicMock(), repository_id, "id", spawner.queue) - (uuid, status, time) = spawner.queue.get() - assert uuid == "id" - assert not status - assert time >= 0 + status = spawner.queue.get() + assert status.process_id == "id" + assert not status.status + assert status.consumed_time >= 0 assert spawner.queue.empty() -def test_spawn_process(spawner: Spawn, mocker: MockerFixture) -> None: +def test_spawn_process(spawner: Spawn, repository_id: RepositoryId, mocker: MockerFixture) -> None: """ must correctly spawn child process """ start_mock = mocker.patch("multiprocessing.Process.start") - assert spawner._spawn_process("add", "ahriman", now="", maybe="?", none=None) + assert spawner._spawn_process(repository_id, "add", "ahriman", now="", maybe="?", none=None) start_mock.assert_called_once_with() spawner.args_parser.parse_args.assert_called_once_with( spawner.command_arguments + [ @@ -77,7 +81,7 @@ def test_key_import(spawner: Spawn, mocker: MockerFixture) -> None: """ spawn_mock = mocker.patch("ahriman.core.spawn.Spawn._spawn_process") assert spawner.key_import("0xdeadbeaf", None) - spawn_mock.assert_called_once_with("service-key-import", "0xdeadbeaf") + spawn_mock.assert_called_once_with(pytest.helpers.anyvar(int), "service-key-import", "0xdeadbeaf") def test_key_import_with_server(spawner: Spawn, mocker: MockerFixture) -> None: @@ -86,78 +90,80 @@ def test_key_import_with_server(spawner: Spawn, mocker: MockerFixture) -> None: """ spawn_mock = mocker.patch("ahriman.core.spawn.Spawn._spawn_process") assert spawner.key_import("0xdeadbeaf", "keyserver.ubuntu.com") - spawn_mock.assert_called_once_with("service-key-import", "0xdeadbeaf", **{"key-server": "keyserver.ubuntu.com"}) + spawn_mock.assert_called_once_with(pytest.helpers.anyvar(int), "service-key-import", "0xdeadbeaf", + **{"key-server": "keyserver.ubuntu.com"}) -def test_packages_add(spawner: Spawn, mocker: MockerFixture) -> None: +def test_packages_add(spawner: Spawn, repository_id: RepositoryId, mocker: MockerFixture) -> None: """ must call package addition """ spawn_mock = mocker.patch("ahriman.core.spawn.Spawn._spawn_process") - assert spawner.packages_add(["ahriman", "linux"], None, now=False) - spawn_mock.assert_called_once_with("package-add", "ahriman", "linux", username=None) + assert spawner.packages_add(repository_id, ["ahriman", "linux"], None, now=False) + spawn_mock.assert_called_once_with(repository_id, "package-add", "ahriman", "linux", username=None) -def test_packages_add_with_build(spawner: Spawn, mocker: MockerFixture) -> None: +def test_packages_add_with_build(spawner: Spawn, repository_id: RepositoryId, mocker: MockerFixture) -> None: """ must call package addition with update """ spawn_mock = mocker.patch("ahriman.core.spawn.Spawn._spawn_process") - assert spawner.packages_add(["ahriman", "linux"], None, now=True) - spawn_mock.assert_called_once_with("package-add", "ahriman", "linux", username=None, now="") + assert spawner.packages_add(repository_id, ["ahriman", "linux"], None, now=True) + spawn_mock.assert_called_once_with(repository_id, "package-add", "ahriman", "linux", username=None, now="") -def test_packages_add_with_username(spawner: Spawn, mocker: MockerFixture) -> None: +def test_packages_add_with_username(spawner: Spawn, repository_id: RepositoryId, mocker: MockerFixture) -> None: """ must call package addition with username """ spawn_mock = mocker.patch("ahriman.core.spawn.Spawn._spawn_process") - assert spawner.packages_add(["ahriman", "linux"], "username", now=False) - spawn_mock.assert_called_once_with("package-add", "ahriman", "linux", username="username") + assert spawner.packages_add(repository_id, ["ahriman", "linux"], "username", now=False) + spawn_mock.assert_called_once_with(repository_id, "package-add", "ahriman", "linux", username="username") -def test_packages_rebuild(spawner: Spawn, mocker: MockerFixture) -> None: +def test_packages_rebuild(spawner: Spawn, repository_id: RepositoryId, mocker: MockerFixture) -> None: """ must call package rebuild """ spawn_mock = mocker.patch("ahriman.core.spawn.Spawn._spawn_process") - assert spawner.packages_rebuild("python", "packager") - spawn_mock.assert_called_once_with("repo-rebuild", **{"depends-on": "python", "username": "packager"}) + assert spawner.packages_rebuild(repository_id, "python", "packager") + spawn_mock.assert_called_once_with(repository_id, "repo-rebuild", + **{"depends-on": "python", "username": "packager"}) -def test_packages_remove(spawner: Spawn, mocker: MockerFixture) -> None: +def test_packages_remove(spawner: Spawn, repository_id: RepositoryId, mocker: MockerFixture) -> None: """ must call package removal """ spawn_mock = mocker.patch("ahriman.core.spawn.Spawn._spawn_process") - assert spawner.packages_remove(["ahriman", "linux"]) - spawn_mock.assert_called_once_with("package-remove", "ahriman", "linux") + assert spawner.packages_remove(repository_id, ["ahriman", "linux"]) + spawn_mock.assert_called_once_with(repository_id, "package-remove", "ahriman", "linux") -def test_packages_update(spawner: Spawn, mocker: MockerFixture) -> None: +def test_packages_update(spawner: Spawn, repository_id: RepositoryId, mocker: MockerFixture) -> None: """ must call repo update """ spawn_mock = mocker.patch("ahriman.core.spawn.Spawn._spawn_process") - assert spawner.packages_update("packager", aur=True, local=True, manual=True) + assert spawner.packages_update(repository_id, "packager", aur=True, local=True, manual=True) args = {"username": "packager", "aur": "", "local": "", "manual": ""} - spawn_mock.assert_called_once_with("repo-update", **args) + spawn_mock.assert_called_once_with(repository_id, "repo-update", **args) spawn_mock.reset_mock() - assert spawner.packages_update("packager", aur=False, local=True, manual=True) + assert spawner.packages_update(repository_id, "packager", aur=False, local=True, manual=True) args = {"username": "packager", "no-aur": "", "local": "", "manual": ""} - spawn_mock.assert_called_once_with("repo-update", **args) + spawn_mock.assert_called_once_with(repository_id, "repo-update", **args) spawn_mock.reset_mock() - assert spawner.packages_update("packager", aur=True, local=False, manual=True) + assert spawner.packages_update(repository_id, "packager", aur=True, local=False, manual=True) args = {"username": "packager", "aur": "", "no-local": "", "manual": ""} - spawn_mock.assert_called_once_with("repo-update", **args) + spawn_mock.assert_called_once_with(repository_id, "repo-update", **args) spawn_mock.reset_mock() - assert spawner.packages_update("packager", aur=True, local=True, manual=False) + assert spawner.packages_update(repository_id, "packager", aur=True, local=True, manual=False) args = {"username": "packager", "aur": "", "local": "", "no-manual": ""} - spawn_mock.assert_called_once_with("repo-update", **args) + spawn_mock.assert_called_once_with(repository_id, "repo-update", **args) spawn_mock.reset_mock() @@ -167,8 +173,8 @@ def test_run(spawner: Spawn, mocker: MockerFixture) -> None: """ logging_mock = mocker.patch("logging.Logger.info") - spawner.queue.put(("1", False, 1)) - spawner.queue.put(("2", True, 1)) + spawner.queue.put(ProcessStatus("1", False, 1)) + spawner.queue.put(ProcessStatus("2", True, 1)) spawner.queue.put(None) # terminate spawner.run() @@ -182,8 +188,8 @@ def test_run_pop(spawner: Spawn) -> None: first = spawner.active["1"] = MagicMock() second = spawner.active["2"] = MagicMock() - spawner.queue.put(("1", False, 1)) - spawner.queue.put(("2", True, 1)) + spawner.queue.put(ProcessStatus("1", False, 1)) + spawner.queue.put(ProcessStatus("2", True, 1)) spawner.queue.put(None) # terminate spawner.run() diff --git a/tests/ahriman/core/test_util.py b/tests/ahriman/core/test_util.py index ddced37c..25709742 100644 --- a/tests/ahriman/core/test_util.py +++ b/tests/ahriman/core/test_util.py @@ -478,6 +478,7 @@ def test_walk(resource_path_root: Path) -> None: resource_path_root / "web" / "templates" / "build-status" / "package-rebuild-modal.jinja2", resource_path_root / "web" / "templates" / "build-status" / "table.jinja2", resource_path_root / "web" / "templates" / "static" / "favicon.ico", + resource_path_root / "web" / "templates" / "static" / "logo.svg", resource_path_root / "web" / "templates" / "utils" / "bootstrap-scripts.jinja2", resource_path_root / "web" / "templates" / "utils" / "style.jinja2", resource_path_root / "web" / "templates" / "api.jinja2", diff --git a/tests/ahriman/core/upload/test_remote_service.py b/tests/ahriman/core/upload/test_remote_service.py index 269187b8..f8ea5a4f 100644 --- a/tests/ahriman/core/upload/test_remote_service.py +++ b/tests/ahriman/core/upload/test_remote_service.py @@ -30,9 +30,13 @@ def test_package_upload(remote_service: RemoteService, package_ahriman: Package, remote_service.sync(Path("local"), [package_ahriman]) open_mock.assert_called_once_with("rb") file_mock.close.assert_called_once() - upload_mock.assert_called_once_with("POST", f"{remote_service.client.address}/api/v1/service/upload", files={ - "package": (filename, pytest.helpers.anyvar(int), "application/octet-stream", {}) - }) + upload_mock.assert_called_once_with( + "POST", f"{remote_service.client.address}/api/v1/service/upload", + params=remote_service.repository_id.query(), + files={ + "package": (filename, pytest.helpers.anyvar(int), "application/octet-stream", {}), + }, + ) def test_package_upload_with_signature(remote_service: RemoteService, package_ahriman: Package, @@ -50,10 +54,12 @@ def test_package_upload_with_signature(remote_service: RemoteService, package_ah open_mock.assert_has_calls([MockCall("rb"), MockCall("rb")]) file_mock.close.assert_has_calls([MockCall(), MockCall()]) upload_mock.assert_called_once_with( - "POST", f"{remote_service.client.address}/api/v1/service/upload", files={ + "POST", f"{remote_service.client.address}/api/v1/service/upload", + params=remote_service.repository_id.query(), + files={ "package": (filename, pytest.helpers.anyvar(int), "application/octet-stream", {}), - "signature": (f"{filename}.sig", pytest.helpers.anyvar(int), "application/octet-stream", {}) - } + "signature": (f"{filename}.sig", pytest.helpers.anyvar(int), "application/octet-stream", {}), + }, ) diff --git a/tests/ahriman/models/test_migration.py b/tests/ahriman/models/test_migration.py index 870782bc..e69de29b 100644 --- a/tests/ahriman/models/test_migration.py +++ b/tests/ahriman/models/test_migration.py @@ -1,34 +0,0 @@ -import pytest - -from pytest_mock import MockerFixture - -from ahriman.core.exceptions import MigrationError -from ahriman.models.migration_result import MigrationResult - - -def test_is_outdated() -> None: - """ - must return False for outdated schema - """ - assert MigrationResult(old_version=0, new_version=1).is_outdated - assert not MigrationResult(old_version=1, new_version=1).is_outdated - - -def test_is_outdated_validation(mocker: MockerFixture) -> None: - """ - must call validation before version check - """ - validate_mock = mocker.patch("ahriman.models.migration_result.MigrationResult.validate") - assert MigrationResult(old_version=0, new_version=1).is_outdated - validate_mock.assert_called_once_with() - - -def test_validate() -> None: - """ - must raise exception on invalid migration versions - """ - with pytest.raises(MigrationError): - MigrationResult(old_version=-1, new_version=0).validate() - - with pytest.raises(MigrationError): - MigrationResult(old_version=1, new_version=0).validate() diff --git a/tests/ahriman/models/test_migration_result.py b/tests/ahriman/models/test_migration_result.py index e69de29b..870782bc 100644 --- a/tests/ahriman/models/test_migration_result.py +++ b/tests/ahriman/models/test_migration_result.py @@ -0,0 +1,34 @@ +import pytest + +from pytest_mock import MockerFixture + +from ahriman.core.exceptions import MigrationError +from ahriman.models.migration_result import MigrationResult + + +def test_is_outdated() -> None: + """ + must return False for outdated schema + """ + assert MigrationResult(old_version=0, new_version=1).is_outdated + assert not MigrationResult(old_version=1, new_version=1).is_outdated + + +def test_is_outdated_validation(mocker: MockerFixture) -> None: + """ + must call validation before version check + """ + validate_mock = mocker.patch("ahriman.models.migration_result.MigrationResult.validate") + assert MigrationResult(old_version=0, new_version=1).is_outdated + validate_mock.assert_called_once_with() + + +def test_validate() -> None: + """ + must raise exception on invalid migration versions + """ + with pytest.raises(MigrationError): + MigrationResult(old_version=-1, new_version=0).validate() + + with pytest.raises(MigrationError): + MigrationResult(old_version=1, new_version=0).validate() diff --git a/tests/ahriman/models/test_package.py b/tests/ahriman/models/test_package.py index e6f0e0c8..79709eb9 100644 --- a/tests/ahriman/models/test_package.py +++ b/tests/ahriman/models/test_package.py @@ -164,14 +164,13 @@ def test_from_archive(package_ahriman: Package, pyalpm_handle: MagicMock, mocker assert generated == package_ahriman -def test_from_aur(package_ahriman: Package, aur_package_ahriman: AURPackage, pacman: Pacman, - mocker: MockerFixture) -> None: +def test_from_aur(package_ahriman: Package, aur_package_ahriman: AURPackage, mocker: MockerFixture) -> None: """ must construct package from aur """ mocker.patch("ahriman.core.alpm.remote.AUR.info", return_value=aur_package_ahriman) - package = Package.from_aur(package_ahriman.base, pacman, package_ahriman.packager) + package = Package.from_aur(package_ahriman.base, package_ahriman.packager) assert package_ahriman.base == package.base assert package_ahriman.version == package.version assert package_ahriman.packages.keys() == package.packages.keys() diff --git a/tests/ahriman/models/test_process_status.py b/tests/ahriman/models/test_process_status.py new file mode 100644 index 00000000..e69de29b diff --git a/tests/ahriman/models/test_repository_id.py b/tests/ahriman/models/test_repository_id.py index ebe0c9dc..6ce39956 100644 --- a/tests/ahriman/models/test_repository_id.py +++ b/tests/ahriman/models/test_repository_id.py @@ -21,6 +21,29 @@ def test_id() -> None: assert RepositoryId("arch", "repo").id == "arch-repo" +def test_query() -> None: + """ + must generate query request parameters + """ + assert RepositoryId("x86_64", "a").query() == [("architecture", "x86_64"), ("repository", "a")] + assert RepositoryId("i686", "a").query() == [("architecture", "i686"), ("repository", "a")] + assert RepositoryId("x86_64", "b").query() == [("architecture", "x86_64"), ("repository", "b")] + + +def test_view() -> None: + """ + must generate json view + """ + repository_id = RepositoryId("x86_64", "a") + assert repository_id.view() == {"architecture": repository_id.architecture, "repository": repository_id.name} + + repository_id = RepositoryId("x86_64", "b") + assert repository_id.view() == {"architecture": repository_id.architecture, "repository": repository_id.name} + + repository_id = RepositoryId("i686", "a") + assert repository_id.view() == {"architecture": repository_id.architecture, "repository": repository_id.name} + + def test_lt() -> None: """ must correctly compare instances diff --git a/tests/ahriman/web/conftest.py b/tests/ahriman/web/conftest.py index 7110b846..5f53d05d 100644 --- a/tests/ahriman/web/conftest.py +++ b/tests/ahriman/web/conftest.py @@ -14,10 +14,9 @@ import ahriman.core.auth.helpers from ahriman.core.auth.oauth import OAuth from ahriman.core.configuration import Configuration from ahriman.core.database import SQLite -from ahriman.core.repository import Repository from ahriman.core.spawn import Spawn from ahriman.models.user import User -from ahriman.web.web import setup_service +from ahriman.web.web import setup_server @pytest.helpers.register @@ -114,8 +113,7 @@ def schema_response(handler: Callable[..., Awaitable[Any]], *, code: int = 200) @pytest.fixture -def application(configuration: Configuration, spawner: Spawn, database: SQLite, repository: Repository, - mocker: MockerFixture) -> Application: +def application(configuration: Configuration, spawner: Spawn, database: SQLite, mocker: MockerFixture) -> Application: """ application fixture @@ -123,7 +121,6 @@ def application(configuration: Configuration, spawner: Spawn, database: SQLite, configuration(Configuration): configuration fixture spawner(Spawn): spawner fixture database(SQLite): database fixture - repository(Repository): repository fixture mocker(MockerFixture): mocker object Returns: @@ -131,17 +128,16 @@ def application(configuration: Configuration, spawner: Spawn, database: SQLite, """ configuration.set_option("web", "port", "8080") mocker.patch("ahriman.core.database.SQLite.load", return_value=database) - mocker.patch("ahriman.core.repository.Repository.load", return_value=repository) mocker.patch("aiohttp_apispec.setup_aiohttp_apispec") mocker.patch.object(ahriman.core.auth.helpers, "_has_aiohttp_security", False) _, repository_id = configuration.check_loaded() - return setup_service(repository_id, configuration, spawner) + return setup_server(configuration, spawner, [repository_id]) @pytest.fixture def application_with_auth(configuration: Configuration, user: User, spawner: Spawn, database: SQLite, - repository: Repository, mocker: MockerFixture) -> Application: + mocker: MockerFixture) -> Application: """ application fixture with auth enabled @@ -150,7 +146,6 @@ def application_with_auth(configuration: Configuration, user: User, spawner: Spa user(User): user descriptor fixture spawner(Spawn): spawner fixture database(SQLite): database fixture - repository(Repository): repository fixture mocker(MockerFixture): mocker object Returns: @@ -159,11 +154,10 @@ def application_with_auth(configuration: Configuration, user: User, spawner: Spa configuration.set_option("auth", "target", "configuration") configuration.set_option("web", "port", "8080") mocker.patch("ahriman.core.database.SQLite.load", return_value=database) - mocker.patch("ahriman.core.repository.Repository.load", return_value=repository) mocker.patch("aiohttp_apispec.setup_aiohttp_apispec") mocker.patch.object(ahriman.core.auth.helpers, "_has_aiohttp_security", True) _, repository_id = configuration.check_loaded() - application = setup_service(repository_id, configuration, spawner) + application = setup_server(configuration, spawner, [repository_id]) generated = user.hash_password(application["validator"].salt) mocker.patch("ahriman.core.database.SQLite.user_get", return_value=generated) @@ -173,7 +167,7 @@ def application_with_auth(configuration: Configuration, user: User, spawner: Spa @pytest.fixture def application_with_debug(configuration: Configuration, user: User, spawner: Spawn, database: SQLite, - repository: Repository, mocker: MockerFixture) -> Application: + mocker: MockerFixture) -> Application: """ application fixture with debug enabled @@ -182,7 +176,6 @@ def application_with_debug(configuration: Configuration, user: User, spawner: Sp user(User): user descriptor fixture spawner(Spawn): spawner fixture database(SQLite): database fixture - repository(Repository): repository fixture mocker(MockerFixture): mocker object Returns: @@ -191,17 +184,16 @@ def application_with_debug(configuration: Configuration, user: User, spawner: Sp configuration.set_option("web", "debug", "yes") configuration.set_option("web", "port", "8080") mocker.patch("ahriman.core.database.SQLite.load", return_value=database) - mocker.patch("ahriman.core.repository.Repository.load", return_value=repository) mocker.patch("aiohttp_apispec.setup_aiohttp_apispec") mocker.patch.object(ahriman.core.auth.helpers, "_has_aiohttp_security", False) _, repository_id = configuration.check_loaded() - return setup_service(repository_id, configuration, spawner) + return setup_server(configuration, spawner, [repository_id]) @pytest.fixture -def client(application: Application, event_loop: BaseEventLoop, - aiohttp_client: Any, mocker: MockerFixture) -> TestClient: +def client(application: Application, event_loop: BaseEventLoop, aiohttp_client: Any, + mocker: MockerFixture) -> TestClient: """ web client fixture @@ -219,8 +211,8 @@ def client(application: Application, event_loop: BaseEventLoop, @pytest.fixture -def client_with_auth(application_with_auth: Application, event_loop: BaseEventLoop, - aiohttp_client: Any, mocker: MockerFixture) -> TestClient: +def client_with_auth(application_with_auth: Application, event_loop: BaseEventLoop, aiohttp_client: Any, + mocker: MockerFixture) -> TestClient: """ web client fixture with full authorization functions @@ -238,8 +230,8 @@ def client_with_auth(application_with_auth: Application, event_loop: BaseEventLo @pytest.fixture -def client_with_oauth_auth(application_with_auth: Application, event_loop: BaseEventLoop, - aiohttp_client: Any, mocker: MockerFixture) -> TestClient: +def client_with_oauth_auth(application_with_auth: Application, event_loop: BaseEventLoop, aiohttp_client: Any, + mocker: MockerFixture) -> TestClient: """ web client fixture with full authorization functions diff --git a/tests/ahriman/web/schemas/test_repository_id_schema.py b/tests/ahriman/web/schemas/test_repository_id_schema.py new file mode 100644 index 00000000..1982fb6b --- /dev/null +++ b/tests/ahriman/web/schemas/test_repository_id_schema.py @@ -0,0 +1 @@ +# schema testing goes in view class tests diff --git a/tests/ahriman/web/test_web.py b/tests/ahriman/web/test_web.py index 855ed27c..3beea310 100644 --- a/tests/ahriman/web/test_web.py +++ b/tests/ahriman/web/test_web.py @@ -5,10 +5,12 @@ from aiohttp.web import Application from pytest_mock import MockerFixture from unittest.mock import call as MockCall +from ahriman.core.configuration import Configuration from ahriman.core.exceptions import InitializeError from ahriman.core.log.filtered_access_logger import FilteredAccessLogger +from ahriman.core.spawn import Spawn from ahriman.core.status.watcher import Watcher -from ahriman.web.web import _create_socket, _on_shutdown, _on_startup, run_server +from ahriman.web.web import _create_socket, _on_shutdown, _on_startup, run_server, setup_server async def test_create_socket(application: Application, mocker: MockerFixture) -> None: @@ -72,7 +74,7 @@ async def test_on_startup(application: Application, watcher: Watcher, mocker: Mo """ must call load method """ - mocker.patch("aiohttp.web.Application.__getitem__", return_value=watcher) + mocker.patch("aiohttp.web.Application.__getitem__", return_value={"": watcher}) load_mock = mocker.patch("ahriman.core.status.watcher.Watcher.load") await _on_startup(application) @@ -83,7 +85,7 @@ async def test_on_startup_exception(application: Application, watcher: Watcher, """ must throw exception on load error """ - mocker.patch("aiohttp.web.Application.__getitem__", return_value=watcher) + mocker.patch("aiohttp.web.Application.__getitem__", return_value={"": watcher}) mocker.patch("ahriman.core.status.watcher.Watcher.load", side_effect=Exception()) with pytest.raises(InitializeError): @@ -151,3 +153,11 @@ def test_run_with_socket(application: Application, mocker: MockerFixture) -> Non application, host="127.0.0.1", port=port, sock=42, handle_signals=True, access_log=pytest.helpers.anyvar(int), access_log_class=FilteredAccessLogger ) + + +def test_setup_no_repositories(configuration: Configuration, spawner: Spawn) -> None: + """ + must raise InitializeError if no repositories set + """ + with pytest.raises(InitializeError): + setup_server(configuration, spawner, []) diff --git a/tests/ahriman/web/views/test_view_base.py b/tests/ahriman/web/views/test_view_base.py index 3b040e19..3faff16f 100644 --- a/tests/ahriman/web/views/test_view_base.py +++ b/tests/ahriman/web/views/test_view_base.py @@ -2,10 +2,11 @@ import pytest from multidict import MultiDict from aiohttp.test_utils import TestClient -from aiohttp.web import HTTPBadRequest +from aiohttp.web import HTTPBadRequest, HTTPNotFound from pytest_mock import MockerFixture from unittest.mock import AsyncMock +from ahriman.models.repository_id import RepositoryId from ahriman.models.user_access import UserAccess from ahriman.web.views.base import BaseView @@ -24,11 +25,18 @@ def test_configuration(base: BaseView) -> None: assert base.configuration -def test_service(base: BaseView) -> None: +def test_services(base: BaseView) -> None: """ - must return service + must return services """ - assert base.service + assert base.services + + +def test_sign(base: BaseView) -> None: + """ + must return GPP wrapper instance + """ + assert base.sign def test_spawn(base: BaseView) -> None: @@ -193,6 +201,53 @@ def test_page_bad_request(base: BaseView) -> None: base.page() +def test_repository_id(base: BaseView, repository_id: RepositoryId) -> None: + """ + must repository identifier from parameters + """ + base._request = pytest.helpers.request(base.request.app, "", "", + params=MultiDict(architecture="i686", repository="repo")) + assert base.repository_id() == RepositoryId("i686", "repo") + + base._request = pytest.helpers.request(base.request.app, "", "", params=MultiDict(architecture="i686")) + assert base.repository_id() == repository_id + + base._request = pytest.helpers.request(base.request.app, "", "", params=MultiDict(repository="repo")) + assert base.repository_id() == repository_id + + base._request = pytest.helpers.request(base.request.app, "", "", params=MultiDict()) + assert base.repository_id() == repository_id + + +def test_service(base: BaseView) -> None: + """ + must return service for repository + """ + repository_id = RepositoryId("i686", "repo") + base.request.app["watcher"] = { + repository_id: watcher + for watcher in base.request.app["watcher"].values() + } + + assert base.service(repository_id) == base.services[repository_id] + + +def test_service_auto(base: BaseView, repository_id: RepositoryId, mocker: MockerFixture) -> None: + """ + must return service for repository if no parameters set + """ + mocker.patch("ahriman.web.views.base.BaseView.repository_id", return_value=repository_id) + assert base.service() == base.services[repository_id] + + +def test_service_not_found(base: BaseView) -> None: + """ + must raise HTTPNotFound if no repository found + """ + with pytest.raises(HTTPNotFound): + base.service(RepositoryId("", "")) + + async def test_username(base: BaseView, mocker: MockerFixture) -> None: """ must return identity of logged-in user diff --git a/tests/ahriman/web/views/v1/service/test_view_v1_service_add.py b/tests/ahriman/web/views/v1/service/test_view_v1_service_add.py index 87a1c64b..ef2e371e 100644 --- a/tests/ahriman/web/views/v1/service/test_view_v1_service_add.py +++ b/tests/ahriman/web/views/v1/service/test_view_v1_service_add.py @@ -4,6 +4,7 @@ from aiohttp.test_utils import TestClient from pytest_mock import MockerFixture from unittest.mock import AsyncMock +from ahriman.models.repository_id import RepositoryId from ahriman.models.user_access import UserAccess from ahriman.web.views.v1.service.add import AddView @@ -24,7 +25,7 @@ def test_routes() -> None: assert AddView.ROUTES == ["/api/v1/service/add"] -async def test_post(client: TestClient, mocker: MockerFixture) -> None: +async def test_post(client: TestClient, repository_id: RepositoryId, mocker: MockerFixture) -> None: """ must call post request correctly """ @@ -39,7 +40,7 @@ async def test_post(client: TestClient, mocker: MockerFixture) -> None: assert not request_schema.validate(payload) response = await client.post("/api/v1/service/add", json=payload) assert response.ok - add_mock.assert_called_once_with(["ahriman"], "username", now=True) + add_mock.assert_called_once_with(repository_id, ["ahriman"], "username", now=True) json = await response.json() assert json["process_id"] == "abc" diff --git a/tests/ahriman/web/views/v1/service/test_view_v1_service_rebuild.py b/tests/ahriman/web/views/v1/service/test_view_v1_service_rebuild.py index a092e0c7..1fe740fb 100644 --- a/tests/ahriman/web/views/v1/service/test_view_v1_service_rebuild.py +++ b/tests/ahriman/web/views/v1/service/test_view_v1_service_rebuild.py @@ -4,6 +4,7 @@ from aiohttp.test_utils import TestClient from pytest_mock import MockerFixture from unittest.mock import AsyncMock +from ahriman.models.repository_id import RepositoryId from ahriman.models.user_access import UserAccess from ahriman.web.views.v1.service.rebuild import RebuildView @@ -24,7 +25,7 @@ def test_routes() -> None: assert RebuildView.ROUTES == ["/api/v1/service/rebuild"] -async def test_post(client: TestClient, mocker: MockerFixture) -> None: +async def test_post(client: TestClient, repository_id: RepositoryId, mocker: MockerFixture) -> None: """ must call post request correctly """ @@ -39,7 +40,7 @@ async def test_post(client: TestClient, mocker: MockerFixture) -> None: assert not request_schema.validate(payload) response = await client.post("/api/v1/service/rebuild", json=payload) assert response.ok - rebuild_mock.assert_called_once_with("python", "username") + rebuild_mock.assert_called_once_with(repository_id, "python", "username") json = await response.json() assert json["process_id"] == "abc" diff --git a/tests/ahriman/web/views/v1/service/test_view_v1_service_remove.py b/tests/ahriman/web/views/v1/service/test_view_v1_service_remove.py index 1489a6c8..3e823c9f 100644 --- a/tests/ahriman/web/views/v1/service/test_view_v1_service_remove.py +++ b/tests/ahriman/web/views/v1/service/test_view_v1_service_remove.py @@ -3,6 +3,7 @@ import pytest from aiohttp.test_utils import TestClient from pytest_mock import MockerFixture +from ahriman.models.repository_id import RepositoryId from ahriman.models.user_access import UserAccess from ahriman.web.views.v1.service.remove import RemoveView @@ -23,7 +24,7 @@ def test_routes() -> None: assert RemoveView.ROUTES == ["/api/v1/service/remove"] -async def test_post(client: TestClient, mocker: MockerFixture) -> None: +async def test_post(client: TestClient, repository_id: RepositoryId, mocker: MockerFixture) -> None: """ must call post request correctly """ @@ -35,7 +36,7 @@ async def test_post(client: TestClient, mocker: MockerFixture) -> None: assert not request_schema.validate(payload) response = await client.post("/api/v1/service/remove", json=payload) assert response.ok - remove_mock.assert_called_once_with(["ahriman"]) + remove_mock.assert_called_once_with(repository_id, ["ahriman"]) json = await response.json() assert json["process_id"] == "abc" diff --git a/tests/ahriman/web/views/v1/service/test_view_v1_service_request.py b/tests/ahriman/web/views/v1/service/test_view_v1_service_request.py index 904f444f..bd6dfb73 100644 --- a/tests/ahriman/web/views/v1/service/test_view_v1_service_request.py +++ b/tests/ahriman/web/views/v1/service/test_view_v1_service_request.py @@ -4,6 +4,7 @@ from aiohttp.test_utils import TestClient from pytest_mock import MockerFixture from unittest.mock import AsyncMock +from ahriman.models.repository_id import RepositoryId from ahriman.models.user_access import UserAccess from ahriman.web.views.v1.service.request import RequestView @@ -24,7 +25,7 @@ def test_routes() -> None: assert RequestView.ROUTES == ["/api/v1/service/request"] -async def test_post(client: TestClient, mocker: MockerFixture) -> None: +async def test_post(client: TestClient, repository_id: RepositoryId, mocker: MockerFixture) -> None: """ must call post request correctly """ @@ -39,7 +40,7 @@ async def test_post(client: TestClient, mocker: MockerFixture) -> None: assert not request_schema.validate(payload) response = await client.post("/api/v1/service/request", json=payload) assert response.ok - add_mock.assert_called_once_with(["ahriman"], "username", now=False) + add_mock.assert_called_once_with(repository_id, ["ahriman"], "username", now=False) json = await response.json() assert json["process_id"] == "abc" diff --git a/tests/ahriman/web/views/v1/service/test_view_v1_service_search.py b/tests/ahriman/web/views/v1/service/test_view_v1_service_search.py index 8e288a0d..23b9d0c5 100644 --- a/tests/ahriman/web/views/v1/service/test_view_v1_service_search.py +++ b/tests/ahriman/web/views/v1/service/test_view_v1_service_search.py @@ -77,4 +77,4 @@ async def test_get_join(client: TestClient, mocker: MockerFixture) -> None: assert not request_schema.validate(payload) response = await client.get("/api/v1/service/search", params=payload) assert response.ok - search_mock.assert_called_once_with("ahriman", "maybe", pacman=pytest.helpers.anyvar(int)) + search_mock.assert_called_once_with("ahriman", "maybe") diff --git a/tests/ahriman/web/views/v1/service/test_view_v1_service_update.py b/tests/ahriman/web/views/v1/service/test_view_v1_service_update.py index 8c185a27..913fa23c 100644 --- a/tests/ahriman/web/views/v1/service/test_view_v1_service_update.py +++ b/tests/ahriman/web/views/v1/service/test_view_v1_service_update.py @@ -4,6 +4,7 @@ from aiohttp.test_utils import TestClient from pytest_mock import MockerFixture from unittest.mock import AsyncMock +from ahriman.models.repository_id import RepositoryId from ahriman.models.user_access import UserAccess from ahriman.web.views.v1.service.update import UpdateView @@ -24,7 +25,7 @@ def test_routes() -> None: assert UpdateView.ROUTES == ["/api/v1/service/update"] -async def test_post(client: TestClient, mocker: MockerFixture) -> None: +async def test_post(client: TestClient, repository_id: RepositoryId, mocker: MockerFixture) -> None: """ must call post request correctly for alias """ @@ -50,7 +51,7 @@ async def test_post(client: TestClient, mocker: MockerFixture) -> None: assert not request_schema.validate(payload) response = await client.post("/api/v1/service/update", json=payload) assert response.ok - update_mock.assert_called_once_with("username", **(defaults | payload)) + update_mock.assert_called_once_with(repository_id, "username", **(defaults | payload)) update_mock.reset_mock() json = await response.json() diff --git a/tests/ahriman/web/views/v1/status/test_view_v1_status_package.py b/tests/ahriman/web/views/v1/status/test_view_v1_status_package.py index d8c2efad..abf8e602 100644 --- a/tests/ahriman/web/views/v1/status/test_view_v1_status_package.py +++ b/tests/ahriman/web/views/v1/status/test_view_v1_status_package.py @@ -4,6 +4,7 @@ from aiohttp.test_utils import TestClient from ahriman.models.build_status import BuildStatus, BuildStatusEnum from ahriman.models.package import Package +from ahriman.models.repository_id import RepositoryId from ahriman.models.user_access import UserAccess from ahriman.web.views.v1.status.package import PackageView @@ -94,13 +95,17 @@ async def test_get_not_found(client: TestClient, package_ahriman: Package) -> No assert not response_schema.validate(await response.json()) -async def test_post(client: TestClient, package_ahriman: Package) -> None: +async def test_post(client: TestClient, package_ahriman: Package, repository_id: RepositoryId) -> None: """ must update package status """ request_schema = pytest.helpers.schema_request(PackageView.post) - payload = {"status": BuildStatusEnum.Success.value, "package": package_ahriman.view()} + payload = { + "status": BuildStatusEnum.Success.value, + "package": package_ahriman.view(), + "repository": repository_id.view(), + } assert not request_schema.validate(payload) response = await client.post(f"/api/v1/packages/{package_ahriman.base}", json=payload) assert response.status == 204 @@ -120,18 +125,25 @@ async def test_post_exception(client: TestClient, package_ahriman: Package) -> N assert not response_schema.validate(await response.json()) -async def test_post_light(client: TestClient, package_ahriman: Package) -> None: +async def test_post_light(client: TestClient, package_ahriman: Package, repository_id: RepositoryId) -> None: """ must update package status only """ request_schema = pytest.helpers.schema_request(PackageView.post) - payload = {"status": BuildStatusEnum.Unknown.value, "package": package_ahriman.view()} + payload = { + "status": BuildStatusEnum.Success.value, + "package": package_ahriman.view(), + "repository": repository_id.view(), + } assert not request_schema.validate(payload) response = await client.post(f"/api/v1/packages/{package_ahriman.base}", json=payload) assert response.status == 204 - payload = {"status": BuildStatusEnum.Success.value} + payload = { + "status": BuildStatusEnum.Success.value, + "repository": repository_id.view(), + } assert not request_schema.validate(payload) response = await client.post(f"/api/v1/packages/{package_ahriman.base}", json=payload) assert response.status == 204 @@ -145,14 +157,17 @@ async def test_post_light(client: TestClient, package_ahriman: Package) -> None: assert statuses[package_ahriman.base].status == BuildStatusEnum.Success -async def test_post_not_found(client: TestClient, package_ahriman: Package) -> None: +async def test_post_not_found(client: TestClient, package_ahriman: Package, repository_id: RepositoryId) -> None: """ must raise exception on status update for unknown package """ request_schema = pytest.helpers.schema_request(PackageView.post) response_schema = pytest.helpers.schema_response(PackageView.post, code=400) - payload = {"status": BuildStatusEnum.Success.value} + payload = { + "status": BuildStatusEnum.Success.value, + "repository": repository_id.view(), + } assert not request_schema.validate(payload) response = await client.post(f"/api/v1/packages/{package_ahriman.base}", json=payload) assert response.status == 400 diff --git a/tests/ahriman/web/views/v1/status/test_view_v1_status_repositories.py b/tests/ahriman/web/views/v1/status/test_view_v1_status_repositories.py new file mode 100644 index 00000000..4c7ebfea --- /dev/null +++ b/tests/ahriman/web/views/v1/status/test_view_v1_status_repositories.py @@ -0,0 +1,37 @@ +import pytest + +from aiohttp.test_utils import TestClient + +from ahriman.models.repository_id import RepositoryId +from ahriman.models.user_access import UserAccess +from ahriman.web.views.v1.status.repositories import RepositoriesView + + +async def test_get_permission() -> None: + """ + must return correct permission for the request + """ + for method in ("GET",): + request = pytest.helpers.request("", "", method) + assert await RepositoriesView.get_permission(request) == UserAccess.Read + + +def test_routes() -> None: + """ + must return correct routes + """ + assert RepositoriesView.ROUTES == ["/api/v1/repositories"] + + +async def test_get(client: TestClient, repository_id: RepositoryId) -> None: + """ + must return status for specific package + """ + response_schema = pytest.helpers.schema_response(RepositoriesView.get) + + response = await client.get(f"/api/v1/repositories") + assert response.ok + json = await response.json() + assert not response_schema.validate(json, many=True) + + assert json == [repository_id.view()]