argus-alm 0.12.2__tar.gz → 0.12.4b1__tar.gz

argus_alm-0.12.4b1/PKG-INFO

@@ -0,0 +1,129 @@
+Metadata-Version: 2.1
+Name: argus-alm
+Version: 0.12.4b1
+Summary: Argus
+Home-page: https://github.com/scylladb/argus
+License: Apache-2.0
+Author: Alexey Kartashov
+Author-email: alexey.kartashov@scylladb.com
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: click (>=8.1.3,<9.0.0)
+Requires-Dist: requests (>=2.26.0,<3.0.0)
+Project-URL: Repository, https://github.com/scylladb/argus
+Description-Content-Type: text/markdown
+
+# Argus
+
+## Description
+
+Argus is a test tracking system intended to provide observability into automated test pipelines which use long-running resources. It allows observation of a test status, its events and its allocated resources. It also allows easy comparison between particular runs of a specific test.
+
+## Installation notes
+
+### Development
+
+For development setup instructions, see [dev-setup.md](./docs/dev-setup.md).
+
+### Prerequisites
+
+- Python >=3.10.0 (system-wide or pyenv)
+
+- NodeJS >=16 (with npm)
+
+- Yarn (can be installed globally with `npm -g install yarn`)
+
+- nginx
+
+- poetry >=1.2.0b1
+
+### From source
+
+#### Production
+
+Perform the following steps:
+
+Create a user that will be used by uwsgi:
+
+```bash
+useradd -m -s /bin/bash argus
+sudo -iu argus
+```
+
+(Optional) Install pyenv and create a virtualenv for this user:
+
+```bash
+pyenv install 3.10.0
+pyenv virtualenv argus
+pyenv activate argus
+```
+
+Clone the project into a directory somewhere where user has full write permissions
+
+```bash
+git clone https://github.com/scylladb/argus ~/app
+cd ~/app
+```
+
+Install project dependencies:
+
+```bash
+poetry install --with default,dev,web-backend,docker-image
+yarn install
+```
+
+Compile frontend files from `/frontend` into `/public/dist`
+
+```bash
+yarn webpack
+```
+
+Create a `argus.local.yaml` configuration file (used to configure database connection) and a `argus_web.yaml` (used for webapp secrets) in your application install directory.
+
+```bash
+cp argus_web.example.yaml argus_web.yaml
+cp argus.yaml argus.local.yaml
+```
+
+Open `argus.local.yaml` and add the database connection information (contact_points, user, password and keyspace name).
+
+Open `argus_web.yaml` and change the `SECRET_KEY` value to something secure, like a sha512 digest of random bytes. Fill out GITHUB_* variables with their respective values.
+
+Copy nginx configuration file from `docs/configs/argus.nginx.conf` to nginx virtual hosts directory:
+
+Ubuntu:
+
+```bash
+sudo cp docs/configs/argus.nginx.conf /etc/nginx/sites-available/argus
+sudo ln -s /etc/nginx/sites-enabled/argus /etc/nginx/sites-available/argus
+```
+
+RHEL/Centos/Alma/Fedora:
+
+```bash
+sudo cp docs/configs/argus.nginx.conf /etc/nginx/conf.d/argus.conf
+```
+
+Adjust the webhost settings in that file as necessary, particularly `listen` and `server_name` directives.
+
+Copy systemd service file from `docs/config/argus.service` to `/etc/systemd/system` directory:
+
+```bash
+sudo cp docs/config/argus.service /etc/systemd/system
+```
+
+Open it and adjust the path to the `start_argus.sh` script in the `ExecStart=` directive and the user/group, then reload systemd daemon configuration and enable (and optionally start) the service.
+
+WARNING: `start_argus.sh` assumes pyenv is installed into `~/.pyenv`
+
+```bash
+sudo systemctl daemon-reload
+sudo systemctl enable --now argus.service
+```
+
+
+

argus_alm-0.12.4b1/README.md

