OT Tests: Add docstring to tests

1 files changed, 15 insertions, 0 deletions

diff --git a/pydis_site/apps/api/tests/test_off_topic_channel_names.py b/pydis_site/apps/api/tests/test_off_topic_channel_names.py
index 51372651..cac9405a 100644
--- a/pydis_site/apps/api/tests/test_off_topic_channel_names.py
+++ b/pydis_site/apps/api/tests/test_off_topic_channel_names.py
@@ -10,12 +10,14 @@ class UnauthenticatedTests(APISubdomainTestCase):
         self.client.force_authenticate(user=None)
 
     def test_cannot_read_off_topic_channel_name_list(self):
+        """Test does this return 401 response code when not authenticated."""
         url = reverse('bot:offtopicchannelname-list', host='api')
         response = self.client.get(url)
 
         self.assertEqual(response.status_code, 401)
 
     def test_cannot_read_off_topic_channel_name_list_with_random_item_param(self):
+        """Test does this give 401 code when `random_items` provided and not authenticated."""
         url = reverse('bot:offtopicchannelname-list', host='api')
         response = self.client.get(f'{url}?random_items=no')
 
@@ -24,6 +26,7 @@ class UnauthenticatedTests(APISubdomainTestCase):
 
 class EmptyDatabaseTests(APISubdomainTestCase):
     def test_returns_empty_object(self):
+        """Test does this return empty list when no names in database."""
         url = reverse('bot:offtopicchannelname-list', host='api')
         response = self.client.get(url)
 
@@ -31,6 +34,7 @@ class EmptyDatabaseTests(APISubdomainTestCase):
         self.assertEqual(response.json(), [])
 
     def test_returns_empty_list_with_get_all_param(self):
+        """Test does this return empty list when no names and `random_items` param provided."""
         url = reverse('bot:offtopicchannelname-list', host='api')
         response = self.client.get(f'{url}?random_items=5')
 
@@ -38,6 +42,7 @@ class EmptyDatabaseTests(APISubdomainTestCase):
         self.assertEqual(response.json(), [])
 
     def test_returns_400_for_bad_random_items_param(self):
+        """Test does this return error message when passing not integer as `random_items`."""
         url = reverse('bot:offtopicchannelname-list', host='api')
         response = self.client.get(f'{url}?random_items=totally-a-valid-integer')
 
@@ -47,6 +52,7 @@ class EmptyDatabaseTests(APISubdomainTestCase):
         })
 
     def test_returns_400_for_negative_random_items_param(self):
+        """Test does this return error message when passing negative int as `random_items`."""
         url = reverse('bot:offtopicchannelname-list', host='api')
         response = self.client.get(f'{url}?random_items=-5')
 
@@ -63,6 +69,7 @@ class ListTests(APISubdomainTestCase):
         cls.test_name_2 = OffTopicChannelName.objects.create(name='bbq-with-bisk', used=True)
 
     def test_returns_name_in_list(self):
+        """Test does this return all off-topic channel names."""
         url = reverse('bot:offtopicchannelname-list', host='api')
         response = self.client.get(url)
 
@@ -76,6 +83,7 @@ class ListTests(APISubdomainTestCase):
         )
 
     def test_returns_single_item_with_random_items_param_set_to_1(self):
+        """Test does this return not-used name instead used."""
         url = reverse('bot:offtopicchannelname-list', host='api')
         response = self.client.get(f'{url}?random_items=1')
 
@@ -84,6 +92,7 @@ class ListTests(APISubdomainTestCase):
         self.assertEqual(response.json(), [self.test_name.name])
 
     def test_running_out_of_names_with_random_parameter(self):
+        """Test does this reset names `used` parameter to `False` when running out of names."""
         url = reverse('bot:offtopicchannelname-list', host='api')
         response = self.client.get(f'{url}?random_items=2')
 
@@ -101,6 +110,7 @@ class CreationTests(APISubdomainTestCase):
         self.assertEqual(response.status_code, 201)
 
     def test_returns_201_for_unicode_chars(self):
+        """Test does this accept all valid characters."""
         url = reverse('bot:offtopicchannelname-list', host='api')
         names = (
             '𝖠𝖡𝖢𝖣𝖤𝖥𝖦𝖧𝖨𝖩𝖪𝖫𝖬𝖭𝖮𝖯𝖰𝖱𝖲𝖳𝖴𝖵𝖶𝖷𝖸𝖹',
@@ -112,6 +122,7 @@ class CreationTests(APISubdomainTestCase):
             self.assertEqual(response.status_code, 201)
 
     def test_returns_400_for_missing_name_param(self):
+        """Test does this return error message when name not provided."""
         url = reverse('bot:offtopicchannelname-list', host='api')
         response = self.client.post(url)
         self.assertEqual(response.status_code, 400)
@@ -120,6 +131,7 @@ class CreationTests(APISubdomainTestCase):
         })
 
     def test_returns_400_for_bad_name_param(self):
+        """Test does this return error message when invalid characters provided."""
         url = reverse('bot:offtopicchannelname-list', host='api')
         invalid_names = (
             'space between words',
@@ -142,18 +154,21 @@ class DeletionTests(APISubdomainTestCase):
         cls.test_name_2 = OffTopicChannelName.objects.create(name='bbq-with-bisk')
 
     def test_deleting_unknown_name_returns_404(self):
+        """Test does this return 404 code when trying to delete unknown name."""
         url = reverse('bot:offtopicchannelname-detail', args=('unknown-name',), host='api')
         response = self.client.delete(url)
 
         self.assertEqual(response.status_code, 404)
 
     def test_deleting_known_name_returns_204(self):
+        """Test does this return 204 code when deleting was successful."""
         url = reverse('bot:offtopicchannelname-detail', args=(self.test_name.name,), host='api')
         response = self.client.delete(url)
 
         self.assertEqual(response.status_code, 204)
 
     def test_name_gets_deleted(self):
+        """Test does name gets actually deleted."""
         url = reverse('bot:offtopicchannelname-detail', args=(self.test_name_2.name,), host='api')
         response = self.client.delete(url)