Merge branch 'release/5.6.3' into 'master'

Release/5.6.3 - master

See merge request os2borgerpc/os2borgerpc-admin-site!286

Author: Søren Howe Gersager

.gitlab-ci.yml

@@ -53,7 +53,6 @@ Lint Python:
     script:
         - cd admin_site
         - black --check --diff --exclude=migrations .
-        - flake8 . --exclude=migrations
 
 Lint Dockerfiles:
       <<: *lint-default

NEWS.rst

@@ -1,3 +1,13 @@
+Version 5.6.3, June 8, 2022
+---------------------------
+
+New in this version:
+
+- Add maintenance script support (scripts run as superuser)
+- Add a database index on PC uid field
+- Move print_db_files management command to the correct place
+- Remove flake8 from linters
+
 Version 5.6.2, June 2, 2022
 ---------------------------
 

VERSION

@@ -1 +1 @@
-5.6.2
+5.6.3

admin_site/requirements.txt

@@ -8,7 +8,6 @@ django-crispy-forms==1.13.0
 django-extensions==3.1.5
 django-storages==1.12.3
 django-xmlrpc==0.1.8
-flake8==4.0.1
 google-api-core==2.2.2
 google-auth==2.3.3
 google-cloud-core==2.2.1

admin_site/static/js/jobs_list.js

@@ -34,12 +34,14 @@ $(function(){
                 }
                 var script_link = '<a href="' + this.script_url + '">' + this.script_name + '</a>'
                 var pc_link = '<a href="' + this.pc_url + '">' + this.pc_name + '</a>'
+                var user_link = '<a href="' + this.user_url + '">' + this.user + '</a>'
                 var item = $(BibOS.expandTemplate(
                     'job-entry',
                     $.extend(this, {
                         'jobinfobutton': info_button,
                         'script_link' : script_link,
-                        'pc_link' : pc_link
+                        'pc_link' : pc_link,
+                        'user_link': user_link
                     })
                 ))
                 item.find('input:checkbox').on("click", function() {

admin_site/system/admin.py

@@ -1,10 +1,11 @@
+from hashlib import md5
+
 from django.contrib import admin
 from django.db.models import Count
 from django.utils import timezone
 from django.utils.html import format_html_join, escape, mark_safe
 from django.utils.translation import ugettext_lazy as _
 from django.urls import reverse
-from hashlib import md5
 
 from system.models import (
     Configuration,
@@ -218,6 +219,10 @@ class PCAdmin(admin.ModelAdmin):
         "last_seen",
         "created",
     )
+    list_filter = (
+        "site",
+        "is_activated",
+    )
     search_fields = ("name", "uid")
     readonly_fields = ("created",)
 
@@ -242,7 +247,16 @@ def get_search_results(self, request, queryset, search_term):
 
 
 class JobAdmin(admin.ModelAdmin):
-    list_display = ("__str__", "status", "user", "pc", "created", "started", "finished")
+    list_display = (
+        "__str__",
+        "status",
+        "user",
+        "pc",
+        "created",
+        "started",
+        "finished",
+    )
+    list_filter = ("status",)
     search_fields = ("batch__name", "user__username", "pc__name")
     readonly_fields = ("created", "started", "finished")
 

scripts/cleanup_old_media_files/db_files.py renamed to admin_site/system/management/commands/print_db_files.py

@@ -0,0 +1,105 @@
+# Copyright (C) 2021 Magenta ApS, https://magenta.dk.
+# Contact: [email protected].
+
+from django.core.management.base import (
+    BaseCommand,
+    CommandError,
+)
+from django.db import transaction
+from django.contrib.auth import get_user_model
+from system.models import (
+    Site,
+    Script,
+    Batch,
+    Job,
+    PCGroup,
+    PC,
+)
+
+User = get_user_model()
+
+
+class Command(BaseCommand):
+    """
+    Run a script on pcs, group or site as maintenance jobs.
+
+    Notes:
+    Only scripts without arguments are supported for now.
+    Sites and Groups arguments take UID's while the PC argument takes ID's.
+    The script does not validate that a given group, site or PC exists. In case one doesn't match, it's silently ignored.
+
+    Form:
+            $ python manage.py run_maintenance_script <user_username> <script_uid_to_run> <batch_site_uid> {--pcs <target_pc_ids...> | --groups <target_group_uids...>| --sites <target_site_uids...>}
+    Examples:
+
+        $ python manage.py run_maintenance_script shg 1 magenta --pcs 1 4
+        $ python manage.py run_maintenance_script jabbi 3 magenta-test --groups group1
+        $ python manage.py run_maintenance_script gitte 2 magenta --sites magenta mag test
+
+
+    """
+
+    help = "Run a maintenance job script on pcs, groups or sites"
+
+    def add_arguments(self, parser):
+        parser.add_argument(
+            "username", nargs="?", type=str, help="username of the user"
+        )
+        parser.add_argument("script", nargs="?", type=int, help="the id of the script")
+        parser.add_argument(
+            "script_site", nargs="?", type=str, help="the uid of the site"
+        )
+        parser.add_argument("--pcs", nargs="*", type=int, help="a list of pc uids")
+        parser.add_argument("--sites", nargs="*", type=str, help="the uid of a site")
+        parser.add_argument("--groups", nargs="*", type=str, help="the uid of a group")
+
+    @transaction.atomic
+    def handle(self, *args, **options):
+        script_id = options["script"]
+        script_site_uid = options["script_site"]
+        username = options["username"]
+
+        user = User.objects.filter(is_superuser=True, username=username).first()
+        if not user:
+            raise CommandError(f"User with username: {username} does not exist")
+
+        script = Script.objects.filter(id=script_id).first()
+        if not script:
+            raise CommandError(f"Script with ID: {script_id} does not exist")
+
+        script_site = Site.objects.filter(uid=script_site_uid).first()
+        if not script_site:
+            raise CommandError(f"Site with UID: {script_site_uid} does not exist")
+
+        if options["pcs"]:
+            pcs = PC.objects.filter(id__in=options["pcs"])
+        elif options["sites"]:
+            site_uids = options["sites"]
+            sites = Site.objects.filter(uid__in=site_uids)
+            pcs = PC.objects.filter(site__in=sites)
+        elif options["groups"]:
+            group_ids = options["groups"]
+            pc_groups = PCGroup.objects.filter(uid__in=group_ids)
+            pcs = PC.objects.filter(pc_groups__in=pc_groups)
+        else:
+            raise CommandError("--pcs, --site or --group needs to be given")
+
+        self.stdout.write(
+            self.style.SUCCESS(
+                f"Do you want to run {script} on site {script_site}"
+                f" as user {username} for {pcs.count()} PCs? (Y/y for yes)"
+            )
+        )
+        confirmation = input()
+        if confirmation in ["y", "Y"]:
+            batch = Batch.objects.create(site=script_site, script=script, name="")
+            for pc in pcs:
+                Job.objects.create(user=user, batch=batch, pc=pc)
+                self.stdout.write(
+                    self.style.SUCCESS(
+                        f"Maintenance job was created for pc: {pc}"
+                        f" for site: {script_site}"
+                    )
+                )
+        else:
+            self.stdout.write(self.style.WARNING("Aborting"))

admin_site/system/management/commands/run_maintenance_script.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.2.12 on 2022-06-07 14:01
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("system", "0053_auto_20220602_1522"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="pc",
+            name="uid",
+            field=models.CharField(verbose_name="UID", max_length=255, db_index=True),
+        ),
+    ]

admin_site/system/migrations/0054_alter_pc_uid.py

@@ -336,7 +336,7 @@ class PC(models.Model):
 
     mac = models.CharField(verbose_name=_("MAC"), max_length=255, blank=True)
     name = models.CharField(verbose_name=_("name"), max_length=255)
-    uid = models.CharField(verbose_name=_("UID"), max_length=255)
+    uid = models.CharField(verbose_name=_("UID"), max_length=255, db_index=True)
     description = models.CharField(
         verbose_name=_("description"), max_length=1024, blank=True
     )