@@ -0,0 +1,109 @@
+# Argus
+
+## Description
+
+Argus is a test tracking system intended to provide observability into automated test pipelines which use long-running resources. It allows observation of a test status, its events and its allocated resources. It also allows easy comparison between particular runs of a specific test.
+
+## Installation notes
+
+### Development
+
+For development setup instructions, see [dev-setup.md](./docs/dev-setup.md).
+
+### Prerequisites
+
+- Python >=3.10.0 (system-wide or pyenv)
+
+- NodeJS >=16 (with npm)
+
+- Yarn (can be installed globally with `npm -g install yarn`)
+
+- nginx
+
+- poetry >=1.2.0b1
+
+### From source
+
+#### Production
+
+Perform the following steps:
+
+Create a user that will be used by uwsgi:
+
+```bash
+useradd -m -s /bin/bash argus
+sudo -iu argus
+```
+
+(Optional) Install pyenv and create a virtualenv for this user:
+
+```bash
+pyenv install 3.10.0
+pyenv virtualenv argus
+pyenv activate argus
+```
+
+Clone the project into a directory somewhere where user has full write permissions
+
+```bash
+git clone https://github.com/scylladb/argus ~/app
+cd ~/app
+```
+
+Install project dependencies:
+
+```bash
+poetry install --with default,dev,web-backend,docker-image
+yarn install
+```
+
+Compile frontend files from `/frontend` into `/public/dist`
+
+```bash
+yarn webpack
+```
+
+Create a `argus.local.yaml` configuration file (used to configure database connection) and a `argus_web.yaml` (used for webapp secrets) in your application install directory.
+
+```bash
+cp argus_web.example.yaml argus_web.yaml
+cp argus.yaml argus.local.yaml
+```
+
+Open `argus.local.yaml` and add the database connection information (contact_points, user, password and keyspace name).
+
+Open `argus_web.yaml` and change the `SECRET_KEY` value to something secure, like a sha512 digest of random bytes. Fill out GITHUB_* variables with their respective values.
+
+Copy nginx configuration file from `docs/configs/argus.nginx.conf` to nginx virtual hosts directory:
+
+Ubuntu:
+
+```bash
+sudo cp docs/configs/argus.nginx.conf /etc/nginx/sites-available/argus
+sudo ln -s /etc/nginx/sites-enabled/argus /etc/nginx/sites-available/argus
+```
+
+RHEL/Centos/Alma/Fedora:
+
+```bash
+sudo cp docs/configs/argus.nginx.conf /etc/nginx/conf.d/argus.conf
+```
+
+Adjust the webhost settings in that file as necessary, particularly `listen` and `server_name` directives.
+
+Copy systemd service file from `docs/config/argus.service` to `/etc/systemd/system` directory:
+
+```bash
+sudo cp docs/config/argus.service /etc/systemd/system
+```
+
+Open it and adjust the path to the `start_argus.sh` script in the `ExecStart=` directive and the user/group, then reload systemd daemon configuration and enable (and optionally start) the service.
+
+WARNING: `start_argus.sh` assumes pyenv is installed into `~/.pyenv`
+
+```bash
+sudo systemctl daemon-reload
+sudo systemctl enable --now argus.service
+```
+
+

{argus_alm-0.12.2 → argus_alm-0.12.4b1}/argus/backend/cli.py

@@ -22,7 +22,7 @@ def sync_models_command():
         LOGGER.info("Synchronizing plugin type %s...", user_type.__name__)
         sync_type(ks_name=cluster.config["SCYLLA_KEYSPACE_NAME"], type_model=user_type)
     LOGGER.info("Synchronizing plugin models...")
-    for model in all_plugin_models():
+    for model in all_plugin_models(True):
         LOGGER.info("Synchronizing plugin model %s...", model.__name__)
         sync_table(model=model, keyspaces=[cluster.config["SCYLLA_KEYSPACE_NAME"]])
 

{argus_alm-0.12.2 → argus_alm-0.12.4b1}/argus/backend/controller/admin_api.py

@@ -261,3 +261,29 @@ def get_tests_for_group():
         "status": "ok",
         "response": tests
     }
