chef-apply 0.1.17 → 0.1.18

data/spec/unit/ui/error_printer_spec.rb

@@ -0,0 +1,173 @@
+#
+# Copyright:: Copyright (c) 2018 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_apply/ui/error_printer"
+require "chef_apply/errors/standard_error_resolver"
+require "chef_apply/target_host"
+
+RSpec.describe ChefApply::UI::ErrorPrinter do
+  let(:orig_exception) { StandardError.new("test") }
+  let(:target_host) { ChefApply::TargetHost.instance_for_url("mock://localhost") }
+  let(:wrapped_exception) { ChefApply::WrappedError.new(orig_exception, target_host) }
+  subject(:printer) { ChefApply::UI::ErrorPrinter.new(wrapped_exception, nil) }
+
+  context "#format_error" do
+    it "formats the message" do
+      expect(subject).to receive(:format_header).and_return "header"
+      expect(subject).to receive(:format_body).and_return "body"
+      expect(subject).to receive(:format_footer).and_return "footer"
+      expect(subject.format_error).to eq "\nheader\n\nbody\nfooter\n"
+    end
+  end
+
+  context "#format_body" do
+    RC = ChefApply::TargetHost
+    context "when exception is a ChefApply::Error" do
+      let(:result) { RemoteExecResult.new(1, "", "failed") }
+      let(:orig_exception) { RC::RemoteExecutionFailed.new("localhost", "test", result) }
+      it "invokes the right handler" do
+        expect(subject).to receive(:format_workstation_exception)
+        subject.format_body
+      end
+    end
+
+    context "when exception is a Train::Error" do
+      # These may expand as we find error-specific messaging we can provide to customers
+      # for more specific train exceptions
+      let(:orig_exception) { Train::Error.new("test") }
+      it "invokes the right handler" do
+        expect(subject).to receive(:format_train_exception)
+        subject.format_body
+      end
+    end
+
+    context "when exception is something else" do
+      # These may expand as we find error-specific messaging we can provide to customers
+      # for more specific general exceptions
+      it "invokes the right handler" do
+        expect(subject).to receive(:format_other_exception)
+        subject.format_body
+      end
+    end
+  end
+
+  context ".show_error" do
+    subject { ChefApply::UI::ErrorPrinter }
+    context "when handling a MultiJobFailure" do
+      it "recognizes it and invokes capture_multiple_failures" do
+        underlying_error = ChefApply::MultiJobFailure.new([])
+        error_to_process = ChefApply::Errors::StandardErrorResolver.wrap_exception(underlying_error)
+        expect(subject).to receive(:capture_multiple_failures).with(underlying_error)
+        subject.show_error(error_to_process)
+
+      end
+    end
+
+    context "when an error occurs in error handling" do
+      it "processes the new failure with dump_unexpected_error" do
+        error_to_raise = StandardError.new("this will be raised")
+        error_to_process = ChefApply::Errors::StandardErrorResolver.wrap_exception(StandardError.new("this is being shown"))
+        # Intercept a known call to raise an error
+        expect(ChefApply::UI::Terminal).to receive(:output).and_raise error_to_raise
+        expect(subject).to receive(:dump_unexpected_error).with(error_to_raise)
+        subject.show_error(error_to_process)
+      end
+    end
+
+  end
+
+  context ".capture_multiple_failures" do
+    subject { ChefApply::UI::ErrorPrinter }
+    let(:file_content_capture) { StringIO.new }
+    before do
+      allow(ChefApply::Config).to receive(:error_output_path).and_return "/dev/null"
+      allow(File).to receive(:open).with("/dev/null", "w").and_yield(file_content_capture)
+    end
+
+    it "should write a properly formatted error file" do
+      # TODO - add support for test-only i18n content, so that we don't have
+      #        to rely on specific known error IDs that may change or be removed,
+      #        and arent' directly relevant to the test at hand.
+      job1 = double("Job", target_host: double("TargetHost", hostname: "host1"),
+                           exception: ChefApply::Error.new("CHEFUPL005"))
+      job2 = double("Job", target_host: double("TargetHost", hostname: "host2"),
+                           exception: StandardError.new("Hello World"))
+
+      expected_content = File.read("spec/unit/fixtures/multi-error.out")
+      multifailure = ChefApply::MultiJobFailure.new([job1, job2] )
+      subject.capture_multiple_failures(multifailure)
+      expect(file_content_capture.string).to eq expected_content
+    end
+  end
+
+  context "#format_footer" do
+    let(:show_log) { true }
+    let(:show_stack) { true }
+    let(:formatter) do
+      ChefApply::UI::ErrorPrinter.new(wrapped_exception, nil)
+    end
+
+    subject(:format_footer) do
+      lambda { formatter.format_footer }
+    end
+
+    before do
+      allow(formatter).to receive(:show_log).and_return show_log
+      allow(formatter).to receive(:show_stack).and_return show_stack
+    end
+
+    context "when both log and stack wanted" do
+      let(:show_log) { true }
+      let(:show_stack) { true }
+      assert_string_lookup("errors.footer.both")
+    end
+
+    context "when only log is wanted" do
+      let(:show_log) { true }
+      let(:show_stack) { false }
+      assert_string_lookup("errors.footer.log_only")
+    end
+
+    context "when only stack is wanted" do
+      let(:show_log) { false }
+      let(:show_stack) { true }
+      assert_string_lookup("errors.footer.stack_only")
+    end
+
+    context "when neither log nor stack wanted" do
+      let(:show_log) { false }
+      let(:show_stack) { false }
+      assert_string_lookup("errors.footer.neither")
+    end
+  end
+
+  context ".write_backtrace" do
+    let(:inst) { double(ChefApply::UI::ErrorPrinter) }
+    before do
+      allow(ChefApply::UI::ErrorPrinter).to receive(:new).and_return inst
+    end
+
+    let(:orig_args) { %w{test} }
+    it "formats and saves the backtrace" do
+      expect(inst).to receive(:add_backtrace_header).with(anything(), orig_args)
+      expect(inst).to receive(:add_formatted_backtrace)
+      expect(inst).to receive(:save_backtrace)
+      ChefApply::UI::ErrorPrinter.write_backtrace(wrapped_exception, orig_args)
+    end
+  end
+end

data/spec/unit/ui/terminal_spec.rb

@@ -0,0 +1,109 @@
+#
+# Copyright:: Copyright (c) 2018 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_apply/ui/terminal"
+
+RSpec.describe ChefApply::UI::Terminal do
+  Terminal = ChefApply::UI::Terminal
+  # Lets send our Terminal output somewhere so it does not clutter the
+  # test output
+  Terminal.location = StringIO.new
+
+  it "correctly outputs a message" do
+    expect { Terminal.output("test") }
+      .to output("test\n").to_terminal
+  end
+
+  context "#render_job" do
+    it "executes the provided block" do
+      @ran = false
+      Terminal.render_job("a message") { |reporter| @ran = true }
+      expect(@ran).to eq true
+    end
+  end
+
+  context "#render_parallel_jobs" do
+    it "executes the provided job instances" do
+      @job1ran = false
+      @job2ran = false
+      job1 = Terminal::Job.new("prefix", nil) do
+        @job1ran = true
+      end
+      job2 = Terminal::Job.new("prefix", nil) do
+        @job2ran = true
+      end
+      Terminal.render_parallel_jobs("a message", [job1, job2])
+      expect(@job1ran).to eq true
+      expect(@job2ran).to eq true
+    end
+  end
+
+  describe ChefApply::UI::Terminal::Job do
+    subject { ChefApply::UI::Terminal::Job }
+    context "#exception" do
+      context "when no exception occurs in execution" do
+        context "and it's been invoked directly" do
+          it "exception is nil" do
+            job = subject.new("", nil) { 0 }
+            job.run(ChefApply::MockReporter.new)
+            expect(job.exception).to eq nil
+          end
+        end
+        context "and it's running in a thread alongside other jobs" do
+          it "exception is nil for each job" do
+            job1 = subject.new("", nil) { 0 }
+            job2 = subject.new("", nil) { 0 }
+            threads = []
+            threads << Thread.new { job1.run(ChefApply::MockReporter.new) }
+            threads << Thread.new { job2.run(ChefApply::MockReporter.new) }
+            threads.each(&:join)
+            expect(job1.exception).to eq nil
+            expect(job2.exception).to eq nil
+
+          end
+        end
+      end
+      context "when an exception occurs in execution" do
+        context "and it's been invoked directly" do
+          it "captures the exception in #exception" do
+            expected_exception = StandardError.new("exception 1")
+            job = subject.new("", nil) { |arg| raise expected_exception }
+            job.run(ChefApply::MockReporter.new)
+            expect(job.exception).to eq expected_exception
+          end
+        end
+
+        context "and it's running in a thread alongside other jobs" do
+          it "each job holds its own exception" do
+            e1 = StandardError.new("exception 1")
+            e2 = StandardError.new("exception 2")
+
+            job1 = subject.new("", nil) { |_| raise e1 }
+            job2 = subject.new("", nil) { |_| raise e2 }
+            threads = []
+            threads << Thread.new { job1.run(ChefApply::MockReporter.new) }
+            threads << Thread.new { job2.run(ChefApply::MockReporter.new) }
+            threads.each(&:join)
+            expect(job1.exception).to eq e1
+            expect(job2.exception).to eq e2
+          end
+        end
+      end
+    end
+  end
+end

data/spec/unit/version_spec.rb

@@ -0,0 +1,31 @@
+#
+# Copyright:: Copyright (c) 2018 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_apply/version"
+
+RSpec.describe ChefApply::VERSION do
+  subject(:version) do
+    ChefApply::VERSION
+  end
+
+  context "VERSION" do
+    it "returns the version" do
+      expect(Gem::Version.correct?(version)).to be_truthy
+    end
+  end
+end

data/warning.txt

@@ -0,0 +1,3 @@
+Chef Apply is not meant to be installed as a gem. It is meant to be installed
+as part of the Chef Workstation omnibus package. Please download and install
+that from https://downloads.chef.io/chef-dk/

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-apply
 version: !ruby/object:Gem::Version
-  version: 0.1.17
+  version: 0.1.18
 platform: ruby
 authors:
 - Chef Software, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-30 00:00:00.000000000 Z
+date: 2018-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-cli
@@ -356,6 +356,38 @@ files:
 - lib/chef_apply/ui/plain_text_element.rb
 - lib/chef_apply/ui/terminal.rb
 - lib/chef_apply/version.rb
+- spec/fixtures/custom_config.toml
+- spec/integration/chef-run_spec.rb
+- spec/integration/fixtures/chef_help.out
+- spec/integration/fixtures/chef_version.out
+- spec/integration/spec_helper.rb
+- spec/spec_helper.rb
+- spec/support/matchers/output_to_terminal.rb
+- spec/unit/action/base_spec.rb
+- spec/unit/action/converge_target_spec.rb
+- spec/unit/action/generate_local_policy_spec.rb
+- spec/unit/action/generate_temp_cookbook_spec.rb
+- spec/unit/action/install_chef/base_spec.rb
+- spec/unit/action/install_chef_spec.rb
+- spec/unit/cli/options_spec.rb
+- spec/unit/cli/validation_spec.rb
+- spec/unit/cli_spec.rb
+- spec/unit/config_spec.rb
+- spec/unit/errors/ccr_failure_mapper_spec.rb
+- spec/unit/file_fetcher_spec.rb
+- spec/unit/fixtures/multi-error.out
+- spec/unit/log_spec.rb
+- spec/unit/recipe_lookup_spec.rb
+- spec/unit/startup_spec.rb
+- spec/unit/target_host_spec.rb
+- spec/unit/target_resolver_spec.rb
+- spec/unit/telemeter/sender_spec.rb
+- spec/unit/telemeter_spec.rb
+- spec/unit/temp_cookbook_spec.rb
+- spec/unit/ui/error_printer_spec.rb
+- spec/unit/ui/terminal_spec.rb
+- spec/unit/version_spec.rb
+- warning.txt
 homepage: https://github.com/chef/chef-apply
 licenses:
 - Apache-2.0