knife-spork 0.1.8 → 0.1.9

data/README.md

@@ -46,6 +46,11 @@ gist:
   in_chef: true
   chef_path: cookbooks/gist/files/default/gist
   path: /usr/bin/gist
+foodcritic:
+  enabled: true
+  fail_tags: [any]
+  tags: [foo]
+  include_rules: [/home/me/myrules]
 default_environments: [ production, development ]
 ````
 ## Git
@@ -70,6 +75,18 @@ This lets you send to a graphite metric when promote --remote is performed. It s
 
 This allows you to generate an optional gist of environment changes which will be added to irccat notifications on promote --remote. It supports the https://rubygems.org/gems/gist, and contains two parameters to use a version in your chef repo, or a version installed somewhere else locally.
 
+## Foodcritic
+
+This allows you to run a foodcritic lint check against your cookbook before spork uploading. The check only runs against the cookbook you've passed to spork-upload on the command line.
+
+PLEASE NOTE: Due to it's many dependancies (gem dependancy Nokogiri requires libxml-devel, libxslt-devel), foodcritic is not specified as a dependency of the knife-spork gem as it won't install without other manual package installs, so if you want to use it you'll need to make sure it's installed yourself for now. This may change in a future version.
+
+The optional attributes for this section work as follows:
+
+fail_tags: Fail the build if any of the specified tags are matched.
+tags: Only check against rules with the specified tags.
+include_rules: Additional rule file path(s) to load.
+
 ## Default Environments
 
 This allows you to specify a default list of environments you want to promote changes to. If this option is configured and you *ommit* the environment parameter when promoting, ie knife spork promote <cookbook>, then it will promote to all environments in this list.

data/knife-spork.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'knife-spork'
-  s.version           = '0.1.8'
-  s.date              = '2012-02-21'
+  s.version           = '0.1.9'
+  s.date              = '2012-04-03'
   s.rubyforge_project = 'knife-spork'
 
   ## Make sure your summary is short. The description may be as long

data/lib/chef/knife/spork-bump.rb

@@ -83,6 +83,14 @@ module KnifeSpork
         show_usage
         exit 1
       end
+      
+      if !AppConf.git.nil? && AppConf.git.enabled
+        if !@@gitavail
+            ui.msg "Git gem not available, skipping git pull.\n\n"
+        else
+            git_pull_if_repo
+        end
+      end
 
       if bump_type == "manual"
         manual_version = name_args.last
@@ -104,7 +112,6 @@ module KnifeSpork
       end
     end
 
-
     def patch(cookbook_path, cookbook, type)
       t = TYPE_INDEX[type]
       current_version = get_version(cookbook_path, cookbook).split(".").map{|i| i.to_i}
@@ -175,7 +182,45 @@ module KnifeSpork
         end
       end
     end
-  end
+    
+    def git_pull_if_repo
+        strio = StringIO.new
+        l = Logger.new strio
+        cookbook_path = config[:cookbook_path]
+        if cookbook_path.size > 1
+          ui.warn "It looks like you have multiple cookbook paths defined so I can't tell if you're running inside a git repo.\n\n"
+        else
+          begin
+            path = cookbook_path[0].gsub("/cookbooks","")
+            ui.msg "Opening git repo #{path}\n\n"
+            g = Git.open(path, :log => Logger.new(strio))
+            ui.msg "Pulling latest changes from git\n\n"
+            output = IO.popen ("cd #{path} && git pull 2>&1")
+            Process.wait
+            exit_code = $?            
+            if exit_code.exitstatus ==  0
+              ui.msg "#{output.read()}\n"
+            else
+              ui.error "#{output.read()}\n"
+              exit 1
+            end
+
+            ui.msg "Pulling latest changes from git submodules (if any)\n\n"
+            output = IO.popen ("cd #{path} && git submodule foreach git pull 2>&1")
+            Process.wait
+            exit_code = $?
+            if exit_code.exitstatus ==  0
+              ui.msg "#{output.read()}\n"
+            else
+              ui.error "#{output.read()}\n"
+              exit 1
+            end
+          rescue ArgumentError => e
+            ui.warn "Git: The root of your chef repo doesn't look like it's a git repo. Skipping git pull...\n\n"
+          end
+        end
+      end
+    end
 
 end
 

data/lib/chef/knife/spork-promote.rb

@@ -4,7 +4,7 @@
 # License:: Apache License, Version 2.0
 #
 #
-# Uses code from the knife cookbook upload plugin by:
+# Uses some code from the knife cookbook upload plugin by:
 #
 # Author:: Adam Jacob (<adam@opscode.com>)
 # Author:: Christopher Walters (<cw@opscode.com>)
@@ -144,7 +144,7 @@ module KnifeSpork
               ui.msg "Saving changes into #{e}.json"
               new_environment_json = pretty_print(@environment)
               save_environment_changes(e,new_environment_json)
-
+          
               if config[:remote]
                 ui.msg "Uploading #{e} to server"
                 save_environment_changes_remote("#{e}")
@@ -180,7 +180,7 @@ module KnifeSpork
            end
       end
 
-       def valid_version(version)
+      def valid_version(version)
           v = version.split(".")
           if v.size < 3 or v.size > 3
             return false
@@ -191,7 +191,7 @@ module KnifeSpork
              end
           end
           return true
-      end
+       end
 
       def loader
         @loader ||= Chef::Knife::Core::ObjectLoader.new(Chef::Environment, ui)
@@ -215,7 +215,17 @@ module KnifeSpork
           if env_diff.size > 1
             ui.warn "You're about to promote changes to several cookbooks:"
             ui.warn "\n#{env_diff.collect { |k, v| "#{k}: #{v}\n" }.join}"
-            ui.confirm("Are you sure you want to continue?")
+            begin
+              ui.confirm("Are you sure you want to continue")
+            rescue SystemExit => e
+                if e.status == 3
+                  ui.confirm("Would you like to reset your local #{environment}.json to match the server?")
+                  tmp_env = Chef::Environment.load(environment)
+                  save_environment_changes(environment,pretty_print(tmp_env))
+                  puts "#{environment}.json reset."
+                end
+                raise
+            end
           end
           updated.save
 
@@ -250,7 +260,37 @@ module KnifeSpork
             end
           end
             
-            
+          if !AppConf.eventinator.nil? && AppConf.eventinator.enabled
+            metadata = {}
+            metadata[:promoted_cookbooks] = {}
+            promoted_cookbooks = []
+            env_diff.collect do |k,v|
+              v =~ /= ([\d\.]+) changed to = ([\d\.]+)/
+              metadata[:promoted_cookbooks][k] = { :previous_version => $1, :new_version => $2 }
+              promoted_cookbooks << "#{k} (#{$2})"
+            end
+            event_data = {}
+            event_data[:tag]      = "knife"
+            event_data[:username] = ENV['USER']
+            event_data[:status]   = "#{ENV['USER']} promoted #{promoted_cookbooks.join(", ")} to #{environment.gsub(".json","")}"
+            event_data[:metadata] = metadata.to_json
+            uri = URI.parse(AppConf.eventinator.url)
+            http = Net::HTTP.new(uri.host, uri.port)
+            ## TODO: should make this configurable, timeout after 5 sec
+            http.read_timeout = 5;
+            request = Net::HTTP::Post.new(uri.request_uri)
+            request.set_form_data(event_data)
+            begin
+              response = http.request(request)
+              if response.code != "200"
+                ui.warn("Got a #{response.code} from #{AppConf.eventinator.url} promote wasn't eventinated")
+              end 
+            rescue Timeout::Error
+              ui.warn("Timed out connecting to #{AppConf.eventinator.url} promote wasn't eventinated")
+            rescue Exception => msg 
+              ui.warn("An unhandled execption occured while eventinating: #{msg}")
+            end 
+          end
           if !AppConf.graphite.nil? && AppConf.graphite.enabled
             begin
               time = Time.now
@@ -262,7 +302,6 @@ module KnifeSpork
               puts "Something went wrong with sending to graphite: (#{msg})"  
             end
           end
-          
       end
 
       def save_environment_changes(environment,envjson)
@@ -280,10 +319,16 @@ module KnifeSpork
             f2.puts envjson
           end
         end
+        if !AppConf.git.nil? && AppConf.git.enabled
+            if !@@gitavail
+              ui.msg "Git gem not available, skipping git add.\n\n"
+            else
+              git_add(path)
+            end
+        end
       end
 
       def promote(environment,cookbook)
-
         if config[:version]
             if !valid_version(config[:version])
               ui.error("#{config[:version]} isn't a valid version number.")
@@ -294,7 +339,6 @@ module KnifeSpork
         else
            @version = get_version(config[:cookbook_path], cookbook)
         end
-        
         ui.msg "Adding version constraint #{cookbook} = #{@version}"
         return update_version_constraints(environment,cookbook,@version)
       end
@@ -306,9 +350,9 @@ module KnifeSpork
             results << c
           end
           return results
-     end
+      end
      
-    def check_cookbook_uploaded(cookbook)
+      def check_cookbook_uploaded(cookbook)
       if config[:version]
             if !valid_version(config[:version])
               ui.error("#{config[:version]} isn't a valid version number.")
@@ -326,11 +370,11 @@ module KnifeSpork
         ui.msg "#{cookbook} version #{@version } found on server!"
     end
 
-     def pretty_print(environment)
+      def pretty_print(environment)
        return JSON.pretty_generate(JSON.parse(environment.to_json))
      end
 
-     def git_pull_if_repo
+      def git_pull_if_repo
         strio = StringIO.new
         l = Logger.new strio
         cookbook_path = config[:cookbook_path]
@@ -367,10 +411,27 @@ module KnifeSpork
           end
         end
      end
-    end
+     
+      def git_add(environment)
+      strio = StringIO.new
+      l = Logger.new strio
+      cookbook_path = config[:cookbook_path]
+      begin
+        path = cookbook_path[0].gsub("cookbooks","")
+        ui.msg "Opening git repo #{path}\n\n"
+        g = Git.open(path, :log => Logger.new(strio))
+        ui.msg "Git add'ing #{environment}\n\n"
+        g.add("#{environment}")
+      rescue ArgumentError => e
+        ui.warn "Git: The root of your chef repo doesn't look like it's a git repo. Skipping git add...\n\n"
+      rescue
+        ui.warn "Git: Cookbook bump succeeded, but something went wrong with git add #{environment}, so you'll want to manually git add it. Dumping log info..."
+        ui.warn "#{strio.string}"
+      end
+     end
   end
-
-  class String
+end
+class String
       def is_i?
          !!(self =~ /^[-+]?[0-9]+$/)
       end

data/lib/chef/knife/spork-upload.rb

@@ -3,7 +3,9 @@
 # Copyright:: Copyright (c) 2011 Jon Cowie
 # License:: Apache License, Version 2.0
 #
-# Modified cookbook upload to always freeze, and disable --force option
+# Modified cookbook upload to always freeze, and disable --force option, some other options disabled such as
+# updating environment constraints, as this is done later in the spork workflow.
+
 # Based on the knife cookbook upload plugin by:
 #
 # Author:: Adam Jacob (<adam@opscode.com>)
@@ -35,12 +37,18 @@ module KnifeSpork
       CHECKSUM = "checksum"
       MATCH_CHECKSUM = /[0-9a-f]{32,}/
 
+      @@fcavail = true
       deps do
         require 'chef/exceptions'
         require 'chef/cookbook_loader'
         require 'chef/cookbook_uploader'
+        begin
+          require "foodcritic"
+        rescue LoadError
+            @@fcavail = false
+        end
       end
-
+      
       banner "knife spork upload [COOKBOOKS...] (options)"
 
       option :cookbook_path,
@@ -54,12 +62,6 @@ module KnifeSpork
         :description => 'Freeze this version of the cookbook so that it cannot be overwritten',
         :boolean => true
 
-      option :environment,
-        :short => '-E',
-        :long  => '--environment ENVIRONMENT',
-        :description => "Set ENVIRONMENT's version dependency match the version you're uploading.",
-        :default => nil
-
       option :depends,
         :short => "-d",
         :long => "--include-dependencies",
@@ -91,9 +93,7 @@ module KnifeSpork
       
         config[:cookbook_path] ||= Chef::Config[:cookbook_path]
 
-        assert_environment_valid!
         warn_about_cookbook_shadowing
-        version_constraints_to_update = {}
         # Get a list of cookbooks and their versions from the server
         # for checking existence of dependending cookbooks.
         @server_side_cookbooks = Chef::CookbookVersion.list
@@ -112,12 +112,20 @@ module KnifeSpork
                 @name_args.push dep
               end
             end
+            
+            if !AppConf.foodcritic.nil? && AppConf.foodcritic.enabled
+              if !@@fcavail
+                ui.msg "Foodcritic gem not available, skipping cookbook lint check.\n\n"
+              else
+                foodcritic_lint_check(cookbook_name)
+              end
+            end
+            
             ui.info("Uploading and freezing #{cookbook.name.to_s.ljust(justify_width + 10)} [#{cookbook.version}]")
             
             upload(cookbook, justify_width)
             cookbook.freeze_version
             upload(cookbook, justify_width)
-            version_constraints_to_update[cookbook_name] = cookbook.version
                   
             if !AppConf.irccat.nil? && AppConf.irccat.enabled
                 begin
@@ -139,6 +147,39 @@ module KnifeSpork
                end
             end
 
+            if !AppConf.eventinator.nil? && AppConf.eventinator.enabled
+              metadata = {}
+              metadata[:cookbook_name]    = cookbook.name
+              metadata[:cookbook_version] = cookbook.version
+
+              event_data = {}
+              event_data[:tag]      = "knife"
+              event_data[:username] = ENV['USER']
+              event_data[:status]   = "#{ENV['USER']} uploaded and froze version #{cookbook.version} of cookbook #{cookbook_name}"
+              event_data[:metadata] = metadata.to_json
+
+              uri = URI.parse(AppConf.eventinator.url)
+
+              http = Net::HTTP.new(uri.host, uri.port)
+
+              ## TODO: should make this configurable, timeout after 5 sec
+              http.read_timeout = 5;
+
+              request = Net::HTTP::Post.new(uri.request_uri)
+              request.set_form_data(event_data)
+
+              begin
+                response = http.request(request)
+                if response.code != "200"
+                  ui.warn("Got a #{response.code} from #{AppConf.eventinator.url} upload wasn't eventinated")
+                end 
+              rescue Timeout::Error
+                ui.warn("Timed out connecting to #{AppConf.eventinator.url} upload wasn't eventinated")
+              rescue Exception => msg
+                ui.warn("An unhandled execption occured while eventinating: #{msg}")
+              end 
+            end 
+
           rescue Chef::Exceptions::CookbookNotFoundInRepo => e
             ui.error("Could not find cookbook #{cookbook_name} in your cookbook path, skipping it")
             Chef::Log.debug(e)
@@ -146,7 +187,6 @@ module KnifeSpork
         end
 
         ui.info "upload complete"
-        update_version_constraints(version_constraints_to_update) if config[:environment]
       end
 
       def cookbook_repo
@@ -156,18 +196,6 @@ module KnifeSpork
         end
       end
 
-      def update_version_constraints(new_version_constraints)
-        new_version_constraints.each do |cookbook_name, version|
-          environment.cookbook_versions[cookbook_name] = "= #{version}"
-        end
-        environment.save
-      end
-
-
-      def environment
-        @environment ||= config[:environment] ? Chef::Environment.load(config[:environment]) : nil
-      end
-
       def warn_about_cookbook_shadowing
         unless cookbook_repo.merged_cookbooks.empty?
           ui.warn "* " * 40
@@ -186,20 +214,7 @@ WARNING
 
       private
 
-      def assert_environment_valid!
-        environment
-      rescue Net::HTTPServerException => e
-        if e.response.code.to_s == "404"
-          ui.error "The environment #{config[:environment]} does not exist on the server, aborting."
-          Chef::Log.debug(e)
-          exit 1
-        else
-          raise
-        end
-      end
-
       def upload(cookbook, justify_width)
-
         check_for_broken_links(cookbook)
         check_dependencies(cookbook)
         Chef::CookbookUploader.new(cookbook, config[:cookbook_path]).upload_cookbook
@@ -208,6 +223,7 @@ WARNING
         when "409"
           ui.error "Version #{cookbook.version} of cookbook #{cookbook.name} is frozen. Please bump your version number."
           Chef::Log.debug(e)
+          exit 1
         else
           raise
         end
@@ -269,6 +285,35 @@ WARNING
         end
         false
       end
-
+      
+      def foodcritic_lint_check(cookbook_name)
+        
+        if config[:cookbook_path].size > 1
+          ui.warn "It looks like you have multiple cookbook paths defined so I'm not sure where to look for this cookbook.\n\n"
+          ui.warn "Skipping Lint Check.\n\n"
+          return
+        end 
+        
+        fail_tags = []
+        fail_tags = AppConf.foodcritic.fail_tags unless AppConf.foodcritic.fail_tags.nil?
+        
+        tags = []
+        tags = AppConf.foodcritic.tags unless AppConf.foodcritic.tags.nil?
+        
+        include_rules = []
+        include_rules = AppConf.foodcritic.include_rules unless AppConf.foodcritic.include_rules.nil?
+        
+        ui.msg "Lint checking #{cookbook_name}..."
+        options = {:fail_tags => fail_tags, :tags =>tags, :include_rules => include_rules}
+        review = FoodCritic::Linter.new.check("#{config[:cookbook_path][0]}/#{cookbook_name}",options)
+        
+        if review.failed?
+          ui.error "Lint check failed. Halting upload."
+          ui.error "Lint check output:"
+          ui.error review
+          exit 1
+        end
+        ui.msg "Lint check passed"
+      end
     end
   end

data/lib/knife-spork.rb

@@ -1,3 +1,3 @@
 module KnifeSpork
-  VERSION = "0.1.8"
+  VERSION = "0.1.9"
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 8
-  version: 0.1.8
+  - 9
+  version: 0.1.9
 platform: ruby
 authors: 
 - Jon Cowie
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-21 00:00:00 +00:00
+date: 2012-04-03 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency