Add dummy data for development (#5)

This PR implements a way to use dummy data for development in two ways:

1. Dump a working dev database with Django's `dumpdata` command. We dump
the `auth` and `commitfest` modules separately. This data can likewise
be reloaded when starting from scratch with the corresponding `loaddata`
commands (see the README.)
2. Mocks the archives server, to allow users to search and add sample
mailing threads to their patches.

To avoid an infinite recursion error this change also required moving
the ManyToMany relationship between MailThread and Patch from the
MailThread to Patch side.

---------

Co-authored-by: Jelte Fennema-Nio <[email protected]>

Author: polkerty

README.md

@@ -12,6 +12,8 @@ This is a Django 4.2 application backed by PostgreSQL and running on Python 3.x.
 
 ### Ubuntu instructions
 
+#### Install Dependencies / Configure Environment
+
 First, prepare your development environment by installing pip, virtualenv, and postgresql-server-dev-X.Y.
 
 ```bash
@@ -45,12 +47,24 @@ be provided.
 ./manage.py migrate
 ```
 
-You'll need either a database dump of the actual server's data or else to create a superuser:
+#### Load data
+For a quick start, you can load some dummy data into the database. Here's how you do that:
+
+```
+./manage.py loaddata auth_data.json
+./manage.py loaddata commitfest_data.json
+```
+
+If you do this, the admin username and password are `admin` and `admin`.
+
+On the other hand, if you'd like to start from scratch instead, you can run the following command to create
+a super user:
 
 ```bash
 ./manage.py createsuperuser
 ```
 
+#### Start application
 Finally, you're ready to start the application:
 
 ```bash
@@ -69,3 +83,11 @@ codestyle.
 ln -s ../../tools/githook/pre-commit .git/hooks/
 
 ```
+
+If you'd like to regenerate the database dump files, you can run the following commands:
+```
+./manage.py dumpdata auth  --format=json --indent=4 --exclude=auth.permission > pgcommitfest/commitfest/fixtures/auth_data.json
+./manage.py dumpdata commitfest  --format=json --indent=4 > pgcommitfest/commitfest/fixtures/commitfest_data.json
+```
+
+If you want to reload data from dump file, you can run `drop owned by postgres;` in the `pgcommitfest` database first.

pgcommitfest/commitfest/ajax.py

@@ -9,6 +9,7 @@
 import requests
 import json
 import textwrap
+import re
 
 from pgcommitfest.auth import user_search
 from .models import CommitFest, Patch, MailThread, MailThreadAttachment
@@ -23,7 +24,26 @@ class Http503(Exception):
     pass
 
 
+def mockArchivesAPI(path):
+    with open(settings.MOCK_ARCHIVE_DATA, 'r', encoding='utf-8') as file:
+        data = json.load(file)
+        for message in data:
+            message['atts'] = []
+
+    message_pattern = re.compile(r"^/message-id\.json/(?P<message_id>[^/]+)$")
+
+    message_match = message_pattern.match(path)
+    if message_match:
+        message_id = message_match.group("message_id")
+        return [message for message in data if message['msgid'] == message_id]
+    else:
+        return data
+
+
 def _archivesAPI(suburl, params=None):
+    if getattr(settings, 'MOCK_ARCHIVES', False) and getattr(settings, 'MOCK_ARCHIVE_DATA'):
+        return mockArchivesAPI(suburl)
+
     try:
         resp = requests.get(
             "http{0}://{1}:{2}{3}".format(settings.ARCHIVES_PORT == 443 and 's' or '',