Merge branch 'nix-shell' into 'main'

Nix shell

See merge request bde/nk20!201

.gitignore

@@ -48,7 +48,6 @@ backups/
 env/
 venv/
 db.sqlite3
-shell.nix
 
 # ansibles customs host
 ansible/host_vars/*.yaml

.gitlab-ci.yml

@@ -7,10 +7,25 @@ stages:
 variables:
   GIT_SUBMODULE_STRATEGY: recursive
 
-# Ubuntu 22.04
+# Debian Buster
-py310-django50:
+#  py37-django22:
+#   stage: test
+#   image: debian:buster-backports
+#   before_script:
+#     - >
+#         apt-get update &&
+#         apt-get install --no-install-recommends -t buster-backports -y
+#         python3-django python3-django-crispy-forms
+#         python3-django-extensions python3-django-filters python3-django-polymorphic
+#         python3-djangorestframework python3-django-oauth-toolkit python3-psycopg2 python3-pil
+#         python3-babel python3-lockfile python3-pip python3-phonenumbers python3-memcache
+#         python3-bs4 python3-setuptools tox texlive-xetex
+#   script: tox -e py37-django22
+
+# Ubuntu 20.04
+py38-django22:
   stage: test
-  image: ubuntu:22.04
+  image: ubuntu:20.04
   before_script:
     # Fix tzdata prompt
     - ln -sf /usr/share/zoneinfo/Europe/Paris /etc/localtime && echo Europe/Paris > /etc/timezone
@@ -22,12 +37,12 @@ py310-django50:
         python3-djangorestframework python3-django-oauth-toolkit python3-psycopg2 python3-pil
         python3-babel python3-lockfile python3-pip python3-phonenumbers python3-memcache
         python3-bs4 python3-setuptools tox texlive-xetex
-  script: tox -e py310-django50
+  script: tox -e py38-django22
 
-# Debian Bookworm
+# Debian Bullseye
-py311-django50:
+py39-django22:
   stage: test
-  image: debian:bookworm
+  image: debian:bullseye
   before_script:
     - >
         apt-get update &&
@@ -37,7 +52,7 @@ py311-django50:
         python3-djangorestframework python3-django-oauth-toolkit python3-psycopg2 python3-pil
         python3-babel python3-lockfile python3-pip python3-phonenumbers python3-memcache
         python3-bs4 python3-setuptools tox texlive-xetex
-  script: tox -e py311-django50
+  script: tox -e py39-django22
 
 linters:
   stage: quality-assurance

apps/activity/forms.py

@@ -1,8 +1,6 @@
 # Copyright (C) 2018-2024 by BDE ENS Paris-Saclay
 # SPDX-License-Identifier: GPL-3.0-or-later
 
-from bootstrap_datepicker_plus.widgets import DateTimePickerInput
-
 from datetime import timedelta
 from random import shuffle
 
@@ -12,7 +10,7 @@ from django.utils import timezone
 from django.utils.translation import gettext_lazy as _
 from member.models import Club
 from note.models import Note, NoteUser
-from note_kfet.inputs import Autocomplete
+from note_kfet.inputs import Autocomplete, DateTimePickerInput
 from note_kfet.middlewares import get_current_request
 from permission.backends import PermissionBackend
 

apps/api/urls.py

@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 from django.conf import settings
-from django.urls import include, re_path
+from django.conf.urls import url, include
 from rest_framework import routers
 
 from .views import UserInformationView
@@ -47,7 +47,7 @@ app_name = 'api'
 # Wire up our API using automatic URL routing.
 # Additionally, we include login URLs for the browsable API.
 urlpatterns = [
-    re_path('^', include(router.urls)),
+    url('^', include(router.urls)),
-    re_path('^me/', UserInformationView.as_view()),
+    url('^me/', UserInformationView.as_view()),
-    re_path('^api-auth/', include('rest_framework.urls', namespace='rest_framework')),
+    url('^api-auth/', include('rest_framework.urls', namespace='rest_framework')),
 ]

apps/member/forms.py

@@ -3,7 +3,6 @@
 
 import io
 
-from bootstrap_datepicker_plus.widgets import DatePickerInput
 from PIL import Image, ImageSequence
 from django import forms
 from django.conf import settings
@@ -14,7 +13,7 @@ from django.forms import CheckboxSelectMultiple
 from django.utils import timezone
 from django.utils.translation import gettext_lazy as _
 from note.models import NoteSpecial, Alias
-from note_kfet.inputs import Autocomplete, AmountInput
+from note_kfet.inputs import Autocomplete, AmountInput, DatePickerInput
 from permission.models import PermissionMask, Role
 
 from .models import Profile, Club, Membership
@@ -33,7 +32,7 @@ class UserForm(forms.ModelForm):
         # Django usernames can only contain letters, numbers, @, ., +, - and _.
         # We want to allow users to have uncommon and unpractical usernames:
         # That is their problem, and we have normalized aliases for us.
-        return super()._get_validation_exclusions() | {"username"}
+        return super()._get_validation_exclusions() + ["username"]
 
     class Meta:
         model = User

apps/member/tests/test_login.py

@@ -44,7 +44,7 @@ class TemplateLoggedInTests(TestCase):
         self.assertRedirects(response, settings.LOGIN_REDIRECT_URL, 302, 302)
 
     def test_logout(self):
-        response = self.client.post(reverse("logout"))
+        response = self.client.get(reverse("logout"))
         self.assertEqual(response.status_code, 200)
 
     def test_admin_index(self):

apps/note/api/urls.py

@@ -13,7 +13,7 @@ def register_note_urls(router, path):
     router.register(path + '/note', NotePolymorphicViewSet)
     router.register(path + '/alias', AliasViewSet)
     router.register(path + '/trust', TrustViewSet)
-    router.register(path + '/consumer', ConsumerViewSet, basename="consumer")
+    router.register(path + '/consumer', ConsumerViewSet)
 
     router.register(path + '/transaction/category', TemplateCategoryViewSet)
     router.register(path + '/transaction/transaction', TransactionViewSet)

apps/note/api/views.py

@@ -179,10 +179,19 @@ class ConsumerViewSet(ReadOnlyProtectedModelViewSet):
             # We match first an alias if it is matched without normalization,
             # then if the normalized pattern matches a normalized alias.
             queryset = queryset.filter(
-                Q(**{f'name{suffix}': alias_prefix + alias})
+                **{f'name{suffix}': alias_prefix + alias}
-                | Q(**{f'normalized_name{suffix}': alias_prefix + Alias.normalize(alias)})
+            ).union(
-                | Q(**{f'normalized_name{suffix}': alias_prefix + alias.lower()})
+                queryset.filter(
-            )
+                    Q(**{f'normalized_name{suffix}': alias_prefix + Alias.normalize(alias)})
+                    & ~Q(**{f'name{suffix}': alias_prefix + alias})
+                ),
+                all=True).union(
+                queryset.filter(
+                    Q(**{f'normalized_name{suffix}': alias_prefix + alias.lower()})
+                    & ~Q(**{f'normalized_name{suffix}': alias_prefix + Alias.normalize(alias)})
+                    & ~Q(**{f'name{suffix}': alias_prefix + alias})
+                ),
+                all=True)
 
         queryset = queryset if settings.DATABASES[queryset.db]["ENGINE"] == 'django.db.backends.postgresql' \
             else queryset.order_by("name")

apps/note/forms.py

@@ -1,15 +1,13 @@
 # Copyright (C) 2018-2024 by BDE ENS Paris-Saclay
 # SPDX-License-Identifier: GPL-3.0-or-later
-
 from datetime import datetime
 
-from bootstrap_datepicker_plus.widgets import DateTimePickerInput
 from django import forms
 from django.contrib.contenttypes.models import ContentType
 from django.forms import CheckboxSelectMultiple
 from django.utils.timezone import make_aware
 from django.utils.translation import gettext_lazy as _
-from note_kfet.inputs import Autocomplete, AmountInput
+from note_kfet.inputs import Autocomplete, AmountInput, DateTimePickerInput
 
 from .models import TransactionTemplate, NoteClub, Alias
 

apps/note/migrations/0002_create_special_notes.py

@@ -18,7 +18,6 @@ def create_special_notes(apps, schema_editor):
 class Migration(migrations.Migration):
     dependencies = [
         ('note', '0001_initial'),
-        ('logs', '0001_initial'),
     ]
 
     operations = [

apps/note/migrations/0007_alter_note_polymorphic_ctype_and_more.py

@@ -1,25 +0,0 @@
-# Generated by Django 5.0.7 on 2024-07-11 09:24
-
-import django.db.models.deletion
-from django.db import migrations, models
-
-
-class Migration(migrations.Migration):
-
-    dependencies = [
-        ('contenttypes', '0002_remove_content_type_name'),
-        ('note', '0006_trust'),
-    ]
-
-    operations = [
-        migrations.AlterField(
-            model_name='note',
-            name='polymorphic_ctype',
-            field=models.ForeignKey(editable=False, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='polymorphic_%(app_label)s.%(class)s_set+', to='contenttypes.contenttype'),
-        ),
-        migrations.AlterField(
-            model_name='transaction',
-            name='polymorphic_ctype',
-            field=models.ForeignKey(editable=False, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='polymorphic_%(app_label)s.%(class)s_set+', to='contenttypes.contenttype'),
-        ),
-    ]

apps/note/templates/note/amount_input.html

@@ -9,7 +9,7 @@ SPDX-License-Identifier: GPL-3.0-or-later
            name="{{ widget.name }}"
            {# Other attributes are loaded  #}
            {% for name, value in widget.attrs.items %}
-                {% if value != False %}{{ name }}{% if value != True %}="{{ value|stringformat:'s' }}"{% endif %}{% endif %}
+                {% ifnotequal value False %}{{ name }}{% ifnotequal value True %}="{{ value|stringformat:'s' }}"{% endifnotequal %}{% endifnotequal %}
             {% endfor %}>
     <div class="input-group-append">
         <span class="input-group-text">€</span>

apps/treasury/migrations/0009_alter_sogecredit_transactions.py

@@ -1,19 +0,0 @@
-# Generated by Django 5.0.7 on 2024-07-11 09:24
-
-from django.db import migrations, models
-
-
-class Migration(migrations.Migration):
-
-    dependencies = [
-        ('note', '0007_alter_note_polymorphic_ctype_and_more'),
-        ('treasury', '0008_auto_20240322_0045'),
-    ]
-
-    operations = [
-        migrations.AlterField(
-            model_name='sogecredit',
-            name='transactions',
-            field=models.ManyToManyField(blank=True, related_name='+', to='note.membershiptransaction', verbose_name='membership transactions'),
-        ),
-    ]

apps/wei/forms/registration.py

@@ -1,14 +1,13 @@
 # Copyright (C) 2018-2024 by BDE ENS Paris-Saclay
 # SPDX-License-Identifier: GPL-3.0-or-later
 
-from bootstrap_datepicker_plus.widgets import DatePickerInput
 from django import forms
 from django.contrib.auth.models import User
 from django.db.models import Q
 from django.forms import CheckboxSelectMultiple
 from django.utils.translation import gettext_lazy as _
 from note.models import NoteSpecial, NoteUser
-from note_kfet.inputs import AmountInput, Autocomplete, ColorWidget
+from note_kfet.inputs import AmountInput, DatePickerInput, Autocomplete, ColorWidget
 
 from ..models import WEIClub, WEIRegistration, Bus, BusTeam, WEIMembership, WEIRole
 

apps/wei/tests/test_wei_registration.py

@@ -439,7 +439,7 @@ class TestWEIRegistration(TestCase):
             emergency_contact_phone='+33123456789',
         ))
         self.assertEqual(response.status_code, 200)
-        self.assertTrue("This user can't be in her/his first year since he/she has already participated to a WEI."
+        self.assertTrue("This user can't be in her/his first year since he/she has already participated to a WEI."
                         in str(response.context["form"].errors))
 
         # Check that if the WEI is started, we can't register anyone
@@ -635,7 +635,7 @@ class TestWEIRegistration(TestCase):
         ))
         self.assertEqual(response.status_code, 200)
         self.assertFalse(response.context["form"].is_valid())
-        self.assertTrue("This team doesn't belong to the given bus." in str(response.context["form"].errors))
+        self.assertTrue("This team doesn't belong to the given bus." in str(response.context["form"].errors))
 
         response = self.client.post(reverse("wei:validate_registration", kwargs=dict(pk=self.registration.pk)), dict(
             roles=[WEIRole.objects.get(name="GC WEI").id],

note_kfet/admin.py

@@ -25,13 +25,19 @@ admin_site.register(Site, SiteAdmin)
 
 # Add external apps model
 if "oauth2_provider" in settings.INSTALLED_APPS:
-    from oauth2_provider.admin import ApplicationAdmin, GrantAdmin, AccessTokenAdmin, RefreshTokenAdmin
+    from oauth2_provider.admin import Application, ApplicationAdmin, Grant, \
-    from oauth2_provider.models import Application, Grant, AccessToken, RefreshToken
+        GrantAdmin, AccessToken, AccessTokenAdmin, RefreshToken, RefreshTokenAdmin
     admin_site.register(Application, ApplicationAdmin)
     admin_site.register(Grant, GrantAdmin)
     admin_site.register(AccessToken, AccessTokenAdmin)
     admin_site.register(RefreshToken, RefreshTokenAdmin)
 
+if "django_htcpcp_tea" in settings.INSTALLED_APPS:
+    from django_htcpcp_tea.admin import *
+    from django_htcpcp_tea.models import *
+    admin_site.register(Pot, PotAdmin)
+    admin_site.register(TeaType, TeaTypeAdmin)
+    admin_site.register(Addition, AdditionAdmin)
 
 if "mailer" in settings.INSTALLED_APPS:
     from mailer.admin import *
@@ -44,3 +50,9 @@ if "rest_framework" in settings.INSTALLED_APPS:
     from rest_framework.authtoken.admin import *
     from rest_framework.authtoken.models import *
     admin_site.register(Token, TokenAdmin)
+
+if "cas_server" in settings.INSTALLED_APPS:
+    from cas_server.admin import *
+    from cas_server.models import *
+    admin_site.register(ServicePattern, ServicePatternAdmin)
+    admin_site.register(FederatedIendityProvider, FederatedIendityProviderAdmin)

note_kfet/settings/base.py

@@ -41,7 +41,7 @@ INSTALLED_APPS = [
     'bootstrap_datepicker_plus',
     'colorfield',
     'crispy_forms',
-    'crispy_bootstrap4',
+    'django_htcpcp_tea',
     'django_tables2',
     'mailer',
     'phonenumber_field',
@@ -90,6 +90,7 @@ MIDDLEWARE = [
     'django.middleware.clickjacking.XFrameOptionsMiddleware',
     'django.middleware.locale.LocaleMiddleware',
     'django.contrib.sites.middleware.CurrentSiteMiddleware',
+    'django_htcpcp_tea.middleware.HTCPCPTeaMiddleware',
     'note_kfet.middlewares.SessionMiddleware',
     'note_kfet.middlewares.LoginByIPMiddleware',
     'note_kfet.middlewares.TurbolinksMiddleware',
@@ -294,6 +295,3 @@ PHONENUMBER_DEFAULT_REGION = 'FR'
 
 # We add custom information to CAS, in order to give a normalized name to other services
 CAS_AUTH_CLASS = 'member.auth.CustomAuthUser'
-
-# Default field for primary key
-DEFAULT_AUTO_FIELD = "django.db.models.AutoField"

note_kfet/templates/autocomplete_model.html

@@ -8,7 +8,7 @@ SPDX-License-Identifier: GPL-3.0-or-later
    {% if widget.value != None and widget.value != "" %}value="{{ widget.value }}"{% endif %}
    name="{{ widget.name }}_name" autocomplete="off"
     {% for name, value in widget.attrs.items %}
-        {% if value != False %}{{ name }}{% if value != True %}="{{ value|stringformat:'s' }}"{% endif %}{% endif %}
+        {% ifnotequal value False %}{{ name }}{% ifnotequal value True %}="{{ value|stringformat:'s' }}"{% endifnotequal %}{% endifnotequal %}
     {% endfor %}
     aria-describedby="{{widget.attrs.id}}_tooltip">
     {% if widget.resetable %}

note_kfet/templates/base.html

@@ -126,12 +126,9 @@ SPDX-License-Identifier: GPL-3.0-or-later
                                 <a class="dropdown-item" href="{% url 'member:user_detail' pk=request.user.pk %}">
                                     <i class="fa fa-user"></i> {% trans "My account" %}
                                 </a>
-                                <form method="post" action="{% url 'logout' %}">
+                                <a class="dropdown-item" href="{% url 'logout' %}">
-                                  {% csrf_token %}
-                                  <button class="dropdown-item" type="submit">
                                     <i class="fa fa-sign-out"></i> {% trans "Log out" %}
-                                  </button>
+                                </a>
-                                </form>
                             </div>
                         </li>
                     {% else %}

note_kfet/urls.py

@@ -30,6 +30,9 @@ urlpatterns = [
     path('accounts/', include('django.contrib.auth.urls')),
     path('api/', include('api.urls')),
     path('permission/', include('permission.urls')),
+
+    # Make coffee
+    path('coffee/', include('django_htcpcp_tea.urls')),
 ]
 
 # During development, serve static and media files
@@ -43,6 +46,11 @@ if "oauth2_provider" in settings.INSTALLED_APPS:
         path('o/', include('oauth2_provider.urls', namespace='oauth2_provider'))
     )
 
+if "cas_server" in settings.INSTALLED_APPS:
+    urlpatterns.append(
+        path('cas/', include('cas_server.urls', namespace='cas_server'))
+    )
+
 if "debug_toolbar" in settings.INSTALLED_APPS:
     import debug_toolbar
     urlpatterns = [

requirements.txt

@@ -1,17 +1,19 @@
-beautifulsoup4~=4.12.3
+beautifulsoup4~=4.7.1
-crispy-bootstrap4~=2024.1
+Django~=2.2.15
-Django~=5.0.7
+django-bootstrap-datepicker-plus~=3.0.5
-django-bootstrap-datepicker-plus~=5.0.5
+django-cas-server~=1.2.0
-django-colorfield~=0.11.0
+django-colorfield~=0.3.2
-django-crispy-forms~=2.2
+django-crispy-forms~=1.7.2
-django-extensions~=3.2.3
+django-extensions>=2.1.4
-django-filter~=24.2
+django-filter~=2.1
-django-mailer~=2.3.2
+django-htcpcp-tea~=0.3.1
-django-oauth-toolkit~=2.4.0
+django-mailer~=2.0.1
-django-phonenumber-field~=8.0.0
+django-oauth-toolkit~=1.3.3
-django-polymorphic~=3.1.0
+django-phonenumber-field~=5.0.0
-django-rest-polymorphic~=0.1.10
+django-polymorphic>=2.0.3,<3.0.0
-django-tables2~=2.7.0
+djangorestframework>=3.9.0,<3.13.0
-djangorestframework~=3.15.2
+django-rest-polymorphic~=0.1.9
-phonenumbers~=8.13.40
+django-tables2~=2.3.1
+python-memcached~=1.59
+phonenumbers~=8.9.10
 Pillow>=5.4.1

shell-static.nix

@@ -0,0 +1,34 @@
+# This is a workaround meant for use with the nix package manager. If you don't know what it is or don't use it, please ignore this file.
+# 
+# The nk20 javascript static location are hardcoded for imperative system.
+# This make ./manage.py collectstatic hard to use with nixos.
+# 
+# A workaround is to enter a FHSUserEnv with the static placed under /share/javascript/<static>.
+# This emulate a debian like system and enable collecting static normally with ./manage.py collectstatics.
+# The regular shell.nix should be enough for other configurations.
+#
+# Warning, you are still supposed to use pip package with a venv !
+{ pkgs ? import <nixpkgs> {} }:
+(pkgs.buildFHSUserEnv {
+  name = "pipzone";
+  targetPkgs = pkgs: (with pkgs;
+  let
+    fhs-static = stdenv.mkDerivation {
+      name = "fhs-static";
+      buildCommand = ''
+      mkdir -p $out/share/javascript/bootstrap4
+      mkdir -p $out/share/javascript/jquery
+      ln -s ${python39Packages.xstatic-bootstrap}/lib/python3.9/site-packages/xstatic/pkg/bootstrap/data/* $out/share/javascript/bootstrap4
+      ln -s ${python39Packages.xstatic-jquery}/lib/python3.9/site-packages/xstatic/pkg/jquery/data/* $out/share/javascript/jquery
+    '';
+    };
+  in [
+    fhs-static
+    python39
+    gettext
+    python39Packages.pip
+    python39Packages.virtualenv
+    python39Packages.setuptools
+  ]);
+  runScript = "bash";
+}).env

shell.nix

@@ -0,0 +1,23 @@
+# This is meant for use with the nix package manager. If you don't know what it is or don't use it, please ignore this file.
+#
+# This shell.nix contains all dependencies require to create a venv and pip install -r requirements.txt.
+#
+# Please check shell-static.nix for running ./manage.py collectstatics.
+{ pkgs ? import <nixpkgs> {} }:
+pkgs.mkShell {
+  buildInputs = with pkgs; [
+    python39
+    python39Packages.pip
+    python39Packages.setuptools
+    gettext
+
+  ];
+  shellHook = ''
+    # Tells pip to put packages into $PIP_PREFIX instead of the usual locations.
+    # See https://pip.pypa.io/en/stable/user_guide/#environment-variables.
+    export PIP_PREFIX=$(pwd)/_build/pip_packages
+    export PYTHONPATH="$PIP_PREFIX/${pkgs.python39.sitePackages}:$PYTHONPATH"
+    export PATH="$PIP_PREFIX/bin:$PATH"
+    unset SOURCE_DATE_EPOCH
+  '';
+}

tox.ini

@@ -1,10 +1,13 @@
 [tox]
 envlist =
+    # Debian Buster Python
+    py37-django22
+
     # Ubuntu 20.04 Python
-    py310-django50
+    py38-django22
 
     # Debian Bullseye Python
-    py311-django50
+    py39-django22
 
     linters
 skipsdist = True