knife-spork-berks 1.3.2

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

@@ -0,0 +1,298 @@
+require 'knife-spork/plugins/plugin'
+
+module KnifeSpork
+  module Plugins
+    class Irccat < Plugin
+      name :irccat
+
+      TEMPLATES = {
+        :upload  => '#BOLD#PURPLECHEF:#NORMAL %{organization}%{current_user} uploaded #TEAL%{cookbooks}#NORMAL',
+        :promote => '#BOLD#PURPLECHEF:#NORMAL %{organization}%{current_user} promoted #TEAL%{cookbooks}#NORMAL to %{environment} %{gist}',
+        :environmentfromfile  => '#BOLD#PURPLECHEF:#NORMAL %{organization}%{current_user} uploaded environment #TEAL%{object_name}#NORMAL %{gist}',
+        :environmentedit  => '#BOLD#PURPLECHEF:#NORMAL %{organization}%{current_user} edited environment #TEAL%{object_name}#NORMAL %{gist}',
+        :environmentcreate  => '#BOLD#PURPLECHEF:#NORMAL %{organization}%{current_user} created environment #TEAL%{object_name}#NORMAL %{gist}',
+        :environmentdelete  => '#BOLD#PURPLECHEF:#NORMAL %{organization}%{current_user} deleted environment #TEAL%{object_name}#NORMAL %{gist}',
+        :rolefromfile  => '#BOLD#PURPLECHEF:#NORMAL %{organization}%{current_user} uploaded role #TEAL%{object_name}#NORMAL %{gist}',
+        :roleedit  => '#BOLD#PURPLECHEF:#NORMAL %{organization}%{current_user} edited role #TEAL%{object_name}#NORMAL %{gist}',
+        :rolecreate  => '#BOLD#PURPLECHEF:#NORMAL %{organization}%{current_user} created role #TEAL%{object_name}#NORMAL %{gist}',
+        :roledelete  => '#BOLD#PURPLECHEF:#NORMAL %{organization}%{current_user} deleted role #TEAL%{object_name}#NORMAL %{gist}',
+        :databagedit  => '#BOLD#PURPLECHEF:#NORMAL %{organization}%{current_user} edited data bag item #TEAL%{object_name}:%{object_secondary_name}#NORMAL %{gist}',
+        :databagdelete  => '#BOLD#PURPLECHEF:#NORMAL %{organization}%{current_user} deleted data bag #TEAL%{object_name}#NORMAL %{gist}',
+        :databagitemdelete  => '#BOLD#PURPLECHEF:#NORMAL %{organization}%{current_user} deleted data bag item #TEAL%{object_name}:%{object_secondary_name}#NORMAL %{gist}',
+        :databagcreate  => '#BOLD#PURPLECHEF:#NORMAL %{organization}%{current_user} created data bag #TEAL%{object_name}#NORMAL %{gist}',
+        :databagfromfile  => '#BOLD#PURPLECHEF:#NORMAL %{organization}%{current_user} uploaded data bag item #TEAL%{object_name}:%{object_secondary_name}#NORMAL %{gist}',
+        :nodeedit  => '#BOLD#PURPLECHEF:#NORMAL %{organization}%{current_user} edited node #TEAL%{object_name}#NORMAL %{gist}',
+        :nodedelete  => '#BOLD#PURPLECHEF:#NORMAL %{organization}%{current_user} deleted node #TEAL%{object_name}#NORMAL %{gist}',
+        :nodecreate  => '#BOLD#PURPLECHEF:#NORMAL %{organization}%{current_user} created node #TEAL%{object_name}#NORMAL %{gist}',
+        :nodefromfile  => '#BOLD#PURPLECHEF:#NORMAL %{organization}%{current_user} uploaded node #TEAL%{object_name}#NORMAL %{gist}',
+        :noderunlistadd  => '#BOLD#PURPLECHEF:#NORMAL %{organization}%{current_user} added run_list items to #TEAL%{object_name}: %{object_secondary_name}#NORMAL %{gist}',
+        :noderunlistremove  => '#BOLD#PURPLECHEF:#NORMAL %{organization}%{current_user} removed run_list items from #TEAL%{object_name}: %{object_secondary_name}#NORMAL %{gist}',
+        :noderunlistset  => '#BOLD#PURPLECHEF:#NORMAL %{organization}%{current_user} set the  run_list for #TEAL%{object_name} to %{object_secondary_name}#NORMAL %{gist}'
+      }
+
+      def perform; end
+
+      def after_upload
+        irccat(template(:upload) % {
+          :organization => organization,
+          :current_user => current_user,
+          :cookbooks    => cookbooks.collect { |c| "#{c.name}@#{c.version}" }.join(", ")
+        })
+      end
+
+      def after_promote_remote
+        environments.each do |environment|
+          diff = environment_diffs[environment.name]
+          env_gist = env_gist(environment, diff) if config.gist
+          irccat(template(:promote) % {
+            :organization => organization,
+            :current_user => current_user,
+            :cookbooks    => cookbooks.collect{ |c| "#{c.name}@#{c.version}" }.join(", "),
+            :environment  => environment.name,
+            :gist         => env_gist
+          })
+        end
+      end
+
+      def after_environmentfromfile
+        environment_gist = object_gist("environment", object_name, object_difference) if config.gist  and !object_difference.empty?
+        irccat(template(:environmentfromfile) % {
+            :organization => organization,
+            :current_user => current_user,
+            :object_name    => object_name,
+            :gist => environment_gist
+        })
+      end
+
+      def after_environmentedit
+        environment_gist = object_gist("environment", object_name, object_difference) if config.gist  and !object_difference.empty?
+        irccat(template(:environmentedit) % {
+            :organization => organization,
+            :current_user => current_user,
+            :object_name    => object_name,
+            :gist => environment_gist
+        })
+      end
+
+      def after_environmentcreate
+        environment_gist = object_gist("environment", object_name, object_difference) if config.gist  and !object_difference.empty?
+        irccat(template(:environmentcreate) % {
+            :organization => organization,
+            :current_user => current_user,
+            :object_name    => object_name,
+            :gist => environment_gist
+        })
+      end
+
+      def after_environmentdelete
+        environment_gist = object_gist("environment", object_name, object_difference) if config.gist  and !object_difference.empty?
+        irccat(template(:environmentdelete) % {
+            :organization => organization,
+            :current_user => current_user,
+            :object_name    => object_name,
+            :gist => environment_gist
+        })
+      end
+
+      def after_rolefromfile
+        role_gist = object_gist("role", object_name, object_difference) if config.gist  and !object_difference.empty?
+        irccat(template(:rolefromfile) % {
+            :organization => organization,
+            :current_user => current_user,
+            :object_name    => object_name,
+            :gist => role_gist
+        })
+      end
+
+      def after_roleedit
+        role_gist = object_gist("role", object_name, object_difference) if config.gist  and !object_difference.empty?
+        irccat(template(:roleedit) % {
+            :organization => organization,
+            :current_user => current_user,
+            :object_name    => object_name,
+            :gist => role_gist
+        })
+      end
+
+      def after_rolecreate
+        role_gist = object_gist("role", object_name, object_difference) if config.gist  and !object_difference.empty?
+        irccat(template(:rolecreate) % {
+            :organization => organization,
+            :current_user => current_user,
+            :object_name    => object_name,
+            :gist => role_gist
+        })
+      end
+
+      def after_roledelete
+        role_gist = object_gist("role", object_name, object_difference) if config.gist  and !object_difference.empty?
+        irccat(template(:roledelete) % {
+            :organization => organization,
+            :current_user => current_user,
+            :object_name    => object_name,
+            :gist => role_gist
+        })
+      end
+
+      def after_databagedit
+        databag_gist = object_gist("databag item", "#{object_name}:#{object_secondary_name}", object_difference) if config.gist  and !object_difference.empty?
+        irccat(template(:databagedit) % {
+            :organization => organization,
+            :current_user => current_user,
+            :object_name    => object_name,
+            :object_secondary_name    => object_secondary_name,
+            :gist => databag_gist
+        })
+      end
+
+      def after_databagdelete
+        databag_gist = object_gist("databag item", "#{object_name}", object_difference) if config.gist  and !object_difference.empty?
+        irccat(template(:databagdelete) % {
+            :organization => organization,
+            :current_user => current_user,
+            :object_name    => object_name,
+            :gist => databag_gist
+        })
+      end
+
+      def after_databagitemdelete
+        databag_gist = object_gist("databag item", "#{object_name}:#{object_secondary_name}", object_difference) if config.gist  and !object_difference.empty?
+        irccat(template(:databagitemdelete) % {
+            :organization => organization,
+            :current_user => current_user,
+            :object_name    => object_name,
+            :object_secondary_name    => object_secondary_name,
+            :gist => databag_gist
+        })
+      end
+
+      def after_databagcreate
+        databag_gist = object_gist("databag", "#{object_name}", object_difference) if config.gist  and !object_difference.empty?
+        irccat(template(:databagcreate) % {
+            :organization => organization,
+            :current_user => current_user,
+            :object_name    => object_name,
+            :gist => databag_gist
+        })
+      end
+
+      def after_databagfromfile
+        databag_gist = object_gist("databag", "#{object_name}", object_difference) if config.gist  and !object_difference.empty?
+        irccat(template(:databagfromfile) % {
+            :organization => organization,
+            :current_user => current_user,
+            :object_name    => object_name,
+            :object_secondary_name    => object_secondary_name,
+            :gist => databag_gist
+        })
+      end
+
+      def after_nodeedit
+        node_gist = object_gist("node", "#{object_name}", object_difference) if config.gist  and !object_difference.empty?
+        irccat(template(:nodeedit) % {
+            :organization => organization,
+            :current_user => current_user,
+            :object_name    => object_name,
+            :gist => node_gist
+        })
+      end
+
+      def after_nodedelete
+        node_gist = object_gist("node", "#{object_name}", object_difference) if config.gist  and !object_difference.empty?
+        irccat(template(:nodedelete) % {
+            :organization => organization,
+            :current_user => current_user,
+            :object_name    => object_name,
+            :gist => node_gist
+        })
+      end
+
+      def after_nodecreate
+        node_gist = object_gist("node", "#{object_name}", object_difference) if config.gist  and !object_difference.empty?
+        irccat(template(:nodecreate) % {
+            :organization => organization,
+            :current_user => current_user,
+            :object_name    => object_name,
+            :gist => node_gist
+        })
+      end
+
+      def after_nodefromfile
+        node_gist = object_gist("node", "#{object_name}", object_difference) if config.gist  and !object_difference.empty?
+        irccat(template(:nodefromfile) % {
+            :organization => organization,
+            :current_user => current_user,
+            :object_name    => object_name,
+            :gist => node_gist
+        })
+      end
+
+      def after_noderunlistadd
+        node_gist = object_gist("node", "#{object_name}", object_difference) if config.gist  and !object_difference.empty?
+        irccat(template(:noderunlistadd) % {
+            :organization => organization,
+            :current_user => current_user,
+            :object_name    => object_name,
+            :object_secondary_name    => object_secondary_name,
+            :gist => node_gist
+        })
+      end
+
+      def after_noderunlistremove
+        node_gist = object_gist("node", "#{object_name}", object_difference) if config.gist  and !object_difference.empty?
+        irccat(template(:noderunlistremove) % {
+            :organization => organization,
+            :current_user => current_user,
+            :object_name    => object_name,
+            :object_secondary_name    => object_secondary_name,
+            :gist => node_gist
+        })
+      end
+
+      def after_noderunlistset
+        node_gist = object_gist("node", "#{object_name}", object_difference) if config.gist  and !object_difference.empty?
+        irccat(template(:noderunlistset) % {
+            :organization => organization,
+            :current_user => current_user,
+            :object_name    => object_name,
+            :object_secondary_name    => object_secondary_name,
+            :gist => node_gist
+        })
+      end
+
+      private
+      def irccat(message)
+        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
+
+      def env_gist(environment, diff)
+        msg = "Environment #{environment} uploaded at #{Time.now.getutc} by #{current_user}\n\nConstraints updated on server in this version:\n\n#{diff.collect { |k, v| "#{k}: #{v}\n" }.join}"
+        %x[ echo "#{msg}" | #{config.gist}]
+      end
+
+      def object_gist(object_type, object_name, object_diff)
+        msg = "#{object_type.capitalize} #{object_name} changed at #{Time.now.getutc} by #{current_user}\n\nDiff is as follows:\n\n#{object_diff}"
+        %x[ echo "#{msg}" | #{config.gist}]
+      end
+
+      def channels
+        [ config.channel || config.channels ].flatten
+      end
+
+      def template(name)
+        (config.template && config.template[name]) || TEMPLATES[name]
+      end
+    end
+  end
+end

data/lib/knife-spork/plugins/jabber.rb

@@ -0,0 +1,129 @@
+require 'knife-spork/plugins/plugin'
+
+module KnifeSpork
+  module Plugins
+    class Jabber < Plugin
+      name :jabber
+
+      def perform; end
+
+      def after_upload
+        jabber "#{organization}#{current_user} uploaded the following cookbooks:\n#{cookbooks.collect{ |c| "  #{c.name}@#{c.version}" }.join("\n")}"
+      end
+
+      def after_promote_remote
+        jabber "#{organization}#{current_user} promoted the following cookbooks:\n#{cookbooks.collect{ |c| "  #{c.name}@#{c.version}" }.join("\n")} to #{environments.collect{ |e| "#{e.name}" }.join(", ")}"
+      end
+
+      def after_environmentfromfile
+        jabber "#{organization}#{current_user} uploaded environment #{object_name}"
+      end
+
+      def after_environmentedit
+        jabber "#{organization}#{current_user} edited environment #{object_name}"
+      end
+
+      def after_environmentcreate
+        jabber "#{organization}#{current_user} created environment #{object_name}"
+      end
+
+      def after_environmentdelete
+        jabber "#{organization}#{current_user} deleted environment #{object_name}"
+      end
+
+      def after_rolefromfile
+        jabber "#{organization}#{current_user} uploaded role #{object_name}"
+      end
+
+      def after_roleedit
+        jabber "#{organization}#{current_user} edited role #{object_name}"
+      end
+
+      def after_rolecreate
+        jabber "#{organization}#{current_user} created role #{object_name}"
+      end
+
+      def after_roledelete
+        jabber "#{organization}#{current_user} deleted role #{object_name}"
+      end
+
+      def after_databagedit
+        jabber "#{organization}#{current_user} edited data bag item #{object_name}:#{object_secondary_name}"
+      end
+
+      def after_databagcreate
+        jabber "#{organization}#{current_user} created data bag #{object_name}"
+      end
+
+      def after_databagdelete
+        jabber "#{organization}#{current_user} deleted data bag #{object_name}"
+      end
+
+      def after_databagitemdelete
+        jabber "#{organization}#{current_user} deleted data bag item #{object_name}:#{object_secondary_name}"
+      end
+
+      def after_databagfromfile
+        jabber "#{organization}#{current_user} uploaded data bag item #{object_name}:#{object_secondary_name}"
+      end
+
+      def after_nodeedit
+        jabber "#{organization}#{current_user} edited node #{object_name}"
+      end
+
+      def after_nodedelete
+        jabber "#{organization}#{current_user} deleted node #{object_name}"
+      end
+
+      def after_nodecreate
+        jabber "#{organization}#{current_user} created node #{object_name}"
+      end
+
+      def after_nodefromfile
+        jabber "#{organization}#{current_user} uploaded node #{object_name}"
+      end
+
+      def after_noderunlistadd
+        jabber "#{organization}#{current_user} added run_list items to #{object_name}: #{object_secondary_name}"
+      end
+
+      def after_noderunlistremove
+        jabber "#{organization}#{current_user} removed run_list items from #{object_name}: #{object_secondary_name}"
+      end
+
+      def after_noderunlistset
+        jabber "#{organization}#{current_user} set the run_list for #{object_name} to #{object_secondary_name}"
+      end
+
+      private
+
+      def jabber(message)
+        safe_require 'xmpp4r'
+        safe_require 'xmpp4r/muc/helper/simplemucclient'
+
+        client = ::Jabber::Client.new(config.username)
+        client.connect(host = config.server_name, port = config.server_port ||= '5222')
+        client.auth(config.password)
+
+        rooms.each do |room_name|
+          begin
+            conference = ::Jabber::MUC::SimpleMUCClient.new(client)
+            conference.join("#{room_name}/#{nickname}")
+            conference.say(message)
+          rescue Exception => e
+            ui.error 'Something went wrong sending to Jabber.'
+            ui.error e.to_s
+          end
+        end
+      end
+
+      def rooms
+        [ config.room || config.rooms ].flatten
+      end
+
+      def nickname
+        config.nickname || 'KnifeSpork'
+      end
+    end
+  end
+end

data/lib/knife-spork/plugins/plugin.rb

@@ -0,0 +1,105 @@
+module KnifeSpork
+  module Plugins
+    class Plugin
+      # This is the name of the plugin. It must correspond to the name in the yaml configuration
+      # file in order to load this plugin. If an attribute is passed in, the name is set to that
+      # given value. Otherwise, the name is returned.
+      def self.name(name = nil)
+        if name.nil?
+          class_variable_get(:@@name)
+        else
+          class_variable_set(:@@name, name)
+        end
+      end
+
+      # This is a convenience method for defining multiple hooks in a single call.
+      def self.hooks(*the_hooks)
+        [the_hooks].flatten.each{ |the_hook| hook(the_hook) }
+      end
+
+      # When defining a hook, we define a method on the instance that corresponds to that
+      # hook. That will be fired when the hook is fired.
+      def self.hook(the_hook)
+        self.send(:define_method, the_hook.to_sym) do
+          perform
+        end
+      end
+
+      def initialize(options = {})
+        @options = {
+          :payload => {}
+        }.merge(options)
+      end
+
+      def enabled?
+        !(config.nil? || config.enabled == false)
+      end
+
+      private
+      def config
+        @options[:config].plugins.send(self.class.name.to_sym) unless @options[:config].nil? || @options[:config].plugins.nil?
+      end
+
+      def organization
+        unless ::Chef::Config.chef_server_url.nil?
+          split_server_url = Chef::Config.chef_server_url.gsub(/http(s)?:\/\//,"").split('/')
+          if split_server_url.length > 1
+            return "#{split_server_url.last}: "
+          end
+        end
+
+        nil
+      end
+
+      def cookbooks
+        @options[:cookbooks]
+      end
+
+      def environments
+        @options[:environments]
+      end
+
+      def environment_diffs
+        @options[:environment_diffs]
+      end
+
+      def environment_path
+        @options[:environment_path]
+      end
+
+      def cookbook_path
+        @options[:cookbook_path]
+      end
+
+      def object_name
+        @options[:object_name]
+      end
+
+      def object_secondary_name
+        @options[:object_secondary_name]
+      end
+
+      def object_difference
+        @options[:object_difference]
+      end
+
+      def ui
+        @options[:ui]
+      end
+
+      def current_user
+        (begin `git config user.name`.chomp; rescue nil; end || ENV['USERNAME'] || ENV['USER']).strip
+      end
+
+      # Wrapper method around require that attempts to include the associated file. If it does not exist
+      # or cannot be loaded, an nice error is produced instead of blowing up.
+      def safe_require(file)
+        begin
+          require file
+        rescue LoadError
+          raise "You are using a plugin for knife-spork that requires #{file}, but you have not installed it. Please either run \"gem install #{file}\", add #{file} to your Gemfile or remove the plugin from your configuration."
+        end
+      end
+    end
+  end
+end