-added logging module so we get pretty JSON display in CloudWatch Logs

-added support for CodePipeline S3 Source (no revisionUrl)
-log the error field if it is returned by channels.history or channels.list (helped with troubleshooting)
-support new bot user with combined oauth bot user token and oauth token
-updated readme with instructions to install with the new Slack App's bot user

Author: rayj-pgi

.gitignore

@@ -102,3 +102,6 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+
+# PyCharm
+.idea/

readme.md

@@ -25,14 +25,16 @@ When creating the CloudFormation stack, you can customize:
 - `SlackBotName` (defaults to `PipelineBuildBot`).
 - `SlackBotIcon` (defaults to `:robot_face:` 🤖 ).
 
-Additionally, you must provide `SlackToken`, (see [BotUsers](https://api.slack.com/custom-integrations/bot-users) for creating a slack bot user with an integration token).
+Additionally, you must provide both a `SlackOAuthAccessToken` and a `SlackBotUserOAuthAccessToken`, (see [BotUsers](https://api.slack.com/bot-users) for creating a slack bot user with an OAuth token). It is required to add the permission scope 'Access user’s public channels' (channels:history).
+
 
 ## How it works
 
 We utilize [CloudWatch Events](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/WhatIsCloudWatchEvents.html) for CodePipline and CodeBuild to get notified of all status changes.
 
 Using the notifications, as well as using the CodePipeline APIs, we are able to present a unified summary of your Pipeline and Build status.
 
+
 ### IAM permissions
 
 As part of the deployment, we create an IAM policy for the bot lambda function of:

src/build_info.py

@@ -1,5 +1,7 @@
 import json
-
+import logging
+logger = logging.getLogger()
+logger.setLevel(logging.INFO)
 
 class CodeBuildInfo(object):
   def __init__(self, pipeline, buildId):
@@ -8,7 +10,7 @@ def __init__(self, pipeline, buildId):
 
   @staticmethod
   def fromEvent(event):
-    print(json.dumps(event, indent=2))
+    logger.info(json.dumps(event, indent=2))
     # strip off leading 'codepipeline/'
     pipeline = event['detail']['additional-information']['initiator'][13:]
     bid = event['detail']['build-id']
@@ -39,9 +41,9 @@ def fromEvent(event):
       detail = event['detail']
       return BuildInfo(detail['execution-id'], detail['pipeline'])
     if event['source'] == "aws.codebuild":
-      print(json.dumps(event, indent=2))
+      logger.info(json.dumps(event, indent=2))
       ph = BuildInfo.pull_phase_info(event)
-      print(json.dumps(ph, indent=2))
+      logger.info(json.dumps(ph, indent=2))
 
     return None
 

src/message_builder.py

@@ -1,6 +1,10 @@
 # -*- coding: utf-8 -*-
 
 import json
+import logging
+logger = logging.getLogger()
+logger.setLevel(logging.INFO)
+
 from collections import OrderedDict
 
 class MessageBuilder(object):
@@ -10,12 +14,12 @@ def __init__(self, buildInfo, message):
     self.messageId = None
 
     if message:
-      print(json.dumps(message, indent=2))
+      logger.info(json.dumps(message, indent=2))
       att = message['attachments'][0]
       self.fields = att['fields']
       self.actions = att.get('actions', [])
       self.messageId = message['ts']
-      print("Actions {}".format(self.actions))
+      logger.info("Actions {}".format(self.actions))
     else:
       self.fields = [
         { "title" : buildInfo.pipeline,
@@ -32,11 +36,18 @@ def needsRevisionInfo(self):
 
   def attachRevisionInfo(self, rev):
     if self.needsRevisionInfo() and rev:
-      self.fields.append({
+      if 'revisionUrl' in rev:
+        self.fields.append({
           "title": "Revision",
           "value": "<{}|{}: {}>".format(rev['revisionUrl'], rev['revisionId'][:7], rev['revisionSummary']),
           "short": True
-      })
+        })
+      else:
+        self.fields.append({
+          "title": "Revision",
+          "value": rev['revisionSummary'],
+          "short": True
+        })
 
   def attachLogs(self, logs):
     self.findOrCreateAction('Build Logs', logs['deep-link'])

src/notifier.py

@@ -5,13 +5,13 @@
 import boto3
 import time
 
-from test_events import TEST_EVENTS, TEST_ERROR_EVENTS
+# from test_events import TEST_EVENTS, TEST_ERROR_EVENTS
 from build_info import BuildInfo, CodeBuildInfo
 from slack_helper import post_build_msg, find_message_for_build
 from message_builder import MessageBuilder
 
-import re
-import sys
+# import re
+# import sys
 
 client = boto3.client('codepipeline')
 

src/slack_helper.py

@@ -1,8 +1,12 @@
 from slackclient import SlackClient
 import os
 import json
+import logging
+logger = logging.getLogger()
+logger.setLevel(logging.INFO)
 
 sc = SlackClient(os.getenv("SLACK_TOKEN"))
+sc_bot = SlackClient(os.getenv("SLACK_BOT_TOKEN"))
 SLACK_CHANNEL = os.getenv("SLACK_CHANNEL", "builds2")
 SLACK_BOT_NAME = os.getenv("SLACK_BOT_NAME", "BuildBot")
 SLACK_BOT_ICON = os.getenv("SLACK_BOT_ICON", ":robot_face:")
@@ -14,10 +18,13 @@ def find_channel(name):
     return CHANNEL_CACHE[name]
 
   r = sc.api_call("channels.list", exclude_archived=1)
-  for ch in r['channels']:
-    if ch['name'] == name:
-      CHANNEL_CACHE[name] = ch['id']
-      return ch['id']
+  if 'error' in r:
+    logger.error("error: {}".format(r['error']))
+  else:
+      for ch in r['channels']:
+        if ch['name'] == name:
+          CHANNEL_CACHE[name] = ch['id']
+          return ch['id']
 
   return None
 
@@ -26,9 +33,13 @@ def find_msg(ch):
 
 def find_my_messages(ch_name, user_name=SLACK_BOT_NAME):
   ch_id = find_channel(ch_name)
-  for m in find_msg(ch_id)['messages']:
-    if m.get('username') == user_name:
-      yield m
+  msg = find_msg(ch_id)
+  if 'error' in msg:
+    logger.error("error: {}".format(msg['error']))
+  else:
+    for m in msg['messages']:
+      if m.get('username') == user_name:
+        yield m
 
 MSG_CACHE = {}
 
@@ -57,7 +68,7 @@ def post_build_msg(msgBuilder):
     ch_id = find_channel(SLACK_CHANNEL)
     msg = msgBuilder.message()
     r = update_msg(ch_id, msgBuilder.messageId, msg)
-    print(json.dumps(r, indent=2))
+    logger.info(json.dumps(r, indent=2))
     if r['ok']:
       r['message']['ts'] = r['ts']
       MSG_CACHE[msgBuilder.buildInfo.executionId] = r['message']
@@ -72,7 +83,7 @@ def post_build_msg(msgBuilder):
   return r
 
 def send_msg(ch, attachments):
-  r = sc.api_call("chat.postMessage",
+  r = sc_bot.api_call("chat.postMessage",
     channel=ch,
     icon_emoji=SLACK_BOT_ICON,
     username=SLACK_BOT_NAME,
@@ -81,9 +92,9 @@ def send_msg(ch, attachments):
   return r
 
 def update_msg(ch, ts, attachments):
-  r = sc.api_call('chat.update',
-  channel=ch,
-  ts=ts,
+  r = sc_bot.api_call('chat.update',
+    channel=ch,
+    ts=ts,
     icon_emoji=SLACK_BOT_ICON,
     username=SLACK_BOT_NAME,
     attachments=attachments

template.yml

@@ -3,7 +3,11 @@ Transform: AWS::Serverless-2016-10-31
 Description: Code Pipeline Slack Notifier
 
 Parameters:
-  SlackToken:
+  SlackOAuthAccessToken:
+    MinLength: 1
+    Type: String
+    NoEcho: True
+  SlackBotUserOAuthAccessToken:
     MinLength: 1
     Type: String
     NoEcho: True
@@ -32,7 +36,8 @@ Resources:
       ReservedConcurrentExecutions: 1
       Environment:
         Variables:
-          SLACK_TOKEN: !Ref SlackToken
+          SLACK_TOKEN: !Ref SlackOAuthAccessToken
+          SLACK_BOT_TOKEN: !Ref SlackBotUserOAuthAccessToken
           SLACK_BOT_NAME: !Ref SlackBotName
           SLACK_BOT_ICON: !Ref SlackBotIcon