chef-dk 0.2.1 → 0.3.0

data/lib/chef-dk/policyfile_services/push.rb

@@ -0,0 +1,121 @@
+#
+# 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/authenticated_http'
+require 'chef-dk/policyfile_compiler'
+require 'chef-dk/policyfile/uploader'
+
+module ChefDK
+  module PolicyfileServices
+    class Push
+
+      attr_reader :root_dir
+      attr_reader :config
+      attr_reader :policy_group
+      attr_reader :ui
+
+      def initialize(policyfile: nil, ui: nil, policy_group: nil, config: nil, root_dir: nil)
+        @root_dir = root_dir
+        @policyfile_relative_path = policyfile
+        @ui = ui
+        @config = config
+        @policy_group = policy_group
+
+        @http_client = nil
+        @storage_config = nil
+        @policy_data = nil
+      end
+
+      def policyfile_relative_path
+        @policyfile_relative_path || "Policyfile.rb"
+      end
+
+      def policyfile_path
+        File.expand_path(policyfile_relative_path, root_dir)
+      end
+
+      def lockfile_relative_path
+        policyfile_relative_path.gsub(/\.rb\Z/, '') + ".lock.json"
+      end
+
+      def lockfile_path
+        File.expand_path(lockfile_relative_path, root_dir)
+      end
+
+      def http_client
+        @http_client ||= ChefDK::AuthenticatedHTTP.new(config.chef_server_url,
+                                                       signing_key_filename: config.client_key,
+                                                       client_name: config.node_name)
+      end
+
+      def policy_data
+        @policy_data ||= FFI_Yajl::Parser.parse(IO.read(lockfile_path))
+      rescue => error
+        raise PolicyfilePushError.new("Error reading lockfile #{lockfile_path}", error)
+      end
+
+      def storage_config
+        @storage_config ||= ChefDK::Policyfile::StorageConfig.new.use_policyfile_lock(lockfile_path)
+      end
+
+      def uploader
+        ChefDK::Policyfile::Uploader.new(policyfile_lock, policy_group, ui: ui, http_client: http_client)
+      end
+
+      def run
+        unless File.exist?(lockfile_path)
+          raise LockfileNotFound, "No lockfile at #{lockfile_path} - you need to run `install` before `push`"
+        end
+
+        validate_lockfile
+        write_updated_lockfile
+        upload_policy
+
+      end
+
+      def policyfile_lock
+        @policyfile_lock || validate_lockfile
+      end
+
+      private
+
+      def upload_policy
+        uploader.upload
+      rescue => error
+        raise PolicyfilePushError.new("Failed to upload policy to policy group #{policy_group}", error)
+      end
+
+      def write_updated_lockfile
+        File.open(lockfile_path, "w+") do |f|
+          f.print(FFI_Yajl::Encoder.encode(policyfile_lock.to_lock, pretty: true ))
+        end
+      end
+
+      def validate_lockfile
+        return @policyfile_lock if @policyfile_lock
+        @policyfile_lock = ChefDK::PolicyfileLock.new(storage_config).build_from_lock_data(policy_data)
+        # TODO: enumerate any cookbook that have been updated
+        @policyfile_lock.validate_cookbooks!
+        @policyfile_lock
+      rescue => error
+        raise PolicyfilePushError.new("Invalid lockfile data", error)
+      end
+
+    end
+  end
+end
+

data/lib/chef-dk/skeletons/code_generator/recipes/cookbook.rb

@@ -43,11 +43,13 @@ template "#{cookbook_dir}/recipes/default.rb" do
 end
 
 # git
-if context.have_git && !context.skip_git_init
+if context.have_git
+  if !context.skip_git_init
 
-  execute("initialize-git") do
-    command("git init .")
-    cwd cookbook_dir
+    execute("initialize-git") do
+      command("git init .")
+      cwd cookbook_dir
+    end
   end
 
   cookbook_file "#{cookbook_dir}/.gitignore" do

data/lib/chef-dk/ui.rb

@@ -0,0 +1,50 @@
+#
+# 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.
+#
+
+module ChefDK
+  class UI
+
+    class NullStream
+
+      def puts(*anything)
+        nil
+      end
+
+    end
+
+    def self.null
+      new(out: NullStream.new, err: NullStream.new)
+    end
+
+    attr_reader :out_stream
+    attr_reader :err_stream
+
+    def initialize(out: nil, err: nil)
+      @out_stream = out || $stdout
+      @err_stream = err || $stderr
+    end
+
+    def err(message)
+      @err_stream.puts(message)
+    end
+
+    def msg(message)
+      @out_stream.puts(message)
+    end
+  end
+end
+

