hookworm-handlers 0.1.0

data/lib/hookworm/rogue-commit-email-tmpl.erb

@@ -0,0 +1,153 @@
+From: <%= @from %>
+To: <%= @recipients %>
+Subject: [hookworm] Rogue commit by <%= @head_commit_author %> to <%= @repo %> <%= @ref %> (<%= @head_commit_id %>)
+Date: <%= @date %>
+Message-ID: <<%= @message_id %>@<%= @hostname %>>
+List-ID: <%= @repo %> <hookworm.github.com>
+Content-Type: multipart/alternative;
+  boundary="--==ZOMGBOUNDARAAAYYYYY";
+  charset=UTF-8
+Content-Transfer-Encoding: 7bit
+
+----==ZOMGBOUNDARAAAYYYYY
+Date: <%= @date %>
+Mime-Version: 1.0
+Content-Type: text/plain; charset=utf8
+Content-Transfer-Encoding: 7bit
+
+Rogue commit detected!
+
+Repo      <%= @repo %>
+Ref       <%= @ref %>
+ID        <%= @head_commit_id %>
+Author    <%= @head_commit_author %>
+Committer <%= @head_commit_committer %>
+Timestamp <%= @head_commit_timestamp %>
+Message   <%= @head_commit_message_text %>
+
+--
+This email was sent by hookworm:  https://github.com/modcloth-labs/hookworm
+
+A rogue commit is a commit made directly to a branch that is being watched such
+that only pull requests should be merged into them.
+
+The configured watched branches are:
+
+<% (@watched_branches || []).each do |branch| %> - <%= branch %>
+<% end %>
+
+The configured watched paths are:
+
+<% (@watched_paths || []).each do |path| %> - <%= path %>
+<% end %>
+
+
+If you believe this rogue commit email is an error, you should hunt down the
+party responsible for the hookworm instance registered as a WebHook URL in this
+repo's service hook settings (<%= @repo_url %>/settings/hooks).
+
+Pretty please submit issues specific to hookworm functionality on github:
+https://github.com/modcloth-labs/hookworm/issues/new
+
+----==ZOMGBOUNDARAAAYYYYY
+Date: <%= @date %>
+Mime-Version: 1.0
+Content-Type: text/html; charset=utf8
+Content-Transfer-Encoding: 7bit
+
+<div>
+  <h1><a href="<%= @head_commit_url %>">Rogue commit detected!</a></h1>
+
+  <table>
+    <thead><th></th><th></th></thead>
+    <tbody>
+      <tr>
+        <td style="text-align:right;vertical-align:top;">
+          <strong>Repo</strong>:
+        </td>
+        <td><%= @repo %></td>
+      </tr>
+      <tr>
+        <td style="text-align:right;vertical-align:top;">
+          <strong>Ref</strong>:
+        </td>
+        <td><%= @ref %></td>
+      </tr>
+      <tr>
+        <td style="text-align:right;vertical-align:top;">
+          <strong>ID</strong>:
+        </td>
+        <td><a href="<%= @head_commit_url %>"><%= @head_commit_id %></a></td>
+      </tr>
+      <tr>
+        <td style="text-align:right;vertical-align:top;">
+          <strong>Author</strong>:
+        </td>
+        <td><%= @head_commit_author %></td>
+      </tr>
+      <tr>
+        <td style="text-align:right;vertical-align:top;">
+          <strong>Committer</strong>:
+        </td>
+        <td><%= @head_commit_committer %></td>
+      </tr>
+      <tr>
+        <td style="text-align:right;vertical-align:top;">
+          <strong>Timestamp</strong>:
+        </td>
+        <td><%= @head_commit_timestamp %></td>
+      </tr>
+      <tr>
+        <td style="text-align:right;vertical-align:top;">
+          <strong>Message</strong>:
+        </td>
+        <td><%= @head_commit_message_html %></td>
+      </tr>
+    </tbody>
+  </table>
+</div>
+
+<hr/>
+<div style="font-size:.8em">
+  <p>
+    This email was sent by
+    <a href="https://github.com/modcloth-labs/hookworm">hookworm</a>.
+  </p>
+
+  <p>
+    A rogue commit is a commit made directly to a branch that is being watched such
+    that only pull requests should be merged into them.
+  </p>
+
+  <p>
+    The configured watched branches are:
+  </p>
+
+  <ul>
+    <% (@watched_branches || []).each do |branch| %><li><strong><%= branch %></strong></li>
+    <% end %>
+  </ul>
+
+  <p>
+    The configured watched paths are:
+  </p>
+
+  <ul>
+    <% (@watched_paths || []).each do |path| %><li><strong><%= path %></strong></li>
+    <% end %>
+  </ul>
+
+  <p>
+    If you believe this rogue commit email is an error, you should hunt down the
+    party responsible for the hookworm instance registered as a WebHook URL in
+    this repo's <a href="<%= @repo_url %>/settings/hooks">service hook settings</a>.
+  </p>
+
+  <p>
+    Pretty please submit issues specific to hookworm functionality
+    <a href="https://github.com/modcloth-labs/hookworm/issues/new">on github</a>
+  </p>
+
+</div>
+
+----==ZOMGBOUNDARAAAYYYYY--

data/lib/hookworm/rogue_commit_handler.rb

@@ -0,0 +1,240 @@
+# vim:fileencoding=utf-8
+
+require 'erb'
+require 'json'
+require 'net/smtp'
+require 'time'
+require 'uri'
+require 'hookworm-base'
+require 'hookworm/emailer'
+
+module Hookworm
+  # # Hookworm Rogue Commit Handler
+  #
+  # The rogue commit handler is specific to GitHub payloads.  It will inspect a
+  # payload in the context of the given `watched_branches` and `watched_paths`
+  # and send a "rogue commit email" to the email recipients given in
+  # `email_recipients` to provide visibility roughly equivalent to those
+  # commits that result from pull request merges.
+  #
+  # Because the rogue commit handler is affected by so many arguments, here
+  # they are again with more details about their associated behavior:
+  #
+  # ## `watched_branches`
+  # The `watched_branches` argument should be a comma-delimited list of regular
+  # expressions, e.g.: `watched_branches='^master$,^release_[0-9]'`.  If a
+  # commit payload is received that was not the result of a pull request merge
+  # and the Hookworm Annotator handler has determined that the branch name
+  # matches any of the entries in `watched_branches`, then a rogue commit email
+  # will be sent.
+  #
+  # ## `watched_paths`
+  # The `watched_paths` argument should be a comma-delimited list of regular
+  # expressions, e.g.: `watched_paths='.*\.(go|rb|py)$,bin/.*'`.  If a commit
+  # payload is received that was not the result of a pull request merge and the
+  # Hookworm Annotator handler has determined that one of the commits in the
+  # payload contains a path matching any of the entries in `watched_paths`,
+  # then a rogue commit email will be sent.
+  #
+  # ## `email_from_addr`
+  # The `email_from_addr` is the email address used as the `From` header and
+  # SMTP MAIL address when sending rogue commit emails, e.g.:
+  # `email_from_addr='hookworm-noreply@company.example.com'`.
+  #
+  # ## `email_recipients`
+  # The `email_recipients` argument should be a comma-delimited list of email
+  # addresses (without display name) used in the `To` header and SMTP RCPT
+  # addresses when sending rogue commit emails, e.g.:
+  # `email_recipients='devs@example.com,proj+hookworm@partner.example.net'`
+  #
+  # ## `email_uri`
+  # The `email_uri` argument should be a well-formed URI containing the SMTP
+  # hostname and port and potentially the username and password used for plain
+  # SMTP auth, e.g.:
+  # `email_uri='smtp://hookworm:secret@mailhost.example.com:1587'`
+  class RogueCommitHandler
+    include Hookworm::Base
+
+    private
+
+    def handle_github
+      payload = JSON.parse(input_stream.read, symbolize_names: true)
+      begin
+        Judger.new(cfg).judge_payload(payload)
+      rescue StandardError
+        return 1
+      ensure
+        output_stream.puts JSON.pretty_generate(payload)
+      end
+      0
+    end
+
+    def handle_travis
+      78
+    end
+  end
+
+  class Judger
+    attr_reader :cfg
+
+    def initialize(cfg)
+      @cfg = cfg
+    end
+
+    def judge_payload(payload)
+      return unless watched_branch?(payload)
+      hcid = payload[:head_commit][:id]
+      return if pr_merge?(payload, hcid)
+      return unless watched_path?(payload, hcid)
+      safe_send_rogue_commit_email!(payload)
+    end
+
+    def new_judge_payload(payload)
+      return unless watched_branch?(payload)
+      hcid = payload[:head_commit][:id]
+      return if pr_merge?(payload, hcid)
+      return unless watched_path?(payload, hcid)
+      safe_send_rogue_commit_email!(payload)
+    end
+
+    def watched_branch?(payload)
+      unless payload[:is_watched_branch]
+        log.debug { "#{payload[:ref]} is not a watched branch, yay!" }
+        return false
+      end
+
+      log.debug { "#{payload[:ref]} is a watched branch!" }
+      true
+    end
+
+    def pr_merge?(payload, hcid)
+      if payload[:is_pr_merge]
+        log.info { "#{hcid} is a pull request merge, yay!" }
+        return true
+      end
+
+      log.debug { "#{hcid} is not a pull request merge!" }
+      false
+    end
+
+    def watched_path?(payload, hcid)
+      unless payload[:has_watched_path]
+        log.debug { "#{hcid} does not contain watched paths, yay!" }
+        return false
+      end
+
+      log.debug { "#{hcid} contains watched paths!" }
+      true
+    end
+
+    def safe_send_rogue_commit_email!(payload)
+      send_rogue_commit_email!(payload)
+      log.debug { "Sent rogue commit email to #{recipients}" }
+    rescue => e
+      log.error { "#{e.class.name} #{e.message}" }
+      log.debug { e.backtrace.join("\n") }
+      raise e
+    end
+
+    def send_rogue_commit_email!(payload)
+      log_rogue_commit(payload)
+
+      if recipients.empty?
+        log.warn { 'No email recipients specified, so no emailing!' }
+        return
+      end
+
+      email_body = render_email(payload)
+      log.debug { "Email message:\n#{email_body}" }
+
+      emailer.send(fromaddr, recipients, email_body)
+    end
+
+    def render_email(payload)
+      EmailRenderContext.new(self, payload, rogue_commit_email_tmpl).render
+    end
+
+    def rogue_commit_email_tmpl
+      ERB.new(rogue_commit_email_tmpl_string)
+    end
+
+    def rogue_commit_email_tmpl_string
+      File.read(File.expand_path('../rogue-commit-email-tmpl.erb', __FILE__))
+    end
+
+    def recipients
+      @recipients ||= (cfg[:worm_flags][:email_recipients] || '').commasplit
+    end
+
+    def fromaddr
+      @fromaddr ||= cfg[:worm_flags][:email_from_addr]
+    end
+
+    def watched_branches
+      @watched_branches ||= (
+        cfg[:worm_flags][:watched_branches] || ''
+      ).commasplit
+    end
+
+    def watched_paths
+      @watched_paths ||= (cfg[:worm_flags][:watched_paths] || '').commasplit
+    end
+
+    def emailer
+      @emailer ||= Hookworm::Emailer.new(cfg[:worm_flags][:email_uri])
+    end
+
+    def log_rogue_commit(payload)
+      log.warn do
+        "WARNING rogue commit! #{payload}, " <<
+        "head commit: #{payload[:head_commit]}"
+      end
+    end
+
+    def log
+      @log ||= Logger.new($stderr)
+    end
+
+    class EmailRenderContext
+      def initialize(judger, payload, tmpl)
+        assign_judger_vars(judger)
+        assign_payload_vars(payload)
+        @tmpl = tmpl
+        @date = Time.now.utc.rfc2822
+        @message_id = Time.now.strftime('%s%9N')
+        @hostname = Socket.gethostname
+        assign_head_commit_vars(payload[:head_commit])
+      end
+
+      def assign_judger_vars(judger)
+        @cfg = judger.cfg
+        @from = judger.fromaddr
+        @recipients = judger.recipients.join(', ')
+        @watched_branches = judger.watched_branches
+        @watched_paths = judger.watched_paths
+      end
+
+      def assign_payload_vars(payload)
+        @payload = payload
+        @repo = "#{payload[:repository][:owner][:name]}/" <<
+        "#{payload[:repository][:name]}"
+        @ref = payload[:ref]
+        @repo_url = payload[:repository][:url]
+      end
+
+      def assign_head_commit_vars(hc)
+        @head_commit_id = hc[:id]
+        @head_commit_url = hc[:url]
+        @head_commit_author = hc[:author][:name]
+        @head_commit_committer = hc[:committer][:name]
+        @head_commit_message_text = hc[:message].to_plaintext
+        @head_commit_message_html = hc[:message].to_html
+        @head_commit_timestamp = hc[:timestamp]
+      end
+
+      def render
+        @tmpl.result(binding)
+      end
+    end
+  end
+end

data/lib/hookworm/travis_payload_annotator.rb

@@ -0,0 +1,23 @@
+module Hookworm
+  class TravisPayloadAnnotator
+    def annotate(payload)
+      annotated = payload.clone
+      add_repo_slug!(annotated)
+      annotated[:success] = success?(payload)
+      annotated
+    end
+
+    private
+
+    def add_repo_slug!(payload)
+      repo = (payload[:repository] || {})
+      if repo[:owner_name] && repo[:name]
+        repo[:slug] = "#{repo[:owner_name]}/#{repo[:name]}"
+      end
+    end
+
+    def success?(payload)
+      payload[:result] == 0 && payload[:result_message].downcase == 'passed'
+    end
+  end
+end

data/lib/hookworm-handlers.rb

@@ -0,0 +1,7 @@
+module Hookworm
+  autoload :Annotator, 'hookworm/annotator'
+  autoload :BuildIndexHandler, 'hookworm/build_index_handler'
+  autoload :Handlers, 'hookworm/handlers'
+  autoload :LoggingHandler, 'hookworm/logging_handler'
+  autoload :RogueCommitHandler, 'hookworm/rogue_commit_handler'
+end

data/sampledata/github-payloads/bogus.json

@@ -0,0 +1,4 @@
+{
+    "fizz": "buzz",
+    "bonk": 9000
+}

data/sampledata/github-payloads/branch_delete.json

@@ -0,0 +1,41 @@
+{
+  "ref": "refs/heads/ensuring-watched-branches-and-paths-are-quote-free",
+  "after": "0000000000000000000000000000000000000000",
+  "before": "a1fcfc8fe4017bccb4f156ac5a786c08a6968517",
+  "created": false,
+  "deleted": true,
+  "forced": true,
+  "compare": "https://github.com/modcloth-labs/hookworm/compare/a1fcfc8fe401...000000000000",
+  "commits": [],
+  "head_commit": null,
+  "repository": {
+    "id": 10417548,
+    "name": "hookworm",
+    "url": "https://github.com/modcloth-labs/hookworm",
+    "description": "GitHub & Travis hook receiving thingydoo",
+    "homepage": "",
+    "watchers": 2,
+    "stargazers": 2,
+    "forks": 2,
+    "fork": false,
+    "size": 612,
+    "owner": {
+      "name": "modcloth-labs",
+      "email": "labs@modcloth.com"
+    },
+    "private": false,
+    "open_issues": 0,
+    "has_issues": true,
+    "has_downloads": true,
+    "has_wiki": true,
+    "language": "Ruby",
+    "created_at": 1370060266,
+    "pushed_at": 1378653604,
+    "master_branch": "master",
+    "organization": "modcloth-labs"
+  },
+  "pusher": {
+    "name": "meatballhat",
+    "email": "dan@meatballhat.com"
+  }
+}

data/sampledata/github-payloads/pull_request.json

@@ -0,0 +1,153 @@
+{
+  "ref": "refs/heads/master",
+  "after": "d0afb08e931361f179a7e0fd29daec7ca1663233",
+  "before": "926ed297f149354424c1968924bf944c5b69a7ec",
+  "created": false,
+  "deleted": false,
+  "forced": false,
+  "compare": "https://github.com/modcloth-labs/hookworm/compare/926ed297f149...d0afb08e9313",
+  "commits": [
+    {
+      "id": "7afdcae33a1903e52d0290e738b868d944ce3f60",
+      "distinct": true,
+      "message": "Merge pull request #1 from modcloth-labs/payload-parsing-and-emailing\n\nPayload parsing and emaœling",
+      "timestamp": "2013-06-01T19:28:39-07:00",
+      "url": "https://github.com/modcloth-labs/hookworm/commit/7afdcae33a1903e52d0290e738b868d944ce3f60",
+      "author": {
+        "name": "Dan Buch",
+        "email": "daniel.buch@gmail.com",
+        "username": "meatballhat"
+      },
+      "committer": {
+        "name": "Dan Buch",
+        "email": "daniel.buch@gmail.com",
+        "username": "meatballhat"
+      },
+      "added": [
+        "emailer.go",
+        "example-payload.json",
+        "payload.go"
+      ],
+      "removed": [
+
+      ],
+      "modified": [
+        "Makefile",
+        "server.go"
+      ]
+    },
+    {
+      "id": "323fa5bebc49cbeac869a242682a56c83d4566cc",
+      "distinct": true,
+      "message": "Handling JSON nulls all over the place\n\nwhich I may end up reverting in favor of the {}interface + type\nassertion approach.",
+      "timestamp": "2013-06-02T09:42:59-07:00",
+      "url": "https://github.com/modcloth-labs/hookworm/commit/323fa5bebc49cbeac869a242682a56c83d4566cc",
+      "author": {
+        "name": "Dan Buch",
+        "email": "d.buch@modcloth.com",
+        "username": "meatballhat"
+      },
+      "committer": {
+        "name": "Dan Buch",
+        "email": "d.buch@modcloth.com",
+        "username": "meatballhat"
+      },
+      "added": [
+        "sampledata/payload-with-nulls.json",
+        "sampledata/payload.json"
+      ],
+      "removed": [
+        "example-payload.json"
+      ],
+      "modified": [
+        "payload.go",
+        "server.go"
+      ]
+    },
+    {
+      "id": "d0afb08e931361f179a7e0fd29daec7ca1663233",
+      "distinct": true,
+      "message": "Merge pull request #2 from modcloth-labs/payload-parsing-and-emailing\n\nHandling JSON nulls all over the place",
+      "timestamp": "2013-06-02T09:47:08-07:00",
+      "url": "https://github.com/modcloth-labs/hookworm/commit/d0afb08e931361f179a7e0fd29daec7ca1663233",
+      "author": {
+        "name": "Dan Buch",
+        "email": "daniel.buch@gmail.com",
+        "username": "meatballhat"
+      },
+      "committer": {
+        "name": "Dan Buch",
+        "email": "daniel.buch@gmail.com",
+        "username": "meatballhat"
+      },
+      "added": [
+        "sampledata/payload-with-nulls.json",
+        "sampledata/payload.json"
+      ],
+      "removed": [
+        "example-payload.json"
+      ],
+      "modified": [
+        "payload.go",
+        "server.go"
+      ]
+    }
+  ],
+  "head_commit": {
+    "id": "d0afb08e931361f179a7e0fd29daec7ca1663233",
+    "distinct": true,
+    "message": "Merge pull request #2 from modcloth-labs/payload-parsing-and-emailing\n\nHandling JSON nulls all over the place",
+    "timestamp": "2013-06-02T09:47:08-07:00",
+    "url": "https://github.com/modcloth-labs/hookworm/commit/d0afb08e931361f179a7e0fd29daec7ca1663233",
+    "author": {
+      "name": "Dan Buch",
+      "email": "daniel.buch@gmail.com",
+      "username": "meatballhat"
+    },
+    "committer": {
+      "name": "Dan Buch",
+      "email": "daniel.buch@gmail.com",
+      "username": "meatballhat"
+    },
+    "added": [
+      "sampledata/payload-with-nulls.json",
+      "sampledata/payload.json"
+    ],
+    "removed": [
+      "example-payload.json"
+    ],
+    "modified": [
+      "payload.go",
+      "server.go"
+    ]
+  },
+  "repository": {
+    "id": 10417548,
+    "name": "hookworm",
+    "url": "https://github.com/modcloth-labs/hookworm",
+    "description": "github hook receiving thingydoo",
+    "watchers": 0,
+    "stargazers": 0,
+    "forks": 0,
+    "fork": false,
+    "size": 208,
+    "owner": {
+      "name": "modcloth-labs",
+      "email": null
+    },
+    "private": false,
+    "open_issues": 0,
+    "has_issues": true,
+    "has_downloads": true,
+    "has_wiki": true,
+    "language": "Go",
+    "created_at": 1370060266,
+    "pushed_at": 1370191630,
+    "master_branch": "master",
+    "organization": "modcloth-labs"
+  },
+  "pusher": {
+    "name": "none"
+  },
+  "is_pr_merge": true
+}