Em uma das reuniões dessa última semana na empresa onde trabalho surgiu uma necessidade simples de comunicação: Precisamos que toda a equipe saiba quando um novo release de algum dos nossos repositórios for criado no Github.
Como usamos o Slack como ferramenta de comunicação interna, na hora já pensei:
“Esta é a minha chance de criar um bot para o Slack!”
Sempre tive vontade de fazer algo para o Slack, mas não tinha conseguido achar um tempo e nem um motivo específico para isso. Eu já imaginava que para esse objetivo, avisar sobre um novo release, não seria algo complicado.
Realmente não foi. Em apenas algumas linhas deu pra criar um bot que conecta os webhooks do Github e do Slack utilizando o Flask como meio-campo.
Abaixo o código final da primeira versão.
# coding: utf-8
import os
import requests
from flask import Flask
from flask import request
app = Flask(__name__)
slack_webhook_url = os.getenv('SLACK_WEBHOOK_URL')
@app.route("/", methods=['POST', ])
def webhook():
action = request.json['action']
release = request.json['release']
repository = request.json['repository']
slack_data = {
"text": "A new release from *{repo_name}* was {action}!\n"
"Click <{release_url}|Release {tag_name}> for more details".format(action=action,
repo_name=repository['name'],
release_url=release['url'],
tag_name=release['tag_name'])
}
response = requests.post(slack_webhook_url, json=slack_data)
if response.status_code != 200:
raise ValueError(
'Request to slack returned an error {}, the response is:\n{}'.format(response.status_code,
response.text)
)
return ""
Pelo pouco tempo que passei lendo sobre como fazer um bot para o Slack eu entendi que você cadastra um Incoming Webhook e eles geram uma URL a qual você irá executar um request do tipo POST enviando a mensagem que você quer que um canal específico receba.
É realmente muito simples, porque a própria URL já carrega os tokens que são gerados para você.
Existem diversas outras funcionalidades que podem ser criadas em um bot para o Slack e a documentação deles cobre tudo. Mas vou falar apenas desse pequeno release-alert que criei.
Explicando linha por linha
Antes de começar a escrever o código vou precisar do Flask e de alguns outros pacotes. Então começo ainda na linha de comando do shell.
$ pip install Flask $ pip install requests
Depois eu coloco a URL que gerei no Incoming Webhooks do Slack em uma variável de ambiente que chamo de SLACK_WEBHOOK_URL. Depois basta importá-la para dentro do código.
$ export SLACK_WEBHOOK_URL=<aqui vai a url do webhook do slack>
Agora crio meu arquivo Python chamado bot.py. Como estou usando o Flask, só vou precisar desse arquivo e praticamente nada mais.
Nas primeiras linhas começo importando o que vou utilizar e criando o app do Flask.
import os import requests from flask import Flask from flask import request app = Flask(__name__)
Trago para dentro do código a variável de ambiente que criei antes.
slack_webhook_url = os.getenv('SLACK_WEBHOOK_URL')
Agora vou começar a montar o meu endpoint. Ele receberá um evento POST enviado pelo webhook do Github. Para que isso aconteça você precisa cadastrar uma URL de webhook no settings do seu projeto no Github.
No meu caso, eu cadastrei a webhook no settings da organização, já que queria que todos os projetos da empresa disparassem o aviso. Mas funciona do mesmo jeito em qualquer um dos casos.
Quando cadastrei o meu webhook no Github especifiquei que gostaria de receber apenas os eventos relacionados ao release dos projetos.
Para testar o código localmente eu utilizei o ngrok. Explico como usar o ngrok em outra publicação.
@app.route("/", methods=['POST', ])
def webhook():
As primeiras linhas do meu endpoint capturam as informações que eu preciso do corpo enviado pelo POST do webhook do Github.
action = request.json['action'] release = request.json['release'] repository = request.json['repository']
O Flask facilita recuperar informações de um corpo de um request JSON com o seu objeto request nativo. Basta chamar request.json e ele retorna um dicionário.
Agora eu vou montar o corpo da mensagem que enviarei para o Slack. O formato pedido é muito simples: um JSON com um campo ‘text’.
slack_data = {
"text": "A new release from *{repo_name}* was {action}!\n"
"Click <{release_url}|Release {tag_name}> for more details".format(action=action,
repo_name=repository['name'],
release_url=release['url'],
tag_name=release['tag_name'])
}
Esse dicionário será transformado em um JSON pela próxima linha. O pacote requests já resolve isso para mim através do argumento json.
response = requests.post(slack_webhook_url, json=slack_data)
if response.status_code != 200:
raise ValueError(
'Request to slack returned an error {}, the response is:\n{}'.format(response.status_code,
response.text)
)
return ""
No final do arquivo estou apenas tratando algum possível erro. Caso o requests retorne um status_code diferente de 200 eu levanto uma exceção.
No final retorno uma string vazia, porque cada endpoint do Flask precisa retornar alguma coisa para não levantar erros.
Para que meu bot fique disponível o tempo todo, fiz um deploy na minha conta gratuita do Heroku. E voilá!
