knife-data-bag-version 1.1.0

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2013 Kristian Van Der Vliet
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,74 @@
+# Knife data bag version
+
+While Chef understands the concept of versioned Cookbooks, other resources such as Roles & Data Bags are not versioned. This can cause problems mixing different versions of the same Cookbook within an organization if the data bags are shared between versions.
+
+The knife data bag version plugin attempts to provide a mechanism to version data bag items to match the cookbook version. Coupled with a Chef runtime library, recipes can load a given version of the item which will match its requirements.
+
+## Requirements
+
+knife data bag version relies on thor-scmversion to manage the version information.
+
+## Installation
+
+    gem install knife-data-bag-version
+
+## How does it work?
+
+Instead of storing each data bag item as pure JSON, the items are stored as ERB templates. knife data bag version then processes each template with Erubis and produces a JSON data bag item with the version information injected.
+
+For example, assume we have a simple data bag item:
+
+**my-data-bag-item.json**
+
+    {
+      "id": "my-data-bag-item",
+      "users": ["kristian", "paul", "pete", "david", "bill"]
+    }
+
+For use with knife data bag version this becomes a template:
+
+**my-data-bag-item.erb**
+
+    {
+      "id": "<%= DatabagVersion.id('my-data-bag-item') %>",
+      "users": ["kristian", "paul", "pete", "david", "bill"]
+    }
+
+knife data bag version can then create a JSON file using this template:
+
+    $ knife data bag version
+    Templating data bag item data_bags/my-cookbook/my-data-bag-item
+
+knife data bag version will emit a JSON file:
+
+**my-data-bag-item_1_2_0.json**
+
+    {
+      "id": "my-data-bag-item_1_2_0",
+      "users": ["kristian", "paul", "pete", "david", "bill"]
+    }
+
+The three digits will naturally depend on the major, minor & patch versions of the current Cookbook. The version information is obtained from thor-scmversion, which means the data bag version will always match the cookbook. Each versioned data bag item is distinct from other versions, so you can safely have E.g. "my-data-bag-item\_1\_1\_3", "my-data-bag-item\_1\_2\_0" and "my-data-bag-item\_1\_2\_1" uploaded to the same organization.
+
+## Limitations
+
+The plugin relies on thor-scmversion, which means if you're not using it manage your cookbook versions knife data bag version will always version everything as version 0.0.1.
+
+It assumes that all data bags are contained in a directory called "data\_bags", and it is assumed that the data bags are stored within the Cookbook itself. An example directory structure:
+
+	  my-cookbook
+	    metadata.rb
+	    Thorfile
+	    recipes
+	      default.rb
+	    libraries
+	      my-library.rb
+	    data_bags
+	      my-cookbook
+	        my-cookbook-item.erb
+
+You would then run knife data bag version from the top of the tree, in the "my-cookbook" directory. If you run the knife data bag version and it can't find a directory called "data\_bags" it will fail silently.
+
+How you load the data bags is currently an exercise for the reader, but I'll try to get a Chef runtime library into the Community Cookbooks repository soon.
+
+This knife plugins is supplied without any warranty or guarantees regarding suitability for purpose.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+desc "Run unit tests"
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/unit/*_test.rb'
+  t.verbose = true
+end

data/knife-data-bag-version.gemspec

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+Gem::Specification.new do |g|
+  g.name                    = 'knife-data-bag-version'
+  g.version                 = '1.1.0'
+  g.summary                 = "Create versioned data bag items"
+  g.description             = "Processes data bag item templates with Erubis & thor-scmversion to create 'versioned' data bag items."
+  g.authors                 = ["Kristian Van Der Vliet"]
+  g.email                   = 'kvandervliet@dyn.com'
+  g.homepage                = ''
+  g.license                 = 'Apache-2.0'
+
+  g.files                   = `git ls-files`.split($\)
+  g.executables             = g.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+
+  g.add_runtime_dependency  'thor-scmversion'
+end

data/lib/chef/knife/knife-data-bag-version.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+require 'databag_version'
+
+module Dyn
+  module Knife
+
+    # Version all data bags items
+
+    class DataBagVersion < Chef::Knife
+
+      banner 'knife data bag version'
+
+      option :quiet,
+        :short => "-q",
+        :long => "--quiet",
+        :boolean => "false",
+        :description => "Silence all informational output."
+
+      def run
+        DatabagVersion.process_all(config[:quiet])
+      end
+    end
+
+  end
+end

data/lib/databag_version.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+require 'thor-scmversion'
+require 'erubis'
+
+# A simple module for working with "versioned" data bags.
+# This relies on thor-scmversion to provide the version information. Any
+# data bag item templates are then processed with Erubis to insert the version
+# information.
+
+module DatabagVersion
+  class << self
+
+    def id(name)
+      scm_versioner = ThorSCMVersion.versioner
+      tag = scm_versioner.from_path
+
+      version = tag.to_s.gsub(/\./, '_')
+
+      "#{name}_#{version}"
+    end
+
+    def process_all(quiet = true, path = 'data_bags')
+      @be_quiet = quiet
+      Dir.foreach(path) do |dir|
+        # Skip everything that isn't a sub-directory
+        next unless File.directory?(dir)
+        # Process every sub-directory (but not current & parent, natch)
+        process_dir("#{path}/#{dir}") unless dir == '.' || dir == '..'
+      end if File.exist?(path)
+    end
+
+    private
+
+    def process_dir(path)
+      Dir.foreach(path) do |file|
+        process_file("#{path}/#{file}") if file.match('.erb')
+      end
+    end
+
+    def process_file(file)
+      path = File.dirname(file)
+      name = File.basename(file, '.erb')
+      id = id(name)
+
+      out = "#{path}/#{id}.json"
+
+      puts "Templating data bag item #{path}/#{name}" unless @be_quiet
+
+      template = File.read(file)
+      template = Erubis::Eruby.new(template)
+
+      File.write(out, template.result)
+    end
+
+  end
+
+end

data/test/unit/knife-data-bag-version_test.rb

@@ -0,0 +1,16 @@
+require 'test/unit'
+require 'databag_version'
+
+class DBVTest < Test::Unit::TestCase
+  def test_id
+    assert_equal "derp_0_0_1",
+      DatabagVersion.id("derp")
+  end
+
+  def test_process_all
+    assert_nil DatabagVersion.process_all
+    assert_nothing_raised{ DatabagVersion.process_all(false) }
+    assert_nothing_raised{ DatabagVersion.process_all(false, "/this/path/shouldnt/exist") }
+    assert_nothing_raised{ DatabagVersion.process_all(false, "/tmp") }
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: knife-data-bag-version
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Kristian Van Der Vliet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor-scmversion
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Processes data bag item templates with Erubis & thor-scmversion to create
+  'versioned' data bag items.
+email: kvandervliet@dyn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- knife-data-bag-version.gemspec
+- lib/chef/knife/knife-data-bag-version.rb
+- lib/databag_version.rb
+- test/unit/knife-data-bag-version_test.rb
+homepage: ''
+licenses:
+- Apache-2.0
+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
+signing_key: 
+specification_version: 3
+summary: Create versioned data bag items
+test_files: []
+has_rdoc: