devilry 6.4.2__tar.gz → 6.4.3__tar.gz

{devilry-6.4.2 → devilry-6.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: devilry
-Version: 6.4.2
+Version: 6.4.3
 Summary: A system for handling electronic deliveries. See https://github.com/devilry/devilry-django.
 Author: Tor Johansen, Bendik Opstad, Vegard Angell, Magne Westlie, Ilya Kostolomov, Christian Tryti, Rebekka Mørken, Stian Julseth, Åsmund J. Rosendahl
 Author-email: Espen Angell Kristiansen <post@appresso.no>

devilry-6.4.3/devilry/__init__.py

@@ -0,0 +1 @@
+__version__ = '6.4.3'

{devilry-6.4.2 → devilry-6.4.3}/devilry/devilry_compressionutil/abstract_batch_action.py

@@ -4,7 +4,7 @@
 import os
 from ievv_opensource.ievv_batchframework import batchregistry
 
-from devilry.utils.report_error import report_devilry_error
+from devilry.utils.report_error import debug_error_trigger, report_devilry_error
 
 
 class AbstractBaseBatchAction(batchregistry.Action):
@@ -55,6 +55,7 @@ class AbstractBaseBatchAction(batchregistry.Action):
     def run(cls, **kwargs):
         action = cls(**kwargs)
         try:
+            debug_error_trigger(user=kwargs.get('started_by', None), context=cls.get_name())
             action.execute()
         except Exception as e:
             report_devilry_error(
@@ -63,6 +64,7 @@ class AbstractBaseBatchAction(batchregistry.Action):
                 exception=e,
                 user=kwargs.get('started_by')
             )
+            raise
 
     def execute(self):
         raise NotImplementedError()

devilry-6.4.3/devilry/devilry_superadmin/management/commands/devilry_test_rq_task.py

@@ -0,0 +1,28 @@
+import django_rq
+from django.core.management.base import BaseCommand, CommandError
+
+from devilry.devilry_superadmin import tasks
+from devilry.utils.management import add_input_encoding_argument
+
+
+class Command(BaseCommand):
+    help = "Used to queue tasks for testing if RQ and error reporting works as intended."
+
+    def add_arguments(self, parser):
+        parser.add_argument("taskname", help="The task to enqueue.", choices=["success", "fail", "crash"])
+        parser.add_argument(
+            "--userid", type=int, help="User ID to run the task as. Only used for the 'fail' task.", required=False
+        )
+        parser.add_argument("--queue", default="default", help="RQ queue. Which queue the task should run on.")
+        add_input_encoding_argument(parser)
+
+    def handle(self, *args, **options):
+        queue = django_rq.get_queue(name=options["queue"])
+        taskname = options["taskname"]
+        userid = options.get("userid")
+        if taskname == "success":
+            queue.enqueue(tasks.success, 3, 5)
+        elif taskname == "fail":
+            queue.enqueue(tasks.fail, userid=userid)
+        elif taskname == "crash":
+            queue.enqueue(tasks.crash)

devilry-6.4.3/devilry/devilry_superadmin/tasks.py

@@ -0,0 +1,27 @@
+from django.contrib.auth import get_user_model
+
+from devilry.utils.report_error import debug_error_trigger, report_devilry_error
+
+
+def success(x, y):
+    return x + y
+
+
+def crash():
+    raise ValueError("This task always crashes.")
+
+
+def fail(userid=None):
+    user = None
+    try:
+        if userid:
+            user = get_user_model().objects.get(id=userid)
+        debug_error_trigger(user=user, context="'fail' debug task")
+        raise ValueError("This task always fails gracefully.")
+    except Exception as e:
+        report_devilry_error(
+            context=f"'fail' debug task",
+            message="Error in the 'fail' debug task: {}".format(str(e)),
+            exception=e,
+            user=user,
+        )

{devilry-6.4.2 → devilry-6.4.3}/devilry/project/develop/settings/develop.py

@@ -30,9 +30,7 @@ MIDDLEWARE = MIDDLEWARE + [
 # Django Silk
 #
 ######################
-INSTALLED_APPS += [
-    'silk'
-]
+INSTALLED_APPS += ["silk"]
 
 
 #######################################################
@@ -357,3 +355,5 @@ DEVILRY_USE_STORAGE_BACKEND_URL_FOR_FILE_DOWNLOADS = True
 
 
 DEVILRY_MEMORY_DEBUG_ENABLED = True
+
+# DEVILRY_DEBUG_ERROR_TRIGGER_USER_SHORTNAMES = ["thor@example.com", "april@example.com"]

{devilry-6.4.2 → devilry-6.4.3}/devilry/utils/devilry_email.py

@@ -8,6 +8,8 @@ from django.conf import settings
 from django.template.loader import render_to_string
 import html2text
 
+from devilry.utils.report_error import debug_error_trigger
+
 logger = logging.getLogger(__name__)
 
 
@@ -46,6 +48,7 @@ def send_message(subject, message, *user_objects_to_send_to, **kwargs):
         else:
             errmsg = "User {0} has no email address.".format(user.shortname)
             logger.error(errmsg)
+        debug_error_trigger(user=user, context="send_message()")
     subject = settings.EMAIL_SUBJECT_PREFIX + subject
     try:
         send_mail(subject, plain_message, settings.DEVILRY_EMAIL_DEFAULT_FROM,

{devilry-6.4.2 → devilry-6.4.3}/devilry/utils/report_error.py

@@ -91,3 +91,35 @@ def report_devilry_error(
         ReporterClass = ErrorReporter
     reporter = ReporterClass(context=context, message=message, exception=exception, user=user)
     reporter.report()
+
+
+class FakeException(Exception):
+    pass
+
+
+def debug_error_trigger(user, context=None):
+    """
+    Function to trigger an error for testing error reporting.
+
+    Raises a FakeException if the provided user has `user.shortname` in the
+    `DEVILRY_DEBUG_ERROR_TRIGGER_USER_SHORTNAMES` setting.
+
+    Example setup in `settings.py`::
+
+        DEVILRY_DEBUG_ERROR_TRIGGER_USER_SHORTNAMES = ['thefirstsuperuser', 'theothersuperuser']
+
+    """
+    trigger_shortnames = getattr(settings, "DEVILRY_DEBUG_ERROR_TRIGGER_USER_SHORTNAMES", None)
+    if not trigger_shortnames:
+        return
+    if not user or not user.is_authenticated:
+        return
+
+    if user.shortname in trigger_shortnames:
+        errormessage = (
+            f"Debug error triggered for testing error reporting because {user.shortname} is in "
+            f"the DEVILRY_DEBUG_ERROR_TRIGGER_USER_SHORTNAMES setting."
+        )
+        if context:
+            errormessage += f" Context info: {context}"
+        raise FakeException(errormessage)

{devilry-6.4.2 → devilry-6.4.3}/pyproject.toml

@@ -102,7 +102,7 @@ exclude = [
 
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "6.4.2"
+version = "6.4.3"
 version_files = ["devilry/__init__.py:__version__"]
 tag_format = "$version"
 update_changelog_on_bump = true

devilry-6.4.2/devilry/__init__.py

@@ -1 +0,0 @@
-__version__ = '6.4.2'

devilry-6.4.2/devilry/devilry_superadmin/management/commands/devilry_test_rq_task.py

@@ -1,23 +0,0 @@
-from django.core.management.base import BaseCommand, CommandError
-
-import django_rq
-
-from devilry.utils.management import add_input_encoding_argument
-from devilry.devilry_superadmin import tasks
-
-
-class Command(BaseCommand):
-    help = 'Create new user.'
-
-    def add_arguments(self, parser):
-        parser.add_argument(
-            '--queue',
-            default='default',
-            help='RQ queue. Which queue the task should run on.'),
-        add_input_encoding_argument(parser)
-
-    def handle(self, *args, **options):
-        queue = options['queue']
-        queue = django_rq.get_queue(name=queue)
-        queue.enqueue(tasks.add, 3, 5)
-

devilry-6.4.2/devilry/devilry_superadmin/tasks.py

@@ -1,2 +0,0 @@
-def add(x, y):
-    return x + y