Add missing references in mapping_sessions_user_groups

- Update documentations

Author: thenav56

.github/workflows/actions.yml

@@ -30,7 +30,7 @@ jobs:
     - name: Assert check
       run: |
           cmp --silent ./postgres/initdb.sql ./mapswipe_workers/tests/integration/set_up_db.sql || {
-            echo 'The set_up_db.sql is not same as initdb.sql. Please do `cp ./postgres/initdb.sql ./mapswipe_workers/tests/integration/set_up_db.sql` and push';
+            echo 'The set_up_db.sql is not same as initdb.sql. Please sync this files and push';
             diff ./postgres/initdb.sql ./mapswipe_workers/tests/integration/set_up_db.sql;
             exit 1;
           }

django/apps/existing_database/migrations/0001_initial.py

@@ -102,7 +102,7 @@ class Migration(migrations.Migration):
                 ("timestamp", models.DateTimeField(blank=True, null=True)),
                 ("start_time", models.DateTimeField(blank=True, null=True)),
                 ("end_time", models.DateTimeField(blank=True, null=True)),
-                ("result", models.IntegerField(blank=True, null=True)),
+                ("result", models.SmallIntegerField(blank=True, null=True)),
             ],
             options={
                 "db_table": "results",

django/apps/existing_database/migrations/0002_mappingsession_mappingsessionresult.py

@@ -36,7 +36,7 @@ class Migration(migrations.Migration):
             fields=[
                 ("mapping_session_id", models.BigIntegerField()),
                 ("task_id", models.CharField(max_length=999)),
-                ("result", models.IntegerField(blank=True, null=True)),
+                ("result", models.SmallIntegerField(blank=True, null=True)),
             ],
             options={
                 "db_table": "mapping_sessions_results",

django/apps/existing_database/models.py

@@ -2,6 +2,9 @@
 from django.db import models
 from mapswipe.db import Model
 
+# NOTE: Django model defination and existing table structure doesn't entirely matches.
+# This is to be used for testing only.
+
 
 class User(Model):
     user_id = models.CharField(primary_key=True, max_length=999)
@@ -152,7 +155,7 @@ class Result(Model):
     timestamp = models.DateTimeField(blank=True, null=True)
     start_time = models.DateTimeField(blank=True, null=True)
     end_time = models.DateTimeField(blank=True, null=True)
-    result = models.IntegerField(blank=True, null=True)
+    result = models.SmallIntegerField(blank=True, null=True)
 
     # Django derived fields from ForeignKey
     project_id: str
@@ -237,7 +240,7 @@ class Meta:
 class MappingSessionResult(Model):
     mapping_session = models.ForeignKey(MappingSession, on_delete=models.DO_NOTHING)
     task_id = models.CharField(max_length=999)
-    result = models.IntegerField(blank=True, null=True)
+    result = models.SmallIntegerField(blank=True, null=True)
 
     class Meta:
         managed = False
@@ -254,4 +257,4 @@ class MappingSessionUserGroup(Model):
     class Meta:
         managed = False
         db_table = "mapping_sessions_user_groups"
-        unique_together = (("mapping_session", "user_group_id"),)
+        unique_together = (("mapping_session", "user_group"),)

django/mapswipe/utils.py

@@ -58,9 +58,10 @@ def fetch_git_sha(path, head=None):
         return str(fh.read()).strip()
 
 
-def raise_if_field_not_found(obj, fields, custom_exception=Exception):
+def raise_if_field_not_found(obj: dict, fields: list[str], custom_exception=Exception):
     """
     NOTE: This is for making sure dev pass this variables manually in the test.
+    Don't catch this exception
     """
     empty_keys = [field for field in fields if obj.get(field) is None]
     if empty_keys:

mapswipe_workers/tests/integration/set_up_db.sql

@@ -212,7 +212,8 @@ CREATE TABLE IF NOT EXISTS mapping_sessions_user_groups (
     mapping_session_id int8,
     user_group_id varchar,  -- user group primary key
     PRIMARY KEY (mapping_session_id, user_group_id),
-    FOREIGN KEY (mapping_session_id) REFERENCES mapping_sessions (mapping_session_id)
+    FOREIGN KEY (mapping_session_id) REFERENCES mapping_sessions (mapping_session_id),
+    FOREIGN KEY (user_group_id) REFERENCES user_groups (user_group_id)
 );
 
 -- create table for user_group_results import through csv

postgres/initdb.sql

@@ -212,7 +212,8 @@ CREATE TABLE IF NOT EXISTS mapping_sessions_user_groups (
     mapping_session_id int8,
     user_group_id varchar,  -- user group primary key
     PRIMARY KEY (mapping_session_id, user_group_id),
-    FOREIGN KEY (mapping_session_id) REFERENCES mapping_sessions (mapping_session_id)
+    FOREIGN KEY (mapping_session_id) REFERENCES mapping_sessions (mapping_session_id),
+    FOREIGN KEY (user_group_id) REFERENCES user_groups (user_group_id)
 );
 
 -- create table for user_group_results import through csv