chef-apply 0.1.21 → 0.1.27

data/lib/chef_apply/ui/terminal/job.rb

@@ -0,0 +1,39 @@
+#
+# 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.
+#
+
+module ChefApply
+  module UI
+    class Terminal
+      class Job
+        attr_reader :proc, :prefix, :target_host, :exception
+        def initialize(prefix, target_host, &block)
+          @proc = block
+          @prefix = prefix
+          @target_host = target_host
+          @error = nil
+        end
+
+        def run(reporter)
+          @proc.call(reporter)
+        rescue => e
+          reporter.error(e.to_s)
+          @exception = e
+        end
+      end
+    end
+  end
+end

data/lib/chef_apply/version.rb

@@ -16,5 +16,5 @@
 #
 
 module ChefApply
-  VERSION = "0.1.21"
+  VERSION = "0.1.27"
 end

data/spec/unit/action/converge_target_spec.rb

@@ -75,6 +75,58 @@ RSpec.describe ChefApply::Action::ConvergeTarget do
       expect(local_tempfile.closed?).to eq(true)
     end
 
+    describe "when target_level is left default" do
+      before do
+        ChefApply::Config.reset
+      end
+      it "creates a config file without a specific log_level (leaving default for chef-client)" do
+        expect(Tempfile).to receive(:new).and_return(local_tempfile)
+        expect(local_tempfile).to receive(:write).with(<<~EOM
+          local_mode true
+          color false
+          cache_path "\#{ENV['APPDATA']}/chef-workstation"
+          chef_repo_path "\#{ENV['APPDATA']}/chef-workstation"
+          require_relative "reporter"
+          reporter = ChefApply::Reporter.new
+          report_handlers << reporter
+          exception_handlers << reporter
+        EOM
+        )
+        expect(target_host).to receive(:upload_file).with(local_tempfile.path, remote_config)
+        expect(subject.create_remote_config(remote_folder)).to eq(remote_config)
+        expect(local_tempfile.closed?).to eq(true)
+      end
+    end
+
+    describe "when target_level is set to a value" do
+      before do
+        ChefApply::Config.log.target_level = "info"
+      end
+
+      after do
+        ChefApply::Config.reset
+      end
+
+      it "creates a config file with the log_level set to the right value" do
+        expect(Tempfile).to receive(:new).and_return(local_tempfile)
+        expect(local_tempfile).to receive(:write).with(<<~EOM
+          local_mode true
+          color false
+          cache_path "\#{ENV['APPDATA']}/chef-workstation"
+          chef_repo_path "\#{ENV['APPDATA']}/chef-workstation"
+          require_relative "reporter"
+          reporter = ChefApply::Reporter.new
+          report_handlers << reporter
+          exception_handlers << reporter
+          log_level :info
+        EOM
+        )
+        expect(target_host).to receive(:upload_file).with(local_tempfile.path, remote_config)
+        expect(subject.create_remote_config(remote_folder)).to eq(remote_config)
+        expect(local_tempfile.closed?).to eq(true)
+      end
+    end
+
     describe "when data_collector is set in config" do
       before do
         ChefApply::Config.data_collector.url = "dc.url"

data/spec/unit/cli_spec.rb

@@ -293,13 +293,19 @@ RSpec.describe ChefApply::CLI do
     let(:temp_cookbook) { double(ChefApply::TempCookbook) }
     let(:archive_file_location) { "/path/to/archive" }
     let(:args) { [] }
-    before do
-      allow(ChefApply::UI::Terminal).to receive(:render_job).and_yield(reporter)
-    end
+    # before do
+    #   allow(ChefApply::UI::Terminal).to receive(:render_job).and_yield(reporter)
+    # end
 
     it "generates the cookbook and local policy" do
+      expect(ChefApply::UI::Terminal).to receive(:render_job) do |initial_msg, job|
+        job.run(reporter)
+      end
       expect(subject).to receive(:generate_temp_cookbook)
         .with(args, reporter).and_return temp_cookbook
+      expect(ChefApply::UI::Terminal).to receive(:render_job) do |initial_msg, job|
+        job.run(reporter)
+      end
       expect(subject).to receive(:generate_local_policy)
         .with(reporter).and_return archive_file_location
       subject.render_cookbook_setup(args)

data/spec/unit/startup_spec.rb

@@ -25,7 +25,8 @@ RSpec.describe ChefApply::Startup do
 
   describe "#run" do
     it "performs ordered startup tasks and invokes the CLI" do
