updated test cases to env and improved logging hints #106

Author: bensteUEM

churchtools_api/groups.py

@@ -21,6 +21,9 @@ def get_groups(self, **kwargs) -> list[dict]:
         Keywords:
             group_id: int: optional filter by group id (only to be used on it's own)
 
+        Permissions:
+            requires "view group" for all groups which should be considered
+
         Returns:
             list of groups - either all or filtered by keyword
 
@@ -42,7 +45,7 @@ def get_groups(self, **kwargs) -> list[dict]:
             return response_data
         else:
             logger.warning(
-                "Something went wrong fetching groups: {}".format(response.status_code)
+                "%s Something went wrong fetching groups: %s",response.status_code, response.content
             )
 
     def get_groups_hierarchies(self):
@@ -121,6 +124,7 @@ def create_group(
 
         Required Permissions:
             administer groups
+            create group of grouptype
 
         Returns:
             dict with created group group - similar to get_group
@@ -157,9 +161,7 @@ def create_group(
             return response_data
         else:
             logger.warning(
-                "Something went wrong with creating group: {}".format(
-                    response.status_code
-                )
+                "%s Something went wrong with creating group: %s", response.status_code, response.content
             )
 
     def update_group(self, group_id: int, data: dict):
@@ -197,6 +199,9 @@ def delete_group(self, group_id: int) -> bool:
         Arguments:
             group_id: group_id
 
+        Required Permissions
+            delete group
+
         Returns:
             True if successful
         """
@@ -409,6 +414,8 @@ def remove_group_member(self, group_id: int, person_id: int) -> bool:
             group_id: int: required group id
             person_id: int: required person id
 
+        Required Permissions:
+            edit group memberships of groups
         Returns:
             True if successful
         """
@@ -419,9 +426,7 @@ def remove_group_member(self, group_id: int, person_id: int) -> bool:
             return True
         else:
             logger.warning(
-                "Something went wrong removing group member: {}".format(
-                    response.status_code
-                )
+                "%s Something went wrong removing group member: %s", response.status_code, response.content
             )
 
     def get_group_roles(self, group_id: int) -> list[dict]:
@@ -460,6 +465,9 @@ def add_parent_group(self, group_id: int, parent_group_id: int) -> bool:
             group_id: required group id
             parent_group_id: required parent group id
 
+        Required Permissions:
+            administer groups
+
         Returns:
         True if successful
         """
@@ -472,10 +480,8 @@ def add_parent_group(self, group_id: int, parent_group_id: int) -> bool:
             logger.debug("First response of Add Parent Group successful")
             return True
         else:
-            logger.warning(
-                "Something went wrong adding parent group: {}".format(
-                    response.status_code
-                )
+            logger.warning( 
+                "%s Something went wrong adding parent group: %s",response.status_code, response.content
             )
 
     def remove_parent_group(self, group_id: int, parent_group_id: int) -> bool:

tests/test_churchtools_api.py

@@ -138,12 +138,12 @@ def test_get_songs(self) -> None:
         IMPORTANT - This test method and the parameters used depend on the target system!
         the hard coded sample exists on ELKW1610.KRZ.TOOLS
         """
-        test_song_id = 2034
+        SAMPLE_SONG_ID = 2034
 
         songs = self.api.get_songs()
         self.assertGreater(len(songs), 50)
 
-        song = self.api.get_songs(song_id=test_song_id)[0]
+        song = self.api.get_songs(song_id=SAMPLE_SONG_ID)[0]
         self.assertEqual(song["id"], 2034)
         self.assertEqual(song["name"], "sample")
 
@@ -154,13 +154,13 @@ def test_get_song_ajax(self):
         IMPORTANT - This test method and the parameters used depend on the target system!
         :return:
         """
-        test_song_id = 408
-        song = self.api.get_song_ajax(song_id=test_song_id)
+        SAMPLE_SONG_ID = 2034
+        song = self.api.get_song_ajax(song_id=SAMPLE_SONG_ID)
         self.assertIsInstance(song, dict)
         self.assertEqual(len(song), 14)
 
-        self.assertEqual(int(song['id']), test_song_id)
-        self.assertEqual(song['bezeichnung'], 'Test')
+        self.assertEqual(int(song['id']), SAMPLE_SONG_ID)
+        self.assertEqual(song['bezeichnung'], 'sample')
 
     def test_get_song_category_map(self):
         """
@@ -654,15 +654,16 @@ def test_get_songs_with_tag(self):
         """
         Test method to check if fetching all songs with a specific tag works
         songId and tag_id will vary depending on the server used
-        On ELKW1610.KRZ.TOOLS song ID 408 is the first song with tag 53 "Test"
+        On ELKW1610.KRZ.TOOLS song ID 408 is tagged with 53 "Test"
         :return:
         """
-        tagId = 53
-        songId = 408
+        SAMPLE_TAG_ID = 53
+        SAMPLE_SONG_ID = 408
 
         self.api.ajax_song_last_update = None
-        result = self.api.get_songs_by_tag(tagId)
-        self.assertEqual(songId, result[0]['id'])
+        result = self.api.get_songs_by_tag(SAMPLE_TAG_ID)
+        result_ids = [song['id'] for song in result]
+        self.assertIn(SAMPLE_SONG_ID, result_ids)
 
     def test_file_download(self):
         """ Test of file_download and file_download_from_url on https://elkw1610.krz.tools on any song

tests/test_churchtools_api_calendars.py

@@ -165,6 +165,6 @@ def test_get_calendar_appointments_none(self):
         """
         # Appointment Series by ID
         result = self.api.get_calendar_appointments(
-            calendar_ids=[52], from_="2023-12-03", to_="2023-12-04")
+            calendar_ids=[52], from_="2023-12-01", to_="2023-12-02")
 
         self.assertIsNone(result)

tests/test_churchtools_api_events.py

@@ -137,14 +137,14 @@ def test_get_AllEventData_ajax(self):
         IMPORTANT - This test method and the parameters used depend on the target system!
 
         Test function to check the get_AllEventData_ajax function for a specific ID
-        On ELKW1610.KRZ.TOOLS event ID 3396 is an existing Test Event with schedule (1. Jan 2024)
+        On ELKW1610.KRZ.TOOLS event ID 3348 is an existing Test Event with schedule (29. Sept 2024)
         Please be aware that this function is limited to the timeframe configured for cache in CT (by default -90days)
         :return:
         """
-        eventId = 3396
-        result = self.api.get_AllEventData_ajax(eventId)
+        SAMPLE_EVENT_ID = 3348
+        result = self.api.get_AllEventData_ajax(SAMPLE_EVENT_ID)
         self.assertIn('id', result.keys())
-        self.assertEqual(result['id'], str(eventId))
+        self.assertEqual(result['id'], str(SAMPLE_EVENT_ID))
 
     def test_get_set_event_services_counts(self):
         """
@@ -185,26 +185,26 @@ def test_get_set_event_admins(self):
         IMPORTANT - This test method and the parameters used depend on the target system!
 
         Test function to get list of event admins, change it and check again (and reset to original)
-        On ELKW1610.KRZ.TOOLS event ID 3396 is an existing Test Event with schedule (1. Jan 2024)
+        On ELKW1610.KRZ.TOOLS event ID 3348 is an existing Event with schedule (29. Sept 2024)
         Please be aware that this function is limited to the timeframe configured for cache in CT (by default -90days)
         :return:
         """
-        eventId = 3396
-        admin_ids_original_test = [9]
+        SAMPLE_EVENT_ID = 3348
+        EXPECTED_ADMIN_IDS = [336]
 
-        admin_ids_original = self.api.get_event_admins_ajax(eventId)
-        self.assertEqual(admin_ids_original, admin_ids_original_test)
+        admin_ids_original = self.api.get_event_admins_ajax(SAMPLE_EVENT_ID)
+        self.assertEqual(admin_ids_original, EXPECTED_ADMIN_IDS)
 
         admin_ids_change = [0, 1, 2]
-        result = self.api.set_event_admins_ajax(eventId, admin_ids_change)
+        result = self.api.set_event_admins_ajax(SAMPLE_EVENT_ID, admin_ids_change)
         self.assertTrue(result)
 
-        admin_ids_test = self.api.get_event_admins_ajax(eventId)
+        admin_ids_test = self.api.get_event_admins_ajax(SAMPLE_EVENT_ID)
         self.assertEqual(admin_ids_change, admin_ids_test)
 
         self.assertTrue(
             self.api.set_event_admins_ajax(
-                eventId, admin_ids_original_test))
+                SAMPLE_EVENT_ID, EXPECTED_ADMIN_IDS))
 
     def test_get_event_masterdata(self):
         """

tests/test_churchtools_api_resources.py

@@ -169,6 +169,8 @@ def test_get_booking_from_to_date(self, caplog):
             "_to": datetime(year=2024, month=9, day=30),
         }
 
+        caplog.set_level(logging.WARNING)
+
         result = self.api.get_bookings(
             _from=SAMPLE_DATES["_from"],
             _to=SAMPLE_DATES["_to"],