/usr/share/pyshared/lazr/restful/tests/test_etag.py is in python-lazr.restful 0.19.3-0ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 | # Copyright 2008 Canonical Ltd. All rights reserved.
"""Tests for ETag generation."""
__metaclass__ = type
import unittest
from zope.component import provideUtility
from lazr.restful.interfaces import IWebServiceConfiguration
from lazr.restful.testing.helpers import TestWebServiceConfiguration
from lazr.restful.testing.webservice import create_web_service_request
from lazr.restful._resource import (
EntryFieldResource,
EntryResource,
HTTPResource,
ServiceRootResource,
make_entry_etag_cores,
)
class TestEntryResourceETags(unittest.TestCase):
# The EntryResource uses the field values that can be written or might
# othwerise change as the basis for its ETags. The make_entry_etag_cores
# function is passed the data about the fields and returns the read and
# write cores.
def test_no_field_details(self):
# If make_entry_etag_cores is given no field details (because no
# fields exist), the resulting cores empty strings.
self.assertEquals(make_entry_etag_cores([]), ['', ''])
def test_writable_fields(self):
# If there are writable fields, their values are incorporated into the
# writable portion of the cores.
field_details = [
('first_field',
{'writable': True,
'value': 'first'}),
('second_field',
{'writable': True,
'value': 'second'}),
]
self.assertEquals(
make_entry_etag_cores(field_details), ['', 'first\0second'])
def test_unchanging_fields(self):
# If there are fields that are not writable their values are still
# reflected in the generated cores because we want and addition or
# removal of read-only fields to trigger a new ETag.
field_details = [
('first_field',
{'writable': False,
'value': 'the value'}),
]
self.assertEquals(
make_entry_etag_cores(field_details),
['the value', ''])
def test_combinations_of_fields(self):
# If there are a combination of writable, changable, and unchanable
# fields, their values are reflected in the resulting cores.
field_details = [
('first_writable',
{'writable': True,
'value': 'first-writable'}),
('second_writable',
{'writable': True,
'value': 'second-writable'}),
('first_non_writable',
{'writable': False,
'value': 'first-not-writable'}),
('second_non_writable',
{'writable': False,
'value': 'second-not-writable'}),
]
self.assertEquals(
make_entry_etag_cores(field_details),
['first-not-writable\x00second-not-writable',
'first-writable\x00second-writable'])
class TestHTTPResourceETags(unittest.TestCase):
def test_getETag_is_a_noop(self):
# The HTTPResource class implements a do-nothing _getETagCores in order to
# be conservative (because it's not aware of the nature of all possible
# subclasses).
self.assertEquals(HTTPResource(None, None)._getETagCores(), None)
class TestHTTPResourceETags(unittest.TestCase):
def test_getETag_is_a_noop(self):
# The HTTPResource class implements a do-nothing _getETagCores in order to
# be conservative (because it's not aware of the nature of all possible
# subclasses).
self.assertEquals(HTTPResource(None, None)._getETagCores(), None)
class FauxEntryField:
entry = None
name = 'field_name'
field = None
class EntryFieldResourceTests(unittest.TestCase):
# Tests for ETags of EntryFieldResource objects.
# Because the ETag generation only takes into account the field value and
# the web service revision number (and not whether the field is read-write
# or read-only) these tests don't mention the read-write/read-only nature
# of the field in question.
def setUp(self):
self.config = TestWebServiceConfiguration()
provideUtility(self.config, IWebServiceConfiguration)
self.resource = EntryFieldResource(FauxEntryField(), None)
def set_field_value(self, value):
"""Set the value of the fake field the EntryFieldResource references.
"""
self.resource._unmarshalled_field_cache['field_name'] = (
'field_name', value)
# We have to clear the etag cache for a new value to be generated.
# XXX benji 2010-09-30 [bug=652459] Does this mean there is an error
# condition that occurs when something other than applyChanges (which
# invalidates the cache) modifies a field's value?
self.resource.etags_by_media_type = {}
def test_cores_change_with_revno(self):
# The ETag cores should change if the revision (not the version) of
# the web service change.
self.set_field_value('this is the field value')
# Find the cores generated with a given revision...
self.config.code_revision = u'42'
first_cores = self.resource._getETagCores(self.resource.JSON_TYPE)
# ...find the cores generated with a different revision.
self.config.code_revision = u'99'
second_cores = self.resource._getETagCores(self.resource.JSON_TYPE)
# The cores should be different.
self.assertNotEqual(first_cores, second_cores)
# In particular, the read core should be the same between the two, but
# the write core should be different.
self.assertEqual(first_cores[1], second_cores[1])
self.assertNotEqual(first_cores[0], second_cores[0])
def test_cores_change_with_value(self):
# The ETag cores should change if the value of the field change.
# Find the cores generated with a given value...
self.set_field_value('first value')
first_cores = self.resource._getETagCores(self.resource.JSON_TYPE)
# ...find the cores generated with a different value.
self.set_field_value('second value')
second_cores = self.resource._getETagCores(self.resource.JSON_TYPE)
# The cores should be different.
self.assertNotEqual(first_cores, second_cores)
# In particular, the read core should be different between the two,
# but the write core should be the same.
self.assertNotEqual(first_cores[1], second_cores[1])
self.assertEqual(first_cores[0], second_cores[0])
class ServiceRootResourceTests(unittest.TestCase):
# Tests for ETags of EntryFieldResource objects.
def setUp(self):
self.config = TestWebServiceConfiguration()
provideUtility(self.config, IWebServiceConfiguration)
self.resource = ServiceRootResource()
def test_cores_change_with_revno(self):
# The ETag core should change if the revision (not the version) of the
# web service change.
# Find the cores generated with a given revision...
self.config.code_revision = u'42'
first_cores = self.resource._getETagCores(self.resource.JSON_TYPE)
# ...find the cores generated with a different revision.
self.config.code_revision = u'99'
second_cores = self.resource._getETagCores(self.resource.JSON_TYPE)
# The cores should be different.
self.assertNotEqual(first_cores, second_cores)
class TestableHTTPResource(HTTPResource):
"""A HTTPResource that lest us set the ETags from the outside."""
def _parseETags(self, *args):
return self.incoming_etags
def getETag(self, *args):
return self.existing_etag
class TestConditionalGet(unittest.TestCase):
def setUp(self):
self.config = TestWebServiceConfiguration()
provideUtility(self.config, IWebServiceConfiguration)
self.request = create_web_service_request('/1.0')
self.resource = TestableHTTPResource(None, self.request)
def test_etags_are_the_same(self):
# If one of the ETags present in an incoming request is the same as
# the ETag that represents the current object's state, then
# a conditional GET should return "Not Modified" (304).
self.resource.incoming_etags = ['1', '2', '3']
self.resource.existing_etag = '2'
self.assertEquals(self.resource.handleConditionalGET(), None)
self.assertEquals(self.request.response.getStatus(), 304)
def test_etags_differ(self):
# If none of the ETags present in an incoming request is the same as
# the ETag that represents the current object's state, then a
# conditional GET should result in a new representation of the object
# being returned.
self.resource.incoming_etags = ['1', '2', '3']
self.resource.existing_etag = '99'
self.assertNotEquals(self.resource.handleConditionalGET(), None)
class TestConditionalWrite(unittest.TestCase):
def setUp(self):
self.config = TestWebServiceConfiguration()
provideUtility(self.config, IWebServiceConfiguration)
self.request = create_web_service_request('/1.0')
self.resource = TestableHTTPResource(None, self.request)
def test_etags_are_the_same(self):
# If one of the ETags present in an incoming request is the same as
# the ETag that represents the current object's state, then
# the write should be applied.
self.resource.incoming_etags = ['1', '2', '3']
self.resource.existing_etag = '2'
self.assertNotEquals(self.resource.handleConditionalWrite(), None)
def test_etags_differ(self):
# If one of the ETags present in an incoming request is the same as
# the ETag that represents the current object's state, then
# the write should fail.
self.resource.incoming_etags = ['1', '2', '3']
self.resource.existing_etag = '99'
self.assertEquals(self.resource.handleConditionalWrite(), None)
self.assertEquals(self.request.response.getStatus(), 412)
|