data/lib/chef-dk/version.rb

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

data/spec/shared/a_file_generator.rb

@@ -32,6 +32,10 @@ shared_examples_for "a file generator" do
     reset_tempdir
   end
 
+  after(:each) do
+    ChefDK::Generator::Context.reset
+  end
+
   context "when argv is empty" do
     let(:argv) { [] }
 
@@ -118,4 +122,3 @@ shared_examples_for "a file generator" do
   end
 
 end
-

data/spec/test_helpers.rb

@@ -56,4 +56,25 @@ module TestHelpers
     @tmpdir ||= Dir.mktmpdir("chef-dk")
     File.realpath(@tmpdir)
   end
+
+  class TestUI
+
+    attr_reader :output_stream
+
+    def initialize
+      @output_stream = StringIO.new
+    end
+
+    def err(message)
+      @output_stream.puts(message)
+    end
+
+    def msg(message)
+      @output_stream.puts(message)
+    end
+
+    def output
+      @output_stream.string
+    end
+  end
 end

data/spec/unit/cli_spec.rb

@@ -1,4 +1,3 @@
-#
 # Copyright:: Copyright (c) 2014 Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
@@ -58,6 +57,12 @@ E
   let(:version_message) { "Chef Development Kit Version: #{ChefDK::VERSION}\n" }
 
   def run_cli(expected_exit_code)
+    expect(cli).to receive(:exit).with(expected_exit_code)
+    expect(cli).to receive(:sanity_check!)
+    cli.run
+  end
+
+  def run_cli_with_sanity_check(expected_exit_code)
     expect(cli).to receive(:exit).with(expected_exit_code)
     cli.run
   end
@@ -107,6 +112,18 @@ E
     end
   end
 
+  context "given an invalid option" do
+
+    let(:argv) { %w[-nope] }
+
+    it "prints an 'invalid option message and the help output, then exits non-zero" do
+      run_cli(1)
+      expect(stdout).to eq(base_help_message)
+      expect(stderr).to eq("invalid option: -nope\n")
+    end
+
+  end
+
   context "given an invalid/unknown subcommand" do
     let(:argv) { %w[ancient-aliens] }
 
@@ -148,4 +165,86 @@ E
     end
   end
 
