clc-cheffish 0.8.clc

data/spec/integration/recipe_dsl_spec.rb

@@ -0,0 +1,29 @@
+require 'support/spec_support'
+require 'chef/resource/chef_node'
+require 'chef/provider/chef_node'
+require 'tmpdir'
+
+describe 'Cheffish Recipe DSL' do
+  extend SpecSupport
+
+  context 'when we include with_chef_local_server' do
+    before :each do
+      @tmp_repo = tmp_repo = Dir.mktmpdir('chef_repo')
+      load_recipe do
+        with_chef_local_server :chef_repo_path => tmp_repo
+      end
+    end
+
+    after :each do
+      FileUtils.remove_entry_secure @tmp_repo
+    end
+
+    it 'chef_nodes get put into said server' do
+      run_recipe do
+        chef_node 'blah'
+      end
+      expect(chef_run).to have_updated 'chef_node[blah]', :create
+      expect(File).to exist("#{@tmp_repo}/nodes/blah.json")
+    end
+  end
+end

data/spec/support/key_support.rb

@@ -0,0 +1,29 @@
+RSpec::Matchers.define :be_public_key_for do |private_key, pass_phrase|
+  match do |public_key|
+    if public_key.is_a?(String)
+      public_key, public_key_format = Cheffish::KeyFormatter.decode(IO.read(File.expand_path(public_key)), pass_phrase, public_key)
+    end
+    if private_key.is_a?(String)
+      private_key, private_key_format = Cheffish::KeyFormatter.decode(IO.read(File.expand_path(private_key)), pass_phrase, private_key)
+    end
+
+    encrypted = public_key.public_encrypt('hi there')
+    expect(private_key.private_decrypt(encrypted)).to eq('hi there')
+  end
+end
+
+RSpec::Matchers.define :match_private_key do |expected, pass_phrase|
+  match do |actual|
+    if expected.is_a?(String)
+      expected, format = Cheffish::KeyFormatter.decode(IO.read(File.expand_path(expected)), pass_phrase, expected)
+    end
+    if actual.is_a?(String)
+      actual, format = Cheffish::KeyFormatter.decode(IO.read(File.expand_path(actual)), pass_phrase, actual)
+    end
+
+    encrypted = actual.public_encrypt('hi there')
+    expect(expected.private_decrypt(encrypted)).to eq('hi there')
+    encrypted = expected.public_encrypt('hi there')
+    expect(actual.private_decrypt(encrypted)).to eq('hi there')
+  end
+end

data/spec/support/repository_support.rb

@@ -0,0 +1,103 @@
+module RepositorySupport
+  def when_the_repository(desc, *tags, &block)
+    context("when the chef repo #{desc}", *tags) do
+      include_context "with a chef repo"
+      extend WhenTheRepositoryClassMethods
+      module_eval(&block)
+    end
+  end
+
+  RSpec.shared_context "with a chef repo" do
+    before :each do
+      raise "Can only create one directory per test" if @repository_dir
+      @repository_dir = Dir.mktmpdir('chef_repo')
+      Chef::Config.chef_repo_path = @repository_dir
+      %w(client cookbook data_bag environment node role user).each do |object_name|
+        Chef::Config.delete("#{object_name}_path".to_sym)
+      end
+    end
+
+    after :each do
+      if @repository_dir
+        begin
+          %w(client cookbook data_bag environment node role user).each do |object_name|
+            Chef::Config.delete("#{object_name}_path".to_sym)
+          end
+          Chef::Config.delete(:chef_repo_path)
+          FileUtils.remove_entry_secure(@repository_dir)
+        ensure
+          @repository_dir = nil
+        end
+      end
+      Dir.chdir(@old_cwd) if @old_cwd
+    end
+
+    def directory(relative_path, &block)
+      old_parent_path = @parent_path
+      @parent_path = path_to(relative_path)
+      FileUtils.mkdir_p(@parent_path)
+      instance_eval(&block) if block
+      @parent_path = old_parent_path
+    end
+
+    def file(relative_path, contents)
+      filename = path_to(relative_path)
+      dir = File.dirname(filename)
+      FileUtils.mkdir_p(dir) unless dir == '.'
+      File.open(filename, 'w') do |file|
+        raw = case contents
+              when Hash
+                JSON.pretty_generate(contents)
+              when Array
+                contents.join("\n")
+              else
+                contents
+              end
+        file.write(raw)
+      end
+    end
+
+    def symlink(relative_path, relative_dest)
+      filename = path_to(relative_path)
+      dir = File.dirname(filename)
+      FileUtils.mkdir_p(dir) unless dir == '.'
+      dest_filename = path_to(relative_dest)
+      File.symlink(dest_filename, filename)
+    end
+
+    def path_to(relative_path)
+      File.expand_path(relative_path, (@parent_path || @repository_dir))
+    end
+
+    def cwd(relative_path)
+      @old_cwd = Dir.pwd
+      Dir.chdir(path_to(relative_path))
+    end
+
+    module WhenTheRepositoryClassMethods
+      def directory(*args, &block)
+        before :each do
+          directory(*args, &block)
+        end
+      end
+
+      def file(*args, &block)
+        before :each do
+          file(*args, &block)
+        end
+      end
+
+      def symlink(*args, &block)
+        before :each do
+          symlink(*args, &block)
+        end
+      end
+
+      def path_to(*args, &block)
+        before :each do
+          file(*args, &block)
+        end
+      end
+    end
+  end
+end

data/spec/support/spec_support.rb

@@ -0,0 +1,176 @@
+require 'chef_zero/rspec'
+require 'chef/server_api'
+require 'cheffish'
+require 'cheffish/basic_chef_client'
+require 'chef/provider/chef_acl'
+require 'uri'
+require 'support/repository_support'
+
+module SpecSupport
+  include ChefZero::RSpec
+
+  def self.extended(klass)
+    klass.class_eval do
+      extend RepositorySupport
+
+      def rest
+        Chef::ServerAPI.new
+      end
+
+      def get(path, *args)
+        if path[0] == '/'
+          path = URI.join(rest.url, path)
+        end
+        rest.get(path, *args)
+      end
+
+      def chef_run
+        converge if !@converged
+        event_sink.events
+      end
+
+      def event_sink
+        @event_sink ||= EventSink.new
+      end
+
+      def basic_chef_client
+        @basic_chef_client ||= begin
+          Cheffish::BasicChefClient.new(nil, event_sink)
+        end
+      end
+
+      def load_recipe(&block)
+        basic_chef_client.load_block(&block)
+      end
+
+      def run_recipe(&block)
+        load_recipe(&block)
+        converge
+      end
+
+      def reset_chef_client
+        @event_sink = nil
+        @basic_chef_client = nil
+        @converged = false
+      end
+
+      def converge
+        if @converged
+          raise "Already converged! Cannot converge twice, that's bad mojo."
+        end
+        @converged = true
+        basic_chef_client.converge
+      end
+    end
+  end
+
+  def with_recipe(&block)
+    before :each do
+      load_recipe(&block)
+    end
+
+    after :each do
+      if !@converged
+        raise "Never tried to converge!"
+      end
+    end
+  end
+
+  def with_converge(&block)
+    before :each do
+      load_recipe(&block) if block_given?
+      converge
+    end
+  end
+
+  class EventSink
+    def initialize
+      @events = []
+    end
+
+    attr_reader :events
+
+    def method_missing(method, *args)
+      @events << [ method, *args ]
+    end
+  end
+end
+
+RSpec::Matchers.define :have_updated do |resource_name, *expected_actions|
+  match do |actual|
+    actual_actions = actual.select { |event, resource, action| event == :resource_updated && resource.to_s == resource_name }.map { |event, resource, action| action }
+    expect(actual_actions).to eq(expected_actions)
+  end
+  failure_message do |actual|
+    updates = actual.select { |event, resource, action| event == :resource_updated }.to_a
+    result = "expected that the chef_run would #{expected_actions.join(',')} #{resource_name}."
+    if updates.size > 0
+      result << " Actual updates were #{updates.map { |event, resource, action| "#{resource.to_s} => #{action.inspect}" }.join(', ')}"
+    else
+      result << " Nothing was updated."
+    end
+    result
+  end
+  failure_message_when_negated do |actual|
+    updates = actual.select { |event, resource, action| event == :resource_updated }.to_a
+    result = "expected that the chef_run would not #{expected_actions.join(',')} #{resource_name}."
+    if updates.size > 0
+      result << " Actual updates were #{updates.map { |event, resource, action| "#{resource.to_s} => #{action.inspect}" }.join(', ')}"
+    else
+      result << " Nothing was updated."
+    end
+    result
+  end
+end
+
+RSpec::Matchers.define :update_acls do |acl_paths, expected_acls|
+
+  errors = []
+
+  match do |block|
+    orig_json = {}
+    Array(acl_paths).each do |acl_path|
+      orig_json[acl_path] = get(acl_path)
+    end
+
+    block.call
+
+    orig_json.each_pair do |acl_path, orig|
+      changed = get(acl_path)
+      expected_acls.each do |permission, hash|
+        hash.each do |type, actors|
+          actors.each do |actor|
+            if actor[0] == '-'
+              actor = actor[1..-1]
+              errors << "#{acl_path} expected to remove #{type} #{actor} from #{permission} permissions" if changed[permission][type].include?(actor)
+              orig[permission][type].delete(actor)
+            else
+              errors << "#{acl_path} expected to add #{type} #{actor} to #{permission} permissions" if !changed[permission][type].include?(actor)
+              changed[permission][type].delete(actor)
+            end
+          end
+        end
+      end
+      # After checking everything, see if the remaining acl is the same as before
+      errors << "#{acl_path} updated more than expected!\nActual:\n#{changed}\nExpected:\n#{orig}" if changed != orig
+    end
+    errors.size == 0
+  end
+
+  failure_message do |block|
+    errors.join("\n")
+  end
+
+  supports_block_expectations
+end
+
+RSpec.configure do |config|
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+
+  config.before :each do
+    Chef::Config.reset
+  end
+end
+
+require 'chef/providers'

