chef-dk 0.2.0 → 0.2.1

data/lib/chef-dk/skeletons/code_generator/templates/default/LICENSE.mit.erb

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) <%= year %> <%= copyright_holder %>
+
+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/lib/chef-dk/skeletons/code_generator/templates/default/default_recipe.rb.erb

@@ -2,7 +2,4 @@
 # Cookbook Name:: <%= cookbook_name %>
 # Recipe:: default
 #
-# Copyright (C) <%= Time.new.strftime("%Y") %> <%= author_name %>
-#
-# <%= license_description %>
-#
+<%= license_description('#') %>

data/lib/chef-dk/skeletons/code_generator/templates/default/metadata.rb.erb

@@ -1,7 +1,7 @@
 name             '<%= cookbook_name %>'
-maintainer       '<%= author_name %>'
-maintainer_email '<%= author_email %>'
-license          '<%= license_description %>'
+maintainer       '<%= copyright_holder %>'
+maintainer_email '<%= email %>'
+license          '<%= license %>'
 description      'Installs/Configures <%= cookbook_name %>'
 long_description 'Installs/Configures <%= cookbook_name %>'
 version          '0.1.0'

data/lib/chef-dk/skeletons/code_generator/templates/default/repo/config/rake.rb.erb

@@ -0,0 +1,38 @@
+# Configure the Rakefile's tasks.
+
+###
+# Company and SSL Details
+# Used with the ssl_cert task.
+###
+
+# The company name - used for SSL certificates, and in srvious other places
+COMPANY_NAME = "<%= copyright_holder %>"
+
+# The Country Name to use for SSL Certificates
+SSL_COUNTRY_NAME = "US"
+
+# The State Name to use for SSL Certificates
+SSL_STATE_NAME = "Several"
+
+# The Locality Name for SSL - typically, the city
+SSL_LOCALITY_NAME = "Locality"
+
+# What department?
+SSL_ORGANIZATIONAL_UNIT_NAME = "Operations"
+
+# The SSL contact email address
+SSL_EMAIL_ADDRESS = "ops@example.com"
+
+# License for new Cookbooks
+# Can be :apachev2 or :none
+NEW_COOKBOOK_LICENSE = :<%= license %>
+
+###
+# Useful Extras (which you probably don't need to change)
+###
+
+# The top of the repository checkout
+TOPDIR = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+
+# Where to store certificates generated with ssl_cert
+CADIR = File.expand_path(File.join(TOPDIR, "certificates"))

data/lib/chef-dk/skeletons/code_generator/templates/default/repo/gitignore.erb