+  context "sanity_check!" do
+    context "on unix" do
+      it "complains if embedded is first" do
+        expect(cli).to receive(:env).and_return({'PATH' => '/opt/chefdk/embedded/bin:/opt/chefdk/bin' })
+        allow(cli).to receive(:omnibus_embedded_bin_dir).and_return("/opt/chefdk/embedded/bin")
+        allow(cli).to receive(:omnibus_bin_dir).and_return("/opt/chefdk/bin")
+        run_cli_with_sanity_check(0)
+        expect(stdout).not_to eq(base_help_message)
+        expect(stdout).to include("please reverse that order")
+        expect(stdout).to include("chef shell-init")
+      end
+
+      it "complains if only embedded is present" do
+        expect(cli).to receive(:env).and_return({'PATH' => '/opt/chefdk/embedded/bin' })
+        allow(cli).to receive(:omnibus_embedded_bin_dir).and_return("/opt/chefdk/embedded/bin")
+        allow(cli).to receive(:omnibus_bin_dir).and_return("/opt/chefdk/bin")
+        run_cli_with_sanity_check(0)
+        expect(stdout).not_to eq(base_help_message)
+        expect(stdout).to include("you must add")
+        expect(stdout).to include("chef shell-init")
+      end
+
+      it "passes when both are present in the correct order" do
+        expect(cli).to receive(:env).and_return({'PATH' => '/opt/chefdk/bin:/opt/chefdk/embedded/bin' })
+        allow(cli).to receive(:omnibus_embedded_bin_dir).and_return("/opt/chefdk/embedded/bin")
+        allow(cli).to receive(:omnibus_bin_dir).and_return("/opt/chefdk/bin")
+        run_cli_with_sanity_check(0)
+        expect(stdout).to eq(base_help_message)
+      end
+
+      it "passes when only the omnibus bin dir is present" do
+        expect(cli).to receive(:env).and_return({'PATH' => '/opt/chefdk/bin' })
+        allow(cli).to receive(:omnibus_embedded_bin_dir).and_return("/opt/chefdk/embedded/bin")
+        allow(cli).to receive(:omnibus_bin_dir).and_return("/opt/chefdk/bin")
+        run_cli_with_sanity_check(0)
+        expect(stdout).to eq(base_help_message)
+      end
+    end
+
+    context "on windows" do
+      before do
+        allow(Chef::Platform).to receive(:windows?).and_return(true)
+        stub_const("File::PATH_SEPARATOR", ';')
+      end
+
+      it "complains if embedded is first" do
+        expect(cli).to receive(:env).and_return({'PATH' => 'C:\opscode\chefdk\embedded\bin;C:\opscode\chefdk\bin' })
+        allow(cli).to receive(:omnibus_embedded_bin_dir).and_return("c:/opscode/chefdk/embedded/bin")
+        allow(cli).to receive(:omnibus_bin_dir).and_return("c:/opscode/chefdk/bin")
+        run_cli_with_sanity_check(0)
+        expect(stdout).not_to eq(base_help_message)
+        expect(stdout).to include("please reverse that order")
+        expect(stdout).to include("chef shell-init")
+      end
+
+      it "complains if only embedded is present" do
+        expect(cli).to receive(:env).and_return({'PATH' => 'C:\opscode\chefdk\embedded\bin' })
+        allow(cli).to receive(:omnibus_embedded_bin_dir).and_return("c:/opscode/chefdk/embedded/bin")
+        allow(cli).to receive(:omnibus_bin_dir).and_return("c:/opscode/chefdk/bin")
+        run_cli_with_sanity_check(0)
+        expect(stdout).not_to eq(base_help_message)
+        expect(stdout).to include("you must add")
+        expect(stdout).to include("chef shell-init")
+      end
+
+      it "passes when both are present in the correct order" do
+        expect(cli).to receive(:env).and_return({'PATH' => 'C:\opscode\chefdk\bin;C:\opscode\chefdk\embedded\bin' })
+        allow(cli).to receive(:omnibus_embedded_bin_dir).and_return("c:/opscode/chefdk/embedded/bin")
+        allow(cli).to receive(:omnibus_bin_dir).and_return("c:/opscode/chefdk/bin")
+        run_cli_with_sanity_check(0)
+        expect(stdout).to eq(base_help_message)
+      end
+
+      it "passes when only the omnibus bin dir is present" do
+        expect(cli).to receive(:env).and_return({'PATH' => 'C:\opscode\chefdk\bin' })
+        allow(cli).to receive(:omnibus_embedded_bin_dir).and_return("c:/opscode/chefdk/embedded/bin")
+        allow(cli).to receive(:omnibus_bin_dir).and_return("c:/opscode/chefdk/bin")
+        run_cli_with_sanity_check(0)
+        expect(stdout).to eq(base_help_message)
+      end
+    end
+  end
 end

data/spec/unit/command/base_spec.rb

@@ -34,6 +34,7 @@ describe ChefDK::Command::Base do
     end
   end
 
+  let(:stderr_io) { StringIO.new }
   let(:stdout_io) { StringIO.new }
   let(:command_instance) { TestCommand.new() }
 
@@ -41,8 +42,13 @@ describe ChefDK::Command::Base do
     stdout_io.string
   end
 
+  def stderr
+    stderr_io.string
+  end
+
   before do
     allow(command_instance).to receive(:stdout).and_return(stdout_io)
+    allow(command_instance).to receive(:stderr).and_return(stderr_io)
   end
 
 
@@ -85,4 +91,21 @@ describe ChefDK::Command::Base do
     expect(stdout).to eq("thanks for passing me true\n")
   end
 
+  describe "when given invalid options" do
+
+    it "prints the help banner and exits gracefully" do
+      expect(run_command(%w[-foo])).to eq(1)
+
+      expect(stderr).to eq("invalid option: -foo\n")
+
+      expected = <<-E
+use me please
+    -u, --user                       If the user exists
+
+E
+      expect(stdout).to eq(expected)
+    end
+
+  end
+
 end

data/spec/unit/command/exec_spec.rb

@@ -73,7 +73,7 @@ describe ChefDK::Command::Exec do
 
       let(:expected_GEM_ROOT) { Gem.default_dir.inspect }
 
-      let(:expected_GEM_HOME) { ENV['GEM_HOME'] }
+      let(:expected_GEM_HOME) { Gem.user_dir }
 
       let(:expected_GEM_PATH) { Gem.path.join(':') }
 
@@ -107,7 +107,7 @@ describe ChefDK::Command::Exec do
 
       let(:expected_GEM_ROOT) { Gem.default_dir.inspect }
 
-      let(:expected_GEM_HOME) { ENV['GEM_HOME'] }
+      let(:expected_GEM_HOME) { Gem.user_dir }
 
       let(:expected_GEM_PATH) { Gem.path.join(':') }
 

data/spec/unit/command/install_spec.rb

@@ -0,0 +1,159 @@
+#
+# 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 'spec_helper'
+require 'chef-dk/command/install'
+
+describe ChefDK::Command::Install do
+
+  let(:params) { [] }
+
+  let(:command) do
+    c = described_class.new
+    c.apply_params!(params)
+    c
+  end
+
+  let(:install_service) { instance_double(ChefDK::PolicyfileServices::Install) }
+
+  it "disables debug by default" do
+    expect(command.debug?).to be(false)
+  end
+
+  it "configures a default UI component" do
+    ui = command.ui
+    expect(ui.out_stream).to eq($stdout)
+    expect(ui.err_stream).to eq($stderr)
+  end
+
+  context "when debug mode is set" do
+
+    let(:params) { [ "-D" ] }
+
+    it "enables debug" do
+      expect(command.debug?).to be(true)
+    end
+  end
+
+  context "with no arguments" do
+
+    it "does not specify a policyfile relative path" do
+      expect(command.policyfile_relative_path).to be(nil)
+    end
+
+    it "creates the installer service with a `nil` policyfile path" do
+      expect(ChefDK::PolicyfileServices::Install).to receive(:new).
+        with(policyfile: nil, ui: command.ui, root_dir: Dir.pwd).
+        and_return(install_service)
+      expect(command.installer).to eq(install_service)
+    end
+
+  end
+
+  context "with an explicit policyfile relative path" do
+
+    let(:params) { [ "MyPolicy.rb" ] }
+
+    it "respects the user-supplied path" do
+      expect(command.policyfile_relative_path).to eq("MyPolicy.rb")
+    end
+
+    it "creates the installer service with the specified policyfile path" do
+      expect(ChefDK::PolicyfileServices::Install).to receive(:new).
+        with(policyfile: "MyPolicy.rb", ui: command.ui, root_dir: Dir.pwd).
+        and_return(install_service)
+      expect(command.installer).to eq(install_service)
+    end
+
+  end
+
+  describe "running the install" do
+
+    let(:ui) { TestHelpers::TestUI.new }
+
+    before do
+      command.ui = ui
+      allow(command).to receive(:installer).and_return(install_service)
+    end
+
+    context "when the command is successful" do
+      before do
+        expect(install_service).to receive(:run)
+      end
+
+      it "returns 0" do
+        expect(command.run).to eq(0)
+      end
+    end
+
+    context "when the command is unsuccessful" do
+
+      let(:backtrace) { caller[0...3] }
+
+      let(:cause) do
+        e = StandardError.new("some operation failed")
+        e.set_backtrace(backtrace)
+        e
+      end
+
+      let(:exception) do
+        ChefDK::PolicyfileInstallError.new("install failed", cause)
+      end
+
+      before do
+        expect(install_service).to receive(:run).and_raise(exception)
+      end
+
+      it "returns 1" do
+        expect(command.run).to eq(1)
+      end
+
+      it "displays the exception and cause" do
+        expected_error_text=<<-E
+Error: install failed
+Reason: StandardError
+
+some operation failed
+E
+
+        command.run
+        expect(ui.output).to eq(expected_error_text)
+      end
+
+      context "and debug is enabled" do
+
+        let(:params) { ["-D"] }
+
+        it "displays the exception and cause with backtrace" do
+          expected_error_text=<<-E
+Error: install failed
+Reason: StandardError
+
+some operation failed
+E
+
+          expected_error_text << backtrace.join("\n") << "\n"
+
+          command.run
+          expect(ui.output).to eq(expected_error_text)
+        end
+      end
+
+    end
+
+  end
+end