+
+
+@bp.route("/release/test/state/toggle", methods=["POST"])
+@check_roles(UserRoles.Admin)
+@api_login_required
+def quick_toggle_test_enabled():
+    
+    payload = get_payload(request)
+    res = ReleaseManagerService().toggle_test_enabled(test_id=payload["entityId"], new_state=payload["state"])
+    return {
+        "status": "ok",
+        "response": res
+    }
+
+
+@bp.route("/release/group/state/toggle", methods=["POST"])
+@check_roles(UserRoles.Admin)
+@api_login_required
+def quick_toggle_group_enabled():
+    
+    payload = get_payload(request)
+    res = ReleaseManagerService().toggle_group_enabled(group_id=payload["entityId"], new_state=payload["state"])
+    return {
+        "status": "ok",
+        "response": res
+    }

{argus_alm-0.12.2 → argus_alm-0.12.4b1}/argus/backend/controller/api.py

@@ -12,7 +12,8 @@ from argus.backend.controller.notification_api import bp as notifications_bp
 from argus.backend.controller.client_api import bp as client_bp
 from argus.backend.controller.testrun_api import bp as testrun_bp
 from argus.backend.controller.team import bp as team_bp
-from argus.backend.service.argus_service import ArgusService
+from argus.backend.controller.view_api import bp as view_bp
+from argus.backend.service.argus_service import ArgusService, ScheduleUpdateRequest
 from argus.backend.service.user import UserService, api_login_required
 from argus.backend.service.stats import ReleaseStatsCollector
 from argus.backend.models.web import ArgusRelease, ArgusGroup, ArgusTest, User, UserOauthToken
@@ -23,6 +24,7 @@ bp.register_blueprint(notifications_bp)
 bp.register_blueprint(client_bp)
 bp.register_blueprint(testrun_bp)
 bp.register_blueprint(team_bp)
+bp.register_blueprint(view_bp)
 bp.register_error_handler(Exception, handle_api_exception)
 LOGGER = logging.getLogger(__name__)
 
@@ -227,6 +229,8 @@ def release_schedules_submit():
         groups=payload["groups"],
         assignees=payload["assignees"],
         tag=payload["tag"],
+        comments=payload.get("comments"),
+        group_ids=payload.get("groupIds"),
     )
 
     return jsonify({
@@ -251,6 +255,27 @@ def release_schedules_delete():
     })
 
 
+@bp.route("/release/schedules/update", methods=["POST"])
+@api_login_required
+def release_schedule_update():
+    payload = get_payload(request)
+    req = ScheduleUpdateRequest(**payload)
+    service = ArgusService()
+    update_result = service.update_schedule(
+        release_id=req.release_id,
+        schedule_id=req.schedule_id,
+        old_tests=req.old_tests,
+        new_tests=req.new_tests,
+        comments=req.comments,
+        assignee=req.assignee
+    )
+
+    return jsonify({
+        "status": "ok",
+        "response": update_result
+    })
+
+
 @bp.route("/groups", methods=["GET"])
 @api_login_required
 def argus_groups():

{argus_alm-0.12.2 → argus_alm-0.12.4b1}/argus/backend/controller/main.py

@@ -1,3 +1,5 @@
+import datetime
+import json
 import logging
 from uuid import UUID
 from flask import (
@@ -8,6 +10,7 @@ from argus.backend.controller.team_ui import bp as teams_bp
 from argus.backend.service.argus_service import ArgusService
 from argus.backend.models.web import WebFileStorage
 from argus.backend.service.user import UserService, login_required
+from argus.backend.service.views import UserViewService
 
 LOGGER = logging.getLogger(__name__)
 
@@ -55,6 +58,24 @@ def releases():
     return render_template("releases.html.j2", releases=all_releases)
 
 
+@bp.route("/views")
+@login_required
+def views():
+    service = UserViewService()
+    all_views = service.get_all_views()
+    return render_template("views.html.j2", views=sorted(all_views, key=lambda view: view.created or datetime.datetime.fromtimestamp(0), reverse=True))
+
+
+@bp.route("/view/<string:view_name>")
+@login_required
+def view_dashboard(view_name: str):
+    service = UserViewService()
+    view = service.get_view_by_name(view_name=view_name)
+    data_json = view
+    view["widget_settings"] = json.loads(view["widget_settings"])
+    return render_template("view_dashboard.html.j2", data=data_json)
+
+
 @bp.route("/alert_debug")
 @login_required
 def alert_debug():

{argus_alm-0.12.2 → argus_alm-0.12.4b1}/argus/backend/controller/testrun_api.py

@@ -6,6 +6,7 @@ from flask import (
 )
 
 from argus.backend.error_handlers import handle_api_exception
+from argus.backend.models.web import ArgusTest
 from argus.backend.service.jenkins_service import JenkinsService
 from argus.backend.service.testrun import TestRunService
 from argus.backend.service.user import api_login_required
@@ -288,6 +289,22 @@ def ignore_jobs():
     }
 
 