@@ -0,0 +1,11 @@
+.rake_test_cache
+
+###
+# Ignore Chef key files and secrets
+###
+.chef/*.pem
+.chef/encrypted_data_bag_secret
+<%- if policy_only -%>
+cookbooks/**
+!cookbooks/README.md
+<%- end -%>

data/lib/chef-dk/version.rb

@@ -16,5 +16,5 @@
 #
 
 module ChefDK
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/shared/a_file_generator.rb

@@ -0,0 +1,121 @@
+shared_examples_for "a file generator" do
+
+  let(:stdout_io) { StringIO.new }
+  let(:stderr_io) { StringIO.new }
+
+  def stdout
+    stdout_io.string
+  end
+
+  def stderr
+    stderr_io.string
+  end
+
+  let(:expected_cookbook_root) { tempdir }
+  let(:cookbook_name) { "example_cookbook" }
+
+  let(:cookbook_path) { File.join(tempdir, cookbook_name) }
+
+  subject(:recipe_generator) do
+    generator = described_class.new(argv)
+    allow(generator).to receive(:stdout).and_return(stdout_io)
+    allow(generator).to receive(:stderr).and_return(stderr_io)
+    generator
+  end
+
+  def generator_context
+    ChefDK::Generator.context
+  end
+
+  before do
+    ChefDK::Generator.reset
+    reset_tempdir
+  end
+
+  context "when argv is empty" do
+    let(:argv) { [] }
+
+    it "emits an error message and exits" do
+      expected_stdout = "Usage: chef generate #{generator_name} [path/to/cookbook] NAME [options]"
+
+      expect(recipe_generator.run).to eq(1)
+      expect(stdout).to include(expected_stdout)
+    end
+  end
+
+  context "when CWD is a cookbook" do
+
+    let(:argv) { [ new_file_name ] }
+
+    before do
+      FileUtils.cp_r(File.join(fixtures_path, "example_cookbook"), tempdir)
+    end
+
+    it "configures the generator context" do
+      Dir.chdir(cookbook_path) do
+        recipe_generator.read_and_validate_params
+        recipe_generator.setup_context
+
+        expect(generator_context.cookbook_root).to eq(expected_cookbook_root)
+        expect(generator_context.cookbook_name).to eq(cookbook_name)
+        expect(generator_context.new_file_basename).to eq(new_file_name)
+      end
+    end
+
+    it "creates a new recipe" do
+      Dir.chdir(cookbook_path) do
+        allow(recipe_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+        recipe_generator.run
+      end
+
+        generated_files.each do |expected_file|
+          expect(File).to exist(File.join(cookbook_path, expected_file))
+        end
+    end
+
+  end
+
+  context "when CWD is not a cookbook" do
+    context "and path to the cookbook is not given in the agv" do
+      let(:argv) { [ new_file_name ] }
+
+      it "emits an error message and exits" do
+        expected_stdout = "Usage: chef generate #{generator_name} [path/to/cookbook] NAME [options]"
+        expected_stderr = "Error: Directory #{Dir.pwd} is not a cookbook\n"
+
+        expect(recipe_generator.run).to eq(1)
+        expect(stdout).to include(expected_stdout)
+        expect(stderr).to eq(expected_stderr)
+      end
+    end
+
+    context "and path to the cookbook is given in the argv" do
+      let(:argv) { [cookbook_path, new_file_name ] }
+
+      before do
+        FileUtils.cp_r(File.join(fixtures_path, "example_cookbook"), tempdir)
+      end
+
+      it "configures the generator context" do
+        recipe_generator.read_and_validate_params
+        recipe_generator.setup_context
+
+        expect(generator_context.cookbook_root).to eq(File.dirname(cookbook_path))
+        expect(generator_context.cookbook_name).to eq(cookbook_name)
+        expect(generator_context.new_file_basename).to eq(new_file_name)
+      end
+
+      it "creates a new recipe" do
+        allow(recipe_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+        recipe_generator.run
+
+        generated_files.each do |expected_file|
+          expect(File).to exist(File.join(cookbook_path, expected_file))
+        end
+      end
+
+    end
+  end
+
+end
+

data/spec/shared/a_generated_file.rb

@@ -0,0 +1,12 @@
+shared_examples_for "a generated file" do |context_var|
+  before do
+    Dir.chdir(tempdir) do
+      allow(generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+      generator.run
+    end
+  end
+
+  it "should contain #{context_var} from the generator context" do
+    expect(File.read(file)).to match line
+  end
+end

data/spec/shared/fixture_cookbook_checksums.rb

@@ -0,0 +1,47 @@
+#
+# Copyright:: Copyright (c) 2014 Chef Software 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.
+#
+
+require 'chef-dk/helpers'
+
+RSpec.shared_context "fixture cookbooks checksums" do
+
+  def id_to_dotted(sha1_id)
+    major = sha1_id[0...14]
+    minor = sha1_id[14...28]
+    patch = sha1_id[28..40]
+    decimal_integers =[major, minor, patch].map {|hex| hex.to_i(16) }
+    decimal_integers.join(".")
+  end
+
+  let(:cookbook_foo_cksum) { "467dc855408ce8b74f991c5dc2fd72a6aa369b60" }
+
+  let(:cookbook_foo_cksum_dotted) { id_to_dotted(cookbook_foo_cksum) }
+
+  let(:cookbook_bar_cksum) { "4c538def500b75e744a3af05df66afd04dc3b3c5" }
+
+  let(:cookbook_bar_cksum_dotted) { id_to_dotted(cookbook_bar_cksum) }
+
+  let(:cookbook_baz_cksum) { "5c9063efbc5b5d8acc37024d7383f7dd010ae728" }
+
+  let(:cookbook_baz_cksum_dotted) { id_to_dotted(cookbook_baz_cksum) }
+
+  let(:cookbook_dep_of_bar_cksum) { "a4a6a5e4c6d95a580d291f6415d55b010669feac" }
+
+  let(:cookbook_dep_of_bar_cksum_dotted) { id_to_dotted(cookbook_dep_of_bar_cksum) }
+
+end
+

data/spec/spec_helper.rb

@@ -17,7 +17,6 @@
 
 require 'rubygems'
 require 'rspec/mocks'
-require 'pry-debugger'
 require 'test_helpers'
 
 RSpec.configure do |c|
@@ -28,5 +27,8 @@ RSpec.configure do |c|
 
   c.filter_run :focus => true
   c.run_all_when_everything_filtered = true
-  c.treat_symbols_as_metadata_keys_with_true_values = true
+
+  c.mock_with(:rspec) do |mocks|
+    mocks.verify_partial_doubles = true
+  end
 end

data/spec/unit/chef_runner_spec.rb

@@ -33,17 +33,24 @@ describe ChefDK::ChefRunner do
 
   subject(:chef_runner) do
     r = ChefDK::ChefRunner.new(default_cookbook_path, run_list)
-    r.stub(:stdout).and_return(stdout_io)
-    r.stub(:stderr).and_return(stderr_io)
+    allow(r).to receive(:stdout).and_return(stdout_io)
+    allow(r).to receive(:stderr).and_return(stderr_io)
     r
   end
 
   it "sets up Chef::Config" do
     chef_runner.configure
-    expect(Chef::Config.solo).to be_true
+    expect(Chef::Config.solo).to be true
     expect(Chef::Config.cookbook_path).to eq(default_cookbook_path)
-    expect(Chef::Config.color).to be_true
-    expect(Chef::Config.diff_disabled).to be_true
+    expect(Chef::Config.color).to be true
+    expect(Chef::Config.diff_disabled).to be true
+    expect(Chef::Config.file_staging_uses_destdir).to be true
+  end
+
+  it "disables atomic file updates on Windows" do
+    allow(Chef::Platform).to receive(:windows?) { true }
+    chef_runner.configure
+    expect(Chef::Config.file_atomic_update).to be false
   end
 
   it "configures a formatter for the chef run" do

data/spec/unit/cli_spec.rb

@@ -58,15 +58,15 @@ E
   let(:version_message) { "Chef Development Kit Version: #{ChefDK::VERSION}\n" }
 
   def run_cli(expected_exit_code)
-    cli.should_receive(:exit).with(expected_exit_code)
+    expect(cli).to receive(:exit).with(expected_exit_code)
     cli.run
   end
 
   subject(:cli) do
     ChefDK::CLI.new(argv).tap do |c|
-      c.stub(:commands_map).and_return(commands_map)
-      c.stub(:stdout).and_return(stdout_io)
-      c.stub(:stderr).and_return(stderr_io)
+      allow(c).to receive(:commands_map).and_return(commands_map)
+      allow(c).to receive(:stdout).and_return(stdout_io)
+      allow(c).to receive(:stderr).and_return(stderr_io)
     end
   end
 

data/spec/unit/command/base_spec.rb

@@ -42,7 +42,7 @@ describe ChefDK::Command::Base do
   end
 
   before do
-    command_instance.stub(:stdout).and_return(stdout_io)
+    allow(command_instance).to receive(:stdout).and_return(stdout_io)
   end
 
 

data/spec/unit/command/exec_spec.rb

@@ -33,22 +33,22 @@ describe ChefDK::Command::Exec do
 
   describe "when locating omnibus directory" do
     it "should find omnibus bin directory from ruby path" do
-      Gem.stub(:ruby).and_return(File.join(fixtures_path, "eg_omnibus_dir/valid/embedded/bin/ruby"))
+      allow(Gem).to receive(:ruby).and_return(File.join(fixtures_path, "eg_omnibus_dir/valid/embedded/bin/ruby"))
       expect(command_instance.omnibus_bin_dir).to include("eg_omnibus_dir/valid/bin")
     end
 
     it "should find omnibus embedded bin directory from ruby path" do
-      Gem.stub(:ruby).and_return(File.join(fixtures_path, "eg_omnibus_dir/valid/embedded/bin/ruby"))
+      allow(Gem).to receive(:ruby).and_return(File.join(fixtures_path, "eg_omnibus_dir/valid/embedded/bin/ruby"))
       expect(command_instance.omnibus_embedded_bin_dir).to include("eg_omnibus_dir/valid/embedded/bin")
     end
 
     it "should raise OmnibusInstallNotFound if directory is not looking like omnibus" do
-      Gem.stub(:ruby).and_return(File.join(fixtures_path,".rbenv/versions/2.1.1/bin/ruby"))
+      allow(Gem).to receive(:ruby).and_return(File.join(fixtures_path,".rbenv/versions/2.1.1/bin/ruby"))
       expect{command_instance.omnibus_bin_dir}.to raise_error(ChefDK::OmnibusInstallNotFound)
     end
 
     it "should raise OmnibusInstallNotFound if directory is not looking like omnibus" do
-      Gem.stub(:ruby).and_return(File.join(fixtures_path,".rbenv/versions/2.1.1/bin/ruby"))
+      allow(Gem).to receive(:ruby).and_return(File.join(fixtures_path,".rbenv/versions/2.1.1/bin/ruby"))
       expect{command_instance.omnibus_embedded_bin_dir}.to raise_error(ChefDK::OmnibusInstallNotFound)
     end
   end
@@ -57,7 +57,7 @@ describe ChefDK::Command::Exec do
     let(:ruby_path) { File.join(fixtures_path, "eg_omnibus_dir/valid/embedded/bin/ruby") }
 
     before do
-      Gem.stub(:ruby).and_return(ruby_path)
+      allow(Gem).to receive(:ruby).and_return(ruby_path)
     end
 
     context "when running exec env" do
@@ -69,24 +69,29 @@ describe ChefDK::Command::Exec do
 
       let(:omnibus_bin_dir) { "/foo/bin" }
 
-      let(:expected_env) do
-        {
-          'PATH' => "#{omnibus_bin_dir}:#{user_bin_dir}:#{omnibus_embedded_bin_dir}:#{ENV['PATH']}",
-          'GEM_ROOT' => Gem.default_dir.inspect,
-          'GEM_HOME' => ENV['GEM_HOME'],
-          'GEM_PATH' => Gem.path.join(':'),
-        }
-      end
+      let(:expected_PATH) { "#{omnibus_bin_dir}:#{user_bin_dir}:#{omnibus_embedded_bin_dir}:#{ENV['PATH']}" }
+
+      let(:expected_GEM_ROOT) { Gem.default_dir.inspect }
+
+      let(:expected_GEM_HOME) { ENV['GEM_HOME'] }
+
+      let(:expected_GEM_PATH) { Gem.path.join(':') }
 
       before do
-        command_instance.stub(:omnibus_embedded_bin_dir).and_return(omnibus_embedded_bin_dir)
-        command_instance.stub(:omnibus_bin_dir).and_return(omnibus_bin_dir)
+        allow(command_instance).to receive(:omnibus_embedded_bin_dir).and_return(omnibus_embedded_bin_dir)
+        allow(command_instance).to receive(:omnibus_bin_dir).and_return(omnibus_bin_dir)
       end
 
       it "should call exec to fire off the command with the correct environment" do
-        expect(command_instance).to receive(:exec).with(expected_env, *command_options)
+        expect(ENV).to receive(:[]=).with("PATH", expected_PATH)
+        expect(ENV).to receive(:[]=).with("GEM_ROOT", expected_GEM_ROOT)
+        expect(ENV).to receive(:[]=).with("GEM_HOME", expected_GEM_HOME)
+        expect(ENV).to receive(:[]=).with("GEM_PATH", expected_GEM_PATH)
+
+        expect(command_instance).to receive(:exec).with(*command_options)
         expect{ run_command }.to raise_error # XXX: this isn't a test we just need to swallow the exception
       end
+
     end
 
     context "when running command that does not exist" do
@@ -98,23 +103,28 @@ describe ChefDK::Command::Exec do
 
       let(:omnibus_embedded_bin_dir) { "/foo/embedded/bin" }
 
-      let(:expected_env) do
-        {
-          'PATH' => "#{omnibus_bin_dir}:#{user_bin_dir}:#{omnibus_embedded_bin_dir}:#{ENV['PATH']}",
-          'GEM_ROOT' => Gem.default_dir.inspect,
-          'GEM_HOME' => Gem.paths.home,
-          'GEM_PATH' => Gem.path.join(':'),
-        }
-      end
+      let(:expected_PATH) { "#{omnibus_bin_dir}:#{user_bin_dir}:#{omnibus_embedded_bin_dir}:#{ENV['PATH']}" }
+
+      let(:expected_GEM_ROOT) { Gem.default_dir.inspect }
+
+      let(:expected_GEM_HOME) { ENV['GEM_HOME'] }
+
+      let(:expected_GEM_PATH) { Gem.path.join(':') }
+
 
       before do
-        command_instance.stub(:omnibus_embedded_bin_dir).and_return(omnibus_embedded_bin_dir)
-        command_instance.stub(:omnibus_bin_dir).and_return(omnibus_bin_dir)
+        allow(command_instance).to receive(:omnibus_embedded_bin_dir).and_return(omnibus_embedded_bin_dir)
+        allow(command_instance).to receive(:omnibus_bin_dir).and_return(omnibus_bin_dir)
       end
 
       it "should raise Errno::ENOENT" do
+        expect(ENV).to receive(:[]=).with("PATH", expected_PATH)
+        expect(ENV).to receive(:[]=).with("GEM_ROOT", expected_GEM_ROOT)
+        expect(ENV).to receive(:[]=).with("GEM_HOME", expected_GEM_HOME)
+        expect(ENV).to receive(:[]=).with("GEM_PATH", expected_GEM_PATH)
+
         # XXX: this doesn't really test much, but really calling exec will never return to rspec
-        expect(command_instance).to receive(:exec).with(expected_env, *command_options).and_raise(Errno::ENOENT)
+        expect(command_instance).to receive(:exec).with(*command_options).and_raise(Errno::ENOENT)
         expect{ run_command }.to raise_error(Errno::ENOENT)
       end
     end