Implement UI for automation rules

readthedocs/builds/constants.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 """Constants for the builds app."""
 
 from django.conf import settings
@@ -37,16 +35,20 @@
 # Manager name for External Versions or Builds.
 # ie: Only pull request/merge request Versions and Builds.
 EXTERNAL = 'external'
+EXTERNAL_TEXT = _('External')
 
 BRANCH = 'branch'
+BRANCH_TEXT = _('Branch')
 TAG = 'tag'
+TAG_TEXT = _('Tag')
 UNKNOWN = 'unknown'
+UNKNOWN_TEXT = _('Unknown')
 
 VERSION_TYPES = (
-    (BRANCH, _('Branch')),
-    (TAG, _('Tag')),
-    (EXTERNAL, _('External')),
-    (UNKNOWN, _('Unknown')),
+    (BRANCH, BRANCH_TEXT),
+    (TAG, TAG_TEXT),
+    (EXTERNAL, EXTERNAL_TEXT),
+    (UNKNOWN, UNKNOWN_TEXT),
 )
 
 LATEST = settings.RTD_LATEST

readthedocs/builds/forms.py

@@ -1,11 +1,13 @@
-# -*- coding: utf-8 -*-
-
 """Django forms for the builds app."""
 
 from django import forms
 from django.utils.translation import ugettext_lazy as _
 
-from readthedocs.builds.models import Version
+from readthedocs.builds.constants import BRANCH, BRANCH_TEXT, TAG, TAG_TEXT
+from readthedocs.builds.models import (
+    RegexAutomationRule,
+    Version,
+)
 from readthedocs.core.mixins import HideProtectedLevelMixin
 from readthedocs.core.utils import trigger_build
 
@@ -37,3 +39,77 @@ def save(self, commit=True):
         if obj.active and not obj.built and not obj.uploaded:
             trigger_build(project=obj.project, version=obj)
         return obj
+
+
+class RegexAutomationRuleForm(forms.ModelForm):
+
+    ALL_VERSIONS_REGEX = r'.*'
+    SEMVER_REGEX = r'^v?(\d+\.)(\d+\.)(\d)(-.+)?$'
+    MATCH_CHOICES = (
+        (ALL_VERSIONS_REGEX, 'All versions'),
+        (SEMVER_REGEX, 'Semver versions'),
+        (None, 'Custom'),
+    )
+
+    match = forms.ChoiceField(
+        label='Rule',
+        choices=MATCH_CHOICES,
+        initial=ALL_VERSIONS_REGEX,
+        required=False,
+    )
+
+    match_arg = forms.CharField(
+        label='Custom rule',
+        help_text=_('A Python regular expression'),
+        required=False,
+    )
+
+    class Meta:
+        model = RegexAutomationRule
+        fields = ['description', 'match', 'match_arg', 'version_type', 'action']
+
+    def __init__(self, *args, **kwargs):
+        self.project = kwargs.pop('project', None)
+        super().__init__(*args, **kwargs)
+
+        self.fields['version_type'].choices = [
+            (None, '-' * 9),
+            (BRANCH, BRANCH_TEXT),
+            (TAG, TAG_TEXT),
+        ]
+
+        match_options = set(v[0] for v in self.MATCH_CHOICES)
+        if self.instance.pk:
+            match_arg = self.instance.match_arg
+            if match_arg and match_arg in match_options:
+                self.initial['match'] = self.instance.match_arg
+            else:
+                self.initial['match'] = None
+
+    def clean_match_arg(self):
+        match_arg = self.cleaned_data['match_arg']
+        match = self.cleaned_data['match']
+        if match:
+            match_arg = match
+        if not match_arg:
+            raise forms.ValidationError(
+                _('Custom match should not be empty.'),
+            )
+        return match_arg
+
+    def clean_description(self):
+        description = self.cleaned_data['description']
+        if not description:
+            description = self.instance.get_description()
+        return description
+
+    def save(self, commit=True):
+        if self.instance.pk:
+            return super().save(commit=commit)
+        return RegexAutomationRule.objects.append_rule(
+            project=self.project,
+            description=self.cleaned_data['description'],
+            match_arg=self.cleaned_data['match_arg'],
+            version_type=self.cleaned_data['version_type'],
+            action=self.cleaned_data['action'],
+        )

