chef-utils 15.7.32 → 15.11.8

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

@@ -0,0 +1,40 @@
+#
+# 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"
+
+module ChefUtils
+  module DSL
+    module PlatformVersion
+      include Internal
+
+      # Return the platform_version for the node. Acts like a String
+      # but also provides a mechanism for checking version constraints.
+      #
+      # @param [Chef::Node] node the node to check
+      # @since 15.8
+      #
+      # @return [ChefUtils::VersionString]
+      #
+      def platform_version(node = __getnode)
+        ChefUtils::VersionString.new(node["platform_version"])
+      end
+
+      extend self
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright 2018-2019, Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -28,6 +28,8 @@ module ChefUtils
 
       # Returns if debian's old rc.d manager is installed (not necessarily the primary init system).
       #
+      # @since 15.5
+      #
       # @return [Boolean]
       #
       def debianrcd?
@@ -36,6 +38,8 @@ module ChefUtils
 
       # Returns if debian's old invoke rc.d manager is installed (not necessarily the primary init system).
       #
+      # @since 15.5
+      #
       # @return [Boolean]
       #
       def invokercd?
@@ -44,6 +48,8 @@ module ChefUtils
 
       # Returns if upstart is installed (not necessarily the primary init system).
       #
+      # @since 15.5
+      #
       # @return [Boolean]
       #
       def upstart?
@@ -52,6 +58,8 @@ module ChefUtils
 
       # Returns if insserv is installed (not necessarily the primary init system).
       #
+      # @since 15.5
+      #
       # @return [Boolean]
       #
       def insserv?
@@ -60,12 +68,23 @@ module ChefUtils
 
       # Returns if redhat's init system is installed (not necessarily the primary init system).
       #
+      # @since 15.5
+      #
       # @return [Boolean]
       #
       def redhatrcd?
         file_exist?("/sbin/chkconfig")
       end
 
+      #
+      # Returns if a particular service exists for a particular service init system. Init systems may be :initd, :upstart, :etc_rcd, :xinetd, and :systemd. Example: service_script_exist?(:systemd, 'ntpd')
+      #
+      # @param [Symbol] type The type of init system. :initd, :upstart, :xinetd, :etc_rcd, or :systemd
+      # @param [String] script The name of the service
+      # @since 15.5
+      #
+      # @return [Boolean]
+      #
       def service_script_exist?(type, script)
         case type
         when :initd

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

@@ -1,5 +1,5 @@
-#--
-# Copyright:: Copyright 2019-2019, Chef Software Inc.
+#
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

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

@@ -0,0 +1,249 @@
+#
+# 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"
+
+module ChefUtils
+  module DSL
+    module Virtualization
+      include Internal
+
+      # Determine if the current node is a KVM guest.
+      #
+      # @param [Chef::Node] node
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #
+      def kvm?(node = __getnode)
+        node.dig("virtualization", "system") == "kvm" && node.dig("virtualization", "role") == "guest"
+      end
+
+      # Determine if the current node is a KVM host.
+      #
+      # @param [Chef::Node] node
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #
+      def kvm_host?(node = __getnode)
+        node.dig("virtualization", "system") == "kvm" && node.dig("virtualization", "role") == "host"
+      end
+
+      # Determine if the current node is running in a linux container.
+      #
+      # @param [Chef::Node] node
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #
+      def lxc?(node = __getnode)
+        node.dig("virtualization", "system") == "lxc" && node.dig("virtualization", "role") == "guest"
+      end
+
+      # Determine if the current node is a linux container host.
+      #
+      # @param [Chef::Node] node
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #
+      def lxc_host?(node = __getnode)
+        node.dig("virtualization", "system") == "lxc" && node.dig("virtualization", "role") == "host"
+      end
+
+      # Determine if the current node is running under Parallels Desktop.
+      #
+      # @param [Chef::Node] node
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #   true if the machine is currently running under Parallels Desktop, false
+      #   otherwise
+      #
+      def parallels?(node = __getnode)
+        node.dig("virtualization", "system") == "parallels" && node.dig("virtualization", "role") == "guest"
+      end
+
+      # Determine if the current node is a Parallels Desktop host.
+      #
+      # @param [Chef::Node] node
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #   true if the machine is currently running under Parallels Desktop, false
+      #   otherwise
+      #
+      def parallels_host?(node = __getnode)
+        node.dig("virtualization", "system") == "parallels" && node.dig("virtualization", "role") == "host"
+      end
+
+      # Determine if the current node is a VirtualBox guest.
+      #
+      # @param [Chef::Node] node
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #
+      def vbox?(node = __getnode)
+        node.dig("virtualization", "system") == "vbox" && node.dig("virtualization", "role") == "guest"
+      end
+
+      # Determine if the current node is a VirtualBox host.
+      #
+      # @param [Chef::Node] node
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #
+      def vbox_host?(node = __getnode)
+        node.dig("virtualization", "system") == "vbox" && node.dig("virtualization", "role") == "host"
+      end
+
+      # chef-sugar backcompat method
+      alias_method :virtualbox?, :vbox?
+
+      # Determine if the current node is a VMWare guest.
+      #
+      # @param [Chef::Node] node
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #
+      def vmware?(node = __getnode)
+        node.dig("virtualization", "system") == "vmware" && node.dig("virtualization", "role") == "guest"
+      end
+
+      # Determine if the current node is VMware host.
+      #
+      # @param [Chef::Node] node
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #
+      def vmware_host?(node = __getnode)
+        node.dig("virtualization", "system") == "vmware" && node.dig("virtualization", "role") == "host"
+      end
+
+      # Determine if the current node is an openvz guest.
+      #
+      # @param [Chef::Node] node
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #
+      def openvz?(node = __getnode)
+        node.dig("virtualization", "system") == "openvz" && node.dig("virtualization", "role") == "guest"
+      end
+
+      # Determine if the current node is an openvz host.
+      #
+      # @param [Chef::Node] node
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #
+      def openvz_host?(node = __getnode)
+        node.dig("virtualization", "system") == "openvz" && node.dig("virtualization", "role") == "host"
+      end
+
+      # Determine if the current node is running under any virutalization environment
+      #
+      # @param [Chef::Node] node
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #
+      def guest?(node = __getnode)
+        node.dig("virtualization", "role") == "guest"
+      end
+
+      # chef-sugar backcompat method
+      alias_method :virtual?, :guest?
+
+      # Determine if the current node supports running guests under any virtualization environment
+      #
+      # @param [Chef::Node] node
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #
+      def hypervisor?(node = __getnode)
+        node.dig("virtualization", "role") == "host"
+      end
+
+      # Determine if the current node is NOT running under any virtualization environment (bare-metal or hypervisor on metal)
+      #
+      # @param [Chef::Node] node
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #
+      def physical?(node = __getnode)
+        !virtual?(node)
+      end
+
+      # Determine if the current node is running as a vagrant guest.
+      #
+      # Note that this API is equivalent to just looking for the vagrant user or the
+      # vagrantup.com domain in the hostname, which is the best API we have.
+      #
+      # @param [Chef::Node] node
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #   true if the machine is currently running vagrant, false
+      #   otherwise
+      #
+      def vagrant?(node = __getnode)
+        vagrant_key?(node) || vagrant_domain?(node) || vagrant_user?(node)
+      end
+
+      private
+
+      # Check if the +vagrant+ key exists on the +node+ object. This key is no
+      # longer populated by vagrant, but it is kept around for legacy purposes.
+      #
+      # @param (see vagrant?)
+      # @return (see vagrant?)
+      #
+      def vagrant_key?(node = __getnode)
+        node.key?("vagrant")
+      end
+
+      # Check if "vagrantup.com" is included in the node's domain.
+      #
+      # @param (see vagrant?)
+      # @return (see vagrant?)
+      #
+      def vagrant_domain?(node = __getnode)
+        node.key?("domain") && !node["domain"].nil? && node["domain"].include?("vagrantup.com")
+      end
+
+      # Check if the system contains a +vagrant+ user.
+      #
+      # @param (see vagrant?)
+      # @return (see vagrant?)
+      #
+      def vagrant_user?(node = __getnode)
+        !!(Etc.getpwnam("vagrant") rescue nil)
+      end
+
+      extend self
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright 2018-2019, Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

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

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright 2020, Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -20,11 +20,14 @@ require_relative "../internal"
 module ChefUtils
   module DSL
     module Windows
+      require "chef-utils/version_string"
+
       include Internal
 
       # Determine if the current node is Windows Server Core.
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.7
       #
       # @return [Boolean]
       #
@@ -32,9 +35,10 @@ module ChefUtils
         node["kernel"]["server_core"] == true
       end
 
-      # Determine if the current node is Windows Workstation
+      # Determine if the current node is Windows Workstation.
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.7
       #
       # @return [Boolean]
       #
@@ -42,9 +46,10 @@ module ChefUtils
         node["kernel"]["product_type"] == "Workstation"
       end
 
-      # Determine if the current node is Windows Server
+      # Determine if the current node is Windows Server.
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.7
       #
       # @return [Boolean]
       #
@@ -52,6 +57,28 @@ module ChefUtils
         node["kernel"]["product_type"] == "Server"
       end
 
+      # Determine the current Windows NT version. The NT version often differs from the marketing version, but offers a good way to find desktop and server releases that are based on the same codebase. IE: NT 6.3 is Windows 8.1 and Windows 2012 R2.
+      #
+      # @param [Chef::Node] node the node to check
+      # @since 15.8
+      #
+      # @return [ChefUtils::VersionString]
+      #
+      def windows_nt_version(node = __getnode)
+        ChefUtils::VersionString.new(node["os_version"])
+      end
+
+      # Determine the installed version of PowerShell.
+      #
+      # @param [Chef::Node] node the node to check
+      # @since 15.8
+      #
+      # @return [ChefUtils::VersionString]
+      #
+      def powershell_version(node = __getnode)
+        ChefUtils::VersionString.new(node["languages"]["powershell"]["version"])
+      end
+
       extend self
     end
   end

data/lib/chef-utils/internal.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright 2018-2019, Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");