knife-wip 0.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2014 Daniel Schauenberg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,115 @@
+# knife-wip
+
+## Overview
+Chef should be the authoritative source of how your infrastructure looks like.
+Ideally what's in Chef is also what's running on the servers. However
+sometimes you have to go into a server, stop Chef and debug something by hand.
+This has all sorts of implications - depending on the length of the work - the
+server won't get updates, drifts out of sync with app configuration and worst
+of all nobody might know. This is why knife-wip provides a tag based way to
+track work in progress in your infrastructure. Knife-wip uses Chef [node
+tags][tags] to track who is working on which servers. This way it supports all
+the great ways of searching for tags and testing for them in Chef recipe and
+doesn't rely on any external setup.
+
+
+## Tag format
+In order to provide an easy and standardized way to retrieve information and
+provide everyone with the maximum amount of information the tag for WIP looks
+like this:
+
+```
+wip:[USERNAME]:[provided description]
+```
+
+This should make it easy to immediately see who has added the WIP tag and what
+they are working on.
+
+
+## Usage
+
+```
+# mark a node as WIP
+% knife node wip web01.example.com testing php build
+Created WIP "wip:dschauenberg:testing php build" for node web01.example.com.
+
+# show all nodes that are marked as WIP
+% knife wip list
+1 nodes found with work in progress
+
+web01.example.com: dschauenberg:testing php build
+
+# remove the WIP tag
+% knife node unwip web01.example.com testing php build
+Deleted WIP description "wip:dschauenberg:testing php build" for node web01.example.com.
+```
+
+## Plugins
+knife-wip has a plugin system that makes it possible to perform custom actions
+when work is started or stopped.
+
+
+### Configuration format
+knife-wip reads its configuration from different files in the following order:
+
+- `$COOKBOOKPATH/config/knife-wip-config.yml`
+- `config/knife-wip-config.yml`
+- `/etc/knife-wip-config.yml`
+- `~/.chef/knife-wip-config.yml`
+
+And the file should be YAML and look something like this:
+
+```
+plugins:
+  irccat:
+    server: irccat.example.com
+    port: 12345
+    channels:
+      - "#chef"
+```
+
+The key of the plugin configuration is what knife-wip uses to try and load the
+corresponding ruby file under `lib/knife-wip/plugins`. So it needs to exist
+there first.
+
+### Plugin format
+A simple plugin just needs to inherit from `KnifeWip::Plugin` and implement
+the two methods `wip_start` and `wip_stop`. Those methods get passed in the
+user, tag and node for the command that was performed. When the plugin gets
+instantiated it also gets its configuration from the config file passed in and
+it's available as the `@config` instance variable in there.
+
+```
+module KnifeWip
+  module Plugins
+    class LolFormatter < KnifeWip::Plugin
+
+      def wip_start(user, tag, node)
+      end
+
+      def wip_stop(user, tag, node)
+      end
+
+
+    end
+  end
+end
+```
+
+
+
+## Installation
+
+```
+gem install knife-wip
+```
+
+
+## Bugs
+Probably. Please file a ticket [here][issues]
+
+
+
+[tags]: https://docs.getchef.com/knife_tag.html
+[issues]: https://github.com/mrtazz/knife-wip/issues
+

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'

data/knife-wip.gemspec

@@ -0,0 +1,20 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'knife-wip'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'knife-wip'
+  gem.version       = KnifeWip::VERSION
+  gem.authors       = ["Daniel Schauenberg"]
+  gem.email         = 'd@unwiredcouch.com'
+  gem.homepage      = 'https://github.com/mrtazz/knife-wip'
+  gem.summary       = "A workflow plugin to track WIP nodes on a chef server"
+  gem.description   = "A workflow plugin to track WIP nodes on a chef server"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'chef', '>= 0.10.4'
+  gem.add_runtime_dependency 'app_conf', '~> 0.4', '>= 0.4.2'
+end

data/lib/chef/knife/knife-wip.rb

