Added docstrings

migratorapi/api/migrations/0009_migration_is_urgent.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.1.2 on 2020-10-22 01:27
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0008_auto_20201021_1805'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='migration',
+            name='is_urgent',
+            field=models.BooleanField(default=False),
+        ),
+    ]

migratorapi/api/models.py

@@ -6,6 +6,7 @@ from django.utils import timezone
 
 
 class Migration(models.Model):
+    """This is the migration class"""
     id = models.CharField(max_length=200, unique=True,
                           default=uuid.uuid4, primary_key=True)
     submit_time = models.DateField('migrtation submitted on')
@@ -22,6 +23,7 @@ class Migration(models.Model):
     additional_domains = models.CharField(
         max_length=500, null=True, blank=True)
     migration_type = models.CharField(max_length=200)
+    is_urgent = models.BooleanField(default=False)
 
     def print_missed_migrations(self):
         now = timezone.now()

migratorapi/api/tests.py

@@ -1,3 +1,25 @@
+import datetime
 from django.test import TestCase
+from django.utils import timezone
+# from django.urls import reverse
 
-# Create your tests here.
+from .models import Migration
+
+
+def create_migration(submit_time, domain, booked_time, original_server,
+                     new_server, username, notes, brand, ticket_id, migration_status,
+                     agent_booked, additional_domains, migration_type, is_urgent):
+
+    return Migration.objects.create(submit_time=submit_time, domain=domain, booked_time=booked_time, original_server=original_server,
+                                    new_server=new_server, username=username, notes=notes, brand=brand, ticket_id=ticket_id,
+                                    migration_status=migration_status, agent_booked=agent_booked, additional_domains=additional_domains,
+                                    migration_type=migration_type, is_urgent=is_urgent)
+
+
+class MigrationModelTests(TestCase):
+    def test_migration_is_booked(self):
+        migration = create_migration(submit_time=timezone.now(), domain="test.com", booked_time=timezone.now() + datetime.timedelta(1),
+                                     original_server='1.2.3.4', new_server="4.3.2.1", username="ben", notes="", brand="VentraIP", ticket_id="VIP-1234567", migration_status="Booked",
+                                     agent_booked="BL", additional_domains="", migration_type="cPanel", is_urgent=False)
+        print(migration.migration_status)
+        self.assertTrue(migration.migration_status == "Booked")

migratorapi/api/views.py

@@ -1,45 +1,42 @@
 import datetime
+
 from django.shortcuts import get_object_or_404, render
 from django.http import HttpResponseRedirect, JsonResponse
 from django.views import generic
 from django.urls import reverse
 from django.utils import timezone
 from rest_framework import status, viewsets
-from .serializers import MigrationSerializer
 from rest_framework.response import Response
 from rest_framework.decorators import action
+from .serializers import MigrationSerializer
+
 
 from .models import Migration
 
 
 class MigrationViewSet(viewsets.ModelViewSet):
+    ''' Class for defining the migration views '''
     queryset = Migration.objects.all()
     serializer_class = MigrationSerializer
     # permission_classes = (AllowAny,)
 
     @action(detail=False, methods=['GET'])
     def upcoming(self, request, *args, **kwargs):
+        ''' Returns a list of the migrations due today '''
         queryset = MigrationSerializer(
             Migration.objects.filter(booked_time=timezone.now(), migration_status="Booked"), many=True)
         return Response(queryset.data, status=status.HTTP_200_OK)
 
     @action(detail=False, methods=['GET'])
     def missed(self, request, *args, **kwargs):
+        ''' Returns a list of the missed migrations (Still have the status booked and date is greater then today) '''
         queryset = MigrationSerializer(
             Migration.objects.filter(booked_time__gte=timezone.now() + datetime.timedelta(1), migration_status="Booked"), many=True)
         return Response(queryset.data, status=status.HTTP_200_OK)
 
     @action(detail=False, methods=['GET'])
     def booked(self, request, *args, **kwargs):
+        ''' Returns a list of the booked migrations '''
         queryset = MigrationSerializer(Migration.objects.filter(
             migration_status="booked",), many=True)
         return Response(queryset.data, status=status.HTTP_200_OK)
-
-
-class IndexView(generic.ListView):
-    template_name = 'api/index.html'
-    context_object_name = 'latest_migrations'
-
-    def get_queryset(self):
-        """Return the last five published questions (not including those set in the future)."""
-        return Migration.objects.filter(booked_time__gte=timezone.now()).order_by('-booked_time')[:5]