Global: Add template as a parameter

Summary:

* Add a template parameter that allow to customise the message representation.

* Fix an issue with tags.

* Fix an issue with rules.

* Complete the documentation.

Author: PXke

README.md

@@ -23,6 +23,24 @@ Configure Mattermost:
 - Create an Incoming Webhook
 - Enable override usernames and profile picture icons in System Console Integrations
 
+# Templating
+
+You can change the template per project. It supports markdown. 
+
+To configure the variable you need to write `{myvariable}`
+
+Variable can design any attribute/function of the `group` class in https://github.com/getsentry/sentry/blob/master/src/sentry/models/group.py#L247
+
+By doing `{group@message}` for example. 
+
+Or any attribute/function of the `project` class in https://github.com/getsentry/sentry/blob/master/src/sentry/models/project.py#L78
+
+By doing `{project@status}` for example. 
+
+There are two specific variable `{rules}` and `{tags}` which when you want to include rules or tags will be replace by their content. 
+
+The default value is:
+`"__[{project@get_full_name}]({project@get_absolute_url})__\n__[{group@title}]({group@get_absolute_url})__\n{group@culprit}\n{rules}\n{tags}"`
 
 # Contributing
 We use Docker to setup a development stack. Make sure you have the latest

sentry_mattermost/__init__.py

@@ -2,4 +2,4 @@
     VERSION = __import__('pkg_resources') \
         .get_distribution(__name__).version
 except Exception as e:
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'

sentry_mattermost/plugin.py

@@ -25,15 +25,13 @@
 from sentry_plugins.base import CorePluginMixin
 from sentry.utils import json
 from sentry.integrations import FeatureDescription, IntegrationFeatures
+from string import Formatter
 
 import sentry_mattermost
 
 
 def get_rules(rules, group, project):
-    rules_list = []
-    for rule in rules:
-        rules_list.append(rule.label.encode('utf-8'))
-    return ', '.join('%s' % r for r in rules_list)
+    return ', '.join(rules)
 
 
 def get_tags(event):
@@ -46,36 +44,38 @@ def get_tags(event):
 
 
 class PayloadFactory:
-    @classmethod
-    def render_text(cls, params):
-        template = "__{project}__\n__[{title}]({link})__ \n{culprit}\n"
-        return template.format(**params)
 
     @classmethod
-    def create(cls, plugin, event, rules):
-        group = event.group
-        project = group.project
-
-        if group.culprit:
-            culprit = group.culprit.encode("utf-8")
-        else:
-            culprit = None
-        project_name = project.get_full_name().encode("utf-8")
-
-        params = {
-            "title": group.message_short.encode('utf-8'),
-            "link": group.get_absolute_url(),
-            "culprit": culprit,
-            "project": project_name
-        }
+    def create(cls, plugin, event, template, rules):
+        project = event.group.project
+
+        names = [fn for _, fn, _, _ in Formatter().parse(template)
+                 if fn not in {None, "rules", "tags"}]
+        params = {"rules": "", "tags": ""}
+        for name in names:
+            getter = None
+            particules = name.split("@")
+            for particule in particules:
+                if not getter:
+                    getter = event.__getattribute__(particule)
+                else:
+                    getter = getter.__getattribute__(particule)
+
+            if callable(getter):
+                params[name] = getter()
+            else:
+                params[name] = getter
 
         if plugin.get_option('include_rules', project):
-            params["rules"] = get_rules(rules, group, project)
+            params["rules"] = get_rules(rules, event.group, project)
 
         if plugin.get_option('include_tags', project):
             params["tags"] = get_tags(event)
 
-        text = cls.render_text(params)
+
+        # \n is not correctly interpreted from the text field of sentry
+        template = template.replace("\\n", "\n")
+        text = template.format(**params)
 
         payload = {
             "username": "Sentry",
@@ -122,6 +122,14 @@ def get_config(self, project, **kwargs):
                 "required": True,
                 "help": "Your custom mattermost webhook URL.",
             },
+            {
+                "name": "template",
+                "label": "Template",
+                "type": "string",
+                "required": True,
+                "default": "__[{project@get_full_name}]({project@get_absolute_url})__\n__[{group@title}]({group@get_absolute_url})__\n{group@culprit}\n{rules}\n{tags}",
+                "help": "You can define the template that the plugin will post to mattermost. More info: https://github.com/Biekos/sentry-mattermost",
+            },
             {
                 "name": "include_rules",
                 "label": "Include Rules",
@@ -140,11 +148,13 @@ def get_config(self, project, **kwargs):
     def is_configured(self, project):
         return bool(self.get_option("webhook", project))
 
-    def notify_users(self, group, event, triggering_rules, fail_silently=False, **kwargs):
+    def notify_users(self, group, event, triggering_rules, **kwargs):
         project = event.group.project
         if not self.is_configured(project):
             return
 
         webhook = self.get_option('webhook', project)
-        payload = PayloadFactory.create(self, event, triggering_rules)
+        template = self.get_option('template', project)
+        payload = PayloadFactory.create(
+            self, event, template, triggering_rules)
         return request(webhook, payload)