Merge pull request #201 from rackerlabs/issue-191-add-enable-disable-switch-to-scans

Added enable/disable functionality to Scan model

Author: derpadoo

master/django_scantron/__init__.py

@@ -1 +1 @@
-__version__ = "1.28"
+__version__ = "1.29"

master/django_scantron/admin.py

@@ -32,7 +32,7 @@ class ScanCommandAdmin(admin.ModelAdmin):
 
 class ScanAdmin(admin.ModelAdmin):
 
-    list_display = ("id", "site", "scan_name", "start_time", "recurrences")
+    list_display = ("id", "site", "scan_name", "enable_scan", "start_time", "recurrences")
 
     exclude = ("completed_time", "result_file_base_name")
 

master/django_scantron/api/serializers.py

@@ -110,6 +110,7 @@ class Meta:
             "id",
             "site",
             "scan_name",
+            "enable_scan",
             "start_time",
             "recurrences",
         )

master/django_scantron/models.py

@@ -171,6 +171,7 @@ class Scan(models.Model):
     id = models.AutoField(primary_key=True, verbose_name="Scan ID")
     site = models.ForeignKey(Site, on_delete=models.CASCADE, verbose_name="Site ID")
     scan_name = models.CharField(unique=False, max_length=255, blank=True, verbose_name="Scan Name")
+    enable_scan = models.BooleanField(verbose_name="Enable scan?")
     start_time = models.TimeField(verbose_name="Scan start time")
     recurrences = RecurrenceField(include_dtstart=False, verbose_name="Recurrences")
 

master/scan_scheduler.py

@@ -42,10 +42,12 @@ def main():
 
     # Only filter on scans that should start at this time based off hour and minute, ignoring seconds.
     # If minute is the time resolution, this script (wrapped with scan_scheduler.sh) must be executed every minute
-    # through cron.  We can't filter on occurrences using Django's filter() method; it will have to be checked using
-    # logic below.
-    scans = django_connector.Scan.objects.filter(start_time__hour=now_time_hour).filter(
-        start_time__minute=now_time_minute
+    # through cron.  Also filter on scans that are enabled.  We can't filter on occurrences using Django's filter()
+    # method; it will have to be checked using logic below.
+    scans = (
+        django_connector.Scan.objects.filter(start_time__hour=now_time_hour)
+        .filter(start_time__minute=now_time_minute)
+        .filter(enable_scan=True)
     )
 
     if not scans:

scantron_api_client/README.md

@@ -111,6 +111,7 @@ At a minimum, you need to include `RDATE:`.
 payload = {
     "site": 1,
     "scan_name": "DMZ Scan",
+    "enable_scan": True,
     "start_time": "16:00:00",
     "recurrences": "RRULE:FREQ=WEEKLY;BYDAY=MO\nRDATE:20200113T060000Z",
 }