chef-core 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95d4d54d6d4f6d93a734304e0fa472c09ecc19b4731e27f9412163833a028ae4
-  data.tar.gz: fc87960b14f2ff60052ccf098e9c4733d75292ff3ca3832f2acd2f9be4af7ab3
+  metadata.gz: 3304fd223814fd03889847edc6b0b44bb20e0218d126d37c8c68e2df2bed3290
+  data.tar.gz: d818f9f5683018d5578d46244926fb8bd3cabafdbfe11521916c51b123674469
 SHA512:
-  metadata.gz: e4dd0e482cb7a6113265cb1f2ff51d48f6dd3d3ab32e6104a3c82fcded262ca766d186392d1d06131bda9a584e7507781cc436d801264f73efe865c0cb082111
-  data.tar.gz: 9d5437085b14e6ea12e2dab7eee17f97ffdc7835690617d23689580c9b755478f4bfe9a8224821aecb6765f713210a1a87c06a99cd086e39a2dbbda8d4c2b3b4
+  metadata.gz: 6b4b4a9ab4c31d096a57d3309663f3d5fb2800b3e2696314800fad001fe0c7b090192b7e8a4276068722037be53857f35cd8dcc89a7c53e7cad850a6b2a6eddb
+  data.tar.gz: 44ed3054f724b189822237081f1b717c8cc85ae32fb547f305cfcb4b9f395736f51d587269e7e1cd1cbe1263d891c662e1c55063bad225525dba3fc344f77c1d

data/lib/chef_core/cliux/ui/error_printer.rb

@@ -59,7 +59,7 @@ module ChefCore
             e.jobs.each do |j|
               wrapped = ChefCore::Errors::StandardErrorResolver.wrap_exception(j.exception, j.target_host)
               ep = ErrorPrinter.new(wrapper: wrapped, config: config)
-              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}: ")
@@ -100,7 +100,7 @@ module ChefCore
           @pastel = Pastel.new
           @content = StringIO.new
           @config = config
-          @id = if @exception.kind_of? ChefCore::Error
+          @id = if @exception.is_a? ChefCore::Error
                   @exception.id
                 else
                   DEFAULT_ERROR_NO
@@ -122,7 +122,7 @@ module ChefCore
 
         def format_undecorated
           @content << "\n"
-          @content << format_body()
+          @content << format_body
           if @command
             @content << "\n"
             @content << @command.usage
@@ -131,11 +131,11 @@ module ChefCore
 
         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
 
@@ -144,9 +144,9 @@ module ChefCore
         end
 
         def format_body
-          if exception.kind_of? ChefCore::Error
+          if exception.is_a? ChefCore::Error
             format_workstation_exception
-          elsif exception.kind_of? Train::Error
+          elsif exception.is_a? Train::Error
             format_train_exception
           else
             format_other_exception
@@ -172,7 +172,7 @@ module ChefCore
         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
 
@@ -183,10 +183,10 @@ module ChefCore
         end
 
         def self.error_summary(e)
-          if e.kind_of? ChefCore::Error
+          if e.is_a? ChefCore::Error
             # By convention, all of our defined messages have a short summary on the first line.
             ChefCore::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
@@ -205,7 +205,7 @@ module ChefCore
         # 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
@@ -219,6 +219,7 @@ module ChefCore
 
         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]}@"
@@ -255,6 +256,7 @@ module ChefCore
           i = 1
           while i <= backtrace1.size && i <= backtrace2.size
             break if backtrace1[-i] != backtrace2[-i]
+
             i += 1
           end
           backtrace1[0..-i]

data/lib/chef_core/cliux/ui/plain_text_element.rb

@@ -72,8 +72,7 @@ module ChefCore
           @err = false
         end
 
-        def auto_spin
-        end
+        def auto_spin; end
       end
     end
   end

data/lib/chef_core/cliux/ui/plain_text_header.rb

@@ -40,7 +40,7 @@ module ChefCore
           @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_core/cliux/ui/terminal.rb

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

data/lib/chef_core/error.rb

@@ -24,7 +24,6 @@ module ChefCore
     end
   end
 
-
   class WrappedError < StandardError
     attr_accessor :target_host, :contained_exception
     def initialize(e, target_host)

data/lib/chef_core/file_fetcher.rb

@@ -51,7 +51,7 @@ module ChefCore
             @error = true
             raise
           ensure
-            file.close()
+            file.close
             # If any failures occurred, don't risk keeping
             # an incomplete download that we'll see as 'cached'
             if @error

data/lib/chef_core/target_host.rb

@@ -25,7 +25,7 @@ module ChefCore
     # 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 ChefCore
     # 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 })
@@ -92,7 +92,7 @@ module ChefCore
 
       # From WinRM gem: It is recommended that you :disable_sspi => true if you are using the plaintext or ssl transport.
       #                 See note here: https://github.com/mwrock/WinRM#example
-      if ["ssl", "plaintext"].include?(target_opts[:winrm_transport])
+      if %w{ssl plaintext}.include?(target_opts[:winrm_transport])
         target_opts[:winrm_disable_sspi] = true
       end
 
@@ -128,6 +128,7 @@ module ChefCore
     def connect!
       # Keep existing connections
       return unless @backend.nil?
+
       @backend = train_connection.connection
       @backend.wait_until_ready
 
@@ -159,6 +160,7 @@ module ChefCore
     # 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"
       # TODO - this should use the right transport, not default to SSH
       Train::Transports::SSH.default_options[:user][:default]
@@ -196,6 +198,7 @@ module ChefCore
       if result.exit_status != 0
         raise RemoteExecutionFailed.new(@config[:host], command, result)
       end
+
       result
     end
 
@@ -205,13 +208,13 @@ module ChefCore
 
     # TODO spec
     def save_as_remote_file(content, remote_path)
-       t = Tempfile.new("chef-content")
-       t << content
-       t.close
-       upload_file(t.path, remote_path)
+      t = Tempfile.new("chef-content")
+      t << content
+      t.close
+      upload_file(t.path, remote_path)
     ensure
-        t.close
-        t.unlink
+      t.close
+      t.unlink
     end
 
     def upload_file(local_path, remote_path)
@@ -234,9 +237,10 @@ module ChefCore
     # 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
@@ -247,6 +251,7 @@ module ChefCore
     def read_chef_version_manifest
       manifest = fetch_file_contents(omnibus_manifest_path)
       raise ChefNotInstalled.new if manifest.nil?
+
       JSON.parse(manifest)
     end
 
@@ -258,7 +263,7 @@ module ChefCore
     #
     # 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_core/target_host/linux.rb

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

data/lib/chef_core/target_resolver.rb

@@ -28,7 +28,7 @@ module ChefCore
   # Use resolver_inst.targets to get the expanded list of TargetHost instances.
   class TargetResolver
     MAX_EXPANDED_TARGETS = 24
-    SUPPORTED_PROTOCOLS = %w{winrm ssh}
+    SUPPORTED_PROTOCOLS = %w{winrm ssh}.freeze
     def initialize(target, default_protocol, conn_options, max_expanded_targets: MAX_EXPANDED_TARGETS)
       @max_expanded_targets = max_expanded_targets
       @default_proto = default_protocol
@@ -42,6 +42,7 @@ module ChefCore
     # Returns the list of targets as an array of TargetHost instances
     def targets
       return @targets unless @targets.nil?
+
       expanded_urls = []
       @split_targets.each do |target|
         expand_targets(target).each { |t| expanded_urls << t }
@@ -100,7 +101,7 @@ module ChefCore
     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 SUPPORTED_PROTOCOLS.include? $1.downcase
@@ -131,6 +132,7 @@ module ChefCore
 
     def do_parse(targets, depth = 0)
       raise TooManyRanges.new(@current_target) if depth > 2
+
       new_targets = []
       done = false
       targets.each do |target|
@@ -191,7 +193,7 @@ module ChefCore
     end
     # Provide an error base for all targetresolver errors, to simplify
     # handling when caller is not concerned with the specific failure.
-    class TargetResolverError  < ChefCore::Error; end
+    class TargetResolverError < ChefCore::Error; end
 
     class InvalidRange < TargetResolverError
       def initialize(unresolved_target, given_range)

data/lib/chef_core/telemeter.rb

@@ -70,16 +70,16 @@ module ChefCore
       timed_capture(:run, arguments: arguments, &block)
     end
 
-    def timed_capture(name, data = {})
+    def timed_capture(name, data = {}, options = {})
       time = Benchmark.measure { yield }
       data[:duration] = time.real
-      capture(name, data)
+      capture(name, data, options)
     end
 
-    def capture(name, data = {})
+    def capture(name, data = {}, options = {})
       # Adding it to the head of the list will ensure that the
       # sequence of events is preserved when we send the final payload
-      payload = make_event_payload(name, data)
+      payload = make_event_payload(name, data, options)
       @events_to_send.unshift payload
     end
 
@@ -91,16 +91,21 @@ module ChefCore
       @events_to_send = []
     end
 
-    def make_event_payload(name, data)
-      {
+    def make_event_payload(name, data, options)
+      payload = {
         event: name,
         properties: {
           installation_id: installation_id,
           run_timestamp: run_timestamp,
           host_platform: host_platform,
-          event_data: data,
         },
       }
+      if options[:flatten]
+        payload[:properties].merge! data
+      else
+        payload[:properties][:event_data] = data
+      end
+      payload
     end
 
     def installation_id

data/lib/chef_core/telemeter/patch.rb

@@ -16,13 +16,6 @@
 #
 
 class Telemetry
-  class Session
-    # The telemetry session data is normally kept in .chef, which we don't have.
-    def session_file
-      ChefCore::Config.telemetry_session_file.freeze
-    end
-  end
-
   def deliver(data = {})
     if ChefCore::Telemeter.instance.enabled?
       payload = event.prepare(data)

data/lib/chef_core/telemeter/sender.rb

@@ -83,12 +83,12 @@ module ChefCore
         FileUtils.rm_rf(config[:session_file])
         # We'll use the version captured in the sesion file
         entries = content["entries"]
-        cli_version = content["version"]
         total = entries.length
-        telemetry = Telemetry.new(product: "chef-workstation",
-                                  origin: "command-line",
-                                  product_version: cli_version,
-                                  install_context: "omnibus")
+        product_info = config[:product] || {}
+        telemetry = Telemetry.new(product: product_info[:name] || "chef-workstation",
+                                  origin: product_info[:origin] || "command-line",
+                                  product_version: product_info[:version] || content["version"],
+                                  install_context: product_info[:install_context] || "omnibus")
         total = entries.length
         entries.each_with_index do |entry, x|
           submit_entry(telemetry, entry, x + 1, total)

data/lib/chef_core/text.rb

@@ -35,6 +35,7 @@ module ChefCore
 
     def self.add_localization(base_path)
       return if @raw_localization_paths.include? base_path
+
       # @localization_paths will get modified by R18n, so we'll
       # keep them as strings as well, to ensure we can avoid duplicate loading.
       errors_path = File.join(base_path, "errors")

data/lib/chef_core/text/error_translation.rb

@@ -20,20 +20,19 @@ module ChefCore
     # Represents an error loaded from translation, with
     # display attributes set.
     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: [])
         error_translation = error_translation_for_id(id)
 
-        options = YAML.load(Text.errors.display_defaults, "display_defaults",
-                            symbolize_names: true)
+        options = _sym(YAML.load(Text.errors.display_defaults, "display_defaults"))
 
         # Display metadata is a string containing a YAML hash that is optionally under
         # the error's 'options' attribute
         # Note that we couldn't use :display, as that conflicts with a method on Object.
         display_opts = if error_translation.methods.include?(:options)
-                         YAML.load(error_translation.options, @id, symbolize_names: true)
+                         _sym(YAML.load(error_translation.options, @id))
                        else
                          {}
                        end
@@ -53,6 +52,10 @@ module ChefCore
         end
       end
 
+      def _sym hash
+        hash.map { |k,v| [k.to_sym, v] }.to_h
+      end
+
       def inspect
         inspection = "#{self}: "
         ATTRIBUTES.each do |attribute|

data/lib/chef_core/text/text_wrapper.rb

@@ -32,6 +32,7 @@ module ChefCore
           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)
@@ -56,7 +57,7 @@ module ChefCore
         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_core/version.rb

@@ -16,5 +16,5 @@
 #
 
 module ChefCore
-  VERSION = "0.0.3".freeze
+  VERSION = "0.0.5".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-core
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Chef Software, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-23 00:00:00.000000000 Z
+date: 2019-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -297,17 +297,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Composable common actions for assembling Chef workflows