chef-apply 0.1.21 → 0.1.27

data/lib/chef_apply/action/converge_target.rb

@@ -40,7 +40,7 @@ module ChefApply::Action
       c = target_host.run_command(cmd_str)
       target_host.run_command!("#{delete_folder} #{remote_dir_path}")
       if c.exit_status == 0
-        ChefApply::Log.debug(c.stdout)
+        ChefApply::Log.info(c.stdout)
         notify(:success)
       elsif c.exit_status == 35
         notify(:reboot)
@@ -79,6 +79,16 @@ module ChefApply::Action
         exception_handlers << reporter
       EOM
 
+      # add the target host's log level value
+      # (we don't set a location because we want output to
+      #   go in stdout for reporting back to chef-apply)
+      log_settings = ChefApply::Config.log
+      if !log_settings.target_level.nil?
+        workstation_rb << <<~EOM
+          log_level :#{log_settings.target_level}
+        EOM
+      end
+
       # Maybe add data collector endpoint.
       dc = ChefApply::Config.data_collector
       if !dc.url.nil? && !dc.token.nil?

data/lib/chef_apply/cli.rb

@@ -35,6 +35,7 @@ require "chef_apply/target_resolver"
 require "chef_apply/telemeter"
 require "chef_apply/ui/error_printer"
 require "chef_apply/ui/terminal"
+require "chef_apply/ui/terminal/job"
 
 module ChefApply
   class CLI
@@ -130,12 +131,16 @@ module ChefApply
     end
 
     def render_cookbook_setup(arguments)
-      UI::Terminal.render_job(TS.generate_temp_cookbook.generating) do |reporter|
+      # TODO update Job so that it doesn't require prefix and host. As a data container,
+      # should these attributes even be required?
+      job = UI::Terminal::Job.new("", nil) do |reporter|
         @temp_cookbook = generate_temp_cookbook(arguments, reporter)
       end
-      UI::Terminal.render_job(TS.generate_temp_cookbook.generating) do |reporter|
+      UI::Terminal.render_job("...", job)
+      job = UI::Terminal::Job.new("", nil) do |reporter|
         @archive_file_location = generate_local_policy(reporter)
       end
+      UI::Terminal.render_job("...", job)
     end
 
     def render_converge(target_hosts)

data/lib/chef_apply/config.rb

@@ -111,6 +111,8 @@ module ChefApply
     config_context :log do
       default(:level, "warn")
       default(:location, File.join(WS_BASE_PATH, "logs/default.log"))
+      # set the log level for the target host's chef-client run
+      default(:target_level, nil)
     end
 
     config_context :cache do
@@ -128,7 +130,7 @@ module ChefApply
     end
 
     config_context :dev do
-      default(:spinner, "TTY::Spinner")
+      default(:spinner, true)
     end
 
     config_context :chef do

data/lib/chef_apply/startup.rb

@@ -34,6 +34,10 @@ module ChefApply
     end
 
     def run
+      # This component is not supported in ChefDK; an exception will be raised
+      # if running in that context.
+      verify_not_in_chefdk
+
       # Some tasks we do only once in an installation:
       first_run_tasks
 
@@ -68,6 +72,8 @@ module ChefApply
       UI::Terminal.output(T.error.bad_config_file(e.path))
     rescue ConfigPathNotProvided
       UI::Terminal.output(T.error.missing_config_path)
+    rescue UnsupportedInstallation
+      UI::Terminal.output(T.error.unsupported_installation)
     rescue Mixlib::Config::UnknownConfigOptionError => e
       # Ideally we'd update the exception in mixlib to include
       # a field with the faulty value, line number, and nested context -
@@ -89,6 +95,15 @@ module ChefApply
       UI::Terminal.init($stdout)
     end
 
+    # Verify that chef-run gem is not executing out of ChefDK by checking the
+    # runtime path of this file.
+    #
+    # NOTE: This is imperfect - someone could theoretically
+    # install chefdk to a path other than the default.
+    def verify_not_in_chefdk
+      raise UnsupportedInstallation.new if script_path =~ /chefdk/
+    end
+
     def first_run_tasks
       return if Dir.exist?(Config::WS_BASE_PATH)
       create_default_config
@@ -173,6 +188,13 @@ module ChefApply
       require "chef_apply/cli"
       ChefApply::CLI.new(@argv).run
     end
+
+    private
+
+    def script_path
+      File.expand_path File.dirname(__FILE__)
+    end
+
     class ConfigPathNotProvided < StandardError; end
     class ConfigPathInvalid < StandardError
       attr_reader :path
@@ -180,5 +202,6 @@ module ChefApply
         @path = path
       end
     end
+    class UnsupportedInstallation < StandardError; end
   end
 end

data/lib/chef_apply/target_host.rb

@@ -45,6 +45,12 @@ module ChefApply
                           sudo: opts_in[:sudo] === false ? false : true,
                           www_form_encoded_password: true,
                           key_files: opts_in[:identity_file],
+                          non_interactive: true,
+                          # Prevent long delays due to retries on auth failure.
+                          # This does reduce the number of attempts we'll make for transient conditions as well, but
+                          # train does not currently exposes these as separate controls. Ideally I'd like to see a 'retry_on_auth_failure' option.
+                          connection_retries: 2,
+                          connection_retry_sleep: 0.15,
                           logger: ChefApply::Log }
       if opts_in.has_key? :ssl
         connection_opts[:ssl] = opts_in[:ssl]

data/lib/chef_apply/text.rb

@@ -17,11 +17,20 @@
 
 require "r18n-desktop"
 require "chef_apply/text/text_wrapper"
+require "chef_apply/text/error_translation"
 
 # A very thin wrapper around R18n, the idea being that we're likely to replace r18n
 # down the road and don't want to have to change all of our commands.
 module ChefApply
   module Text
+    def self._error_table
+      # Though ther may be several translations, en.yml will be the only one with
+      # error metadata.
+      path = File.join(_translation_path, "errors", "en.yml")
+      raw_yaml = File.read(path)
+      @error_table ||= YAML.load(raw_yaml, _translation_path, symbolize_names: true)[:errors]
+    end
+
     def self._translation_path
       @translation_path ||= File.join(File.dirname(__FILE__), "..", "..", "i18n")
     end
@@ -38,8 +47,7 @@ module ChefApply
       end
     end
 
-    # We need to do this when the class is loaded to avoid breaking a bunch of behaviors for now.
+    # Load on class load to ensure our text accessor methods are available from the start.
     load
   end
-
 end

data/lib/chef_apply/text/error_translation.rb

@@ -0,0 +1,69 @@
+#
+# 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.
+#
+
+module ChefApply
+  module Text
+    class ErrorTranslation
+      ATTRIBUTES = :decorations, :header, :footer, :stack, :log
+      attr_reader :message, *ATTRIBUTES
+
+      def initialize(id, params: [])
+        # To get access to the metadata we'll go directly through the parsed yaml.
+        # Accessing via R18n is unnecessarily complicated
+        yml = Text._error_table
+
+        # We'll still use our Text mechanism for the text itself so that
+        # parameters, pluralization, etc will still work.
+        # This will raise if the key doesn't exist.
+        @message = Text.errors.send(id).text(*params)
+        options = yml[:display_defaults]
+
+        # Override any defaults if display metadata is given
+        display_opts = yml[id.to_sym][:display]
+        options = options.merge(display_opts) unless display_opts.nil?
+
+        ATTRIBUTES.each do |attribute|
+          instance_variable_set("@#{attribute}", options.delete(attribute))
+        end
+
+        if options.length > 0
+          # Anything not in ATTRIBUTES is not supported. This will also catch
+          # typos in attr names
+          raise InvalidDisplayAttributes.new(id, options)
+        end
+      end
+
+      def inspect
+        inspection = "#{self}: "
+        ATTRIBUTES.each do |attribute|
+          inspection << "#{attribute}: #{send(attribute.to_s)}; "
+        end
+        inspection << "message: #{message.gsub("\n", "\\n")}"
+        inspection
+      end
+
+      class InvalidDisplayAttributes < RuntimeError
+        attr_reader :invalid_attrs
+        def initialize(id, attrs)
+          @invalid_attrs = attrs
+          super("Invalid display attributes found for #{id}: #{attrs}")
+        end
+      end
+
+    end
+  end
+end

data/lib/chef_apply/ui/error_printer.rb

@@ -25,7 +25,8 @@ require "chef_apply/errors/standard_error_resolver"
 
 module ChefApply::UI
   class ErrorPrinter
-    attr_reader :id, :pastel, :show_log, :show_stack, :exception, :target_host
+    attr_reader :id, :pastel, :translation, :exception, :target_host
+
     # TODO define 't' as a method is a temporary workaround
     # to ensure that text key lookups are testable.
     def t
@@ -91,27 +92,22 @@ module ChefApply::UI
     def initialize(wrapper, unwrapped = nil, target_host = nil)
       @exception = unwrapped || wrapper.contained_exception
       @target_host = wrapper.target_host || target_host
+      @command = exception.respond_to?(:command) ? exception.command : nil
       @pastel = Pastel.new
-      @show_log = exception.respond_to?(:show_log) ? exception.show_log : true
-      @show_stack = exception.respond_to?(:show_stack) ? exception.show_stack : true
       @content = StringIO.new
-      @command = exception.respond_to?(:command) ? exception.command : nil
-      @id = DEFAULT_ERROR_NO
-      if exception.respond_to?(:id) && exception.id =~ /CHEF.*/
-        @id = exception.id
-      end
-      if exception.respond_to?(:decorate)
-        @decorate = exception.decorate
-      else
-        @decorate = true
-      end
+      @id = if exception.kind_of? ChefApply::Error
+              exception.id
+            else
+              DEFAULT_ERROR_NO
+            end
+      @translation = ChefApply::Text::ErrorTranslation.new(id)
     rescue => e
       ErrorPrinter.dump_unexpected_error(e)
       exit! 128
     end
 
     def format_error
-      if @decorate
+      if translation.decorations
         format_decorated
       else
         format_undecorated
@@ -153,15 +149,15 @@ module ChefApply::UI
     end
 
     def format_footer
-      if show_log
-        if show_stack
+      if translation.log
+        if translation.stack
           t.footer.both(ChefApply::Config.log.location,
                         ChefApply::Config.stack_trace_path)
         else
           t.footer.log_only(ChefApply::Config.log.location)
         end
       else
-        if show_stack
+        if translation.stack
           t.footer.stack_only
         else
           t.footer.neither
@@ -185,7 +181,7 @@ module ChefApply::UI
     def self.error_summary(e)
       if e.kind_of? ChefApply::Error
         # By convention, all of our defined messages have a short summary on the first line.
-        ChefApply::Text.errors.send(e.id, *e.params).split("\n").first
+        ChefApply::Text.errors.send(e.id).text(*e.params).split("\n").first
       elsif e.kind_of? String
         e
       else
@@ -199,20 +195,22 @@ module ChefApply::UI
 
     def format_workstation_exception
       params = exception.params
-      t.send(@id, *params)
+      t.send(@id).text(*params)
     end
 
+    # TODO this gets moved to trainerrormapper  or simply removed since
+    #     many of these issues are now handled in the RemoteTarget::ConnectionFailure
     def format_train_exception
       backend, host = formatted_host()
       if host.nil?
-        t.CHEFTRN002(exception.message)
+        t.CHEFTRN002.text(exception.message)
       else
-        t.CHEFTRN001(backend, host, exception.message)
+        t.CHEFTRN001.text(backend, host, exception.message)
       end
     end
 
     def format_other_exception
-      t.send(DEFAULT_ERROR_NO, exception.message)
+      t.send(DEFAULT_ERROR_NO).text(exception.message)
     end
 
     def formatted_host

data/lib/chef_apply/ui/plain_text_element.rb

@@ -29,7 +29,7 @@ module ChefApply
       end
 
       def update(params)
-        # SOme of this is particular to our usage -
+        # Some of this is particular to our usage -
         # prefix does not cause a text update, but does
         # change the prefix for future messages.
         if params.has_key?(:prefix)
@@ -70,6 +70,9 @@ module ChefApply
         @succ = true
         @err = false
       end
+
+      def auto_spin
+      end
     end
   end
 end

data/lib/chef_apply/ui/plain_text_header.rb

@@ -0,0 +1,46 @@
+#
+# 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 "thread"
+require "chef_apply/ui/plain_text_element"
+
+module ChefApply
+  module UI
+    class PlainTextHeader
+      def initialize(format, opts)
+        @format = format
+        @output = opts[:output]
+        @children = {}
+        @threads = []
+      end
+
+      def register(child_format, child_opts, &block)
+        child_opts[:output] = @output
+        child = PlainTextElement.new(child_format, child_opts)
+        @children[child] = block
+      end
+
+      def auto_spin
+        msg = @format.gsub(/:spinner/, " HEADER ")
+        @output.puts(msg)
+        @children.each do |child, block|
+          @threads << Thread.new { block.call(child) }
+        end
+        @threads.each { |thr| thr.join }
+      end
+    end
+  end
+end

data/lib/chef_apply/ui/terminal.rb

@@ -20,27 +20,11 @@ require "chef_apply/status_reporter"
 require "chef_apply/config"
 require "chef_apply/log"
 require "chef_apply/ui/plain_text_element"
+require "chef_apply/ui/plain_text_header"
 
 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
-
       class << self
         # To support matching in test
         attr_accessor :location
@@ -58,31 +42,30 @@ module ChefApply
         end
 
         def render_parallel_jobs(header, jobs)
-      # Do not indent the topmost 'parent' spinner, but do indent child spinners
+          # Do not indent the topmost 'parent' spinner, but do indent child spinners
           indent_style = { top: "",
                            middle: TTY::Spinner::Multi::DEFAULT_INSET[:middle],
                            bottom: TTY::Spinner::Multi::DEFAULT_INSET[:bottom] }
-      # @option options [Hash] :style
-      #   keys :top :middle and :bottom can contain Strings that are used to
-      #   indent the spinners. Ignored if message is blank
-          multispinner = TTY::Spinner::Multi.new("[:spinner] #{header}", output: @location, hide_cursor: true, style: indent_style)
-          jobs.each do |a|
-            multispinner.register(spinner_prefix(a.prefix), hide_cursor: true) do |spinner|
-              reporter = StatusReporter.new(spinner, prefix: a.prefix, key: :status)
-              a.run(reporter)
+          # @option options [Hash] :style
+          #   keys :top :middle and :bottom can contain Strings that are used to
+          #   indent the spinners. Ignored if message is blank
+          multispinner = get_multispinner.new("[:spinner] #{header}", output: @location, hide_cursor: true, style: indent_style)
+          jobs.each do |job|
+            multispinner.register(spinner_prefix(job.prefix), hide_cursor: true) do |spinner|
+              reporter = StatusReporter.new(spinner, prefix: job.prefix, key: :status)
+              job.run(reporter)
             end
           end
           multispinner.auto_spin
         end
 
-        # TODO update this to accept a job instead of a block, for consistency of usage
-        #      between render_job and render_parallel
-        def render_job(msg, prefix: "", &block)
-          klass = ChefApply::UI.const_get(ChefApply::Config.dev.spinner)
-          spinner = klass.new(spinner_prefix(prefix), output: @location, hide_cursor: true)
-          reporter = StatusReporter.new(spinner, prefix: prefix, key: :status)
-          reporter.update(msg)
-          spinner.run { yield(reporter) }
+        def render_job(initial_msg, job)
+          # TODO why do we have to pass prefix to both the spinner and the reporter?
+          spinner = get_spinner.new(spinner_prefix(job.prefix), output: @location, hide_cursor: true)
+          reporter = StatusReporter.new(spinner, prefix: job.prefix, key: :status)
+          reporter.update(initial_msg)
+          spinner.auto_spin
+          job.run(reporter)
         end
 
         def spinner_prefix(prefix)
@@ -90,6 +73,14 @@ module ChefApply
           spinner_msg += ":prefix " unless prefix.empty?
           spinner_msg + ":status"
         end
+
+        def get_multispinner
+          ChefApply::Config.dev.spinner ? TTY::Spinner::Multi : PlainTextHeader
+        end
+
+        def get_spinner
+          ChefApply::Config.dev.spinner ? TTY::Spinner : PlainTextElement
+        end
       end
     end
   end