""" General serializer field tests. """ from __future__ import unicode_literals import datetime from django.db import models from django.test import TestCase from django.core import validators from rest_framework import serializers class TimestampedModel(models.Model): added = models.DateTimeField(auto_now_add=True) updated = models.DateTimeField(auto_now=True) class CharPrimaryKeyModel(models.Model): id = models.CharField(max_length=20, primary_key=True) class TimestampedModelSerializer(serializers.ModelSerializer): class Meta: model = TimestampedModel class CharPrimaryKeyModelSerializer(serializers.ModelSerializer): class Meta: model = CharPrimaryKeyModel class TimeFieldModel(models.Model): clock = models.TimeField() class TimeFieldModelSerializer(serializers.ModelSerializer): class Meta: model = TimeFieldModel class BasicFieldTests(TestCase): def test_auto_now_fields_read_only(self): """ auto_now and auto_now_add fields should be read_only by default. """ serializer = TimestampedModelSerializer() self.assertEquals(serializer.fields['added'].read_only, True) def test_auto_pk_fields_read_only(self): """ AutoField fields should be read_only by default. """ serializer = TimestampedModelSerializer() self.assertEquals(serializer.fields['id'].read_only, True) def test_non_auto_pk_fields_not_read_only(self): """ PK fields other than AutoField fields should not be read_only by default. """ serializer = CharPrimaryKeyModelSerializer() self.assertEquals(serializer.fields['id'].read_only, False) class DateFieldTest(TestCase): """ Tests for the DateFieldTest from_native() and to_native() behavior """ def test_from_native_string(self): """ Make sure from_native() accepts default iso input formats. """ f = serializers.DateField() result_1 = f.from_native('1984-07-31') self.assertEqual(datetime.date(1984, 7, 31), result_1) def test_from_native_datetime_date(self): """ Make sure from_native() accepts a datetime.date instance. """ f = serializers.DateField() result_1 = f.from_native(datetime.date(1984, 7, 31)) self.assertEqual(result_1, datetime.date(1984, 7, 31)) def test_from_native_custom_format(self): """ Make sure from_native() accepts custom input formats. """ f = serializers.DateField(input_formats=['%Y -- %d']) result = f.from_native('1984 -- 31') self.assertEqual(datetime.date(1984, 1, 31), result) def test_from_native_invalid_default_on_custom_format(self): """ Make sure from_native() don't accept default formats if custom format is preset """ f = serializers.DateField(input_formats=['%Y -- %d']) try: f.from_native('1984-07-31') except validators.ValidationError as e: self.assertEqual(e.messages, ["Date has wrong format. Use one of these formats instead: YYYY -- DD"]) else: self.fail("ValidationError was not properly raised") def test_from_native_empty(self): """ Make sure from_native() returns None on empty param. """ f = serializers.DateField() result = f.from_native('') self.assertEqual(result, None) def test_from_native_invalid_date(self): """ Make sure from_native() raises a ValidationError on passing an invalid date. """ f = serializers.DateField() try: f.from_native('1984-13-31') except validators.ValidationError as e: self.assertEqual(e.messages, ["Date has wrong format. Use one of these formats instead: YYYY-MM-DD"]) else: self.fail("ValidationError was not properly raised") def test_from_native_invalid_format(self): """ Make sure from_native() raises a ValidationError on passing an invalid format. """ f = serializers.DateField() try: f.from_native('1984 -- 31') except validators.ValidationError as e: self.assertEqual(e.messages, ["Date has wrong format. Use one of these formats instead: YYYY-MM-DD"]) else: self.fail("ValidationError was not properly raised") def test_to_native(self): """ Make sure to_native() returns isoformat as default. """ f = serializers.DateField() result_1 = f.to_native(datetime.date(1984, 7, 31)) self.assertEqual('1984-07-31', result_1) def test_to_native_custom_format(self): """ Make sure to_native() returns correct custom format. """ f = serializers.DateField(output_format="%Y - %m.%d") result_1 = f.to_native(datetime.date(1984, 7, 31)) self.assertEqual('1984 - 07.31', result_1) class DateTimeFieldTest(TestCase): """ Tests for the DateTimeField from_native() and to_native() behavior """ def test_from_native_string(self): """ Make sure from_native() accepts default iso input formats. """ f = serializers.DateTimeField() result_1 = f.from_native('1984-07-31') result_2 = f.from_native('1984-07-31 04:31') result_3 = f.from_native('1984-07-31 04:31:59') result_4 = f.from_native('1984-07-31 04:31:59.000200') self.assertEqual(datetime.datetime(1984, 7, 31), result_1) self.assertEqual(datetime.datetime(1984, 7, 31, 4, 31), result_2) self.assertEqual(datetime.datetime(1984, 7, 31, 4, 31, 59), result_3) self.assertEqual(datetime.datetime(1984, 7, 31, 4, 31, 59, 200), result_4) def test_from_native_datetime_datetime(self): """ Make sure from_native() accepts a datetime.datetime instance. """ f = serializers.DateTimeField() result_1 = f.from_native(datetime.datetime(1984, 7, 31)) result_2 = f.from_native(datetime.datetime(1984, 7, 31, 4, 31)) result_3 = f.from_native(datetime.datetime(1984, 7, 31, 4, 31, 59)) result_4 = f.from_native(datetime.datetime(1984, 7, 31, 4, 31, 59, 200)) self.assertEqual(result_1, datetime.datetime(1984, 7, 31)) self.assertEqual(result_2, datetime.datetime(1984, 7, 31, 4, 31)) self.assertEqual(result_3, datetime.datetime(1984, 7, 31, 4, 31, 59)) self.assertEqual(result_4, datetime.datetime(1984, 7, 31, 4, 31, 59, 200)) def test_from_native_custom_format(self): """ Make sure from_native() accepts custom input formats. """ f = serializers.DateTimeField(input_formats=['%Y -- %H:%M']) result = f.from_native('1984 -- 04:59') self.assertEqual(datetime.datetime(1984, 1, 1, 4, 59), result) def test_from_native_invalid_default_on_custom_format(self): """ Make sure from_native() don't accept default formats if custom format is preset """ f = serializers.DateTimeField(input_formats=['%Y -- %H:%M']) try: f.from_native('1984-07-31 04:31:59') except validators.ValidationError as e: self.assertEqual(e.messages, ["Datetime has wrong format. Use one of these formats instead: YYYY -- HH:MM"]) else: self.fail("ValidationError was not properly raised") def test_from_native_empty(self): """ Make sure from_native() returns None on empty param. """ f = serializers.DateTimeField() result = f.from_native('') self.assertEqual(result, None) def test_from_native_invalid_datetime(self): """ Make sure from_native() raises a ValidationError on passing an invalid datetime. """ f = serializers.DateTimeField() try: f.from_native('04:61:59') except validators.ValidationError as e: self.assertEqual(e.messages, ["Datetime has wrong format. Use one of these formats instead: " "YYYY-MM-DD; YYYY-MM-DD HH:MM; YYYY-MM-DD HH:MM:SS; " "YYYY-MM-DD HH:MM:SS.uuuuuu"]) else: self.fail("ValidationError was not properly raised") def test_from_native_invalid_format(self): """ Make sure from_native() raises a ValidationError on passing an invalid format. """ f = serializers.DateTimeField() try: f.from_native('04 -- 31') except validators.ValidationError as e: self.assertEqual(e.messages, ["Datetime has wrong format. Use one of these formats instead: " "YYYY-MM-DD; YYYY-MM-DD HH:MM; YYYY-MM-DD HH:MM:SS; " "YYYY-MM-DD HH:MM:SS.uuuuuu"]) else: self.fail("ValidationError was not properly raised") def test_to_native(self): """ Make sure to_native() returns isoformat as default. """ f = serializers.DateTimeField() result_1 = f.to_native(datetime.datetime(1984, 7, 31)) result_2 = f.to_native(datetime.datetime(1984, 7, 31, 4, 31)) result_3 = f.to_native(datetime.datetime(1984, 7, 31, 4, 31, 59)) result_4 = f.to_native(datetime.datetime(1984, 7, 31, 4, 31, 59, 200)) self.assertEqual('1984-07-31T00:00:00', result_1) self.assertEqual('1984-07-31T04:31:00', result_2) self.assertEqual('1984-07-31T04:31:59', result_3) self.assertEqual('1984-07-31T04:31:59.000200', result_4) def test_to_native_custom_format(self): """ Make sure to_native() returns correct custom format. """ f = serializers.DateTimeField(output_format="%Y - %H:%M") result_1 = f.to_native(datetime.datetime(1984, 7, 31)) result_2 = f.to_native(datetime.datetime(1984, 7, 31, 4, 31)) result_3 = f.to_native(datetime.datetime(1984, 7, 31, 4, 31, 59)) result_4 = f.to_native(datetime.datetime(1984, 7, 31, 4, 31, 59, 200)) self.assertEqual('1984 - 00:00', result_1) self.assertEqual('1984 - 04:31', result_2) self.assertEqual('1984 - 04:31', result_3) self.assertEqual('1984 - 04:31', result_4) class TimeFieldTest(TestCase): """ Tests for the TimeField from_native() and to_native() behavior """ def test_from_native_string(self): """ Make sure from_native() accepts default iso input formats. """ f = serializers.TimeField() result_1 = f.from_native('04:31') result_2 = f.from_native('04:31:59') result_3 = f.from_native('04:31:59.000200') self.assertEqual(datetime.time(4, 31), result_1) self.assertEqual(datetime.time(4, 31, 59), result_2) self.assertEqual(datetime.time(4, 31, 59, 200), result_3) def test_from_native_datetime_time(self): """ Make sure from_native() accepts a datetime.time instance. """ f = serializers.TimeField() result_1 = f.from_native(datetime.time(4, 31)) result_2 = f.from_native(datetime.time(4, 31, 59)) result_3 = f.from_native(datetime.time(4, 31, 59, 200)) self.assertEqual(result_1, datetime.time(4, 31)) self.assertEqual(result_2, datetime.time(4, 31, 59)) self.assertEqual(result_3, datetime.time(4, 31, 59, 200)) def test_from_native_custom_format(self): """ Make sure from_native() accepts custom input formats. """ f = serializers.TimeField(input_formats=['%H -- %M']) result = f.from_native('04 -- 31') self.assertEqual(datetime.time(4, 31), result) def test_from_native_invalid_default_on_custom_format(self): """ Make sure from_native() don't accept default formats if custom format is preset """ f = serializers.TimeField(input_formats=['%H -- %M']) try: f.from_native('04:31:59') except validators.ValidationError as e: self.assertEqual(e.messages, ["Time has wrong format. Use one of these formats instead: HH -- MM"]) else: self.fail("ValidationError was not properly raised") def test_from_native_empty(self): """ Make sure from_native() returns None on empty param. """ f = serializers.TimeField() result = f.from_native('') self.assertEqual(result, None) def test_from_native_invalid_time(self): """ Make sure from_native() raises a ValidationError on passing an invalid time. """ f = serializers.TimeField() try: f.from_native('04:61:59') except validators.ValidationError as e: self.assertEqual(e.messages, ["Time has wrong format. Use one of these formats instead: " "HH:MM; HH:MM:SS; HH:MM:SS.uuuuuu"]) else: self.fail("ValidationError was not properly raised") def test_from_native_invalid_format(self): """ Make sure from_native() raises a ValidationError on passing an invalid format. """ f = serializers.TimeField() try: f.from_native('04 -- 31') except validators.ValidationError as e: self.assertEqual(e.messages, ["Time has wrong format. Use one of these formats instead: " "HH:MM; HH:MM:SS; HH:MM:SS.uuuuuu"]) else: self.fail("ValidationError was not properly raised") def test_to_native(self): """ Make sure to_native() returns isoformat as default. """ f = serializers.TimeField() result_1 = f.to_native(datetime.time(4, 31)) result_2 = f.to_native(datetime.time(4, 31, 59)) result_3 = f.to_native(datetime.time(4, 31, 59, 200)) self.assertEqual('04:31:00', result_1) self.assertEqual('04:31:59', result_2) self.assertEqual('04:31:59.000200', result_3) def test_to_native_custom_format(self): """ Make sure to_native() returns correct custom format. """ f = serializers.TimeField(output_format="%H - %S [%f]") result_1 = f.to_native(datetime.time(4, 31)) result_2 = f.to_native(datetime.time(4, 31, 59)) result_3 = f.to_native(datetime.time(4, 31, 59, 200)) self.assertEqual('04 - 00 [000000]', result_1) self.assertEqual('04 - 59 [000000]', result_2) self.assertEqual('04 - 59 [000200]', result_3)