+@bp.route("/get_runs_by_test_id_run_id", methods=["POST"])
+@api_login_required
+def get_runs_by_test_id_run_id():
+    payload: list[tuple[UUID, UUID]] = get_payload(request)
+    service = TestRunService()
+
+    result = service.resolve_run_build_id_and_number_multiple(payload)
+
+    return {
+        "status": "ok",
+        "response": {
+            "runs": result
+        }
+    }
+
+
 @bp.route("/jenkins/params", methods=["POST"])
 @api_login_required
 def get_jenkins_job_params():
@@ -336,4 +353,118 @@ def get_queue_info():
         "response": {
             "queueItem": result
         }
-    }
+    }
+
+
+@bp.route("/jenkins/clone/targets")
+@api_login_required
+def get_clone_targets():
+    test_id = request.args.get("testId")
+    if not test_id:
+        raise Exception("No testId provided")
+    service = JenkinsService()
+    result = service.get_releases_for_clone(test_id)
+
+    return {
+        "status": "ok",
+        "response": {
+            "targets": result
+        }
+    }
+
+
+@bp.route("/jenkins/clone/groups")
+@api_login_required
+def get_groups_for_target():
+    target_id = request.args.get("targetId")
+    if not target_id:
+        raise Exception("No targetId provided")
+    service = JenkinsService()
+    result = service.get_groups_for_release(target_id)
+
+    return {
+        "status": "ok",
+        "response": {
+            "groups": result
+        }
+    }
+
+
+@bp.route("/jenkins/clone/create", methods=["POST"])
+@api_login_required
+def clone_jenkins_job():
+
+    payload = get_payload(request)
+    service = JenkinsService()
+
+    result = service.clone_job(
+        current_test_id=payload["currentTestId"],
+        new_name=payload["newName"],
+        target=payload["target"],
+        group=payload["group"],
+        advanced_settings=payload["advancedSettings"],
+    )
+
+    return {
+        "status": "ok",
+        "response": result
+    }
+
+
+@bp.route("/jenkins/clone/build", methods=["POST"])
+@api_login_required
+def clone_build_jenkins_job():
+
+    payload = get_payload(request)
+    service = JenkinsService()
+
+    result = service.clone_build_job(build_id=payload["buildId"], params=payload["parameters"])
+
+    return {
+        "status": "ok",
+        "response": result
+    }
+
+
+@bp.route("/jenkins/clone/settings")
+@api_login_required
+def get_clone_job_advanced_settings():
+    build_id = request.args.get("buildId")
+    if not build_id:
+        raise Exception("No testId provided")
+    service = JenkinsService()
+    result = service.get_advanced_settings(build_id)
+
+    return {
+        "status": "ok",
+        "response": result
+    }
+
+
+@bp.route("/jenkins/clone/settings/change", methods=["POST"])
+@api_login_required
+def set_job_settings():
+    payload = get_payload(request)
+    service = JenkinsService()
+    test = ArgusTest.get(build_system_id=payload["buildId"])
+    result = service.adjust_job_settings(build_id=test.build_system_id, plugin_name=test.plugin_name, settings=payload["settings"])
+
+    return {
+        "status": "ok",
+        "response": result
+    }
+
+
+@bp.route("/jenkins/clone/settings/validate", methods=["POST"])
+@api_login_required
+def clone_validate_new_settings():
+
+    payload = get_payload(request)
+    service = JenkinsService()
+
+    result = service.verify_job_settings(build_id=payload["buildId"], new_settings=payload["newSettings"])
+
+    return {
+        "status": "ok",
+        "response": result
+    }

argus_alm-0.12.4b1/argus/backend/controller/view_api.py

