chef-dk 0.5.0.rc.1 → 0.5.0

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

@@ -17,6 +17,7 @@
 
 require 'ffi_yajl'
 
+require 'chef-dk/helpers'
 require 'chef-dk/service_exceptions'
 require 'chef-dk/policyfile_compiler'
 require 'chef-dk/policyfile/storage_config'

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

@@ -0,0 +1,104 @@
+#
+# Copyright:: Copyright (c) 2015 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'
+require 'chef-dk/policyfile/storage_config'
+require 'chef-dk/service_exceptions'
+require 'chef-dk/policyfile_compiler'
+
+module ChefDK
+  module PolicyfileServices
+
+    class UpdateAttributes
+
+      include Policyfile::StorageConfigDelegation
+      include ChefDK::Helpers
+
+      attr_reader :ui
+      attr_reader :storage_config
+
+      def initialize(policyfile: nil, ui: nil, root_dir: nil)
+        @ui = ui
+
+        policyfile_rel_path = policyfile || "Policyfile.rb"
+        policyfile_full_path = File.expand_path(policyfile_rel_path, root_dir)
+        @storage_config = Policyfile::StorageConfig.new.use_policyfile(policyfile_full_path)
+        @updated = false
+      end
+
+      def run
+        assert_policy_and_lock_present!
+
+        if policyfile_compiler.default_attributes != policyfile_lock.default_attributes
+          policyfile_lock.default_attributes = policyfile_compiler.default_attributes
+          @updated = true
+        end
+
+        if policyfile_compiler.override_attributes != policyfile_lock.override_attributes
+          policyfile_lock.override_attributes = policyfile_compiler.override_attributes
+          @updated = true
+        end
+
+        if updated_lock?
+          with_file(policyfile_lock_expanded_path) do |f|
+            f.print(FFI_Yajl::Encoder.encode(policyfile_lock.to_lock, pretty: true ))
+          end
+          ui.msg("Updated attributes in #{policyfile_lock_expanded_path}")
+        else
+          ui.msg("Attributes already up to date")
+        end
+      rescue => error
+        raise PolicyfileUpdateError.new("Failed to update Policyfile lock", error)
+      end
+
+      def updated_lock?
+        @updated
+      end
+
+      def policyfile_content
+        @policyfile_content ||= IO.read(policyfile_expanded_path)
+      end
+
+      def policyfile_compiler
+        @policyfile_compiler ||= ChefDK::PolicyfileCompiler.evaluate(policyfile_content, policyfile_expanded_path, ui: ui)
+      end
+
+      def policyfile_lock_content
+        @policyfile_lock_content ||= IO.read(policyfile_lock_expanded_path)
+      end
+
+      def policyfile_lock
+        @policyfile_lock ||= begin
+          lock_data = FFI_Yajl::Parser.new.parse(policyfile_lock_content)
+          PolicyfileLock.new(storage_config, ui: ui).build_from_lock_data(lock_data)
+        end
+      end
+
+
+      def assert_policy_and_lock_present!
+        unless File.exist?(policyfile_expanded_path)
+          raise PolicyfileNotFound, "Policyfile not found at path #{policyfile_expanded_path}"
+        end
+        unless File.exist?(policyfile_lock_expanded_path)
+          raise LockfileNotFound, "Policyfile lock not found at path #{policyfile_lock_expanded_path}"
+        end
+      end
+
+    end
+  end
+end
+

data/lib/chef-dk/service_exceptions.rb

@@ -36,6 +36,12 @@ module ChefDK
   class LockfileNotFound < PolicyfileServiceError
   end
 
+  class MalformedLockfile < PolicyfileServiceError
+  end
+
+  class GitError < PolicyfileServiceError
+  end
+
   class ExportDirNotEmpty < PolicyfileServiceError
   end
 
@@ -70,9 +76,15 @@ module ChefDK
 
   end
 
+  class PolicyfileDownloadError < PolicyfileNestedException
+  end
+
   class PolicyfileInstallError < PolicyfileNestedException
   end
 
+  class PolicyfileUpdateError < PolicyfileNestedException
+  end
+
   class PolicyfilePushError < PolicyfileNestedException
   end
 

data/lib/chef-dk/ui.rb

@@ -24,6 +24,10 @@ module ChefDK
         nil
       end
 
+      def print(*anything)
+        nil
+      end
+
     end
 
     def self.null
@@ -45,6 +49,10 @@ module ChefDK
     def msg(message)
       @out_stream.puts(message)
     end
+
+    def print(message)
+      @out_stream.print(message)
+    end
   end
 end
 

data/lib/chef-dk/version.rb

@@ -16,5 +16,5 @@
 #
 
 module ChefDK
-  VERSION = "0.5.0.rc.1"
+  VERSION = "0.5.0"
 end

data/spec/spec_helper.rb

@@ -23,6 +23,8 @@ require 'test_helpers'
 require 'chef/workstation_config_loader'
 
 RSpec.configure do |c|
