Skip to content

Commit

Permalink
Fix off-topic names test docstrings mood
Browse files Browse the repository at this point in the history
  • Loading branch information
ks129 committed Aug 29, 2020
1 parent 32b76b1 commit d5945b3
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions pydis_site/apps/api/tests/test_off_topic_channel_names.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ def setUp(self):
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."""
"""Return a 401 response 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."""
"""Return a 401 response when `random_items` provided and not authenticated."""
url = reverse('bot:offtopicchannelname-list', host='api')
response = self.client.get(f'{url}?random_items=no')

Expand All @@ -26,23 +26,23 @@ def test_cannot_read_off_topic_channel_name_list_with_random_item_param(self):

class EmptyDatabaseTests(APISubdomainTestCase):
def test_returns_empty_object(self):
"""Test does this return empty list when no names in database."""
"""Return empty list when no names in database."""
url = reverse('bot:offtopicchannelname-list', host='api')
response = self.client.get(url)

self.assertEqual(response.status_code, 200)
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."""
"""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')

self.assertEqual(response.status_code, 200)
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`."""
"""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')

Expand All @@ -52,7 +52,7 @@ def test_returns_400_for_bad_random_items_param(self):
})

def test_returns_400_for_negative_random_items_param(self):
"""Test does this return error message when passing negative int as `random_items`."""
"""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')

Expand All @@ -69,7 +69,7 @@ def setUpTestData(cls):
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."""
"""Return all off-topic channel names."""
url = reverse('bot:offtopicchannelname-list', host='api')
response = self.client.get(url)

Expand All @@ -83,7 +83,7 @@ def test_returns_name_in_list(self):
)

def test_returns_single_item_with_random_items_param_set_to_1(self):
"""Test does this return not-used name instead used."""
"""Return not-used name instead used."""
url = reverse('bot:offtopicchannelname-list', host='api')
response = self.client.get(f'{url}?random_items=1')

Expand All @@ -92,7 +92,7 @@ def test_returns_single_item_with_random_items_param_set_to_1(self):
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."""
"""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')

Expand All @@ -110,7 +110,7 @@ def setUp(self):
self.assertEqual(response.status_code, 201)

def test_returns_201_for_unicode_chars(self):
"""Test does this accept all valid characters."""
"""Accept all valid characters."""
url = reverse('bot:offtopicchannelname-list', host='api')
names = (
'𝖠𝖡𝖢𝖣𝖤𝖥𝖦𝖧𝖨𝖩𝖪𝖫𝖬𝖭𝖮𝖯𝖰𝖱𝖲𝖳𝖴𝖵𝖶𝖷𝖸𝖹',
Expand All @@ -122,7 +122,7 @@ def test_returns_201_for_unicode_chars(self):
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."""
"""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)
Expand All @@ -131,7 +131,7 @@ def test_returns_400_for_missing_name_param(self):
})

def test_returns_400_for_bad_name_param(self):
"""Test does this return error message when invalid characters provided."""
"""Return error message when invalid characters provided."""
url = reverse('bot:offtopicchannelname-list', host='api')
invalid_names = (
'space between words',
Expand All @@ -154,21 +154,21 @@ def setUpTestData(cls):
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."""
"""Return 404 reponse 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."""
"""Return 204 response 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."""
"""Name gets actually deleted."""
url = reverse('bot:offtopicchannelname-detail', args=(self.test_name_2.name,), host='api')
response = self.client.delete(url)

Expand Down

0 comments on commit d5945b3

Please sign in to comment.