diff --git a/.forgejo/issue_template/bug.yml b/.forgejo/issue_template/bug.yml new file mode 100644 index 0000000..8b227a0 --- /dev/null +++ b/.forgejo/issue_template/bug.yml @@ -0,0 +1,35 @@ +name: Bug Report +about: File a bug report +labels: + - Kind/Bug +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Also tell us, what did you expect to happen? + placeholder: Tell us what you see! + validations: + required: true + - type: dropdown + id: browsers + attributes: + label: What browsers are you seeing the problem on? + multiple: true + options: + - Firefox (Windows) + - Firefox (MacOS) + - Firefox (Linux) + - Firefox (Android) + - Firefox (iOS) + - Chrome (Windows) + - Chrome (MacOS) + - Chrome (Linux) + - Chrome (Android) + - Chrome (iOS) + - Safari + - Microsoft Edge \ No newline at end of file diff --git a/.forgejo/issue_template/feature.yml b/.forgejo/issue_template/feature.yml new file mode 100644 index 0000000..c8cf794 --- /dev/null +++ b/.forgejo/issue_template/feature.yml @@ -0,0 +1,27 @@ +name: 'New Feature' +about: 'This template is for new features' +labels: + - Kind/Feature +body: + - type: markdown + attributes: + value: | + Before creating a Feature Ticket, please check for duplicates. + - type: markdown + attributes: + value: | + ### Implementation Checklist + - [ ] concept + - [ ] frontend + - [ ] backend + - [ ] unittests + - [ ] tested on staging + visible: [ content ] + - type: textarea + id: description + attributes: + label: 'Feature Description' + description: 'Explain the the feature.' + placeholder: Description + validations: + required: true \ No newline at end of file diff --git a/.forgejo/workflows/deploy_staging.yml b/.forgejo/workflows/deploy_staging.yml new file mode 100644 index 0000000..3b44d24 --- /dev/null +++ b/.forgejo/workflows/deploy_staging.yml @@ -0,0 +1,60 @@ +on: + push: + branches: + - testing + +jobs: + test: + runs-on: docker + container: + image: ghcr.io/catthehacker/ubuntu:act-22.04 + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + with: + python-version: '3.11' + cache-dependency-path: '**/requirements.dev.txt' + - name: Install dependencies + working-directory: core + run: pip3 install -r requirements.dev.txt + - name: Run django tests + working-directory: core + run: python3 manage.py test + + deploy: + needs: [test] + runs-on: docker + steps: + - uses: actions/checkout@v4 + - name: Install ansible + run: | + apt update -y + apt install python3-pip -y + python3 -m pip install ansible + python3 -m pip install ansible-lint + + - name: Populate relevant files + run: | + mkdir ~/.ssh + echo "${{ secrets.C3LF_SSH_TESTING }}" > ~/.ssh/id_ed25519 + chmod 0600 ~/.ssh/id_ed25519 + ls -lah ~/.ssh + command -v ssh-agent >/dev/null || ( apt-get update -y && apt-get install openssh-client -y ) + eval $(ssh-agent -s) + ssh-add ~/.ssh/id_ed25519 + echo "andromeda.lab.or.it ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDXPoO0PE+B9PYwbGaLo98zhbmjAkp6eBtVeZe43v/+T" >> ~/.ssh/known_hosts + mkdir /etc/ansible + echo "${{ secrets.C3LF_INVENTORY_TESTING }}" > /etc/ansible/hosts + + - name: Check ansible version + run: | + ansible --version + + - name: List ansible hosts + run: | + ansible -m ping Andromeda + + - name: Deploy testing + run: | + cd deploy/ansible + ansible-playbook playbooks/deploy-c3lf-sys3.yml diff --git a/.forgejo/workflows/test.yml b/.forgejo/workflows/test.yml new file mode 100644 index 0000000..480e590 --- /dev/null +++ b/.forgejo/workflows/test.yml @@ -0,0 +1,21 @@ +on: + pull_request: + push: + +jobs: + test: + runs-on: docker + container: + image: ghcr.io/catthehacker/ubuntu:act-22.04 + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + with: + python-version: '3.11' + cache-dependency-path: '**/requirements.dev.txt' + - name: Install dependencies + working-directory: core + run: pip3 install -r requirements.dev.txt + - name: Run django tests + working-directory: core + run: python3 manage.py test diff --git a/core/authentication/api_v2.py b/core/authentication/api_v2.py index 514a697..2547b6d 100644 --- a/core/authentication/api_v2.py +++ b/core/authentication/api_v2.py @@ -12,25 +12,7 @@ from knox.models import AuthToken from knox.views import LoginView as KnoxLoginView from authentication.models import ExtendedUser - - -class UserSerializer(serializers.ModelSerializer): - permissions = serializers.SerializerMethodField() - groups = serializers.SlugRelatedField(many=True, read_only=True, slug_field='name') - - class Meta: - model = ExtendedUser - fields = ('id', 'username', 'email', 'first_name', 'last_name', 'permissions', 'groups') - read_only_fields = ('id', 'username', 'email', 'first_name', 'last_name', 'permissions', 'groups') - - def get_permissions(self, obj): - return list(set(obj.get_permissions())) - - -@receiver(post_save, sender=ExtendedUser) -def create_auth_token(sender, instance=None, created=False, **kwargs): - if created: - AuthToken.objects.create(user=instance) +from authentication.serializers import UserSerializer, GroupSerializer class UserViewSet(viewsets.ModelViewSet): @@ -38,26 +20,17 @@ class UserViewSet(viewsets.ModelViewSet): serializer_class = UserSerializer -class GroupSerializer(serializers.ModelSerializer): - permissions = serializers.SerializerMethodField() - members = serializers.SerializerMethodField() - - class Meta: - model = Group - fields = ('id', 'name', 'permissions', 'members') - - def get_permissions(self, obj): - return ["*:" + p.codename for p in obj.permissions.all()] - - def get_members(self, obj): - return [u.username for u in obj.user_set.all()] - - class GroupViewSet(viewsets.ModelViewSet): queryset = Group.objects.all() serializer_class = GroupSerializer +@receiver(post_save, sender=ExtendedUser) +def create_auth_token(sender, instance=None, created=False, **kwargs): + if created: + AuthToken.objects.create(user=instance) + + @api_view(['GET']) @permission_classes([IsAuthenticated]) def selfUser(request): diff --git a/core/authentication/serializers.py b/core/authentication/serializers.py new file mode 100644 index 0000000..0581865 --- /dev/null +++ b/core/authentication/serializers.py @@ -0,0 +1,32 @@ +from rest_framework import serializers +from django.contrib.auth.models import Group + +from authentication.models import ExtendedUser + + +class UserSerializer(serializers.ModelSerializer): + permissions = serializers.SerializerMethodField() + groups = serializers.SlugRelatedField(many=True, read_only=True, slug_field='name') + + class Meta: + model = ExtendedUser + fields = ('id', 'username', 'email', 'first_name', 'last_name', 'permissions', 'groups') + read_only_fields = ('id', 'username', 'email', 'first_name', 'last_name', 'permissions', 'groups') + + def get_permissions(self, obj): + return list(set(obj.get_permissions())) + + +class GroupSerializer(serializers.ModelSerializer): + permissions = serializers.SerializerMethodField() + members = serializers.SerializerMethodField() + + class Meta: + model = Group + fields = ('id', 'name', 'permissions', 'members') + + def get_permissions(self, obj): + return ["*:" + p.codename for p in obj.permissions.all()] + + def get_members(self, obj): + return [u.username for u in obj.user_set.all()] diff --git a/core/core/settings.py b/core/core/settings.py index db23180..5a8f20f 100644 --- a/core/core/settings.py +++ b/core/core/settings.py @@ -15,6 +15,11 @@ import sys import dotenv from pathlib import Path + +def truthy_str(s): + return s.lower() in ['true', '1', 't', 'y', 'yes', 'yeah', 'yup', 'certainly', 'sure', 'positive', 'uh-huh', '👍'] + + # Build paths inside the project like this: BASE_DIR / 'subdir'. BASE_DIR = Path(__file__).resolve().parent.parent @@ -24,12 +29,14 @@ dotenv.load_dotenv(BASE_DIR / '.env') # See https://docs.djangoproject.com/en/4.2/howto/deployment/checklist/ # SECURITY WARNING: keep the secret key used in production secret! -SECRET_KEY = 'django-insecure-tm*$w_14iqbiy-!7(8#ba7j+_@(7@rf2&a^!=shs&$03b%2*rv' +SECRET_KEY = os.getenv('DJANGO_SECRET_KEY', 'django-insecure-tm*$w_14iqbiy-!7(8#ba7j+_@(7@rf2&a^!=shs&$03b%2*rv') # SECURITY WARNING: don't run with debug turned on in production! -DEBUG = True +DEBUG = truthy_str(os.getenv('DEBUG_MODE_ACTIVE', 'False')) -ALLOWED_HOSTS = [os.getenv('HTTP_HOST', 'localhost')] +PRIMARY_HOST = os.getenv('HTTP_HOST', 'localhost') + +ALLOWED_HOSTS = [PRIMARY_HOST] MAIL_DOMAIN = os.getenv('MAIL_DOMAIN', 'localhost') @@ -40,6 +47,8 @@ LEGACY_USER_PASSWORD = os.getenv('LEGACY_API_PASSWORD', 'legacy_password') SYSTEM3_VERSION = "0.0.0-dev.0" +ACTIVE_SPAM_TRAINING = truthy_str(os.getenv('ACTIVE_SPAM_TRAINING', 'False')) + # Application definition INSTALLED_APPS = [ @@ -50,6 +59,7 @@ INSTALLED_APPS = [ 'django.contrib.messages', 'django.contrib.staticfiles', 'django_extensions', + 'django_prometheus', 'rest_framework', 'knox', 'drf_yasg', @@ -85,6 +95,7 @@ SWAGGER_SETTINGS = { } MIDDLEWARE = [ + 'django_prometheus.middleware.PrometheusBeforeMiddleware', 'django.middleware.security.SecurityMiddleware', 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', @@ -92,6 +103,7 @@ MIDDLEWARE = [ 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', + 'django_prometheus.middleware.PrometheusAfterMiddleware', ] ROOT_URLCONF = 'core.urls' @@ -134,7 +146,8 @@ else: 'USER': os.getenv('DB_USER', 'system3'), 'PASSWORD': os.getenv('DB_PASSWORD', 'system3'), 'OPTIONS': { - 'charset': 'utf8mb4' + 'charset': 'utf8mb4', + 'init_command': "SET sql_mode='STRICT_TRANS_TABLES'" } } } @@ -204,10 +217,12 @@ CHANNEL_LAYERS = { 'default': { 'BACKEND': 'channels_redis.core.RedisChannelLayer', 'CONFIG': { - 'hosts': [('localhost', 6379)], + 'hosts': [(os.getenv('REDIS_HOST', 'localhost'), 6379)], }, } } +PROMETHEUS_METRIC_NAMESPACE = 'c3lf' + TEST_RUNNER = 'core.test_runner.FastTestRunner' diff --git a/core/core/urls.py b/core/core/urls.py index b0161bb..1c5f158 100644 --- a/core/core/urls.py +++ b/core/core/urls.py @@ -21,9 +21,6 @@ from .version import get_info urlpatterns = [ path('djangoadmin/', admin.site.urls), - path('api/1/', include('inventory.api_v1')), - path('api/1/', include('files.api_v1')), - path('api/1/', include('files.media_v1')), path('api/2/', include('inventory.api_v2')), path('api/2/', include('files.api_v2')), path('media/2/', include('files.media_v2')), @@ -32,4 +29,5 @@ urlpatterns = [ path('api/2/', include('notify_sessions.api_v2')), path('api/2/', include('authentication.api_v2')), path('api/', get_info), + path('', include('django_prometheus.urls')), ] diff --git a/core/core/wsgi.py b/core/core/wsgi.py deleted file mode 100644 index f44964d..0000000 --- a/core/core/wsgi.py +++ /dev/null @@ -1,16 +0,0 @@ -""" -WSGI config for core project. - -It exposes the WSGI callable as a module-level variable named ``application``. - -For more information on this file, see -https://docs.djangoproject.com/en/4.2/howto/deployment/wsgi/ -""" - -import os - -from django.core.wsgi import get_wsgi_application - -os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'core.settings') - -application = get_wsgi_application() diff --git a/core/files/api_v1.py b/core/files/api_v1.py deleted file mode 100644 index ce9730f..0000000 --- a/core/files/api_v1.py +++ /dev/null @@ -1,27 +0,0 @@ -from rest_framework import serializers, viewsets, routers - -from files.models import File - - -class FileSerializer(serializers.ModelSerializer): - data = serializers.CharField(max_length=1000000, write_only=True) - - class Meta: - model = File - fields = ['hash', 'data'] - read_only_fields = ['hash'] - - -class FileViewSet(viewsets.ModelViewSet): - serializer_class = FileSerializer - queryset = File.objects.all() - lookup_field = 'hash' - permission_classes = [] - authentication_classes = [] - - -router = routers.SimpleRouter(trailing_slash=False) -router.register(r'files', FileViewSet, basename='files') -router.register(r'file', FileViewSet, basename='files') - -urlpatterns = router.urls diff --git a/core/files/media_v1.py b/core/files/media_v1.py deleted file mode 100644 index d80ce64..0000000 --- a/core/files/media_v1.py +++ /dev/null @@ -1,65 +0,0 @@ -import os -from django.http import HttpResponse -from django.urls import path -from drf_yasg.utils import swagger_auto_schema -from rest_framework import status -from rest_framework.decorators import api_view, permission_classes, authentication_classes -from rest_framework.response import Response - -from core.settings import MEDIA_ROOT -from files.models import File - - -@swagger_auto_schema(method='GET', auto_schema=None) -@api_view(['GET']) -@permission_classes([]) -@authentication_classes([]) -def media_urls(request, hash): - try: - file = File.objects.get(hash=hash) - hash_path = file.file - return HttpResponse(status=status.HTTP_200_OK, - content_type=file.mime_type, - headers={ - 'X-Accel-Redirect': f'/redirect_media/{hash_path}', - 'Access-Control-Allow-Origin': '*', - }) # TODO Expires and Cache-Control - - except File.DoesNotExist: - return Response(status=status.HTTP_404_NOT_FOUND) - - -@swagger_auto_schema(method='GET', auto_schema=None) -@api_view(['GET']) -@permission_classes([]) -@authentication_classes([]) -def thumbnail_urls(request, hash): - size = 200 - try: - file = File.objects.get(hash=hash) - hash_path = file.file - if not os.path.exists(MEDIA_ROOT + f'/thumbnails/{size}/{hash_path}'): - from PIL import Image - image = Image.open(file.file) - image.thumbnail((size, size)) - rgb_image = image.convert('RGB') - thumb_dir = os.path.dirname(MEDIA_ROOT + f'/thumbnails/{size}/{hash_path}') - if not os.path.exists(thumb_dir): - os.makedirs(thumb_dir) - rgb_image.save(MEDIA_ROOT + f'/thumbnails/{size}/{hash_path}', 'jpeg', quality=90) - - return HttpResponse(status=status.HTTP_200_OK, - content_type="image/jpeg", - headers={ - 'X-Accel-Redirect': f'/redirect_thumbnail/{size}/{hash_path}', - 'Access-Control-Allow-Origin': '*', - }) # TODO Expires and Cache-Control - - except File.DoesNotExist: - return Response(status=status.HTTP_404_NOT_FOUND) - - -urlpatterns = [ - path('thumbs/', thumbnail_urls), - path('images/', media_urls), -] diff --git a/core/files/tests/v1/__init__.py b/core/files/tests/v1/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/core/files/tests/v1/test_files.py b/core/files/tests/v1/test_files.py deleted file mode 100644 index ce59b2c..0000000 --- a/core/files/tests/v1/test_files.py +++ /dev/null @@ -1,68 +0,0 @@ -from django.test import TestCase, Client -from django.core.files.base import ContentFile - -from files.models import File -from inventory.models import Event, Container, Item - -client = Client() - - -class FileTestCase(TestCase): - - def setUp(self): - super().setUp() - self.event = Event.objects.create(slug='EVENT', name='Event') - self.box = Container.objects.create(name='BOX') - - def test_create_file_raw(self): - from hashlib import sha256 - content = b"foo" - chash = sha256(content).hexdigest() - item = Item.objects.create(container=self.box, event=self.event, description='1') - file = File.objects.create(file=ContentFile(b"foo"), mime_type='text/plain', hash=chash, item=item) - file.save() - self.assertEqual(1, len(File.objects.all())) - self.assertEqual(content, File.objects.all()[0].file.read()) - self.assertEqual(chash, File.objects.all()[0].hash) - - def test_list_files(self): - import base64 - - item = File.objects.create(data="data:text/plain;base64," + base64.b64encode(b"foo").decode('utf-8')) - response = client.get('/api/1/files') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json()[0]['hash'], item.hash) - self.assertEqual(len(response.json()[0]['hash']), 64) - self.assertEqual(len(File.objects.all()), 1) - self.assertEqual(File.objects.all()[0].file.read(), b"foo") - - def test_one_file(self): - import base64 - item = File.objects.create(data="data:text/plain;base64," + base64.b64encode(b"foo").decode('utf-8')) - response = client.get(f'/api/1/file/{item.hash}') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json()['hash'], item.hash) - self.assertEqual(len(response.json()['hash']), 64) - self.assertEqual(len(File.objects.all()), 1) - self.assertEqual(File.objects.all()[0].file.read(), b"foo") - - def test_create_file(self): - import base64 - Item.objects.create(container=self.box, event=self.event, description='1') - item = Item.objects.create(container=self.box, event=self.event, description='2') - response = client.post('/api/1/file', - {'data': "data:text/plain;base64," + base64.b64encode(b"foo").decode('utf-8')}, - content_type='application/json') - self.assertEqual(response.status_code, 201) - self.assertEqual(len(response.json()['hash']), 64) - self.assertEqual(len(File.objects.all()), 1) - self.assertEqual(File.objects.all()[0].file.read(), b"foo") - - def test_delete_file(self): - import base64 - item = Item.objects.create(container=self.box, event=self.event, description='1') - File.objects.create(item=item, data="data:text/plain;base64," + base64.b64encode(b"foo").decode('utf-8')) - file = File.objects.create(item=item, data="data:text/plain;base64," + base64.b64encode(b"bar").decode('utf-8')) - self.assertEqual(len(File.objects.all()), 2) - response = client.delete(f'/api/1/file/{file.hash}') - self.assertEqual(response.status_code, 204) diff --git a/core/inventory/api_v1.py b/core/inventory/api_v1.py deleted file mode 100644 index e9e670d..0000000 --- a/core/inventory/api_v1.py +++ /dev/null @@ -1,150 +0,0 @@ -from django.utils import timezone -from django.urls import re_path -from rest_framework import routers, viewsets, serializers -from rest_framework.decorators import api_view, permission_classes, authentication_classes -from rest_framework.response import Response - -from files.models import File -from inventory.models import Event, Container, Item -from inventory.serializers import EventSerializer, ContainerSerializer - - -class EventViewSet(viewsets.ModelViewSet): - serializer_class = EventSerializer - queryset = Event.objects.all() - permission_classes = [] - authentication_classes = [] - - -class ContainerViewSet(viewsets.ModelViewSet): - serializer_class = ContainerSerializer - queryset = Container.objects.all() - permission_classes = [] - authentication_classes = [] - - -class ItemSerializer(serializers.ModelSerializer): - dataImage = serializers.CharField(write_only=True, required=False) - cid = serializers.SerializerMethodField() - box = serializers.SerializerMethodField() - file = serializers.SerializerMethodField() - - class Meta: - model = Item - fields = ['cid', 'box', 'uid', 'description', 'file', 'dataImage'] - read_only_fields = ['uid'] - - def get_cid(self, instance): - return instance.container.cid - - def get_box(self, instance): - return instance.container.name - - def get_file(self, instance): - if len(instance.files.all()) > 0: - return instance.files.all().order_by('-created_at')[0].hash - return None - - def to_internal_value(self, data): - if 'cid' in data: - container = Container.objects.get(cid=data['cid']) - internal = super().to_internal_value(data) - internal['container'] = container - return internal - return super().to_internal_value(data) - - def validate(self, attrs): - return super().validate(attrs) - - def create(self, validated_data): - if 'dataImage' in validated_data: - file = File.objects.create(data=validated_data['dataImage']) - validated_data.pop('dataImage') - item = Item.objects.create(**validated_data) - item.files.set([file]) - return item - return Item.objects.create(**validated_data) - - def update(self, instance, validated_data): - if 'returned' in validated_data: - if validated_data['returned']: - validated_data['returned_at'] = timezone.now() - validated_data.pop('returned') - if 'dataImage' in validated_data: - file = File.objects.create(data=validated_data['dataImage']) - validated_data.pop('dataImage') - instance.files.add(file) - return super().update(instance, validated_data) - - -@api_view(['GET']) -@permission_classes([]) -@authentication_classes([]) -def search_items(request, event_slug, query): - try: - event = Event.objects.get(slug=event_slug) - query_tokens = query.split(' ') - q = Item.objects.filter(event=event) - for token in query_tokens: - if token: - q = q.filter(description__icontains=token) - return Response(ItemSerializer(q, many=True).data) - except Event.DoesNotExist: - return Response(status=404) - - -@api_view(['GET', 'POST']) -@permission_classes([]) -@authentication_classes([]) -def item(request, event_slug): - try: - event = Event.objects.get(slug=event_slug) - if request.method == 'GET': - return Response(ItemSerializer(Item.objects.filter(event=event), many=True).data) - elif request.method == 'POST': - validated_data = ItemSerializer(data=request.data) - if validated_data.is_valid(): - validated_data.save(event=event) - return Response(validated_data.data, status=201) - except Event.DoesNotExist: - return Response(status=404) - - -@api_view(['GET', 'PUT', 'DELETE']) -@permission_classes([]) -@authentication_classes([]) -def item_by_id(request, event_slug, id): - try: - event = Event.objects.get(slug=event_slug) - item = Item.objects.get(event=event, uid=id) - if request.method == 'GET': - return Response(ItemSerializer(item).data) - elif request.method == 'PUT': - validated_data = ItemSerializer(item, data=request.data) - if validated_data.is_valid(): - validated_data.save() - return Response(validated_data.data) - elif request.method == 'DELETE': - item.delete() - return Response(status=204) - except Item.DoesNotExist: - return Response(status=404) - except Event.DoesNotExist: - return Response(status=404) - - -urlpatterns = [ - re_path('events/?$', EventViewSet.as_view({'get': 'list', 'post': 'create'})), - re_path('events/(?P[0-9]+)/?$', - EventViewSet.as_view({'get': 'retrieve', 'put': 'update', 'delete': 'destroy'})), - re_path('boxes/?$', ContainerViewSet.as_view({'get': 'list', 'post': 'create'})), - re_path('boxes/(?P[0-9]+)/?$', - ContainerViewSet.as_view({'get': 'retrieve', 'put': 'update', 'delete': 'destroy'})), - re_path('box/?$', ContainerViewSet.as_view({'get': 'list', 'post': 'create'})), - re_path('box/(?P[0-9]+)/?$', - ContainerViewSet.as_view({'get': 'retrieve', 'put': 'update', 'delete': 'destroy'})), - re_path('(?P[a-zA-Z0-9]+)/items/?$', item), - re_path('(?P[a-zA-Z0-9]+)/items/(?P[^/]+)/?$', search_items), - re_path('(?P[a-zA-Z0-9]+)/item/?$', item), - re_path('(?P[a-zA-Z0-9]+)/item/(?P[0-9]+)/?$', item_by_id), -] diff --git a/core/inventory/api_v2.py b/core/inventory/api_v2.py index 0a34140..e1f643e 100644 --- a/core/inventory/api_v2.py +++ b/core/inventory/api_v2.py @@ -1,4 +1,4 @@ -from django.urls import path +from django.urls import re_path from django.contrib.auth.decorators import permission_required from rest_framework import routers, viewsets from rest_framework.decorators import api_view, permission_classes @@ -6,7 +6,9 @@ from rest_framework.response import Response from rest_framework.permissions import IsAuthenticated from inventory.models import Event, Container, Item -from inventory.serializers import EventSerializer, ContainerSerializer, ItemSerializer +from inventory.serializers import EventSerializer, ContainerSerializer, ItemSerializer, SearchResultSerializer + +from base64 import b64decode class EventViewSet(viewsets.ModelViewSet): @@ -20,18 +22,26 @@ class ContainerViewSet(viewsets.ModelViewSet): queryset = Container.objects.all() +def filter_items(items, query): + query_tokens = query.split(' ') + for item in items: + value = 0 + for token in query_tokens: + if token in item.description: + value += 1 + if value > 0: + yield {'search_score': value, 'item': item} + + @api_view(['GET']) @permission_classes([IsAuthenticated]) -@permission_required('view_item', raise_exception=True) def search_items(request, event_slug, query): try: event = Event.objects.get(slug=event_slug) - query_tokens = query.split(' ') - q = Item.objects.filter(event=event) - for token in query_tokens: - if token: - q = q.filter(description__icontains=token) - return Response(ItemSerializer(q, many=True).data) + if not request.user.has_event_perm(event, 'view_item'): + return Response(status=403) + items = filter_items(Item.objects.filter(event=event), b64decode(query).decode('utf-8')) + return Response(SearchResultSerializer(items, many=True).data) except Event.DoesNotExist: return Response(status=404) @@ -40,7 +50,9 @@ def search_items(request, event_slug, query): @permission_classes([IsAuthenticated]) def item(request, event_slug): try: - event = Event.objects.get(slug=event_slug) + event = None + if event_slug != 'none': + event = Event.objects.get(slug=event_slug) if request.method == 'GET': if not request.user.has_event_perm(event, 'view_item'): return Response(status=403) @@ -52,6 +64,7 @@ def item(request, event_slug): if validated_data.is_valid(): validated_data.save(event=event) return Response(validated_data.data, status=201) + return Response(status=400) except Event.DoesNotExist: return Response(status=404) @@ -61,7 +74,7 @@ def item(request, event_slug): def item_by_id(request, event_slug, id): try: event = Event.objects.get(slug=event_slug) - item = Item.objects.get(event=event, uid=id) + item = Item.objects.get(event=event, id=id) if request.method == 'GET': if not request.user.has_event_perm(event, 'view_item'): return Response(status=403) @@ -99,8 +112,8 @@ router.register(r'boxes', ContainerViewSet, basename='boxes') router.register(r'box', ContainerViewSet, basename='boxes') urlpatterns = router.urls + [ - path('/items/', item), - path('/items//', search_items), - path('/item/', item), - path('/item//', item_by_id), + re_path(r'^(?P[\w-]+)/items/$', item, name='item'), + re_path(r'^(?P[\w-]+)/items/(?P[-A-Za-z0-9+/]*={0,3})/$', search_items, name='search_items'), + re_path(r'^(?P[\w-]+)/item/$', item, name='item'), + re_path(r'^(?P[\w-]+)/item/(?P\d+)/$', item_by_id, name='item_by_id'), ] diff --git a/core/inventory/migrations/0005_rename_cid_container_id_rename_eid_event_id_and_more.py b/core/inventory/migrations/0005_rename_cid_container_id_rename_eid_event_id_and_more.py new file mode 100644 index 0000000..fcd4b8d --- /dev/null +++ b/core/inventory/migrations/0005_rename_cid_container_id_rename_eid_event_id_and_more.py @@ -0,0 +1,52 @@ +# Generated by Django 4.2.7 on 2024-11-19 22:56 + +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + dependencies = [ + ('inventory', '0004_alter_event_created_at_alter_item_created_at'), + ] + + operations = [ + migrations.RenameField( + model_name='container', + old_name='cid', + new_name='id', + ), + migrations.RenameField( + model_name='event', + old_name='eid', + new_name='id', + ), + migrations.RenameField( + model_name='item', + old_name='iid', + new_name='id', + ), + migrations.RenameField( + model_name='item', + old_name='uid', + new_name='uid_deprecated', + ), + migrations.AlterUniqueTogether( + name='item', + unique_together=set(), + ), + migrations.AlterField( + model_name='item', + name='container', + field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='inventory.container'), + ), + migrations.AlterField( + model_name='item', + name='event', + field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='inventory.event'), + ), + migrations.AlterUniqueTogether( + name='item', + unique_together={('uid_deprecated', 'event')}, + ), + ] diff --git a/core/inventory/migrations/0006_alter_event_table.py b/core/inventory/migrations/0006_alter_event_table.py new file mode 100644 index 0000000..2fa421a --- /dev/null +++ b/core/inventory/migrations/0006_alter_event_table.py @@ -0,0 +1,17 @@ +# Generated by Django 4.2.7 on 2024-11-20 01:39 + +from django.db import migrations + + +class Migration(migrations.Migration): + + dependencies = [ + ('inventory', '0005_rename_cid_container_id_rename_eid_event_id_and_more'), + ] + + operations = [ + migrations.AlterModelTable( + name='event', + table='common_event', + ), + ] diff --git a/core/inventory/models.py b/core/inventory/models.py index 8b3d018..3421680 100644 --- a/core/inventory/models.py +++ b/core/inventory/models.py @@ -1,15 +1,16 @@ -from django.core.files.base import ContentFile -from django.db import models, IntegrityError +from itertools import groupby + +from django.db import models from django_softdelete.models import SoftDeleteModel, SoftDeleteManager class ItemManager(SoftDeleteManager): def create(self, **kwargs): - if 'uid' in kwargs: - raise ValueError('uid must not be set manually') - uid = Item.all_objects.filter(event=kwargs['event']).count() + 1 - kwargs['uid'] = uid + if 'uid_deprecated' in kwargs: + raise ValueError('uid_deprecated must not be set manually') + uid_deprecated = Item.all_objects.filter(event=kwargs['event']).count() + 1 + kwargs['uid_deprecated'] = uid_deprecated return super().create(**kwargs) def get_queryset(self): @@ -17,40 +18,47 @@ class ItemManager(SoftDeleteManager): class Item(SoftDeleteModel): - iid = models.AutoField(primary_key=True) - uid = models.IntegerField() + id = models.AutoField(primary_key=True) + uid_deprecated = models.IntegerField() description = models.TextField() - event = models.ForeignKey('Event', models.CASCADE, db_column='eid') - container = models.ForeignKey('Container', models.CASCADE, db_column='cid') + event = models.ForeignKey('Event', models.CASCADE) + container = models.ForeignKey('Container', models.CASCADE) returned_at = models.DateTimeField(blank=True, null=True) created_at = models.DateTimeField(null=True, auto_now_add=True) updated_at = models.DateTimeField(blank=True, null=True) + @property + def related_issues(self): + groups = groupby(self.issue_relation_changes.all(), lambda rel: rel.issue_thread.id) + return [sorted(v, key=lambda r: r.timestamp)[0].issue_thread for k, v in groups] + + + objects = ItemManager() all_objects = models.Manager() class Meta: - unique_together = (('uid', 'event'),) + unique_together = (('uid_deprecated', 'event'),) permissions = [ ('match_item', 'Can match item') ] def __str__(self): - return '[' + str(self.uid) + ']' + self.description + return '[' + str(self.id) + ']' + self.description class Container(SoftDeleteModel): - cid = models.AutoField(primary_key=True) + id = models.AutoField(primary_key=True) name = models.CharField(max_length=255) created_at = models.DateTimeField(blank=True, null=True) updated_at = models.DateTimeField(blank=True, null=True) def __str__(self): - return '[' + str(self.cid) + ']' + self.name + return '[' + str(self.id) + ']' + self.name class Event(models.Model): - eid = models.AutoField(primary_key=True) + id = models.AutoField(primary_key=True) name = models.CharField(max_length=255) slug = models.CharField(max_length=255, unique=True) start = models.DateTimeField(blank=True, null=True) @@ -62,3 +70,6 @@ class Event(models.Model): def __str__(self): return '[' + str(self.slug) + ']' + self.name + + class Meta: + db_table = 'common_event' \ No newline at end of file diff --git a/core/inventory/serializers.py b/core/inventory/serializers.py index 18686e1..9ae2bbe 100644 --- a/core/inventory/serializers.py +++ b/core/inventory/serializers.py @@ -4,7 +4,9 @@ from rest_framework.relations import SlugRelatedField from files.models import File from inventory.models import Event, Container, Item +from inventory.shared_serializers import BasicItemSerializer from mail.models import EventAddress +from tickets.shared_serializers import BasicIssueSerializer #class EventAdressSerializer(serializers.ModelSerializer): @@ -30,8 +32,8 @@ class EventSerializer(serializers.ModelSerializer): class Meta: model = Event - fields = ['eid', 'slug', 'name', 'start', 'end', 'pre_start', 'post_end', 'addresses'] - read_only_fields = ['eid'] + fields = ['id', 'slug', 'name', 'start', 'end', 'pre_start', 'post_end', 'addresses'] + read_only_fields = ['id'] # def update(self, instance, validated_data): # addresses = validated_data.pop('addresses', None) @@ -50,44 +52,27 @@ class ContainerSerializer(serializers.ModelSerializer): class Meta: model = Container - fields = ['cid', 'name', 'itemCount'] - read_only_fields = ['cid', 'itemCount'] + fields = ['id', 'name', 'itemCount'] + read_only_fields = ['id', 'itemCount'] def get_itemCount(self, instance): - return Item.objects.filter(container=instance.cid).count() + return Item.objects.filter(container=instance.id).count() -class ItemSerializer(serializers.ModelSerializer): +class ItemSerializer(BasicItemSerializer): dataImage = serializers.CharField(write_only=True, required=False) - cid = serializers.SerializerMethodField() - box = serializers.SerializerMethodField() - file = serializers.SerializerMethodField() - returned = serializers.SerializerMethodField(required=False) + related_issues = BasicIssueSerializer(many=True, read_only=True) class Meta: model = Item - fields = ['cid', 'box', 'uid', 'description', 'file', 'dataImage', 'returned'] - read_only_fields = ['uid'] - - def get_cid(self, instance): - return instance.container.cid - - def get_box(self, instance): - return instance.container.name - - def get_file(self, instance): - if len(instance.files.all()) > 0: - return instance.files.all().order_by('-created_at')[0].hash - return None - - def get_returned(self, instance): - return instance.returned_at is not None + fields = ['cid', 'box', 'id', 'description', 'file', 'dataImage', 'returned', 'event', 'related_issues'] + read_only_fields = ['id'] def to_internal_value(self, data): container = None returned = False if 'cid' in data: - container = Container.objects.get(cid=data['cid']) + container = Container.objects.get(id=data['cid']) if 'returned' in data: returned = data['returned'] internal = super().to_internal_value(data) @@ -98,6 +83,8 @@ class ItemSerializer(serializers.ModelSerializer): return internal def validate(self, attrs): + if not 'container' in attrs and not self.partial: + raise serializers.ValidationError("This field cannot be empty.") return super().validate(attrs) def create(self, validated_data): @@ -119,3 +106,14 @@ class ItemSerializer(serializers.ModelSerializer): validated_data.pop('dataImage') instance.files.add(file) return super().update(instance, validated_data) + + +class SearchResultSerializer(serializers.Serializer): + search_score = serializers.IntegerField() + item = ItemSerializer() + + def to_representation(self, instance): + return {**ItemSerializer(instance['item']).data, 'search_score': instance['search_score']} + + class Meta: + model = Item diff --git a/core/inventory/shared_serializers.py b/core/inventory/shared_serializers.py new file mode 100644 index 0000000..0bd44c3 --- /dev/null +++ b/core/inventory/shared_serializers.py @@ -0,0 +1,31 @@ +from rest_framework import serializers + +from inventory.models import Event, Item + + +class BasicItemSerializer(serializers.ModelSerializer): + cid = serializers.SerializerMethodField() + box = serializers.SerializerMethodField() + file = serializers.SerializerMethodField() + returned = serializers.SerializerMethodField(required=False) + event = serializers.SlugRelatedField(slug_field='slug', queryset=Event.objects.all(), + allow_null=True, required=False) + + class Meta: + model = Item + fields = ['cid', 'box', 'id', 'description', 'file', 'returned', 'event'] + read_only_fields = ['id'] + + def get_cid(self, instance): + return instance.container.id if instance.container else None + + def get_box(self, instance): + return instance.container.name if instance.container else None + + def get_file(self, instance): + if len(instance.files.all()) > 0: + return instance.files.all().order_by('-created_at')[0].hash + return None + + def get_returned(self, instance): + return instance.returned_at is not None diff --git a/core/inventory/tests/v1/__init__.py b/core/inventory/tests/v1/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/core/inventory/tests/v1/test_api.py b/core/inventory/tests/v1/test_api.py deleted file mode 100644 index db1df0a..0000000 --- a/core/inventory/tests/v1/test_api.py +++ /dev/null @@ -1,34 +0,0 @@ -from django.test import TestCase, Client - -client = Client() - - -class ApiTest(TestCase): - - def test_root(self): - from core.settings import SYSTEM3_VERSION - response = client.get('/api/') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json()["framework_version"], SYSTEM3_VERSION) - - def test_events(self): - response = client.get('/api/1/events') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json(), []) - - def test_containers(self): - response = client.get('/api/1/boxes') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json(), []) - - def test_files(self): - response = client.get('/api/1/files') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json(), []) - - def test_items(self): - from inventory.models import Event - Event.objects.create(slug='TEST1', name='Event') - response = client.get('/api/1/TEST1/items') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json(), []) diff --git a/core/inventory/tests/v1/test_containers.py b/core/inventory/tests/v1/test_containers.py deleted file mode 100644 index 78b82c1..0000000 --- a/core/inventory/tests/v1/test_containers.py +++ /dev/null @@ -1,59 +0,0 @@ -from django.test import TestCase, Client -from inventory.models import Container - -client = Client() - - -class ContainerTestCase(TestCase): - - def test_empty(self): - response = client.get('/api/1/boxes') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json(), []) - - def test_members(self): - Container.objects.create(name='BOX') - response = client.get('/api/1/boxes') - self.assertEqual(response.status_code, 200) - self.assertEqual(len(response.json()), 1) - self.assertEqual(response.json()[0]['cid'], 1) - self.assertEqual(response.json()[0]['name'], 'BOX') - self.assertEqual(response.json()[0]['itemCount'], 0) - - def test_multi_members(self): - Container.objects.create(name='BOX 1') - Container.objects.create(name='BOX 2') - Container.objects.create(name='BOX 3') - response = client.get('/api/1/boxes') - self.assertEqual(response.status_code, 200) - self.assertEqual(len(response.json()), 3) - - def test_create_container(self): - response = client.post('/api/1/box', {'name': 'BOX'}) - self.assertEqual(response.status_code, 201) - self.assertEqual(response.json()['cid'], 1) - self.assertEqual(response.json()['name'], 'BOX') - self.assertEqual(response.json()['itemCount'], 0) - self.assertEqual(len(Container.objects.all()), 1) - self.assertEqual(Container.objects.all()[0].cid, 1) - self.assertEqual(Container.objects.all()[0].name, 'BOX') - - def test_update_container(self): - from rest_framework.test import APIClient - box = Container.objects.create(name='BOX 1') - response = APIClient().put(f'/api/1/box/{box.cid}', {'name': 'BOX 2'}) - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json()['cid'], 1) - self.assertEqual(response.json()['name'], 'BOX 2') - self.assertEqual(response.json()['itemCount'], 0) - self.assertEqual(len(Container.objects.all()), 1) - self.assertEqual(Container.objects.all()[0].cid, 1) - self.assertEqual(Container.objects.all()[0].name, 'BOX 2') - - def test_delete_container(self): - box = Container.objects.create(name='BOX 1') - Container.objects.create(name='BOX 2') - self.assertEqual(len(Container.objects.all()), 2) - response = client.delete(f'/api/1/box/{box.cid}') - self.assertEqual(response.status_code, 204) - self.assertEqual(len(Container.objects.all()), 1) diff --git a/core/inventory/tests/v1/test_events.py b/core/inventory/tests/v1/test_events.py deleted file mode 100644 index a861f12..0000000 --- a/core/inventory/tests/v1/test_events.py +++ /dev/null @@ -1,56 +0,0 @@ -from django.test import TestCase, Client -from inventory.models import Event - -client = Client() - - -class EventTestCase(TestCase): - - def test_empty(self): - response = client.get('/api/1/events') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json(), []) - - def test_members(self): - Event.objects.create(slug='EVENT', name='Event') - response = client.get('/api/1/events') - self.assertEqual(response.status_code, 200) - self.assertEqual(len(response.json()), 1) - self.assertEqual(response.json()[0]['slug'], 'EVENT') - self.assertEqual(response.json()[0]['name'], 'Event') - - def test_multi_members(self): - Event.objects.create(slug='EVENT1', name='Event 1') - Event.objects.create(slug='EVENT2', name='Event 2') - Event.objects.create(slug='EVENT3', name='Event 3') - response = client.get('/api/1/events') - self.assertEqual(response.status_code, 200) - self.assertEqual(len(response.json()), 3) - - def test_create_event(self): - response = client.post('/api/1/events', {'slug': 'EVENT', 'name': 'Event'}) - self.assertEqual(response.status_code, 201) - self.assertEqual(response.json()['slug'], 'EVENT') - self.assertEqual(response.json()['name'], 'Event') - self.assertEqual(len(Event.objects.all()), 1) - self.assertEqual(Event.objects.all()[0].slug, 'EVENT') - self.assertEqual(Event.objects.all()[0].name, 'Event') - - def test_update_event(self): - from rest_framework.test import APIClient - event = Event.objects.create(slug='EVENT1', name='Event 1') - response = APIClient().put(f'/api/1/events/{event.eid}', {'slug': 'EVENT2', 'name': 'Event 2 new'}) - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json()['slug'], 'EVENT2') - self.assertEqual(response.json()['name'], 'Event 2 new') - self.assertEqual(len(Event.objects.all()), 1) - self.assertEqual(Event.objects.all()[0].slug, 'EVENT2') - self.assertEqual(Event.objects.all()[0].name, 'Event 2 new') - - def test_remove_event(self): - event = Event.objects.create(slug='EVENT1', name='Event 1') - Event.objects.create(slug='EVENT2', name='Event 2') - self.assertEqual(len(Event.objects.all()), 2) - response = client.delete(f'/api/1/events/{event.eid}') - self.assertEqual(response.status_code, 204) - self.assertEqual(len(Event.objects.all()), 1) diff --git a/core/inventory/tests/v1/test_items.py b/core/inventory/tests/v1/test_items.py deleted file mode 100644 index e13bcba..0000000 --- a/core/inventory/tests/v1/test_items.py +++ /dev/null @@ -1,133 +0,0 @@ -from django.test import TestCase, Client - -from files.models import File -from inventory.models import Event, Container, Item - -client = Client() - - -class ItemTestCase(TestCase): - - def setUp(self): - super().setUp() - self.event = Event.objects.create(slug='EVENT', name='Event') - self.box = Container.objects.create(name='BOX') - - def test_empty(self): - response = client.get(f'/api/1/{self.event.slug}/item') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.content, b'[]') - - def test_members(self): - item = Item.objects.create(container=self.box, event=self.event, description='1') - response = client.get(f'/api/1/{self.event.slug}/item') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json(), - [{'uid': 1, 'description': '1', 'box': 'BOX', 'cid': self.box.cid, 'file': None}]) - - def test_members_with_file(self): - import base64 - item = Item.objects.create(container=self.box, event=self.event, description='1') - file = File.objects.create(item=item, data="data:text/plain;base64," + base64.b64encode(b"foo").decode('utf-8')) - response = client.get(f'/api/1/{self.event.slug}/item') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json(), - [{'uid': 1, 'description': '1', 'box': 'BOX', 'cid': self.box.cid, 'file': file.hash}]) - - def test_multi_members(self): - Item.objects.create(container=self.box, event=self.event, description='1') - Item.objects.create(container=self.box, event=self.event, description='2') - Item.objects.create(container=self.box, event=self.event, description='3') - response = client.get(f'/api/1/{self.event.slug}/item') - self.assertEqual(response.status_code, 200) - self.assertEqual(len(response.json()), 3) - - def test_create_item(self): - response = client.post(f'/api/1/{self.event.slug}/item', {'cid': self.box.cid, 'description': '1'}) - self.assertEqual(response.status_code, 201) - self.assertEqual(response.json(), - {'uid': 1, 'description': '1', 'box': 'BOX', 'cid': self.box.cid, 'file': None}) - self.assertEqual(len(Item.objects.all()), 1) - self.assertEqual(Item.objects.all()[0].uid, 1) - self.assertEqual(Item.objects.all()[0].description, '1') - self.assertEqual(Item.objects.all()[0].container.cid, self.box.cid) - - def test_create_item_with_file(self): - import base64 - response = client.post(f'/api/1/{self.event.slug}/item', - {'cid': self.box.cid, 'description': '1', - 'dataImage': "data:text/plain;base64," + base64.b64encode(b"foo").decode( - 'utf-8')}, content_type='application/json') - self.assertEqual(response.status_code, 201) - self.assertEqual(response.json()['uid'], 1) - self.assertEqual(response.json()['description'], '1') - self.assertEqual(response.json()['box'], 'BOX') - self.assertEqual(response.json()['cid'], self.box.cid) - self.assertEqual(len(response.json()['file']), 64) - self.assertEqual(len(Item.objects.all()), 1) - self.assertEqual(Item.objects.all()[0].uid, 1) - self.assertEqual(Item.objects.all()[0].description, '1') - self.assertEqual(Item.objects.all()[0].container.cid, self.box.cid) - self.assertEqual(len(File.objects.all()), 1) - - def test_update_item(self): - item = Item.objects.create(container=self.box, event=self.event, description='1') - response = client.put(f'/api/1/{self.event.slug}/item/{item.uid}', {'description': '2'}, - content_type='application/json') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json(), - {'uid': 1, 'description': '2', 'box': 'BOX', 'cid': self.box.cid, 'file': None}) - self.assertEqual(len(Item.objects.all()), 1) - self.assertEqual(Item.objects.all()[0].uid, 1) - self.assertEqual(Item.objects.all()[0].description, '2') - self.assertEqual(Item.objects.all()[0].container.cid, self.box.cid) - - def test_update_item_with_file(self): - import base64 - item = Item.objects.create(container=self.box, event=self.event, description='1') - response = client.put(f'/api/1/{self.event.slug}/item/{item.uid}', - {'description': '2', - 'dataImage': "data:text/plain;base64," + base64.b64encode(b"foo").decode('utf-8')}, - content_type='application/json') - self.assertEqual(response.status_code, 200) - self.assertEqual(response.json()['uid'], 1) - self.assertEqual(response.json()['description'], '2') - self.assertEqual(response.json()['box'], 'BOX') - self.assertEqual(response.json()['cid'], self.box.cid) - self.assertEqual(len(response.json()['file']), 64) - self.assertEqual(len(Item.objects.all()), 1) - self.assertEqual(Item.objects.all()[0].uid, 1) - self.assertEqual(Item.objects.all()[0].description, '2') - self.assertEqual(Item.objects.all()[0].container.cid, self.box.cid) - self.assertEqual(len(File.objects.all()), 1) - - def test_delete_item(self): - item = Item.objects.create(container=self.box, event=self.event, description='1') - Item.objects.create(container=self.box, event=self.event, description='2') - self.assertEqual(len(Item.objects.all()), 2) - response = client.delete(f'/api/1/{self.event.slug}/item/{item.uid}') - self.assertEqual(response.status_code, 204) - self.assertEqual(len(Item.objects.all()), 1) - - def test_delete_item2(self): - Item.objects.create(container=self.box, event=self.event, description='1') - item2 = Item.objects.create(container=self.box, event=self.event, description='2') - self.assertEqual(len(Item.objects.all()), 2) - response = client.delete(f'/api/1/{self.event.slug}/item/{item2.uid}') - self.assertEqual(response.status_code, 204) - self.assertEqual(len(Item.objects.all()), 1) - item3 = Item.objects.create(container=self.box, event=self.event, description='3') - self.assertEqual(item3.uid, 3) - self.assertEqual(len(Item.objects.all()), 2) - - def test_item_count(self): - Item.objects.create(container=self.box, event=self.event, description='1') - Item.objects.create(container=self.box, event=self.event, description='2') - response = client.get('/api/1/boxes') - self.assertEqual(response.status_code, 200) - self.assertEqual(len(response.json()), 1) - self.assertEqual(response.json()[0]['itemCount'], 2) - - def test_item_nonexistent(self): - response = client.get(f'/api/1/NOEVENT/item') - self.assertEqual(response.status_code, 404) diff --git a/core/inventory/tests/v2/test_containers.py b/core/inventory/tests/v2/test_containers.py index 58322cc..b74a4a7 100644 --- a/core/inventory/tests/v2/test_containers.py +++ b/core/inventory/tests/v2/test_containers.py @@ -24,7 +24,7 @@ class ContainerTestCase(TestCase): response = self.client.get('/api/2/boxes/') self.assertEqual(response.status_code, 200) self.assertEqual(len(response.json()), 1) - self.assertEqual(response.json()[0]['cid'], 1) + self.assertEqual(response.json()[0]['id'], 1) self.assertEqual(response.json()[0]['name'], 'BOX') self.assertEqual(response.json()[0]['itemCount'], 0) @@ -39,28 +39,28 @@ class ContainerTestCase(TestCase): def test_create_container(self): response = self.client.post('/api/2/box/', {'name': 'BOX'}) self.assertEqual(response.status_code, 201) - self.assertEqual(response.json()['cid'], 1) + self.assertEqual(response.json()['id'], 1) self.assertEqual(response.json()['name'], 'BOX') self.assertEqual(response.json()['itemCount'], 0) self.assertEqual(len(Container.objects.all()), 1) - self.assertEqual(Container.objects.all()[0].cid, 1) + self.assertEqual(Container.objects.all()[0].id, 1) self.assertEqual(Container.objects.all()[0].name, 'BOX') def test_update_container(self): box = Container.objects.create(name='BOX 1') - response = self.client.put(f'/api/2/box/{box.cid}/', {'name': 'BOX 2'}, content_type='application/json') + response = self.client.put(f'/api/2/box/{box.id}/', {'name': 'BOX 2'}, content_type='application/json') self.assertEqual(response.status_code, 200) - self.assertEqual(response.json()['cid'], 1) + self.assertEqual(response.json()['id'], 1) self.assertEqual(response.json()['name'], 'BOX 2') self.assertEqual(response.json()['itemCount'], 0) self.assertEqual(len(Container.objects.all()), 1) - self.assertEqual(Container.objects.all()[0].cid, 1) + self.assertEqual(Container.objects.all()[0].id, 1) self.assertEqual(Container.objects.all()[0].name, 'BOX 2') def test_delete_container(self): box = Container.objects.create(name='BOX 1') Container.objects.create(name='BOX 2') self.assertEqual(len(Container.objects.all()), 2) - response = self.client.delete(f'/api/2/box/{box.cid}/') + response = self.client.delete(f'/api/2/box/{box.id}/') self.assertEqual(response.status_code, 204) self.assertEqual(len(Container.objects.all()), 1) diff --git a/core/inventory/tests/v2/test_events.py b/core/inventory/tests/v2/test_events.py index 6bbc701..55c6b90 100644 --- a/core/inventory/tests/v2/test_events.py +++ b/core/inventory/tests/v2/test_events.py @@ -39,7 +39,7 @@ class EventTestCase(TestCase): def test_update_event(self): from rest_framework.test import APIClient event = Event.objects.create(slug='EVENT1', name='Event 1') - response = APIClient().put(f'/api/2/events/{event.eid}/', {'slug': 'EVENT2', 'name': 'Event 2 new'}) + response = APIClient().put(f'/api/2/events/{event.id}/', {'slug': 'EVENT2', 'name': 'Event 2 new'}) self.assertEqual(response.status_code, 200) self.assertEqual(response.json()['slug'], 'EVENT2') self.assertEqual(response.json()['name'], 'Event 2 new') @@ -63,7 +63,7 @@ class EventTestCase(TestCase): event = Event.objects.create(slug='EVENT1', name='Event 1') Event.objects.create(slug='EVENT2', name='Event 2') self.assertEqual(len(Event.objects.all()), 2) - response = client.delete(f'/api/2/events/{event.eid}/') + response = client.delete(f'/api/2/events/{event.id}/') self.assertEqual(response.status_code, 204) self.assertEqual(len(Event.objects.all()), 1) diff --git a/core/inventory/tests/v2/test_items.py b/core/inventory/tests/v2/test_items.py index 056b38c..59a5a4e 100644 --- a/core/inventory/tests/v2/test_items.py +++ b/core/inventory/tests/v2/test_items.py @@ -7,6 +7,8 @@ from authentication.models import ExtendedUser from files.models import File from inventory.models import Event, Container, Item +from base64 import b64encode + class ItemTestCase(TestCase): @@ -28,9 +30,15 @@ class ItemTestCase(TestCase): item = Item.objects.create(container=self.box, event=self.event, description='1') response = self.client.get(f'/api/2/{self.event.slug}/item/') self.assertEqual(response.status_code, 200) - self.assertEqual(response.json(), - [{'uid': 1, 'description': '1', 'box': 'BOX', 'cid': self.box.cid, 'file': None, - 'returned': False}]) + self.assertEqual(len(response.json()), 1) + self.assertEqual(response.json()[0]['id'], item.id) + self.assertEqual(response.json()[0]['description'], '1') + self.assertEqual(response.json()[0]['box'], 'BOX') + self.assertEqual(response.json()[0]['cid'], self.box.id) + self.assertEqual(response.json()[0]['file'], None) + self.assertEqual(response.json()[0]['returned'], False) + self.assertEqual(response.json()[0]['event'], self.event.slug) + self.assertEqual(len(response.json()[0]['related_issues']), 0) def test_members_with_file(self): import base64 @@ -38,9 +46,15 @@ class ItemTestCase(TestCase): file = File.objects.create(item=item, data="data:text/plain;base64," + base64.b64encode(b"foo").decode('utf-8')) response = self.client.get(f'/api/2/{self.event.slug}/item/') self.assertEqual(response.status_code, 200) - self.assertEqual(response.json(), - [{'uid': 1, 'description': '1', 'box': 'BOX', 'cid': self.box.cid, 'file': file.hash, - 'returned': False}]) + self.assertEqual(len(response.json()), 1) + self.assertEqual(response.json()[0]['id'], item.id) + self.assertEqual(response.json()[0]['description'], '1') + self.assertEqual(response.json()[0]['box'], 'BOX') + self.assertEqual(response.json()[0]['cid'], self.box.id) + self.assertEqual(response.json()[0]['file'], file.hash) + self.assertEqual(response.json()[0]['returned'], False) + self.assertEqual(response.json()[0]['event'], self.event.slug) + self.assertEqual(len(response.json()[0]['related_issues']), 0) def test_multi_members(self): Item.objects.create(container=self.box, event=self.event, description='1') @@ -51,71 +65,89 @@ class ItemTestCase(TestCase): self.assertEqual(len(response.json()), 3) def test_create_item(self): - response = self.client.post(f'/api/2/{self.event.slug}/item/', {'cid': self.box.cid, 'description': '1'}) + response = self.client.post(f'/api/2/{self.event.slug}/item/', {'cid': self.box.id, 'description': '1'}) self.assertEqual(response.status_code, 201) - self.assertEqual(response.json(), - {'uid': 1, 'description': '1', 'box': 'BOX', 'cid': self.box.cid, 'file': None, - 'returned': False}) + self.assertEqual(response.json()['id'], 1) + self.assertEqual(response.json()['description'], '1') + self.assertEqual(response.json()['box'], 'BOX') + self.assertEqual(response.json()['cid'], self.box.id) + self.assertEqual(response.json()['file'], None) + self.assertEqual(response.json()['returned'], False) + self.assertEqual(response.json()['event'], self.event.slug) + self.assertEqual(len(response.json()['related_issues']), 0) self.assertEqual(len(Item.objects.all()), 1) - self.assertEqual(Item.objects.all()[0].uid, 1) + self.assertEqual(Item.objects.all()[0].id, 1) self.assertEqual(Item.objects.all()[0].description, '1') - self.assertEqual(Item.objects.all()[0].container.cid, self.box.cid) + self.assertEqual(Item.objects.all()[0].container.id, self.box.id) + + def test_create_item_without_container(self): + response = self.client.post(f'/api/2/{self.event.slug}/item/', {'description': '1'}) + self.assertEqual(response.status_code, 400) + + def test_create_item_without_description(self): + response = self.client.post(f'/api/2/{self.event.slug}/item/', {'cid': self.box.id}) + self.assertEqual(response.status_code, 400) def test_create_item_with_file(self): import base64 response = self.client.post(f'/api/2/{self.event.slug}/item/', - {'cid': self.box.cid, 'description': '1', + {'cid': self.box.id, 'description': '1', 'dataImage': "data:text/plain;base64," + base64.b64encode(b"foo").decode( 'utf-8')}, content_type='application/json') self.assertEqual(response.status_code, 201) - self.assertEqual(response.json()['uid'], 1) + self.assertEqual(response.json()['id'], 1) self.assertEqual(response.json()['description'], '1') self.assertEqual(response.json()['box'], 'BOX') - self.assertEqual(response.json()['cid'], self.box.cid) + self.assertEqual(response.json()['id'], self.box.id) self.assertEqual(len(response.json()['file']), 64) self.assertEqual(len(Item.objects.all()), 1) - self.assertEqual(Item.objects.all()[0].uid, 1) + self.assertEqual(Item.objects.all()[0].id, 1) self.assertEqual(Item.objects.all()[0].description, '1') - self.assertEqual(Item.objects.all()[0].container.cid, self.box.cid) + self.assertEqual(Item.objects.all()[0].container.id, self.box.id) self.assertEqual(len(File.objects.all()), 1) def test_update_item(self): item = Item.objects.create(container=self.box, event=self.event, description='1') - response = self.client.put(f'/api/2/{self.event.slug}/item/{item.uid}/', {'description': '2'}, + response = self.client.patch(f'/api/2/{self.event.slug}/item/{item.id}/', {'description': '2'}, content_type='application/json') self.assertEqual(response.status_code, 200) - self.assertEqual(response.json(), - {'uid': 1, 'description': '2', 'box': 'BOX', 'cid': self.box.cid, 'file': None, - 'returned': False}) + self.assertEqual(response.json()['id'], item.id) + self.assertEqual(response.json()['description'], '2') + self.assertEqual(response.json()['box'], 'BOX') + self.assertEqual(response.json()['cid'], self.box.id) + self.assertEqual(response.json()['file'], None) + self.assertEqual(response.json()['returned'], False) + self.assertEqual(response.json()['event'], self.event.slug) + self.assertEqual(len(response.json()['related_issues']), 0) self.assertEqual(len(Item.objects.all()), 1) - self.assertEqual(Item.objects.all()[0].uid, 1) + self.assertEqual(Item.objects.all()[0].id, 1) self.assertEqual(Item.objects.all()[0].description, '2') - self.assertEqual(Item.objects.all()[0].container.cid, self.box.cid) + self.assertEqual(Item.objects.all()[0].container.id, self.box.id) def test_update_item_with_file(self): import base64 item = Item.objects.create(container=self.box, event=self.event, description='1') - response = self.client.put(f'/api/2/{self.event.slug}/item/{item.uid}/', + response = self.client.patch(f'/api/2/{self.event.slug}/item/{item.id}/', {'description': '2', 'dataImage': "data:text/plain;base64," + base64.b64encode(b"foo").decode('utf-8')}, content_type='application/json') self.assertEqual(response.status_code, 200) - self.assertEqual(response.json()['uid'], 1) + self.assertEqual(response.json()['id'], 1) self.assertEqual(response.json()['description'], '2') self.assertEqual(response.json()['box'], 'BOX') - self.assertEqual(response.json()['cid'], self.box.cid) + self.assertEqual(response.json()['id'], self.box.id) self.assertEqual(len(response.json()['file']), 64) self.assertEqual(len(Item.objects.all()), 1) - self.assertEqual(Item.objects.all()[0].uid, 1) + self.assertEqual(Item.objects.all()[0].id, 1) self.assertEqual(Item.objects.all()[0].description, '2') - self.assertEqual(Item.objects.all()[0].container.cid, self.box.cid) + self.assertEqual(Item.objects.all()[0].container.id, self.box.id) self.assertEqual(len(File.objects.all()), 1) def test_delete_item(self): item = Item.objects.create(container=self.box, event=self.event, description='1') Item.objects.create(container=self.box, event=self.event, description='2') self.assertEqual(len(Item.objects.all()), 2) - response = self.client.delete(f'/api/2/{self.event.slug}/item/{item.uid}/') + response = self.client.delete(f'/api/2/{self.event.slug}/item/{item.id}/') self.assertEqual(response.status_code, 204) self.assertEqual(len(Item.objects.all()), 1) @@ -123,11 +155,11 @@ class ItemTestCase(TestCase): Item.objects.create(container=self.box, event=self.event, description='1') item2 = Item.objects.create(container=self.box, event=self.event, description='2') self.assertEqual(len(Item.objects.all()), 2) - response = self.client.delete(f'/api/2/{self.event.slug}/item/{item2.uid}/') + response = self.client.delete(f'/api/2/{self.event.slug}/item/{item2.id}/') self.assertEqual(response.status_code, 204) self.assertEqual(len(Item.objects.all()), 1) item3 = Item.objects.create(container=self.box, event=self.event, description='3') - self.assertEqual(item3.uid, 3) + self.assertEqual(item3.id, 3) self.assertEqual(len(Item.objects.all()), 2) def test_item_count(self): @@ -148,7 +180,7 @@ class ItemTestCase(TestCase): response = self.client.get(f'/api/2/{self.event.slug}/item/') self.assertEqual(response.status_code, 200) self.assertEqual(len(response.json()), 1) - response = self.client.patch(f'/api/2/{self.event.slug}/item/{item.uid}/', {'returned': True}, + response = self.client.patch(f'/api/2/{self.event.slug}/item/{item.id}/', {'returned': True}, content_type='application/json') self.assertEqual(response.status_code, 200) item.refresh_from_db() @@ -168,4 +200,75 @@ class ItemTestCase(TestCase): response = self.client.get(f'/api/2/{self.event.slug}/item/') self.assertEqual(response.status_code, 200) self.assertEqual(len(response.json()), 1) - self.assertEqual(response.json()[0]['uid'], item1.uid) + self.assertEqual(response.json()[0]['id'], item1.id) + + +class ItemSearchTestCase(TestCase): + + def setUp(self): + super().setUp() + self.event = Event.objects.create(slug='EVENT', name='Event') + self.box = Container.objects.create(name='BOX') + self.user = ExtendedUser.objects.create_user('testuser', 'test', 'test') + self.user.user_permissions.add(*Permission.objects.all()) + self.token = AuthToken.objects.create(user=self.user) + self.client = Client(headers={'Authorization': 'Token ' + self.token[1]}) + self.item1 = Item.objects.create(container=self.box, event=self.event, description='abc def') + self.item2 = Item.objects.create(container=self.box, event=self.event, description='def ghi') + self.item3 = Item.objects.create(container=self.box, event=self.event, description='jkl mno pqr') + self.item4 = Item.objects.create(container=self.box, event=self.event, description='stu vwx') + + def test_search(self): + search_query = b64encode(b'abc').decode('utf-8') + response = self.client.get(f'/api/2/{self.event.slug}/items/{search_query}/') + self.assertEqual(200, response.status_code) + self.assertEqual(1, len(response.json())) + self.assertEqual(self.item1.id, response.json()[0]['id']) + self.assertEqual('abc def', response.json()[0]['description']) + self.assertEqual('BOX', response.json()[0]['box']) + self.assertEqual(self.box.id, response.json()[0]['cid']) + self.assertEqual(1, response.json()[0]['search_score']) + + def test_search2(self): + search_query = b64encode(b'def').decode('utf-8') + response = self.client.get(f'/api/2/{self.event.slug}/items/{search_query}/') + self.assertEqual(200, response.status_code) + self.assertEqual(2, len(response.json())) + self.assertEqual(self.item1.id, response.json()[0]['id']) + self.assertEqual('abc def', response.json()[0]['description']) + self.assertEqual('BOX', response.json()[0]['box']) + self.assertEqual(self.box.id, response.json()[0]['cid']) + self.assertEqual(1, response.json()[0]['search_score']) + self.assertEqual(self.box.id, response.json()[1]['cid']) + self.assertEqual('def ghi', response.json()[1]['description']) + self.assertEqual('BOX', response.json()[1]['box']) + self.assertEqual(self.box.id, response.json()[1]['cid']) + self.assertEqual(1, response.json()[0]['search_score']) + + def test_search3(self): + search_query = b64encode(b'jkl').decode('utf-8') + response = self.client.get(f'/api/2/{self.event.slug}/items/{search_query}/') + self.assertEqual(200, response.status_code) + self.assertEqual(1, len(response.json())) + self.assertEqual(self.item3.id, response.json()[0]['id']) + self.assertEqual('jkl mno pqr', response.json()[0]['description']) + self.assertEqual('BOX', response.json()[0]['box']) + self.assertEqual(self.box.id, response.json()[0]['cid']) + self.assertEqual(1, response.json()[0]['search_score']) + + def test_search4(self): + search_query = b64encode(b'abc def').decode('utf-8') + response = self.client.get(f'/api/2/{self.event.slug}/items/{search_query}/') + self.assertEqual(200, response.status_code) + self.assertEqual(2, len(response.json())) + self.assertEqual(self.item1.id, response.json()[0]['id']) + self.assertEqual('abc def', response.json()[0]['description']) + self.assertEqual('BOX', response.json()[0]['box']) + self.assertEqual(self.box.id, response.json()[0]['cid']) + self.assertEqual(2, response.json()[0]['search_score']) + self.assertEqual(self.item2.id, response.json()[1]['id']) + self.assertEqual('def ghi', response.json()[1]['description']) + self.assertEqual('BOX', response.json()[1]['box']) + self.assertEqual(self.box.id, response.json()[1]['cid']) + self.assertEqual(1, response.json()[1]['search_score']) + diff --git a/core/mail/migrations/0006_email_raw_file.py b/core/mail/migrations/0006_email_raw_file.py new file mode 100644 index 0000000..4086af8 --- /dev/null +++ b/core/mail/migrations/0006_email_raw_file.py @@ -0,0 +1,36 @@ +# Generated by Django 4.2.7 on 2024-11-08 20:37 +from django.core.files.base import ContentFile +from django.db import migrations, models + + +class Migration(migrations.Migration): + dependencies = [ + ('mail', '0005_alter_eventaddress_event'), + ] + + def move_raw_mails_to_file(apps, schema_editor): + Email = apps.get_model('mail', 'Email') + for email in Email.objects.all(): + raw_content = email.raw + path = "mail_{}".format(email.id) + if len(raw_content): + email.raw_file.save(path, ContentFile(raw_content)) + email.save() + + operations = [ + migrations.AddField( + model_name='email', + name='raw_file', + field=models.FileField(null=True, upload_to='raw_mail/'), + ), + migrations.RunPython(move_raw_mails_to_file), + migrations.RemoveField( + model_name='email', + name='raw', + ), + migrations.AlterField( + model_name='email', + name='raw_file', + field=models.FileField(upload_to='raw_mail/'), + ), + ] diff --git a/core/mail/models.py b/core/mail/models.py index 378854b..36cd2b3 100644 --- a/core/mail/models.py +++ b/core/mail/models.py @@ -3,7 +3,7 @@ import random from django.db import models from django_softdelete.models import SoftDeleteModel -from core.settings import MAIL_DOMAIN +from core.settings import MAIL_DOMAIN, ACTIVE_SPAM_TRAINING from files.models import AbstractFile from inventory.models import Event from tickets.models import IssueThread @@ -18,7 +18,7 @@ class Email(SoftDeleteModel): recipient = models.CharField(max_length=255) reference = models.CharField(max_length=255, null=True, unique=True) in_reply_to = models.CharField(max_length=255, null=True) - raw = models.TextField() + raw_file = models.FileField(upload_to='raw_mail/') issue_thread = models.ForeignKey(IssueThread, models.SET_NULL, null=True, related_name='emails') event = models.ForeignKey(Event, models.SET_NULL, null=True) @@ -28,6 +28,18 @@ class Email(SoftDeleteModel): self.reference = f'<{random.randint(0, 1000000000):09}@{MAIL_DOMAIN}>' self.save() + def train_spam(self): + if ACTIVE_SPAM_TRAINING and self.raw_file.path: + import subprocess + path = self.raw_file.path + subprocess.run(["rspamc", "learn_spam", path]) + + def train_ham(self): + if ACTIVE_SPAM_TRAINING and self.raw_file.path: + import subprocess + path = self.raw_file.path + subprocess.run(["rspamc", "learn_ham", path]) + class EventAddress(models.Model): id = models.AutoField(primary_key=True) diff --git a/core/mail/protocol.py b/core/mail/protocol.py index a87f1a6..c5aaa4a 100644 --- a/core/mail/protocol.py +++ b/core/mail/protocol.py @@ -91,7 +91,7 @@ async def send_smtp(message): await aiosmtplib.send(message, hostname="127.0.0.1", port=25, use_tls=False, start_tls=False) -def find_active_issue_thread(in_reply_to, address, subject): +def find_active_issue_thread(in_reply_to, address, subject, event): from re import match uuid_match = match(r'^ticket\+([a-f0-9-]{36})@', address) if uuid_match: @@ -102,7 +102,7 @@ def find_active_issue_thread(in_reply_to, address, subject): if reply_to.exists(): return reply_to.first().issue_thread, False else: - issue = IssueThread.objects.create(name=subject) + issue = IssueThread.objects.create(name=subject, event=event) return issue, True @@ -202,11 +202,14 @@ def receive_email(envelope, log=None): subject = unescape_and_decode_base64(subject) target_event = find_target_event(recipient) - active_issue_thread, new = find_active_issue_thread(header_in_reply_to, recipient, subject) + active_issue_thread, new = find_active_issue_thread(header_in_reply_to, recipient, subject, target_event) + + from hashlib import sha256 + random_filename = 'mail-' + sha256(envelope.content).hexdigest() email = Email.objects.create( sender=sender, recipient=recipient, body=body, subject=subject, reference=header_message_id, - in_reply_to=header_in_reply_to, raw=envelope.content, event=target_event, + in_reply_to=header_in_reply_to, raw_file=ContentFile(envelope.content, name=random_filename), event=target_event, issue_thread=active_issue_thread) for attachment in attachments: email.attachments.add(attachment) diff --git a/core/mail/tests/v2/test_mails.py b/core/mail/tests/v2/test_mails.py index 3df56ca..3b358ca 100644 --- a/core/mail/tests/v2/test_mails.py +++ b/core/mail/tests/v2/test_mails.py @@ -142,6 +142,7 @@ class LMTPHandlerTestCase(TestCase): # TODO replace with less hacky test aiosmtplib.send.assert_called_once() self.assertEqual('test ä', Email.objects.all()[0].subject) self.assertEqual('Text mit Quoted-Printable-Kodierung: äöüß', Email.objects.all()[0].body) + self.assertTrue( Email.objects.all()[0].raw_file.path) def test_handle_quoted_printable_2(self): from aiosmtpd.smtp import Envelope @@ -162,6 +163,7 @@ class LMTPHandlerTestCase(TestCase): # TODO replace with less hacky test aiosmtplib.send.assert_called_once() self.assertEqual('suche_Mütze', Email.objects.all()[0].subject) self.assertEqual('Text mit Quoted-Printable-Kodierung: äöüß', Email.objects.all()[0].body) + self.assertTrue( Email.objects.all()[0].raw_file.path) def test_handle_base64(self): from aiosmtpd.smtp import Envelope @@ -182,6 +184,7 @@ class LMTPHandlerTestCase(TestCase): # TODO replace with less hacky test aiosmtplib.send.assert_called_once() self.assertEqual('test', Email.objects.all()[0].subject) self.assertEqual('Text mit Base64-Kodierung: äöüß', Email.objects.all()[0].body) + self.assertTrue( Email.objects.all()[0].raw_file.path) def test_handle_client_reply(self): issue_thread = IssueThread.objects.create( @@ -229,6 +232,7 @@ class LMTPHandlerTestCase(TestCase): # TODO replace with less hacky test self.assertEqual(IssueThread.objects.all()[0].name, 'test') self.assertEqual(IssueThread.objects.all()[0].state, 'pending_new') self.assertEqual(IssueThread.objects.all()[0].assigned_to, None) + self.assertTrue( Email.objects.all()[2].raw_file.path) def test_handle_client_reply_2(self): issue_thread = IssueThread.objects.create( @@ -281,6 +285,7 @@ class LMTPHandlerTestCase(TestCase): # TODO replace with less hacky test self.assertEqual(IssueThread.objects.all()[0].name, 'test') self.assertEqual(IssueThread.objects.all()[0].state, 'pending_open') self.assertEqual(IssueThread.objects.all()[0].assigned_to, None) + self.assertTrue( Email.objects.all()[2].raw_file.path) def test_mail_reply(self): issue_thread = IssueThread.objects.create( @@ -384,6 +389,7 @@ class LMTPHandlerTestCase(TestCase): # TODO replace with less hacky test states = StateChange.objects.filter(issue_thread=IssueThread.objects.all()[0]) self.assertEqual(1, len(states)) self.assertEqual('pending_new', states[0].state) + self.assertEqual(event, IssueThread.objects.all()[0].event) def test_mail_html_body(self): from aiosmtpd.smtp import Envelope diff --git a/core/requirements.dev.txt b/core/requirements.dev.txt index 146aa37..3807a6c 100644 --- a/core/requirements.dev.txt +++ b/core/requirements.dev.txt @@ -73,3 +73,5 @@ watchfiles==0.21.0 websockets==12.0 yarl==1.9.4 zope.interface==6.1 +django-prometheus==2.3.1 +prometheus_client==0.21.0 diff --git a/core/requirements.prod.txt b/core/requirements.prod.txt index 14bdc0f..ee69fe7 100644 --- a/core/requirements.prod.txt +++ b/core/requirements.prod.txt @@ -41,3 +41,5 @@ urllib3==2.1.0 uvicorn==0.24.0.post1 watchfiles==0.21.0 websockets==12.0 +django-prometheus==2.3.1 +prometheus_client==0.21.0 diff --git a/core/tickets/api_v2.py b/core/tickets/api_v2.py index 596bd9b..1ed7e02 100644 --- a/core/tickets/api_v2.py +++ b/core/tickets/api_v2.py @@ -1,4 +1,4 @@ -import logging +from base64 import b64decode from django.urls import re_path from django.contrib.auth.decorators import permission_required @@ -14,8 +14,9 @@ from inventory.models import Event from mail.models import Email from mail.protocol import send_smtp, make_reply, collect_references from notify_sessions.models import SystemEvent -from tickets.models import IssueThread, Comment, STATE_CHOICES, ShippingVoucher -from tickets.serializers import IssueSerializer, CommentSerializer, ShippingVoucherSerializer +from tickets.models import IssueThread, Comment, STATE_CHOICES, ShippingVoucher, ItemRelation +from tickets.serializers import IssueSerializer, CommentSerializer, ShippingVoucherSerializer, SearchResultSerializer +from tickets.shared_serializers import RelationSerializer class IssueViewSet(viewsets.ModelViewSet): @@ -23,6 +24,16 @@ class IssueViewSet(viewsets.ModelViewSet): queryset = IssueThread.objects.all() +class RelationViewSet(viewsets.ModelViewSet): + serializer_class = RelationSerializer + queryset = ItemRelation.objects.all() + + +class CommentViewSet(viewsets.ModelViewSet): + serializer_class = CommentSerializer + queryset = Comment.objects.all() + + class ShippingVoucherViewSet(viewsets.ModelViewSet): serializer_class = ShippingVoucherSerializer queryset = ShippingVoucher.objects.all() @@ -56,7 +67,7 @@ def reply(request, pk): @api_view(['POST']) @permission_classes([IsAuthenticated]) @permission_required('tickets.add_issuethread_manual', raise_exception=True) -def manual_ticket(request): +def manual_ticket(request, event_slug): if 'name' not in request.data: return Response({'status': 'error', 'message': 'missing name'}, status=status.HTTP_400_BAD_REQUEST) if 'sender' not in request.data: @@ -66,8 +77,16 @@ def manual_ticket(request): if 'body' not in request.data: return Response({'status': 'error', 'message': 'missing body'}, status=status.HTTP_400_BAD_REQUEST) + event = None + if event_slug != 'none': + try: + event = Event.objects.get(slug=event_slug) + except: + return Response({'status': 'error', 'message': 'invalid event'}, status=status.HTTP_400_BAD_REQUEST) + issue = IssueThread.objects.create( name=request.data['name'], + event=event, manually_created=True, ) email = Email.objects.create( @@ -117,13 +136,40 @@ def add_comment(request, pk): return Response(CommentSerializer(comment).data, status=status.HTTP_201_CREATED) +def filter_issues(issues, query): + query_tokens = query.split(' ') + for issue in issues: + value = 0 + for token in query_tokens: + if token in issue.description: + value += 1 + if value > 0: + yield {'search_score': value, 'issue': issue} + + +@api_view(['GET']) +@permission_classes([]) +# @permission_classes([IsAuthenticated]) +# @permission_required('view_item', raise_exception=True) +def search_issues(request, event_slug, query): + try: + event = Event.objects.get(slug=event_slug) + items = filter_issues(IssueThread.objects.filter(event=event), b64decode(query).decode('utf-8')) + return Response(SearchResultSerializer(items, many=True).data) + except Event.DoesNotExist: + return Response(status=404) + + router = routers.SimpleRouter() router.register(r'tickets', IssueViewSet, basename='issues') +router.register(r'matches', RelationViewSet, basename='matches') router.register(r'shipping_vouchers', ShippingVoucherViewSet, basename='shipping_vouchers') urlpatterns = ([ + re_path(r'tickets/states/$', get_available_states, name='get_available_states'), re_path(r'^tickets/(?P\d+)/reply/$', reply, name='reply'), re_path(r'^tickets/(?P\d+)/comment/$', add_comment, name='add_comment'), - re_path(r'^tickets/manual/$', manual_ticket, name='manual_ticket'), - re_path(r'^tickets/states/$', get_available_states, name='get_available_states'), + re_path(r'^(?P[\w-]+)/tickets/manual/$', manual_ticket, name='manual_ticket'), + re_path(r'^(?P[\w-]+)/tickets/(?P[-A-Za-z0-9+/]*={0,3})/$', search_issues, + name='search_issues'), ] + router.urls) diff --git a/core/tickets/migrations/0011_train_old_spam.py b/core/tickets/migrations/0011_train_old_spam.py new file mode 100644 index 0000000..206cbb4 --- /dev/null +++ b/core/tickets/migrations/0011_train_old_spam.py @@ -0,0 +1,31 @@ +# Generated by Django 4.2.7 on 2024-06-23 02:17 + +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + dependencies = [ + ('mail', '0006_email_raw_file'), + ('tickets', '0010_issuethread_event_itemrelation_and_more'), + ] + + def train_old_mails(apps, schema_editor): + from tickets.models import IssueThread + for t in IssueThread.objects.all(): + try: + state = t.state + i = 0 + for e in t.emails.all(): + if e.raw_file: + if state == 'closed_spam' and i == 0: + e.train_spam() + else: + e.train_ham() + i += 1 + except: + pass + + operations = [ + migrations.RunPython(train_old_mails), + ] diff --git a/core/tickets/migrations/0012_remove_issuethread_related_items_and_more.py b/core/tickets/migrations/0012_remove_issuethread_related_items_and_more.py new file mode 100644 index 0000000..d8a24c7 --- /dev/null +++ b/core/tickets/migrations/0012_remove_issuethread_related_items_and_more.py @@ -0,0 +1,29 @@ +# Generated by Django 4.2.7 on 2024-11-20 23:58 + +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + dependencies = [ + ('inventory', '0006_alter_event_table'), + ('tickets', '0011_train_old_spam'), + ] + + operations = [ + migrations.RemoveField( + model_name='issuethread', + name='related_items', + ), + migrations.AlterField( + model_name='itemrelation', + name='issue_thread', + field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='item_relation_changes', to='tickets.issuethread'), + ), + migrations.AlterField( + model_name='itemrelation', + name='item', + field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='issue_relation_changes', to='inventory.item'), + ), + ] diff --git a/core/tickets/models.py b/core/tickets/models.py index db427fe..2c14687 100644 --- a/core/tickets/models.py +++ b/core/tickets/models.py @@ -1,5 +1,7 @@ -from django.db import models +from itertools import groupby + from django.utils import timezone +from django.db import models from django_softdelete.models import SoftDeleteModel from authentication.models import ExtendedUser @@ -43,7 +45,6 @@ class IssueThread(SoftDeleteModel): name = models.CharField(max_length=255) event = models.ForeignKey(Event, null=True, on_delete=models.SET_NULL, related_name='issue_threads') manually_created = models.BooleanField(default=False) - related_items = models.ManyToManyField(Item, through='ItemRelation') def short_uuid(self): return self.uuid[:8] @@ -60,6 +61,8 @@ class IssueThread(SoftDeleteModel): if self.state == value: return self.state_changes.create(state=value) + if value == 'closed_spam' and self.emails.exists(): + self.emails.first().train_spam() @property def assigned_to(self): @@ -74,6 +77,11 @@ class IssueThread(SoftDeleteModel): return self.assignments.create(assigned_to=value) + @property + def related_items(self): + groups = groupby(self.item_relation_changes.all(), lambda rel: rel.item.id) + return [sorted(v, key=lambda r: r.timestamp)[0].item for k, v in groups] + def __str__(self): return '[' + str(self.id) + '][' + self.short_uuid() + '] ' + self.name @@ -130,8 +138,8 @@ class Assignment(models.Model): class ItemRelation(models.Model): id = models.AutoField(primary_key=True) - issue_thread = models.ForeignKey(IssueThread, on_delete=models.CASCADE, related_name='item_relations') - item = models.ForeignKey(Item, on_delete=models.CASCADE, related_name='issues') + issue_thread = models.ForeignKey(IssueThread, on_delete=models.CASCADE, related_name='item_relation_changes') + item = models.ForeignKey(Item, on_delete=models.CASCADE, related_name='issue_relation_changes') timestamp = models.DateTimeField(auto_now_add=True) status = models.CharField(max_length=255, choices=RELATION_STATUS_CHOICES, default='possible') diff --git a/core/tickets/serializers.py b/core/tickets/serializers.py index a980b97..aae37ba 100644 --- a/core/tickets/serializers.py +++ b/core/tickets/serializers.py @@ -1,9 +1,11 @@ from rest_framework import serializers from authentication.models import ExtendedUser +from inventory.models import Event +from inventory.shared_serializers import BasicItemSerializer from mail.api_v2 import AttachmentSerializer from tickets.models import IssueThread, Comment, STATE_CHOICES, ShippingVoucher -from inventory.serializers import ItemSerializer +from tickets.shared_serializers import BasicIssueSerializer class CommentSerializer(serializers.ModelSerializer): @@ -36,24 +38,20 @@ class ShippingVoucherSerializer(serializers.ModelSerializer): read_only_fields = ('id', 'timestamp', 'used_at') -class IssueSerializer(serializers.ModelSerializer): +class IssueSerializer(BasicIssueSerializer): timeline = serializers.SerializerMethodField() last_activity = serializers.SerializerMethodField() - assigned_to = serializers.SlugRelatedField(slug_field='username', queryset=ExtendedUser.objects.all(), - allow_null=True, required=False) - related_items = ItemSerializer(many=True, read_only=True) + related_items = BasicItemSerializer(many=True, read_only=True) class Meta: model = IssueThread - fields = ('id', 'timeline', 'name', 'state', 'assigned_to', 'last_activity', 'uuid', 'related_items') + fields = ('id', 'timeline', 'name', 'state', 'assigned_to', 'last_activity', 'uuid', 'related_items', 'event') read_only_fields = ('id', 'timeline', 'last_activity', 'uuid', 'related_items') def to_internal_value(self, data): ret = super().to_internal_value(data) if 'state' in data: ret['state'] = data['state'] -# if 'assigned_to' in data: -# ret['assigned_to'] = data['assigned_to'] return ret def validate(self, attrs): @@ -71,8 +69,8 @@ class IssueSerializer(serializers.ModelSerializer): last_mail = self.emails.order_by('-timestamp').first().timestamp if self.emails.count() > 0 else None last_assignment = self.assignments.order_by('-timestamp').first().timestamp if \ self.assignments.count() > 0 else None - last_relation = self.item_relations.order_by('-timestamp').first().timestamp if \ - self.item_relations.count() > 0 else None + last_relation = self.item_relation_changes.order_by('-timestamp').first().timestamp if \ + self.item_relation_changes.count() > 0 else None args = [x for x in [last_state_change, last_comment, last_mail, last_assignment, last_relation] if x is not None] return max(args) @@ -114,13 +112,13 @@ class IssueSerializer(serializers.ModelSerializer): 'timestamp': assignment.timestamp, 'assigned_to': assignment.assigned_to.username, }) - for relation in obj.item_relations.all(): + for relation in (obj.item_relation_changes.all()): timeline.append({ 'type': 'item_relation', 'id': relation.id, 'status': relation.status, 'timestamp': relation.timestamp, - 'item': ItemSerializer(relation.item).data, + 'item': BasicItemSerializer(relation.item).data, }) for shipping_voucher in obj.shipping_vouchers.all(): timeline.append({ @@ -132,5 +130,14 @@ class IssueSerializer(serializers.ModelSerializer): }) return sorted(timeline, key=lambda x: x['timestamp']) - def get_queryset(self): - return IssueThread.objects.all().order_by('-last_activity') + + +class SearchResultSerializer(serializers.Serializer): + search_score = serializers.IntegerField() + item = IssueSerializer() + + def to_representation(self, instance): + return {**IssueSerializer(instance['item']).data, 'search_score': instance['search_score']} + + class Meta: + model = IssueThread diff --git a/core/tickets/shared_serializers.py b/core/tickets/shared_serializers.py new file mode 100644 index 0000000..ac16d81 --- /dev/null +++ b/core/tickets/shared_serializers.py @@ -0,0 +1,23 @@ +from rest_framework import serializers + +from authentication.models import ExtendedUser +from inventory.models import Event +from tickets.models import IssueThread, ItemRelation + + +class RelationSerializer(serializers.ModelSerializer): + class Meta: + model = ItemRelation + fields = ('id', 'status', 'timestamp', 'item', 'issue_thread') + + +class BasicIssueSerializer(serializers.ModelSerializer): + assigned_to = serializers.SlugRelatedField(slug_field='username', queryset=ExtendedUser.objects.all(), + allow_null=True, required=False) + event = serializers.SlugRelatedField(slug_field='slug', queryset=Event.objects.all(), + allow_null=True, required=False) + + class Meta: + model = IssueThread + fields = ('id', 'name', 'state', 'assigned_to', 'uuid', 'event') + read_only_fields = ('id', 'timeline', 'last_activity', 'uuid', 'related_items') diff --git a/core/tickets/tests/v2/test_matches.py b/core/tickets/tests/v2/test_matches.py new file mode 100644 index 0000000..7bd7a52 --- /dev/null +++ b/core/tickets/tests/v2/test_matches.py @@ -0,0 +1,149 @@ +from datetime import datetime, timedelta + +from django.test import TestCase, Client + +from authentication.models import ExtendedUser +from inventory.models import Event, Container, Item +from mail.models import Email, EmailAttachment +from tickets.models import IssueThread, StateChange, Comment, ItemRelation +from django.contrib.auth.models import Permission +from knox.models import AuthToken + +from base64 import b64encode + + +class IssueItemMatchApiTest(TestCase): + + def setUp(self): + super().setUp() + self.user = ExtendedUser.objects.create_user('testuser', 'test', 'test') + self.user.user_permissions.add(*Permission.objects.all()) + self.user.save() + self.event = Event.objects.create(slug='evt') + self.box = Container.objects.create(name='box1') + self.item = Item.objects.create(container=self.box, description="foo", event=self.event) + self.token = AuthToken.objects.create(user=self.user) + self.client = Client(headers={'Authorization': 'Token ' + self.token[1]}) + now = datetime.now() + self.issue = IssueThread.objects.create( + name="test issue", + event=self.event, + ) + self.mail1 = Email.objects.create( + subject='test', + body='test', + sender='test', + recipient='test', + issue_thread=self.issue, + timestamp=now, + ) + self.comment = Comment.objects.create( + issue_thread=self.issue, + comment="test", + timestamp=now + timedelta(seconds=3), + ) + self.match = ItemRelation.objects.create( + issue_thread=self.issue, + item=self.item, + timestamp=now + timedelta(seconds=5), + ) + + def test_issues(self): + response = self.client.get('/api/2/tickets/') + self.assertEqual(response.status_code, 200) + self.assertEqual(len(response.json()), 1) + self.assertEqual(response.json()[0]['id'], self.issue.id) + self.assertEqual(response.json()[0]['name'], "test issue") + self.assertEqual(response.json()[0]['state'], "pending_new") + self.assertEqual(response.json()[0]['event'], "evt") + self.assertEqual(response.json()[0]['assigned_to'], None) + self.assertEqual(response.json()[0]['uuid'], self.issue.uuid) + self.assertEqual(response.json()[0]['last_activity'], self.match.timestamp.strftime('%Y-%m-%dT%H:%M:%S.%fZ')) + self.assertEqual(len(response.json()[0]['timeline']), 4) + self.assertEqual(response.json()[0]['timeline'][0]['type'], 'state') + self.assertEqual(response.json()[0]['timeline'][1]['type'], 'mail') + self.assertEqual(response.json()[0]['timeline'][2]['type'], 'comment') + self.assertEqual(response.json()[0]['timeline'][1]['id'], self.mail1.id) + self.assertEqual(response.json()[0]['timeline'][2]['id'], self.comment.id) + self.assertEqual(response.json()[0]['timeline'][0]['state'], 'pending_new') + self.assertEqual(response.json()[0]['timeline'][1]['sender'], 'test') + self.assertEqual(response.json()[0]['timeline'][1]['recipient'], 'test') + self.assertEqual(response.json()[0]['timeline'][1]['subject'], 'test') + self.assertEqual(response.json()[0]['timeline'][1]['body'], 'test') + self.assertEqual(response.json()[0]['timeline'][1]['timestamp'], + self.mail1.timestamp.strftime('%Y-%m-%dT%H:%M:%S.%fZ')) + self.assertEqual(response.json()[0]['timeline'][2]['comment'], 'test') + self.assertEqual(response.json()[0]['timeline'][2]['timestamp'], + self.comment.timestamp.strftime('%Y-%m-%dT%H:%M:%S.%fZ')) + self.assertEqual(response.json()[0]['timeline'][3]['status'], 'possible') + self.assertEqual(response.json()[0]['timeline'][3]['timestamp'], + self.match.timestamp.strftime('%Y-%m-%dT%H:%M:%S.%fZ')) + self.assertEqual(response.json()[0]['timeline'][3]['item']['description'], "foo") + self.assertEqual(response.json()[0]['timeline'][3]['item']['event'], "evt") + self.assertEqual(response.json()[0]['timeline'][3]['item']['box'], "box1") + self.assertEqual(response.json()[0]['related_items'][0]['description'], "foo") + self.assertEqual(response.json()[0]['related_items'][0]['event'], "evt") + self.assertEqual(response.json()[0]['related_items'][0]['box'], "box1") + + def test_members(self): + response = self.client.get(f'/api/2/{self.event.slug}/item/') + self.assertEqual(response.status_code, 200) + self.assertEqual(len(response.json()), 1) + self.assertEqual(response.json()[0]['id'], self.item.id) + self.assertEqual(response.json()[0]['description'], 'foo') + self.assertEqual(response.json()[0]['box'], 'box1') + self.assertEqual(response.json()[0]['cid'], self.box.id) + self.assertEqual(response.json()[0]['file'], None) + self.assertEqual(response.json()[0]['returned'], False) + self.assertEqual(response.json()[0]['event'], self.event.slug) + self.assertEqual(len(response.json()[0]['related_issues']), 1) + self.assertEqual(response.json()[0]['related_issues'][0]['id'], self.issue.id) + self.assertEqual(response.json()[0]['related_issues'][0]['name'], "test issue") + + def test_add_match(self): + response = self.client.get('/api/2/matches/') + self.assertEqual(1, len(response.json())) + item = Item.objects.create(container=self.box, event=self.event, description='1') + issue = IssueThread.objects.create(name="test issue", event=self.event) + + response = self.client.post(f'/api/2/matches/', + {'item': item.id, 'issue_thread': issue.id}, + content_type='application/json') + self.assertEqual(response.status_code, 201) + + response = self.client.get('/api/2/matches/') + self.assertEqual(2, len(response.json())) + + response = self.client.get('/api/2/tickets/') + self.assertEqual(4, len(response.json()[0]['timeline'])) + self.assertEqual('item_relation', response.json()[0]['timeline'][3]['type']) + self.assertEqual('possible', response.json()[0]['timeline'][3]['status']) + self.assertEqual(1, len(response.json()[0]['related_items'])) + + def test_change_match_state(self): + response = self.client.get('/api/2/matches/') + self.assertEqual(1, len(response.json())) + + response = self.client.get('/api/2/tickets/') + self.assertEqual(4, len(response.json()[0]['timeline'])) + self.assertEqual('item_relation', response.json()[0]['timeline'][3]['type']) + self.assertEqual('possible', response.json()[0]['timeline'][3]['status']) + self.assertEqual(1, len(response.json()[0]['related_items'])) + + response = self.client.post(f'/api/2/matches/', + {'item': self.item.id, 'issue_thread': self.issue.id, 'status': 'confirmed'}, + content_type='application/json') + self.assertEqual(response.status_code, 201) + self.assertEqual(response.json()['status'], 'confirmed') + self.assertEqual(response.json()['id'], 2) + + response = self.client.get('/api/2/matches/') + self.assertEqual(2, len(response.json())) + + response = self.client.get('/api/2/tickets/') + self.assertEqual(5, len(response.json()[0]['timeline'])) + self.assertEqual('item_relation', response.json()[0]['timeline'][3]['type']) + self.assertEqual('possible', response.json()[0]['timeline'][3]['status']) + self.assertEqual('item_relation', response.json()[0]['timeline'][4]['type']) + self.assertEqual('confirmed', response.json()[0]['timeline'][4]['status']) + self.assertEqual(1, len(response.json()[0]['related_items'])) diff --git a/core/tickets/tests/v2/test_tickets.py b/core/tickets/tests/v2/test_tickets.py index 8223506..105de93 100644 --- a/core/tickets/tests/v2/test_tickets.py +++ b/core/tickets/tests/v2/test_tickets.py @@ -3,11 +3,14 @@ from datetime import datetime, timedelta from django.test import TestCase, Client from authentication.models import ExtendedUser +from inventory.models import Event, Container, Item from mail.models import Email, EmailAttachment -from tickets.models import IssueThread, StateChange, Comment +from tickets.models import IssueThread, StateChange, Comment, ItemRelation from django.contrib.auth.models import Permission from knox.models import AuthToken +from base64 import b64encode + class IssueApiTest(TestCase): @@ -16,6 +19,9 @@ class IssueApiTest(TestCase): self.user = ExtendedUser.objects.create_user('testuser', 'test', 'test') self.user.user_permissions.add(*Permission.objects.all()) self.user.save() + self.event = Event.objects.create(slug='evt') + self.box = Container.objects.create(name='box1') + self.item = Item.objects.create(container=self.box, description="foo", event=self.event) self.token = AuthToken.objects.create(user=self.user) self.client = Client(headers={'Authorization': 'Token ' + self.token[1]}) @@ -28,6 +34,7 @@ class IssueApiTest(TestCase): now = datetime.now() issue = IssueThread.objects.create( name="test issue", + event=self.event, ) mail1 = Email.objects.create( subject='test', @@ -51,6 +58,11 @@ class IssueApiTest(TestCase): comment="test", timestamp=now + timedelta(seconds=3), ) + match = ItemRelation.objects.create( + issue_thread=issue, + item = self.item, + timestamp=now + timedelta(seconds=5), + ) self.assertEqual('pending_new', issue.state) self.assertEqual('test issue', issue.name) self.assertEqual(None, issue.assigned_to) @@ -61,10 +73,11 @@ class IssueApiTest(TestCase): self.assertEqual(response.json()[0]['id'], issue.id) self.assertEqual(response.json()[0]['name'], "test issue") self.assertEqual(response.json()[0]['state'], "pending_new") + self.assertEqual(response.json()[0]['event'], "evt") self.assertEqual(response.json()[0]['assigned_to'], None) self.assertEqual(response.json()[0]['uuid'], issue.uuid) - self.assertEqual(response.json()[0]['last_activity'], comment.timestamp.strftime('%Y-%m-%dT%H:%M:%S.%fZ')) - self.assertEqual(len(response.json()[0]['timeline']), 4) + self.assertEqual(response.json()[0]['last_activity'], match.timestamp.strftime('%Y-%m-%dT%H:%M:%S.%fZ')) + self.assertEqual(len(response.json()[0]['timeline']), 5) self.assertEqual(response.json()[0]['timeline'][0]['type'], 'state') self.assertEqual(response.json()[0]['timeline'][1]['type'], 'mail') self.assertEqual(response.json()[0]['timeline'][2]['type'], 'mail') @@ -88,17 +101,29 @@ class IssueApiTest(TestCase): self.assertEqual(response.json()[0]['timeline'][3]['comment'], 'test') self.assertEqual(response.json()[0]['timeline'][3]['timestamp'], comment.timestamp.strftime('%Y-%m-%dT%H:%M:%S.%fZ')) + self.assertEqual(response.json()[0]['timeline'][4]['status'], 'possible') + self.assertEqual(response.json()[0]['timeline'][4]['timestamp'], + match.timestamp.strftime('%Y-%m-%dT%H:%M:%S.%fZ')) + self.assertEqual(response.json()[0]['timeline'][4]['item']['description'], "foo") + self.assertEqual(response.json()[0]['timeline'][4]['item']['event'], "evt") + self.assertEqual(response.json()[0]['timeline'][4]['item']['box'], "box1") + self.assertEqual(response.json()[0]['related_items'][0]['description'], "foo") + self.assertEqual(response.json()[0]['related_items'][0]['event'], "evt") + self.assertEqual(response.json()[0]['related_items'][0]['box'], "box1") def test_issues_incomplete_timeline(self): now = datetime.now() issue1 = IssueThread.objects.create( name="test issue", + event=self.event, ) issue2 = IssueThread.objects.create( name="test issue", + event=self.event, ) issue3 = IssueThread.objects.create( name="test issue", + event=self.event, ) mail1 = Email.objects.create( subject='test', @@ -118,8 +143,11 @@ class IssueApiTest(TestCase): self.assertEqual(200, response.status_code) self.assertEqual(3, len(response.json())) self.assertEqual(issue1.id, response.json()[0]['id']) + self.assertEqual("evt", response.json()[0]['event']) self.assertEqual(issue2.id, response.json()[1]['id']) + self.assertEqual("evt", response.json()[1]['event']) self.assertEqual(issue3.id, response.json()[2]['id']) + self.assertEqual("evt", response.json()[2]['event']) self.assertEqual(issue1.state_changes.first().timestamp.strftime('%Y-%m-%dT%H:%M:%S.%fZ'), response.json()[0]['last_activity']) self.assertEqual(mail1.timestamp.strftime('%Y-%m-%dT%H:%M:%S.%fZ'), @@ -153,6 +181,7 @@ class IssueApiTest(TestCase): now = datetime.now() issue = IssueThread.objects.create( name="test issue", + event=self.event, ) mail1 = Email.objects.create( subject='test', @@ -189,6 +218,7 @@ class IssueApiTest(TestCase): self.assertEqual(200, response.status_code) self.assertEqual(1, len(response.json())) self.assertEqual(issue.id, response.json()[0]['id']) + self.assertEqual("evt", response.json()[0]['event']) self.assertEqual('pending_new', response.json()[0]['state']) self.assertEqual('test issue', response.json()[0]['name']) self.assertEqual(None, response.json()[0]['assigned_to']) @@ -230,13 +260,14 @@ class IssueApiTest(TestCase): self.assertEqual(file2.hash, response.json()[0]['timeline'][1]['attachments'][1]['hash']) def test_manual_creation(self): - response = self.client.post('/api/2/tickets/manual/', + response = self.client.post('/api/2/evt/tickets/manual/', {'name': 'test issue', 'sender': 'test', 'recipient': 'test', 'body': 'test'}, content_type='application/json') self.assertEqual(response.status_code, 201) self.assertEqual(response.json()['state'], 'pending_new') self.assertEqual(response.json()['name'], 'test issue') self.assertEqual(response.json()['assigned_to'], None) + self.assertEqual("evt", response.json()['event']) timeline = response.json()['timeline'] self.assertEqual(len(timeline), 2) self.assertEqual(timeline[0]['type'], 'state') @@ -247,9 +278,35 @@ class IssueApiTest(TestCase): self.assertEqual(timeline[1]['subject'], 'test issue') self.assertEqual(timeline[1]['body'], 'test') + def test_manual_creation_none(self): + response = self.client.post('/api/2/none/tickets/manual/', + {'name': 'test issue', 'sender': 'test', 'recipient': 'test', 'body': 'test'}, + content_type='application/json') + self.assertEqual(response.status_code, 201) + self.assertEqual(response.json()['state'], 'pending_new') + self.assertEqual(response.json()['name'], 'test issue') + self.assertEqual(response.json()['assigned_to'], None) + self.assertEqual(None, response.json()['event']) + timeline = response.json()['timeline'] + self.assertEqual(len(timeline), 2) + self.assertEqual(timeline[0]['type'], 'state') + self.assertEqual(timeline[0]['state'], 'pending_new') + self.assertEqual(timeline[1]['type'], 'mail') + self.assertEqual(timeline[1]['sender'], 'test') + self.assertEqual(timeline[1]['recipient'], 'test') + self.assertEqual(timeline[1]['subject'], 'test issue') + self.assertEqual(timeline[1]['body'], 'test') + + def test_manual_creation_invalid(self): + response = self.client.post('/api/2/foobar/tickets/manual/', + {'name': 'test issue', 'sender': 'test', 'recipient': 'test', 'body': 'test'}, + content_type='application/json') + self.assertEqual(response.status_code, 400) + def test_post_comment_altenative(self): issue = IssueThread.objects.create( name="test issue", + event=self.event, ) response = self.client.post(f'/api/2/tickets/{issue.id}/comment/', {'comment': 'test'}) self.assertEqual(response.status_code, 201) @@ -260,6 +317,7 @@ class IssueApiTest(TestCase): def test_post_alt_comment_empty(self): issue = IssueThread.objects.create( name="test issue", + event=self.event, ) response = self.client.post(f'/api/2/tickets/{issue.id}/comment/', {'comment': ''}) self.assertEqual(response.status_code, 400) @@ -267,6 +325,7 @@ class IssueApiTest(TestCase): def test_state_change(self): issue = IssueThread.objects.create( name="test issue", + event=self.event, ) response = self.client.patch(f'/api/2/tickets/{issue.id}/', {'state': 'pending_open'}, content_type='application/json') @@ -284,6 +343,7 @@ class IssueApiTest(TestCase): def test_state_change_invalid_state(self): issue = IssueThread.objects.create( name="test issue", + event=self.event, ) response = self.client.patch(f'/api/2/tickets/{issue.id}/', {'state': 'invalid'}, content_type='application/json') @@ -292,12 +352,14 @@ class IssueApiTest(TestCase): def test_assign_user(self): issue = IssueThread.objects.create( name="test issue", + event=self.event, ) response = self.client.patch(f'/api/2/tickets/{issue.id}/', {'assigned_to': self.user.username}, content_type='application/json') self.assertEqual(200, response.status_code) self.assertEqual('pending_new', response.json()['state']) self.assertEqual('test issue', response.json()['name']) + self.assertEqual("evt", response.json()['event']) self.assertEqual(self.user.username, response.json()['assigned_to']) timeline = response.json()['timeline'] self.assertEqual(2, len(timeline)) @@ -305,3 +367,21 @@ class IssueApiTest(TestCase): self.assertEqual('pending_new', timeline[0]['state']) self.assertEqual('assignment', timeline[1]['type']) self.assertEqual(self.user.username, timeline[1]['assigned_to']) + + +class IssueSearchTest(TestCase): + + def setUp(self): + super().setUp() + self.event = Event.objects.create(slug='EVENT', name='Event') + self.user = ExtendedUser.objects.create_user('testuser', 'test', 'test') + self.user.user_permissions.add(*Permission.objects.all()) + self.user.save() + self.token = AuthToken.objects.create(user=self.user) + self.client = Client(headers={'Authorization': 'Token ' + self.token[1]}) + + def test_search(self): + search_query = b64encode(b'abc').decode('utf-8') + response = self.client.get(f'/api/2/{self.event.slug}/tickets/{search_query}/') + self.assertEqual(200, response.status_code) + self.assertEqual([], response.json()) diff --git a/deploy/ansible/inventory.yml.sample b/deploy/ansible/inventory.yml.sample index 6ba14ac..2a50efd 100644 --- a/deploy/ansible/inventory.yml.sample +++ b/deploy/ansible/inventory.yml.sample @@ -11,4 +11,6 @@ c3lf-nodes: mail_domain: main_email: legacy_api_user: - legacy_api_password: \ No newline at end of file + legacy_api_password: + debug_mode_active: false + django_secret_key: 'django-insecure-tm*$w_14iqbiy-!7(8#ba7j+_@(7@rf2&a^!=shs&$03b%2*rv' \ No newline at end of file diff --git a/deploy/ansible/playbooks/templates/django.env.j2 b/deploy/ansible/playbooks/templates/django.env.j2 index 72a0c30..c9b1c83 100644 --- a/deploy/ansible/playbooks/templates/django.env.j2 +++ b/deploy/ansible/playbooks/templates/django.env.j2 @@ -1,3 +1,4 @@ +REDIS_HOST=localhost DB_HOST=localhost DB_PORT=3306 DB_NAME=c3lf_sys3 @@ -9,3 +10,6 @@ LEGACY_API_USER={{ legacy_api_user }} LEGACY_API_PASSWORD={{ legacy_api_password }} MEDIA_ROOT=/var/www/c3lf-sys3/userfiles STATIC_ROOT=/var/www/c3lf-sys3/staticfiles +ACTIVE_SPAM_TRAINING=True +DEBUG_MODE_ACTIVE={{ debug_mode_active }} +DJANGO_SECRET_KEY={{ django_secret_key }} diff --git a/deploy/ansible/playbooks/templates/nginx.conf.j2 b/deploy/ansible/playbooks/templates/nginx.conf.j2 index 608ffd5..3533f37 100644 --- a/deploy/ansible/playbooks/templates/nginx.conf.j2 +++ b/deploy/ansible/playbooks/templates/nginx.conf.j2 @@ -70,6 +70,13 @@ server { alias /var/www/c3lf-sys3/staticfiles/; } + location /metrics { + allow 95.156.226.90; + allow 127.0.0.1; + allow ::1; + deny all; + } + listen 443 ssl http2; # managed by Certbot ssl_certificate /etc/letsencrypt/live/{{ web_domain }}/fullchain.pem; # managed by Certbot ssl_certificate_key /etc/letsencrypt/live/{{ web_domain }}/privkey.pem; # managed by Certbot diff --git a/deploy/dev/docker-compose.yml b/deploy/dev/docker-compose.yml index 95e8083..dff5ab3 100644 --- a/deploy/dev/docker-compose.yml +++ b/deploy/dev/docker-compose.yml @@ -6,11 +6,17 @@ services: command: bash -c 'python manage.py migrate && python manage.py runserver 0.0.0.0:8000' environment: - HTTP_HOST=core - #- DATABASE_URL + - DB_HOST=db + - DB_PORT=3306 + - DB_NAME=system3 + - DB_USER=system3 + - DB_PASSWORD=system3 volumes: - ../../core:/code ports: - "8000:8000" + depends_on: + - db frontend: build: @@ -23,6 +29,8 @@ services: - ./vue.config.js:/web/vue.config.js ports: - "8080:8080" + depends_on: + - core db: image: mariadb @@ -30,4 +38,11 @@ services: MARIADB_RANDOM_ROOT_PASSWORD: true MARIADB_DATABASE: system3 MARIADB_USER: system3 - MARIADB_PASSWORD: system3 \ No newline at end of file + MARIADB_PASSWORD: system3 + volumes: + - mariadb_data:/var/lib/mysql + ports: + - "3306:3306" + +volumes: + mariadb_data: \ No newline at end of file diff --git a/deploy/testing/Dockerfile.backend b/deploy/testing/Dockerfile.backend new file mode 100644 index 0000000..c968994 --- /dev/null +++ b/deploy/testing/Dockerfile.backend @@ -0,0 +1,11 @@ +FROM python:3.11-bookworm +LABEL authors="lagertonne" + +ENV PYTHONUNBUFFERED 1 +RUN mkdir /code +WORKDIR /code +COPY requirements.prod.txt /code/ +RUN apt update && apt install -y mariadb-client +RUN pip install -r requirements.prod.txt +RUN pip install mysqlclient +COPY .. /code/ \ No newline at end of file diff --git a/deploy/testing/Dockerfile.frontend b/deploy/testing/Dockerfile.frontend new file mode 100644 index 0000000..0a41d1a --- /dev/null +++ b/deploy/testing/Dockerfile.frontend @@ -0,0 +1,6 @@ +FROM docker.io/node:22 + +RUN mkdir /web +WORKDIR /web +COPY package.json /web/ +RUN npm install diff --git a/deploy/testing/docker-compose.yml b/deploy/testing/docker-compose.yml new file mode 100644 index 0000000..e93e901 --- /dev/null +++ b/deploy/testing/docker-compose.yml @@ -0,0 +1,55 @@ +services: + redis: + image: redis + ports: + - "6379:6379" + + db: + image: mariadb + environment: + MARIADB_RANDOM_ROOT_PASSWORD: true + MARIADB_DATABASE: system3 + MARIADB_USER: system3 + MARIADB_PASSWORD: system3 + volumes: + - mariadb_data:/var/lib/mysql + ports: + - "3306:3306" + + core: + build: + context: ../../core + dockerfile: ../deploy/testing/Dockerfile.backend + command: bash -c 'python manage.py migrate && python /code/server.py' + environment: + - HTTP_HOST=core + - REDIS_HOST=redis + - DB_HOST=db + - DB_PORT=3306 + - DB_NAME=system3 + - DB_USER=system3 + - DB_PASSWORD=system3 + volumes: + - ../../core:/code + ports: + - "8000:8000" + depends_on: + - db + - redis + + frontend: + build: + context: ../../web + dockerfile: ../deploy/testing/Dockerfile.frontend + command: npm run serve + volumes: + - ../../web:/web:ro + - /web/node_modules + - ./vue.config.js:/web/vue.config.js + ports: + - "8080:8080" + depends_on: + - core + +volumes: + mariadb_data: \ No newline at end of file diff --git a/deploy/testing/vue.config.js b/deploy/testing/vue.config.js new file mode 100644 index 0000000..f8f3c26 --- /dev/null +++ b/deploy/testing/vue.config.js @@ -0,0 +1,27 @@ +// vue.config.js + +module.exports = { + devServer: { + headers: { + "Access-Control-Allow-Origin": "*", + "Access-Control-Allow-Headers": "*", + "Access-Control-Allow-Methods": "*" + }, + proxy: { + '^/media/2': { + target: 'http://core:8000/', + }, + '^/api/2': { + target: 'http://core:8000/', + }, + '^/api/1': { + target: 'http://core:8000/', + }, + '^/ws/2': { + target: 'http://core:8000/', + ws: true, + logLevel: 'debug', + }, + } + } +} \ No newline at end of file diff --git a/web/src/components/Navbar.vue b/web/src/components/Navbar.vue index 686f324..ccfb0f0 100644 --- a/web/src/components/Navbar.vue +++ b/web/src/components/Navbar.vue @@ -6,7 +6,8 @@ {{ getEventSlug }}
- {{ event.slug }}
@@ -48,12 +49,12 @@ @@ -64,19 +65,6 @@