feat: add integration test for tutorials

Author: Gigaszi

mapswipe_workers/tests/integration/set_up.py

@@ -16,20 +16,28 @@
 
 
 def set_firebase_test_data(
-    project_type: str, data_type: str, fixture_name: str, identifier: str
+    project_type: str,
+    data_type: str,
+    fixture_name: str,
+    identifier: str,
+    tutorial_id: str = None,
 ):
     test_dir = os.path.dirname(__file__)
     fixture_name = fixture_name + ".json"
     file_path = os.path.join(
         test_dir, "fixtures", project_type, data_type, fixture_name
     )
-    upload_file_to_firebase(file_path, data_type, identifier)
+    upload_file_to_firebase(file_path, data_type, identifier, tutorial_id=tutorial_id)
 
 
-def upload_file_to_firebase(file_path: str, data_type: str, identifier: str):
+def upload_file_to_firebase(
+    file_path: str, data_type: str, identifier: str, tutorial_id: str = None
+):
     with open(file_path) as test_file:
         test_data = json.load(test_file)
 
+    if tutorial_id:
+        test_data["tutorialId"] = tutorial_id
     fb_db = auth.firebaseDB()
     ref = fb_db.reference(f"/v2/{data_type}/{identifier}")
     ref.set(test_data)
@@ -85,15 +93,20 @@ def create_test_project(
         set_postgres_test_data(project_type, "users", "user")
         set_firebase_test_data(project_type, "user_groups", "user_group", "")
         set_firebase_test_data(project_type, "results", fixture_name, project_id)
-        set_postgres_test_data(project_type, "mapping_sessions", fixture_name, columns=[
-            "project_id",
-            "group_id",
-            "user_id",
-            "mapping_session_id",
-            "start_time",
-            "end_time",
-            "items_count",
-        ])
+        set_postgres_test_data(
+            project_type,
+            "mapping_sessions",
+            fixture_name,
+            columns=[
+                "project_id",
+                "group_id",
+                "user_id",
+                "mapping_session_id",
+                "start_time",
+                "end_time",
+                "items_count",
+            ],
+        )
         set_postgres_test_data(project_type, mapping_sessions_results, fixture_name)
         if create_user_group_session_data:
             set_postgres_test_data(
@@ -108,7 +121,9 @@ def create_test_project(
                     "created_at",
                 ],
             )
-            set_postgres_test_data(project_type, "mapping_sessions_user_groups", fixture_name)
+            set_postgres_test_data(
+                project_type, "mapping_sessions_user_groups", fixture_name
+            )
 
     time.sleep(5)  # Wait for Firebase Functions to complete
     return project_id
@@ -131,12 +146,24 @@ def create_test_user(project_type: str, user_id: str = None) -> str:
 
 
 def create_test_project_draft(
-    project_type: str, fixture_name: str = "user", identifier: str = ""
+    project_type: str,
+    fixture_name: str = "user",
+    identifier: str = "",
+    tutorial_id: str = None,
 ) -> str:
     """
     Create test project drafts in Firebase and return project ids.
     Project drafts in Firebase are created by project manager using the dashboard.
     """
+    if tutorial_id:
+        set_firebase_test_data(
+            project_type,
+            "projectDrafts",
+            fixture_name,
+            identifier,
+            tutorial_id=tutorial_id,
+        )
+        return identifier
     if not identifier:
         identifier = f"test_{fixture_name}"
     set_firebase_test_data(project_type, "projectDrafts", fixture_name, identifier)

mapswipe_workers/tests/integration/test_create_tutorial.py

@@ -0,0 +1,71 @@
+import unittest
+
+from click.testing import CliRunner
+
+from mapswipe_workers import auth, mapswipe_workers
+from mapswipe_workers.utils.create_directories import create_directories
+from tests.integration import set_up, tear_down
+
+
+class TestCreateTileClassificationProject(unittest.TestCase):
+    def setUp(self):
+        self.tutorial_id = set_up.create_test_tutorial_draft("footprint", "footprint")
+
+        self.project_id = set_up.create_test_project_draft(
+            "tile_classification",
+            "tile_classification",
+            "test_tile_classification_tutorial",
+            tutorial_id=self.tutorial_id,
+        )
+        create_directories()
+
+    def tearDown(self):
+        tear_down.delete_test_data(self.project_id)
+
+    def test_create_tile_classification_project(self):
+        runner = CliRunner()
+        runner.invoke(mapswipe_workers.run_create_projects, catch_exceptions=False)
+
+        pg_db = auth.postgresDB()
+        query = "SELECT project_id FROM projects WHERE project_id = %s"
+        result = pg_db.retr_query(query, [self.project_id])[0][0]
+        self.assertEqual(result, self.project_id)
+
+        query = """
+            SELECT project_id
+            FROM projects
+            WHERE project_id = %s
+                and project_type_specifics::jsonb ? 'customOptions'
+        """
+        result = pg_db.retr_query(query, [self.project_id])[0][0]
+        self.assertEqual(result, self.project_id)
+
+        query = "SELECT count(*)  FROM groups WHERE project_id = %s"
+        result = pg_db.retr_query(query, [self.project_id])[0][0]
+        self.assertEqual(result, 20)
+
+        query = "SELECT count(*)  FROM tasks WHERE project_id = %s"
+        result = pg_db.retr_query(query, [self.project_id])[0][0]
+        self.assertEqual(result, 5040)
+
+        fb_db = auth.firebaseDB()
+        ref = fb_db.reference(f"/v2/projects/{self.project_id}")
+        result = ref.get(shallow=True)
+        self.assertIsNotNone(result)
+
+        ref = fb_db.reference(f"/v2/groups/{self.project_id}")
+        result = ref.get(shallow=True)
+        self.assertEqual(len(result), 20)
+
+        # Tile classification projects do not have tasks in Firebase
+        ref = fb_db.reference(f"/v2/tasks/{self.project_id}")
+        result = ref.get(shallow=True)
+        self.assertIsNone(result)
+
+        ref = fb_db.reference(f"/v2/projects/{self.project_id}/tutorialId")
+        result = ref.get(shallow=True)
+        self.assertEqual(self.tutorial_id, result)
+
+
+if __name__ == "__main__":
+    unittest.main()