Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 1 | """Serializers for Crashreport-related models.""" |
Borjan Tchakaloff | 340b6f3 | 2018-03-01 15:23:43 +0400 | [diff] [blame] | 2 | from django.utils import timezone |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 3 | from django.core.exceptions import ObjectDoesNotExist |
Mitja Nikolaus | fd452f8 | 2018-11-07 11:53:59 +0100 | [diff] [blame] | 4 | from django.utils.dateparse import parse_datetime |
Dirk Vogt | d134521 | 2016-09-14 14:31:45 +0200 | [diff] [blame] | 5 | from rest_framework import serializers |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 6 | from rest_framework.exceptions import NotFound |
Dirk Vogt | d134521 | 2016-09-14 14:31:45 +0200 | [diff] [blame] | 7 | from rest_framework import permissions |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 8 | |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 9 | from crashreports.models import Crashreport, Device, HeartBeat, LogFile |
Dirk Vogt | 67eb148 | 2016-10-13 12:42:56 +0200 | [diff] [blame] | 10 | from crashreports.permissions import user_is_hiccup_staff |
| 11 | |
| 12 | |
| 13 | class PrivateField(serializers.ReadOnlyField): |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 14 | """Class for making a field private. |
| 15 | |
| 16 | The private attribute can then only be read by Hiccup staff members |
| 17 | """ |
Dirk Vogt | 67eb148 | 2016-10-13 12:42:56 +0200 | [diff] [blame] | 18 | |
| 19 | def get_attribute(self, instance): |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 20 | """Get the private attribute. |
| 21 | |
Dirk Vogt | 67eb148 | 2016-10-13 12:42:56 +0200 | [diff] [blame] | 22 | Given the *outgoing* object instance, return the primitive value |
| 23 | that should be used for this field. |
| 24 | """ |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 25 | if user_is_hiccup_staff(self.context["request"].user): |
Dirk Vogt | 67eb148 | 2016-10-13 12:42:56 +0200 | [diff] [blame] | 26 | return super(PrivateField, self).get_attribute(instance) |
| 27 | return -1 |
Dirk Vogt | d134521 | 2016-09-14 14:31:45 +0200 | [diff] [blame] | 28 | |
Mitja Nikolaus | 2189b5e | 2018-08-31 10:50:55 +0200 | [diff] [blame] | 29 | def to_internal_value(self, data): |
| 30 | """Transform the *incoming* primitive data into a native value. |
| 31 | |
| 32 | Since PrivateField is read only, there will never be any incoming data, |
| 33 | thus we raise NotImplementedError. |
| 34 | """ |
| 35 | raise NotImplementedError() |
| 36 | |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 37 | |
Dirk Vogt | d134521 | 2016-09-14 14:31:45 +0200 | [diff] [blame] | 38 | class CrashReportSerializer(serializers.ModelSerializer): |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 39 | """Serializer for CrashReport instances.""" |
| 40 | |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 41 | permission_classes = (permissions.AllowAny,) |
Dirk Vogt | 83107df | 2017-05-02 12:04:19 +0200 | [diff] [blame] | 42 | logfiles = serializers.HyperlinkedRelatedField( |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 43 | read_only=True, many=True, view_name="api_v1_logfiles_by_id" |
| 44 | ) |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 45 | uuid = serializers.CharField(max_length=64) |
Dirk Vogt | 67eb148 | 2016-10-13 12:42:56 +0200 | [diff] [blame] | 46 | id = PrivateField() |
| 47 | device_local_id = serializers.IntegerField(required=False) |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 48 | date = serializers.DateTimeField(default_timezone=timezone.utc) |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 49 | |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 50 | class Meta: # noqa: D106 |
Dirk Vogt | d134521 | 2016-09-14 14:31:45 +0200 | [diff] [blame] | 51 | model = Crashreport |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 52 | exclude = ("device",) |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 53 | |
| 54 | def create(self, validated_data): |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 55 | """Create a crashreport. |
| 56 | |
| 57 | Args: |
| 58 | validated_data: Data of the crashreport, excluding the device |
| 59 | |
| 60 | Returns: The created report |
| 61 | |
| 62 | """ |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 63 | try: |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 64 | device = Device.objects.get(uuid=validated_data["uuid"]) |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 65 | except ObjectDoesNotExist: |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 66 | raise NotFound(detail="uuid does not exist") |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 67 | validated_data.pop("uuid", None) |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 68 | report = Crashreport(**validated_data) |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 69 | report.device = device |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 70 | report.save() |
| 71 | return report |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 72 | |
| 73 | |
| 74 | class HeartBeatSerializer(serializers.ModelSerializer): |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 75 | """Serializer for HeartBeat instances.""" |
| 76 | |
Dirk Vogt | 3663569 | 2016-10-17 12:19:10 +0200 | [diff] [blame] | 77 | permission_classes = (permissions.IsAuthenticated,) |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 78 | uuid = serializers.CharField(max_length=64) |
Dirk Vogt | 67eb148 | 2016-10-13 12:42:56 +0200 | [diff] [blame] | 79 | id = PrivateField() |
| 80 | device_local_id = serializers.IntegerField(required=False) |
Mitja Nikolaus | fd452f8 | 2018-11-07 11:53:59 +0100 | [diff] [blame] | 81 | date = serializers.DateField() |
Dirk Vogt | e178488 | 2016-10-13 16:09:38 +0200 | [diff] [blame] | 82 | |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 83 | class Meta: # noqa: D106 |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 84 | model = HeartBeat |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 85 | exclude = ("device",) |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 86 | |
| 87 | def create(self, validated_data): |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 88 | """Create a heartbeat report. |
| 89 | |
| 90 | Args: |
| 91 | validated_data: Data of the heartbeat, excluding the device |
| 92 | |
| 93 | Returns: The created heartbeat |
| 94 | |
| 95 | """ |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 96 | try: |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 97 | device = Device.objects.get(uuid=validated_data["uuid"]) |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 98 | except ObjectDoesNotExist: |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 99 | raise NotFound(detail="uuid does not exist") |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 100 | validated_data.pop("uuid", None) |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 101 | heartbeat = HeartBeat(**validated_data) |
| 102 | heartbeat.device = device |
| 103 | heartbeat.save() |
| 104 | return heartbeat |
| 105 | |
Mitja Nikolaus | fd452f8 | 2018-11-07 11:53:59 +0100 | [diff] [blame] | 106 | def to_internal_value(self, data): |
| 107 | """Parse serialized heartbeat representations. |
| 108 | |
| 109 | Incoming 'date' values that are datetime values (including time) are |
| 110 | changed so that only the date part of the value is deserialized. |
| 111 | Initially, the date was a datetime field and Hiccup clients can still |
| 112 | send datetime values. |
| 113 | """ |
| 114 | datetime = parse_datetime(data["date"]) |
| 115 | if datetime: |
| 116 | updated_data = data.copy() |
| 117 | updated_data["date"] = datetime.date().isoformat() |
| 118 | data = updated_data |
| 119 | |
| 120 | return super(HeartBeatSerializer, self).to_internal_value(data) |
| 121 | |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 122 | |
Dirk Vogt | 83107df | 2017-05-02 12:04:19 +0200 | [diff] [blame] | 123 | class LogFileSerializer(serializers.ModelSerializer): |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 124 | """Serializer for LogFile instances.""" |
| 125 | |
Dirk Vogt | 83107df | 2017-05-02 12:04:19 +0200 | [diff] [blame] | 126 | permission_classes = (permissions.IsAdminUser,) |
| 127 | |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 128 | class Meta: # noqa: D106 |
Dirk Vogt | 83107df | 2017-05-02 12:04:19 +0200 | [diff] [blame] | 129 | model = LogFile |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 130 | fields = "__all__" |
Dirk Vogt | 83107df | 2017-05-02 12:04:19 +0200 | [diff] [blame] | 131 | |
| 132 | |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 133 | class DeviceSerializer(serializers.ModelSerializer): |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 134 | """Serializer for Device instances.""" |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 135 | |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 136 | permission_classes = (permissions.IsAdminUser,) |
| 137 | board_date = serializers.DateTimeField(default_timezone=timezone.utc) |
| 138 | last_heartbeat = serializers.DateTimeField(default_timezone=timezone.utc) |
| 139 | |
| 140 | class Meta: # noqa: D106 |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 141 | model = Device |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 142 | fields = "__all__" |
Franz-Xaver Geiger | d994335 | 2018-02-27 14:26:41 +0100 | [diff] [blame] | 143 | |
| 144 | |
| 145 | class DeviceCreateSerializer(DeviceSerializer): |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 146 | """Serializer for creating Device instances.""" |
Franz-Xaver Geiger | d994335 | 2018-02-27 14:26:41 +0100 | [diff] [blame] | 147 | |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 148 | class Meta: # noqa: D106 |
Franz-Xaver Geiger | d994335 | 2018-02-27 14:26:41 +0100 | [diff] [blame] | 149 | model = Device |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 150 | fields = ("board_date", "chipset") |
Franz-Xaver Geiger | d994335 | 2018-02-27 14:26:41 +0100 | [diff] [blame] | 151 | extra_kwargs = { |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame] | 152 | "board_date": {"required": True}, |
| 153 | "chipset": {"required": True}, |
Franz-Xaver Geiger | d994335 | 2018-02-27 14:26:41 +0100 | [diff] [blame] | 154 | } |