Add models for automation rules #5323

stsewd · 2019-02-20T21:37:44Z

Still wip, I would like some input. I want to use the same pattern that we use for subclassing Integrations. Also, not sure if the model is fine in the builds app or if I should create a new app. I'm subclassing regex as a simple example for now.

Ref #4001

stsewd · 2019-02-20T21:49:53Z

readthedocs/builds/models.py

+        max_length=32,
+        choices=RULE_TYPES,
+    )
+    rule_arg = models.CharField(


Should this be rule_args? I can only think of one arg for the rule.

stsewd · 2019-02-20T21:51:00Z

readthedocs/builds/models.py

+        max_length=32,
+        choices=ACTIONS,
+    )
+    action_arg = models.CharField(


Same here, but I can think of some cases where we could need more than one. But, this also could be solved by creating several rules with different action_arg.

How is this action_arg used from a user perspective and what is it useful for?

Any extra option needed to execute the action. Like, I want to activate the version and set the privacy to public/private. But I can think this can be solved by creating two rules. First activate version v and a second one set version v to public/private.

I'd say that we should keep this simple for now.

If 2 actions are needed for a specific version (match rule), two entries should be created. I'd remove the action_arg for now, and add it later if we find that we need it.

stsewd · 2019-02-20T21:53:18Z

readthedocs/builds/models.py

+                return self.apply_action(version, match_result, self.action_arg)
+        return False
+
+    def match(self, version, arg):


I'm thinking is passing *args and **kwargs to match and apply_action, still not sure. And maybe select a better name for arg. Or just use self.rule_arg, but this makes it easier to test :)

I think it could be better to use self.rule_arg inside the method because it will more clear when reading the code and it's a common pattern.

stsewd · 2019-02-28T16:13:36Z

django-polymorphic works great with proxy models, no extra tables :). I'm asking for an early review here.

humitos

This is good. I like the pattern designed here.

readthedocs/builds/models.py

humitos · 2019-03-04T11:13:31Z

readthedocs/builds/models.py

+        proxy = True
+
+    def match(self, version, arg):
+        regex = re.compile(arg)


There is no need to compile the regex if it will be used just once. You can just call re.match directly.

humitos · 2019-03-04T11:15:03Z

readthedocs/builds/models.py

+
+    def match(self, version, arg):
+        """
+        Returns an object different from None if the version matches the rule.


I think it's better to return True if it matches and False if there is no matching.

What is the match_result useful for?

Actually, in case that match_result would be useful for something I'd suggest to have a specific method for that and leave match returning a boolean.

We need to pass the match result, in case of regex, that would be used to capture the groups in a later phase of the feature.

How exactly that "later phase of the feature" will use it?

I mean, I don't see how the match result will be useful from a user's perspective. Or, how the user will have access to it.

In case we need it internally, how are we going to us it?

humitos · 2019-03-04T11:16:59Z

readthedocs/builds/models.py

+        max_length=32,
+        choices=ACTIONS,
+    )
+    action_arg = models.CharField(


How is this action_arg used from a user perspective and what is it useful for?

readthedocs/builds/models.py

humitos · 2019-03-04T11:22:58Z

readthedocs/builds/models.py

+                return self.apply_action(version, match_result, self.action_arg)
+        return False
+
+    def match(self, version, arg):


I think it could be better to use self.rule_arg inside the method because it will more clear when reading the code and it's a common pattern.

humitos · 2019-03-04T11:26:09Z

readthedocs/builds/automation_actions.py

@@ -0,0 +1,2 @@
+def activate_version_from_regex_action(version, match_result, arg):


Is it needed to be specific here on from_regex_action?

I suppose that this function should be just like version.active = True and version.save(). No need to use match_result nor arg here.

All function actions will receive all the parameters. Match result and arg was explained above ^

stsewd · 2019-03-04T21:44:46Z

For the moment I'm going to assume that having separate rules is the way to go instead of having extra parameters (only for the names, models will still have that till final decision).

/cc @agjohnson

stsewd · 2019-03-04T22:24:59Z

readthedocs/builds/admin.py

@@ -48,7 +56,6 @@ def version_name(self, obj):


 class VersionAdmin(GuardedModelAdmin):
-    search_fields = ('slug', 'project__name')


This was repeated below

stsewd · 2019-03-04T22:28:35Z

This is ready for review, consider #5323 (comment)

This is how the admin looks like, we can expand it with search and other stuff as we need them.

humitos · 2019-03-05T08:53:59Z

For the moment I'm going to assume that having separate rules is the way to go instead of having extra parameters (only for the names, models will still have that till final decision).

I agree with this.

Also, it may worth to find other services that allow these kind of rules and see how they handle this case. Docker Hub for example, does something simple where you write a regex rule to be tagged as a Docker tag, like ^releases/3\.[0-9]$ will be tagged as 3.x. That's all.

stsewd · 2019-04-26T00:47:06Z

It wasn't so much code after all, need to write tests though

stsewd · 2019-04-26T00:50:42Z

readthedocs/restapi/views/model_views.py

+                project.slug, added_versions
+            )
+
+        # TODO: move this to an automation rule


I wanted to move this to the run_automation_rules function, but it depends on the previous state of one version. It can be refactored for later

stsewd · 2019-04-29T22:39:00Z

Test are written 📖 and as usual they helped me to fix bugs on time :)

humitos

💯

I suppose that at this point, I will have to accept the usage of re.search ;)

readthedocs/restapi/views/model_views.py

humitos · 2019-05-09T08:21:03Z

👍

humitos · 2019-05-20T14:00:40Z

@stsewd I think this PR is ready to merge. Can you please resolve the conflicts so we can merge it?

stsewd · 2019-05-20T18:26:28Z

Done 👍

Add models for automation rules

2ae80d1

stsewd mentioned this pull request Feb 20, 2019

Make subclassing reusable #5324

Closed

stsewd added the PR: work in progress Pull request is not ready for full review label Feb 20, 2019

stsewd marked this pull request as ready for review February 20, 2019 21:41

stsewd commented Feb 20, 2019

View reviewed changes

stsewd added 3 commits February 28, 2019 10:34

Merge branch 'master' into add-models-for-automationrules

d0e04e0

Use django-polymorphic with proxy models

d53bad2

Add migration

d287286

stsewd requested a review from a team February 28, 2019 16:13

humitos reviewed Mar 4, 2019

View reviewed changes

stsewd mentioned this pull request Mar 4, 2019

Refactor Integration models to use django-polymorphic #5394

Open

stsewd added 7 commits March 4, 2019 12:49

Merge branch 'master' into add-models-for-automationrules

c5e6010

Refactor and suggestions from review

cb5e1b9

Update migration

4fd56f6

Implement activation action

e570a58

Clean model

353bc8a

Tests!

7a60668

Refactor name

409e960

stsewd added 2 commits March 4, 2019 17:23

Refactor models

8f58e77

Integrate in admin

8dfe290

stsewd commented Mar 4, 2019

View reviewed changes

stsewd removed the PR: work in progress Pull request is not ready for full review label Mar 4, 2019

stsewd requested review from agjohnson and a team March 4, 2019 22:28

Execute automation rules on new versions

a2c50ac

Typo

0f06958

stsewd commented Apr 26, 2019

View reviewed changes

Trigger build after activate

bf2f954

stsewd added the Needed: tests Tests are required label Apr 26, 2019

stsewd added 8 commits April 29, 2019 11:56

Better admin page

73030c0

More tests

6237ca4

More tests

25faa28

Test from api call

eda1cd2

Tests for set_default_version

39c8cc5

Fix test

a6d959d

Docs

2ae831d

Period

78e6e62

stsewd removed the Needed: tests Tests are required label Apr 29, 2019

Merge branch 'master' into add-models-for-automationrules

5d0c706

stsewd requested review from humitos and a team April 30, 2019 05:03

humitos approved these changes Apr 30, 2019

View reviewed changes

readthedocs/restapi/views/model_views.py Outdated Show resolved Hide resolved

stsewd mentioned this pull request May 1, 2019

Automation rules: track commit time in versions #5649

Open

stsewd added 2 commits May 8, 2019 21:22

Merge branch 'master' into add-models-for-automationrules

b2a1339

Notes about the versions order

b07b660

stsewd added 2 commits May 20, 2019 11:35

Merge branch 'master' into add-models-for-automationrules

a86d427

Fix mock

cbce26a

humitos merged commit ae7c700 into readthedocs:master May 21, 2019

stsewd deleted the add-models-for-automationrules branch May 21, 2019 14:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add models for automation rules #5323

Add models for automation rules #5323

stsewd commented Feb 20, 2019 •

edited

Loading

stsewd Feb 20, 2019

stsewd Feb 20, 2019

humitos Mar 4, 2019

stsewd Mar 4, 2019

humitos Mar 5, 2019

stsewd Feb 20, 2019

humitos Mar 4, 2019

stsewd commented Feb 28, 2019 •

edited

Loading

humitos left a comment

humitos Mar 4, 2019

humitos Mar 4, 2019

humitos Mar 4, 2019

stsewd Mar 4, 2019

humitos Mar 5, 2019

humitos Mar 5, 2019

humitos Mar 4, 2019

humitos Mar 4, 2019

humitos Mar 4, 2019

stsewd Mar 4, 2019

stsewd commented Mar 4, 2019

stsewd Mar 4, 2019

stsewd commented Mar 4, 2019

humitos commented Mar 5, 2019

stsewd commented Apr 26, 2019

stsewd Apr 26, 2019

stsewd commented Apr 29, 2019

humitos left a comment

humitos commented May 9, 2019

humitos commented May 20, 2019

stsewd commented May 20, 2019

		@@ -0,0 +1,2 @@
		def activate_version_from_regex_action(version, match_result, arg):

		@@ -48,7 +56,6 @@ def version_name(self, obj):


		class VersionAdmin(GuardedModelAdmin):
		search_fields = ('slug', 'project__name')

Add models for automation rules #5323

Add models for automation rules #5323

Conversation

stsewd commented Feb 20, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stsewd commented Feb 28, 2019 • edited Loading

humitos left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stsewd commented Mar 4, 2019

Choose a reason for hiding this comment

stsewd commented Mar 4, 2019

humitos commented Mar 5, 2019

stsewd commented Apr 26, 2019

Choose a reason for hiding this comment

stsewd commented Apr 29, 2019

humitos left a comment

Choose a reason for hiding this comment

humitos commented May 9, 2019

humitos commented May 20, 2019

stsewd commented May 20, 2019

stsewd commented Feb 20, 2019 •

edited

Loading

stsewd commented Feb 28, 2019 •

edited

Loading