@@ -0,0 +1,162 @@
+import logging
+from uuid import UUID
+from flask import (
+    Blueprint,
+    jsonify,
+    request,
+)
+from argus.backend.error_handlers import handle_api_exception
+from argus.backend.models.web import User
+from argus.backend.service.stats import ViewStatsCollector
+from argus.backend.service.user import api_login_required
+from argus.backend.service.views import UserViewService
+from argus.backend.util.common import get_payload
+
+bp = Blueprint('view_api', __name__, url_prefix='/views')
+LOGGER = logging.getLogger(__name__)
+bp.register_error_handler(Exception, handle_api_exception)
+
+
+class ViewApiException(Exception):
+    pass
+
+
+@bp.route("/", methods=["GET"])
+@api_login_required
+def index():
+    return {
+        "status": "ok",
+        "response": {
+            "version": "v1",
+        }
+    }
+
+
+@bp.route("/create", methods=["POST"])
+@api_login_required
+def create_view():
+    payload = get_payload(request)
+    service = UserViewService()
+    view = service.create_view(
+        name=payload["name"], 
+        items=payload["items"],
+        widget_settings=payload["settings"],
+        description=payload.get("description"),
+        display_name=payload.get("displayName")
+    )
+    return {
+        "status": "ok",
+        "response": view
+    }
+
+
+@bp.route("/get", methods=["GET"])
+@api_login_required
+def get_view():
+    view_id = request.args.get("viewId")
+    if not view_id:
+        raise ViewApiException("No viewId provided.")
+    service = UserViewService()
+    view = service.get_view(UUID(view_id))
+    return {
+        "status": "ok",
+        "response": view
+    }
+
+
+@bp.route("/all", methods=["GET"])
+@api_login_required
+def get_all_views():
+    user_id = request.args.get("userId")
+    if user_id:
+        user = User.get(id=user_id)
+    else:
+        user = None
+    service = UserViewService()
+    views = service.get_all_views(user)
+    return {
+        "status": "ok",
+        "response": views
+    }
+
+
+@bp.route("/update", methods=["POST"])
+@api_login_required
+def update_view():
+    payload = get_payload(request)
+    service = UserViewService()
+    res = service.update_view(view_id=payload["viewId"], update_data=payload["updateData"])
+    return {
+        "status": "ok",
+        "response": res
+    }
+
+
+@bp.route("/delete", methods=["POST"])
+@api_login_required
+def delete_view():
+    payload = get_payload(request)
+    service = UserViewService()
+    res = service.delete_view(payload["viewId"])
+    return {
+        "status": "ok",
+        "response": res
+    }
+
+
+@bp.route("/search", methods=["GET"])
+@api_login_required
+def search_tests():
+    query = request.args.get("query")
+    service = UserViewService()
+    if query:
+        res = service.test_lookup(query)
+    else:
+        res = []
+    return {
+        "status": "ok",
+        "response": {
+            "hits": res,
+            "total": len(res)
+        }
+    }
+
+@bp.route("/stats", methods=["GET"])
+@api_login_required
+def view_stats():
+    view_id = request.args.get("viewId")
+    if not view_id:
+        raise ViewApiException("No view id provided.")
+    limited = bool(int(request.args.get("limited", 0)))
+    version = request.args.get("productVersion", None)
+    include_no_version = bool(int(request.args.get("includeNoVersion", True)))
+    force = bool(int(request.args.get("force",  0)))
+    collector = ViewStatsCollector(view_id=view_id, filter=version)
+    stats = collector.collect(limited=limited, force=force, include_no_version=include_no_version)
+
+    res = jsonify({
+        "status": "ok",
+        "response": stats
+    })
+    res.cache_control.max_age = 300
+    return res
+
+@bp.route("/<string:view_id>/versions", methods=["GET"])
+@api_login_required
+def view_versions(view_id: str):
+    service = UserViewService()
+    res = service.get_versions_for_view(view_id)
+    return {
+        "status": "ok",
+        "response": res
+    }
+
+@bp.route("/<string:view_id>/resolve", methods=["GET"])
+@api_login_required
+def view_resolve(view_id: str):
+    service = UserViewService()
+    res = service.resolve_view_for_edit(view_id)
+    return {
+        "status": "ok",
+        "response": res
+    }