test_renderers.py

import unittest

from unittest.mock import mock_open, patch
from rest_framework.generics import ListAPIView
from rest_framework.fields import Field
from rest_framework.mixins import CreateModelMixin, DestroyModelMixin

from rest_framework_ccbv.renderers import (
    BasePageRenderer, IndexPageRenderer, LandPageRenderer, ErrorPageRenderer,
    SitemapRenderer, DetailPageRenderer,
)
from rest_framework_ccbv.config import VERSION
from rest_framework_ccbv.inspector import Attributes

KLASS_FILE_CONTENT = (
    '{"3.9": {"rest_framework.generics": ["RetrieveDestroyAPIView", "ListAPIView"]},'
    '"%s": {"rest_framework.generics": ["RetrieveDestroyAPIView", "ListAPIView"]}}' % VERSION
)


class TestBasePageRenderer(unittest.TestCase):
    def setUp(self):
        # Adding Field below just to make sure that Field
        # is not being added to grouped_klasses later on.
        # We don't want to show Field.
        self.renderer = BasePageRenderer(
            [Field, ListAPIView, CreateModelMixin, DestroyModelMixin]
        )
        self.renderer.template_name = 'base.html'

    @patch('rest_framework_ccbv.renderers.BasePageRenderer.get_context', return_value={'foo': 'bar'})
    @patch('rest_framework_ccbv.renderers.template_env.get_template')
    @patch('rest_framework_ccbv.renderers.open', new_callable=mock_open)
    def test_render(self, mock_open, get_template_mock, get_context_mock):
        self.renderer.render('foo')
        mock_open.assert_called_once_with('foo', 'w')
        handle = mock_open()
        handle.write.assert_called_once()
        get_template_mock.assert_called_with('base.html')
        get_template_mock.return_value.render.assert_called_with({
                                                                 'foo': 'bar'})

    @patch('rest_framework_ccbv.renderers.template_env.get_template')
    @patch('rest_framework_ccbv.renderers.open', mock_open())
    def test_context(self, get_template_mock):
        self.renderer.render('foo')
        context = get_template_mock.return_value.render.call_args_list[0][0][0]
        assert context['version_prefix'] == 'Django REST Framework'
        assert context['version'] == VERSION
        assert context['versions']
        assert context['other_versions']
        assert context['grouped_klasses'] == {
            "rest_framework.generics": [ListAPIView],
            "rest_framework.mixins": [CreateModelMixin, DestroyModelMixin],
        }


class TestStaticPagesRenderered(unittest.TestCase):
    def setUp(self):
        self.rendererIndex = IndexPageRenderer([ListAPIView])
        self.rendererLandPage = LandPageRenderer([ListAPIView])
        self.rendererErrorPage = ErrorPageRenderer([ListAPIView])

    @patch('rest_framework_ccbv.renderers.template_env.get_template')
    @patch('rest_framework_ccbv.renderers.open', mock_open())
    def test_template_name(self, get_template_mock):
        self.rendererIndex.render('foo')
        get_template_mock.assert_called_with('index.html')
        self.rendererLandPage.render('foo')
        get_template_mock.assert_called_with('home.html')
        self.rendererErrorPage.render('foo')
        get_template_mock.assert_called_with('error.html')


class TestSitemapRenderer(unittest.TestCase):
    def setUp(self):
        self.renderer = SitemapRenderer([ListAPIView])

    @patch('rest_framework_ccbv.renderers.template_env.get_template')
    @patch('rest_framework_ccbv.renderers.open', mock_open(read_data='{}'))
    def test_context(self, get_template_mock):
        self.renderer.render('foo')
        context = get_template_mock.return_value.render.call_args_list[0][0][0]
        assert context['latest_version']
        assert context['base_url']
        assert context['klasses'] == {}


class TestDetailPageRenderer(unittest.TestCase):
    # @patch('rest_framework_ccbv.renderers.open', mock_open(read_data='{}'))
    def setUp(self):
        self.renderer = DetailPageRenderer(
            [ListAPIView], ListAPIView.__name__, ListAPIView.__module__)

    @patch('rest_framework_ccbv.renderers.template_env.get_template')
    @patch('rest_framework_ccbv.renderers.open', mock_open(read_data=KLASS_FILE_CONTENT))
    @patch('rest_framework_ccbv.inspector.open', mock_open(read_data=KLASS_FILE_CONTENT))
    def test_context(self, get_template_mock):
        self.renderer.render('foo')
        context = get_template_mock.return_value.render.call_args_list[0][0][0]
        assert context['other_versions'] == ['3.9']
        assert context['name'] == ListAPIView.__name__
        assert isinstance(context['ancestors'], (list, tuple))
        assert isinstance(context['direct_ancestors'], (list, tuple))
        assert isinstance(context['attributes'], Attributes)
        assert isinstance(context['methods'], Attributes)
        assert context['this_klass'] == ListAPIView
        assert isinstance(context['children'], list)
        assert context['this_module'] == ListAPIView.__module__
        assert isinstance(context['unavailable_methods'], set)