-      ordered_messages = [:first_run_tasks,
+      ordered_messages = [:verify_not_in_chefdk,
+                          :first_run_tasks,
                           :setup_workstation_user_directories,
                           :setup_error_handling,
                           :load_config,
@@ -37,6 +38,7 @@ RSpec.describe ChefApply::Startup do
       end
       subject.run()
     end
+
     context "when errors happen" do
       let(:error) { nil }
       let(:error_text) { ChefApply::Text.cli.error }
@@ -90,6 +92,16 @@ RSpec.describe ChefApply::Startup do
         end
       end
 
+      context "when a UnsupportedInstallation exception is raised" do
+        let(:error) { ChefApply::Startup::UnsupportedInstallation.new }
+
+        it "shows the correct error" do
+          expected_text = error_text.unsupported_installation
+          expect(ChefApply::UI::Terminal).to receive(:output).with(expected_text)
+          subject.run
+        end
+      end
+
       context "when a Tomlrb::ParserError is raised" do
         let(:msg) { "Parse failed." }
         let(:error) { Tomlrb::ParseError.new(msg) }
@@ -102,12 +114,40 @@ RSpec.describe ChefApply::Startup do
       end
     end
   end
+
   describe "#init_terminal" do
     it "initializees the terminal for stdout" do
       expect(ChefApply::UI::Terminal).to receive(:init).with($stdout)
       subject.init_terminal
     end
   end
+
+  describe "#verify_not_in_chefdk" do
+    before do
+      allow(subject).to receive(:script_path).and_return script_path
+    end
+
+    context "when chef-run has been loaded from a *nix chefdk path" do
+      let(:script_path) { "/opt/chefdk/embedded/lib/ruby/gems/2.5.0/gems/chef-apply/startup.rb" }
+      it "raises an UnsupportedInstallation error" do
+        expect { subject.verify_not_in_chefdk }.to raise_error(ChefApply::Startup::UnsupportedInstallation)
+      end
+    end
+    context "when chef-run has been loaded from a Windows chefdk path" do
+      let(:script_path) { "C:\\chefdk\\embedded\\lib\\ruby\\gems\\2.5.0\\gems\\chef-apply\\startup.rb" }
+      it "raises an UnsupportedInstallation error" do
+        expect { subject.verify_not_in_chefdk }.to raise_error(ChefApply::Startup::UnsupportedInstallation)
+      end
+    end
+
+    context "when chef-run has been loaded from anywhere else" do
+      let(:script_path) { "/home/user1/dev/chef-apply" }
+      it "runs without error" do
+        subject.verify_not_in_chefdk
+      end
+    end
+  end
+
   describe "#first_run_tasks" do
     let(:first_run_complete) { true }
     before do
@@ -122,6 +162,7 @@ RSpec.describe ChefApply::Startup do
         subject.first_run_tasks
       end
     end
+
     context "when first run has not already occurred" do
       let(:first_run_complete) { false }
       it "Performs required first-run tasks" do

data/spec/unit/text/error_translation_spec.rb

@@ -0,0 +1,105 @@
+#
+# Copyright:: Copyright (c) 2017 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/text"
+
+RSpec.describe ChefApply::Text::ErrorTranslation do
+
+  let(:display_defaults) do
+    {
+    decorations: true,
+    header: true,
+    footer: true,
+    stack: false,
+    log: false }
+  end
+
+  let(:error_table) do
+    { display_defaults: display_defaults,
+      TESTERROR: test_error } end
+
+  let(:test_error_text) { "This is a test error" }
+  let(:test_error) { {} }
+
+  subject { ChefApply::Text::ErrorTranslation }
+  let(:error_mock) do
+    double("R18n::Translated",
+                            text: test_error_text ) end
+  let(:translation_mock) do
+    double("R18n::Translated",
+                                 TESTERROR: error_mock,
+                                 text: test_error_text ) end
+  before do
+    # Mock out the R18n portion - our methods care only that the key exists, and
+    # the test focus is on the display metadata.
+    allow(ChefApply::Text).to receive(:errors).and_return translation_mock
+    allow(ChefApply::Text).to receive(:_error_table).and_return(error_table)
+  end
+
+  context "when some display attributes are specified" do
+    let(:test_error) { { display: { stack: true, log: true } } }
+    it "sets display attributes to specified values and defaults remaining" do
+      translation = subject.new("TESTERROR")
+      expect(translation.decorations).to be true
+      expect(translation.header).to be true
+      expect(translation.footer).to be true
+      expect(translation.stack).to be true
+      expect(translation.log).to be true
+      expect(translation.message).to eq test_error_text
+    end
+  end
+
+  context "when all display attributes are specified" do
+    let(:test_error) do
+      { display: { decorations: false, header: false,
+                   footer: false, stack: true, log: true } } end
+    it "sets display attributes to specified values with no defaults" do
+      translation = subject.new("TESTERROR")
+      expect(translation.decorations).to be false
+      expect(translation.header).to be false
+      expect(translation.footer).to be false
+      expect(translation.stack).to be true
+      expect(translation.log).to be true
+      expect(translation.message).to eq test_error_text
+    end
+  end
+
+  context "when no attributes for an error are specified" do
+    let(:test_error) { {} }
+    it "sets display attribute to default values and references the correct message" do
+      translation = subject.new("TESTERROR")
+      expect(translation.decorations).to be true
+      expect(translation.header).to be true
+      expect(translation.footer).to be true
+      expect(translation.stack).to be false
+      expect(translation.log).to be false
+      expect(translation.message).to eq test_error_text
+    end
+  end
+
+  context "when invalid attributes for an error are specified" do
+    let(:test_error) { { display: { bad_value: true } } }
+    it "raises InvalidDisplayAttributes when invalid attributes are specified" do
+      expect { subject.new("TESTERROR") }
+        .to raise_error(ChefApply::Text::ErrorTranslation::InvalidDisplayAttributes) do |e|
+        expect(e.invalid_attrs).to eq({ bad_value: true })
+      end
+
+    end
+  end
+end

data/spec/unit/ui/error_printer_spec.rb

@@ -17,21 +17,52 @@
 
 require "spec_helper"
 require "chef_apply/ui/error_printer"
+require "chef_apply/text/error_translation"
 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) }
+
+  let(:show_footer) { true }
+  let(:show_log) { true }
+  let(:show_stack) { true }
+  let(:has_decorations) { true }
+  let(:show_header) { true }
+  let(:translation_mock) do
+    instance_double("ChefApply::Errors::ErrorTranslation",
+                    footer: show_footer,
+                    log: show_log,
+                    stack: show_stack,
+                    header: show_header,
+                    decorations: has_decorations
+                   )
+  end
+  subject { ChefApply::UI::ErrorPrinter.new(wrapped_exception, nil) }
+
+  before do
+    allow(ChefApply::Text::ErrorTranslation).to receive(:new).and_return translation_mock
+  end
 
   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"
+
+    context "and the message has decorations" do
+      let(:has_decorations)  { true }
+      it "formats the message using the correct method" do
+        expect(subject).to receive(:format_decorated).and_return "decorated"
+        subject.format_error
+      end
+    end
+
+    context "and the message does not have decorations" do
+      let(:has_decorations)  { false }
+      it "formats the message using the correct method" do
+        expect(subject).to receive(:format_undecorated).and_return "undecorated"
+        subject.format_error
+      end
     end
   end
 
@@ -116,21 +147,14 @@ RSpec.describe ChefApply::UI::ErrorPrinter do
   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
+    subject 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 }

data/spec/unit/ui/terminal_spec.rb

@@ -32,7 +32,10 @@ RSpec.describe ChefApply::UI::Terminal do
   context "#render_job" do
     it "executes the provided block" do
       @ran = false
-      Terminal.render_job("a message") { |reporter| @ran = true }
+      job = Terminal::Job.new("prefix", nil) do
+        @ran = true
+      end
+      Terminal.render_job("a message", job)
       expect(@ran).to eq true
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-apply
 version: !ruby/object:Gem::Version
-  version: 0.1.21
+  version: 0.1.27
 platform: ruby
 authors:
 - Chef Software, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-09 00:00:00.000000000 Z
+date: 2018-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-cli
@@ -352,10 +352,13 @@ files:
 - lib/chef_apply/telemeter/sender.rb
 - lib/chef_apply/temp_cookbook.rb
 - lib/chef_apply/text.rb
+- lib/chef_apply/text/error_translation.rb
 - lib/chef_apply/text/text_wrapper.rb
 - lib/chef_apply/ui/error_printer.rb
 - lib/chef_apply/ui/plain_text_element.rb
+- lib/chef_apply/ui/plain_text_header.rb
 - lib/chef_apply/ui/terminal.rb
+- lib/chef_apply/ui/terminal/job.rb
 - lib/chef_apply/version.rb
 - spec/fixtures/custom_config.toml
 - spec/integration/chef-run_spec.rb
@@ -386,6 +389,7 @@ files:
 - spec/unit/telemeter/sender_spec.rb
 - spec/unit/telemeter_spec.rb
 - spec/unit/temp_cookbook_spec.rb
+- spec/unit/text/error_translation_spec.rb
 - spec/unit/ui/error_printer_spec.rb
 - spec/unit/ui/terminal_spec.rb
 - spec/unit/version_spec.rb