from __future__ import unicode_literals from django.core.exceptions import ObjectDoesNotExist from rest_framework import serializers from taggit.models import Tag from dcim.api.serializers import NestedDeviceSerializer, NestedRackSerializer, NestedSiteSerializer from dcim.models import Device, Rack, Site from extras.constants import ACTION_CHOICES, GRAPH_TYPE_CHOICES from extras.models import ExportTemplate, Graph, ImageAttachment, ReportResult, TopologyMap, UserAction from users.api.serializers import NestedUserSerializer from utilities.api import ChoiceFieldSerializer, ContentTypeFieldSerializer, ValidatedModelSerializer from extras.constants import * # # Graphs # class GraphSerializer(ValidatedModelSerializer): type = ChoiceFieldSerializer(choices=GRAPH_TYPE_CHOICES) class Meta: model = Graph fields = ['id', 'type', 'weight', 'name', 'source', 'link'] class RenderedGraphSerializer(serializers.ModelSerializer): embed_url = serializers.SerializerMethodField() embed_link = serializers.SerializerMethodField() type = ChoiceFieldSerializer(choices=GRAPH_TYPE_CHOICES) class Meta: model = Graph fields = ['id', 'type', 'weight', 'name', 'embed_url', 'embed_link'] def get_embed_url(self, obj): return obj.embed_url(self.context['graphed_object']) def get_embed_link(self, obj): return obj.embed_link(self.context['graphed_object']) # # Export templates # class ExportTemplateSerializer(ValidatedModelSerializer): class Meta: model = ExportTemplate fields = ['id', 'content_type', 'name', 'description', 'template_code', 'mime_type', 'file_extension'] # # Topology maps # class TopologyMapSerializer(ValidatedModelSerializer): site = NestedSiteSerializer() class Meta: model = TopologyMap fields = ['id', 'name', 'slug', 'site', 'device_patterns', 'description'] # # Tags # class TagSerializer(ValidatedModelSerializer): tagged_items = serializers.IntegerField(read_only=True) class Meta: model = Tag fields = ['id', 'name', 'slug', 'tagged_items'] # # Image attachments # class ImageAttachmentSerializer(ValidatedModelSerializer): content_type = ContentTypeFieldSerializer() parent = serializers.SerializerMethodField(read_only=True) class Meta: model = ImageAttachment fields = [ 'id', 'content_type', 'object_id', 'parent', 'name', 'image', 'image_height', 'image_width', 'created', ] def validate(self, data): # Validate that the parent object exists try: data['content_type'].get_object_for_this_type(id=data['object_id']) except ObjectDoesNotExist: raise serializers.ValidationError( "Invalid parent object: {} ID {}".format(data['content_type'], data['object_id']) ) # Enforce model validation super(ImageAttachmentSerializer, self).validate(data) return data def get_parent(self, obj): # Static mapping of models to their nested serializers if isinstance(obj.parent, Device): serializer = NestedDeviceSerializer elif isinstance(obj.parent, Rack): serializer = NestedRackSerializer elif isinstance(obj.parent, Site): serializer = NestedSiteSerializer else: raise Exception("Unexpected type of parent object for ImageAttachment") return serializer(obj.parent, context={'request': self.context['request']}).data # # Reports # class ReportResultSerializer(serializers.ModelSerializer): class Meta: model = ReportResult fields = ['created', 'user', 'failed', 'data'] class NestedReportResultSerializer(serializers.ModelSerializer): url = serializers.HyperlinkedIdentityField( view_name='extras-api:report-detail', lookup_field='report', lookup_url_kwarg='pk' ) class Meta: model = ReportResult fields = ['url', 'created', 'user', 'failed'] class ReportSerializer(serializers.Serializer): module = serializers.CharField(max_length=255) name = serializers.CharField(max_length=255) description = serializers.CharField(max_length=255, required=False) test_methods = serializers.ListField(child=serializers.CharField(max_length=255)) result = NestedReportResultSerializer() class ReportDetailSerializer(ReportSerializer): result = ReportResultSerializer() # # User actions # class UserActionSerializer(serializers.ModelSerializer): user = NestedUserSerializer() action = ChoiceFieldSerializer(choices=ACTION_CHOICES) class Meta: model = UserAction fields = ['id', 'time', 'user', 'action', 'message']