Domains: add expired queryset (#9667)

This is going to be used in rtd-ext
to remove expired domains from CF.

Author: stsewd

readthedocs/domains/querysets.py

@@ -1,5 +1,7 @@
 """Querysets for domain related models."""
 
+from datetime import timedelta
+
 from django.conf import settings
 from django.db.models import Q
 from django.utils import timezone
@@ -9,8 +11,11 @@
 
 
 class DomainQueryset(RelatedProjectQuerySet):
+
+    """Domain querysets."""
+
     def pending(self, include_recently_expired=False):
-        max_date = timezone.now() - timezone.timedelta(
+        max_date = timezone.now() - timedelta(
             days=settings.RTD_CUSTOM_DOMAINS_VALIDATION_PERIOD
         )
         queryset = self.exclude(
@@ -20,5 +25,26 @@ def pending(self, include_recently_expired=False):
             return queryset.filter(validation_process_start__date__gte=max_date)
         return queryset.filter(validation_process_start__date__gt=max_date)
 
+    def expired(self, when=None):
+        """
+        Return domains that have their validation process expired.
+
+        :param when: If given, return domains that expired on this date only.
+        """
+        queryset = self.exclude(
+            Q(ssl_status=SSL_STATUS_VALID) | Q(skip_validation=True)
+        )
+        if when:
+            start_date = when - timedelta(
+                days=settings.RTD_CUSTOM_DOMAINS_VALIDATION_PERIOD
+            )
+            queryset = queryset.filter(validation_process_start__date=start_date)
+        else:
+            max_date = timezone.now() - timedelta(
+                days=settings.RTD_CUSTOM_DOMAINS_VALIDATION_PERIOD
+            )
+            queryset = queryset.filter(validation_process_start__date__lte=max_date)
+        return queryset
+
     def valid(self):
         return self.filter(ssl_status=SSL_STATUS_VALID)

readthedocs/domains/tests/test_querysets.py

@@ -1,3 +1,5 @@
+from datetime import timedelta
+
 from django.conf import settings
 from django.contrib.auth.models import User
 from django.test import TestCase
@@ -33,15 +35,15 @@ def setUp(self):
         self.domain_recently_expired = get(
             Domain, project=self.project, ssl_status=SSL_STATUS_PENDING
         )
-        self.domain_recently_expired.validation_process_start -= timezone.timedelta(
+        self.domain_recently_expired.validation_process_start -= timedelta(
             days=settings.RTD_CUSTOM_DOMAINS_VALIDATION_PERIOD
         )
         self.domain_recently_expired.save()
 
         self.domain_expired = get(
             Domain, project=self.project, ssl_status=SSL_STATUS_PENDING
         )
-        self.domain_expired.validation_process_start -= timezone.timedelta(
+        self.domain_expired.validation_process_start -= timedelta(
             days=settings.RTD_CUSTOM_DOMAINS_VALIDATION_PERIOD + 10
         )
         self.domain_expired.save()
@@ -59,3 +61,16 @@ def test_pending(self):
     def test_valid(self):
         domains = set(Domain.objects.valid().all())
         self.assertEqual(domains, {self.domain})
+
+    def test_expired(self):
+        # All expired domains.
+        domains = set(Domain.objects.expired())
+        self.assertEqual(domains, {self.domain_expired, self.domain_recently_expired})
+
+        # Domains that expired today.
+        domains = set(Domain.objects.expired(when=timezone.now()))
+        self.assertEqual(domains, {self.domain_recently_expired})
+
+        # Domains that expired 10 days ago.
+        domains = set(Domain.objects.expired(when=timezone.now() - timedelta(days=10)))
+        self.assertEqual(domains, {self.domain_expired})