readthedocs/builds/managers.py

@@ -1,11 +1,10 @@
-# -*- coding: utf-8 -*-
-
 """Build and Version class model Managers."""
 
 import logging
 
-from django.db import models
 from django.core.exceptions import ObjectDoesNotExist
+from django.db import models
+from polymorphic.managers import PolymorphicManager
 
 from readthedocs.core.utils.extend import (
     SettingsOverrideObject,
@@ -14,14 +13,15 @@
 
 from .constants import (
     BRANCH,
+    EXTERNAL,
     LATEST,
     LATEST_VERBOSE_NAME,
     STABLE,
     STABLE_VERBOSE_NAME,
     TAG,
-    EXTERNAL,
 )
-from .querysets import VersionQuerySet, BuildQuerySet
+from .querysets import BuildQuerySet, VersionQuerySet
+
 
 log = logging.getLogger(__name__)
 
@@ -179,3 +179,37 @@ class InternalBuildManager(SettingsOverrideObject):
 
 class ExternalBuildManager(SettingsOverrideObject):
     _default_class = ExternalBuildManagerBase
+
+
+class VersionAutomationRuleManager(PolymorphicManager):
+
+    def append_rule(
+        self, *, project, description, match_arg, version_type,
+        action, action_arg=None,
+    ):
+        """
+        Append an automation rule to `project`.
+
+        The rule is created with a priority higher than the last rule
+        in `project`.
+        """
+        last_priority = (
+            project.automation_rules
+            .values_list('priority', flat=True)
+            .last()
+        )
+        if last_priority is None:
+            priority = 0
+        else:
+            priority = last_priority + 1
+
+        rule = self.create(
+            project=project,
+            priority=priority,
+            description=description,
+            match_arg=match_arg,
+            version_type=version_type,
+            action=action,
+            action_arg=action_arg,
+        )
+        return rule

readthedocs/builds/migrations/0010_add-description-field-to-automation-rule.py

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.22 on 2019-07-25 17:24
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('builds', '0009_added_external_version_type'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='versionautomationrule',
+            name='description',
+            field=models.CharField(blank=True, max_length=255, null=True, verbose_name='Description'),
+        ),
+    ]

readthedocs/builds/models.py

@@ -17,48 +17,30 @@
 from polymorphic.models import PolymorphicModel
 
 import readthedocs.builds.automation_actions as actions
-from readthedocs.config import LATEST_CONFIGURATION_VERSION
-from readthedocs.core.utils import broadcast
-from readthedocs.projects.constants import (
-    BITBUCKET_COMMIT_URL,
-    BITBUCKET_URL,
-    GITHUB_BRAND,
-    GITHUB_COMMIT_URL,
-    GITHUB_URL,
-    GITHUB_PULL_REQUEST_URL,
-    GITHUB_PULL_REQUEST_COMMIT_URL,
-    GITLAB_COMMIT_URL,
-    GITLAB_URL,
-    PRIVACY_CHOICES,
-    PRIVATE,
-    MEDIA_TYPES,
-)
-from readthedocs.projects.models import APIProject, Project
-from readthedocs.projects.version_handling import determine_stable_version
-
 from readthedocs.builds.constants import (
     BRANCH,
     BUILD_STATE,
     BUILD_STATE_FINISHED,
     BUILD_STATE_TRIGGERED,
     BUILD_TYPES,
+    EXTERNAL,
     GENERIC_EXTERNAL_VERSION_NAME,
     GITHUB_EXTERNAL_VERSION_NAME,
     INTERNAL,
     LATEST,
     NON_REPOSITORY_VERSIONS,
-    EXTERNAL,
     STABLE,
     TAG,
     VERSION_TYPES,
 )
 from readthedocs.builds.managers import (
-    VersionManager,
-    InternalVersionManager,
-    ExternalVersionManager,
     BuildManager,
-    InternalBuildManager,
     ExternalBuildManager,
+    ExternalVersionManager,
+    InternalBuildManager,
+    InternalVersionManager,
+    VersionAutomationRuleManager,
+    VersionManager,
 )
 from readthedocs.builds.querysets import (
     BuildQuerySet,
@@ -71,7 +53,24 @@
     get_gitlab_username_repo,
 )
 from readthedocs.builds.version_slug import VersionSlugField
-from readthedocs.oauth.models import RemoteRepository
+from readthedocs.config import LATEST_CONFIGURATION_VERSION
+from readthedocs.core.utils import broadcast
+from readthedocs.projects.constants import (
+    BITBUCKET_COMMIT_URL,
+    BITBUCKET_URL,
+    GITHUB_BRAND,
+    GITHUB_COMMIT_URL,
+    GITHUB_PULL_REQUEST_COMMIT_URL,
+    GITHUB_PULL_REQUEST_URL,
+    GITHUB_URL,
+    GITLAB_COMMIT_URL,
+    GITLAB_URL,
+    MEDIA_TYPES,
+    PRIVACY_CHOICES,
+    PRIVATE,
+)
+from readthedocs.projects.models import APIProject, Project
+from readthedocs.projects.version_handling import determine_stable_version
 
 
 log = logging.getLogger(__name__)
@@ -936,6 +935,12 @@ class VersionAutomationRule(PolymorphicModel, TimeStampedModel):
         _('Rule priority'),
         help_text=_('A lower number (0) means a higher priority'),
     )
+    description = models.CharField(
+        _('Description'),
+        max_length=255,
+        null=True,
+        blank=True,
+    )
     match_arg = models.CharField(
         _('Match argument'),
         help_text=_('Value used for the rule to match the version'),
@@ -959,6 +964,8 @@ class VersionAutomationRule(PolymorphicModel, TimeStampedModel):
         choices=VERSION_TYPES,
     )
 
+    objects = VersionAutomationRuleManager()
+
     class Meta:
         unique_together = (('project', 'priority'),)
         ordering = ('priority', '-modified', '-created')
@@ -1002,6 +1009,15 @@ def apply_action(self, version, match_result):
             raise NotImplementedError
         action(version, match_result, self.action_arg)
 
+    def get_description(self):
+        if self.description:
+            return self.description
+        return f'{self.get_action_display()}'
+
+    @property
+    def edit_url(self):
+        raise NotImplementedError
+
     def __str__(self):
         class_name = self.__class__.__name__
         return (
@@ -1030,3 +1046,10 @@ def match(self, version, match_arg):
         except Exception as e:
             log.info('Error parsing regex: %s', e)
             return False, None
+
+    @property
+    def edit_url(self):
+        return reverse(
+            'projects_automation_rule_regex_edit',
+            args=[self.project.slug, self.pk],
+        )

readthedocs/builds/views.py

@@ -1,9 +1,8 @@
-# -*- coding: utf-8 -*-
-
 """Views for builds app."""
 
 import logging
 import textwrap
+from urllib.parse import urlparse
 
 from django.contrib import messages
 from django.contrib.auth.decorators import login_required
@@ -17,12 +16,11 @@
 from django.utils.decorators import method_decorator
 from django.views.generic import DetailView, ListView
 from requests.utils import quote
-from urllib.parse import urlparse
 
-from readthedocs.doc_builder.exceptions import BuildEnvironmentError
 from readthedocs.builds.models import Build, Version
 from readthedocs.core.permissions import AdminPermission
 from readthedocs.core.utils import trigger_build
+from readthedocs.doc_builder.exceptions import BuildEnvironmentError
 from readthedocs.projects.models import Project