Ticket #6135: workflow-post-commit-hook.patch

trac-post-commit-hook.sh

@@ -53 +53 @@
 # In addition, the ':' character can be omitted and issue or bug can be used
 # instead of ticket.
 #
-# You can have more then one command in a message. The following commands
-# are supported. There is more then one spelling for each command, to make
-# this as user-friendly as possible.
-#
-#   close, closed, closes, fix, fixed, fixes
-#     The specified issue numbers are closed with the contents of this
-#     commit message being added to it. 
-#   references, refs, addresses, re, see 
-#     The specified issue numbers are left in their current status, but 
-#     the contents of this commit message are added to their notes. 
+# The hook is configured in the environment's trac.ini's svn-post-commit-hook 
+# section. 
 #
-# A fairly complicated example of what you can do is with a commit message
-# of:
+# You specify commands in terms of groups. An example set of commands would
+# be:
+# 
+#   [svn-post-commit-hook]
+#   command_groups = close, refs
+#   close_commands = close, closed, closes, fix, fixes, fixed
+#   refs_commands = references, refs, addresses, re, see
+#
+# For the purpose of the above settings, 'close' and 'closes' and 'fixes'
+# are all considered identical. Many options are provided to make it as
+# user-friendly as possible to use.
+#
+# As long as at least one command is included in the commit message, the 
+# entire contents of the message will be added to the specified ticket. 
+#
+# You can have more then one command in a message. 
+#
+# In addition to this, you may specify a search list of workflow actions
+# that should be performed if available on the ticket. The first matching
+# action found will be executed; if none of the actions are found in the
+# ticket, the hook will simply give up quietly. Its not considered an
+# error.
+# 
+# Actions are specified as a list named <group>_actions. So the actions 
+# that you want to be executed for commands in close_commands you would
+# specify in close_actions. This is optional; if there are no actions
+# then the command will cause the commit message to be added, and all is
+# fine.
+# 
+#
+# A more complete example that can be used in the basic workflow would be:
+#
+#   [svn-post-commit-hook]
+#   command_groups = close, refs
+#   close_commands = close, closed, closes, fix, fixes, fixed
+#   refs_commands = references, refs, addresses, re, see
+#   close_actions = resolve
+#
+# TODO: How to handle the action 'operations', and in particular from
+#       above set_resolution? Perhaps allow "close_actions = resolve=fixed"
+#       I don't know the API to pass such into the workflow API. Must dig.
+#
+# A fairly complicated example of what you can do is in an enterprise or
+# more complicated workflow would be: 
+#
+#   [svn-post-commit-hook]
+#   command_groups = close, answer, refs
+#   close_commands = close, closed, closes, fix, fixes, fixed
+#   refs_commands = references, refs, addresses, re, see
+#   answer_commands = answer, answers
+#   answer_actions = provideinfo, provideinfo_new
+#   close_actions = test, resolve
+#
+# In the above example, we assume that there are two statuses, "infoneeded"
+# and "infoneeded_new". The former has an action called "provideinfo" that
+# will send the ticket back to Assigned; the latter has an action called
+# "provideinfo_new" that will set the status back to New. 
+#
+# If a commit message has "answers #4", the hook will see if ticket #4 has
+# a provideinfo action; if so it performs it and the ticket becomes Assigned.
+# If it has provideinfo_new instead, the ticket becomes New. Otherwise the
+# ticket is left alone as nothing was specified that is understood in terms
+# of the workflow.
+#
+# The close action will first try to see if the ticket is in a position to
+# be sent to QA via the test action; failing that it'll see if it can be
+# resolved.
+#
+# As with the previous examples, the reference commands do nothing special.
+# 
+# Given the above, the following more complicated message shows how the
+# hook will try to easily parse through what you intend:
 #
 #    Changed blah and foo to do this or that. Fixes #10 and #12, and refs #12.
 #
-# This will close #10 and #12, and add a note to #12.
+# This will send #10 and #12 to QA, and add a note to #12.
 
 import re
 import os
@@ -78 +140 @@
 
 from trac.env import open_environment
 from trac.ticket.notification import TicketNotifyEmail
-from trac.ticket import Ticket
+from trac.ticket import Ticket, TicketSystem
 from trac.ticket.web_ui import TicketModule
 # TODO: move grouped_changelog_entries to model.py
 from trac.util.text import to_unicode
 from trac.util.datefmt import utc
 from trac.versioncontrol.api import NoSuchChangeset
-
+from trac.perm import PermissionCache
+ 
 from optparse import OptionParser
 
 parser = OptionParser()
@@ -123 +186 @@
 command_re = re.compile(ticket_command)
 ticket_re = re.compile(ticket_prefix + '([0-9]+)')
 
-class CommitHook:
-    _supported_cmds = {'close':      '_cmdClose',
-                       'closed':     '_cmdClose',
-                       'closes':     '_cmdClose',
-                       'fix':        '_cmdClose',
-                       'fixed':      '_cmdClose',
-                       'fixes':      '_cmdClose',
-                       'addresses':  '_cmdRefs',
-                       're':         '_cmdRefs',
-                       'references': '_cmdRefs',
-                       'refs':       '_cmdRefs',
-                       'see':        '_cmdRefs'}
+# TODO: This is ugly but the workflow API expects a Request object with a PermissionCache
+# on it to check for the allowability of actions, and I can't see a better way to get
+# about it.
+
+class DummyRequest:
+    def __init__(self, env, username):
+        self.perm = PermissionCache(env, username)
+        #   close_commands = close, closed, closes, fix, fixes, fixed
+        #   refs_commands = references, refs, addresses, re, see
 
+class CommitHook:
+    # The defaults are suitable to mimic previous behavior in an environment that is
+    # using the 'basic' workflow.
+    
+    default_supported_commands = {
+        "close":        "close", 
+        "closes":       "close",
+        "closed":       "close",
+        "fix":          "close",
+        "fixes":        "close",
+        "fixed":        "close",
+        
+        "references":   "refs",
+        "refs":         "refs",
+        "addresses":    "refs",
+        "re":           "refs",
+        "see":          "refs"
+    }
+    
+    default_command_actions = {
+        "close":        ["resolve"],
+        "refs":         []
+    }
+    
     def __init__(self, project=options.project, author=options.user,
                  rev=options.rev, url=options.url):
         self.env = open_environment(project)
         repos = self.env.get_repository()
         repos.sync()
         
+        supported_commands = {}
+        command_actions = {}
+        for group in self.env.config.get('svn-post-commit-hook', 'command_groups').split(','):
+            group = group.strip()
+
+            if not group:
+                continue
+                
+            for command in self.env.config.get('svn-post-commit-hook', '%s_commands' % group).split(','):
+                supported_commands[command.strip()] = group
+            command_actions[group] = self.env.config.get('svn-post-commit-hook', '%s_actions' % group, '').split(',')
+    
+        supported_commands = supported_commands or self.default_supported_commands
+        command_actions = command_actions or self.default_command_actions
+
         # Instead of bothering with the encoding, we'll use unicode data
         # as provided by the Trac versioncontrol API (#1310).
         try:
@@ -157 +256 @@
 
         tickets = {}
         for cmd, tkts in cmd_groups:
-            funcname = CommitHook._supported_cmds.get(cmd.lower(), '')
-            if funcname:
+            command_group = supported_commands.get(cmd.lower(), '')
+            if command_group:
                 for tkt_id in ticket_re.findall(tkts):
-                    func = getattr(self, funcname)
-                    tickets.setdefault(tkt_id, []).append(func)
+                    tickets.setdefault(tkt_id, []).append(command_group)
 
+        req = DummyRequest(self.env, self.author)
+        
         for tkt_id, cmds in tickets.iteritems():
             try:
                 db = self.env.get_db_cnx()
                 
                 ticket = Ticket(self.env, int(tkt_id), db)
-                for cmd in cmds:
-                    cmd(ticket)
 
+                # If multiple commands are given for a particular ticket, then the
+                # first one that has actions set are the actions that will be 
+                # executed.
+                desiredActions = []
+                for cmd in cmds:
+                    desiredActions = desiredActions or command_actions.get(cmd, None)
+                    
                 # determine sequence number... 
                 cnum = 0
                 tm = TicketModule(self.env)
                 for change in tm.grouped_changelog_entries(ticket, db):
                     if change['permanent']:
                         cnum += 1
-                
+
+                # Determine all the actions that the ticket has available
+                availableActions = TicketSystem(self.env).get_available_actions(req, ticket)
+
+                # See if any actions we want are actually available
+                chosenAction = None
+                for action in availableActions:
+                    if action in desiredActions:
+                        chosenAction = action
+                        break
+
+                if chosenAction:                    
+                    controllers = self._get_action_controllers(req, ticket, chosenAction)
+                    for controller in controllers:
+                        changes = controller.get_ticket_changes(req, ticket, action)
+
+                        for key, value in changes.items():
+                            ticket[key] = value
+
                 ticket.save_changes(self.author, self.msg, self.now, db, cnum+1)
                 db.commit()
                 
                 tn = TicketNotifyEmail(self.env)
                 tn.notify(ticket, newticket=0, modtime=self.now)
+                                
             except Exception, e:
-                # import traceback
-                # traceback.print_exc(file=sys.stderr)
                 print>>sys.stderr, 'Unexpected error while processing ticket ' \
                                    'ID %s: %s' % (tkt_id, e)
             
-
-    def _cmdClose(self, ticket):
-        ticket['status'] = 'closed'
-        ticket['resolution'] = 'fixed'
-
-    def _cmdRefs(self, ticket):
-        pass
-
+    def _get_action_controllers(self, req, ticket, action):
+        """Generator yielding the controllers handling the given `action`"""
+        for controller in TicketSystem(self.env).action_controllers:
+            actions = [a for w,a in
+                       controller.get_ticket_actions(req, ticket)]
+            if action in actions:
+                yield controller
 
 if __name__ == "__main__":
     if len(sys.argv) < 5: