chapeau/tests/tests_response.py

from django.test import TestCase, Client
from django.test.client import RequestFactory
from django_kepi import TombstoneException
from django_kepi.models import Actor, Following
from django_kepi.responses import *
from things_for_testing.models import ThingUser
from things_for_testing.views import ThingUserCollection
import datetime
import json
import math

EXAMPLE_SERVER = 'http://testserver'
JSON_TYPE = 'application/activity+json'
PAGE_LENGTH = 50

class ResponseTests(TestCase):

    # We are checking:
    #  - TombstoneException (may as well test it here)
    #  - response(various objects)
    #  - response(thing that throws Tombstone)
    #  - default CollectionResponse, passing in items
    #  - CollectionResponse if one of the items is a Tombstone
    #  - specialised CollectionResponses with overridden _transform_item 

    def test_tombstone_exception(self):

        te = TombstoneException(
                fred = 'jim',
                sheila = 'hazel',
                )

        self.assertEqual(
                te.activity,
                {
                    'fred': 'jim',
                    'sheila': 'hazel',
                    'type': 'Tombstone',
                    })

    def test_empty_response(self):

        aor = ActivityObjectResponse()
        self.assertEqual(
                aor.content,
                 b'')

    def test_object_response(self):

        class RandomWeirdThing(object):
            @property
            def activity(self):
                return {
                        'where': 'there',
                        'what': 'that',
                        }

        rwt = RandomWeirdThing()
        aor = ActivityObjectResponse(item=rwt)

        self.assertEqual(aor.status_code, 200)

        content_value = json.loads(aor.content.decode(encoding='UTF-8'))

        self.assertEqual(
                rwt.activity,
                content_value)

    def test_tombstone_object_response(self):

        class RandomWeirdGoneAwayThing(object):
            @property
            def activity(self):
                raise TombstoneException(former_type='Article')

        rwgat = RandomWeirdGoneAwayThing()
        aor = ActivityObjectResponse(item=rwgat)

        self.assertEqual(aor.status_code, 410)

        content_value = json.loads(aor.content.decode(encoding='UTF-8'))
        self.assertEqual(
                {'former_type': 'Article', 'type': 'Tombstone'},
                content_value)

    def test_collection_response(self):

        people = {}

        for name in ['alice', 'albert', 'bob']:
            people[name] = ThingUser(name=name)
            people[name].save()

        PATH_INDEX = '/users/something'
        PATH_PAGE1 = PATH_INDEX+'?page=1'

        rf = RequestFactory()
        request_index = rf.get(PATH_INDEX)
        request_page1 = rf.get(PATH_PAGE1)

        for queryset in [
                ThingUser.objects.none(),
                ThingUser.objects.filter(name='alice'),
                ThingUser.objects.filter(name__startswith='al'),
                ThingUser.objects.all(),
                ]:

            ################ check the index

            cr = CollectionResponse(queryset, request_index)

            self.assertEqual(cr.status_code, 200)

            content_value = json.loads(cr.content.decode(encoding='UTF-8'))

            self.assertEqual(content_value['totalItems'], queryset.count())
            self.assertEqual(content_value['type'], 'OrderedCollection')
            self.assertEqual(content_value['id'], EXAMPLE_SERVER+PATH_INDEX)

            if queryset.count()==0:
                self.assertNotIn('first', content_value)
            else:
                self.assertEqual(content_value['first'], EXAMPLE_SERVER+PATH_PAGE1)

            ################ check the first page

            if queryset.count()==0:
                continue

            cr = CollectionResponse(queryset, request_page1)

            self.assertEqual(cr.status_code, 200)

            content_value = json.loads(cr.content.decode(encoding='UTF-8'))

            self.assertEqual(content_value['totalItems'], queryset.count())
            self.assertEqual(content_value['type'], 'OrderedCollectionPage')
            self.assertEqual(content_value['partOf'], EXAMPLE_SERVER+PATH_INDEX)
            self.assertEqual(content_value['id'], EXAMPLE_SERVER+PATH_PAGE1)

            expectedItems = [str(x) for x in queryset]
            self.assertEqual(content_value['orderedItems'], expectedItems)

    def test_collection_response_spills(self):

        rf = RequestFactory()
        PATH = '/something?page=%d'

        for i in range(1, PAGE_LENGTH*3):
            someone = ThingUser(name='Person %03d' % (i,))
            someone.save()

            expected_page_count = math.ceil(i/PAGE_LENGTH)

            queryset = ThingUser.objects.all()

            for p in range(1, expected_page_count+1):
                request_page = rf.get(PATH % (p,))
                cr = CollectionResponse(queryset, request_page)
                content_value = json.loads(cr.content.decode(encoding='UTF-8'))

                self.assertEqual(content_value['totalItems'], i)
                self.assertEqual(content_value['id'], EXAMPLE_SERVER+PATH % (p,))

                if p==1:
                    self.assertNotIn('prev', content_value)
                else:
                    self.assertEqual(content_value['prev'], EXAMPLE_SERVER+PATH % (p-1))

                if p==expected_page_count:
                    self.assertNotIn('next', content_value)
                else:
                    self.assertEqual(content_value['next'], EXAMPLE_SERVER+PATH % (p+1))

    def test_tombstone_collection_response(self):
        pass

    def test_collection_with_overridden_transform(self):
        pass

    ################ unfixed below this line

    def check_collection(self,
            path,
            expectedTotalItems):

        c = Client(
                HTTP_ACCEPT = JSON_TYPE,
                )

        response = c.get(path)

        if response.status_code!=200:
            raise RuntimeError(response.content)

        self.assertEqual(response['Content-Type'], JSON_TYPE)

        result = json.loads(response.content.decode(encoding='UTF-8'))

        for field in [
                '@context',
                'id',
                'totalItems',
                'type',
                ]:
            self.assertIn(field, result)

        if expectedTotalItems==0:
            self.assertNotIn('first', result)
        else:
            self.assertIn('first', result)
            self.assertEqual(result['first'], EXAMPLE_SERVER+path+'?page=1')

        self.assertEqual(result['id'], EXAMPLE_SERVER+path)
        self.assertEqual(result['totalItems'], expectedTotalItems)
        self.assertEqual(result['type'], 'OrderedCollection')

    def check_collection_page(self,
            path,
            page_number,
            expectedTotalItems,
            expectedOnPage,
            ):

        def full_path(page):
            if page is None:
                query = ''
            else:
                query = '?page={}'.format(page)

            return EXAMPLE_SERVER + path + query

        c = Client(
                HTTP_ACCEPT = JSON_TYPE,
                )

        response = c.get(full_path(page_number))

        if response['Content-Type']=='text/html':
            # let's just give up here so they have a chance
            # of figuring out the error message from the server.
            raise RuntimeError(response.content)

        self.assertEqual(response['Content-Type'], JSON_TYPE)

        result = json.loads(response.content.decode(encoding='UTF-8'))

        for field in [
                '@context',
                'id',
                'totalItems',
                'type',
                'partOf',
                ]:
            self.assertIn(field, result)

        self.assertEqual(result['id'], full_path(page_number))
        self.assertEqual(result['totalItems'], expectedTotalItems)
        self.assertEqual(result['type'], 'OrderedCollectionPage')
        self.assertEqual(result['orderedItems'], expectedOnPage)
        self.assertEqual(result['partOf'], full_path(None))

        if page_number!=1:
            self.assertIn('prev', result)
            self.assertEqual(result['prev'], full_path(page_number-1))
        else:
            self.assertNotIn('prev', result)

        if (page_number-1)<int((expectedTotalItems-1)/PAGE_LENGTH):
            self.assertIn('next', result)
            self.assertEqual(result['next'], full_path(page_number+1))
        else:
            self.assertNotIn('next', result)

    def test_usageByOtherApps(self):

        PATH = '/thing-users'
        EXPECTED_SERIALIZATION = [
                {'id': 'https://example.com/user/alice', 'name': 'alice', 'type': 'Person',
                    'favourite_colour': 'red'},
                {'id': 'https://example.com/user/bob', 'name': 'bob', 'type': 'Person',
                    'favourite_colour': 'green'},
                {'id': 'https://example.com/user/carol', 'name': 'carol', 'type': 'Person',
                    'favourite_colour': 'blue'},
                ]

        users = [
                ThingUser(name='alice', favourite_colour='red'),
                ThingUser(name='bob', favourite_colour='green'),
                ThingUser(name='carol', favourite_colour='blue'),
                ]

        for user in users:
            user.save()

        self.check_collection(
                path=PATH,
                expectedTotalItems=len(users),
                )

        self.check_collection_page(
                path=PATH,
                page_number=1,
                expectedTotalItems=len(users),
                expectedOnPage=EXPECTED_SERIALIZATION,
                )

    def test_followers_and_following(self):

        people = {}

        for name in ['alice', 'bob', 'carol']:
            people[name] = ThingUser(name=name)
            people[name].save()

            reln = Following(
                    follower = people[name].actor,
                    following = people['alice'].actor,
                    )
            reln.save()

        path = '/users/alice/followers'

        self.check_collection(
                path=path,
                expectedTotalItems=3,
                )

        self.check_collection_page(
                path=path,
                page_number=1,
                expectedTotalItems=3,
                expectedOnPage=['alice', 'bob', 'carol'],
                )

        for name in ['alice', 'bob', 'carol']:

            path='/users/{}/following'.format(name)

            self.check_collection(
                    path=path,
                    expectedTotalItems=1,
                    )

            self.check_collection_page(
                    path=path,
                    page_number=1,
                    expectedTotalItems=1,
                    expectedOnPage=['alice'],
                    )