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 |
Dirk Vogt | d134521 | 2016-09-14 14:31:45 +0200 | [diff] [blame] | 4 | from rest_framework import serializers |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 5 | from rest_framework.exceptions import NotFound |
Dirk Vogt | d134521 | 2016-09-14 14:31:45 +0200 | [diff] [blame] | 6 | from rest_framework import permissions |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 7 | |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame^] | 8 | from crashreports.models import Crashreport, Device, HeartBeat, LogFile |
Dirk Vogt | 67eb148 | 2016-10-13 12:42:56 +0200 | [diff] [blame] | 9 | from crashreports.permissions import user_is_hiccup_staff |
| 10 | |
| 11 | |
| 12 | class PrivateField(serializers.ReadOnlyField): |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 13 | """Class for making a field private. |
| 14 | |
| 15 | The private attribute can then only be read by Hiccup staff members |
| 16 | """ |
Dirk Vogt | 67eb148 | 2016-10-13 12:42:56 +0200 | [diff] [blame] | 17 | |
| 18 | def get_attribute(self, instance): |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 19 | """Get the private attribute. |
| 20 | |
Dirk Vogt | 67eb148 | 2016-10-13 12:42:56 +0200 | [diff] [blame] | 21 | Given the *outgoing* object instance, return the primitive value |
| 22 | that should be used for this field. |
| 23 | """ |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame^] | 24 | if user_is_hiccup_staff(self.context["request"].user): |
Dirk Vogt | 67eb148 | 2016-10-13 12:42:56 +0200 | [diff] [blame] | 25 | return super(PrivateField, self).get_attribute(instance) |
| 26 | return -1 |
Dirk Vogt | d134521 | 2016-09-14 14:31:45 +0200 | [diff] [blame] | 27 | |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 28 | |
Dirk Vogt | d134521 | 2016-09-14 14:31:45 +0200 | [diff] [blame] | 29 | class CrashReportSerializer(serializers.ModelSerializer): |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 30 | """Serializer for CrashReport instances.""" |
| 31 | |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 32 | permission_classes = (permissions.AllowAny,) |
Dirk Vogt | 83107df | 2017-05-02 12:04:19 +0200 | [diff] [blame] | 33 | logfiles = serializers.HyperlinkedRelatedField( |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame^] | 34 | read_only=True, many=True, view_name="api_v1_logfiles_by_id" |
| 35 | ) |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 36 | uuid = serializers.CharField(max_length=64) |
Dirk Vogt | 67eb148 | 2016-10-13 12:42:56 +0200 | [diff] [blame] | 37 | id = PrivateField() |
| 38 | device_local_id = serializers.IntegerField(required=False) |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 39 | date = serializers.DateTimeField(default_timezone=timezone.utc) |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 40 | |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 41 | class Meta: # noqa: D106 |
Dirk Vogt | d134521 | 2016-09-14 14:31:45 +0200 | [diff] [blame] | 42 | model = Crashreport |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame^] | 43 | exclude = ("device",) |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 44 | |
| 45 | def create(self, validated_data): |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 46 | """Create a crashreport. |
| 47 | |
| 48 | Args: |
| 49 | validated_data: Data of the crashreport, excluding the device |
| 50 | |
| 51 | Returns: The created report |
| 52 | |
| 53 | """ |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 54 | try: |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame^] | 55 | device = Device.objects.get(uuid=validated_data["uuid"]) |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 56 | except ObjectDoesNotExist: |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 57 | raise NotFound(detail="uuid does not exist") |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame^] | 58 | validated_data.pop("uuid", None) |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 59 | report = Crashreport(**validated_data) |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 60 | report.device = device |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 61 | report.save() |
| 62 | return report |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 63 | |
| 64 | |
| 65 | class HeartBeatSerializer(serializers.ModelSerializer): |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 66 | """Serializer for HeartBeat instances.""" |
| 67 | |
Dirk Vogt | 3663569 | 2016-10-17 12:19:10 +0200 | [diff] [blame] | 68 | permission_classes = (permissions.IsAuthenticated,) |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 69 | uuid = serializers.CharField(max_length=64) |
Dirk Vogt | 67eb148 | 2016-10-13 12:42:56 +0200 | [diff] [blame] | 70 | id = PrivateField() |
| 71 | device_local_id = serializers.IntegerField(required=False) |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 72 | date = serializers.DateTimeField(default_timezone=timezone.utc) |
Dirk Vogt | e178488 | 2016-10-13 16:09:38 +0200 | [diff] [blame] | 73 | |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 74 | class Meta: # noqa: D106 |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 75 | model = HeartBeat |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame^] | 76 | exclude = ("device",) |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 77 | |
| 78 | def create(self, validated_data): |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 79 | """Create a heartbeat report. |
| 80 | |
| 81 | Args: |
| 82 | validated_data: Data of the heartbeat, excluding the device |
| 83 | |
| 84 | Returns: The created heartbeat |
| 85 | |
| 86 | """ |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 87 | try: |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame^] | 88 | device = Device.objects.get(uuid=validated_data["uuid"]) |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 89 | except ObjectDoesNotExist: |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 90 | raise NotFound(detail="uuid does not exist") |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame^] | 91 | validated_data.pop("uuid", None) |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 92 | heartbeat = HeartBeat(**validated_data) |
| 93 | heartbeat.device = device |
| 94 | heartbeat.save() |
| 95 | return heartbeat |
| 96 | |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 97 | |
Dirk Vogt | 83107df | 2017-05-02 12:04:19 +0200 | [diff] [blame] | 98 | class LogFileSerializer(serializers.ModelSerializer): |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 99 | """Serializer for LogFile instances.""" |
| 100 | |
Dirk Vogt | 83107df | 2017-05-02 12:04:19 +0200 | [diff] [blame] | 101 | permission_classes = (permissions.IsAdminUser,) |
| 102 | |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 103 | class Meta: # noqa: D106 |
Dirk Vogt | 83107df | 2017-05-02 12:04:19 +0200 | [diff] [blame] | 104 | model = LogFile |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame^] | 105 | fields = "__all__" |
Dirk Vogt | 83107df | 2017-05-02 12:04:19 +0200 | [diff] [blame] | 106 | |
| 107 | |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 108 | class DeviceSerializer(serializers.ModelSerializer): |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 109 | """Serializer for Device instances.""" |
Dirk Vogt | c9e10ab | 2016-10-12 13:58:15 +0200 | [diff] [blame] | 110 | |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 111 | permission_classes = (permissions.IsAdminUser,) |
| 112 | board_date = serializers.DateTimeField(default_timezone=timezone.utc) |
| 113 | last_heartbeat = serializers.DateTimeField(default_timezone=timezone.utc) |
| 114 | |
| 115 | class Meta: # noqa: D106 |
Dirk Vogt | f2a3342 | 2016-10-11 17:17:26 +0200 | [diff] [blame] | 116 | model = Device |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame^] | 117 | fields = "__all__" |
Franz-Xaver Geiger | d994335 | 2018-02-27 14:26:41 +0100 | [diff] [blame] | 118 | |
| 119 | |
| 120 | class DeviceCreateSerializer(DeviceSerializer): |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 121 | """Serializer for creating Device instances.""" |
Franz-Xaver Geiger | d994335 | 2018-02-27 14:26:41 +0100 | [diff] [blame] | 122 | |
Mitja Nikolaus | 5c3e057 | 2018-07-30 13:36:14 +0200 | [diff] [blame] | 123 | class Meta: # noqa: D106 |
Franz-Xaver Geiger | d994335 | 2018-02-27 14:26:41 +0100 | [diff] [blame] | 124 | model = Device |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame^] | 125 | fields = ("board_date", "chipset") |
Franz-Xaver Geiger | d994335 | 2018-02-27 14:26:41 +0100 | [diff] [blame] | 126 | extra_kwargs = { |
Mitja Nikolaus | cb50f2c | 2018-08-24 13:54:48 +0200 | [diff] [blame^] | 127 | "board_date": {"required": True}, |
| 128 | "chipset": {"required": True}, |
Franz-Xaver Geiger | d994335 | 2018-02-27 14:26:41 +0100 | [diff] [blame] | 129 | } |