argus-server 2.4.0__tar.gz → 2.5.0__tar.gz

{argus_server-2.4.0 → argus_server-2.5.0}/CHANGELOG.md

@@ -4,10 +4,50 @@ read by developers.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-This project uses [*towncrier*](https://towncrier.readthedocs.io/) and the changes for the upcoming release can be found in <https://github.com/Uninett/Argus/tree/master/changelog.d/>.
+This project uses [*towncrier*](https://towncrier.readthedocs.io/) and the changes for the upcoming release can be found in <https://github.com/Uninett/Argus/tree/main/changelog.d/>.
 
 <!-- towncrier release notes start -->
 
+## [2.5.0] - 2025-12-04
+
+The big new thing this time around is a way to prevent notifications from
+certain incidents by masking them via a planned maintenance filter stored in
+a planned maintenance task. This task works just like a notification profile:
+more filters add precision. The only way to set up a filter right now is via
+the admin. Users with admin-access can click on the admin link, see the section
+"ARGUS_PLANNEDMAINTENANCE".
+
+We want some feedback on the feature before we add support
+for setting up planned maintenance tasks via the API and the frontend.
+
+Otherwise: work on increasing consistency in the frontend continues, and the
+version number of argus should now always be available.
+
+Customizers, please see the NOTES.md, the preferences page has more changes.
+
+Remember to migrate if upgrading.
+
+### Added
+
+- Add preview for theme and date format preferences
+  ([#1557](https://github.com/Uninett/Argus/issues/1557))
+- Add model for planned maintenance tasks
+  ([#1586](https://github.com/Uninett/Argus/issues/1586))
+- Added functionality to add/edit planned maintenance tasks to Django admin
+  ([#1587](https://github.com/Uninett/Argus/issues/1587))
+- Filter out events covered by ongoing planned maintenance tasks from being
+  sent ([#1588](https://github.com/Uninett/Argus/issues/1588))
+- Added Argus version number to user menu dropdown and login page
+  ([#1650](https://github.com/Uninett/Argus/issues/1650))
+
+### Changed
+
+- Split user preferences into multiple sections
+  ([#1557](https://github.com/Uninett/Argus/issues/1557))
+- Increase accessibility of cards by using borders instead of shadow
+  ([#1641](https://github.com/Uninett/Argus/issues/1641))
+
+
 ## [2.4.0] - 2025-11-28
 
 The most important feature this release is being able to filter on source

{argus_server-2.4.0 → argus_server-2.5.0}/NOTES.md

@@ -3,6 +3,21 @@
 This file documents changes to Argus that are relevant for operations,
 customizers and end-users.
 
+## [2.5.0] - 2025-12-04
+
+This release adds a new app, "argus.plannedmaintenance", which uses a new
+database table, so remember to migrate.
+
+The new table is to store planned maintenance tasks, which are used to exclude
+some notifications from being sent. A notification is only sent *iff* an
+incident and its events are not found by any filter during a currently ongoing
+planned maintenance task.
+
+Customizers: We have started work on adding previews to all the preferences;
+first out is previews of themes and date formats. If you have added your own
+preferences or otherwise customized the preferences page you need to take extra
+care when upgrading.
+
 ## [2.4.0] - 2025-11-28
 
 The most important feature this release is being able to filter on source

{argus_server-2.4.0 → argus_server-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: argus-server
-Version: 2.4.0
+Version: 2.5.0
 Summary: Argus is an alert aggregator for monitoring systems
 Project-URL: Homepage, https://github.com/Uninett/Argus
 Author-email: Uninett Opensource <opensource@uninett.no>
@@ -59,7 +59,7 @@ Description-Content-Type: text/markdown
 
 # Argus
 [![test badge](https://github.com/Uninett/Argus/actions/workflows/python.yml/badge.svg)](https://github.com/Uninett/Argus/actions)
-[![codecov badge](https://codecov.io/gh/Uninett/Argus/branch/master/graph/badge.svg)](https://codecov.io/gh/Uninett/Argus)
+[![codecov badge](https://codecov.io/gh/Uninett/Argus/branch/main/graph/badge.svg)](https://codecov.io/gh/Uninett/Argus)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![djLint](https://img.shields.io/badge/html%20style-djlint-blue.svg)](https://www.djlint.com)
 [![docs badge](https://readthedocs.org/projects/argus-server/badge/?version=latest&style=flat)](http://argus-server.rtfd.io/en/latest/)
@@ -320,12 +320,12 @@ Refer to the [tox.ini](tox.ini) file for further options.
 
 Do not ever remove these
 
-* master
+* main
 * argus-demo
 * stable/SOMETHING
 
 The last branch-type is for backporting bugfixes and similar to older releases,
-bypassing master if necessary.
+bypassing main if necessary.
 
 
 ## How to do maintenance

{argus_server-2.4.0 → argus_server-2.5.0}/README.md

@@ -1,6 +1,6 @@
 # Argus
 [![test badge](https://github.com/Uninett/Argus/actions/workflows/python.yml/badge.svg)](https://github.com/Uninett/Argus/actions)
-[![codecov badge](https://codecov.io/gh/Uninett/Argus/branch/master/graph/badge.svg)](https://codecov.io/gh/Uninett/Argus)
+[![codecov badge](https://codecov.io/gh/Uninett/Argus/branch/main/graph/badge.svg)](https://codecov.io/gh/Uninett/Argus)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![djLint](https://img.shields.io/badge/html%20style-djlint-blue.svg)](https://www.djlint.com)
 [![docs badge](https://readthedocs.org/projects/argus-server/badge/?version=latest&style=flat)](http://argus-server.rtfd.io/en/latest/)
@@ -261,12 +261,12 @@ Refer to the [tox.ini](tox.ini) file for further options.
 
 Do not ever remove these
 
-* master
+* main
 * argus-demo
 * stable/SOMETHING
 
 The last branch-type is for backporting bugfixes and similar to older releases,
-bypassing master if necessary.
+bypassing main if necessary.
 
 
 ## How to do maintenance

{argus_server-2.4.0 → argus_server-2.5.0}/codecov.yml

@@ -2,10 +2,10 @@ coverage:
   status:
     project:
       default:
-        threshold: 90%
+        threshold: 1%
     patch:
       default:
-        threshold: 90%
+        threshold: 1%
 
 ignore:
   - "manage.py"

{argus_server-2.4.0 → argus_server-2.5.0}/docs/about-argus.rst

@@ -67,6 +67,7 @@ server, such as:
 * Administration of Argus user accounts
 * Creating API authentication tokens for users
 * Defining new source systems to collect incidents from
+* Creating and updating planned maintenance tasks
 
 Pick and choose
 ---------------

{argus_server-2.4.0 → argus_server-2.5.0}/docs/development/howtos/regenerate-the-ER-diagram.rst

@@ -20,7 +20,7 @@ Test by making a .dot-file
 
 To test if everything is installed correctly, run::
 
-    python manage.py graph_models argus_auth argus_incident argus_notificationprofile \
+    python manage.py graph_models argus_auth argus_incident argus_notificationprofile argus_plannedmaintenance \
     --group-models -X Permission,AbstractUser,AbstractBaseUser,PermissionsMixin
 
 This will dump a `.dot-file <https://graphviz.org/doc/info/lang.html>`_, the
@@ -42,7 +42,7 @@ We need to have one more dependency installed: one of ``pygraphviz`` or
 
 To generate the final PNG in the correct location, run::
 
-    python manage.py graph_models argus_auth argus_incident argus_notificationprofile \
+    python manage.py graph_models argus_auth argus_incident argus_notificationprofile argus_plannedmaintenance \
     --group-models -X Permission,AbstractUser,AbstractBaseUser,PermissionsMixin \
     -o docs/reference/img/ER_model.png
 
@@ -52,7 +52,7 @@ Use ``graphviz`` directly on a .dot-file
 1. Make sure you have graphviz installed, how is OS/distro dependent
 2. Generate the dot-file with::
 
-    python manage.py graph_models argus_auth argus_incident argus_notificationprofile \
+    python manage.py graph_models argus_auth argus_incident argus_notificationprofile argus_plannedmaintenance \
     --group-models -X Permission,AbstractUser,AbstractBaseUser,PermissionsMixin \
     -o ER_model.dot
 3. Generate the PNG with ``dot``::

{argus_server-2.4.0 → argus_server-2.5.0}/docs/development/howtos/release-checklist.rst

@@ -43,11 +43,11 @@ not needed to do this yet.
 Checklist
 ---------
 
-#. Ensure you're on the correct branch to be released. Either ``master`` or
+#. Ensure you're on the correct branch to be released. Either ``main`` or
    newest stable, which has a name of the form ``stable/1.5.x``. Release from
    the stable branch only under exceptional circumstances. For instance:
    there's a critical bugfix for production and there's a lot of new stuff on
-   master that is not ready to go.
+   main that is not ready to go.
 
 #. Check that there are no files that have not been commited:
 

{argus_server-2.4.0 → argus_server-2.5.0}/docs/development/howtos/vendor-a-repo.rst

@@ -55,7 +55,7 @@ Prep the ORIGIN repo
 
         git fetch TARGET
 
-9. Merge ORIGIN-clone's "main" into feceiving's "master"::
+9. Merge ORIGIN-clone's "main" into receiving's "master"::
 
         git merge --allow-unrelated-histories TARGET/master
 

{argus_server-2.4.0 → argus_server-2.5.0}/docs/django_settings.py

@@ -25,6 +25,7 @@ INSTALLED_APPS = [
     "argus.filter",
     "argus.notificationprofile",
     "argus.dev",
+    "argus.plannedmaintenance",
 ]
 
 MEDIA_PLUGINS = []

{argus_server-2.4.0 → argus_server-2.5.0}/docs/integrations/notifications/writing-notification-plugins.rst

@@ -4,7 +4,7 @@ Writing your own notification plugin
 ====================================
 
 When writing a new notification plugin the plugins for
-`SMS-as-Email <https://github.com/Uninett/Argus/blob/master/src/argus/notificationprofile/media/sms_as_email.py>`_
+`SMS-as-Email <https://github.com/Uninett/Argus/blob/main/src/argus/notificationprofile/media/sms_as_email.py>`_
 and
 `Teams <https://github.com/Uninett/argus_notification_msteams/blob/main/src/argus_notification_msteams.py>`_
 can be used as guides.

{argus_server-2.4.0 → argus_server-2.5.0}/docs/reference/models.rst

@@ -89,6 +89,18 @@ Handling notifications
       Holds a ``DestinationConfig``'s type. The ``installed``-field is updated
       on startup to keep track of which ``notification plugin``\s are installed.
 
+Handling maintenance work
+=========================
+
+.. glossary::
+
+   PlannedMaintenanceTask
+      Holds who created the task and when (not editable), the start and end time
+      of such a task, and a description of what this maintenance work entails and/or
+      why it is happening.
+
+      It also holds a collection of ``Filter``\s that describe what kind of events are
+      covered by that planned maintenance.
 
 ER diagram
 ==========

argus_server-2.5.0/docs/reference/planned-maintenance.rst

@@ -0,0 +1,43 @@
+===================
+Planned maintenance
+===================
+
+To interact with planned maintenance tasks visit the admin interface at:
+``/admin/argus_plannedmaintenance/plannedmaintenancetask/``.
+
+A planned maintenance task consists of a start time and an end time (where the latter
+is by default infinity). Those define the period during which planned work is happening
+and when notifications for events, for example for affected devices, should not be
+sent.
+
+Filters are used to define exactly which kind of events notifications should be
+suppressed for. As it is for notification profiles, if multiple filters are connected
+to one planned maintenance task, then that tasks will only lead to a notification being
+suppressed if all of the filters apply to that event.
+
+.. warning:: When notifications are suppressed during a planned maintenance task and
+    that task ends, while the incident is still open, you will not receive a
+    notification.
+    It is your responsibility to check that everything is resolved when a planned
+    maintenance task is finished!
+
+The planned maintenance task list
+=================================
+
+In the admin you can view a list of planned maintenance tasks, filter them and search
+for specific ones.
+
+You can also select multiple planned maintenance tasks and delete them or mark them as
+finished. Marking a task as finished will set an open task's end time to the current
+time. If you mark a task as finished that has not begun yet, then that task will be
+deleted.
+
+Adding/editing a planned maintenance task
+=========================================
+
+If you want to add a planned maintenance task click the
+``Add planned maintenance task`` button. If you want to see details for a specific
+task or edit it, click the username in the column ``created by``.
+
+You can mark an existing task as finished and see its history by clicking on the
+buttons in the top right corner of the edit page.

{argus_server-2.4.0 → argus_server-2.5.0}/src/argus/auth/factories.py

@@ -16,7 +16,6 @@ class BaseUserFactory(factory.django.DjangoModelFactory):
 
     is_staff = False
     is_superuser = False
-    password = factory.PostGenerationMethodCall("set_password", "defaultpassword")
 
 
 class PersonUserFactory(BaseUserFactory):
@@ -30,6 +29,7 @@ class PersonUserFactory(BaseUserFactory):
         lambda o: "%s.%s@%s" % (o.first_name.lower(), o.last_name.lower(), factory.Faker("safe_domain_name"))
     )
     username = email
+    password = factory.django.Password("very SECRET P455w0rD")
 
 
 class SourceUserFactory(BaseUserFactory):
@@ -40,6 +40,7 @@ class SourceUserFactory(BaseUserFactory):
     username = factory.Sequence(lambda n: "source_%d" % n)
     is_staff = False
     is_superuser = False
+    password = factory.django.Password(None)
 
 
 class AdminUserFactory(PersonUserFactory):

{argus_server-2.4.0 → argus_server-2.5.0}/src/argus/dev/management/commands/create_fake_incident.py

@@ -8,6 +8,7 @@ from django.contrib.auth import get_user_model
 from django.core.exceptions import ValidationError
 from django.core.management import CommandError, call_command
 from django.core.management.base import BaseCommand
+from django.db.utils import IntegrityError
 
 from argus.dev.utils import get_json_from_file
 from argus.incident.constants import Level
@@ -125,5 +126,5 @@ class Command(BaseCommand):
 
             try:
                 create_fake_incident(**incident)
-            except (ValueError, ValidationError) as e:
+            except (IntegrityError, ValueError, ValidationError) as e:
                 self.stderr.write(self.style.ERROR(str(e)))

{argus_server-2.4.0 → argus_server-2.5.0}/src/argus/dev/management/commands/create_source.py

@@ -1,6 +1,9 @@
 from django.core.management.base import BaseCommand
+from django.db import transaction
 
+from argus.auth.factories import SourceUserFactory
 from argus.incident.factories import SourceSystemFactory, SourceSystemTypeFactory
+from argus.incident.models import SourceSystem
 
 
 class Command(BaseCommand):
@@ -15,5 +18,9 @@ class Command(BaseCommand):
     def handle(self, *args, **options):
         source = options["source"]
         source_type = options.get("source_type") or "argus"
-        sst = SourceSystemTypeFactory(name=source_type.lower())
-        SourceSystemFactory(name=source, type=sst)
+        if SourceSystem.objects.filter(name=source, type__name=source_type).exists():
+            return
+        with transaction.atomic():
+            user = SourceUserFactory(username=source)
+            sst = SourceSystemTypeFactory(name=source_type.lower())
+            SourceSystemFactory(user=user, name=source, type=sst)

{argus_server-2.4.0 → argus_server-2.5.0}/src/argus/htmx/context_processors.py

@@ -10,6 +10,7 @@ See django settings for ``TEMPLATES``.
 from django.conf import settings
 
 from . import defaults
+from argus.site.views import get_version
 
 
 def static_paths(request):
@@ -23,3 +24,7 @@ def static_paths(request):
 
 def banner_message(request):
     return {"banner_message": getattr(settings, "BANNER_MESSAGE", None)}
+
+
+def metadata(request):
+    return {"version": get_version()}