Support windows

.github/workflows/test.yml

@@ -7,7 +7,7 @@ on:
   pull_request:
 
 jobs:
-  test:
+  test-docker:
     name: Tests dj${{ matrix.dj }} / ${{ matrix.db }} / py${{ matrix.py }}
 
     runs-on: ubuntu-latest
@@ -47,3 +47,32 @@ jobs:
 
       - name: Run tests
         run: docker compose run django test
+
+  test-windows:
+    name: Tests windows
+
+    runs-on: windows-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Python version
+        run: python --version
+
+      - name: Packages versions
+        run: pip freeze --all
+
+      - name: Setup postgres
+        uses: ikalnytskyi/action-setup-postgres@v4
+
+      - name: Update pip
+        run: pip install --upgrade pip setuptools
+
+      - name: Install python deps
+        run: pip install -r requirements-dev.txt
+
+      - name: Run tests
+        env:
+          TOOSIMPLEQ_TEST_DB: postgres
+          POSTGRES_PORT_WORKER: "5432"
+        run: python manage.py test

README.md

@@ -372,6 +372,7 @@ pre-commit install
   - feature: added workerstatus to the admin, allowing to monitor workers
   - feature: queue tasks for later (`mytask.queue(due=now()+timedelta(hours=2))`)
   - feature: assign queues to schedules (`@schedule_task(queue="schedules")`)
+  - feature: support windows
   - feature: allow manual schedules that are only run manually through the admin  (`@schedule_task(cron="manual")`)
   - refactor: removed non-execution related data from the database (clarifying the fact tha the source of truth is the registry)
   - refactor: better support for concurrent workers

django_toosimple_q/management/commands/worker.py

@@ -68,7 +68,9 @@ def handle(self, *args, **options):
         signal.signal(signal.SIGINT, self.handle_signal)
         signal.signal(signal.SIGTERM, self.handle_signal)
         # Custom signal to provoke an artifical exception, used for testing only
-        signal.signal(signal.SIGUSR1, self.handle_signal)
+        if hasattr(signal, "SIGUSR1"):
+            # this doesn't exist on Windows
+            signal.signal(signal.SIGUSR1, self.handle_signal)
 
         # TODO: replace by simple-parsing
         self.queues = options["queue"] or []
@@ -248,7 +250,7 @@ def do_loop(self) -> bool:
 
     def handle_signal(self, sig, stackframe):
         # For testing, simulates a unexpected crash of the worker
-        if sig == signal.SIGUSR1:
+        if hasattr(signal, "SIGUSR1") and sig == signal.SIGUSR1:
             self.simulate_exception = True
             return
 

django_toosimple_q/tests/base.py

@@ -166,6 +166,7 @@ def start_worker_in_background(
                 env={**os.environ, "DJANGO_SETTINGS_MODULE": settings},
                 stdout=subprocess.PIPE,
                 stderr=subprocess.STDOUT,
+                shell=(os.name == "nt"),  # for some reason this seems needed on windows
             )
         )
 
@@ -182,11 +183,14 @@ def wait_for_qs(self, queryset, exists=True, timeout=15):
 
     def wait_for_tasks(self, timeout=15):
         """Waits untill all tasks are marked as done in the database"""
-        return self.wait_for_qs(
-            TaskExec.objects.filter(state__in=TaskExec.States.todo()),
-            exists=False,
-            timeout=timeout,
-        )
+        try:
+            return self.wait_for_qs(
+                TaskExec.objects.filter(state__in=TaskExec.States.todo()),
+                exists=False,
+                timeout=timeout,
+            )
+        except AssertionError:
+            self.workers_get_stdout()
 
     def workers_get_stdout(self):
         """Stops the workers if needed and returns the stdout of the last worker, or raises an exception on error.

django_toosimple_q/tests/tests_worker.py

@@ -1,5 +1,7 @@
+import os
 import signal
 import time
+import unittest
 
 from django.core import management
 from freezegun import freeze_time
@@ -70,7 +72,11 @@ def _start_worker_with_task(self, duration=10):
         )
 
         # Wait for the task to be picked up by the worker
-        self.wait_for_qs(TaskExec.objects.filter(state=TaskExec.States.PROCESSING))
+        try:
+            self.wait_for_qs(TaskExec.objects.filter(state=TaskExec.States.PROCESSING))
+        except AssertionError:
+            # Show the error
+            self.workers_get_stdout()
 
         # Keep id of the first task for further reference
         self.__first_task_pk = TaskExec.objects.first().pk
@@ -140,6 +146,9 @@ def test_terminate(self):
         self.assertIsNotNone(self.taskexec.replaced_by)
         self.assertEqual(self.taskexec.replaced_by.state, TaskExec.States.SLEEPING)
 
+    @unittest.skipIf(
+        not hasattr(signal, "SIGUSR1"), "USR1 signal not available on this platform"
+    )
     def test_worker_crash(self):
         self._start_worker_with_task()
 
@@ -156,6 +165,9 @@ def test_worker_crash(self):
 
         # The failure is not linked to the task
 
+    @unittest.skipIf(
+        os.name == "nt", "didn't find a way to gracefully stop subprocess on windows"
+    )
     def test_quit(self):
         self._start_worker_with_task()