chef-apply 0.3.3 → 0.4.6

data/lib/chef_apply/startup.rb

@@ -106,6 +106,7 @@ module ChefApply
 
     def first_run_tasks
       return if Dir.exist?(Config::WS_BASE_PATH)
+
       create_default_config
       setup_telemetry
     end
@@ -129,7 +130,7 @@ module ChefApply
     end
 
     def start_telemeter_upload
-      ChefApply::Telemeter::Sender.start_upload_thread()
+      ChefApply::Telemeter::Sender.start_upload_thread
     end
 
     def setup_workstation_user_directories
@@ -167,6 +168,7 @@ module ChefApply
           next_arg = argv[index + 1]
           raise ConfigPathNotProvided.new if next_arg.nil?
           raise ConfigPathInvalid.new(next_arg) unless File.file?(next_arg) && File.readable?(next_arg)
+
           return next_arg
         end
       end
@@ -178,9 +180,10 @@ module ChefApply
       ChefApply::Log.info("Initialized logger")
 
       ChefConfig.logger = ChefApply::Log
-      # Setting the config isn't enough, we need to ensure the logger is initialized
-      # or automatic initialization will still go to stdout
-      Chef::Log.init(ChefApply::Log.location)
+      # Setting the config isn't enough, we need to ensure the logger is
+      # initialized with our existing stream or automatic initialization
+      # will still go to stdout instead of the log file we opened.
+      Chef::Log.init(ChefApply::Log.stream)
       Chef::Log.level = ChefApply::Log.level
     end
 

data/lib/chef_apply/target_host.rb

@@ -25,7 +25,7 @@ module ChefApply
     # These values may exist in .ssh/config but will be ignored by train
     # in favor of its defaults unless we specify them explicitly.
     # See #apply_ssh_config
-    SSH_CONFIG_OVERRIDE_KEYS = [:user, :port, :proxy].freeze
+    SSH_CONFIG_OVERRIDE_KEYS = %i{user port proxy}.freeze
 
     # We're borrowing a page from train here - because setting up a
     # reliable connection for testing is a multi-step process,
@@ -34,7 +34,7 @@ module ChefApply
     # OS, this instance will mix-in the supporting methods for the given platform;
     # otherwise those methods will raise NotImplementedError.
     def self.mock_instance(url, family: "unknown", name: "unknown",
-                                release: "unknown", arch: "x86_64")
+      release: "unknown", arch: "x86_64")
       # Specifying sudo: false ensures that attempted operations
       # don't fail because the mock platform doesn't support sudo
       target_host = TargetHost.new(url, { sudo: false })
@@ -87,7 +87,7 @@ module ChefApply
         connection_opts[:self_signed] = (opts_in[:ssl_verify] === false ? true : false)
       end
 
-      [:sudo_password, :sudo, :sudo_command, :password, :user].each do |key|
+      %i{sudo_password sudo sudo_command password user}.each do |key|
         connection_opts[key] = opts_in[key] if opts_in.key? key
       end
 
@@ -114,6 +114,7 @@ module ChefApply
     def connect!
       # Keep existing connections
       return unless @backend.nil?
+
       @backend = train_connection.connection
       @backend.wait_until_ready
 
@@ -146,6 +147,7 @@ module ChefApply
     # Returns the user being used to connect. Defaults to train's default user if not specified
     def user
       return config[:user] unless config[:user].nil?
+
       require "train/transports/ssh"
       Train::Transports::SSH.default_options[:user][:default]
     end
@@ -182,6 +184,7 @@ module ChefApply
       if result.exit_status != 0
         raise RemoteExecutionFailed.new(@config[:host], command, result)
       end
+
       result
     end
 
@@ -209,9 +212,10 @@ module ChefApply
     # be found.
     def installed_chef_version
       return @installed_chef_version if @installed_chef_version
+
       # Note: In the case of a very old version of chef (that has no manifest - pre 12.0?)
       #       this will report as not installed.
-      manifest = read_chef_version_manifest()
+      manifest = read_chef_version_manifest
 
       # We split the version here because  unstable builds install from)
       # are in the form "Major.Minor.Build+HASH" which is not a valid
@@ -222,6 +226,7 @@ module ChefApply
     def read_chef_version_manifest
       manifest = fetch_file_contents(omnibus_manifest_path)
       raise ChefNotInstalled.new if manifest.nil?
+
       JSON.parse(manifest)
     end
 
@@ -233,7 +238,7 @@ module ChefApply
     #
     # The base temp dir is cached and will only be created once per connection lifetime.
     def temp_dir
-      dir = make_temp_dir()
+      dir = make_temp_dir
       chown(dir, user)
       dir
     end

data/lib/chef_apply/target_host/linux.rb

@@ -15,7 +15,7 @@ module ChefApply
       end
 
       def chown(path, owner)
-        owner ||= user()
+        owner ||= user
         run_command!("chown #{owner} '#{path}'")
         nil
       end

data/lib/chef_apply/target_resolver.rb

@@ -35,6 +35,7 @@ module ChefApply
     # them to account for ranges embedded in the target name.
     def targets
       return @targets unless @targets.nil?
+
       expanded_urls = []
       @split_targets.each do |target|
         expanded_urls = (expanded_urls | expand_targets(target))
@@ -84,7 +85,7 @@ module ChefApply
     end
 
     def prefix_from_target(target)
-      if target =~ /^(.+?):\/\/(.*)/
+      if target =~ %r{^(.+?)://(.*)}
         # We'll store the existing prefix to avoid it interfering
         # with the check further below.
         if ChefApply::Config::SUPPORTED_PROTOCOLS.include? $1.downcase
@@ -115,6 +116,7 @@ module ChefApply
 
     def do_parse(targets, depth = 0)
       raise TooManyRanges.new(@current_target) if depth > 2
+
       new_targets = []
       done = false
       targets.each do |target|

data/lib/chef_apply/telemeter.rb

@@ -152,7 +152,7 @@ module ChefApply
       loop do
         id += 1
         filename = File.join(ChefApply::Config.telemetry_path,
-                             "telemetry-payload-#{id}.yml")
+          "telemetry-payload-#{id}.yml")
         break unless File.exist?(filename)
       end
       filename

data/lib/chef_apply/text/error_translation.rb

@@ -18,7 +18,7 @@
 module ChefApply
   module Text
     class ErrorTranslation
-      ATTRIBUTES = [:decorations, :header, :footer, :stack, :log].freeze
+      ATTRIBUTES = %i{decorations header footer stack log}.freeze
       attr_reader :message, *ATTRIBUTES
 
       def initialize(id, params: [])

data/lib/chef_apply/text/text_wrapper.rb

@@ -31,6 +31,7 @@ module ChefApply
           if k.class == Integer
             raise MissingPlural.new(@tree.instance_variable_get(:@path), k)
           end
+
           k = k.to_sym
           define_singleton_method k do |*args|
             subtree = @tree.send(k, *args)
@@ -55,7 +56,7 @@ module ChefApply
         def set_call_context
           # TODO - this can vary (8 isn't always right) - inspect
           @line = caller(8, 1).first
-          if @line =~ /.*\/lib\/(.*\.rb):(\d+)/
+          if @line =~ %r{.*/lib/(.*\.rb):(\d+)}
             @line = "File: #{$1} Line: #{$2}"
           end
         end

data/lib/chef_apply/ui/error_printer.rb

@@ -55,7 +55,7 @@ module ChefApply::UI
         e.jobs.each do |j|
           wrapped = ChefApply::Errors::StandardErrorResolver.wrap_exception(j.exception, j.target_host)
           ep = ErrorPrinter.new(wrapped)
-          msg = ep.format_body().tr("\n", " ").gsub(/ {2,}/, " ").chomp.strip
+          msg = ep.format_body.tr("\n", " ").gsub(/ {2,}/, " ").chomp.strip
           out.write("Host: #{j.target_host.hostname} ")
           if ep.exception.respond_to? :id
             out.write("Error: #{ep.exception.id}: ")
@@ -95,7 +95,7 @@ module ChefApply::UI
       @command = exception.respond_to?(:command) ? exception.command : nil
       @pastel = Pastel.new
       @content = StringIO.new
-      @id = if exception.kind_of? ChefApply::Error
+      @id = if exception.is_a? ChefApply::Error
               exception.id
             else
               DEFAULT_ERROR_NO
@@ -117,7 +117,7 @@ module ChefApply::UI
 
     def format_undecorated
       @content << "\n"
-      @content << format_body()
+      @content << format_body
       if @command
         @content << "\n"
         @content << @command.usage
@@ -126,11 +126,11 @@ module ChefApply::UI
 
     def format_decorated
       @content << "\n"
-      @content << format_header()
+      @content << format_header
       @content << "\n\n"
-      @content << format_body()
+      @content << format_body
       @content << "\n"
-      @content << format_footer()
+      @content << format_footer
       @content << "\n"
     end
 
@@ -139,9 +139,9 @@ module ChefApply::UI
     end
 
     def format_body
-      if exception.kind_of? ChefApply::Error
+      if exception.is_a? ChefApply::Error
         format_workstation_exception
-      elsif exception.kind_of? Train::Error
+      elsif exception.is_a? Train::Error
         format_train_exception
       else
         format_other_exception
@@ -152,7 +152,7 @@ module ChefApply::UI
       if translation.log
         if translation.stack
           t.footer.both(ChefApply::Config.log.location,
-                        ChefApply::Config.stack_trace_path)
+            ChefApply::Config.stack_trace_path)
         else
           t.footer.log_only(ChefApply::Config.log.location)
         end
@@ -168,7 +168,7 @@ module ChefApply::UI
     def add_backtrace_header(out, args)
       out.write("\n#{"-" * 80}\n")
       out.print("#{Time.now}: Error encountered while running the following:\n")
-      out.print("  #{args.join(' ')}\n")
+      out.print("  #{args.join(" ")}\n")
       out.print("Backtrace:\n")
     end
 
@@ -179,10 +179,10 @@ module ChefApply::UI
     end
 
     def self.error_summary(e)
-      if e.kind_of? ChefApply::Error
+      if e.is_a? ChefApply::Error
         # By convention, all of our defined messages have a short summary on the first line.
         ChefApply::Text.errors.send(e.id).text(*e.params).split("\n").first
-      elsif e.kind_of? String
+      elsif e.is_a? String
         e
       else
         if e.respond_to? :message
@@ -201,7 +201,7 @@ module ChefApply::UI
     # 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()
+      backend, host = formatted_host
       if host.nil?
         t.CHEFTRN002.text(exception.message)
       else
@@ -215,6 +215,7 @@ module ChefApply::UI
 
     def formatted_host
       return nil if target_host.nil?
+
       cfg = target_host.config
       port = cfg[:port].nil? ? "" : ":#{cfg[:port]}"
       user = cfg[:user].nil? ? "" : "#{cfg[:user]}@"
@@ -251,6 +252,7 @@ module ChefApply::UI
       i = 1
       while i <= backtrace1.size && i <= backtrace2.size
         break if backtrace1[-i] != backtrace2[-i]
+
         i += 1
       end
       backtrace1[0..-i]

data/lib/chef_apply/ui/plain_text_element.rb

@@ -71,8 +71,7 @@ module ChefApply
         @err = false
       end
 
-      def auto_spin
-      end
+      def auto_spin; end
     end
   end
 end

data/lib/chef_apply/ui/plain_text_header.rb

@@ -39,7 +39,7 @@ module ChefApply
         @children.each do |child, block|
           @threads << Thread.new { block.call(child) }
         end
-        @threads.each { |thr| thr.join }
+        @threads.each(&:join)
       end
     end
   end

data/lib/chef_apply/ui/terminal.rb

@@ -51,9 +51,9 @@ module ChefApply
           #   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)
+            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)
@@ -91,7 +91,7 @@ module ChefApply
         end
 
         def show_cursor
-          TTY::Cursor.show()
+          TTY::Cursor.show
         end
       end
     end

data/lib/chef_apply/version.rb

@@ -16,5 +16,5 @@
 #
 
 module ChefApply
-  VERSION = "0.3.3".freeze
+  VERSION = "0.4.6".freeze
 end

data/spec/spec_helper.rb

@@ -20,6 +20,46 @@ require "simplecov"
 require "rspec/expectations"
 require "support/matchers/output_to_terminal"
 
+# class << Kernel
+#   alias :_require :require
+#   def require(*args)
+#
+#     show = false
+#     args.each do |a|
+#       if a =~ /chef_apply.*/
+#         show = true
+#         break
+#       end
+#     end
+#
+#     $stderr.puts "from #{File.basename(caller[1])}: require: %s" % [args.inspect] if show
+#     _require(*args)
+#   end
+#
+#   alias :_load :load
+#   def load(*args)
+#     show = false
+#     args.each do |a|
+#       if a =~ /chef_apply.*/
+#         show = true
+#         break
+#       end
+#     end
+#     $stderr.puts "from #{File.basename(caller[1])}: load: %s" % [args.inspect] if show
+#     _load(*args)
+#   end
+#
+# end
+#
+# module Kernel
+#   def require(*args)
+#     Kernel.require(*args)
+#   end
+#   def load(*args)
+#     Kernel.load(*args)
+#   end
+# end
+
 RemoteExecResult = Struct.new(:exit_status, :stdout, :stderr)
 
 class ChefApply::MockReporter
@@ -67,7 +107,7 @@ def assert_string_lookup(key, retval = "testvalue")
   it "should look up string #{key}" do
     top_level_method, *call_seq = key.split(".")
     terminal_method = call_seq.pop
-    tmock = double()
+    tmock = double
     # Because ordering is important
     # (eg calling errors.hello is different from hello.errors),
     # we need to add this individually instead of using
@@ -102,8 +142,8 @@ RSpec.configure do |config|
   end
 
   config.before(:all) do
-    ChefApply::Log.setup "/dev/null", :error
-    ChefApply::UI::Terminal.init(File.open("/dev/null", "w"))
+    ChefApply::Log.setup File::NULL, :error
+    ChefApply::UI::Terminal.init(File.open(File::NULL, "w"))
   end
 end
 

data/spec/unit/action/base_spec.rb

@@ -28,7 +28,8 @@ RSpec.describe ChefApply::Action::Base do
   end
   let(:opts) do
     { target_host: target_host,
-      other: "something-else" } end
+      other: "something-else" }
+  end
   subject(:action) { ChefApply::Action::Base.new(opts) }
 
   context "#initialize" do

data/spec/unit/{errors → action/converge_target}/ccr_failure_mapper_spec.rb

@@ -16,16 +16,16 @@
 #
 
 require "spec_helper"
-require "chef_apply/errors/ccr_failure_mapper"
+require "chef_apply/action/converge_target/ccr_failure_mapper"
 
-RSpec.describe ChefApply::Errors::CCRFailureMapper do
+RSpec.describe ChefApply::Action::ConvergeTarget::CCRFailureMapper do
   let(:cause_line) { nil }
   let(:resource) { "apt_package" }
   let(:params) do
     { resource: resource, resource_name: "a-test-thing",
       stderr: "an error", stdout: "other output" }
   end
-  subject { ChefApply::Errors::CCRFailureMapper.new(cause_line, params) }
+  subject { ChefApply::Action::ConvergeTarget::CCRFailureMapper.new(cause_line, params) }
 
   describe "#exception_args_from_cause" do
     context "when resource properties have valid names but invalid values" do
@@ -45,14 +45,16 @@ RSpec.describe ChefApply::Errors::CCRFailureMapper do
           it "returns a correct CHEFCCR004 when details are available" do
             expect(subject.exception_args_from_cause).to eq(
               ["CHEFCCR004",
-               "Option force must be a kind of [TrueClass, FalseClass]!  You passed \"purle\"."])
+               "Option force must be a kind of [TrueClass, FalseClass]!  You passed \"purle\"."]
+            )
           end
         end
         context "And less detail is available" do
           let(:cause_line) { "Chef::Exceptions::User: linux_user[marc] ((chef-client cookbook)::(chef-client recipe) line 1) had an error: Chef::Exceptions::User: Couldn't lookup integer GID for group name blah" }
           it "returns a correct CHEFCCR002" do
             expect(subject.exception_args_from_cause).to eq(
-              ["CHEFCCR002", "Couldn't lookup integer GID for group name blah"])
+              ["CHEFCCR002", "Couldn't lookup integer GID for group name blah"]
+            )
           end
         end
       end
@@ -70,7 +72,8 @@ RSpec.describe ChefApply::Errors::CCRFailureMapper do
       let(:cause_line) { "NoMethodError: undefined method `badresourceprop' for Chef::Resource::User::LinuxUser" }
       it "returns a correct CHEFCCR006 " do
         expect(subject.exception_args_from_cause).to eq(
-          ["CHEFCCR006", "badresourceprop", "Chef::Resource::User::LinuxUser"])
+          ["CHEFCCR006", "badresourceprop", "Chef::Resource::User::LinuxUser"]
+        )
       end
     end
   end
@@ -79,7 +82,7 @@ RSpec.describe ChefApply::Errors::CCRFailureMapper do
     context "when no cause is provided" do
       let(:cause_line) { nil }
       it "raises a RemoteChefRunFailedToResolveError" do
-        expect { subject.raise_mapped_exception! }.to raise_error(ChefApply::Errors::CCRFailureMapper::RemoteChefRunFailedToResolveError)
+        expect { subject.raise_mapped_exception! }.to raise_error(ChefApply::Action::ConvergeTarget::CCRFailureMapper::RemoteChefRunFailedToResolveError)
 
       end
     end
@@ -88,14 +91,14 @@ RSpec.describe ChefApply::Errors::CCRFailureMapper do
       context "but can't resolve it" do
         let(:cause_line) { "unparseable mess" }
         it "raises a RemoteChefClientRunFailedUnknownReason" do
-          expect { subject.raise_mapped_exception! }.to raise_error(ChefApply::Errors::CCRFailureMapper::RemoteChefClientRunFailedUnknownReason)
+          expect { subject.raise_mapped_exception! }.to raise_error(ChefApply::Action::ConvergeTarget::CCRFailureMapper::RemoteChefClientRunFailedUnknownReason)
         end
       end
 
       context "and can resolve the cause" do
         let(:cause_line) { "NoMethodError: undefined method `badresourceprop' for Chef::Resource::User::LinuxUser" }
         it "raises a RemoteChefClientRunFailed" do
-          expect { subject.raise_mapped_exception! }.to raise_error(ChefApply::Errors::CCRFailureMapper::RemoteChefClientRunFailed)
+          expect { subject.raise_mapped_exception! }.to raise_error(ChefApply::Action::ConvergeTarget::CCRFailureMapper::RemoteChefClientRunFailed)
         end
       end
     end