Add models for automation rules

readthedocs/builds/admin.py

@@ -144,13 +144,15 @@ def wipe_version(self, request, queryset):
 
 @admin.register(RegexAutomationRule)
 class RegexAutomationRuleAdmin(PolymorphicChildModelAdmin, admin.ModelAdmin):
+    raw_id_fields = ('project',)
     base_model = RegexAutomationRule
 
 
 @admin.register(VersionAutomationRule)
 class VersionAutomationRuleAdmin(PolymorphicParentModelAdmin, admin.ModelAdmin):
     base_model = VersionAutomationRule
     list_display = (
+        'id',
         'project',
         'priority',
         'match_arg',

readthedocs/builds/automation_actions.py

@@ -8,7 +8,31 @@
 - action_arg: An additional argument to apply the action
 """
 
+from readthedocs.core.utils import trigger_build
+
 
 def activate_version(version, match_result, action_arg, *args, **kwargs):
+    """
+    Sets version as active.
+
+    It triggers a build if the version isn't built.
+    """
     version.active = True
     version.save()
+    if not version.built:
+        trigger_build(
+            project=version.project,
+            version=version
+        )
+
+
+def set_default_version(version, match_result, action_arg, *args, **kwargs):
+    """
+    Sets version as the project's default version.
+
+    The version is activated first.
+    """
+    activate_version(version, match_result, action_arg)
+    project = version.project
+    project.default_version = version.slug
+    project.save()

readthedocs/builds/migrations/0007_add-automation-rules.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Generated by Django 1.11.20 on 2019-03-04 22:15
+# Generated by Django 1.11.20 on 2019-04-25 23:04
 from __future__ import unicode_literals
 
 from django.db import migrations, models
@@ -10,7 +10,7 @@
 class Migration(migrations.Migration):
 
     dependencies = [
-        ('projects', '0040_increase_path_max_length'),
+        ('projects', '0042_increase_env_variable_value_max_length'),
         ('contenttypes', '0002_remove_content_type_name'),
         ('builds', '0006_add_config_field'),
     ]
@@ -24,7 +24,7 @@ class Migration(migrations.Migration):
                 ('modified', django_extensions.db.fields.ModificationDateTimeField(auto_now=True, verbose_name='modified')),
                 ('priority', models.IntegerField(help_text='A lower number (0) means a higher priority', verbose_name='Rule priority')),
                 ('match_arg', models.CharField(help_text='Value used for the rule to match the version', max_length=255, verbose_name='Match argument')),
-                ('action', models.CharField(choices=[('activate-version', 'Activate version on match')], max_length=32, verbose_name='Action')),
+                ('action', models.CharField(choices=[('activate-version', 'Activate version on match'), ('set-default-version', 'Set as default version on match')], max_length=32, verbose_name='Action')),
                 ('action_arg', models.CharField(blank=True, help_text='Value used for the action to perfom an operation', max_length=255, null=True, verbose_name='Action argument')),
                 ('version_type', models.CharField(choices=[('branch', 'Branch'), ('tag', 'Tag'), ('unknown', 'Unknown')], max_length=32, verbose_name='Version type')),
                 ('polymorphic_ctype', models.ForeignKey(editable=False, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='polymorphic_builds.versionautomationrule_set+', to='contenttypes.ContentType')),

readthedocs/builds/models.py

@@ -711,8 +711,10 @@ class VersionAutomationRule(PolymorphicModel, TimeStampedModel):
     """Versions automation rules for projects."""
 
     ACTIVATE_VERSION_ACTION = 'activate-version'
+    SET_DEFAULT_VERSION_ACTION = 'set-default-version'
     ACTIONS = (
         (ACTIVATE_VERSION_ACTION, _('Activate version on match')),
+        (SET_DEFAULT_VERSION_ACTION, _('Set as default version on match')),
     )
 
     project = models.ForeignKey(
@@ -759,37 +761,36 @@ def run(self, version, *args, **kwargs):
         :returns: True if the action was performed
         """
         if version.type == self.version_type:
-            match_result = self.match(version, self.match_arg)
-            if match_result is not None:
-                self.apply_action(version, match_result, self.action_arg)
+            match, result = self.match(version, self.match_arg)
+            if match:
+                self.apply_action(version, result)
                 return True
         return False
 
     def match(self, version, match_arg):
         """
-        Returns an object different from None if the version matches the rule.
+        Returns True and the match result if the version matches the rule.
 
         :type version: readthedocs.builds.models.Version
         :param str match_arg: Additional argument to perform the match
-        :returns: An object different from `None` if the match is successful.
+        :returns: A tuple of (boolean, match_resul).
                   The result will be passed to `apply_action`.
         """
-        return None
+        return False, None
 
-    def apply_action(self, version, match_result, action_arg):
+    def apply_action(self, version, match_result):
         """
         Apply the action from allowed_actions.
 
         :type version: readthedocs.builds.models.Version
         :param any match_result: Additional context from the match operation
-        :param str action_arg: Additional argument to perform the action
         :raises: NotImplementedError if the action
                  isn't implemented or supported for this rule.
         """
         action = self.allowed_actions.get(self.action)
         if action is None:
             raise NotImplementedError
-        action(version, match_result, action_arg)
+        action(version, match_result, self.action_arg)
 
     def __str__(self):
         class_name = self.__class__.__name__
@@ -804,6 +805,7 @@ class RegexAutomationRule(VersionAutomationRule):
 
     allowed_actions = {
         VersionAutomationRule.ACTIVATE_VERSION_ACTION: actions.activate_version,
+        VersionAutomationRule.SET_DEFAULT_VERSION_ACTION: actions.set_default_version,
     }
 
     class Meta:
@@ -814,7 +816,7 @@ def match(self, version, match_arg):
             match = re.search(
                 match_arg, version.verbose_name
             )
-            return match
+            return bool(match), match
         except Exception as e:
             log.info('Error parsing regex: %s', e)
-            return None
+            return False, None

readthedocs/projects/models.py

@@ -911,7 +911,7 @@ def update_stable_version(self):
         """
         Returns the version that was promoted to be the new stable version.
 
-        Return ``None`` if no update was mode or if there is no version on the
+        Return ``None`` if no update was made or if there is no version on the
         project that can be considered stable.
         """
         versions = self.versions.all()

readthedocs/restapi/utils.py

@@ -2,6 +2,7 @@
 
 """Utility functions that are used by both views and celery tasks."""
 
+import itertools
 import logging
 
 from rest_framework.pagination import PageNumberPagination
@@ -160,6 +161,18 @@ def delete_versions(project, version_data):
     return set()
 
 
+def run_automation_rules(project, versions_slug):
+    """
+    Runs the automation rules on each version.
+
+    The rules are sorted by priority.
+    """
+    versions = project.versions.filter(slug__in=versions_slug)
+    rules = project.automation_rules.all()
+    for version, rule in itertools.product(versions, rules):
+        rule.run(version)
+
+
 class RemoteOrganizationPagination(PageNumberPagination):
     page_size = 25
 

readthedocs/restapi/views/model_views.py

@@ -8,7 +8,7 @@
 from django.shortcuts import get_object_or_404
 from django.template.loader import render_to_string
 from rest_framework import decorators, permissions, status, viewsets
-from rest_framework.parsers import MultiPartParser, JSONParser, FormParser
+from rest_framework.parsers import JSONParser, MultiPartParser
 from rest_framework.renderers import BaseRenderer, JSONRenderer
 from rest_framework.response import Response
 
@@ -215,6 +215,17 @@ def sync_versions(self, request, **kwargs):  # noqa: D205
                 status=status.HTTP_400_BAD_REQUEST,
             )
 
+        try:
+            api_utils.run_automation_rules(project, added_versions)
+        except Exception:
+            # Don't interrupt the request if something goes wrong
+            # in the automation rules.
+            log.exception(
+                'Failed to execute automation rules for [%s]: %s',
+                project.slug, added_versions
+            )
+
+        # TODO: move this to an automation rule
         promoted_version = project.update_stable_version()
         new_stable = project.get_stable_version()
         if promoted_version and new_stable and new_stable.active:

readthedocs/rtd_tests/tests/test_automation_rules.py

@@ -1,7 +1,8 @@
+import mock
 import pytest
 from django_dynamic_fixture import get
 
-from readthedocs.builds.constants import BRANCH, TAG
+from readthedocs.builds.constants import BRANCH, LATEST, TAG
 from readthedocs.builds.models import (
     RegexAutomationRule,
     Version,
@@ -64,14 +65,15 @@ def setup_method(self):
         ]
     )
     @pytest.mark.parametrize('version_type', [BRANCH, TAG])
-    def test_action_activation_match(
+    def test_match(
             self, version_name, regex, result, version_type):
         version = get(
             Version,
             verbose_name=version_name,
             project=self.project,
             active=False,
             type=version_type,
+            built=False,
         )
         rule = get(
             RegexAutomationRule,
@@ -82,4 +84,44 @@ def test_action_activation_match(
             version_type=version_type,
         )
         assert rule.run(version) is result
-        assert version.active is result
+
+    @mock.patch('readthedocs.builds.automation_actions.trigger_build')
+    def test_action_activation(self, trigger_build):
+        version = get(
+            Version,
+            verbose_name='v2',
+            project=self.project,
+            active=False,
+            type=TAG,
+        )
+        rule = get(
+            RegexAutomationRule,
+            project=self.project,
+            priority=0,
+            match_arg='.*',
+            action=VersionAutomationRule.ACTIVATE_VERSION_ACTION,
+            version_type=TAG,
+        )
+        assert rule.run(version) is True
+        assert version.active is True
+        trigger_build.assert_called_once()
+
+    def test_action_set_default_version(self):
+        version = get(
+            Version,
+            verbose_name='v2',
+            project=self.project,
+            active=True,
+            type=TAG,
+        )
+        rule = get(
+            RegexAutomationRule,
+            project=self.project,
+            priority=0,
+            match_arg='.*',
+            action=VersionAutomationRule.SET_DEFAULT_VERSION_ACTION,
+            version_type=TAG,
+        )
+        assert self.project.get_default_version() == LATEST
+        assert rule.run(version) is True
+        assert self.project.get_default_version() == version.slug