chef-utils 16.2.73 → 16.3.38

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 712ce0c1f706df8363d83df9037b09a162df620cdf2de3712184fb0d221fb725
-  data.tar.gz: 65af39a0822945d9abf808c01823c80e405375d75111e6badded36283f3ea0e3
+  metadata.gz: 9f5b96fe6160526b332bbb97dd82753a024e239478257753052287f5a91b2239
+  data.tar.gz: 5b8504937acdb70a72818d139c60eb760da04be5c8238b172a9c76a02b945bda
 SHA512:
-  metadata.gz: 1ed1b71c80a160ca0c1ca290d34988bd85b878f703d4f33359fafe01f8a4197099d5e7c636f7812dded42a76e0a58d3c7b907a634a5a0a6882ca0cd5d6fdf943
-  data.tar.gz: b2a1e1baee866d6a68ba29e8cdb20aa08cb7c66af92a8afe8f75c0a33776a0457511a25c786d785a35d23c39933f56ad2ef20779b62a26f3ed83ae4728c3f8bb
+  metadata.gz: dfd59cb093364785edc3ddb3261f792c9d13a6e63cfbf2ef3abaee879a020fcbcf913d47b4a93f6bcb59b77887638cad5342bd93db8bea625d087bfaf2e6afcf
+  data.tar.gz: 36faef376d1e3439bcfb743c48aea0b19e466461ee238706429058f11eabcfdf76ebdcf3d396867fe349c5beb78f0853e209e35f5c76a854cd9ff50075ca246a

data/chef-utils.gemspec

@@ -1,5 +1,4 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "chef-utils/version"
 

data/lib/chef-utils.rb

@@ -19,6 +19,7 @@ require_relative "chef-utils/dsl/architecture"
 require_relative "chef-utils/dsl/cloud"
 require_relative "chef-utils/dsl/introspection"
 require_relative "chef-utils/dsl/os"
+require_relative "chef-utils/dsl/default_paths"
 require_relative "chef-utils/dsl/path_sanity"
 require_relative "chef-utils/dsl/platform"
 require_relative "chef-utils/dsl/platform_family"
@@ -34,9 +35,9 @@ require_relative "chef-utils/mash"
 module ChefUtils
   include ChefUtils::DSL::Architecture
   include ChefUtils::DSL::Cloud
+  include ChefUtils::DSL::DefaultPaths
   include ChefUtils::DSL::Introspection
   include ChefUtils::DSL::OS
-  include ChefUtils::DSL::PathSanity
   include ChefUtils::DSL::Platform
   include ChefUtils::DSL::PlatformFamily
   include ChefUtils::DSL::PlatformVersion

data/lib/chef-utils/dsl/default_paths.rb

@@ -0,0 +1,59 @@
+#
+# Copyright:: Copyright (c) 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_relative "../internal"
+require_relative "platform_family"
+
+module ChefUtils
+  module DSL
+    module DefaultPaths
+      include Internal
+
+      # @since 15.5
+      def default_paths(env = nil)
+        env_path = env ? env["PATH"] : __env_path
+        env_path = "" if env_path.nil?
+        path_separator = ChefUtils.windows? ? ";" : ":"
+        # ensure the Ruby and Gem bindirs are included for omnibus chef installs
+        new_paths = env_path.split(path_separator)
+        [ __ruby_bindir, __gem_bindir ].compact.each do |path|
+          new_paths = [ path ] + new_paths unless new_paths.include?(path)
+        end
+        __default_paths.each do |path|
+          new_paths << path unless new_paths.include?(path)
+        end
+        new_paths.join(path_separator).encode("utf-8", invalid: :replace, undef: :replace)
+      end
+
+      private
+
+      def __default_paths
+        ChefUtils.windows? ? %w{} : %w{/usr/local/sbin /usr/local/bin /usr/sbin /usr/bin /sbin /bin}
+      end
+
+      def __ruby_bindir
+        RbConfig::CONFIG["bindir"]
+      end
+
+      def __gem_bindir
+        Gem.bindir
+      end
+
+      extend self
+    end
+  end
+end

data/lib/chef-utils/dsl/path_sanity.rb

@@ -15,42 +15,21 @@
 # limitations under the License.
 #
 
-require_relative "../internal"
-require_relative "platform_family"
+require_relative "default_paths"
 
 module ChefUtils
   module DSL
     module PathSanity
-      include Internal
+      include ChefUtils::DSL::DefaultPaths
 
-      # @since 15.5
       def sanitized_path(env = nil)
-        env_path = env ? env["PATH"] : __env_path
-        env_path = "" if env_path.nil?
-        path_separator = ChefUtils.windows? ? ";" : ":"
-        # ensure the Ruby and Gem bindirs are included for omnibus chef installs
-        new_paths = env_path.split(path_separator)
-        [ ChefUtils::DSL::PathSanity.ruby_bindir, ChefUtils::DSL::PathSanity.gem_bindir ].compact.each do |path|
-          new_paths = [ path ] + new_paths unless new_paths.include?(path)
-        end
-        ChefUtils::DSL::PathSanity.sane_paths.each do |path|
-          new_paths << path unless new_paths.include?(path)
-        end
-        new_paths.join(path_separator).encode("utf-8", invalid: :replace, undef: :replace)
+        default_paths(env)
       end
 
-      class << self
-        def sane_paths
-          ChefUtils.windows? ? %w{} : %w{/usr/local/sbin /usr/local/bin /usr/sbin /usr/bin /sbin /bin}
-        end
+      private
 
-        def ruby_bindir
-          RbConfig::CONFIG["bindir"]
-        end
-
-        def gem_bindir
-          Gem.bindir
-        end
+      def __sane_paths
+        __default_paths
       end
 
       extend self

data/lib/chef-utils/dsl/service.rb

@@ -25,6 +25,7 @@ module ChefUtils
     module Service
       include Internal
       include TrainHelpers
+      include Introspection
 
       # Returns if debian's old rc.d manager is installed (not necessarily the primary init system).
       #
@@ -97,8 +98,8 @@ module ChefUtils
           file_exist?("/etc/rc.d/#{script}")
         when :systemd
           file_exist?("/etc/init.d/#{script}") ||
-            ChefUtils::DSL::Introspection.has_systemd_service_unit?(script) ||
-            ChefUtils::DSL::Introspection.has_systemd_unit?(script)
+            has_systemd_service_unit?(script) ||
+            has_systemd_unit?(script)
         else
           raise ArgumentError, "type of service must be one of :initd, :upstart, :xinetd, :etc_rcd, or :systemd"
         end

data/lib/chef-utils/internal.rb

@@ -40,11 +40,18 @@ module ChefUtils
 
     private
 
-    # FIXME: include a `__config` method so we can wire up Chef::Config automatically or allow other consumers to
-    # inject a config hash without having to take a direct dep on the chef-config gem
-
+    # This should be set to a Chef::Node instance or to some Hash/Mash-like configuration object with the same keys.  It needs to
+    # expose keys like `:os`, `:platform`, `:platform_version` and `:platform_family` at least to be useful.  It will automatically
+    # pick up a `node` method when mixed into an object that has that as a method (which is the encouraged "public" API to use
+    # for dependency injection rather than overriding the method in this case.
+    #
+    # @return [Hash] hash-like config object
+    #
     # @api private
     def __getnode(skip_global = false)
+      # Software developers should feel free to rely on the default wiring here to the node method by implementing the node method in their
+      # own class.  For anything more complicated they should completely override the method (overriding the whole method is never wrong and
+      # is safer).
       return node if respond_to?(:node) && node
 
       return run_context&.node if respond_to?(:run_context) && run_context&.node
@@ -56,7 +63,10 @@ module ChefUtils
       nil
     end
 
+    # Just a helper to pull the ENV["PATH"] in a train-independent way
+    #
     # @api private
+    #
     def __env_path
       if __transport_connection
         __transport_connection.run_command("echo $PATH").stdout || ""
@@ -65,13 +75,39 @@ module ChefUtils
       end
     end
 
+    # This should be set to a Train::Plugins::Transport instance.  You should wire this up to nil for not using a train transport connection.
+    #
+    # @return [Train::Plugins::Transport]
+    #
     # @api private
+    #
     def __transport_connection
+      # Software consumers MUST override this method with their own implementation.  The default behavior here is subject to change.
       return Chef.run_context.transport_connection if defined?(Chef) && Chef.respond_to?(:run_context) && Chef&.run_context&.transport_connection
 
       nil
     end
 
+    # This should be set to Chef::Config or to some Hash/Mash-like configuration object with the same keys.  It must not be nil.
+    #
+    # @return [Hash] hash-like config object
+    #
+    # @api private
+    #
+    def __config
+      raise NotImplementedError
+    end
+
+    # This should be set to Chef::Log or something that duck-types like it.  It must not be nil.
+    #
+    # @return [Chef::Log] logger-like logging object
+    #
+    # @api private
+    #
+    def __log
+      raise NotImplementedError
+    end
+
     extend self
   end
 end

data/lib/chef-utils/version.rb

@@ -14,6 +14,6 @@
 # limitations under the License.
 
 module ChefUtils
-  CHEFUTILS_ROOT = File.expand_path("../..", __FILE__)
-  VERSION = "16.2.73".freeze
+  CHEFUTILS_ROOT = File.expand_path("..", __dir__)
+  VERSION = "16.3.38".freeze
 end

data/spec/spec_helper.rb

@@ -6,7 +6,7 @@ HELPER_MODULES = [
   ChefUtils::DSL::Cloud,
   ChefUtils::DSL::Introspection,
   ChefUtils::DSL::OS,
-  ChefUtils::DSL::PathSanity,
+  ChefUtils::DSL::DefaultPaths,
   ChefUtils::DSL::Platform,
   ChefUtils::DSL::PlatformFamily,
   ChefUtils::DSL::Service,

data/spec/unit/dsl/introspection_spec.rb

@@ -21,6 +21,7 @@ RSpec.describe ChefUtils::DSL::Introspection do
   class IntrospectionTestClass
     include ChefUtils::DSL::Introspection
     attr_accessor :node
+
     def initialize(node)
       @node = node
     end

data/spec/unit/dsl/path_sanity_spec.rb

@@ -17,9 +17,9 @@
 
 require "spec_helper"
 
-RSpec.describe ChefUtils::DSL::PathSanity do
-  class PathSanityTestClass
-    include ChefUtils::DSL::PathSanity
+RSpec.describe ChefUtils::DSL::DefaultPaths do
+  class DefaultPathsTestClass
+    include ChefUtils::DSL::DefaultPaths
   end
 
   before do
@@ -32,26 +32,26 @@ RSpec.describe ChefUtils::DSL::PathSanity do
       allow(ChefUtils).to receive(:windows?).and_return(false)
     end
 
-    let(:test_instance) { PathSanityTestClass.new }
+    let(:test_instance) { DefaultPathsTestClass.new }
 
     it "works with no path" do
       env = {}
-      expect(test_instance.sanitized_path(env)).to eql("#{Gem.bindir}:#{RbConfig::CONFIG["bindir"]}:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin")
+      expect(test_instance.default_paths(env)).to eql("#{Gem.bindir}:#{RbConfig::CONFIG["bindir"]}:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin")
     end
 
     it "works with nil path" do
       env = { "PATH" => nil }
-      expect(test_instance.sanitized_path(env)).to eql("#{Gem.bindir}:#{RbConfig::CONFIG["bindir"]}:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin")
+      expect(test_instance.default_paths(env)).to eql("#{Gem.bindir}:#{RbConfig::CONFIG["bindir"]}:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin")
     end
 
     it "works with empty path" do
       env = { "PATH" => "" }
-      expect(test_instance.sanitized_path(env)).to eql("#{Gem.bindir}:#{RbConfig::CONFIG["bindir"]}:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin")
+      expect(test_instance.default_paths(env)).to eql("#{Gem.bindir}:#{RbConfig::CONFIG["bindir"]}:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin")
     end
 
-    it "appends the sane_paths to the end of the path, preserving any that already exist, in the same order" do
+    it "appends the default_paths to the end of the path, preserving any that already exist, in the same order" do
       env = { "PATH" => "/bin:/opt/app/bin:/sbin" }
-      expect(test_instance.sanitized_path(env)).to eql("#{Gem.bindir}:#{RbConfig::CONFIG["bindir"]}:/bin:/opt/app/bin:/sbin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin")
+      expect(test_instance.default_paths(env)).to eql("#{Gem.bindir}:#{RbConfig::CONFIG["bindir"]}:/bin:/opt/app/bin:/sbin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin")
     end
   end
 
@@ -60,26 +60,26 @@ RSpec.describe ChefUtils::DSL::PathSanity do
       allow(ChefUtils).to receive(:windows?).and_return(true)
     end
 
-    let(:test_instance) { PathSanityTestClass.new }
+    let(:test_instance) { DefaultPathsTestClass.new }
 
     it "works with no path" do
       env = {}
-      expect(test_instance.sanitized_path(env)).to eql("#{Gem.bindir};#{RbConfig::CONFIG["bindir"]}")
+      expect(test_instance.default_paths(env)).to eql("#{Gem.bindir};#{RbConfig::CONFIG["bindir"]}")
     end
 
     it "works with nil path" do
       env = { "PATH" => nil }
-      expect(test_instance.sanitized_path(env)).to eql("#{Gem.bindir};#{RbConfig::CONFIG["bindir"]}")
+      expect(test_instance.default_paths(env)).to eql("#{Gem.bindir};#{RbConfig::CONFIG["bindir"]}")
     end
 
     it "works with empty path" do
       env = { "PATH" => "" }
-      expect(test_instance.sanitized_path(env)).to eql("#{Gem.bindir};#{RbConfig::CONFIG["bindir"]}")
+      expect(test_instance.default_paths(env)).to eql("#{Gem.bindir};#{RbConfig::CONFIG["bindir"]}")
     end
 
     it "prepends to an existing path" do
       env = { "PATH" => '%SystemRoot%\system32;%SystemRoot%;%SystemRoot%\System32\Wbem;%SYSTEMROOT%\System32\WindowsPowerShell\v1.0\\' }
-      expect(test_instance.sanitized_path(env)).to eql("#{Gem.bindir};#{RbConfig::CONFIG["bindir"]};%SystemRoot%\\system32;%SystemRoot%;%SystemRoot%\\System32\\Wbem;%SYSTEMROOT%\\System32\\WindowsPowerShell\\v1.0\\")
+      expect(test_instance.default_paths(env)).to eql("#{Gem.bindir};#{RbConfig::CONFIG["bindir"]};%SystemRoot%\\system32;%SystemRoot%;%SystemRoot%\\System32\\Wbem;%SYSTEMROOT%\\System32\\WindowsPowerShell\\v1.0\\")
     end
   end
 end

data/spec/unit/dsl/platform_spec.rb

@@ -58,6 +58,7 @@ RSpec.describe ChefUtils::DSL::Platform do
   class ThingWithANode
     include ChefUtils::DSL::Platform
     attr_accessor :node
+
     def initialize(node)
       @node = node
     end
@@ -69,6 +70,7 @@ RSpec.describe ChefUtils::DSL::Platform do
       attr_accessor :node
     end
     attr_accessor :run_context
+
     def initialize(node)
       @run_context = RunContext.new
       run_context.node = node
@@ -78,6 +80,7 @@ RSpec.describe ChefUtils::DSL::Platform do
   class ThingWithTheDSL
     include ChefUtils
     attr_accessor :node
+
     def initialize(node)
       @node = node
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-utils
 version: !ruby/object:Gem::Version
-  version: 16.2.73
+  version: 16.3.38
 platform: ruby
 authors:
 - Chef Software, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-01 00:00:00.000000000 Z
+date: 2020-07-25 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -23,6 +23,7 @@ files:
 - lib/chef-utils.rb
 - lib/chef-utils/dsl/architecture.rb
 - lib/chef-utils/dsl/cloud.rb
+- lib/chef-utils/dsl/default_paths.rb
 - lib/chef-utils/dsl/introspection.rb
 - lib/chef-utils/dsl/os.rb
 - lib/chef-utils/dsl/path_sanity.rb