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