head_chef 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDc2NGY2YjQxODc1ZjgwNWUzNGI5NWI5Y2YzY2ZlZDNlYzRlYWYwYQ==
+  data.tar.gz: !binary |-
+    NzA5MTRhODJiNDMwZmZlYmFjODM4NTAwMmRiNWZhZTE4N2YzZjNhYg==
+SHA512:
+  metadata.gz: !binary |-
+    NTYzMDNhYTNiOTQyMDczNWQyODNlODBjNGU4MWFjNGNlMjhhYzdhYzk2OWEz
+    YTM5YTkzZDM4YTlmNWYxN2NlMWU5YjAyMjE2MzU2YTdlODg5NGMxMDUyMTEx
+    NDk5NmI1MGRjMzZkZDFiZDExY2FlZDg4NmI3OWE3OGU1NzEyY2Q=
+  data.tar.gz: !binary |-
+    NjIyMjNjODBhNmQ0OWRlNjhjMzg0ZDBkNjA1MmE5MjRhNDQ2YmRlNjViMWEx
+    YzJmMjg3MWQ0ODhiZDcwZWQ5NWFlZDBiMDEwNWJhNDZkM2U4NWJmZWE3NzBj
+    MmQ1ZmExMTZkYWNiZTcxMThmMDQ1NjU2YTU1N2QzNzZjYjg1NDQ=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+head_chef

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p286

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in head_chef.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Medidata
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+Head Chef
+========
+
+The head-chef gem can be used to create environments based on the
+branches in a git repository containing a master cookbook that uses
+Berkshelf for dependency management.
+
+Different Chef environments (eg. production and non-production) may 
+be located in different Chef organizations; this is configurable.
+
+#Usage
+
+To create or update the environment for the current branch:
+
+```bash
+head-chef env sync
+```
+
+The sync command accepts these options: 
+
+```bash
+--force, Overwrites cookbooks on chef server 
+``` 
+
+To compare the differences between the current branch and the 
+environment in use on the Chef server:
+
+```bash
+head-chef env diff
+```
+
+The above commands accept a number of options:
+
+```bash
+-e <environment>,      Applies to the specified Chef environment 
+```
+
+

data/Rakefile

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

data/bin/head-chef

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'head_chef/cli'
+
+HeadChef::Cli.start

data/features/commands/diff.feature

@@ -0,0 +1,74 @@
+Feature: head-chef env diff
+  Background:
+    Given the current git branch is named "test"
+    And the Chef Server has an environment named "test"
+
+  Scenario: Diff with same version constraints
+    Given the Berksfile has the following cookbooks:
+      | test_cookbook | 0.1.0 | cookbook_path |
+    And the environment "test" has the following cookbook version constraints:
+      | test_cookbook | 0.1.0 |
+    When I run `head-chef env diff`
+    Then the output should contain "identical"
+
+  Scenario: Diff with a cookbook file list conflict
+    Given the Berksfile has the following cookbooks:
+      | test_cookbook | 0.1.0 | file_list_conflict_path |
+    And the Chef Server has the following cookbooks uploaded:
+      | test_cookbook | 0.1.0 | cookbook_path |
+    And the environment "test" has the following cookbook version constraints:
+      | test_cookbook | 0.1.0 |
+    When I run `head-chef env diff`
+    Then the output should contain "CONFLICT"
+
+  Scenario: Diff with a cookbook file content conflict
+    Given the Berksfile has the following cookbooks:
+      | test_cookbook | 0.1.0 | file_content_conflict_path |
+    And the Chef Server has the following cookbooks uploaded:
+      | test_cookbook | 0.1.0 | cookbook_path |
+    And the environment "test" has the following cookbook version constraints:
+      | test_cookbook | 0.1.0 |
+    When I run `head-chef env diff`
+    Then the output should contain "CONFLICT"
+
+  Scenario: Diff with a cookbook add
+    Given the Berksfile has the following cookbooks:
+      | test_cookbook | 0.1.0 | cookbook_path |
+    And the environment "test" does not have the following cookbook version constraints:
+      | test_cookbook | 0.1.0 |
+    When I run `head-chef env diff`
+    Then the output should contain "ADD"
+
+  Scenario: Diff with a cookbook update
+    Given the Berksfile has the following cookbooks:
+      | test_cookbook | 0.1.0 | cookbook_path |
+    And the environment "test" has the following cookbook version constraints:
+      | test_cookbook | 0.0.1 |
+    When I run `head-chef env diff`
+    Then the output should contain "UPDATE"
+
+  Scenario: Diff with a cookbook remove
+    Given the Berksfile does not have the following cookbooks:
+      | test_cookbook |
+    And the environment "test" has the following cookbook version constraints:
+      | test_cookbook | 0.1.0 |
+    When I run `head-chef env diff`
+    Then the output should contain "REMOVE"
+
+  Scenario: Diff with a cookbook revert
+    Given the Berksfile has the following cookbooks:
+      | test_cookbook | 0.1.0 | cookbook_path |
+    And the environment "test" has the following cookbook version constraints:
+      | test_cookbook | 0.2.0 |
+    When I run `head-chef env diff`
+    Then the output should contain "REVERT"
+
+  Scenario: Diff using environment option with existing environment
+    Given the Chef Server has an environment named "environment_option"
+    When I run `head-chef env diff -e=environment_option`
+    Then the output should contain "Calculating diff"
+
+  Scenario: Diff without existing environment
+    Given the Chef Server does not have an environment named "test"
+    When I run `head-chef env diff`
+    Then the output should contain "not found"

data/features/commands/list.feature

@@ -0,0 +1,20 @@
+Feature: head-chef env list
+  Background:
+    Given the current git branch is named "test"
+
+  Scenario: Listing cookbook and version constraints for existing Chef environment
+    Given the Chef Server has an environment named "test"
+    And the environment "test" has the following cookbook version constraints:
+      | cookbook | 0.0.1 |
+    When I run `head-chef env list`
+    Then the output should contain "cookbook: 0.0.1"
+
+  Scenario: Listing cookbook and version constraints for non-existent Chef environment
+    Given the Chef Server does not have an environment named "test"
+    When I run `head-chef env list`
+    Then the output should contain "not found"
+
+  Scenario: Calling list command with environment option
+    Given the Chef Server has an environment named "other_branch"
+    When I run `head-chef env list --environment=other_branch`
+    Then the output should contain "COOKBOOKS:"

data/features/commands/sync.feature

@@ -0,0 +1,67 @@
+Feature: head-chef env sync
+  Background:
+    Given the current git branch is named "test"
+
+  Scenario: Sync without existing chef envrionment
+    Given the Chef Server does not have an environment named "test"
+    And the Berksfile has the following cookbooks:
+      | test_cookbook | 0.1.0 | cookbook_path |
+    When I run `head-chef env sync`
+    Then the Chef Server should have an environment named "test"
+    And the environment "test" should have the following cookbook version constraints:
+      | test_cookbook | 0.1.0 |
+
+  Scenario: Sync with existing chef environment
+    Given the Chef Server has an environment named "test"
+    And the Berksfile has the following cookbooks:
+      | test_cookbook | 0.1.0 | cookbook_path |
+    When I run `head-chef env sync`
+    Then the environment "test" should have the following cookbook version constraints:
+      | test_cookbook | 0.1.0 |
+
+  Scenario: Sync with existing chef environment overwrites previous environment cookbook verion constraints
+    Given the Chef Server has an environment named "test"
+    And the environment "test" has the following cookbook version constraints:
+      | other_cookbook | 0.1.0 |
+    And the Berksfile has the following cookbooks:
+      | test_cookbook | 0.1.0 | cookbook_path |
+    When I run `head-chef env sync`
+    Then the environment "test" should have the following cookbook version constraints:
+      | test_cookbook | 0.1.0 |
+    Then the environment "test" should not have the following cookbook version constraints:
+      | other_cookbook | 0.1.0 |
+
+  Scenario: Sync without cookbook on Chef Server
+    Given the Berksfile has the following cookbooks:
+      | test_cookbook | 0.1.0 | cookbook_path |
+    And the Chef Server does not have the following cookbooks uploaded:
+      | test_cookbook | 0.1.0 |
+    When I run `head-chef env sync`
+    Then the Chef Server should have the following cookbooks uploaded:
+      | test_cookbook | 0.1.0 |
+
+  Scenario: Sync with cookbook on Chef Server
+    Given the Berksfile has the following cookbooks:
+      | test_cookbook | 0.1.0 | cookbook_path |
+    And the Chef Server has the following cookbooks uploaded:
+      | test_cookbook | 0.1.0 | cookbook_path |
+    When I run `head-chef env sync`
+    Then the Chef Server should have the following cookbooks uploaded:
+      | test_cookbook | 0.1.0 |
+
+  Scenario: Sync with cookbook conflict without force option
+    Given the Berksfile has the following cookbooks:
+      | test_cookbook | 0.1.0 | file_list_conflict_path |
+    And the Chef Server has the following cookbooks uploaded:
+      | test_cookbook | 0.1.0 | cookbook_path |
+    When I run `head-chef env sync`
+    Then the output should contain "conflict"
+
+  Scenario: Sync with cookbook conflict with force option
+    Given the Berksfile has the following cookbooks:
+      | test_cookbook | 0.1.0 |  cookbook_path|
+    And the Chef Server has the following cookbooks uploaded:
+      | test_cookbook | 0.1.0 | cookbook_path |
+    When I run `head-chef env sync --force`
+    Then the Chef Server should have the following cookbooks uploaded:
+      | test_cookbook | 0.1.0 |

