Add more tests

Author: codingjoe

galahad/admin.py

@@ -28,11 +28,11 @@ def rerun(modeladmin, request, queryset):
 
 
 def cancel(modeladmin, request, queryset):
-    succeeded = queryset.succeeded().count()
-    if succeeded:
-        messages.warning(request, "Only failed tasks can be retried. %s tasks have been skipped" % succeeded)
-    queryset.not_succeeded().cancel(request.user)
-    messages.success(request, "Tasks have been successfully queued")
+    not_scheduled = queryset.not_scheduled().count()
+    if not_scheduled:
+        messages.warning(request, "Only scheduled tasks can be canceled. %s tasks have been skipped" % not_scheduled)
+    queryset.scheduled().cancel(request.user)
+    messages.success(request, "Tasks have been successfully canceled")
 
 
 cancel.short_description = t('Cancel selected tasks')
@@ -47,6 +47,11 @@ def has_rerun_permission(self, request):
         codename = get_permission_codename('rerun', opts)
         return request.user.has_perm('%s.%s' % (opts.app_label, codename))
 
+    def has_cancel_permission(self, request):
+        opts = self.opts
+        codename = get_permission_codename('cancel', opts)
+        return request.user.has_perm('%s.%s' % (opts.app_label, codename))
+
     def pretty_stacktrace(self, obj):
         return format_html('<pre class="readonly collapse">{}<pre>', obj.stacktrace)
 
@@ -57,7 +62,7 @@ def child_tasks(self, obj):
 
     child_tasks.short_description = t('Child tasks')
 
-    actions = (rerun,)
+    actions = (rerun, cancel)
 
     list_display = (
         'node_name',

galahad/models.py

@@ -153,10 +153,6 @@ def get_next_nodes(cls, prev_node):
             if start.node_name == prev_node.node_name:
                 yield end
 
-    def finish(self):
-        self.completed = timezone.now()
-        self.save(update_fields=['completed'])
-
     @classmethod
     def get_url_namespace(cls):
         return cls.__name__.lower()
@@ -297,6 +293,9 @@ class TasksQuerySet(models.query.QuerySet):
     def scheduled(self):
         return self.filter(status=self.model.SCHEDULED)
 
+    def not_scheduled(self):
+        return self.exclude(status=self.model.SCHEDULED)
+
     def succeeded(self):
         return self.filter(status=self.model.SUCCEEDED)
 
@@ -496,6 +495,7 @@ def enqueue(self, countdown=None, eta=None):
             'exception',
             'stacktrace',
         ])
+        print(self.status)
         transaction.on_commit(lambda: celery.task_wrapper.apply_async(
             args=(self.pk, self._process_id),
             countdown=countdown,

tests/conftest.py

@@ -9,6 +9,7 @@
 def testdir():
     return pathlib.Path(os.path.dirname(os.path.abspath(__file__)))
 
+
 @pytest.fixture()
 def fixturedir(testdir):
     return testdir / 'fixtures'
@@ -22,6 +23,14 @@ def on_commit(f):
     monkeypatch.setattr('django.db.transaction.on_commit', on_commit)
 
 
+@pytest.fixture()
+def no_on_commit(instant_commit, monkeypatch):
+    def on_commit(f):
+        pass
+
+    monkeypatch.setattr('django.db.transaction.on_commit', on_commit)
+
+
 @pytest.yield_fixture(autouse=True)
 def fake_lock(monkeypatch):
     @contextmanager

tests/test_admin.py

@@ -0,0 +1,65 @@
+import pytest
+from django.contrib.auth.models import AnonymousUser
+from django.contrib.messages.storage.fallback import FallbackStorage
+from django.contrib.sessions.middleware import SessionMiddleware
+
+from galahad import admin
+from galahad.models import Task
+from tests.testapp import models
+
+
+class TestTaskAdmin:
+
+    @pytest.fixture
+    def post_request(self, rf):
+        request = rf.post('/')
+
+        # adding session
+        middleware = SessionMiddleware()
+        middleware.process_request(request)
+        request.session.save()
+
+        # adding messages
+        messages = FallbackStorage(request)
+        setattr(request, '_messages', messages)
+        setattr(request, 'user', AnonymousUser())
+        return request
+
+    def test_rerun(self, db, no_on_commit, post_request):
+        process = models.SimpleProcess.objects.create()
+        task = process.task_set.create(status=Task.FAILED, node_name='save_the_princess')
+        admin.rerun(None, post_request, process.task_set.all())
+        assert '1 tasks have been successfully queued' == str(post_request._messages._queued_messages[0])
+        task.refresh_from_db()
+        assert task.status == Task.SCHEDULED
+
+    def test_rerun__succeeded(self, db, no_on_commit, post_request):
+        process = models.SimpleProcess.objects.create()
+        task = process.task_set.create(status=Task.SUCCEEDED, node_name='save_the_princess')
+        admin.rerun(None, post_request, process.task_set.all())
+        assert 'Only failed tasks can be retried. 1 tasks have been skipped' == \
+               str(post_request._messages._queued_messages[0])
+        assert '0 tasks have been successfully queued' == \
+               str(post_request._messages._queued_messages[1])
+        task.refresh_from_db()
+        assert task.status == Task.SUCCEEDED
+
+    def test_cancel(self, db, post_request):
+        process = models.SimpleProcess.objects.create()
+        task = process.task_set.create(node_name='save_the_princess')
+        admin.cancel(None, post_request, process.task_set.all())
+        assert "Tasks have been successfully canceled" == \
+               str(post_request._messages._queued_messages[0])
+        task.refresh_from_db()
+        assert task.status == Task.CANCELED
+
+    def test_cancel__not_scheduled(self, db, post_request):
+        process = models.SimpleProcess.objects.create()
+        task = process.task_set.create(status=Task.SUCCEEDED, node_name='save_the_princess')
+        admin.cancel(None, post_request, process.task_set.all())
+        assert 'Only scheduled tasks can be canceled. 1 tasks have been skipped' == \
+               str(post_request._messages._queued_messages[0])
+        assert "Tasks have been successfully canceled" == \
+               str(post_request._messages._queued_messages[1])
+        task.refresh_from_db()
+        assert task.status == Task.SUCCEEDED

tests/test_models.py

@@ -1,6 +1,8 @@
 from unittest.mock import patch
 
 import pytest
+from django.contrib.auth import get_user_model
+from django.contrib.auth.models import AnonymousUser
 from django.urls import reverse
 from django.utils import timezone
 from django.utils.safestring import SafeString
@@ -181,6 +183,86 @@ def test_get_instance_graph_svg(self, db, fixturedir):
         svg = process.get_instance_graph_svg()
         assert isinstance(svg, SafeString)
 
+    def test_cancel(self, db):
+        process = models.SimpleProcess.objects.create()
+        process.task_set.create()
+        assert process.task_set.scheduled().exists()
+        process.cancel()
+        assert not process.task_set.scheduled().exists()
+        assert process.task_set.latest().completed_by_user is None
+        assert process.task_set.latest().completed
+
+    def test_cancel__with_user(self, db):
+        process = models.SimpleProcess.objects.create()
+        process.task_set.create()
+        user = get_user_model().objects.create(
+            email='[email protected]',
+            first_name='Peter',
+            last_name='Parker',
+            username='spidy',
+        )
+        process.cancel(user=user)
+        assert process.task_set.latest().completed_by_user == user
+
+    def test_cancel__with_anonymous_user(self, db):
+        process = models.SimpleProcess.objects.create()
+        process.task_set.create()
+        user = AnonymousUser()
+        process.cancel(user=user)
+        assert process.task_set.latest().completed_by_user is None
+
+
+class TestTaskQuerySet:
+
+    def test_scheduled(self, db):
+        process = models.SimpleProcess.objects.create()
+        task = process.task_set.create()
+        process.task_set.create(status=Task.CANCELED)
+        assert process.task_set.scheduled().get() == task
+
+    def test_succeeded(self, db):
+        process = models.SimpleProcess.objects.create()
+        task = process.task_set.create(status=Task.SUCCEEDED)
+        process.task_set.create(status=Task.CANCELED)
+        assert process.task_set.succeeded().get() == task
+
+    def test_not_succeeded(self, db):
+        process = models.SimpleProcess.objects.create()
+        task = process.task_set.create()
+        process.task_set.create(status=Task.SUCCEEDED)
+        assert process.task_set.not_succeeded().get() == task
+
+    def test_failed(self, db):
+        process = models.SimpleProcess.objects.create()
+        task = process.task_set.create(status=Task.FAILED)
+        process.task_set.create(status=Task.CANCELED)
+        assert process.task_set.failed().get() == task
+
+    def test_canceled(self, db):
+        process = models.SimpleProcess.objects.create()
+        task = process.task_set.create(status=Task.CANCELED)
+        process.task_set.create()
+        assert process.task_set.canceled().get() == task
+
+    def test_cancel__with_user(self, db):
+        process = models.SimpleProcess.objects.create()
+        process.task_set.create()
+        user = get_user_model().objects.create(
+            email='[email protected]',
+            first_name='Peter',
+            last_name='Parker',
+            username='spidy',
+        )
+        process.task_set.cancel(user=user)
+        assert process.task_set.latest().completed_by_user == user
+
+    def test_cancel__with_anonymous_user(self, db):
+        process = models.SimpleProcess.objects.create()
+        process.task_set.create()
+        user = AnonymousUser()
+        process.task_set.cancel(user=user)
+        assert process.task_set.latest().completed_by_user is None
+
 
 class TestTask:
 
@@ -239,3 +321,45 @@ def test_fail(self, db):
         assert 'Traceback (most recent call last):\n' in task.stacktrace
         assert '    raise IOError("nope")\n' in task.stacktrace
         assert 'OSError: nope\n' in task.stacktrace
+
+    def test_cancel(self, db):
+        process = models.SimpleProcess.objects.create()
+        task = process.task_set.create()
+        task.cancel()
+        assert task.status == task.CANCELED
+        assert task.completed_by_user is None
+        assert task.completed
+
+    def test_cancel__with_user(self, db):
+        process = models.SimpleProcess.objects.create()
+        task = process.task_set.create()
+        user = get_user_model().objects.create(
+            email='[email protected]',
+            first_name='Peter',
+            last_name='Parker',
+            username='spidy',
+        )
+        task.cancel(user=user)
+        assert task.completed_by_user == user
+
+    def test_cancel__with_anonymous_user(self, db):
+        process = models.SimpleProcess.objects.create()
+        task = process.task_set.create()
+        user = AnonymousUser()
+        task.cancel(user=user)
+        assert task.completed_by_user is None
+
+    def test_save__modified_date(self, db):
+        process = models.SimpleProcess.objects.create()
+        task = process.task_set.create()
+        modified_date = task.modified
+        task.save(update_fields=[])
+        task.refresh_from_db()
+        assert task.modified > modified_date
+
+    def test_save__no_update_fields(self, db):
+        process = models.SimpleProcess.objects.create()
+        task = process.task_set.create()
+        with pytest.raises(ValueError) as e:
+            task.save()
+        assert "You need to provide explicit 'update_fields' to avoid race conditions." in str(e)