Skip to content
This repository has been archived by the owner on Jan 11, 2021. It is now read-only.

Add basic UI settings #519

Merged
merged 5 commits into from
Aug 15, 2016
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add tests for UI settings.
  • Loading branch information
marcgibbons committed Aug 15, 2016
commit c5079ff77b83027bcc9a89ffdd26211bf6f3a511
8 changes: 4 additions & 4 deletions rest_framework_swagger/renderers.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ def set_context(self, renderer_context):
swagger_settings.USE_SESSION_AUTH
renderer_context.update(self.get_auth_urls(renderer_context))

renderer_context['drs_settings'] = self.get_ui_settings()
renderer_context['drs_settings'] = json.dumps(self.get_ui_settings())

def get_auth_urls(self, renderer_context):
return {
Expand All @@ -90,7 +90,7 @@ def add_next_to_url(self, url, request):
return '%s?next=%s' % (resolve_url(url), request.path)

def get_ui_settings(self):
drs_settings = {
data = {
'apisSorter': swagger_settings.APIS_SORTER,
'docExpansion': swagger_settings.DOC_EXPANSION,
'jsonEditor': swagger_settings.JSON_EDITOR,
Expand All @@ -99,6 +99,6 @@ def get_ui_settings(self):
'supportedSubmitMethods': swagger_settings.SUPPORTED_SUBMIT_METHODS
}
if swagger_settings.VALIDATOR_URL != '':
drs_settings['validatorUrl'] = swagger_settings.VALIDATOR_URL
data['validatorUrl'] = swagger_settings.VALIDATOR_URL

return json.dumps(drs_settings)
return data
44 changes: 44 additions & 0 deletions tests/renderers/test_swagger.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
from unittest import TestCase

import simplejson as json
from rest_framework_swagger.renderers import SwaggerUIRenderer

from ..compat.mock import patch, MagicMock
Expand Down Expand Up @@ -61,6 +63,16 @@ def test_set_context_sets_auth_urls(self):

self.assertDictContainsSubset(urls, self.renderer_context)

def test_set_context_sets_ui_esttings(self):
with patch.object(self.sut, 'get_ui_settings') as mock:
mock.return_value = {'foo': 'bar'}
self.sut.set_context(self.renderer_context)

self.assertEqual(
json.dumps(mock.return_value),
self.renderer_context['drs_settings']
)

def test_get_auth_urls(self):
key = 'LOGIN_URL'
value = '/foo?next=bar'
Expand All @@ -82,6 +94,38 @@ def test_get_auth_url_settings(self):
self.sut.get_auth_url_settings()
)

def test_get_ui_settings_without_validator_url(self):
expected = {
'apisSorter': self.swagger_settings.APIS_SORTER,
'docExpansion': self.swagger_settings.DOC_EXPANSION,
'jsonEditor': self.swagger_settings.JSON_EDITOR,
'operationsSorter': self.swagger_settings.OPERATIONS_SORTER,
'showRequestHeaders': self.swagger_settings.SHOW_REQUEST_HEADERS,
'supportedSubmitMethods':
self.swagger_settings.SUPPORTED_SUBMIT_METHODS,
'validatorUrl': self.swagger_settings.VALIDATOR_URL
}
result = self.sut.get_ui_settings()

self.assertDictEqual(expected, result)

def test_validator_url_none_when_set(self):
self.swagger_settings.VALIDATOR_URL = None
result = self.sut.get_ui_settings()

self.assertDictContainsSubset({'validatorUrl': None}, result)

def test_validator_url_not_present_when_empty_string(self):
"""
Given the validator URL is unspecified (empty string, not null),
the validatorUrl should not be present. SwaggerUI will use
swagger.io as the default.
"""
self.swagger_settings.VALIDATOR_URL = ''
result = self.sut.get_ui_settings()

self.assertNotIn('validatorUrl', result)

@patch('rest_framework_swagger.renderers.resolve_url')
def test_add_next_to_url(self, mock):
request = MagicMock(path='industries')
Expand Down