knife-flow 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in knife-flow.gemspec
+gemspec

data/README.md

@@ -0,0 +1,81 @@
+knife-flow 
+========
+A collection of Chef plugins for managing the migration of cookbooks to environments in different Opscode organizations.
+The main reason for having a workflow around the development and promotion of cookbooks is to ensure quality, reliability and administrative security of the process.  
+
+Requirements
+---------------
+Right now knife-flow is build with many assumptions:
+
+* The knife-flow assumes you have at least 2 orgs; one for "development" and one for "production".
+* The "development" org has one environment called "candidate".
+* The "production" org has an "innovate" and a "production" environment.
+* You are using git flow [http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/](http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/) for your chef-repo project.
+
+Installing knife-flow
+-------------------
+Be sure you are running the latest version Chef.
+
+Map the "development" org to the knife.rb file, and map the "production" org to a knife-production.rb file.
+
+Copy the increment.rb, promote.rb and release.rb files to the <tt>chef-repo/.chef/knife/plugins</tt> directory.
+
+Plugins
+---------------
+
+### increment
+Increments the cookbooks version by 1 digit at the patch level (i.e. 2.3.1 -> 2.3.2 ) <br />
+Uploads the cookbook by running <tt> knife cookbook upload COOKBOOK COOKBOOK </tt> <br />
+Commits the changes to the "develop" branch <br />
+
+
+    $ knife increment COOKBOOK COOKBOOK ... 
+
+
+This plugin is useful when working on the projects in the "sandbox" stage. The "_default" environment will always load the latest versions of the cookbooks.
+
+
+### promote
+Increments the cookbooks version by 1 digit at the patch level ( i.e. 2.3.1 -> 2.3.2 ) <br />
+Uploads the cookbook by running <tt> knife cookbook upload COOKBOOK COOKBOOK </tt> <br />
+Updates the environments/ENVIRONMENT.json file with the list of COOKBOOK COOKBOOK and relative new versions. <br />
+Uploads the ENVIRONMENT.json file to the "development" org. <br />
+Commits the changes to the "develop" branch. <br />
+
+
+    $ knife promote  ENVIRONMENT(i.e. candidate) COOKBOOK COOKBOOK ...
+
+
+This plugin is useful when working on the projects in the "validation" and "performance" stage. The "candidate" environment will be used to validate the cookbooks versions.
+
+
+### release
+Copies the "candidate" environment cookbook list and transfer them to the ENVIRONMENT in the "production" org. <br />
+Commits all changes and creates a release tag TAG using the <tt> git flow release start/finish TAG </tt>. <br />
+Uploads all cookbooks to the "production" org. <br />
+
+    $ knife release ENVIRONMENT(i.e. innovate or production) TAG(i.e. 2011.2.3)
+
+This plugin is useful when we are ready to migrate the cookbooks to the environments in the "production" org.
+
+License terms
+-------------
+Authors:: Johnlouis Petitbon, Jacob Zimmerman, Aaron Suggs 
+
+Copyright:: Copyright (c) 2009-2011 Medidata Solutions Worldwide, Inc.
+
+License:: Apache License, Version 2.0
+
+
+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/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/knife-flow.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "knife-flow/version"
+
+Gem::Specification.new do |s|
+  s.name        = "knife-flow"
+  s.version     = Knife::Flow::VERSION
+  s.authors     = ["Johnlouis Petitbon", "Jacob Zimmerman", "Aaron Suggs"]
+  s.email       = ["jpetitbon@mdsol.com"]
+  s.homepage    = "https://github.com/mdsol/knife-flow"
+  s.summary     = %q{A collection of Chef plugins for managing the migration of cookbooks to environments in different Opscode organizations.}
+  s.description = %q{The main reason for having a workflow around the development and promotion of cookbooks is to ensure quality, reliability and administrative security of the process.}
+
+  s.rubyforge_project = "knife-flow"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/chef/knife/increment.rb

