def testDeserializeEatsErrors(self):
"""Deserialization detects wrongly embedded structures."""
# Can deserialize a valid serialized Place just fine.
place = Place(name="avi's place",
location=Point(x=1.0, y=1.2))
serialized = SerializeThriftMsg(place)
DeserializeThriftMsg(Place(), serialized)
# If we much up the type of the required Point field...
# We can STILL serialize and deserialize
place.location = Review(rating=4, text="this place is pretty great")
serialized = SerializeThriftMsg(place)
deserialized = DeserializeThriftMsg(Place(), serialized)
# Thrift found an invalid location and simply failed to report it.
self.assertRaises(TProtocolException, deserialized.location.validate)
# Instead, it just set all the fields to None
self.assertIsNone(deserialized.location.x)
self.assertIsNone(deserialized.location.y)
# If we muck up the type of the review, the same thing happens.
place.review = Point(x=3.4, y=1.1)
serialized = SerializeThriftMsg(place)
deserialized = DeserializeThriftMsg(Place(), serialized)
# Thrift found an invalid location and simply failed to report it.
self.assertRaises(TProtocolException, deserialized.review.validate)
# Instead, it just set all the fields to None
self.assertIsNone(deserialized.review.rating)
self.assertIsNone(deserialized.review.text)
def testSerializationChecksSomeTypes(self):
"""When using a simple structure like Point, everything works fine."""
# Point has required fields. Serialization fails if you don't set them.
point = Point()
self.assertRaises(TProtocolException, SerializeThriftMsg, point)
# Of course, serialization works when you set fields correctly.
point.x, point.y = 1.0, 1.2
SerializeThriftMsg(point)
# Point.x is a double. If it's a string then you can't serialize.
point.x = "asdf"
self.assertRaises(Exception, SerializeThriftMsg, point)
# Same is true for point.y
point.y = "also a string"
self.assertRaises(Exception, SerializeThriftMsg, point)
def testSerializationDoesntCheckStructs(self):
"""However, there are some oddities when you embed structures."""
# Can't serialize empty place as it has empty fields.
place = Place()
self.assertRaises(TProtocolException, SerializeThriftMsg, place)
# If we set the required fields, everything is fine.
place.name = "avi's place"
place.location = Point(x=1.0, y=1.2)
SerializeThriftMsg(place)
# HOWEVER, we can set the Review struct to a Point and...
place.review = Point(x=3.4, y=1.1)
SerializeThriftMsg(place)
# SIMILARLY, we can set the Point to a Review
place.location = Review(rating=4, text="this place is pretty great")
SerializeThriftMsg(place)
def testSimpleCase(self):
"""When using a simple structure like Point, everything works fine."""
# point.x and point.y are required and unset
point = Point()
self.assertRaises(Exception, point.validate)
# point.y is required and unset
point.x = 1.0
self.assertRaises(Exception, point.validate)
# both point.x and point.y are set, so point is valid.
point.y = 1.2
point.validate()
# But here's something weird you should know about:
# point.x is supposed to be a double, but if you set
# to a string it will still validate
point.x = 'this is not a double'
point.validate()
def testValidateOnComplexStructure(self):
"""Built-in validate() makes less sense on a complex structure."""
place = Place()
self.assertRaises(Exception, place.validate)
# Name is insufficient - location is required as well.
place.name = 'avis place'
self.assertRaises(Exception, place.validate)
# Location and name are the only required fields.
# However, validate doesn't descend into the Point
# and check that it too is valid. So I can set
# place.location to an empty point and validate is
# satisfied.
place.location = Point()
place.validate()
# Worse yet, I can make it a string and that is also no problem.
place.location = 'this is not a point'
place.validate()
