Merge pull request #77 from intelowlproject/develop

Added Tag model | custom fields in admin view + updated travis config

Author: mlodic

.gitignore

@@ -5,4 +5,5 @@ test_files
 env_file_app
 env_file_postgres
 env_file_integrations
-.env
+.env
+venv/

.travis.yml

@@ -1,3 +1,7 @@
+branches:
+  only:
+  - master
+  - develop
 sudo: required
 language: python
 dist: bionic

api_app/admin.py

@@ -1,4 +1,25 @@
 from django.contrib import admin
-from .models import Job
+from .models import Job, Tag
 
-admin.site.register(Job)
+
+class JobAdminView(admin.ModelAdmin):
+    list_display = (
+        "id",
+        "source",
+        "observable_name",
+        "status",
+        "observable_classification",
+        "file_mimetype",
+        "received_request_time",
+    )
+    list_display_link = ("id", "status")
+    search_fields = ("source", "md5", "observable_name")
+
+
+class TagAdminView(admin.ModelAdmin):
+    list_display = ("id", "label", "color")
+    search_fields = ("label", "color")
+
+
+admin.site.register(Job, JobAdminView)
+admin.site.register(Tag, TagAdminView)

api_app/models.py

@@ -3,29 +3,54 @@
 
 from api_app import utilities
 
-STATUS = [("pending", "pending"),
-          ("running", "running"),
-          ("reported_without_fails", "reported_without_fails"),
-          ("reported_with_fails", "reported_with_fails"),
-          ("failed", "failed")]
+STATUS = [
+    ("pending", "pending"),
+    ("running", "running"),
+    ("reported_without_fails", "reported_without_fails"),
+    ("reported_with_fails", "reported_with_fails"),
+    ("failed", "failed"),
+]
+
+
+class Tag(models.Model):
+    label = models.CharField(max_length=50, blank=False, default="none")
+    color = models.CharField(max_length=7, blank=False, default="#222222")
+
+    def __str__(self):
+        return f'Tag(label="{self.label}")'
 
 
 class Job(models.Model):
     source = models.CharField(max_length=50, blank=False, default="none")
-    is_sample = models.BooleanField(blank=False)
+    is_sample = models.BooleanField(blank=False, default=False)
     md5 = models.CharField(max_length=50, blank=False)
     observable_name = models.CharField(max_length=50, blank=True)
     observable_classification = models.CharField(max_length=50, blank=True)
     file_name = models.CharField(max_length=50, blank=True)
     file_mimetype = models.CharField(max_length=50, blank=True)
-    status = models.CharField(max_length=50, blank=False, choices=STATUS, default="pending")
-    analyzers_requested = postgres_fields.ArrayField(models.CharField(max_length=900), blank=True, default=list)
+    status = models.CharField(
+        max_length=50, blank=False, choices=STATUS, default="pending"
+    )
+    analyzers_requested = postgres_fields.ArrayField(
+        models.CharField(max_length=900), blank=True, default=list
+    )
     run_all_available_analyzers = models.BooleanField(blank=False, default=False)
-    analyzers_to_execute = postgres_fields.ArrayField(models.CharField(max_length=900), blank=True, default=list)
+    analyzers_to_execute = postgres_fields.ArrayField(
+        models.CharField(max_length=900), blank=True, default=list
+    )
     analysis_reports = postgres_fields.JSONField(default=list, null=True, blank=True)
     received_request_time = models.DateTimeField(auto_now_add=True)
     finished_analysis_time = models.DateTimeField(blank=True, null=True)
     force_privacy = models.BooleanField(blank=False, default=False)
     disable_external_analyzers = models.BooleanField(blank=False, default=False)
-    errors = postgres_fields.ArrayField(models.CharField(max_length=900), blank=True, default=list, null=True)
+    errors = postgres_fields.ArrayField(
+        models.CharField(max_length=900), blank=True, default=list, null=True
+    )
     file = models.FileField(blank=True, upload_to=utilities.file_directory_path)
+    tags = models.ManyToManyField(Tag, related_name="jobs", blank=True)
+
+    def __str__(self):
+        if self.observable_name:
+            return f'Job("{self.observable_name}")'
+        else:
+            return f'Job("{self.file_name}")'

api_app/serializers.py

@@ -1,8 +1,28 @@
 from rest_framework import serializers
-from api_app.models import Job
+from api_app.models import Job, Tag
+
+
+class TagSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Tag
+        fields = "__all__"
 
 
 class JobSerializer(serializers.ModelSerializer):
+    tags = TagSerializer(many=True, read_only=True)
+    tags_id = serializers.PrimaryKeyRelatedField(
+        many=True, write_only=True, queryset=Tag.objects.all()
+    )
+
     class Meta:
         model = Job
-        fields = '__all__'
+        fields = "__all__"
+        extra_kwargs = {"tags": {"required": False}}
+
+    def create(self, validated_data):
+        tags = validated_data.pop("tags_id", None)
+        job = Job.objects.create(**validated_data)
+        if tags:
+            job.tags.set(tags)
+
+        return job