knife-spork 1.2.2 → 1.3.0

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 1.3.0 (23rd October, 2013)
+
+Features:
+
+    - Allow a custom plugin path to be specified in config to load additional plugins from (https://github.com/jonlives/knife-spork/issues/59)
+    - Spork check will prompt for a bump if one is needed (https://github.com/jonlives/knife-spork/issues/82)
+    - Spork omni command added to perform bump, upload and promote in a single step (https://github.com/jonlives/knife-spork/issues/49)
+    - Spork role, data bag and node commands added (https://github.com/jonlives/knife-spork/issues/81)
+
+Bugfixes:
+
+    - Remove legacy code referring to "promote all cookbooks" (https://github.com/jonlives/knife-spork/issues/76)
+    - Fix incorrect cookbook version numbers in plugin output when -v used with promote (https://github.com/jonlives/knife-spork/issues/64)
+    - Replaced monkeypatched Hash#diff with an hash_diff method to fix clashes with ActiveSupport deprecation warnings. (Thanks to @RSO: https://github.com/jonlives/knife-spork/pull/84)
+    - Various fixes for Berkshelf issues (Thanks to @RSO and @sethvargo: https://github.com/jonlives/knife-spork/issues/73)
+    - Fix load_from_berkshelf method to return a CookbookVersion object (Thanks to @hanskrueger https://github.com/jonlives/knife-spork/pull/90)
+    - Fix foodcritic plugin to work properly with foodcritic > 3.0.0 (Thanks to @juliandunn https://github.com/jonlives/knife-spork/pull/94)
+
 ## 1.2.2 (10th Sept, 2013)
 
 Bugfixes:

data/LICENSE

@@ -12,7 +12,7 @@ License:: GPL
 
 Other
 -----
-Based on the knife-cookbook-bump plugin by:
+spork bump is based on the knife-cookbook-bump plugin by:
 Alalanta (no license specified)
 
 With snippets from:

data/README.md

@@ -4,7 +4,8 @@ KnifeSpork is a workflow plugin for `Chef::Knife` which helps multiple developer
 
 Installation
 ------------
-### Gem Install (recommended)
+
+### Gem Install
 `knife-spork` is available on rubygems. Add the following to your `Gemfile`:
 
 ```ruby
@@ -17,9 +18,7 @@ or install the gem manually:
 gem install knife-spork
 ```
 
-### Plugin Install
-Copy spork-* script from lib/chef/knife/spork-*.rb to your ~/.chef/plugins/knife directory.
-
+**Please note**: As of version 1.3.0, knife-spork depends on version 11.0.0 or greater of the chef gem. If you're still using Chef 10, please continue to use knife-spork 1.2.x
 Spork Configuration
 -------------------
 Out of the box, knife spork will work with no configuration. However, you can optionally enable several features to enhance its functionality.
@@ -47,10 +46,14 @@ environment_groups:
     - acceptance_testing
 version_change_threshold: 2
 environment_path: "/home/me/environments"
+role_path: "/home/me/roles"
+custom_plugin_path: "/home/me/spork-plugins"
 plugins:
   campfire:
     account: myaccount
     token: a1b2c3d4...
+  foodcritic:
+    tags: ['any']
   hipchat:
     api_token: ABC123
     rooms:
@@ -93,6 +96,13 @@ The `version_change_threshold` directive allows you to customise the threshold u
 #### Environment Path
 The `environment_path` allows you to specify the path to where you store your chef environment json files. If this parameter is not specified, spork will default to using the first element of your cookbook_path, replacing the word "cookbooks" with "environments"
 
+#### Role Path
+The `role_path` allows you to specify the path to where you store your chef role json files. If this parameter is not specified, spork will default to using the first element of your cookbook_path, replacing the word "cookbooks" with "roles"
+
+#### Custom Plugin Path
+The `custom_plugin_path` allows you to specify an additional directory from which to load knife-spork plugins. If this parameter is not specified or the path set does not exist, only the default plugins shipped with knife-spork will be loaded (if enabled in config)
+
+
 #### Plugins
 Knife spork supports plugins to allow users to hook it into existing systems such as source control, monitoring and chat systems. Plugins are enabled / disabled by adding / removing their config block from the plugin section of the config file. Any of the default plugins shown above can be disabled by removing their section.
 
@@ -198,7 +208,7 @@ This function lets you easily version your cookbooks without having to manually
 
 #### Usage
 ```bash
-knife spork bump COOKBOOK [MAJOR | MINOR | PATCH | MANUAL x.x.x]
+knife spork bump COOKBOOK [major | minor | patch | manual x.x.x]
 ````
 
 #### Example (No patch level specified - defaulting to patch)
@@ -263,3 +273,119 @@ Adding version constraint apache2 = 2.0.2
 Saving changes to my_environment.json
 Promotion complete. Don't forget to upload your changed my_environment to Chef Server
 ```
+
+Spork Omni
+-------------
+Omni lets you combine one of the most common combinations of spork commands (bump, upload & promote or promote --remote) - into one handy shortcut.
+
+As omni is designed for use only in those cases where you want to perform all three of bump, upload and promote at the same time it supports a limited subset of the command line options supported by the individual bump, upload and promote commands.
+
+If you run omni with no extra options, it will default to performing a ```patch``` level bump, and promote locally to the environments listed in the ```default_environments``` variable in your spork configuration file.
+
+Alternatively, you can specify any of the following options:
+
+```--cookbook-path PATH:PATH```: A colon-separated path to look for cookbooks in
+
+```--include-dependencies```: Also upload cookbook dependencies during the upload step
+
+```--bump-level [major|minor|patch]```: Version level to bump the cookbook (defaults to patch)
+
+```--environment ENVIRONMENT```: Environment to promote the cookbook to',
+
+```--remote```: Make omni perform a promote --remote instead of a local promote',
+
+#### Usage
+
+```bash
+knife spork omni COOKBOOK [--bump-level, --cookbook-path, --include-dependencies, --environment, --remote]
+```
+
+#### Example (default options, default_environments set to development and production)
+
+```text
+$ knife spork omni apache2
+OMNI: Bumping apache2
+Successfully bumped apache2 to v0.3.99!
+
+OMNI: Uploading apache2
+Freezing apache2 at 0.3.99...
+Successfully uploaded apache2@0.3.99!
+
+OMNI: Promoting apache2
+Adding version constraint apache2 = 0.3.99
+Saving changes to development.json
+Promotion complete. Don't forget to upload your changed development.json to Chef Server
+Adding version constraint apache2 = 0.3.99
+Saving changes to production.json
+Promotion complete. Don't forget to upload your changed production.json to Chef Server
+```
+
+#### Example (default options, default_environments set to development and production, promote --remote)
+
+```text
+$ knife spork omni apache2 --remote
+OMNI: Bumping apache2
+Successfully bumped apache2 to v0.3.99!
+
+OMNI: Uploading apache2
+Freezing apache2 at 0.3.99...
+Successfully uploaded apache2@0.3.99!
+
+OMNI: Promoting apache2
+Adding version constraint apache2 = 0.3.99
+Saving changes to development.json
+Uploading development.json to Chef Server
+Promotion complete at 2013-08-08 11:43:12 +0100!
+Adding version constraint apache2 = 0.3.99
+Saving changes to production.json
+Uploading production.json to Chef Server
+Promotion complete at 2013-08-08 11:43:12 +0100!
+```
+
+#### Example (Specifying patch level and environment)
+```text
+$ knife spork omni apache2 -l minor -e development
+OMNI: Bumping apache2
+Successfully bumped apache2 to v0.4.0!
+
+OMNI: Uploading apache2
+Freezing apache2 at 0.4.0...
+Successfully uploaded apache2@0.4.0!
+
+OMNI: Promoting apache2
+Adding version constraint apache2 = 0.4.0
+Saving changes to development.json
+Promotion complete. Don't forget to upload your changed development.json to Chef Server
+```
+
+Spork Node / Role / Databag Commands
+-------------
+
+Knife spork contains "wrappers" around several stock knife commands for changing nodes, roles, and databags. These commands work exactly as in the original knife, with the addition of being wrapped in Spork's plugin API. This means that for example, when you upload a role using spork you will see an IRC message containing details, and a gist of the role change.
+
+The following  ```data bag``` commands are provided in knife-spork:
+```
+knife spork data bag create
+knife spork data bag delete
+knife spork data bag edit
+knife spork data bag from file
+```
+
+The following  ```node``` commands are provided in knife-spork:
+```
+knife spork node create
+knife spork node delete
+knife spork node edit
+knife spork node from file
+knife spork node run_list add
+knife spork node run_list remove
+knife spork node run_list set
+```
+
+The following  ```role``` commands are provided in knife-spork:
+```
+knife spork role create
+knife spork role delete
+knife spork role edit
+knife spork role from file
+```

data/knife-spork.gemspec

@@ -2,7 +2,7 @@ $:.push File.expand_path('../lib', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name          = 'knife-spork'
-  gem.version       = '1.2.2'
+  gem.version       = '1.3.0'
   gem.authors       = ["Jon Cowie"]
   gem.email         = 'jonlives@gmail.com'
   gem.homepage      = 'https://github.com/jonlives/knife-spork'
@@ -15,7 +15,8 @@ Gem::Specification.new do |gem|
   gem.name          = "knife-spork"
   gem.require_paths = ["lib"]
 
-  gem.add_runtime_dependency 'chef', '>= 0.10.4'
+  gem.add_runtime_dependency 'chef', '>= 11.0.0'
   gem.add_runtime_dependency 'git', '>= 1.2.5'
   gem.add_runtime_dependency 'app_conf', '>= 0.4.0'
+  gem.add_runtime_dependency 'diffy', '>= 3.0.1'
 end

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

@@ -58,7 +58,19 @@ module KnifeSpork
         if remote_version == local_version
           if frozen?(remote_version)
             message = "Your local version (#{local_version}) is frozen on the remote server. You'll need to bump before you can upload."
-            config[:fail] ? fail_and_exit("#{message}") : ui.warn("#{message}")
+            if config[:fail]
+              fail_and_exit("#{message}")
+            else
+              ui.warn("#{message}")
+              answer = ui.ask("Would you like to perform a patch-level bump on the #{@cookbook.name} cookbook now? (Y/N)")
+              if answer == "Y" or answer == "y"
+                bump = SporkBump.new
+                bump.name_args = [@cookbook.name]
+                bump.run
+              else
+                ui.info "Skipping bump..."
+              end
+            end
           else
             message =  "The version #{local_version} exists on the server and is not frozen. Uploading will overwrite!"
             config[:fail] ? fail_and_exit("#{message}") : ui.error("#{message}")

data/lib/chef/knife/spork-databag-create.rb

@@ -0,0 +1,53 @@
+require 'chef/knife'
+require 'knife-spork/runner'
+require 'json'
+
+module KnifeSpork
+  class SporkDataBagCreate < Chef::Knife
+    include KnifeSpork::Runner
+
+    deps do
+      require 'chef/knife/data_bag_create'
+    end
+
+    banner 'knife data bag create BAG [ITEM] (options)'
+
+    option :secret,
+           :short => "-s SECRET",
+           :long  => "--secret ",
+           :description => "The secret key to use to encrypt data bag item values"
+
+    option :secret_file,
+           :long => "--secret-file SECRET_FILE",
+           :description => "A file containing the secret key to use to encrypt data bag item values"
+
+    def run
+      self.config = Chef::Config.merge!(config)
+
+      if @name_args.nil?
+        ui.error "You must specify a data bag name"
+        ui.error opt_parser
+        exit 1
+      end
+
+      @object_name = @name_args.first
+
+      run_plugins(:before_databagcreate)
+      pre_databag = {}
+      databag_create
+      post_databag = load_databag(@object_name)
+      @object_difference = json_diff(pre_databag,post_databag).to_s
+      run_plugins(:after_databagcreate)
+    end
+
+    private
+    def databag_create
+      dbc = Chef::Knife::DataBagCreate.new
+      dbc.name_args = @name_args
+      dbc.config[:editor] = config[:editor]
+      dbc.config[:secret] = config[:secret]
+      dbc.config[:secret_file] = config[:secret_file]
+      dbc.run
+    end
+  end
+end

data/lib/chef/knife/spork-databag-delete.rb

@@ -0,0 +1,51 @@
+require 'chef/knife'
+require 'knife-spork/runner'
+require 'json'
+
+module KnifeSpork
+  class SporkDataBagDelete < Chef::Knife
+    include KnifeSpork::Runner
+
+    deps do
+      require 'chef/knife/data_bag_delete'
+    end
+
+    banner 'knife data bag delete BAG [ITEM] (options)'
+
+
+    def run
+      self.config = Chef::Config.merge!(config)
+
+      if @name_args.length == 2
+        @object_name = @name_args.first
+        @object_secondary_name = @name_args.last
+        run_plugins(:before_databagitemdelete)
+        pre_databag = load_databag_item(@object_name,@object_secondary_name)
+        databag_delete
+        post_databag = {}
+        @object_difference = json_diff(pre_databag,post_databag).to_s
+        run_plugins(:after_databagitemdelete)
+      elsif @name_args.length == 1
+        @object_name = @name_args.first
+        run_plugins(:before_databagdelete)
+        pre_databag = load_databag(@object_name)
+        databag_delete
+        post_databag =  {}
+        @object_difference = json_diff(pre_databag,post_databag).to_s
+        run_plugins(:after_databagdelete)
+      else
+        show_usage
+        ui.fatal("You must specify at least a data bag name")
+        exit 1
+      end
+    end
+
+    private
+    def databag_delete
+      dbd = Chef::Knife::DataBagDelete.new
+      dbd.name_args = @name_args
+      dbd.config[:editor] = config[:editor]
+      dbd.run
+    end
+  end
+end

data/lib/chef/knife/spork-databag-edit.rb

@@ -0,0 +1,54 @@
+require 'chef/knife'
+require 'knife-spork/runner'
+require 'json'
+
+module KnifeSpork
+  class SporkDataBagEdit < Chef::Knife
+    include KnifeSpork::Runner
+
+    deps do
+      require 'chef/knife/data_bag_edit'
+    end
+
+    banner 'knife spork data bag edit BAG ITEM (options)'
+
+    option :secret,
+           :short => "-s SECRET",
+           :long  => "--secret ",
+           :description => "The secret key to use to encrypt data bag item values"
+
+    option :secret_file,
+           :long => "--secret-file SECRET_FILE",
+           :description => "A file containing the secret key to use to encrypt data bag item values"
+
+    def run
+      self.config = Chef::Config.merge!(config)
+
+      if @name_args.length != 2
+        ui.error "You must supply the data bag and an item to edit!"
+        ui.error opt_parser
+        exit 1
+      end
+
+      @object_name = @name_args.first
+      @object_secondary_name = @name_args.last
+
+      run_plugins(:before_databagedit)
+      pre_databag = load_databag_item(@object_name, @object_secondary_name)
+      databag_edit
+      post_databag = load_databag_item(@object_name, @object_secondary_name)
+      @object_difference = json_diff(pre_databag,post_databag).to_s
+      run_plugins(:after_databagedit)
+    end
+
+    private
+    def databag_edit
+      dbe = Chef::Knife::DataBagEdit.new
+      dbe.name_args = @name_args
+      dbe.config[:editor] = config[:editor]
+      dbe.config[:secret] = config[:secret]
+      dbe.config[:secret_file] = config[:secret_file]
+      dbe.run
+    end
+  end
+end

data/lib/chef/knife/spork-databag-fromfile.rb

@@ -0,0 +1,82 @@
+require 'chef/knife'
+require 'knife-spork/runner'
+require 'json'
+
+module KnifeSpork
+  class SporkDataBagFromFile < Chef::Knife
+    include KnifeSpork::Runner
+
+    deps do
+      require 'chef/knife/data_bag_from_file'
+    end
+
+    banner 'knife data bag from file BAG FILE|FOLDER [FILE|FOLDER..] (options)'
+
+    option :secret,
+           :short => "-s SECRET",
+           :long  => "--secret ",
+           :description => "The secret key to use to encrypt data bag item values"
+
+    option :secret_file,
+           :long => "--secret-file SECRET_FILE",
+           :description => "A file containing the secret key to use to encrypt data bag item values"
+
+    option :all,
+           :short => "-a",
+           :long  => "--all",
+           :description => "Upload all data bags"
+
+    def run
+      self.config = Chef::Config.merge!(config)
+
+      @object_name = @name_args.first
+
+      if config[:all] == true
+        test = Chef::Knife::DataBagFromFile.new
+        test.config[:verbosity] = 3
+        databags = test.send(:find_all_data_bags)
+        databags.each do |bag|
+          test.send(:find_all_data_bag_items,bag).each do |item|
+            @object_name = bag
+            @object_secondary_name = item.split("/").last
+            run_plugins(:before_databagfromfile)
+            begin
+              pre_databag = load_databag_item(@object_name, @object_secondary_name.gsub(".json",""))
+            rescue
+              pre_databag = {}
+            end
+            databag_from_file([@object_name,@object_secondary_name])
+            post_databag = load_databag_item(@object_name, @object_secondary_name.gsub(".json",""))
+            @object_difference = json_diff(pre_databag,post_databag).to_s
+            run_plugins(:after_databagfromfile)
+          end
+        end
+
+      else
+        @name_args[1..-1].each do |arg|
+            @object_secondary_name = arg
+            run_plugins(:before_databagfromfile)
+            begin
+              pre_databag = load_databag_item(@object_name, @object_secondary_name.gsub(".json",""))
+            rescue
+              pre_databag = {}
+            end
+            databag_from_file
+            post_databag = load_databag_item(@object_name, @object_secondary_name.gsub(".json",""))
+            @object_difference = json_diff(pre_databag,post_databag).to_s
+            run_plugins(:after_databagfromfile)
+        end
+      end
+    end
+
+    private
+    def databag_from_file(data_bag_names=nil)
+      dbff = Chef::Knife::DataBagFromFile.new
+      dbff.name_args = data_bag_names || @name_args
+      dbff.config[:editor] = config[:editor]
+      dbff.config[:secret] = config[:secret]
+      dbff.config[:secret_file] = config[:secret_file]
+      dbff.run
+    end
+  end
+end

data/lib/chef/knife/spork-node-create.rb

@@ -0,0 +1,38 @@
+require 'chef/knife'
+require 'knife-spork/runner'
+
+module KnifeSpork
+  class SporkNodeCreate < Chef::Knife
+    include KnifeSpork::Runner
+
+    banner 'knife spork node create NODE (options)'
+
+
+    def run
+      self.config = Chef::Config.merge!(config)
+
+      if @name_args.empty?
+        show_usage
+        ui.error("You must specify a node name")
+        exit 1
+      end
+
+      @object_name = @name_args.first
+
+      run_plugins(:before_nodecreate)
+      pre_node = {}
+      node_create
+      post_node = load_node(@object_name)
+      @object_difference = json_diff(pre_node,post_node).to_s
+      run_plugins(:after_nodecreate)
+    end
+
+    private
+    def node_create
+      ne = Chef::Knife::NodeCreate.new
+      ne.name_args = @name_args
+      ne.config[:editor] = config[:editor]
+      ne.run
+    end
+  end
+end

data/lib/chef/knife/spork-node-delete.rb

@@ -0,0 +1,38 @@
+require 'chef/knife'
+require 'knife-spork/runner'
+
+module KnifeSpork
+  class SporkNodeDelete < Chef::Knife
+    include KnifeSpork::Runner
+
+    banner 'knife spork node delete NODE (options)'
+
+
+    def run
+      self.config = Chef::Config.merge!(config)
+
+      if @name_args.empty?
+        show_usage
+        ui.error("You must specify a node name")
+        exit 1
+      end
+
+      @object_name = @name_args.first
+
+      run_plugins(:before_nodedelete)
+      pre_node = load_node(@object_name)
+      node_delete
+      post_node = {}
+      @object_difference = json_diff(pre_node,post_node).to_s
+      run_plugins(:after_nodedelete)
+    end
+
+    private
+    def node_delete
+      ne = Chef::Knife::NodeDelete.new
+      ne.name_args = @name_args
+      ne.config[:editor] = config[:editor]
+      ne.run
+    end
+  end
+end

data/lib/chef/knife/spork-node-edit.rb

@@ -0,0 +1,45 @@
+require 'chef/knife'
+require 'chef/knife/core/node_editor'
+require 'knife-spork/runner'
+
+module KnifeSpork
+  class SporkNodeEdit < Chef::Knife
+    include KnifeSpork::Runner
+
+    banner 'knife spork node edit NODE (options)'
+
+    option :all_attributes,
+           :short => "-a",
+           :long => "--all",
+           :boolean => true,
+           :description => "Display all attributes when editing"
+
+    def run
+      self.config = Chef::Config.merge!(config)
+
+      if @name_args.empty?
+        show_usage
+        ui.error("You must specify a node name")
+        exit 1
+      end
+
+      @object_name = @name_args.first
+
+      run_plugins(:before_nodeedit)
+      pre_node = load_node(@object_name)
+      node_edit
+      post_node = load_node(@object_name)
+      @object_difference = json_diff(pre_node,post_node).to_s
+      run_plugins(:after_nodeedit)
+    end
+
+    private
+    def node_edit
+      ne = Chef::Knife::NodeEdit.new
+      ne.name_args = @name_args
+      ne.config[:editor] = config[:editor]
+      ne.config[:all] = config[:all]
+      ne.run
+    end
+  end
+end

data/lib/chef/knife/spork-node-fromfile.rb

@@ -0,0 +1,43 @@
+require 'chef/knife'
+require 'knife-spork/runner'
+
+module KnifeSpork
+  class SporkNodeFromFile < Chef::Knife
+    include KnifeSpork::Runner
+
+    banner 'knife spork node from file FILE (options)'
+
+
+    def run
+      self.config = Chef::Config.merge!(config)
+
+      if @name_args.empty?
+        show_usage
+        ui.error("You must specify a filename")
+        exit 1
+      end
+
+      @object_name = JSON.parse(File.read(@name_args.first))["name"]
+      ui.info @object_name
+
+      run_plugins(:before_nodefromfile)
+      begin
+        pre_node = load_node(@object_name.gsub(".json",""))
+      rescue
+        pre_node = {}
+      end
+      node_fromfile
+      post_node = load_node(@object_name.gsub(".json",""))
+      @object_difference = json_diff(pre_node,post_node).to_s
+      run_plugins(:after_nodefromfile)
+    end
+
+    private
+    def node_fromfile
+      nff = Chef::Knife::NodeFromFile.new
+      nff.name_args = @name_args
+      nff.config[:editor] = config[:editor]
+      nff.run
+    end
+  end
+end