[tests:fix] Switched to ChannelsLiveServerTestCase #466 #465

dee077 · 2025-04-28T18:56:18Z

Replaced StaticLiveServerTestCase with ChannelsLiveServerTestCase to resolve JS errors caused by failed websocket connections.

Fixes #466

Checklist

I have read the OpenWISP Contributing Guidelines.
I have manually tested the changes proposed in this pull request.

Reference to Existing Issue

Closes #466.

Description of Changes

Changed StaticLiveServerTestCase to ChannelsLiveServerTestCase.
Updated to Django 5.2.0 in ci.
Removed --parallel for running test in ci.

Issues

ChannelsLiveServerTestCase does not support Django 5.2 yet.
For running test --parallel does not work.

nemesifier

Looks on the right track to me.

Question: how can we be sure it's working as expected and there's no JS errors?
Wouldn't it make sense to add at least one test for this?

CI is not passing on Django 5.2, why is that?

nemesifier · 2025-05-08T23:46:12Z

tests/openwisp2/settings.py

+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': 'openwisp_utils.db',
+        'TEST': {
+            'NAME': 'openwisp_utils_test.db',


Why is this needed?

Why is this needed?

Without this, it was causing this error

raise ImproperlyConfigured( django.core.exceptions.ImproperlyConfigured: ChannelLiveServerTestCase can not be used with in memory databases

As the ASGI server requires a physical database

nemesifier · 2025-05-08T23:46:49Z

tests/test_project/tests/test_selenium.py



-class TestMenu(SeleniumTestMixin, StaticLiveServerTestCase):
+class TestMenu(SeleniumTestMixin, ChannelsLiveServerTestCase):


Let's tag all these tests (as we're doing in other modules for the selenium tests) so we can exclude them from the parallel run.

nemesifier · 2025-05-08T23:49:36Z

.github/workflows/ci.yml

      if: ${{ !cancelled() && steps.deps.conclusion == 'success' }}
      run: |
-        coverage run runtests.py --parallel
+        coverage run runtests.py


Once we have tagged the tests, we can modify the runtests.py script to handle which tests must not be run in parallel.

Since this can get complex in each module, I insisted with @pandafy that we hide this complexity from contributors in the runtests.py script, which thanks to a few lines of comments is also useful to us maintainers to remember why it's done that way.

See the runtests.py script in the controller module:
https://github.com/openwisp/openwisp-controller/blob/master/runtests.py#L46-L47

We need to handle this.

dee077 · 2025-05-09T07:19:13Z

CI is not passing on Django 5.2, why is that?

There is an open issue in django channels for ChannelsLiveServerTestCase is broken in django 5.2
django/channels#2148

coveralls · 2025-06-04T12:12:05Z

coverage: 96.029%. remained the same
when pulling da9866c on dee077:issues/904-change-to-ChannelsLiveServerTestCase
into dd1b06f on openwisp:master.

nemesifier · 2025-08-25T19:59:12Z

setup.py

-            "channels[daphne]~=4.2.0",
+            "channels[daphne]@"
+            "git+https://github.com/openwisp/channels.git@"
+            "issues/2148-ChannelsLiveServerTestCase-Django52-compatible#egg=channels[daphne]",


We can update this now as the PR has been merged.

nemesifier · 2025-08-25T19:59:57Z

.github/workflows/ci.yml

      if: ${{ !cancelled() && steps.deps.conclusion == 'success' }}
      run: |
-        coverage run runtests.py --parallel
+        coverage run runtests.py


We need to handle this.

nemesifier · 2025-08-25T20:00:12Z

.github/workflows/ci.yml

        pip install ${{ matrix.django-version }}
        sudo npm install -g prettier
+        pip uninstall channels channels-redis daphne -y
+        pip install -e ".[channels]"


Shouldn't be needed anymore.

Replaced StaticLiveServerTestCase with ChannelsLiveServerTestCase to resolve JS errors caused by failed websocket connections. Fixes openwisp#466

dee077 · 2025-08-26T21:20:32Z

Updates:

Changed ChannelsLiveServerTestCase from StaticLiveServerTestCase
Added tag selenium tests to all selenium tests to exclude them from running in parallel.
Updated CI to run unit and selenium tests separately.

nemesifier

LGTM! @pandafy what do you think?

pandafy

LGTM! I have one question, the rest looks good!

pandafy · 2025-08-27T07:06:14Z

tests/openwisp2/asgi.py

+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "openwisp2.settings")


Why do we need this here? I don't see it in openwisp-controller and openwisp-notifications.

I don't remember exactly why, but removing it does nothing. So removed it.

dee077 · 2025-08-27T11:50:31Z

Updates

Added --noinput flag in running test in ci to auto destroy the previous db as ChannelsLiveServerTestCase requires a physical db and rerunning jobs can ask prompts to destroy db yes or no.
Removed from asgi.py

os.environ.setdefault("DJANGO_SETTINGS_MODULE", "openwisp2.settings")

dee077 changed the title ~~[change:tests] Switch to ChannelsLiveServerTestCase #904~~ [change:tests] Switch to ChannelsLiveServerTestCase #466 Apr 29, 2025

dee077 force-pushed the issues/904-change-to-ChannelsLiveServerTestCase branch from ee2d9f8 to 3d223e8 Compare April 29, 2025 05:26

nemesifier assigned dee077 May 8, 2025

nemesifier added enhancement testing Issue related to testing or CI labels May 8, 2025

nemesifier added this to OpenWISP Contributor's Board May 8, 2025

github-project-automation bot moved this to To do (general) in OpenWISP Contributor's Board May 8, 2025

nemesifier reviewed May 9, 2025

View reviewed changes

nemesifier mentioned this pull request May 9, 2025

[fix] Added address field to real-time location updates #169 openwisp/django-loci#171

Merged

3 tasks

dee077 force-pushed the issues/904-change-to-ChannelsLiveServerTestCase branch 2 times, most recently from a6a7f2b to 6a8a34a Compare June 4, 2025 11:48

nemesifier reviewed Aug 25, 2025

View reviewed changes

dee077 added 3 commits August 27, 2025 01:48

[change:tests] Switch to ChannelsLiveServerTestCase openwisp#466

7a4bfea

Replaced StaticLiveServerTestCase with ChannelsLiveServerTestCase to resolve JS errors caused by failed websocket connections. Fixes openwisp#466

[fix] Update to double quotes and test channels fix

bef9033

[fix] Change to ChannelsLiveServerTestCase

18861b1

dee077 force-pushed the issues/904-change-to-ChannelsLiveServerTestCase branch from 6a8a34a to 18861b1 Compare August 26, 2025 21:07

dee077 marked this pull request as ready for review August 26, 2025 21:16

nemesifier previously approved these changes Aug 27, 2025

View reviewed changes

github-project-automation bot moved this from To do (general) to In progress in OpenWISP Contributor's Board Aug 27, 2025

pandafy previously approved these changes Aug 27, 2025

View reviewed changes

[fix] Remove defualt and add --noinput

da9866c

dee077 dismissed stale reviews from pandafy and nemesifier via da9866c August 27, 2025 11:41

nemesifier approved these changes Aug 29, 2025

View reviewed changes

nemesifier changed the title ~~[change:tests] Switch to ChannelsLiveServerTestCase #466~~ [fix:tests] Switch to ChannelsLiveServerTestCase #466 Aug 29, 2025

nemesifier changed the title ~~[fix:tests] Switch to ChannelsLiveServerTestCase #466~~ [tests:fix] Switched to ChannelsLiveServerTestCase #466 Aug 29, 2025

nemesifier merged commit bf8ac7b into openwisp:master Aug 29, 2025
32 checks passed

github-project-automation bot moved this from In progress to Done in OpenWISP Contributor's Board Aug 29, 2025



		class TestMenu(SeleniumTestMixin, StaticLiveServerTestCase):
		class TestMenu(SeleniumTestMixin, ChannelsLiveServerTestCase):


		from django.core.asgi import get_asgi_application

		os.environ.setdefault("DJANGO_SETTINGS_MODULE", "openwisp2.settings")

Uh oh!

[tests:fix] Switched to ChannelsLiveServerTestCase #466 #465

[tests:fix] Switched to ChannelsLiveServerTestCase #466 #465

Uh oh!

Conversation

dee077 commented Apr 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Reference to Existing Issue

Description of Changes

Issues

Uh oh!

nemesifier left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dee077 commented May 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coveralls commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dee077 commented Aug 26, 2025

Updates:

Uh oh!

nemesifier left a comment

Choose a reason for hiding this comment

Uh oh!

pandafy left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dee077 commented Aug 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Updates

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

dee077 commented Apr 28, 2025 •

edited

Loading

dee077 commented May 9, 2025 •

edited

Loading

coveralls commented Jun 4, 2025 •

edited

Loading

dee077 commented Aug 27, 2025 •

edited

Loading