@@ -0,0 +1,122 @@
+#
+## Author:: Johnlouis Petitbon (<jpetitbon@mdsol.com>)
+##
+## 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.
+##
+#
+
+require 'chef/knife'
+ 
+module KnifeFlow
+  class Increment < Chef::Knife
+ 
+    deps do
+      require 'chef/cookbook_loader'
+      require 'chef/cookbook_uploader'
+    end
+ 
+    banner "knife increment COOKBOOK"
+
+    WORKING_BRANCH = "develop"
+
+    def run
+     
+      @cookbooks = parse_name_args!
+
+      self.config = Chef::Config.merge!(config)
+      
+      if !config[:cookbook_path]
+        raise ArgumentError, "Default cookbook_path is not specified in the knife.rb config file, and a value to -o is not provided. Nowhere to write the new cookbook to." 
+      end
+      
+      if check_branch(WORKING_BRANCH)
+
+        pull_branch(WORKING_BRANCH) 
+
+        @cookbook_path = Array(config[:cookbook_path]).first
+     
+        @cookbooks.each do | book |
+          metadata_file = File.join(@cookbook_path, book, "metadata.rb")
+
+          # 1) increase version on the metadata file
+          replace_version(find_version(book), increment_version(find_version(book)), metadata_file )
+        
+        end
+      
+        # 2) upload cookbooks to chef server
+        cookbook_up = Chef::Knife::CookbookUpload.new
+        cookbook_up.name_args = @cookbooks 
+        cookbook_up.config[:freeze] = true
+        cookbook_up.run  
+        
+        # 3) commit and push WORKING_BRANCH
+        commit_and_push_branch(WORKING_BRANCH, "#{@cookbooks} have been incremented")
+      
+      end
+
+    end
+    
+    def parse_name_args!
+      if name_args.empty?
+        ui.error("USAGE: knife increment COOKBOOK COOKBOOK COOKBOOK")
+        exit 1
+      else
+        return name_args
+      end
+    end
+
+    def commit_and_push_branch(branch, comment)
+      print "--------------------------------- \n"
+      system("git pull origin #{branch}") 
+      system("git add .")
+      system("git commit -am  '#{comment}'")
+      system("git push origin #{branch}")
+      print "--------------------------------- \n"
+    end
+
+    def pull_branch(name)
+      print "--------------------------------- \n"
+      system("git pull origin #{name}")
+      print "--------------------------------- \n"
+    end
+
+    def check_branch(name)
+      if (`git status` =~ /#{name}/) != nil
+        return true
+      else
+        ui.error("USAGE: you must be in the #{name} branch")
+        exit 1
+      end
+    end
+
+    def find_version(name)
+     loader = Chef::CookbookLoader.new(@cookbook_path)
+     return loader[name].version
+    end
+
+    def increment_version(version)
+     current_version = version.split(".").map{|i| i.to_i}
+     current_version[2] = current_version[2] + 1
+     return current_version.join('.')
+    end
+
+    def replace_version(search_string, replace_string, file)
+      open_file = File.open(file, "r")
+      body_of_file = open_file.read
+      open_file.close
+      body_of_file.gsub!(search_string, replace_string)
+      File.open(file, "w") { |file| file << body_of_file }
+    end
+
+  end
+end

data/lib/chef/knife/promote.rb

@@ -0,0 +1,156 @@
+#
+## Author:: Johnlouis Petitbon (<jpetitbon@mdsol.com>)
+##
+## 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.
+##
+#
+
+require 'chef/knife'
+ 
+module KnifeFlow
+  class Promote < Chef::Knife
+ 
+    deps do
+      require 'chef/cookbook_loader'
+      require 'chef/cookbook_uploader'
+      require 'chef/environment'
+      require 'chef/knife/core/object_loader'
+    end
+ 
+    banner "knife promote ENVIRONMENT COOKBOOK"
+ 
+    WORKING_BRANCH = "develop"
+    
+    def run
+
+
+      all_args = parse_name_args!
+      env_name = all_args[0]
+      all_args.shift
+      cookbooks = all_args
+      
+      self.config = Chef::Config.merge!(config)
+     
+      if !config[:cookbook_path]
+        raise ArgumentError, "Default cookbook_path is not specified in the knife.rb config file, and a value to -o is not provided. Nowhere to write the new cookbook to." 
+      end
+      @cookbook_path = Array(config[:cookbook_path]).first
+      
+
+      if check_branch(WORKING_BRANCH)
+        
+        pull_branch(WORKING_BRANCH)
+
+        env_json = load_env_file(env_name)
+        
+        env_data = JSON.parse(env_json)
+    
+        cookbooks.each do | book |
+          metadata_file = File.join(@cookbook_path, book, "metadata.rb")
+
+          # 1) increase version on the metadata file
+          replace_version(find_version(book), increment_version(find_version(book)), metadata_file )
+      
+          # 2) add or update the cookbook in the environment cookbook_versions list
+          env_data.cookbook_versions.merge!(book => find_version(book))
+        
+        end
+        
+        # 3) write the environment to file
+        File.open("environments/#{env_name}.json","w") do |f|
+          f.write(JSON.pretty_generate(env_data))
+        end
+        
+        # 4) upload cookbooks to chef server
+        cookbook_up = Chef::Knife::CookbookUpload.new
+        cookbook_up.name_args = cookbooks 
+        cookbook_up.config[:freeze] = true
+        cookbook_up.run  
+        
+        
+        # 5) upload environment to chef server
+        knife_environment_from_file = Chef::Knife::EnvironmentFromFile.new
+        knife_environment_from_file.name_args = ["#{env_name}.json"]
+        output = knife_environment_from_file.run
+
+        # 6) commit and push all changes to develop 
+        commit_and_push_branch(WORKING_BRANCH, "#{cookbooks.join(" and ").to_s} have been promoted to the #{env_name} environment")
+
+      end
+
+    end
+  
+    def load_env_file(env_name)
+      if File.exist?("environments/#{env_name}.json")
+        File.read("environments/#{env_name}.json")
+      else
+        # TODO - we should handle the creation of the environment.json file if it doesn't exist.
+        raise ArgumentError, "environments/#{env_name}.json was not found; please create the environment file manually.#{env_name}"
+      end
+    end
+
+    def commit_and_push_branch(branch, comment)
+      print "--------------------------------- \n"
+      system("git pull origin #{branch}") 
+      system("git add .")
+      system("git commit -am  '#{comment}'")
+      system("git push origin #{branch}")
+      print "--------------------------------- \n"
+    end
+
+    def pull_branch(name)
+      print "--------------------------------- \n"
+      system("git pull origin #{name}")
+      print "--------------------------------- \n"
+    end
+
+    def check_branch(name)
+      if (`git status` =~ /#{name}/) != nil
+        return true
+      else
+        ui.error("USAGE: you must be in the #{name} branch.")
+        exit 1
+      end
+    end
+
+    def parse_name_args!
+      if name_args.empty?
+        ui.error("USAGE: knife promote ENVIRONMENT COOKBOOK COOKBOOK ...")
+        exit 1
+      else
+        return name_args
+      end
+    end
+
+    def find_version(name)
+     loader = Chef::CookbookLoader.new(@cookbook_path)
+     return loader[name].version
+    end
+
+    def increment_version(version)
+     current_version = version.split(".").map{|i| i.to_i}
+     current_version[2] = current_version[2] + 1
+     return current_version.join('.')
+    end
+
+    def replace_version(search_string, replace_string, file)
+      open_file = File.open(file, "r")
+      body_of_file = open_file.read
+      open_file.close
+      body_of_file.gsub!(search_string, replace_string)
+      File.open(file, "w") { |file| file << body_of_file }
+    end
+
+
+  end
+end

data/lib/chef/knife/release.rb

@@ -0,0 +1,195 @@
+#
+## Author:: Johnlouis Petitbon (<jpetitbon@mdsol.com>)
+##
+## 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.
+##
+#
+
+require 'chef/knife'
+ 
+module KnifeFlow
+  class Release < Chef::Knife
+ 
+    deps do
+      require 'chef/cookbook_loader'
+      require 'chef/cookbook_uploader'
+      require 'chef/environment'
+      require 'chef/knife/core/object_loader'
+    end
+
+    banner "knife release ENVIRONMENT TAG"
+ 
+    WORKING_BRANCH = "develop"
+    CANDIDATE_ENVIRONMENT = "candidate"
+
+    def run
+
+      all_args = parse_name_args!
+      env_name = all_args[0]
+      tag_name = all_args[1]
+     
+      self.config = Chef::Config.merge!(config)
+       
+      switch_org(env_name)
+
+      self.config = Chef::Config.merge!(config)
+    
+      if !config[:cookbook_path]
+        raise ArgumentError, "Default cookbook_path is not specified in the knife.rb config file, and a value to -o is not provided. Nowhere to write the new cookbook to." 
+      end
+      @cookbook_path = Array(config[:cookbook_path]).first
+      
+      if check_branch(WORKING_BRANCH)
+        
+        pull_branch(WORKING_BRANCH)
+
+        system("git fetch --tags")
+
+        # 1) start a new git-flow release
+        system("git flow release start #{tag_name}")
+  
+        candidate_json = load_env_file(CANDIDATE_ENVIRONMENT)
+        candidate_data = JSON.parse(candidate_json)
+        
+        env_json = load_env_file(env_name)
+        env_data = JSON.parse(env_json)
+    
+        cb_a = [] 
+        candidate_data.cookbook_versions.each do | book_data |
+          cb_a << book_data[0]
+      
+          # 2) add or update the cookbook in the environment cookbook_versions list
+          env_data.cookbook_versions.merge!(book_data[0] => book_data[1])
+       
+        end
+        
+        # 3) write the environment to file
+        File.open("environments/#{env_name}.json","w") do |f|
+          f.write(JSON.pretty_generate(env_data))
+        end
+        
+        # 4) upload cookbooks to chef server
+        cookbook_up = Chef::Knife::CookbookUpload.new
+        cookbook_up.name_args = cb_a
+        cookbook_up.config[:freeze] = true
+        cookbook_up.run  
+
+        # 5) upload environment to chef server
+        knife_environment_from_file = Chef::Knife::EnvironmentFromFile.new
+        knife_environment_from_file.name_args = ["#{env_name}.json"]
+        output = knife_environment_from_file.run
+
+        # 6) commit all changes and finish the git-flow release
+        system("git commit -am 'the candidate environemnt is now in production and tagged #{tag_name}'")
+        system("git flow release finish -m 'testing' #{tag_name}") 
+
+        system("git push origin #{WORKING_BRANCH} --tags")
+
+      end
+
+    end
+  
+    def switch_org(env_name)
+      # TODO - someone smarter than me can switch the organization without requiring 2 different knife.rb files
+      current_dir = File.dirname(__FILE__)   
+      case env_name
+      when "innovate"
+        Chef::Config[:config_file] = "#{current_dir}/../../knife-production.rb"
+      when "production"
+        Chef::Config[:config_file] = "#{current_dir}/../../knife-production.rb"
+      when "candidate"
+        Chef::Config[:config_file] = "#{current_dir}/../../knife.rb"
+      end
+      ::File::open(config[:config_file]) { |f| apply_config(f.path) }
+    end
+
+    def load_env_file(env_name)
+      if File.exist?("environments/#{env_name}.json")
+        File.read("environments/#{env_name}.json")
+      else
+        # TODO - we should handle the creation of the environment.json file if it doesn't exist.
+        raise ArgumentError, "environments/#{env_name}.json was not found; please create the environment file manually.#{env_name}"
+      end
+    end
+
+    def apply_config(config_file_path)
+      Chef::Config.from_file(config_file_path)
+      Chef::Config.merge!(config)
+    end
+
+    def commit_and_push_branch(branch, comment)
+      print "--------------------------------- \n"
+      system("git pull origin #{branch}") 
+      system("git add .")
+      system("git commit -am  '#{comment}'")
+      system("git push origin #{branch}")
+      print "--------------------------------- \n"
+    end
+    
+    def checkout_branch(name)
+      print "--------------------------------- \n"
+      system("git checkout #{name}")
+      print "--------------------------------- \n"
+    end
+
+   def checkout_tag(name)
+      print "--------------------------------- \n"
+      system("git checkout #{name}")
+      print "--------------------------------- \n"
+    end
+
+    def pull_branch(name)
+      print "--------------------------------- \n"
+      system("git pull origin #{name}")
+      print "--------------------------------- \n"
+    end
+
+    def check_branch(name)
+      if (`git status` =~ /#{name}/) != nil
+        return true
+      else
+        ui.error("USAGE: you must be in the #{name} branch.")
+        exit 1
+      end
+    end
+
+    def parse_name_args!
+      if name_args.empty?
+        ui.error("USAGE: knife promote ENVIRONMENT COOKBOOK COOKBOOK ...")
+        exit 1
+      else
+        return name_args
+      end
+    end
+
+    def find_version(name)
+     loader = Chef::CookbookLoader.new(@cookbook_path)
+     return loader[name].version
+    end
+
+    def increment_version(version)
+     current_version = version.split(".").map{|i| i.to_i}
+     current_version[2] = current_version[2] + 1
+     return current_version.join('.')
+    end
+
+    def replace_version(search_string, replace_string, file)
+      open_file = File.open(file, "r")
+      body_of_file = open_file.read
+      open_file.close
+      body_of_file.gsub!(search_string, replace_string)
+      File.open(file, "w") { |file| file << body_of_file }
+    end
+
+  end
+end

data/lib/knife-flow/version.rb

@@ -0,0 +1,5 @@
+module Knife
+  module Flow
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: knife-flow
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Johnlouis Petitbon
+- Jacob Zimmerman
+- Aaron Suggs
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-09 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: The main reason for having a workflow around the development and promotion of cookbooks is to ensure quality, reliability and administrative security of the process.
+email: 
+- jpetitbon@mdsol.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- knife-flow.gemspec
+- lib/chef/knife/increment.rb
+- lib/chef/knife/promote.rb
+- lib/chef/knife/release.rb
+- lib/knife-flow/version.rb
+has_rdoc: true
+homepage: https://github.com/mdsol/knife-flow
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: knife-flow
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: A collection of Chef plugins for managing the migration of cookbooks to environments in different Opscode organizations.
+test_files: []
+