Automation Rules: allow to invert a match

Ref #7653 Closes #6354
readthedocs · Nov 10, 2020 · e07b73c · e07b73c
1 parent abd3b60
commit e07b73c
Show file tree

Hide file tree

Showing 6 changed files with 70 additions and 9 deletions.
diff --git a/docs/automation-rules.rst b/docs/automation-rules.rst
@@ -82,6 +82,12 @@ You can change the order using the up and down arrow buttons.
 
    New rules are added at the end (lower priority).
 
+Perform action on match
+-----------------------
+
+If this attribute is un-check, the rule will be inverted.
+This means the action will be performed over versions that don't match the pattern.
+
 Examples
 --------
 
@@ -127,9 +133,7 @@ Activate all new tags and branches that start with ``v`` or ``V``
 Activate all new tags that don't contain the ``-nightly`` suffix
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. TODO: update example if https://github.com/readthedocs/readthedocs.org/issues/6354 is approved.
-
-
-- Custom match: ``.*(?<!-nightly)$``
+- Perform action on match: ``False``
+- Custom match: ``-nightly$``
 - Version type: ``Tag``
 - Action: ``Activate version``
diff --git a/readthedocs/builds/forms.py b/readthedocs/builds/forms.py
@@ -110,6 +110,7 @@ class Meta:
         model = RegexAutomationRule
         fields = [
             'description',
+            'on_match',
             'predefined_match_arg',
             'match_arg',
             'version_type',
@@ -128,6 +129,11 @@ def __init__(self, *args, **kwargs):
         self.project = kwargs.pop('project', None)
         super().__init__(*args, **kwargs)
 
+        # Remove the nullable option from the form.
+        # TODO: remove after migration.
+        self.fields['on_match'].widget = forms.CheckboxInput()
+        self.fields['on_match'].empty_value = False
+
         # Only list supported types
         self.fields['version_type'].choices = [
             (None, '-' * 9),
@@ -181,6 +187,7 @@ def save(self, commit=True):
             rule = RegexAutomationRule.objects.add_rule(
                 project=self.project,
                 description=self.cleaned_data['description'],
+                on_match=self.cleaned_data['on_match'],
                 match_arg=self.cleaned_data['match_arg'],
                 predefined_match_arg=self.cleaned_data['predefined_match_arg'],
                 version_type=self.cleaned_data['version_type'],

diff --git a/readthedocs/builds/managers.py b/readthedocs/builds/managers.py
@@ -194,8 +194,7 @@ class VersionAutomationRuleManager(PolymorphicManager):
     """
 
     def add_rule(
-        self, *, project, description, match_arg, version_type,
-        action, action_arg=None, predefined_match_arg=None,
+        self, *, project, description, match_arg, version_type, action, **kwargs,
     ):
         """
         Append an automation rule to `project`.
@@ -219,9 +218,8 @@ def add_rule(
             priority=priority,
             description=description,
             match_arg=match_arg,
-            predefined_match_arg=predefined_match_arg,
             version_type=version_type,
             action=action,
-            action_arg=action_arg,
+            **kwargs,
         )
         return rule
diff --git a/readthedocs/builds/migrations/0028_add_on_match_field.py b/readthedocs/builds/migrations/0028_add_on_match_field.py
@@ -0,0 +1,18 @@
+# Generated by Django 2.2.16 on 2020-11-10 15:45
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('builds', '0027_add_privacy_level_automation_rules'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='versionautomationrule',
+            name='on_match',
+            field=models.BooleanField(default=True, help_text="Perform this action when the pattern matches or when it doesn't match?", null=True, verbose_name='Perform action on match'),
+        ),
+    ]
diff --git a/readthedocs/builds/models.py b/readthedocs/builds/models.py
@@ -965,6 +965,13 @@ class VersionAutomationRule(PolymorphicModel, TimeStampedModel):
         related_name='automation_rules',
         on_delete=models.CASCADE,
     )
+    on_match = models.BooleanField(
+        _('Perform action on match?'),
+        # TODO: remove after migration.
+        null=True,
+        default=True,
+        help_text=_('Perform this action when the pattern matches or when it doesn\'t match?'),
+    )
     priority = models.IntegerField(
         _('Rule priority'),
         help_text=_('A lower number (0) means a higher priority'),
@@ -1034,7 +1041,8 @@ def run(self, version, *args, **kwargs):
         """
         if version.type == self.version_type:
             match, result = self.match(version, self.get_match_arg())
-            if match:
+            # TODO: remove the is None check after migration.
+            if bool(match) is (self.on_match is None or self.on_match):
                 self.apply_action(version, result)
                 return True
         return False

diff --git a/readthedocs/rtd_tests/tests/test_automation_rules.py b/readthedocs/rtd_tests/tests/test_automation_rules.py
@@ -92,6 +92,32 @@ def test_match(
         )
         assert rule.run(version) is result
 
+    @pytest.mark.parametrize('type', [TAG, BRANCH])
+    def test_not_match(self, type):
+        version = get(
+            Version,
+            verbose_name='dont-match',
+            project=self.project,
+            active=False,
+            type=type,
+            built=False,
+        )
+        rule = get(
+            RegexAutomationRule,
+            project=self.project,
+            on_match=False,
+            priority=0,
+            match_arg='^match$',
+            action=VersionAutomationRule.ACTIVATE_VERSION_ACTION,
+            version_type=type,
+        )
+
+        assert rule.run(version) is True
+
+        version.verbose_name = 'match'
+        version.save()
+        assert rule.run(version) is False
+
     @pytest.mark.parametrize(
         'version_name,result',
         [