data/features/step_definitions/berkshelf_steps.rb

@@ -0,0 +1,40 @@
+require 'erubis'
+
+Given(/^the Berksfile has the following cookbooks:$/) do |cookbooks|
+  berksfile_template = Erubis::Eruby.new(File.read('../spec/fixtures/Berksfiles/template.erb'))
+
+
+  berkshelf_entries = cookbooks.raw.map do |cookbook|
+    cookbook_path = self.send(cookbook[2].to_sym, cookbook[0])
+
+    cookbook[2] = "path: '#{cookbook_path}'"
+    cookbook
+  end
+
+  context = {
+    cookbooks: berkshelf_entries
+  }
+
+  File.open('Berksfile', 'w') do |file|
+    file.write(berksfile_template.evaluate(context))
+  end
+end
+
+
+Given(/^the Berksfile does not have the following cookbooks:$/) do |cookbooks|
+  tmp = Tempfile.new('Berksfile.tmp')
+
+  File.open('Berksfile', 'r').each do |line|
+    writeable = true
+
+    cookbooks.raw.each do |name|
+      writeable = false if (line =~ /#{name.first}/)
+    end
+
+    tmp.write(line) if writeable
+  end
+
+  tmp.close
+  FileUtils.mv(tmp.path, 'Berksfile')
+  tmp.unlink
+end

data/features/step_definitions/chef_server_steps.rb

@@ -0,0 +1,81 @@
+require 'ridley'
+World(HeadChef::RSpec::ChefServer)
+
+Given(/^the Chef Server has an environment named "(.*?)"$/) do |name|
+  chef_environment(name, { 'description' => 'This is an environment' })
+end
+
+Then(/^the Chef Server should have an environment named "(.*?)"$/) do |name|
+  # To avoid error warning, raise_error requires a proc
+  lambda { chef_server.data_store.get(['environments', name]) }.should_not raise_error
+end
+
+Given(/^the Chef Server does not have an environment named "(.*?)"$/) do |name|
+  if chef_server.data_store.exists?(['environments', name])
+    chef_server.data_store.delete(['environments', name])
+  end
+end
+
+Given(/^the environment "(.*?)" has the following cookbook version constraints:$/) do |name, locks|
+  cookbook_versions = {}.tap do |h|
+    locks.rows_hash.each do |cookbook, version|
+      h[cookbook] = version
+    end
+  end
+
+  chef_environment(name, { 'cookbook_versions' => cookbook_versions })
+end
+
+Given(/^the environment "(.*?)" does not have the following cookbook version constraints:$/) do |name, locks|
+  list = chef_environment_locks(name)
+
+  if list
+    locks.raw.each do |cookbook_name, version|
+      if list.key?(cookbook_name) && list[cookbook_name] == version
+        list.delete(cookbook_name)
+      end
+    end
+
+    chef_environment(name, { 'cookbook_versions' => list })
+  end
+end
+
+Then(/^the environment "(.*?)" should have the following cookbook version constraints:$/) do |name, locks|
+  list = chef_environment_locks(name)
+
+  locks.raw.each do |cookbook, version|
+    expect(list[cookbook]).to eq(version)
+  end
+end
+
+Then(/^the environment "(.*?)" should not have the following cookbook version constraints:$/) do |name, locks|
+  list = chef_environment_locks(name)
+
+  locks.raw.each do |cookbook, version|
+    expect(list[cookbook]).not_to eq(version)
+  end
+end
+
+Given(/^the Chef Server has the following cookbooks uploaded:$/) do |cookbooks|
+  ridley = Ridley.from_chef_config()
+
+  cookbooks.raw.each do |name, version, path|
+    ridley.cookbook.upload(self.send(path.to_sym, name))
+  end
+end
+
+Given(/^the Chef Server does not have the following cookbooks uploaded:$/) do |cookbooks|
+  ridley = Ridley.from_chef_config()
+
+  cookbooks.raw.each do |name, version|
+    ridley.cookbook.delete(name, version)
+  end
+end
+
+Given(/^the Chef Server should have the following cookbooks uploaded:$/) do |cookbooks|
+  list = chef_cookbooks
+
+  cookbooks.raw.each do |name, version|
+    expect(list[name]).to include(version)
+  end
+end

data/features/step_definitions/git_steps.rb

@@ -0,0 +1,3 @@
+Given(/^the current git branch is named "(.*?)"$/) do |name|
+  system "git checkout -b #{name} --quiet"
+end

data/features/support/env.rb

@@ -0,0 +1,40 @@
+require 'head_chef/cli'
+require 'aruba/cucumber'
+Dir['spec/support/**/*.rb'].each { |f| require File.expand_path(f) }
+
+World(HeadChef::RSpec::PathHelpers)
+
+CHEF_SERVER_PORT = 6267
+
+Before do
+  clean_tmp_path
+
+  # Set up paths
+  Dir.chdir(tmp_path) # ruby dir
+  @dirs                 = tmp_path # aruba dir
+  ENV['PWD']            = tmp_path.to_s # bash dir
+  ENV['BERKSHELF_PATH'] = berkshelf_path.to_s # berkshelf dir
+
+  # Write Berksfile and Berksfile.lock
+  FileUtils.cp fixtures_path.join('Berksfiles/default').expand_path, 
+    tmp_path.join('Berksfile').expand_path
+
+  # Write .chef/knife.rb
+  FileUtils.cp_r fixtures_path.join('dot_chef').expand_path, 
+    tmp_path.join('.chef').expand_path
+
+  # Create temp git repo
+  `GIT_DIR="#{tmp_path.join('.git').expand_path}" git init --quiet`
+
+  HeadChef::RSpec::ChefServer.start(port: CHEF_SERVER_PORT)
+
+  @aruba_timeout_seconds = 10
+end
+
+After do
+  HeadChef::RSpec::ChefServer.reset!
+
+  if File.exists?(tmp_path.join('Berksfile.lock').expand_path)
+    FileUtils.rm tmp_path.join('Berksfile.lock').expand_path 
+  end
+end

data/head_chef.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'head_chef/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'head_chef'
+  spec.version       = HeadChef::VERSION
+  spec.authors       = ['Mark Corwin']
+  spec.email         = ['mcorwin@mdsol.com']
+  spec.description   = %q{Head Chef is a Chef workflow CLI built on Berkshelf}
+  spec.summary       = %q{Chef workflow tool}
+  spec.homepage      = 'https://github.com/mdsol/head_chef'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'cucumber'
+  spec.add_development_dependency 'aruba'
+  spec.add_development_dependency 'chef-zero'
+  spec.add_development_dependency 'erubis'
+  spec.add_development_dependency 'ridley'
+  spec.add_development_dependency 'hashie'
+
+  spec.add_runtime_dependency 'thor'
+  spec.add_runtime_dependency 'grit'
+  spec.add_runtime_dependency 'berkshelf'
+  spec.add_runtime_dependency 'ridley'
+  spec.add_runtime_dependency 'semantic'
+end

data/lib/head_chef/cli.rb

@@ -0,0 +1,28 @@
+require 'head_chef'
+
+module HeadChef
+  class Cli < Thor
+
+    # This is the main entry point for CLI.
+    # It wraps the Thor start command to provide error handling.
+    class << self
+      def start(given_args=ARGV, config={})
+        begin
+          super
+          HeadChef.cleanup
+        rescue Berkshelf::BerkshelfError => e
+          HeadChef.ui.error e
+          Kernel.exit(e.status_code)
+        rescue Ridley::Errors::HTTPError => e
+          HeadChef.ui.error "#{e.class}: #{e} \nEndpoint: #{e.env[:url]}"
+          Kernel.exit(1337)
+        end
+      end
+    end
+
+    namespace 'head_chef'
+
+    desc "env", "Sync and diff branches with Chef enviroments"
+    subcommand "env", Env
+  end
+end

data/lib/head_chef/cookbook.rb

@@ -0,0 +1,115 @@
+require 'digest'
+require 'set'
+
+module HeadChef
+  class Cookbook
+    #@TODO: add enum for methods
+
+    attr_reader :name
+    attr_reader :berkshelf_version # Berkshelf.lock version
+    attr_reader :chef_version # Chef server version
+
+    def initialize(name, berkshelf_version, chef_version)
+      @name = name
+      @berkshelf_version = berkshelf_version
+      @chef_version = chef_version
+    end
+
+    # Returns true if upload will have no conflicts, false otherwise
+    def diff
+      # Get file checksums from chef server
+      cookbook_resource = HeadChef.chef_server.cookbook.find(@name, @berkshelf_version)
+      # Cookbook not present on chef server
+      return true unless cookbook_resource
+
+      # Get cookbook from berkshelf cookbook cache
+      # NOTE: requires berks install/update to be run to ensure cache is
+      # populate from lockfile
+      # NOTE: Berkshelf 3.0 can load cookbooks from lockfile without loading
+      # cache
+      # User manage berksfile? For now, yes
+      berkshelf_cookbook = HeadChef.berksfile.cached_cookbooks.find do |cb|
+        cb.name == "#{@name}-#{@berkshelf_version}"
+      end
+      # Cookbook will not be uploaded since it is not in Berksfile.lock
+      return true unless berkshelf_cookbook
+
+      cookbook_files_mashes = files_from_manifest(cookbook_resource.manifest)
+
+      # Diff file lists
+      cookbook_files = Set.new(cookbook_files_mashes.map(&:path))
+      berkshelf_files = Set.new(remove_ignored_files(berkshelf_cookbook.path))
+
+      return false unless berkshelf_files == cookbook_files
+
+      # Diff file contents
+      cookbook_files_mashes.each do |cookbook_file_mash|
+        berkshelf_cookbook_file = "#{berkshelf_cookbook.path}/#{cookbook_file_mash.path}"
+        berkshelf_cookbook_checksum = checksum_file(berkshelf_cookbook_file) if File.exists?(berkshelf_cookbook_file)
+
+        return false unless berkshelf_cookbook_checksum == cookbook_file_mash.checksum
+      end
+
+      true
+    end
+
+    def to_s
+      if @chef_version && @berkshelf_version && (@chef_version != @berkshelf_version)
+        "#{@name}: #{@chef_version} => #{@berkshelf_version}"
+      else
+        "#{@name}: #{@chef_version || @berkshelf_version}"
+      end
+    end
+
+    private
+
+    def files_from_manifest(manifest)
+      manifest.values.flatten
+    end
+
+    # Taken from Chef
+    def checksum_file(file)
+      File.open(file, 'rb') { |f| checksum_io(f, Digest::MD5.new) }
+    end
+
+    def checksum_io(io, digest)
+      while chunk = io.read(1024 * 8)
+        digest.update(chunk)
+      end
+      digest.hexdigest
+    end
+
+    def remove_ignored_files(path)
+      file_list = Dir.chdir(path) do
+        Dir['**/*'].select { |f| File.file?(f) }
+      end
+
+      ignore_file = File.join(path, 'chefignore')
+      ignore_globs = parse_ignore_file(ignore_file)
+
+      remove_ignores_from(file_list, ignore_globs)
+    end
+
+    def remove_ignores_from(file_list, ignore_globs)
+      file_list.reject do |file|
+        ignored?(file, ignore_globs)
+      end
+    end
+
+    def ignored?(file_name, ignores)
+      ignores.any? { |glob| File.fnmatch?(glob, file_name) }
+    end
+
+    def parse_ignore_file(ignore_file)
+      [].tap do |ignore_globs|
+        if File.exist?(ignore_file) && File.readable?(ignore_file) &&
+        (File.file?(ignore_file) || File.symlink?(ignore_file))
+          File.foreach(ignore_file) do |line|
+            ignore_globs << line.strip unless line =~ /^\s*(?:#.*)?$/
+          end
+        end
+      end
+    end
+
+  end
+end