@@ -0,0 +1,227 @@
+require 'chef/knife'
+require 'chef/knife/core/node_presenter'
+require 'app_conf'
+
+module KnifeWip
+
+  # Public: collection namespace for some helper functions and methods
+  module Helpers
+
+    # Public: load all plugins that are configured
+    #
+    # this method merely tries to require the plugin files, instantiates an
+    # object from them and then stores it in @plugins. That way the knife
+    # commands can just call all plugins however they want from there.
+    #
+    # Returns nothing
+    def load_plugins
+
+      @plugins ||= []
+
+      app_config[:plugins].to_hash.each do |plugin, plugin_config|
+        begin
+          require "knife-wip/plugins/#{plugin.downcase}"
+          # apparently this is the way to dynamically instantiate ruby objects
+          @plugins << KnifeWip::Plugins.const_get(plugin.capitalize).new(plugin_config)
+        rescue LoadError
+          ui.warn "Configured plugin '#{plugin}' doesn't exist."
+        end
+
+      end
+
+    end
+
+    # Public: get the configuration loaded from the yaml files
+    #
+    # Returns the appconf object with config loaded
+    def app_config
+      return @app_config unless @app_config.nil?
+
+      @app_config = ::AppConf.new
+      load_paths = []
+      # first look for configuration in the cookbooks folder
+      load_paths << File.expand_path("#{cookbook_path.gsub('cookbooks','')}/config/knife-wip-config.yml")
+      # or see if we are in the cookbooks repo
+      load_paths << File.expand_path('config/knife-wip-config.yml')
+      # global config in /etc has higher priority
+      load_paths << '/etc/knife-wip-config.yml'
+      # finally the user supplied config file is loaded
+      load_paths << File.expand_path('~/.chef/knife-wip-config.yml')
+
+      # load all the paths
+      load_paths.each do |load_path|
+        if File.exists?(load_path)
+          @app_config.load(load_path)
+        end
+      end
+
+      @app_config
+    end
+
+    def ensure_cookbook_path!
+      if config[:cookbook_path].nil?
+        ui.fatal "No default cookbook_path; Specify with -o or fix your knife.rb."
+        show_usage
+        exit(1)
+      end
+    end
+
+    def cookbook_path
+      ensure_cookbook_path!
+      [config[:cookbook_path] ||= ::Chef::Config.cookbook_path].flatten[0]
+    end
+
+  end
+
+  # Public: class to inherit from for plugins. Basically a cheap hack to get
+  # some control over whether or not a plugin implements the correct methods
+  class Plugin
+    include ::KnifeWip::Helpers
+
+    def initialize(config)
+      @config = config
+    end
+
+    def wip_start(user, tag, node)
+      ui.warn "Warning: #{self.class} doesn't implement the 'wip_start' method."
+      ui.warn "No announcements performed for #{self.class}"
+    end
+
+    def wip_stop(user, tag, node)
+      ui.warn "Warning: #{self.class} doesn't implement the 'wip_stop' method."
+      ui.warn "No announcements performed for #{self.class}"
+    end
+
+  end
+
+
+  class NodeWip < Chef::Knife
+    include KnifeWip::Helpers
+
+    deps do
+      require 'chef/node'
+    end
+
+    banner "knife node wip NODE DESCRIPTION"
+
+    def run
+      name = @name_args[0]
+      description = @name_args[1..-1]
+
+      if name.nil? || description.nil? || description.empty?
+        show_usage
+        ui.fatal("You must specify a node name and a description of what you are working on.")
+        exit 1
+      end
+
+      self.config = Chef::Config.merge!(config)
+
+      load_plugins
+
+      wip_tag = "wip:#{ENV["USER"]}:#{description.join(" ")}"
+
+      node = Chef::Node.load name
+        (node.tags << wip_tag).uniq!
+      node.save
+      ui.info("Created WIP \"#{wip_tag}\" for node #{name}.")
+      @plugins.each do |plugin|
+        plugin.wip_start(ENV["USER"], description.join(" "), name)
+      end
+    end
+
+  end
+
+  class NodeUnwip < Chef::Knife
+    include KnifeWip::Helpers
+
+    deps do
+      require 'chef/node'
+    end
+
+    banner "knife node unwip NODE DESCRIPTION"
+
+    def run
+      name = @name_args[0]
+      description = @name_args[1..-1].join(" ")
+
+      if name.nil? || description.nil? || description.empty?
+        show_usage
+        ui.fatal("You must specify a node name and a WIP description.")
+        exit 1
+      end
+
+      self.config = Chef::Config.merge!(config)
+
+      load_plugins
+
+      node = Chef::Node.load name
+      tag = "wip:#{ENV["USER"]}:#{description}"
+      success = node.tags.delete(tag).nil? ? false : true
+
+      node.save
+      if success == false
+        message = "Nothing has changed. The WIP description requested to be deleted does not exist."
+      else
+        message = "Deleted WIP description \"#{tag}\" for node #{name}."
+        @plugins.each do |plugin|
+          plugin.wip_stop(ENV["USER"], description, name)
+        end
+      end
+      ui.info(message)
+    end
+
+  end
+
+  class WipList < Chef::Knife
+
+    deps do
+      require 'chef/node'
+      require 'chef/environment'
+      require 'chef/api_client'
+      require 'chef/search/query'
+    end
+
+    include Chef::Knife::Core::NodeFormattingOptions
+
+    banner "knife wip list"
+
+    def run
+      q = Chef::Search::Query.new
+
+      query = URI.escape("tags:wip*", Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+
+      result_items = []
+      result_count = 0
+
+      begin
+        q.search('node', query) do |item|
+          formatted_item = format_for_display(item)
+          result_items << formatted_item
+          result_count += 1
+        end
+      rescue Net::HTTPServerException => e
+        msg = Chef::JSONCompat.from_json(e.response.body)["error"].first
+        ui.error("knife wip list failed: #{msg}")
+        exit 1
+      end
+
+      if ui.interchange?
+        output({:results => result_count, :rows => result_items})
+      else
+        ui.msg "#{result_count} nodes found with work in progress"
+        ui.msg("\n")
+        result_items.each do |item|
+          normalized_tags = []
+          item.tags.each do |tag|
+            next unless tag.start_with? "wip:"
+            tag = tag.split(":")
+            normalized_tags << tag[1, tag.length].join(":")
+          end
+          output("#{item.name}: #{normalized_tags.join(", ")}")
+        end
+      end
+    end
+
+  end
+
+end

data/lib/knife-wip.rb

@@ -0,0 +1,3 @@
+module KnifeWip
+  VERSION = "0.1.0"
+end

data/lib/knife-wip/plugins/eventinator.rb

@@ -0,0 +1,62 @@
+require 'chef/knife'
+
+module KnifeWip
+  module Plugins
+    class Eventinator < KnifeWip::Plugin
+
+      def wip_start(user, tag, node)
+        event_data = {
+            :tag => 'knife',
+            :username => user,
+            :status => "#{user} started work '#{tag}' on #{node}",
+            :metadata => {
+                :node_name => node,
+                :tag => tag
+            }.to_json
+        }
+        eventinate(event_data)
+      end
+
+      def wip_stop(user, tag, node)
+        event_data = {
+            :tag => 'knife',
+            :username => user,
+            :status => "#{user} stopped work '#{tag}' on #{node}",
+            :metadata => {
+                :node_name => node,
+                :tag => tag
+            }.to_json
+        }
+        eventinate(event_data)
+      end
+
+      private
+      def eventinate(event_data)
+          begin
+            uri = URI.parse(@config["url"])
+          rescue Exception => e
+            ui.error 'Could not parse URI for Eventinator.'
+            ui.error e.to_s
+            return
+          end
+
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.read_timeout = @config["read_timeout"] || 5
+
+          request = Net::HTTP::Post.new(uri.request_uri)
+          request.set_form_data(event_data)
+
+          begin
+            response = http.request(request)
+            ui.error "Eventinator at #{@config["url"]} did not receive a good response from the server" if response.code != '200'
+          rescue Timeout::Error
+            ui.error "Eventinator timed out connecting to #{@config["url"]}. Is that URL accessible?"
+          rescue Exception => e
+            ui.error 'Eventinator error.'
+            ui.error e.to_s
+          end
+      end
+
+    end
+  end
+end

data/lib/knife-wip/plugins/irccat.rb

@@ -0,0 +1,44 @@
+module KnifeWip
+  module Plugins
+    class Irccat < KnifeWip::Plugin
+
+      TEMPLATES = {
+        :start => '#BOLD#PURPLECHEF:#NORMAL %{user} started work #TEAL%{tag}#NORMAL on #RED%{node}#NORMAL',
+        :stop  => '#BOLD#PURPLECHEF:#NORMAL %{user} stopped work #TEAL%{tag}#NORMAL on #RED%{node}#NORMAL'
+      }
+
+      def wip_start(user, tag, node)
+        send_to_irccat(TEMPLATES[:start] % {
+            :user => user,
+            :tag  => tag,
+            :node => node,
+        })
+      end
+
+      def wip_stop(user, tag, node)
+        send_to_irccat(TEMPLATES[:stop] % {
+            :user => user,
+            :tag  => tag,
+            :node => node,
+        })
+      end
+
+      private
+      def send_to_irccat(message)
+        @config["channels"].each do |channel|
+          begin
+            # Write the message using a TCP Socket
+            socket = TCPSocket.open(@config["server"], @config["port"])
+            socket.write("#{channel} #{message}")
+          rescue Exception => e
+            ui.error 'Failed to post message with irccat.'
+            ui.error e.to_s
+          ensure
+            socket.close unless socket.nil?
+          end
+        end
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: knife-wip
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Daniel Schauenberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: app_conf
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+description: A workflow plugin to track WIP nodes on a chef server
+email: d@unwiredcouch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- knife-wip.gemspec
+- lib/chef/knife/knife-wip.rb
+- lib/knife-wip.rb
+- lib/knife-wip/plugins/eventinator.rb
+- lib/knife-wip/plugins/irccat.rb
+homepage: https://github.com/mrtazz/knife-wip
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: A workflow plugin to track WIP nodes on a chef server
+test_files: []