+  running_on_windows = (RUBY_PLATFORM =~ /mswin|mingw|windows/)
+
   c.include ChefDK
   c.include TestHelpers
 
@@ -35,8 +37,12 @@ RSpec.configure do |c|
 
   c.filter_run :focus => true
   c.run_all_when_everything_filtered = true
+  # Tests that randomly fail, but may have value.
+  c.filter_run_excluding :volatile => true
+  c.filter_run_excluding :skip_on_windows => true if running_on_windows
 
   c.mock_with(:rspec) do |mocks|
     mocks.verify_partial_doubles = true
   end
+
 end

data/spec/test_helpers.rb

@@ -73,6 +73,10 @@ module TestHelpers
       @output_stream.puts(message)
     end
 
+    def print(message)
+      @output_stream.print(message)
+    end
+
     def output
       @output_stream.string
     end

data/spec/unit/command/diff_spec.rb

@@ -0,0 +1,283 @@
+#
+# Copyright:: Copyright (c) 2015 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 'shared/command_with_ui_object'
+require 'chef-dk/command/diff'
+
+describe ChefDK::Command::Diff do
+
+  it_behaves_like "a command with a UI object"
+
+  let(:params) { [] }
+
+  let(:command) do
+    described_class.new
+  end
+
+  let(:chef_config_loader) { instance_double("Chef::WorkstationConfigLoader") }
+
+  let(:chef_config) { double("Chef::Config") }
+
+  let(:config_arg) { nil }
+
+  before do
+    stub_const("Chef::Config", chef_config)
+    allow(Chef::WorkstationConfigLoader).to receive(:new).with(config_arg).and_return(chef_config_loader)
+  end
+
+  describe "selecting comparison bases" do
+
+    let(:ui) { TestHelpers::TestUI.new }
+
+    let(:http_client) { instance_double("ChefDK::AuthenticatedHTTP") }
+
+    let(:differ) { instance_double("ChefDK::Policyfile::Differ", run_report: nil) }
+
+    let(:pager) { instance_double("ChefDK::Pager", ui: ui) }
+
+    before do
+      allow(ChefDK::Pager).to receive(:new).and_return(pager)
+      allow(pager).to receive(:with_pager).and_yield(pager)
+      allow(command).to receive(:materialize_locks).and_return(nil)
+      allow(command).to receive(:differ).and_return(differ)
+      allow(command).to receive(:http_client).and_return(http_client)
+      command.ui = ui
+    end
+
+    context "when no base is given" do
+
+      it "prints an error message and exits" do
+        expect(command.run(params)).to eq(1)
+        expect(ui.output).to include("No comparison specified")
+      end
+
+    end
+
+    context "when server and git comparison bases are mixed" do
+
+      let(:params) { %w{ --git gitref policygroup } }
+
+      it "prints an error message and exits" do
+        expect(command.run(params)).to eq(1)
+        expect(ui.output).to include("Conflicting arguments and options: git and Policy Group comparisons cannot be mixed")
+      end
+
+    end
+
+    context "when specific git comparison bases are mixed with --head" do
+
+      let(:params) { %w{ --head --git gitref } }
+
+      it "prints an error message and exits" do
+        expect(command.run(params)).to eq(1)
+        expect(ui.output).to include("Conflicting git options: --head and --git are exclusive")
+      end
+
+    end
+
+    describe "selecting git comparison bases" do
+
+      context "when the Policyfile isn't named" do
+
+        let(:params) { %w{ --head } }
+
+        it "uses Policyfile.lock.json as the local lock" do
+          expect(command.run(params)).to eq(0)
+          expect(command.policyfile_lock_relpath).to eq("Policyfile.lock.json")
+        end
+
+      end
+
+      context "when the Policyfile is named" do
+
+        context "using the --head option" do
+
+          let(:params) { %w{ policies/OtherPolicy.rb --head } }
+
+          it "uses the corresponding lock as the local lock" do
+            expect(command.run(params)).to eq(0)
+            expect(command.policyfile_lock_relpath).to eq("policies/OtherPolicy.lock.json")
+          end
+
+        end
+
+        context "using the --git option" do
+
+          let(:params) { %w{ policies/OtherPolicy.rb --git master } }
+
+          it "uses the corresponding lock as the local lock" do
+            expect(command.run(params)).to eq(0)
+            expect(command.policyfile_lock_relpath).to eq("policies/OtherPolicy.lock.json")
+          end
+
+        end
+
+      end
+
+      context "when given a single commit-ish" do
+
+        let(:params) { %w{ --git master } }
+
+        it "compares the local lock to the commit" do
+          expect(command.run(params)).to eq(0)
+          expect(command.old_base).to be_a_kind_of(ChefDK::Policyfile::ComparisonBase::Git)
+          expect(command.old_base.ref).to eq("master")
+          expect(command.new_base).to be_a_kind_of(ChefDK::Policyfile::ComparisonBase::Local)
+          expect(command.new_base.policyfile_lock_relpath).to eq("Policyfile.lock.json")
+        end
+
+      end
+
+      context "when given two commit-ish names" do
+
+        let(:params) { %w{ --git master...dev-branch } }
+
+        it "compares the two commits" do
+          expect(command.run(params)).to eq(0)
+          expect(command.old_base).to be_a_kind_of(ChefDK::Policyfile::ComparisonBase::Git)
+          expect(command.old_base.ref).to eq("master")
+          expect(command.new_base).to be_a_kind_of(ChefDK::Policyfile::ComparisonBase::Git)
+          expect(command.new_base.ref).to eq("dev-branch")
+        end
+
+      end
+
+      context "when given too many commit-ish names" do
+
+        let(:params) { %w{ --git too...many...things } }
+
+        it "prints an error and exits" do
+          expect(command.run(params)).to eq(1)
+          expect(ui.output).to include("Unable to parse git comparison `too...many...things`. Only 2 references can be specified.")
+        end
+
+      end
+
+      context "when --head is used" do
+
+        let(:params) { %w{ --head } }
+
+        it "compares the local lock to git HEAD" do
+          expect(command.run(params)).to eq(0)
+          expect(command.old_base).to be_a_kind_of(ChefDK::Policyfile::ComparisonBase::Git)
+          expect(command.old_base.ref).to eq("HEAD")
+          expect(command.new_base).to be_a_kind_of(ChefDK::Policyfile::ComparisonBase::Local)
+          expect(command.new_base.policyfile_lock_relpath).to eq("Policyfile.lock.json")
+        end
+
+      end
+
+    end
+
+    describe "selecting policy group comparison bases" do
+
+      let(:local_lock_comparison_base) do
+        instance_double("ChefDK::Policyfile::ComparisonBase::Local")
+      end
+
+      before do
+        allow(command).to receive(:local_lock_comparison_base).and_return(local_lock_comparison_base)
+      end
+
+      context "when the local lockfile cannot be read and parsed" do
+
+        let(:params) { %w{ dev-group } }
+
+        before do
+          allow(local_lock_comparison_base).to receive(:lock).and_raise(ChefDK::LockfileNotFound)
+        end
+
+        it "prints an error and exits" do
+          expect(command.run(params)).to eq(1)
+        end
+
+      end
+
+      context "when the local lockfile can be read and parsed" do
+        before do
+          allow(local_lock_comparison_base).to receive(:lock).and_return({"name" => "example-policy"})
+          allow(command).to receive(:differ).and_return(differ)
+          command.ui = ui
+        end
+
+        context "when the Policyfile isn't named" do
+
+          let(:params) { %w{ dev-group } }
+
+          it "uses Policyfile.lock.json as the local lock" do
+            expect(command.run(params)).to eq(0)
+            expect(command.policyfile_lock_relpath).to eq("Policyfile.lock.json")
+          end
+
+        end
+
+        context "when the Policyfile is named" do
+
+          let(:params) { %w{ policies/SomePolicy.rb dev-group } }
+
+          it "uses the corresponding lock as the local lock" do
+            expect(command.run(params)).to eq(0)
+            expect(command.policyfile_lock_relpath).to eq("policies/SomePolicy.lock.json")
+          end
+
+        end
+
+        context "when given a single policy group name" do
+
+          let(:params) { %w{ dev-group } }
+
+          it "compares the policy group's lock to the local lock" do
+            expect(command.run(params)).to eq(0)
+            expect(command.old_base).to be_a_kind_of(ChefDK::Policyfile::ComparisonBase::PolicyGroup)
+            expect(command.old_base.group).to eq("dev-group")
+            expect(command.new_base).to be_a_kind_of(ChefDK::Policyfile::ComparisonBase::Local)
+            expect(command.new_base.policyfile_lock_relpath).to eq("Policyfile.lock.json")
+          end
+
+        end
+
+        context "when given two policy group names" do
+
+          let(:params) { %w{ prod-group...stage-group } }
+
+          it "compares the two locks" do
+            expect(command.run(params)).to eq(0)
+            expect(command.old_base).to be_a_kind_of(ChefDK::Policyfile::ComparisonBase::PolicyGroup)
+            expect(command.old_base.group).to eq("prod-group")
+            expect(command.new_base).to be_a_kind_of(ChefDK::Policyfile::ComparisonBase::PolicyGroup)
+            expect(command.new_base.group).to eq("stage-group")
+          end
+
+        end
+
+        context "when given too many policy group names" do
+
+          let(:params) { %w{ prod...stage...dev } }
+
+          it "prints an error and exits" do
+            expect(command.run(params)).to eq(1)
+            expect(ui.output).to include("Unable to parse policy group comparison `prod...stage...dev`. Only 2 references can be specified.")
+          end
+
+        end
+
+      end
+    end
+  end
+end
+