diff --git a/core/.coveragerc b/core/.coveragerc new file mode 100644 index 0000000..14c1fba --- /dev/null +++ b/core/.coveragerc @@ -0,0 +1,14 @@ +[run] +source = . + +[report] +fail_under = 100 +show_missing = True +skip_covered = True +omit = + */tests/* + */migrations/* + core/asgi.py + core/wsgi.py + core/settings.py + manage.py \ No newline at end of file diff --git a/core/core/settings.py b/core/core/settings.py index db23180..518f425 100644 --- a/core/core/settings.py +++ b/core/core/settings.py @@ -50,6 +50,7 @@ INSTALLED_APPS = [ 'django.contrib.messages', 'django.contrib.staticfiles', 'django_extensions', + 'django_prometheus', 'rest_framework', 'knox', 'drf_yasg', @@ -85,6 +86,7 @@ SWAGGER_SETTINGS = { } MIDDLEWARE = [ + 'django_prometheus.middleware.PrometheusBeforeMiddleware', 'django.middleware.security.SecurityMiddleware', 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', @@ -92,6 +94,7 @@ MIDDLEWARE = [ 'django.contrib.auth.middleware.AuthenticationMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', + 'django_prometheus.middleware.PrometheusAfterMiddleware', ] ROOT_URLCONF = 'core.urls' @@ -204,10 +207,14 @@ CHANNEL_LAYERS = { 'default': { 'BACKEND': 'channels_redis.core.RedisChannelLayer', 'CONFIG': { - 'hosts': [('localhost', 6379)], + 'hosts': [(os.getenv('REDIS_HOST', 'localhost'), 6379)], }, } - } +SMTP_GATEWAY_HOST = os.getenv('SMTP_GATEWAY_HOST', 'localhost') +SMTP_GATEWAY_PORT = int(os.getenv('SMTP_GATEWAY_PORT', '25')) + +PROMETHEUS_METRIC_NAMESPACE = 'c3lf' + TEST_RUNNER = 'core.test_runner.FastTestRunner' diff --git a/core/core/urls.py b/core/core/urls.py index b0161bb..df6e0d0 100644 --- a/core/core/urls.py +++ b/core/core/urls.py @@ -32,4 +32,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/inventory/serializers.py b/core/inventory/serializers.py index fd39c3a..5a26623 100644 --- a/core/inventory/serializers.py +++ b/core/inventory/serializers.py @@ -3,12 +3,21 @@ from rest_framework import serializers from files.models import File from inventory.models import Event, Container, Item +from mail.models import EventAddress + + +class EventAdressSerializer(serializers.ModelSerializer): + class Meta: + model = EventAddress + fields = ['address'] class EventSerializer(serializers.ModelSerializer): + addresses = EventAdressSerializer(many=True, required=False) + class Meta: model = Event - fields = ['eid', 'slug', 'name', 'start', 'end', 'pre_start', 'post_end'] + fields = ['eid', 'slug', 'name', 'start', 'end', 'pre_start', 'post_end', 'addresses'] read_only_fields = ['eid'] diff --git a/core/inventory/tests/v2/test_events.py b/core/inventory/tests/v2/test_events.py index 7973313..affbd0e 100644 --- a/core/inventory/tests/v2/test_events.py +++ b/core/inventory/tests/v2/test_events.py @@ -54,3 +54,15 @@ class EventTestCase(TestCase): response = client.delete(f'/api/2/events/{event.eid}/') self.assertEqual(response.status_code, 204) self.assertEqual(len(Event.objects.all()), 1) + + def test_items2(self): + from mail.models import EventAddress + event1 = Event.objects.create(slug='TEST1', name='Event') + EventAddress.objects.create(event=Event.objects.get(slug='TEST1'), address='foo@bar.baz') + response = self.client.get('/api/2/events/') + self.assertEqual(response.status_code, 200) + self.assertEqual(1, len(response.json())) + self.assertEqual('TEST1', response.json()[0]['slug']) + self.assertEqual('Event', response.json()[0]['name']) + self.assertEqual(1, len(response.json()[0]['addresses'])) + diff --git a/core/mail/migrations/0005_alter_eventaddress_event.py b/core/mail/migrations/0005_alter_eventaddress_event.py new file mode 100644 index 0000000..30b79bf --- /dev/null +++ b/core/mail/migrations/0005_alter_eventaddress_event.py @@ -0,0 +1,20 @@ +# Generated by Django 4.2.7 on 2024-11-03 18:30 + +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'), + ('mail', '0004_alter_emailattachment_file'), + ] + + operations = [ + migrations.AlterField( + model_name='eventaddress', + name='event', + field=models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='addresses', to='inventory.event'), + ), + ] diff --git a/core/mail/models.py b/core/mail/models.py index 4bd0973..378854b 100644 --- a/core/mail/models.py +++ b/core/mail/models.py @@ -31,7 +31,7 @@ class Email(SoftDeleteModel): class EventAddress(models.Model): id = models.AutoField(primary_key=True) - event = models.ForeignKey(Event, models.SET_NULL, null=True) + event = models.ForeignKey(Event, models.SET_NULL, null=True, related_name='addresses') address = models.CharField(max_length=255) diff --git a/core/mail/protocol.py b/core/mail/protocol.py index cfd25ce..635766b 100644 --- a/core/mail/protocol.py +++ b/core/mail/protocol.py @@ -1,4 +1,5 @@ import logging +from re import match import aiosmtplib from channels.layers import get_channel_layer @@ -9,6 +10,12 @@ from mail.models import Email, EventAddress, EmailAttachment from notify_sessions.models import SystemEvent from tickets.models import IssueThread +from core.settings import SMTP_GATEWAY_HOST, SMTP_GATEWAY_PORT + + +class SpecialMailException(Exception): + pass + def find_quoted_printable(s, marker): positions = [i for i in range(len(s)) if s.lower().startswith('=?utf-8?' + marker + '?', i)] @@ -83,7 +90,7 @@ def make_reply(reply_email, references=None, event=None): async def send_smtp(message): - await aiosmtplib.send(message, hostname="127.0.0.1", port=25, use_tls=False, start_tls=False) + await aiosmtplib.send(message, hostname=SMTP_GATEWAY_HOST, port=SMTP_GATEWAY_PORT, use_tls=False, start_tls=False) def find_active_issue_thread(in_reply_to, address, subject): @@ -180,13 +187,13 @@ def receive_email(envelope, log=None): header_in_reply_to = parsed.get('In-Reply-To') header_message_id = parsed.get('Message-ID') - if header_from != envelope.mail_from: - log.warning("Header from does not match envelope from") - log.info(f"Header from: {header_from}, envelope from: {envelope.mail_from}") + if match(r'^([a-zA-Z ]*<)?MAILER-DAEMON@', header_from) and envelope.mail_from.strip("<>") == "": + log.warning("Ignoring mailer daemon") + raise SpecialMailException("Ignoring mailer daemon") - if header_to != envelope.rcpt_tos[0]: - log.warning("Header to does not match envelope to") - log.info(f"Header to: {header_to}, envelope to: {envelope.rcpt_tos[0]}") + if Email.objects.filter(reference=header_message_id).exists(): # break before issue thread is created + log.warning("Email already exists") + raise Exception("Email already exists") recipient = envelope.rcpt_tos[0].lower() if envelope.rcpt_tos else header_to.lower() sender = envelope.mail_from if envelope.mail_from else header_from @@ -233,7 +240,7 @@ Your c3lf (Cloakroom + Lost&Found) Team'''.format(active_issue_thread.short_uuid active_issue_thread.state = 'pending_open' active_issue_thread.save() - return email, new, reply + return email, new, reply, active_issue_thread class LMTPHandler: @@ -255,7 +262,7 @@ class LMTPHandler: content = None try: content = envelope.content - email, new, reply = await receive_email(envelope, log) + email, new, reply, thread = await receive_email(envelope, log) log.info(f"Created email {email.id}") systemevent = await database_sync_to_async(SystemEvent.objects.create)(type='email received', reference=email.id) @@ -263,14 +270,20 @@ class LMTPHandler: channel_layer = get_channel_layer() await channel_layer.group_send( 'general', {"type": "generic.event", "name": "send_message_to_frontend", "event_id": systemevent.id, - "message": "email received"} - ) + "message": "email received"}) log.info(f"Sent message to frontend") if new and reply: log.info('Sending message to %s' % reply['To']) await send_smtp(reply) log.info("Sent auto reply") + return '250 Message accepted for delivery' + except SpecialMailException as e: + import uuid + random_filename = 'special-' + str(uuid.uuid4()) + with open(random_filename, 'wb') as f: + f.write(content) + log.warning(f"Special mail exception: {e} saved to {random_filename}") return '250 Message accepted for delivery' except Exception as e: from hashlib import sha256 diff --git a/core/mail/tests/v2/test_mails.py b/core/mail/tests/v2/test_mails.py index ac03bac..3df56ca 100644 --- a/core/mail/tests/v2/test_mails.py +++ b/core/mail/tests/v2/test_mails.py @@ -760,7 +760,6 @@ dGVzdGltYWdl response = self.client.post(f'/api/2/tickets/{issue_thread.id}/reply/', { 'message': 'test' }) - aiosmtplib.send.assert_called_once() self.assertEqual(response.status_code, 201) self.assertEqual(5, len(Email.objects.all())) self.assertEqual(5, len(Email.objects.filter(issue_thread=issue_thread))) @@ -776,6 +775,7 @@ dGVzdGltYWdl self.assertEqual('test subject', IssueThread.objects.all()[0].name) self.assertEqual('pending_new', IssueThread.objects.all()[0].state) self.assertEqual(None, IssueThread.objects.all()[0].assigned_to) + aiosmtplib.send.assert_called_once() def test_mail_4byte_unicode_emoji(self): from aiosmtpd.smtp import Envelope diff --git a/core/requirements.dev.txt b/core/requirements.dev.txt index 8e68f67..146aa37 100644 --- a/core/requirements.dev.txt +++ b/core/requirements.dev.txt @@ -1,3 +1,6 @@ +aiodns==3.2.0 +aiohttp==3.9.5 +aiosignal==1.3.1 aiosmtpd==1.4.4.post2 aiosmtplib==3.0.1 anyio==4.1.0 @@ -28,6 +31,7 @@ django-rest-knox==4.2.0 django-soft-delete==0.9.21 djangorestframework==3.14.0 drf-yasg==1.21.7 +frozenlist==1.4.1 h11==0.14.0 hyperlink==21.0.0 idna==3.4 @@ -38,11 +42,13 @@ Jinja2==3.1.2 MarkupSafe==2.1.3 msgpack==1.0.7 msgpack-python==0.5.6 +multidict==6.0.5 openapi-codec==1.3.2 packaging==23.2 Pillow==10.1.0 pyasn1==0.5.1 pyasn1-modules==0.3.0 +pycares==4.4.0 pycparser==2.21 pyOpenSSL==23.3.0 python-dotenv==1.0.0 @@ -65,4 +71,5 @@ urllib3==2.1.0 uvicorn==0.24.0.post1 watchfiles==0.21.0 websockets==12.0 +yarl==1.9.4 zope.interface==6.1 diff --git a/core/requirements.prod.txt b/core/requirements.prod.txt index 6a4f32a..ee69fe7 100644 --- a/core/requirements.prod.txt +++ b/core/requirements.prod.txt @@ -1,3 +1,6 @@ +aiodns==3.2.0 +aiohttp==3.9.5 +aiosignal==1.3.1 aiosmtpd==1.4.4.post2 aiosmtplib==3.0.1 asgiref==3.7.2 @@ -38,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 f8f746e..596bd9b 100644 --- a/core/tickets/api_v2.py +++ b/core/tickets/api_v2.py @@ -10,6 +10,7 @@ from asgiref.sync import async_to_sync from channels.layers import get_channel_layer from core.settings import MAIL_DOMAIN +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 diff --git a/deploy/ansible/playbooks/templates/django.env.j2 b/deploy/ansible/playbooks/templates/django.env.j2 index 72a0c30..a1757db 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 diff --git a/deploy/dev/Dockerfile.backend b/deploy/dev/Dockerfile.backend new file mode 100644 index 0000000..19c2efd --- /dev/null +++ b/deploy/dev/Dockerfile.backend @@ -0,0 +1,13 @@ +FROM python:3.11-bookworm +LABEL authors="lagertonne" + +ENV PYTHONUNBUFFERED 1 +RUN mkdir /code +WORKDIR /code +COPY requirements.dev.txt /code/ +COPY requirements.prod.txt /code/ +RUN apt update && apt install -y mariadb-client +RUN pip install -r requirements.dev.txt +RUN pip install -r requirements.prod.txt +RUN pip install mysqlclient +COPY .. /code/ \ No newline at end of file diff --git a/deploy/dev/Dockerfile.frontend b/deploy/dev/Dockerfile.frontend new file mode 100644 index 0000000..0a41d1a --- /dev/null +++ b/deploy/dev/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/dev/docker-compose.yml b/deploy/dev/docker-compose.yml new file mode 100644 index 0000000..dff5ab3 --- /dev/null +++ b/deploy/dev/docker-compose.yml @@ -0,0 +1,48 @@ +services: + core: + build: + context: ../../core + dockerfile: ../deploy/dev/Dockerfile.backend + command: bash -c 'python manage.py migrate && python manage.py runserver 0.0.0.0:8000' + environment: + - HTTP_HOST=core + - 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: + context: ../../web + dockerfile: ../deploy/dev/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 + + 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" + +volumes: + mariadb_data: \ No newline at end of file diff --git a/deploy/dev/vue.config.js b/deploy/dev/vue.config.js new file mode 100644 index 0000000..f8f3c26 --- /dev/null +++ b/deploy/dev/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/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..8a7df09 --- /dev/null +++ b/deploy/testing/docker-compose.yml @@ -0,0 +1,61 @@ +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" + + mailpit: + image: axllent/mailpit + ports: + - "8025:8025" + - "1025:1025" + + 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 fb0736b..686f324 100644 --- a/web/src/components/Navbar.vue +++ b/web/src/components/Navbar.vue @@ -29,16 +29,7 @@ -
- -
+