Merge branch 'master' into filippociandy/ow_zt-to-global

Author: nemesifier

.github/workflows/ci.yml

@@ -15,20 +15,6 @@ jobs:
     name: Python==${{ matrix.python-version }} | ${{ matrix.django-version }}
     runs-on: ubuntu-22.04
 
-    services:
-      redis:
-        image: redis
-        ports:
-          - 6379:6379
-      postgres:
-        image: postgis/postgis:13-3.3-alpine
-        env:
-          POSTGRES_PASSWORD: openwisp2
-          POSTGRES_USER: openwisp2
-          POSTGRES_DB: openwisp2
-        ports:
-          - 5432:5432
-
     strategy:
       fail-fast: false
       matrix:
@@ -46,6 +32,19 @@ jobs:
       with:
         ref: ${{ github.event.pull_request.head.sha }}
 
+    - name: Cache APT packages
+      uses: actions/cache@v4
+      with:
+        path: /var/cache/apt/archives
+        key: apt-${{ runner.os }}-${{ hashFiles('.github/workflows/ci.yml') }}
+        restore-keys: |
+          apt-${{ runner.os }}-
+
+    - name: Disable man page auto-update
+      run: |
+        echo 'set man-db/auto-update false' | sudo debconf-communicate >/dev/null
+        sudo dpkg-reconfigure man-db
+
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5
       with:
@@ -54,19 +53,6 @@ jobs:
         cache-dependency-path: |
           **/requirements*.txt
 
-    - uses: browser-actions/setup-chrome@v1
-      # Using a fixed version, see here for more information on why:
-      # https://github.com/openwisp/openwisp-controller/issues/902#issuecomment-2266219715
-      # TODO: find a solution to allow using recent versions
-      with:
-        chrome-version: 125
-        install-chromedriver: true
-      id: setup-chrome
-
-    - run: |
-        ${{ steps.setup-chrome.outputs.chrome-path }} --version
-        chromedriver --version
-
     - name: Install Dependencies
       id: deps
       run: |
@@ -80,23 +66,28 @@ jobs:
         pip install -U -e .
         pip install ${{ matrix.django-version }}
 
+    - name: Start postgres and redis
+      if: ${{ !cancelled() && steps.deps.conclusion == 'success' }}
+      run: docker compose up -d postgres redis
+
     - name: QA checks
       run: ./run-qa-checks
 
     - name: Tests
       if: ${{ !cancelled() && steps.deps.conclusion == 'success' }}
       run: |
         coverage run runtests.py --parallel
-        # the following command runs tests with Postgres/PostGIS but
-        # only for specific test cases which are tagged with "db_tests"
-        POSTGRESQL=1 coverage run runtests.py --parallel --keepdb
         # tests the extension capability
-        SAMPLE_APP=1 coverage run ./runtests.py --parallel --keepdb
+        SAMPLE_APP=1 coverage run ./runtests.py --parallel --keepdb --exclude-tag=selenium_tests
         coverage combine
         coverage xml
       env:
         SELENIUM_HEADLESS: 1
-        CHROME_BIN: ${{ steps.setup-chrome.outputs.chrome-path }}
+        GECKO_LOG: 1
+
+    - name: Show gecko web driver log on failures
+      if: ${{ failure() }}
+      run: cat geckodriver.log
 
     - name: Upload Coverage
       if: ${{ success() }}

docs/developer/installation.rst

@@ -41,7 +41,7 @@ Launch Redis and PostgreSQL:
 
 .. code-block:: shell
 
-    docker-compose up -d redis postgres
+    docker compose up -d redis postgres
 
 Setup and activate a virtual-environment (we'll be using `virtualenv
 <https://pypi.org/project/virtualenv/>`_):
@@ -92,7 +92,8 @@ Launch development server:
 
 You can access the admin interface at ``http://127.0.0.1:8000/admin/``.
 
-Run tests with:
+Run tests with (make sure you have the :ref:`selenium dependencies
+<selenium_dependencies>` installed locally first):
 
 .. code-block:: shell
 
@@ -106,9 +107,6 @@ specific tests as follows:
 
 .. code-block:: shell
 
-    # Run database tests against PostgreSQL backend
-    POSTGRESQL=1 ./runtests.py --parallel
-
     # Run only specific selenium tests classes
     cd tests/
     DJANGO_SETTINGS_MODULE=openwisp2.postgresql_settings ./manage.py test openwisp_controller.config.tests.test_selenium.TestDeviceAdmin
@@ -162,13 +160,13 @@ Build from the Dockerfile:
 
 .. code-block:: shell
 
-    docker-compose build
+    docker compose build
 
 Run the docker container:
 
 .. code-block:: shell
 
-    docker-compose up
+    docker compose up
 
 Troubleshooting Steps for Common Installation Issues
 ----------------------------------------------------

openwisp_controller/config/base/config.py

@@ -272,29 +272,26 @@ def manage_vpn_clients(cls, action, instance, pk_set, **kwargs):
         else:
             templates = pk_set
 
-        # Get current VPNs in use by any template
-        current_vpns = set(
-            instance.templates.filter(type='vpn').values_list('vpn_id', flat=True)
-        )
+        # Delete VPN clients that are not associated with current templates
+        instance.vpnclient_set.exclude(
+            template_id__in=instance.templates.values_list('id', flat=True)
+        ).delete()
 
-        # Handle template actions
-        for template in templates.filter(type='vpn'):
-            if action == 'post_add':
+        if action == 'post_add':
+            for template in templates.filter(type='vpn'):
                 # Create VPN client if needed
                 if not vpn_client_model.objects.filter(
-                    config=instance, vpn=template.vpn
+                    config=instance, vpn=template.vpn, template=template
                 ).exists():
                     client = vpn_client_model(
                         config=instance,
                         vpn=template.vpn,
+                        template=template,
                         auto_cert=template.auto_cert,
                     )
                     client.full_clean()
                     client.save()
 
-        # Clean up any VPN clients that aren't associated with current templates
-        instance.vpnclient_set.exclude(vpn_id__in=current_vpns).delete()
-
     @classmethod
     def clean_templates_org(cls, action, instance, pk_set, raw_data=None, **kwargs):
         """

openwisp_controller/config/base/vpn.py

@@ -796,6 +796,10 @@ class AbstractVpnClient(models.Model):
     config = models.ForeignKey(
         get_model_name('config', 'Config'), on_delete=models.CASCADE
     )
+    template = models.ForeignKey(
+        get_model_name('config', 'Template'),
+        on_delete=models.CASCADE,
+    )
     vpn = models.ForeignKey(get_model_name('config', 'Vpn'), on_delete=models.CASCADE)
     cert = models.OneToOneField(
         get_model_name('django_x509', 'Cert'),

openwisp_controller/config/migrations/0056_vpnclient_template.py

@@ -0,0 +1,24 @@
+# Generated by Django 4.2.18 on 2025-03-18 15:53
+
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("config", "0055_alter_config_status"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="vpnclient",
+            name="template",
+            field=models.ForeignKey(
+                default=None,
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                to=settings.CONFIG_TEMPLATE_MODEL,
+            ),
+        ),
+    ]

openwisp_controller/config/migrations/0057_populate_vpnclient_template.py

@@ -0,0 +1,25 @@
+# Generated by Django 3.2.15 on 2022-09-16 11:45
+
+
+from django.db import migrations
+
+
+def populate_vpnclient_template(apps, schema_editor):
+    VpnClient = apps.get_model('config', 'VpnClient')
+
+    for vpn_client in VpnClient.objects.iterator():
+        if vpn_client.template is None:
+            vpn_client.template = vpn_client.config.templates.get(
+                vpn_id=vpn_client.vpn_id
+            )
+            vpn_client.save()
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ('config', '0056_vpnclient_template'),
+    ]
+
+    operations = [
+        migrations.RunPython(populate_vpnclient_template, migrations.RunPython.noop)
+    ]

openwisp_controller/config/migrations/0058_alter_vpnclient_template.py

@@ -0,0 +1,22 @@
+# Generated by Django 4.2.18 on 2025-03-18 15:55
+
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("config", "0057_populate_vpnclient_template"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="vpnclient",
+            name="template",
+            field=models.ForeignKey(
+                on_delete=django.db.models.deletion.CASCADE,
+                to=settings.CONFIG_TEMPLATE_MODEL,
+            ),
+        ),
+    ]

openwisp_controller/config/static/config/css/device-delete-confirmation.css

@@ -1,6 +1,15 @@
 #deactivating-warning .warning p {
   margin-top: 0px;
 }
+#deactivating-warning .messagelist button {
+  font-size: 15px;
+  vertical-align: middle;
+  line-height: inherit !important;
+  padding: 0.625rem 1rem;
+}
+#deactivating-warning .messagelist button + button {
+  margin-left: 10px;
+}
 #main ul.messagelist li.warning ul li {
   display: list-item;
   padding: 0px;

openwisp_controller/config/static/config/js/device-delete-confirmation.js

@@ -3,7 +3,6 @@
 (function ($) {
   $(document).ready(function () {
     $("#warning-ack").click(function (event) {
-      event.preventDefault();
       $("#deactivating-warning").slideUp("fast");
       $("#delete-confirm-container").slideDown("fast");
       $('input[name="force_delete"]').val("true");

openwisp_controller/config/templates/admin/config/device/delete_confirmation.html

@@ -46,11 +46,10 @@
                   but its configuration will remain active.
                   {% endblocktranslate %}
                 </p>
-                <form>
-                    <input type="submit" class="button danger-btn" id="warning-ack"
-                        value="{% translate 'I understand the risks, delete the device' %}">
-                    <a class="button cancel-link">{% translate 'No, take me back' %}</a>
-                </form>
+                <span>
+                    <button class="danger-btn" id="warning-ack">{% translate 'I understand the risks, delete the device' %}</button>
+                    <button class="button cancel-link">{% translate 'No, take me back' %}</button>
+                </span>
             </li>
         </ul>
     </div>