Merge pull request #61 from totem/develop

0.5.1 Release:  Slack notifications

Author: sukrit007

conf/appconfig.py

@@ -165,6 +165,13 @@
                     .strip().lower() in BOOLEAN_TRUE_VALUES,
                     'token': '',
                     'level': LEVEL_PENDING
+                },
+                'slack': {
+                    'enabled': os.getenv('SLACK_ENABLED', 'false').strip()
+                    .lower() in BOOLEAN_TRUE_VALUES,
+                    'level': LEVEL_FAILED,
+                    'channel': os.getenv('SLACK_CHANNEL', '#totem'),
+                    'url': os.getenv('SLACK_URL'),
                 }
             }
         }

orchestrator/services/job.py

@@ -229,7 +229,10 @@ def get_template_variables(owner, repo, ref, commit=None):
     :return: Template variables
     :rtype: dict
     """
-    ref_number = ref.lower().replace('feature_', '').replace('patch_', '')
+    ref_number = ref.lower()\
+        .replace('feature_', '')\
+        .replace('patch_', '') \
+        .replace('develop_', '')
     commit = commit or 'na'
     return {
         'owner': owner,

orchestrator/tasks/notification.py

@@ -2,6 +2,8 @@
 Tasks for notification
 """
 import json
+
+import time
 from future.builtins import (  # noqa
     bytes, dict, int, list, object, range, str,
     ascii, chr, hex, input, next, oct, open,
@@ -64,6 +66,25 @@ def notify_hipchat(obj, ctx, level, config, security_profile):
                   headers=headers).raise_for_status()
 
 
+@app.task
+def notify_slack(obj, ctx, level, config, security_profile):
+    config = decrypt_config(config, profile=security_profile)
+    ctx.setdefault('github', True)
+    url = config.get('url')
+    notification = util.as_dict(obj)
+    notification['channel'] = config.get('channel')
+    notification['date'] = int(time.time())
+    msg = templatefactory.render_template(
+        'slack.json.jinja', notification=notification, ctx=ctx,
+        level=level)
+    headers = {
+        'content-type': 'application/json',
+    }
+    if url:
+        requests.post(url, data=msg, headers=headers)\
+            .raise_for_status()
+
+
 @app.task
 def notify_github(obj, ctx, level, config, security_profile):
     config = decrypt_config(config, profile=security_profile)
@@ -96,5 +117,5 @@ def notify_github(obj, ctx, level, config, security_profile):
         requests.post(status_url, data=json.dumps(data),
                       headers=headers).raise_for_status()
     else:
-        # Github notification not sent
+        # Github notification is not sent
         pass

orchestrator/templates/slack.json.jinja

@@ -0,0 +1,33 @@
+{
+  "username": "Orchestrator ({{ctx.env}}-{{ctx.operation}})",
+  "channel": "{{ notification.channel or '#totem' }}",
+  "text": " ",
+
+  "attachments": [
+      {
+          "text": "{% if notification.code %}{{ notification.code}}: {% endif %}{{ notification.message | truncate(1000) }} {%if notification.code == 'CONFIG_VALIDATION_ERROR' -%}
+            <https://github.com/totem/cluster-orchestrator/blob/master/schemas/job-config-v1.json | Click here to view the job-config-v1 schema.>
+          {%- endif %} {% if ctx['job-id'] -%}
+            (job-id: {{ ctx['job-id'] }})
+          {%- endif -%}",
+          "color":
+              {% if level == 1 %}
+                "danger"
+              {% elif level == 2 %}
+                "warning"
+              {% elif level == 3 %}
+                "good"
+              {% else %}
+                "#439FE0"
+              {% endif %},
+          "footer":
+              {% if ctx.github %}
+                "<https://github.com/{{ctx.owner}}|{{ctx.owner or 'NA'}}> / <https://github.com/{{ctx.owner}}/{{ctx.repo}}|{{ctx.repo or 'NA'}}> / <https://github.com/{{ctx.owner}}/{{ctx.repo}}/tree/{{ctx.ref}}|{{ctx.ref | truncate(30, True) or 'NA'}}> / <https://github.com/{{ctx.owner}}/{{ctx.repo}}/commit/{{(ctx.commit or ctx.ref or 'NA')[0:7]}}|{{(ctx.commit or ctx.ref or 'NA')[0:7]}}>\n"
+              {% else %}
+                "{{ctx.owner or 'NA'}}/{{ctx.repo or 'NA'}}/{{ctx.ref | truncate(30, True) or 'NA' }}/{{(ctx.commit or 'NA')[0:7]}}"
+              {% endif %},
+          "ts": "{{ notification.date }}"
+      }
+  ]
+
+}