data/spec/unit/get_private_key_spec.rb

@@ -0,0 +1,93 @@
+require 'support/spec_support'
+
+describe Cheffish do
+  let(:directory_that_exists) {
+    Dir.mktmpdir("cheffish-rspec")
+  }
+
+  let(:directory_that_does_not_exist) {
+    dir = Dir.mktmpdir("cheffish-rspec")
+    FileUtils.remove_entry dir
+    dir
+  }
+
+  let(:private_key_contents) { "contents of private key" }
+
+  let(:private_key_pem_contents) { "contents of private key pem" }
+
+  let(:private_key_garbage_contents) { "da vinci virus" }
+
+  def setup_key
+    key_file = File.expand_path("ned_stark", directory_that_exists)
+    File.open(key_file, "w+") do |f|
+      f.write private_key_contents
+    end
+  end
+
+  def setup_pem_key
+    key_file = File.expand_path("ned_stark.pem", directory_that_exists)
+    File.open(key_file, "w+") do |f|
+      f.write private_key_pem_contents
+    end
+  end
+
+  def setup_garbage_key
+    key_file = File.expand_path("ned_stark.pem.bak", directory_that_exists)
+    File.open(key_file, "w+") do |f|
+      f.write private_key_garbage_contents
+    end
+  end
+
+  shared_examples_for "returning the contents of the key file if it finds one" do
+    it "returns nil if it cannot find the private key file" do
+      expect(Cheffish.get_private_key("ned_stark", config)).to be_nil
+    end
+
+    it "returns the contents of the key if it doesn't have an extension" do
+      setup_key
+      expect(Cheffish.get_private_key("ned_stark", config)).to eq(private_key_contents)
+    end
+
+    it "returns the contents of the key if it has an extension" do
+      setup_pem_key
+      expect(Cheffish.get_private_key("ned_stark", config)).to eq(private_key_pem_contents)
+    end
+
+    # we arbitrarily prefer "ned_stark" over "ned_stark.pem" for deterministic behavior
+    it "returns the contents of the key that does not have an extension if both exist" do
+      setup_key
+      setup_pem_key
+      expect(Cheffish.get_private_key("ned_stark", config)).to eq(private_key_contents)
+    end
+  end
+
+  context "#get_private_key" do
+    context "when private_key_paths has a directory which is empty" do
+      let(:config) {
+        { :private_key_paths => [ directory_that_exists ] }
+      }
+
+      it_behaves_like "returning the contents of the key file if it finds one"
+
+      context "when it also has a garbage file" do
+        before { setup_garbage_key }
+
+        it "does not return the da vinci virus if we find only the garbage file" do
+          setup_garbage_key
+          expect(Cheffish.get_private_key("ned_stark", config)).to be_nil
+        end
+
+        it_behaves_like "returning the contents of the key file if it finds one"
+      end
+
+    end
+
+    context "when private_key_paths leads with a directory that does not exist and then an empty directory" do
+      let(:config) {
+        { :private_key_paths => [ directory_that_does_not_exist, directory_that_exists ] }
+      }
+
+      it_behaves_like "returning the contents of the key file if it finds one"
+    end
+  end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: clc-cheffish
+version: !ruby/object:Gem::Version
+  version: 0.8.clc
+platform: ruby
+authors:
+- John Keiser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '11.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '11.8'
+- !ruby/object:Gem::Dependency
+  name: chef-zero
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A library to manipulate Chef in Chef.
+email: jkeiser@opscode.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/chef/provider/chef_acl.rb
+- lib/chef/provider/chef_client.rb
+- lib/chef/provider/chef_container.rb
+- lib/chef/provider/chef_data_bag.rb
+- lib/chef/provider/chef_data_bag_item.rb
+- lib/chef/provider/chef_environment.rb
+- lib/chef/provider/chef_group.rb
+- lib/chef/provider/chef_mirror.rb
+- lib/chef/provider/chef_node.rb
+- lib/chef/provider/chef_organization.rb
+- lib/chef/provider/chef_resolved_cookbooks.rb
+- lib/chef/provider/chef_role.rb
+- lib/chef/provider/chef_user.rb
+- lib/chef/provider/private_key.rb
+- lib/chef/provider/public_key.rb
+- lib/chef/resource/chef_acl.rb
+- lib/chef/resource/chef_client.rb
+- lib/chef/resource/chef_container.rb
+- lib/chef/resource/chef_data_bag.rb
+- lib/chef/resource/chef_data_bag_item.rb
+- lib/chef/resource/chef_environment.rb
+- lib/chef/resource/chef_group.rb
+- lib/chef/resource/chef_mirror.rb
+- lib/chef/resource/chef_node.rb
+- lib/chef/resource/chef_organization.rb
+- lib/chef/resource/chef_resolved_cookbooks.rb
+- lib/chef/resource/chef_role.rb
+- lib/chef/resource/chef_user.rb
+- lib/chef/resource/private_key.rb
+- lib/chef/resource/public_key.rb
+- lib/cheffish.rb
+- lib/cheffish/actor_provider_base.rb
+- lib/cheffish/basic_chef_client.rb
+- lib/cheffish/chef_provider_base.rb
+- lib/cheffish/chef_run_data.rb
+- lib/cheffish/chef_run_listener.rb
+- lib/cheffish/key_formatter.rb
+- lib/cheffish/merged_config.rb
+- lib/cheffish/recipe_dsl.rb
+- lib/cheffish/server_api.rb
+- lib/cheffish/version.rb
+- lib/cheffish/with_pattern.rb
+- spec/functional/fingerprint_spec.rb
+- spec/functional/merged_config_spec.rb
+- spec/integration/chef_acl_spec.rb
+- spec/integration/chef_client_spec.rb
+- spec/integration/chef_container_spec.rb
+- spec/integration/chef_group_spec.rb
+- spec/integration/chef_mirror_spec.rb
+- spec/integration/chef_node_spec.rb
+- spec/integration/chef_organization_spec.rb
+- spec/integration/chef_user_spec.rb
+- spec/integration/private_key_spec.rb
+- spec/integration/recipe_dsl_spec.rb
+- spec/support/key_support.rb
+- spec/support/repository_support.rb
+- spec/support/spec_support.rb
+- spec/unit/get_private_key_spec.rb
+homepage: http://wiki.opscode.com/display/chef
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: A library to manipulate Chef in Chef.
+test_files: []
+has_rdoc: