implement logs support in interface

package/share/ahriman/templates/build-status.jinja2

@@ -40,7 +40,6 @@
             </div>
 
             <table id="packages" class="table table-striped table-hover"
-                   data-click-to-select="true"
                    data-export-options='{"fileName": "packages"}'
                    data-page-list="[10, 25, 50, 100, all]"
                    data-page-size="10"
@@ -76,14 +75,14 @@
         <div class="container">
             <footer class="d-flex flex-wrap justify-content-between align-items-center border-top">
                 <ul class="nav">
-                    <li><a class="nav-link" href="https://github.com/arcan1s/ahriman" title="sources">ahriman</a></li>
+                    <li><a class="nav-link" href="https://github.com/arcan1s/ahriman" title="sources"><i class="bi bi-github"></i> ahriman</a></li>
                     <li><a class="nav-link" href="https://github.com/arcan1s/ahriman/releases" title="releases list">releases</a></li>
                     <li><a class="nav-link" href="https://github.com/arcan1s/ahriman/issues" title="issues tracker">report a bug</a></li>
                 </ul>
 
                 {% if index_url is not none %}
                     <ul class="nav">
-                        <li><a class="nav-link" href="{{ index_url }}" title="repo index">repo index</a></li>
+                        <li><a class="nav-link" href="{{ index_url }}" title="repo index"><i class="bi bi-house"></i> repo index</a></li>
                     </ul>
                 {% endif %}
 
@@ -92,7 +91,7 @@
                         {{ auth.control|safe }}
                     {% else %}
                         <form action="/api/v1/logout" method="post">
-                            <button class="btn btn-link" style="text-decoration: none">logout ({{ auth.username }})</button>
+                            <button class="btn btn-link" style="text-decoration: none"><i class="bi bi-box-arrow-right"></i> logout ({{ auth.username }})</button>
                         </form>
                     {% endif %}
                 {% endif %}
@@ -110,6 +109,8 @@
 
         {% include "build-status/package-add-modal.jinja2" %}
 
+        {% include "build-status/package-info-modal.jinja2" %}
+
         {% include "build-status/table.jinja2" %}
 
     </body>

package/share/ahriman/templates/build-status/failed-modal.jinja2

@@ -1,16 +1,16 @@
 <div id="failed-form" tabindex="-1" role="dialog" class="modal fade">
     <div class="modal-dialog" role="document">
         <div class="modal-content">
-            <div class="modal-header bg-danger">
+            <div class="modal-header bg-danger text-white">
-                <h4 class="modal-title">failed</h4>
+                <h4 id="error-title" class="modal-title"></h4>
                 <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="close"></button>
             </div>
             <div class="modal-body">
-                <p>Packages update has failed.</p>
+                <p id="error-description"></p>
                 <p id="error-details"></p>
             </div>
             <div class="modal-footer">
-                <button type="button" class="btn btn-primary" data-bs-dismiss="modal">close</button>
+                <button type="button" class="btn btn-primary" data-bs-dismiss="modal"><i class="bi bi-x"></i> close</button>
             </div>
         </div>
     </div>
@@ -18,10 +18,14 @@
 
 <script>
     const failedForm = $("#failed-form");
+    const errorDescription = $("#error-description");
     const errorDetails = $("#error-details");
+    const errorTitle = $("#error-title");
     failedForm.on("hidden.bs.modal", () => { reload(); });
 
-    function showFailure(details) {
+    function showFailure(title, description, details) {
+        errorTitle.text(title);
+        errorDescription.text(description);
         errorDetails.text(details);
         failedForm.modal("show");
     }

package/share/ahriman/templates/build-status/login-modal.jinja2

@@ -3,7 +3,7 @@
         <div class="modal-content">
             <form action="/api/v1/login" method="post">
                 <div class="modal-header">
-                    <h4 class="modal-title">login</h4>
+                    <h4 class="modal-title">Login</h4>
                     <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="close"></button>
                 </div>
                 <div class="modal-body">
@@ -21,7 +21,7 @@
                     </div>
                 </div>
                 <div class="modal-footer">
-                    <button class="btn btn-primary">login</button>
+                    <button class="btn btn-primary"><i class="bi bi-person"></i> login</button>
                 </div>
             </form>
         </div>

package/share/ahriman/templates/build-status/package-add-modal.jinja2

@@ -2,7 +2,7 @@
     <div class="modal-dialog" role="document">
         <div class="modal-content">
             <div class="modal-header">
-                <h4 class="modal-title">add new packages</h4>
+                <h4 class="modal-title">Add new packages</h4>
                 <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="close"></button>
             </div>
             <div class="modal-body">
@@ -15,9 +15,9 @@
                 </div>
             </div>
             <div class="modal-footer">
-                <button type="button" class="btn btn-secondary" data-bs-dismiss="modal">close</button>
+                <button type="button" class="btn btn-primary" data-bs-dismiss="modal" onclick="addPackages()"><i class="bi bi-play"></i> add</button>
-                <button type="button" class="btn btn-success" data-bs-dismiss="modal" onclick="requestPackages()">request</button>
+                <button type="button" class="btn btn-success" data-bs-dismiss="modal" onclick="requestPackages()"><i class="bi bi-plus"></i> request</button>
-                <button type="button" class="btn btn-primary" data-bs-dismiss="modal" onclick="addPackages()">add</button>
+                <button type="button" class="btn btn-secondary" data-bs-dismiss="modal"><i class="bi bi-x"></i> close</button>
             </div>
         </div>
     </div>

package/share/ahriman/templates/build-status/package-info-modal.jinja2

@@ -0,0 +1,71 @@
+<div id="package-info-form" tabindex="-1" role="dialog" class="modal fade">
+    <div class="modal-dialog modal-xl" role="document">
+        <div class="modal-content">
+            <div id="package-info-modal-header" class="modal-header">
+                <h4 id="package-info" class="modal-title"></h4>
+                <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="close"></button>
+            </div>
+            <div class="modal-body">
+                <pre class="pre-scrollable language-logs"><code id="package-info-logs" class="language-logs"></code><button id="copy-btn" type="button" class="btn language-logs" onclick="copyLogs()"><i class="bi bi-clipboard"></i> copy</button></pre>
+            </div>
+            <div class="modal-footer">
+                <button type="button" class="btn btn-secondary" onclick="showLogs()"><i class="bi bi-arrow-clockwise"></i> reload</button>
+                <button type="button" class="btn btn-primary" data-bs-dismiss="modal"><i class="bi bi-x"></i> close</button>
+            </div>
+        </div>
+    </div>
+</div>
+
+<script>
+    const packageInfo = $("#package-info");
+    const packageInfoForm = $("#package-info-form");
+    const packageInfoHeader = $("#package-info-modal-header");
+    const packageInfoLogs = $("#package-info-logs");
+    const packageInfoLogsCopyButton = $("#copy-btn");
+
+    async function copyLogs() {
+        const logs = packageInfoLogs.text();
+        await navigator.clipboard.writeText(logs);
+
+        packageInfoLogsCopyButton.html("<i class=\"bi bi-clipboard-check\"></i> copied");
+        setTimeout(()=> {
+            packageInfoLogsCopyButton.html("<i class=\"bi bi-clipboard\"></i> copy");
+        }, 2000);
+    }
+
+    function showLogs(package) {
+        const isPackageBaseSet = package !== undefined;
+        if (isPackageBaseSet)
+            packageInfoForm.data("package", package); // set package base as currently used
+        else
+            package = packageInfoForm.data("package"); // read package base from the current window attribute
+
+        const headerClass = status => {
+            if (status === "pending") return ["bg-warning"];
+            if (status === "building") return ["bg-warning"];
+            if (status === "failed") return ["bg-danger", "text-white"];
+            if (status === "success") return ["bg-success", "text-white"];
+            return ["bg-secondary", "text-white"];
+        };
+
+        $.ajax({
+            url: `/api/v1/packages/${package}/logs`,
+            type: "GET",
+            dataType: "json",
+            success: response => {
+                packageInfo.text(`${response.package_base} ${response.status.status} at ${new Date(1000 * response.status.timestamp).toISOString()}`);
+                packageInfoLogs.text(response.logs);
+
+                packageInfoHeader.removeClass();
+                packageInfoHeader.addClass("modal-header");
+                headerClass(response.status.status).forEach((clz) => packageInfoHeader.addClass(clz));
+
+                if (isPackageBaseSet) packageInfoForm.modal("show"); // we don't need to show window again
+            },
+            error: (jqXHR, _, errorThrown) => {
+                // show failed modal in case if first time loading
+                if (isPackageBaseSet) showFailure("Load failure", `Could not load package ${package} logs:`, errorThrown);
+            },
+        });
+    }
+</script>

package/share/ahriman/templates/build-status/success-modal.jinja2

@@ -1,16 +1,16 @@
 <div id="success-form" tabindex="-1" role="dialog" class="modal fade">
     <div class="modal-dialog" role="document">
         <div class="modal-content">
-            <div class="modal-header bg-success">
+            <div class="modal-header bg-success text-white">
-                <h4 class="modal-title">success</h4>
+                <h4 id="success-title" class="modal-title"></h4>
                 <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="close"></button>
             </div>
             <div class="modal-body">
-                <p>Packages update has been run.</p>
+                <p id="success-description"></p>
                 <ul id="success-details"></ul>
             </div>
             <div class="modal-footer">
-                <button type="button" class="btn btn-primary" data-bs-dismiss="modal">close</button>
+                <button type="button" class="btn btn-primary" data-bs-dismiss="modal"><i class="bi bi-x"></i> close</button>
             </div>
         </div>
     </div>
@@ -18,10 +18,14 @@
 
 <script>
     const successForm = $("#success-form");
+    const successDescription = $("#success-description");
     const successDetails = $("#success-details");
+    const successTitle = $("#success-title");
     successForm.on("hidden.bs.modal", () => { reload(); });
 
-    function showSuccess(details) {
+    function showSuccess(title, description, details) {
+        successTitle.text(title);
+        successDescription.text(description);
         successDetails.empty().append(details);
         successForm.modal("show");
     }

package/share/ahriman/templates/build-status/table.jinja2

@@ -8,6 +8,7 @@
         () => {
             removeButton.prop("disabled", !table.bootstrapTable("getSelections").length);
         });
+    table.on("click-row.bs.table", (_, row) => { showLogs(row.id); });
 
     const architectureBadge = $("#badge-architecture");
     const repositoryBadge = $("#badge-repository");
@@ -26,9 +27,11 @@
                     li.innerText = pkg;
                     return li;
                 });
-                showSuccess(details);
+                showSuccess("Success", `Package action at ${uri} has been run on:`, details);
+            },
+            error: (jqXHR, _, errorThrown) => {
+                showFailure("Action failed", `Package action request at ${uri} on ${packages} has failed:`, errorThrown);
             },
-            error: (jqXHR, _, errorThrown) => { showFailure(errorThrown); },
         });
     }
 
@@ -38,7 +41,11 @@
 
     function removePackages() { doPackageAction("/api/v1/service/remove", getSelection()); }
 
-    function updatePackages() { doPackageAction("/api/v1/service/add", getSelection()); }
+    function updatePackages() {
+        const currentSelection = getSelection();
+        const url = currentSelection.length === 0 ? "/api/v1/service/update" : "/api/v1/service/add";
+        doPackageAction(url, getSelection());
+    }
 
     function hideControls(hidden) {
         addButton.attr("hidden", hidden);
@@ -95,7 +102,7 @@
                     table.bootstrapTable("hideLoading");
                 } else {
                     // other errors
-                    showFailure(errorThrown);
+                    showFailure("Load failure", "Could not load list of packages:", errorThrown);
                 }
                 hideControls(true);
             },

package/share/ahriman/templates/repo-index.jinja2

@@ -19,10 +19,11 @@
                 <p>This repository is signed with <a href="https://pgp.mit.edu/pks/lookup?search=0x{{ pgp_key }}&fingerprint=on&op=index" title="key search">{{ pgp_key }}</a> by default.</p>
             {% endif %}
 
-<pre>$ cat /etc/pacman.conf
+            <p>In order to use this repository edit your <code>/etc/pacman.conf</code> as following:</p>
-[{{ repository }}]
+
+            <pre class="language-ini"><code id="pacman-conf" class="language-ini">[{{ repository }}]
 Server = {{ link_path }}
-SigLevel = Database{% if has_repo_signed %}Required{% else %}Never{% endif %} Package{% if has_package_signed %}Required{% else %}Never{% endif %} TrustedOnly</pre>
+SigLevel = Database{% if has_repo_signed %}Required{% else %}Never{% endif %} Package{% if has_package_signed %}Required{% else %}Never{% endif %} TrustedOnly</code><button id="copy-btn" type="button" class="btn language-ini" onclick="copyPacmanConf()"><i class="bi bi-clipboard"></i> copy</button></pre>
         </div>
 
         <div class="container">
@@ -83,17 +84,32 @@ SigLevel = Database{% if has_repo_signed %}Required{% else %}Never{% endif %} Pa
             <footer class="d-flex flex-wrap justify-content-between align-items-center border-top">
                 <ul class="nav">
                     {% if homepage is not none %}
-                        <li><a class="nav-link" href="{{ homepage }}" title="homepage">homepage</a></li>
+                        <li><a class="nav-link" href="{{ homepage }}" title="homepage"><i class="bi bi-house"></i> homepage</a></li>
                     {% endif %}
                 </ul>
                 <ul class="nav">
-                    <li><a class="nav-link" href="https://github.com/arcan1s/ahriman" title="sources">ahriman</a></li>
+                    <li><a class="nav-link" href="https://github.com/arcan1s/ahriman" title="sources"><i class="bi bi-github"></i> ahriman</a></li>
                 </ul>
             </footer>
         </div>
 
         {% include "utils/bootstrap-scripts.jinja2" %}
 
+        <script>
+            const pacmanConf = $("#pacman-conf");
+            const pacmanConfCopyButton = $("#copy-btn");
+
+            async function copyPacmanConf() {
+                const conf = pacmanConf.text();
+                await navigator.clipboard.writeText(conf);
+
+                pacmanConfCopyButton.html("<i class=\"bi bi-clipboard-check\"></i> copied");
+                setTimeout(() => {
+                    pacmanConfCopyButton.html("<i class=\"bi bi-clipboard\"></i> copy");
+                }, 2000);
+            }
+        </script>
+
     </body>
 
 </html>

package/share/ahriman/templates/utils/bootstrap-scripts.jinja2

@@ -4,9 +4,10 @@
 
 <script src="https://unpkg.com/jquery-resizable-columns@0.2.3/dist/jquery.resizableColumns.min.js"></script>
 
-<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/js/bootstrap.bundle.min.js" integrity="sha384-ka7Sk0Gln4gmtz2MlQnikT1wXgYsOg+OMhuP+IlRH9sENBO0LRn5q+8nbTov4+1p" crossorigin="anonymous"></script>
+<script src="https://cdn.jsdelivr.net/npm/@popperjs/core@2.11.6/dist/umd/popper.min.js" integrity="sha384-oBqDVmMz9ATKxIep9tiCxS/Z9fNfEXiDAYTujMAeBAsjFuCZSmKbSSUnQlmh/jp3" crossorigin="anonymous"></script>
-<script src="https://unpkg.com/bootstrap-table@1.20.2/dist/bootstrap-table.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.2.2/dist/js/bootstrap.min.js" integrity="sha384-IDwe1+LCz02ROU9k972gdyvl+AESN10+x7tBKgc9I5HFtuNz0wWnPclzo6p9vxnk" crossorigin="anonymous"></script>
+<script src="https://unpkg.com/bootstrap-table@1.21.1/dist/bootstrap-table.min.js"></script>
 
-<script src="https://unpkg.com/bootstrap-table@1.20.2/dist/extensions/export/bootstrap-table-export.min.js"></script>
+<script src="https://unpkg.com/bootstrap-table@1.21.1/dist/extensions/export/bootstrap-table-export.min.js"></script>
 
-<script src="https://unpkg.com/bootstrap-table@1.20.2/dist/extensions/resizable/bootstrap-table-resizable.js"></script>
+<script src="https://unpkg.com/bootstrap-table@1.21.1/dist/extensions/resizable/bootstrap-table-resizable.js"></script>

package/share/ahriman/templates/utils/style.jinja2

@@ -1,9 +1,23 @@
-<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css" integrity="sha384-1BmE4kWBq78iYhFldvKuhfTAU6auU8tT94WrHftjDbrCEXSU1oBoqyl2QvZ6jIW3" crossorigin="anonymous" type="text/css">
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@5.2.2/dist/css/bootstrap.min.css" integrity="sha384-Zenh87qX5JnK2Jl0vWa8Ck2rdkQ2Bzep5IDxbcnCeuOxjzrPF/et3URy9Bv1WTRi" crossorigin="anonymous" type="text/css">
-<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.8.3/font/bootstrap-icons.css" type="text/css">
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.10.2/font/bootstrap-icons.css" type="text/css">
 
-<link rel="stylesheet" href="https://unpkg.com/bootstrap-table@1.20.2/dist/bootstrap-table.min.css" type="text/css">
+<link rel="stylesheet" href="https://unpkg.com/bootstrap-table@1.21.1/dist/bootstrap-table.min.css" type="text/css">
 
 <link href="https://unpkg.com/jquery-resizable-columns@0.2.3/dist/jquery.resizableColumns.css" rel="stylesheet">
 
 <style>
+    .pre-scrollable {
+        max-height: 680px;
+        overflow-y: scroll;
+    }
+
+    pre[class*="language-"] {
+        position: relative;
+    }
+
+    pre[class*="language-"] button{
+        position: absolute;
+        top: 0px;
+        right: 5px;
+    }
 </style>

setup.py

@@ -74,6 +74,7 @@ setup(
             "package/share/ahriman/templates/build-status/failed-modal.jinja2",
             "package/share/ahriman/templates/build-status/login-modal.jinja2",
             "package/share/ahriman/templates/build-status/package-add-modal.jinja2",
+            "package/share/ahriman/templates/build-status/package-info-modal.jinja2",
             "package/share/ahriman/templates/build-status/success-modal.jinja2",
             "package/share/ahriman/templates/build-status/table.jinja2",
         ]),

src/ahriman/core/auth/auth.py

@@ -62,7 +62,7 @@ class Auth(LazyLogging):
         Returns:
             str: login control as html code to insert
         """
-        return """<button type="button" class="btn btn-link" data-bs-toggle="modal" data-bs-target="#loginForm" style="text-decoration: none">login</button>"""
+        return """<button type="button" class="btn btn-link" data-bs-toggle="modal" data-bs-target="#loginForm" style="text-decoration: none"><i class="bi bi-box-arrow-in-right"></i> login</button>"""
 
     @classmethod
     def load(cls: Type[Auth], configuration: Configuration, database: SQLite) -> Auth:

src/ahriman/core/auth/oauth.py

@@ -69,7 +69,7 @@ class OAuth(Mapping):
         Returns:
             str: login control as html code to insert
         """
-        return """<a class="nav-link" href="/api/v1/login" title="login via OAuth2">login</a>"""
+        return """<a class="nav-link" href="/api/v1/login" title="login via OAuth2"><i class="bi bi-google"></i> login</a>"""
 
     @staticmethod
     def get_provider(name: str) -> Type[aioauth_client.OAuth2Client]:

src/ahriman/web/views/status/logs.py

@@ -18,7 +18,9 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 #
 from aiohttp.web import HTTPBadRequest, HTTPNoContent, Response, json_response
+from aiohttp.web_exceptions import HTTPNotFound
 
+from ahriman.core.exceptions import UnknownPackageError
 from ahriman.models.log_record_id import LogRecordId
 from ahriman.models.user_access import UserAccess
 from ahriman.web.views.base import BaseView
@@ -58,10 +60,16 @@ class LogsView(BaseView):
             Response: 200 with package logs on success
         """
         package_base = self.request.match_info["package"]
+
+        try:
+            _, status = self.service.get(package_base)
+        except UnknownPackageError:
+            raise HTTPNotFound()
         logs = self.service.get_logs(package_base)
 
         response = {
             "package_base": package_base,
+            "status": status.view(),
             "logs": logs
         }
         return json_response(response)

tests/ahriman/core/test_util.py

@@ -327,6 +327,7 @@ def test_walk(resource_path_root: Path) -> None:
         resource_path_root / "web" / "templates" / "build-status" / "failed-modal.jinja2",
         resource_path_root / "web" / "templates" / "build-status" / "login-modal.jinja2",
         resource_path_root / "web" / "templates" / "build-status" / "package-add-modal.jinja2",
+        resource_path_root / "web" / "templates" / "build-status" / "package-info-modal.jinja2",
         resource_path_root / "web" / "templates" / "build-status" / "success-modal.jinja2",
         resource_path_root / "web" / "templates" / "build-status" / "table.jinja2",
         resource_path_root / "web" / "templates" / "static" / "favicon.ico",

tests/ahriman/web/views/status/test_views_status_logs.py

@@ -2,6 +2,7 @@ import pytest
 
 from aiohttp.test_utils import TestClient
 
+from ahriman.models.build_status import BuildStatusEnum
 from ahriman.models.package import Package
 from ahriman.models.user_access import UserAccess
 from ahriman.web.views.status.logs import LogsView
@@ -23,6 +24,11 @@ async def test_delete(client: TestClient, package_ahriman: Package, package_pyth
     """
     must delete logs for package
     """
+    await client.post(f"/api/v1/packages/{package_ahriman.base}",
+                      json={"status": BuildStatusEnum.Success.value, "package": package_ahriman.view()})
+    await client.post(f"/api/v1/packages/{package_python_schedule.base}",
+                      json={"status": BuildStatusEnum.Success.value, "package": package_python_schedule.view()})
+
     await client.post(f"/api/v1/packages/{package_ahriman.base}/logs",
                       json={"created": 0.001, "message": "message", "process_id": 42})
     await client.post(f"/api/v1/packages/{package_python_schedule.base}/logs",
@@ -44,6 +50,8 @@ async def test_get(client: TestClient, package_ahriman: Package) -> None:
     """
     must get logs for package
     """
+    await client.post(f"/api/v1/packages/{package_ahriman.base}",
+                      json={"status": BuildStatusEnum.Success.value, "package": package_ahriman.view()})
     await client.post(f"/api/v1/packages/{package_ahriman.base}/logs",
                       json={"created": 0.001, "message": "message", "process_id": 42})
 
@@ -51,20 +59,31 @@ async def test_get(client: TestClient, package_ahriman: Package) -> None:
     assert response.status == 200
 
     logs = await response.json()
-    assert logs == {"package_base": package_ahriman.base, "logs": "message"}
+    assert logs["logs"] == "message"
+
+
+async def test_get_not_foud(client: TestClient, package_ahriman: Package) -> None:
+    """
+    must return not found for missing package
+    """
+    response = await client.get(f"/api/v1/packages/{package_ahriman.base}/logs")
+    assert response.status == 404
 
 
 async def test_post(client: TestClient, package_ahriman: Package) -> None:
     """
     must create logs record
     """
+    await client.post(f"/api/v1/packages/{package_ahriman.base}",
+                      json={"status": BuildStatusEnum.Success.value, "package": package_ahriman.view()})
+
     post_response = await client.post(f"/api/v1/packages/{package_ahriman.base}/logs",
                                       json={"created": 0.001, "message": "message", "process_id": 42})
     assert post_response.status == 204
 
     response = await client.get(f"/api/v1/packages/{package_ahriman.base}/logs")
     logs = await response.json()
-    assert logs == {"package_base": package_ahriman.base, "logs": "message"}
+    assert logs["logs"] == "message"
 
 
 async def test_post_exception(client: TestClient, package_ahriman: Package) -> None: