chef-utils 15.6.10 → 15.7.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4922e045b18921d2c32e699614abca3f13a7c5522f5ab0833607936c55f401b9
-  data.tar.gz: 271d42c9c9ea566c24f217d0e4ae260ef5f4f48a16d83dd92996e7ca36bc3ce4
+  metadata.gz: 06ac46e984418a061b58f7db952a50e27569b5919c3f7dce6ffac6d45ee55fb5
+  data.tar.gz: 277f88617c5f70967f6a09e5c0da820d71fb8b59d69ee6ad72458ff3eb40b63c
 SHA512:
-  metadata.gz: eee33a5da2fdf1445a024f42286d14272119bb1d5e7802e093cfd804ed0dbed233f2c55f27bcde759374c7f3ede9cb58d9a0e9691ba63d8aebbab40ba69f0071
-  data.tar.gz: fb666e2a7df8ce8a747f10326967e73b30495bc257cce11905b51a25e37a6d0749af3963c7e5532ea8d48d5aa622b3f87f1397b1070034e0e82e7e7346e20d44
+  metadata.gz: 1618de8f21fe43d920322b4b9eb6527a7948da94391bffa619e8196ed84a41c2483cb4ef3d680390256b32d3b93646ed1dbffda31fa2c7e1fd5e267763245e6e
+  data.tar.gz: 9cc7276e5eaecae036f9d00136a1302d31c33e309bb2f47db593168a2b7881f63495d0e8c35ee82690b2f17a870ec8ea3559fb6d074740f793545024649914b6

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

@@ -63,7 +63,7 @@ module ChefUtils
         %w{sun4u sun4v}.include?(node["kernel"]["machine"])
       end
 
-      # Determine if the current architecture is Powerpc64 Big Endian
+      # Determine if the current architecture is PowerPC 64bit Big Endian
       #
       # @return [Boolean]
       #
@@ -71,7 +71,7 @@ module ChefUtils
         %w{ppc64}.include?(node["kernel"]["machine"])
       end
 
-      # Determine if the current architecture is Powerpc64 Little Endian
+      # Determine if the current architecture is PowerPC 64bit Little Endian
       #
       # @return [Boolean]
       #

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

@@ -28,7 +28,7 @@ module ChefUtils
     module Introspection
       include TrainHelpers
 
-      # Returns whether the node is a docker container.
+      # Determine if the node is a docker container.
       #
       # @param [Chef::Node] node
       #
@@ -40,6 +40,8 @@ module ChefUtils
         !!(node && node.read("virtualization", "systems", "docker") == "guest")
       end
 
+      # Determine if the node uses the systemd init system.
+      #
       # @param [Chef::Node] node
       #
       # @return [Boolean]
@@ -48,6 +50,8 @@ module ChefUtils
         file_exist?("/proc/1/comm") && file_open("/proc/1/comm").gets.chomp == "systemd"
       end
 
+      # Determine if the node is running in Test Kitchen.
+      #
       # @param [Chef::Node] node
       #
       # @return [Boolean]
@@ -56,6 +60,8 @@ module ChefUtils
         ENV.key?("TEST_KITCHEN")
       end
 
+      # Determine if the node is running in a CI system that sets the CI env var.
+      #
       # @param [Chef::Node] node
       #
       # @return [Boolean]
@@ -64,6 +70,8 @@ module ChefUtils
         ENV.key?("CI")
       end
 
+      # Determine if the a systemd service unit is present on the system.
+      #
       # @param [String] svc_name
       #
       # @return [Boolean]
@@ -76,6 +84,8 @@ module ChefUtils
         end
       end
 
+      # Determine if the a systemd unit of any type is present on the system.
+      #
       # @param [String] svc_name
       #
       # @return [Boolean]

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

@@ -22,7 +22,7 @@ module ChefUtils
     module PlatformFamily
       include Internal
 
-      # Determine if the current node is arch linux.
+      # Determine if the current node is a member of the 'arch' family.
       #
       # @param [Chef::Node] node
       #
@@ -34,7 +34,7 @@ module ChefUtils
       # chef-sugar backcompat methods
       alias_method :arch_linux?, :arch?
 
-      # Determine if the current node is aix
+      # Determine if the current node is a member of the 'aix' platform family.
       #
       # @param [Chef::Node] node
       #
@@ -44,7 +44,7 @@ module ChefUtils
         node["platform_family"] == "aix"
       end
 
-      # Determine if the current node is a member of the debian family.
+      # Determine if the current node is a member of the 'debian' platform family (Debian, Ubuntu and derivatives).
       #
       # @param [Chef::Node] node
       #
@@ -54,7 +54,7 @@ module ChefUtils
         node["platform_family"] == "debian"
       end
 
-      # Determine if the current node is a member of the fedora family.
+      # Determine if the current node is a member of the 'fedora' platform family (Fedora and Arist).
       #
       # @param [Chef::Node] node
       #
@@ -64,7 +64,7 @@ module ChefUtils
         node["platform_family"] == "fedora"
       end
 
-      # Determine if the current node is a member of the OSX family.
+      # Determine if the current node is a member of the 'mac_os_x' platform family.
       #
       # @param [Chef::Node] node
       #
@@ -77,9 +77,7 @@ module ChefUtils
       alias_method :mac?, :macos?
       alias_method :mac_os_x?, :macos?
 
-      # Determine if the current node is a member of the rhel family (RHEL, CentOS, Oracle or Scientific Linux, no Amazon or Fedora).
-      #
-      # The platform_versions for these operating systems must match (rhel7 == centos7 == oracle7 == scientfic7), modulo additional packages
+      # Determine if the current node is a member of the 'rhel' platform family (Red Hat, CentOS, Oracle or Scientific Linux, but NOT Amazon Linux or Fedora).
       #
       # @param [Chef::Node] node
       #
@@ -90,7 +88,7 @@ module ChefUtils
       end
       alias_method :el?, :rhel?
 
-      # Determine if the current node is a rhel6 compatible build (RHEL, CentOS, Oracle or Scientific Linux)
+      # Determine if the current node is a rhel6 compatible build (Red Hat, CentOS, Oracle or Scientific Linux)
       #
       # @param [Chef::Node] node
       #
@@ -100,7 +98,7 @@ module ChefUtils
         node["platform_family"] == "rhel" && node["platform_version"].to_f >= 6.0 && node["platform_version"].to_f < 7.0
       end
 
-      # Determine if the current node is a rhel7 compatible build (RHEL, CentOS, Oracle or Scientific Linux)
+      # Determine if the current node is a rhel7 compatible build (Red Hat, CentOS, Oracle or Scientific Linux)
       #
       # @param [Chef::Node] node
       #
@@ -110,7 +108,7 @@ module ChefUtils
         node["platform_family"] == "rhel" && node["platform_version"].to_f >= 7.0 && node["platform_version"].to_f < 8.0
       end
 
-      # Determine if the current node is a rhel8 compatible build (RHEL, CentOS, Oracle or Scientific Linux)
+      # Determine if the current node is a rhel8 compatible build (Red Hat, CentOS, Oracle or Scientific Linux)
       #
       # @param [Chef::Node] node
       #
@@ -120,7 +118,7 @@ module ChefUtils
         node["platform_family"] == "rhel" && node["platform_version"].to_f >= 8.0 && node["platform_version"].to_f < 9.0
       end
 
-      # Determine if the current node is a member of the amazon family.
+      # Determine if the current node is a member of the 'amazon' platform family.
       #
       # @param [Chef::Node] node
       #
@@ -131,7 +129,7 @@ module ChefUtils
       end
       alias_method :amazon_linux?, :amazon?
 
-      # Determine if the current node is solaris2
+      # Determine if the current node is a member of the 'solaris2' platform family.
       #
       # @param [Chef::Node] node
       #
@@ -143,7 +141,7 @@ module ChefUtils
       # chef-sugar backcompat methods
       alias_method :solaris?, :solaris2?
 
-      # Determine if the current node is smartos
+      # Determine if the current node is a member of the 'smartos' platform family.
       #
       # @param [Chef::Node] node
       #
@@ -153,7 +151,7 @@ module ChefUtils
         node["platform_family"] == "smartos"
       end
 
-      # Determine if the current node is a member of the suse family.
+      # Determine if the current node is a member of the 'suse' platform family  (openSUSE, SLES, and SLED).
       #
       # @param [Chef::Node] node
       #
@@ -163,7 +161,7 @@ module ChefUtils
         node["platform_family"] == "suse"
       end
 
-      # Determine if the current node is a member of the gentoo family.
+      # Determine if the current node is a member of the 'gentoo' platform family.
       #
       # @param [Chef::Node] node
       #
@@ -173,7 +171,7 @@ module ChefUtils
         node["platform_family"] == "gentoo"
       end
 
-      # Determine if the current node is freebsd
+      # Determine if the current node is a member of the 'freebsd' platform family.
       #
       # @param [Chef::Node] node
       #
@@ -183,7 +181,7 @@ module ChefUtils
         node["platform_family"] == "freebsd"
       end
 
-      # Determine if the current node is openbsd
+      # Determine if the current node is a member of the 'openbsd' platform family.
       #
       # @param [Chef::Node] node
       #
@@ -193,7 +191,7 @@ module ChefUtils
         node["platform_family"] == "openbsd"
       end
 
-      # Determine if the current node is netbsd
+      # Determine if the current node is a member of the 'netbsd' platform family.
       #
       # @param [Chef::Node] node
       #
@@ -203,7 +201,7 @@ module ChefUtils
         node["platform_family"] == "netbsd"
       end
 
-      # Determine if the current node is dragonflybsd
+      # Determine if the current node is a member of the 'dragonflybsd' platform family.
       #
       # @param [Chef::Node] node
       #
@@ -213,7 +211,7 @@ module ChefUtils
         node["platform_family"] == "dragonflybsd"
       end
 
-      # Determine if the current node is a member of the windows family.
+      # Determine if the current node is a member of the 'windows' platform family.
       #
       # @param [Chef::Node] node
       #

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

@@ -0,0 +1,58 @@
+#
+# Copyright:: Copyright 2020, 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"
+
+module ChefUtils
+  module DSL
+    module Windows
+      include Internal
+
+      # Determine if the current node is Windows Server Core.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def windows_server_core?(node = __getnode)
+        node["kernel"]["server_core"] == true
+      end
+
+      # Determine if the current node is Windows Workstation
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def windows_workstation?(node = __getnode)
+        node["kernel"]["product_type"] == "Workstation"
+      end
+
+      # Determine if the current node is Windows Server
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def windows_server?(node = __getnode)
+        node["kernel"]["product_type"] == "Server"
+      end
+
+      extend self
+    end
+  end
+end

data/lib/chef-utils/version.rb

@@ -15,5 +15,5 @@
 
 module ChefUtils
   CHEFUTILS_ROOT = File.expand_path("../..", __FILE__)
-  VERSION = "15.6.10".freeze
+  VERSION = "15.7.30".freeze
 end

data/lib/chef-utils/version_string.rb

@@ -0,0 +1,143 @@
+# Copyright:: Copyright 2017, Noah Kantrowitz
+# 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 ChefUtils
+  # String-like object for version strings.
+  #
+  # @since 13.2
+  # @api internal
+  class VersionString < String
+    # Parsed version object for the string.
+    # @return [Gem::Version]
+    attr_reader :parsed_version
+
+    # Create a new VersionString from an input String.
+    #
+    # @param val [String] Version string to parse.
+    def initialize(val)
+      super
+      @parsed_version = ::Gem::Version.create(self)
+    end
+
+    # @!group Compat wrappers for String
+
+    # Compat wrapper for + to behave like a normal String.
+    #
+    # @param other [String]
+    # @return [String]
+    def +(other)
+      to_s + other
+    end
+
+    # Compat wrapper for * to behave like a normal String.
+    #
+    # @param other [Integer]
+    # @return [String]
+    def *(other)
+      to_s * other
+    end
+
+    # @!group Comparison operators
+
+    # Compare a VersionString to an object. If compared to another VersionString
+    # then sort like `Gem::Version`, otherwise try to treat the other object as
+    # a version but fall back to normal string comparison.
+    #
+    # @param other [Object]
+    # @return [Integer]
+    def <=>(other)
+      other_ver = case other
+                  when VersionString
+                    other.parsed_version
+                  else
+                    begin
+                      Gem::Version.create(other.to_s)
+                    rescue ArgumentError
+                      # Comparing to a string that isn't a version.
+                      return super
+                    end
+                  end
+      parsed_version <=> other_ver
+    end
+
+    # Compat wrapper for == based on <=>.
+    #
+    # @param other [Object]
+    # @return [Boolean]
+    def ==(other)
+      (self <=> other) == 0
+    end
+
+    # Compat wrapper for != based on <=>.
+    #
+    # @param other [Object]
+    # @return [Boolean]
+    def !=(other)
+      (self <=> other) != 0
+    end
+
+    # Compat wrapper for < based on <=>.
+    #
+    # @param other [Object]
+    # @return [Boolean]
+    def <(other)
+      (self <=> other) < 0
+    end
+
+    # Compat wrapper for <= based on <=>.
+    #
+    # @param other [Object]
+    # @return [Boolean]
+    def <=(other)
+      (self <=> other) < 1
+    end
+
+    # Compat wrapper for > based on <=>.
+    #
+    # @param other [Object]
+    # @return [Boolean]
+    def >(other)
+      (self <=> other) > 0
+    end
+
+    # Compat wrapper for >= based on <=>.
+    #
+    # @param other [Object]
+    # @return [Boolean]
+    def >=(other)
+      (self <=> other) > -1
+    end
+
+    # @!group Matching operators
+
+    # Matching operator to support checking against a requirement string.
+    #
+    # @param other [Regexp, String]
+    # @return [Boolean]
+    # @example Match against a Regexp
+    #   ChefUtils::VersionString.new('1.0.0') =~ /^1/
+    # @example Match against a requirement
+    #   ChefUtils::VersionString.new('1.0.0') =~ '~> 1.0'
+    def =~(other)
+      case other
+      when Regexp
+        super
+      else
+        Gem::Requirement.create(other) =~ parsed_version
+      end
+    end
+
+  end
+end

data/lib/chef-utils.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright 2015-2019, Chef Software Inc.
+# Copyright:: Copyright 2015-2020, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -24,6 +24,7 @@ require_relative "chef-utils/dsl/platform_family"
 require_relative "chef-utils/dsl/service"
 require_relative "chef-utils/dsl/train_helpers"
 require_relative "chef-utils/dsl/which"
+require_relative "chef-utils/dsl/windows"
 require_relative "chef-utils/mash"
 
 # This is the Chef Infra Client DSL, not everytihng needs to go in here
@@ -33,6 +34,7 @@ module ChefUtils
   include ChefUtils::DSL::PlatformFamily
   include ChefUtils::DSL::Platform
   include ChefUtils::DSL::Introspection
+  include ChefUtils::DSL::Windows
   # FIXME: include ChefUtils::DSL::Which in Chef 16.0
   # FIXME: include ChefUtils::DSL::PathSanity in Chef 16.0
   # FIXME: include ChefUtils::DSL::TrainHelpers in Chef 16.0

data/spec/spec_helper.rb

@@ -10,6 +10,7 @@ HELPER_MODULES = [
   ChefUtils::DSL::PlatformFamily,
   ChefUtils::DSL::Service,
   ChefUtils::DSL::Which,
+  ChefUtils::DSL::Windows,
 ].freeze
 
 ARCH_HELPERS = (ChefUtils::DSL::Architecture.methods - Module.methods).freeze
@@ -17,6 +18,7 @@ OS_HELPERS = (ChefUtils::DSL::OS.methods - Module.methods).freeze
 PLATFORM_HELPERS = (ChefUtils::DSL::Platform.methods - Module.methods).freeze
 PLATFORM_FAMILY_HELPERS = (ChefUtils::DSL::PlatformFamily.methods - Module.methods).freeze
 INTROSPECTION_HELPERS = (ChefUtils::DSL::Introspection.methods - Module.methods).freeze
+WINDOWS_HELPERS = (ChefUtils::DSL::Windows.methods - Module.methods).freeze
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|

data/spec/unit/dsl/windows_spec.rb

@@ -0,0 +1,63 @@
+#
+# Copyright:: Copyright 2020, 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"
+
+def windows_reports_true_for(*args)
+  args.each do |method|
+    it "reports true for #{method}" do
+      expect(described_class.send(method, node)).to be true
+    end
+  end
+  (WINDOWS_HELPERS - args).each do |method|
+    it "reports false for #{method}" do
+      expect(described_class.send(method, node)).to be false
+    end
+  end
+end
+
+RSpec.describe ChefUtils::DSL::Windows do
+  ( HELPER_MODULES - [ described_class ] ).each do |klass|
+    it "does not have methods that collide with #{klass}" do
+      expect((klass.methods - Module.methods) & WINDOWS_HELPERS).to be_empty
+    end
+  end
+
+  WINDOWS_HELPERS.each do |helper|
+    it "has the #{helper} in the ChefUtils module" do
+      expect(ChefUtils).to respond_to(helper)
+    end
+  end
+
+  context "on Windows Server Core" do
+    let(:node) { { "kernel" => { "server_core" => true } } }
+
+    windows_reports_true_for(:windows_server_core?)
+  end
+
+  context "on Windows Workstation" do
+    let(:node) { { "kernel" => { "product_type" => "Workstation" } } }
+
+    windows_reports_true_for(:windows_workstation?)
+  end
+
+  context "on Windows Server" do
+    let(:node) { { "kernel" => { "product_type" => "Server" } } }
+
+    windows_reports_true_for(:windows_server?)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-utils
 version: !ruby/object:Gem::Version
-  version: 15.6.10
+  version: 15.7.30
 platform: ruby
 authors:
 - Chef Software, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-10 00:00:00.000000000 Z
+date: 2020-01-23 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -30,9 +30,11 @@ files:
 - lib/chef-utils/dsl/service.rb
 - lib/chef-utils/dsl/train_helpers.rb
 - lib/chef-utils/dsl/which.rb
+- lib/chef-utils/dsl/windows.rb
 - lib/chef-utils/internal.rb
 - lib/chef-utils/mash.rb
 - lib/chef-utils/version.rb
+- lib/chef-utils/version_string.rb
 - spec/spec_helper.rb
 - spec/unit/dsl/architecture_spec.rb
 - spec/unit/dsl/dsl_spec.rb
@@ -43,6 +45,7 @@ files:
 - spec/unit/dsl/platform_spec.rb
 - spec/unit/dsl/service_spec.rb
 - spec/unit/dsl/which_spec.rb
+- spec/unit/dsl/windows_spec.rb
 - spec/unit/mash_spec.rb
 homepage: https://github.com/chef/chef/tree/master/chef-utils
 licenses: