kitchen_hooks 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a997335e993e6cded0cb5dfe84803138e646ddc
-  data.tar.gz: f01a6aa92888bbcc0a74d36a9dc763ed8b409c78
+  metadata.gz: fdb2a72a6956b35d41937cde0cee3be69ad832f2
+  data.tar.gz: 8f033c77c713dee2abe2ef435b7ef2d01645bdc6
 SHA512:
-  metadata.gz: 073e0b9b0264c27d8fc27ae2db1c94740b2eaf6a89ea9b7834dd67ff081e951f529fc65d63bf4f883c4e4dd533ccd7bc36273d059c5acf27f03708625d6b340d
-  data.tar.gz: b8298d57885f831d7f8edb496b623fb2524bbfaf44896cf97b5f590c3939575355486f205120c00e6f70cf0e277e0d377bc2416958f105dcb98351245f5e25b3
+  metadata.gz: 9ab833ecddff610020cec29609480d136514a069425a16ab9daaa941c9de9453e5fc5b380a5a5b9bbe72b9a62b5ccc85ce44431f7c48ee9aaa3b42d3ea810dd6
+  data.tar.gz: cbea2a4672b06e4e096e335e7e2efd2220944bc59e1504f6ddd774a81d622cef6993029e76cade61722f43d5999c9725f4fd1ac44d148dc7ff42e60ba57425ce

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kitchen_hooks (1.4.4)
+    kitchen_hooks (1.5.0)
       berkshelf (~> 3)
       chef (~> 11.16.4)
       daybreak (~> 0.3)

data/Readme.md

@@ -32,15 +32,14 @@ Use the `server` command to start the WebHook receiver:
 
 ## TODO
 
-* Add indication of success or failure
 * Use Ridley for data bag, role, and environment uploads to remove Chef dependency
-* Only make changes on commits to `master` branches
-
 
 ## Changelog
 
 ### 1.5
 
+* Add indication of success or failure
+* Only upload on commits to Kitchen `master` branch
 * Add custom timeline icons to distinguish event types
 
 ### 1.4

data/VERSION

@@ -1 +1 @@
-1.5.0
+1.5.1

data/etc/commit.json

@@ -6,51 +6,11 @@
   "user_name": "Sean Clemmer",
   "repository": {
     "name": "Kitchen Hooks",
-    "url": "git@git.bluejeansnet.com:kitchen-hooks.git",
+    "url": "git@git.bluejeansnet.com:chef/kitchen.git",
     "description": "",
-    "homepage": "http://git.bluejeansnet.com/kitchen-hooks"
+    "homepage": "http://git.bluejeansnet.com/kitchen"
   },
   "commits": [
-    {
-      "id": "b635fcb8f05e7503c7e6255a6b3e0cebbf487df3",
-      "message": "Initial script",
-      "timestamp": "2014-11-20T15:45:54-08:00",
-      "url": "http://git.bluejeansnet.com/kitchen-hooks/commit/b635fcb8f05e7503c7e6255a6b3e0cebbf487df3",
-      "author": {
-        "name": "Kelly Wong",
-        "email": "kelly@bluejeans.com"
-      }
-    },
-    {
-      "id": "b76fd9058de0f0236605f1ac12aaa405e905a383",
-      "message": "Add notifications",
-      "timestamp": "2014-11-24T18:23:21-08:00",
-      "url": "http://git.bluejeansnet.com/kitchen-hooks/commit/b76fd9058de0f0236605f1ac12aaa405e905a383",
-      "author": {
-        "name": "Kelly Wong",
-        "email": "kelly@bluejeans.com"
-      }
-    },
-    {
-      "id": "750a5fbb0741977a2b3e5b87e680b8e1beec001e",
-      "message": "Make a gem",
-      "timestamp": "2014-11-25T17:47:16-08:00",
-      "url": "http://git.bluejeansnet.com/kitchen-hooks/commit/750a5fbb0741977a2b3e5b87e680b8e1beec001e",
-      "author": {
-        "name": "Kelly Wong",
-        "email": "kelly@bluejeans.com"
-      }
-    },
-    {
-      "id": "e3727928632d4ac30599c6726e9532b5e0cd86d7",
-      "message": "Remove MIT license",
-      "timestamp": "2014-11-25T18:29:17-08:00",
-      "url": "http://git.bluejeansnet.com/kitchen-hooks/commit/e3727928632d4ac30599c6726e9532b5e0cd86d7",
-      "author": {
-        "name": "Kelly Wong",
-        "email": "kelly@bluejeans.com"
-      }
-    },
     {
       "id": "fb38bcc884a0579cb52836b00589bca653a9c229",
       "message": "Update readme",

data/etc/config.json

@@ -1,10 +1,4 @@
 {
-  "hipchat": {
-    "nick": "Kitchen (bot)",
-    "room": "test",
-    "token": "YOUR_V1_HIPCHAT_TOKEN"
-  },
-  "knives": {
-    "prod": "~/.chef/knife.rb"
-  }
+  "hipchat": null,
+  "knives": {}
 }

data/lib/kitchen_hooks/app.rb

@@ -57,7 +57,7 @@ module KitchenHooks
 
     post '/' do
       request.body.rewind
-      event = JSON::parse request.body.read
+      event = JSON::parse request.body.read rescue nil
       Thread.new do
         process event
       end
@@ -75,39 +75,49 @@ module KitchenHooks
         color: color, notify: notify, message_format: 'html'
     end
 
-    def notify event, type
-      hipchat notification(event, type)
+    def notify entry
+      hipchat notification(entry)
     end
 
-    def mark event, type
+    # error == nil   => success
+    # error == false => nop
+    # otherwise      => failure
+    def mark event, type, error=nil
+      return if error == false
+      entry = { type: type, event: event }
+      entry.merge!(error: error, type: 'failure') if error
       db.synchronize do
-        db[Time.now.to_f] = {
-          type: type,
-          event: event
-        }
+        db[Time.now.to_f] = entry
       end
-      notify event, type
+      db.flush
+      notify entry
     end
 
     def process event
+      if event.nil? # JSON parse failed
+        mark event, 'failure', 'Could not parse WebHook payload'        
+        return
+      end
+
       if commit_to_kitchen?(event)
-        perform_kitchen_upload(event, knives)
-        mark event, 'kitchen upload'
+        possible_error = perform_kitchen_upload(event, knives) \
+          rescue 'Unable to perform kitchen upload'
+        mark event, 'kitchen upload', possible_error
       end
 
       if tagged_commit_to_cookbook?(event) &&
-         tag_name(event) =~ /^v\d+/ # Tagged with version we're releasing
-        perform_cookbook_upload(event, knives)
-        mark event, 'cookbook upload'
+         tag_name(event) =~ /^v\d+/ # Cookbooks tagged with a version
+        possible_error = perform_cookbook_upload(event, knives) \
+          rescue 'Unable to perform cookbook upload'
+        mark event, 'cookbook upload', possible_error
       end
 
       if tagged_commit_to_realm?(event) &&
-         tag_name(event) =~ /^bjn_/ # Tagged with environment we're pinning
-        perform_constraint_application(event, knives)
-        mark event, 'constraint application'
+         tag_name(event) =~ /^bjn_/ # Realms tagged with an environment
+        possible_error = perform_constraint_application(event, knives) \
+          rescue 'Unable to apply constraints'
+        mark event, 'constraint application', possible_error
       end
-
-      db.flush
     end
   end
 end

data/lib/kitchen_hooks/helpers.rb

@@ -11,10 +11,10 @@ Berkshelf.logger = Logger.new $stdout
 
 module KitchenHooks
   module Helpers
+
     def perform_constraint_application event, knives
-      tag = tag_name event
-      tmp_clone event, :tagged_commit do |dir|
-        Dir.chdir dir do
+      tmp_clone event, :tagged_commit do |clone|
+        Dir.chdir clone do
           logger.info 'Applying constraints'
           constraints = lockfile_constraints 'Berksfile.lock'
           environment = tag_name event
@@ -23,9 +23,14 @@ module KitchenHooks
           end
         end
       end
+
+      return nil # no error
     end
 
+
     def perform_kitchen_upload event, knives
+      return false unless commit_to_master?(event)
+
       tmp_clone event, :latest_commit do |clone|
         Dir.chdir clone do
           logger.info 'Uploading data_bags'
@@ -42,13 +47,13 @@ module KitchenHooks
           end
         end
       end
+
+      return nil # no error
     end
 
-    def perform_cookbook_upload event, knives
-      berksfile = nil
 
+    def perform_cookbook_upload event, knives
       tmp_clone event, :tagged_commit do |clone|
-
         Dir.chdir clone do
           tagged_version = tag_name(event).delete('v')
           cookbook_version = File.read('VERSION').strip
@@ -68,8 +73,11 @@ module KitchenHooks
           end
         end
       end
+
+      return nil # no error
     end
 
+
     def berks_upload berksfile, knife, options={}
       ridley = Ridley::from_chef_config knife
       options.merge! \
@@ -85,6 +93,7 @@ module KitchenHooks
       berksfile.upload [], options
     end
 
+
     def tmp_clone event, commit_method, &block
       Dir.mktmpdir do |tmp|
         dir = File::join tmp, cookbook_name(event)
@@ -94,12 +103,14 @@ module KitchenHooks
       end
     end
 
+
     def with_each_knife command, knives
       knives.map do |k|
         `knife #{command} --config #{Shellwords::escape k}`
       end
     end
 
+
     def apply_constraints constraints, environment, knife
       # Ripped from Berkshelf::Cli::apply and Berkshelf::Lockfile::apply
       # https://github.com/berkshelf/berkshelf/blob/master/lib/berkshelf/cli.rb
@@ -112,6 +123,7 @@ module KitchenHooks
       chef_environment.save
     end
 
+
     def lockfile_constraints lockfile_path
       # Ripped from Berkshelf::Cli::apply and Berkshelf::Lockfile::apply
       # https://github.com/berkshelf/berkshelf/blob/master/lib/berkshelf/cli.rb
@@ -123,6 +135,7 @@ module KitchenHooks
       end
     end
 
+
     def upload_environment environment, knife
       # Load the local environment from a JSON file
       local_environment = JSON::parse File.read(environment)
@@ -149,10 +162,13 @@ module KitchenHooks
       chef_environment.save
     end
 
-    def notification event, type
-      case type
+
+    def notification entry
+      return entry[:error] if entry[:error]
+      event = entry[:event]
+      case entry[:type]
       when 'kitchen upload'
-        %Q| <i>#{author(event)}</i> updated <a href="#{gitlab_url(event)}">the Kitchen</a></p> |
+        %Q| <i>#{author(event)}</i> updated <a href="#{gitlab_url(event)}">the Kitchen</a> |
       when 'cookbook upload'
         %Q| <i>#{author(event)}</i> released <a href="#{gitlab_tag_url(event)}">#{tag_name(event)}</a> of <a href="#{gitlab_url(event)}">#{repo_name(event)}</a> |
       when 'constraint application'
@@ -160,40 +176,70 @@ module KitchenHooks
       end.strip
     end
 
+
+    def generic_details event
+      return if event.nil?
+      %Q|
+        <i>#{author(event)}</i> pushed #{push_details(event)}
+      |.strip
+    end
+
+
+    def push_details event
+      return if event.nil?
+      %Q|
+        <a href="#{gitlab_url(event)}">#{event['after']}</a> to <a href="#{repo_url(event)}">#{repo_name(event)}</a>
+      |.strip
+    end
+
+
     def author event
       event['user_name']
     end
 
+
     def repo_name event
       File::basename event['repository']['url'], '.git'
     end
 
+
     def cookbook_name event
       repo_name(event).sub /^(app|base|realm|fork)_/, 'bjn_'
     end
 
+
     def cookbook_repo? event
       repo_name(event) =~ /^(app|base|realm|fork)_/
     end
 
+
+    def repo_url event
+      git_daemon_style_url(event).sub(/^git/, 'http').sub(/\.git$/, '')
+    end
+
+
     def git_daemon_style_url event
       event['repository']['url'].sub(':', '/').sub('@', '://')
     end
 
+
     def gitlab_url event
       url = git_daemon_style_url(event).sub(/^git/, 'http').sub(/\.git$/, '')
       "#{url}/commit/#{event['after']}"
     end
 
+
     def gitlab_tag_url event
       url = git_daemon_style_url(event).sub(/^git/, 'http').sub(/\.git$/, '')
       "#{url}/commits/#{tag_name(event)}"
     end
 
+
     def latest_commit event
       event['commits'].last['id']
     end
 
+
     def tagged_commit event
       event['ref'] =~ %r{/tags/(.*)$}
       return $1 # First regex capture
@@ -201,20 +247,29 @@ module KitchenHooks
 
     alias_method :tag_name, :tagged_commit
 
+
+    def commit_to_master? event
+      event['ref'] == 'refs/heads/master'
+    end
+
+
     def not_deleted? event
       event['after'] != '0000000000000000000000000000000000000000'
     end
 
+
     def commit_to_kitchen? event
       repo_name(event) == 'kitchen' && not_deleted?(event)
     end
 
+
     def tagged_commit_to_cookbook? event
       cookbook_repo?(event) &&
       event['ref'] =~ %r{/tags/} &&
       not_deleted?(event)
     end
 
+
     def tagged_commit_to_realm? event
       tagged_commit_to_cookbook?(event) &&
       repo_name(event) =~ /^realm_/

data/web/app/style/kitchen_hooks.css

@@ -3,7 +3,11 @@ body {
 }
 
 .cd-timeline-img {
-  background: #75ce66;
+  background: #5cb85c;
+}
+
+.failure .cd-timeline-img {
+  background: #d9534f;
 }
 
 .cd-timeline-content {

data/web/public/vendor/img/error.svg

@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<svg width="512" height="512" xmlns="http://www.w3.org/2000/svg">
+
+ <g>
+  <title>background</title>
+  <rect fill="none" id="canvas_background" height="402" width="582" y="-1" x="-1"/>
+ </g>
+ <g>
+  <title>Layer 1</title>
+  <path fill="#ffffff" d="m341.328003,50l-170.656006,0l-120.671997,120.671997l0,170.656006l120.671997,120.671997l170.656006,0l120.671997,-120.671997l0,-170.656006l-120.671997,-120.671997zm-84.868011,348.518005c-16.207001,0 -29.345001,-13.139008 -29.345001,-29.346008c0,-16.204987 13.138,-29.34198 29.345001,-29.34198c16.204987,0 29.34201,13.136993 29.34201,29.34198c0,16.207001 -13.136993,29.346008 -29.34201,29.346008zm38.77301,-240.279007c-2.480988,19.779999 -20.700012,116.080002 -26.722992,147.724014c-1.113007,5.85199 -6.229004,10.099976 -12.187012,10.099976l-0.238983,0c-6.169022,0 -11.438019,-4.378998 -12.588013,-10.437988c-6.100006,-32.121002 -24.292999,-128.503998 -26.735001,-147.970993c-2.940002,-23.440994 15.354004,-44.171005 38.977005,-44.171005c23.936005,0 42.475006,21.005005 39.494995,44.755997z" id="error-3-icon"/>
+ </g>
+</svg>

data/web/views/app.erb

@@ -1,10 +1,9 @@
 <section id="cd-timeline" class="cd-container">
   <% database.reverse.each do |(timestamp, entry)| %>
     <% type = entry[:type] %>
-    <% event = entry[:event] %>
-    <% timestamp = timestamp.to_f %>
-    <% datetime = Time.at(timestamp).iso8601 %>
-    <div class="cd-timeline-block">
+    <% klass = type.sub(' ','-') %>
+    <% datetime = Time.at(timestamp.to_f).iso8601 %>
+    <div class="cd-timeline-block <%= klass %>">
       <div class="cd-timeline-img">
         <% case type %>
         <% when 'kitchen upload' %>
@@ -13,11 +12,19 @@
           <img src="/vendor/img/book.svg" alt="Book">
         <% when 'constraint application' %>
           <img src="/vendor/img/shield.svg" alt="Shield">
+        <% when 'failure' %>
+          <img src="/vendor/img/error.svg" alt="Error">
         <% end %>
       </div>
       <div class="cd-timeline-content">
         <h2><%= type %></h2>
-        <p><%= notification(event, type) %></p>
+        <% if entry[:error] && entry[:event] %>
+          <p><%= notification entry %>. Triggered when <%= generic_details(entry[:event]) %></p>
+        <% elsif entry[:error] # Failed before event generated %>
+          <p><%= notification entry %></p>
+        <% else %>
+          <p><%= notification entry %> by pushing <%= push_details(entry[:event]) %></p>
+        <% end %>
         <span class="cd-date"><time datetime="<%= datetime %>" pubdate="pubdate" class="time-ago" title="<%= datetime %>"><%= datetime %></time></span>
       </div>
     </div>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kitchen_hooks
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Kelly Wong
@@ -167,6 +167,7 @@ files:
 - web/public/vendor/img/book.svg
 - web/public/vendor/img/cd-icon.svg
 - web/public/vendor/img/cutlery.svg
+- web/public/vendor/img/error.svg
 - web/public/vendor/img/shield.svg
 - web/public/vendor/js/bootstrap-v3.3.0.js
 - web/public/vendor/js/jquery-timeago-v1.4.1.js