tests/integration/orchestrator/templates/test_slack.py

@@ -0,0 +1,37 @@
+import json
+
+from nose.tools import eq_, ok_
+
+from orchestrator import templatefactory
+
+"""
+Tests for Slack Jinja templates
+"""
+
+
+def test_slack_template():
+    """
+    should render json output for slack API.
+    """
+
+    output = templatefactory.render_template(
+        'slack.json.jinja',
+        ctx={
+            "env": "local",
+            "operation": "test",
+            "owner": "test-owner",
+            "repo": "test-repo",
+            "ref": "test-ref",
+            "github": True,
+            "job-id": "test-job"
+        },
+        notification={
+            "message": "test message",
+            "code": "CONFIG_VALIDATION_ERROR"
+        }, level=1)
+    slack_dict = json.loads(output)
+
+    eq_(slack_dict.get("username"), "Orchestrator (local-test)")
+    eq_(slack_dict.get("channel"), "#totem")
+    ok_(slack_dict.get("text"))
+    ok_(slack_dict.get("attachments"))

tests/unit/orchestrator/services/test_job.py

@@ -345,6 +345,28 @@ def test_template_variables():
     })
 
 
+def test_template_variables_for_develop_branch():
+    """
+    Should return default template variables for job config
+    """
+
+    # When: I get template variables for given repository
+    # owner, repo, ref and commit
+    variables = get_template_variables(
+        MOCK_OWNER, MOCK_REPO, 'develop_test', MOCK_COMMIT)
+
+    # Then: Default variables for the config template are returned
+    dict_compare(variables, {
+        'owner': MOCK_OWNER,
+        'repo': MOCK_REPO,
+        'ref': 'develop_test',
+        'commit': MOCK_COMMIT,
+        'ref_number': 'test',
+        'cluster': CLUSTER_NAME,
+        'env': TOTEM_ENV
+    })
+
+
 def test_create_search_params():
     """
     Should return search parameters for given job

tests/unit/orchestrator/tasks/test_notification.py

@@ -150,6 +150,60 @@ def test_notify_hipchat_for_level_success(m_json, m_templatefactory,
         })
 
 
+@patch('orchestrator.tasks.notification.requests')
+@patch('orchestrator.tasks.notification.templatefactory')
+@patch('orchestrator.tasks.notification.json')
+def test_notify_slack(m_json, m_templatefactory, m_requests):
+    """
+    Should send slack notification
+    :return:
+    """
+    # Given: Template factory that renders html template for notification
+    m_templatefactory.render_template.return_value = '{}'
+
+    # And: Mock implementation for jsonify (for validating data)
+    m_json.dumps.side_effect = lambda data: data
+
+    # When: I send message using slack
+    notification.notify_slack(
+        {'message': 'mock'}, {}, LEVEL_FAILED,
+        {'url': 'http://mockslackurl'},
+        'default')
+
+    # Then: Notification gets send successfully
+    m_requests.post.assert_called_once_with(
+        'http://mockslackurl',
+        headers={
+            'content-type': 'application/json'
+        },
+        data='{}')
+
+
+@patch('orchestrator.tasks.notification.requests')
+@patch('orchestrator.tasks.notification.templatefactory')
+@patch('orchestrator.tasks.notification.json')
+def test_notify_slack_when_url_is_not_set(m_json, m_templatefactory,
+                                          m_requests):
+    """
+    Should not send slack notification
+    :return:
+    """
+    # Given: Template factory that renders html template for notification
+    m_templatefactory.render_template.return_value = '{}'
+
+    # And: Mock implementation for jsonify (for validating data)
+    m_json.dumps.side_effect = lambda data: data
+
+    # When: I send message using slack
+    notification.notify_slack(
+        {'message': 'mock'}, {}, LEVEL_FAILED,
+        {},
+        'default')
+
+    # Then: Notification is not sent
+    m_requests.post.assert_not_called()
+
+
 @patch('orchestrator.tasks.notification.requests')
 @patch('orchestrator.tasks.notification.json')
 def test_github(m_json, m_requests):