knife-solo_data_bag 0.3.2 → 0.4.0

data/CHANGELOG.md

@@ -1,9 +1,13 @@
 ## head
 
-## 0.3.2 (04/06/2012)
+# 0.4.0 (05/30/2013)
+* Add support for creating a data bag item from a json file (--json-file)  ([@joeyates](https://github.com/joeyates))
+* Add support for specifying the data bag path on the command line (--data-bag-path) ([@ToQoz](https://github.com/ToQoz))
+
+## 0.3.2 (04/06/2013)
 * Send warning about overriding secret in knife.rb to STDERR instead of STDOUT (props to BK Box @gondoi)
 
-## 0.3.1 (01/11/2012)
+## 0.3.1 (01/11/2013)
 * Write pretty json to disk (addresses #1)
 
 ## 0.3.0 (11/08/2012)
@@ -20,4 +24,3 @@
 
 ## 0.1.0 (05/17/2012)
 * Initial release
-

data/README.md

@@ -30,6 +30,10 @@ Create a data bag item with JSON from the command line (works with encryption)
 
     $ knife solo data bag create apps app_1 --json '{"id": "app_1", "username": "bob"}'
 
+Create a data bag item from a json file
+
+    $ knife solo data bag create apps app_1 --json-file foo.json
+
 ### Edit
 Edit a plain text data bag
 
@@ -66,10 +70,13 @@ You can also display any of the above variations in JSON format with `-F json`
     $ knife solo data bag show apps app_1 -s secret_key -F json
 
 ## Notes
-This plugin will rely on the configured data_bag_path for placement of the data
-bags.  This defaults to '/var/chef/data_bags', but can be overriden in your chef
-client config.
+### Data Bag Path
+By default, this plugin will use the configured data_bag_path. This is
+defaulted to `/var/chef/data_bags` by Chef. It is possible to override this
+path in your Chef client config if desired. When using this plugin, it is also
+possible to override the path using the `--data-bag-path` argument.
 
+### Encrypted Data Bag Secret
 This plugin respects the "encrypted_data_bag_secret" configuration option in
 knife.rb. Command line secret arguments (-s or --secret-file) will override the
 setting in knife.rb.

data/lib/chef/knife/helpers.rb

@@ -12,6 +12,10 @@ module KnifeSoloDataBag
     end
 
     def bags_path
+      if config[:data_bag_path]
+        Chef::Config[:data_bag_path] = config[:data_bag_path]
+      end
+
       Chef::Config[:data_bag_path]
     end
 

data/lib/chef/knife/solo_data_bag_create.rb

@@ -26,6 +26,14 @@ module KnifeSoloDataBag
            :long  => '--json JSON_STRING',
            :description => 'The data bag json string that can be passed at the CLI'
 
+    option :json_file,
+           :long  => '--json-file JSON_FILE',
+           :description => 'A file contining the data bag json string'
+
+    option :data_bag_path,
+           :long => '--data-bag-path DATA_BAG_PATH',
+           :description => 'The path to data bag'
+
     def run
       @bag_name, @item_name = @name_args
       ensure_valid_arguments
@@ -45,12 +53,16 @@ module KnifeSoloDataBag
 
     def create_item_object
       item = nil
-      if config[:json_string].nil?
+      case
+      when config[:json_string]
+        item = Chef::DataBagItem.from_hash bag_item_content(convert_json_string)
+      when config[:json_file]
+        json_string = JSON.parse(File.read(config[:json_file]))
+        item = Chef::DataBagItem.from_hash bag_item_content(json_string)
+      else
         create_object({'id' => item_name}, "data_bag_item[#{item_name}]") do |output|
           item = Chef::DataBagItem.from_hash bag_item_content(output)
         end
-      else
-        item = Chef::DataBagItem.from_hash bag_item_content(convert_json_string)
       end
       item
     end

data/lib/chef/knife/solo_data_bag_edit.rb

@@ -20,6 +20,10 @@ module KnifeSoloDataBag
            :long  => '--secret-file SECRET_FILE',
            :description => 'A file containing the secret key to use to encrypt data bag item values'
 
+    option :data_bag_path,
+           :long => '--data-bag-path DATA_BAG_PATH',
+           :description => 'The path to data bag'
+
     def run
       Chef::Config[:solo]   = true
       @bag_name, @item_name = @name_args

data/lib/chef/knife/solo_data_bag_list.rb

@@ -11,6 +11,10 @@ module KnifeSoloDataBag
 
     attr_reader :bag_name
 
+    option :data_bag_path,
+           :long => '--data-bag-path DATA_BAG_PATH',
+           :description => 'The path to data bag'
+
     def run
       ensure_valid_arguments
       output format_for_display(bags)

data/lib/chef/knife/solo_data_bag_show.rb

@@ -20,6 +20,10 @@ module KnifeSoloDataBag
            :long  => '--secret-file SECRET_FILE',
            :description => 'A file containing the secret key to use to encrypt data bag item values'
 
+    option :data_bag_path,
+           :long => '--data-bag-path DATA_BAG_PATH',
+           :description => 'The path to data bag'
+
     def run
       Chef::Config[:solo]   = true
       @bag_name, @item_name = @name_args

data/lib/knife-solo_data_bag/version.rb

@@ -1,5 +1,5 @@
 module Knife
   module SoloDataBag
-    VERSION = '0.3.2'
+    VERSION = '0.4.0'
   end
 end

data/spec/unit/solo_data_bag_create_spec.rb

@@ -49,6 +49,20 @@ describe KnifeSoloDataBag::SoloDataBagCreate do
           JSON.parse(File.read(@item_path)).raw_data.should == @input_data
         end
 
+        context 'with --data-bag-path' do
+          before do
+            @override_bags_path           = '/opt/bags'
+            @override_bag_path            = "#{@override_bags_path}/bag_1"
+            @knife.config[:data_bag_path] = @override_bags_path
+            FileUtils.mkdir_p @override_bags_path
+          end
+
+          it 'uses the data bag path from the override' do
+            @knife.run
+            File.directory?(@override_bag_path).should be_true
+          end
+        end
+
         context 'when encrypting with -s or --secret' do
           before do
             @knife.name_args << 'bar'
@@ -181,6 +195,22 @@ describe KnifeSoloDataBag::SoloDataBagCreate do
         end
       end
 
+      context 'when also specifying a json file' do
+        before do
+          @knife.name_args << 'bar'
+          @json_path                = '/var/chef/my_bag.json'
+          @knife.config[:json_file] = @json_path
+          @input_data               = {'id' => 'foo', 'sub' => {'key_1' => 'value_1', 'key_2' => 'value_2'}}
+          @item_path                = "#{@bag_path}/bar.json"
+          File.open(@json_path, 'w') { |f| f.write @input_data.to_json }
+        end
+
+        it 'creates the data bag item' do
+          @knife.run
+          JSON.parse(File.read(@item_path)).raw_data.should == @input_data
+        end
+      end
+
     end
 
   end

data/spec/unit/solo_data_bag_edit_spec.rb

@@ -72,6 +72,22 @@ describe KnifeSoloDataBag::SoloDataBagEdit do
 })
       end
 
+      context 'with --data-bag-path' do
+        before do
+          @override_bags_path           = '/opt/bags'
+          @override_bag_path            = "#{@override_bags_path}/bag_1"
+          @override_item_path           = "#{@override_bag_path}/foo.json"
+          @knife.config[:data_bag_path] = @override_bags_path
+          FileUtils.mkdir_p @override_bag_path
+        end
+
+        it 'uses the data bag path from the override' do
+          @knife.run
+          data = JSON.parse(File.read(@override_item_path)).raw_data
+          data.should == @updated_data
+        end
+      end
+
       context 'when encrypting with -s or --secret' do
         before do
           @knife.config[:secret] = 'secret_key'

data/spec/unit/solo_data_bag_list_spec.rb

@@ -33,6 +33,22 @@ describe KnifeSoloDataBag::SoloDataBagList do
         @stdout.string.should match /bag_1/
         @stdout.string.should match /bag_2/
       end
+
+      context 'with --data-bag-path' do
+        before do
+          @bags_path = '/opt/bags'
+          FileUtils.mkdir_p @bags_path
+          @bags.each { |b| FileUtils.mkdir_p "#{@bags_path}/#{b}-opt" }
+          @knife.config[:data_bag_path] = @bags_path
+        end
+
+        it 'should list all of the data bags' do
+          @knife.run
+          @stdout.string.should match /bag_1-opt/
+          @stdout.string.should match /bag_2-opt/
+        end
+      end
+
     end
 
   end

data/spec/unit/solo_data_bag_show_spec.rb

@@ -43,6 +43,22 @@ describe KnifeSoloDataBag::SoloDataBagShow do
           @stdout.string.should match /foo/
           @stdout.string.should match /bar/
         end
+
+        context 'with --data-bag-path' do
+          before do
+            @bags_path       = '/opt/bags'
+            @bag_path        = "#{@bags_path}/bag_1"
+            FileUtils.mkdir_p @bag_path
+            @knife.config[:data_bag_path] = @bags_path
+          end
+
+          it 'uses the data bag path from the override' do
+            @knife.run
+            @stdout.string.should match /foo/
+            @stdout.string.should match /bar/
+          end
+        end
+
       end
 
       context 'when also specifying an item' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-solo_data_bag
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-06 00:00:00.000000000Z
+date: 2013-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
-  requirement: &70207628947780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: 0.10.10
   type: :development
   prerelease: false
-  version_requirements: *70207628947780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.10
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70207628947360 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70207628947360
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70207628975220 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: 2.10.0
   type: :development
   prerelease: false
-  version_requirements: *70207628975220
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
 - !ruby/object:Gem::Dependency
   name: fakefs
-  requirement: &70207628974720 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +69,12 @@ dependencies:
         version: 0.4.0
   type: :development
   prerelease: false
-  version_requirements: *70207628974720
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 description: A knife plugin for working with data bags and chef solo
 email:
 - bishop.thomas@gmail.com
@@ -103,15 +123,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -422012811052713416
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -422012811052713416
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A knife plugin for working with data bags and chef solo