web server support

src/ahriman/web/__init__.py

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

src/ahriman/web/middlewares/__init__.py

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

src/ahriman/web/middlewares/exception_handler.py

@@ -0,0 +1,38 @@
+#
+# Copyright (c) 2021 Evgenii Alekseev.
+#
+# This file is part of ahriman 
+# (see https://github.com/arcan1s/ahriman).
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+from aiohttp.web import middleware, Request, Response
+from logging import Logger
+from typing import Callable
+
+from aiohttp.web_exceptions import HTTPClientError
+
+
+def exception_handler(logger: Logger) -> Callable:
+    @middleware
+    async def handle(request: Request, handler: Callable) -> Response:
+        try:
+            return await handler(request)
+        except HTTPClientError:
+            raise
+        except Exception:
+            logger.exception(f'exception during performing request to {request.path}', exc_info=True)
+            raise
+
+    return handle

src/ahriman/web/routes.py

@@ -0,0 +1,34 @@
+#
+# Copyright (c) 2021 Evgenii Alekseev.
+#
+# This file is part of ahriman 
+# (see https://github.com/arcan1s/ahriman).
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+from aiohttp.web import Application
+
+from ahriman.web.views.index import IndexView
+from ahriman.web.views.package import PackageView
+from ahriman.web.views.packages import PackagesView
+
+
+def setup_routes(app: Application) -> None:
+    app.router.add_get('/', IndexView)
+    app.router.add_get('/index.html', IndexView)
+
+    app.router.add_post('/api/v1/packages', PackagesView)
+
+    app.router.add_delete('/api/v1/packages/{package}', PackageView)
+    app.router.add_post('/api/v1/packages/{package}', PackageView)

src/ahriman/web/views/__init__.py

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

src/ahriman/web/views/base.py

@@ -0,0 +1,29 @@
+#
+# Copyright (c) 2021 Evgenii Alekseev.
+#
+# This file is part of ahriman 
+# (see https://github.com/arcan1s/ahriman).
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+from aiohttp.web import View
+
+from ahriman.core.watcher.watcher import Watcher
+
+
+class BaseView(View):
+
+    @property
+    def service(self) -> Watcher:
+        return self.request.app['watcher']

src/ahriman/web/views/index.py

@@ -0,0 +1,47 @@
+#
+# Copyright (c) 2021 Evgenii Alekseev.
+#
+# This file is part of ahriman 
+# (see https://github.com/arcan1s/ahriman).
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+from typing import Any, Dict
+
+from aiohttp_jinja2 import template
+
+from ahriman.web.views.base import BaseView
+
+
+class IndexView(BaseView):
+
+    @template("index.jinja2")
+    async def get(self) -> Dict[str, Any]:
+        # some magic to make it jinja-readable
+        packages = [
+            {
+                'base': package.base,
+                'packages': [p for p in sorted(package.packages)],
+                'status': status.status.value,
+                'timestamp': status.timestamp,
+                'version': package.version,
+                'web_url': package.web_url
+            } for package, status in sorted(self.service.packages, key=lambda item: item[0].base)
+        ]
+
+        return {
+            'architecture': self.service.architecture,
+            'packages': packages,
+            'repository': self.service.repository.name,
+        }

src/ahriman/web/views/package.py

@@ -0,0 +1,43 @@
+#
+# Copyright (c) 2021 Evgenii Alekseev.
+#
+# This file is part of ahriman 
+# (see https://github.com/arcan1s/ahriman).
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+from aiohttp.web import HTTPOk, Response
+
+from ahriman.models.build_status import BuildStatusEnum
+from ahriman.models.package import Package
+from ahriman.web.views.base import BaseView
+
+
+class PackageView(BaseView):
+
+    async def delete(self) -> Response:
+        base = self.request.match_info['package']
+        self.service.remove(base)
+
+        return HTTPOk()
+
+    async def post(self) -> Response:
+        base = self.request.match_info['package']
+        data = await self.request.json()
+
+        package = Package(**data['package']) if 'package' in data else None
+        status = BuildStatusEnum(data.get('status', 'unknown'))
+        self.service.update(base, status, package)
+
+        return HTTPOk()

src/ahriman/web/views/packages.py

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

src/ahriman/web/web.py

@@ -0,0 +1,73 @@
+#
+# Copyright (c) 2021 Evgenii Alekseev.
+#
+# This file is part of ahriman 
+# (see https://github.com/arcan1s/ahriman).
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+import aiohttp_jinja2
+import jinja2
+import logging
+
+from aiohttp import web
+
+from ahriman.core.configuration import Configuration
+from ahriman.core.exceptions import InitializeException
+from ahriman.core.watcher.watcher import Watcher
+from ahriman.web.middlewares.exception_handler import exception_handler
+from ahriman.web.routes import setup_routes
+
+
+async def on_shutdown(app: web.Application) -> None:
+    app.logger.warning('server terminated')
+
+
+async def on_startup(app: web.Application) -> None:
+    app.logger.info('server started')
+    try:
+        app['watcher'].load()
+    except Exception as e:
+        app.logger.exception('could not load packages', exc_info=True)
+        raise InitializeException() from e
+
+
+def run_server(app: web.Application) -> None:
+    app.logger.info('start server')
+    web.run_app(app,
+                host=app['config'].get('web', 'host'),
+                port=app['config'].getint('web', 'port'),
+                handle_signals=False)
+
+
+def setup_service(architecture: str, config: Configuration) -> web.Application:
+    app = web.Application(logger=logging.getLogger('http'))
+    app.on_shutdown.append(on_shutdown)
+    app.on_startup.append(on_startup)
+
+    app.middlewares.append(web.normalize_path_middleware(append_slash=False, remove_slash=True))
+    app.middlewares.append(exception_handler(app.logger))
+
+    app.logger.info('setup routes')
+    setup_routes(app)
+    app.logger.info('setup templates')
+    aiohttp_jinja2.setup(app, loader=jinja2.FileSystemLoader(config.get('web', 'templates')))
+
+    app.logger.info('setup configuration')
+    app['config'] = config
+
+    app.logger.info('setup watcher')
+    app['watcher'] = Watcher(architecture, config)
+
+    return app