chef-utils 15.8.23 → 15.12.22

data/lib/chef-utils/dsl/platform_family.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");
@@ -24,7 +24,8 @@ module ChefUtils
 
       # Determine if the current node is a member of the 'arch' family.
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -36,7 +37,8 @@ module ChefUtils
 
       # Determine if the current node is a member of the 'aix' platform family.
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -46,7 +48,8 @@ module ChefUtils
 
       # Determine if the current node is a member of the 'debian' platform family (Debian, Ubuntu and derivatives).
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -54,9 +57,10 @@ module ChefUtils
         node["platform_family"] == "debian"
       end
 
-      # Determine if the current node is a member of the 'fedora' platform family (Fedora and Arist).
+      # Determine if the current node is a member of the 'fedora' platform family (Fedora and Arista).
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -66,7 +70,8 @@ module ChefUtils
 
       # Determine if the current node is a member of the 'mac_os_x' platform family.
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -82,7 +87,8 @@ module ChefUtils
 
       # 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
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -94,7 +100,8 @@ module ChefUtils
 
       # Determine if the current node is a rhel6 compatible build (Red Hat, CentOS, Oracle or Scientific Linux).
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -104,7 +111,8 @@ module ChefUtils
 
       # Determine if the current node is a rhel7 compatible build (Red Hat, CentOS, Oracle or Scientific Linux).
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -114,7 +122,8 @@ module ChefUtils
 
       # Determine if the current node is a rhel8 compatible build (Red Hat, CentOS, Oracle or Scientific Linux).
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -124,7 +133,8 @@ module ChefUtils
 
       # Determine if the current node is a member of the 'amazon' platform family.
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -136,7 +146,8 @@ module ChefUtils
 
       # Determine if the current node is a member of the 'solaris2' platform family.
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -148,7 +159,8 @@ module ChefUtils
 
       # Determine if the current node is a member of the 'smartos' platform family.
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -156,9 +168,10 @@ module ChefUtils
         node["platform_family"] == "smartos"
       end
 
-      # Determine if the current node is a member of the 'suse' platform family  (openSUSE, SLES, and SLED).
+      # Determine if the current node is a member of the 'suse' platform family (openSUSE, SLES, and SLED).
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -168,7 +181,8 @@ module ChefUtils
 
       # Determine if the current node is a member of the 'gentoo' platform family.
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -178,7 +192,8 @@ module ChefUtils
 
       # Determine if the current node is a member of the 'freebsd' platform family.
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -188,7 +203,8 @@ module ChefUtils
 
       # Determine if the current node is a member of the 'openbsd' platform family.
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -198,7 +214,8 @@ module ChefUtils
 
       # Determine if the current node is a member of the 'netbsd' platform family.
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -208,7 +225,8 @@ module ChefUtils
 
       # Determine if the current node is a member of the 'dragonflybsd' platform family.
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -218,7 +236,8 @@ module ChefUtils
 
       # Determine if the current node is a member of the 'windows' platform family.
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -236,8 +255,10 @@ module ChefUtils
         node ? node["platform_family"] == "windows" : windows_ruby?
       end
 
-      # Determine if the ruby VM is currently running on a windows node (chefspec can never stub
-      # this behavior, so this is useful for code which can never be parsed on a non-windows box).
+      # Determine if the Ruby VM is currently running on a Windows node (ChefSpec can never stub
+      # this behavior, so this is useful for code which can never be parsed on a non-Windows box).
+      #
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -257,7 +278,8 @@ module ChefUtils
       # less useful since in no way can AIX trace its lineage back to old redhat distros.  This is most useful for
       # "smells like redhat, including SuSE".
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -265,11 +287,12 @@ module ChefUtils
         fedora_derived?(node) || node["platform_family"] == "suse"
       end
 
-      # RPM-based distros which are not SuSE and are very loosely similar to fedora, using yum or dnf.  The historical
-      # lineage of the distro should have forked off from old redhat fedora distros at some point.  Currently rhel,
-      # fedora and amazon.  This is most useful for "smells like redhat, but isn't SuSE".
+      # RPM-based distros which are not SuSE and are very loosely similar to fedora, using yum or dnf. The historical
+      # lineage of the distro should have forked off from old redhat fedora distros at some point. Currently rhel,
+      # fedora and amazon. This is most useful for "smells like redhat, but isn't SuSE".
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -277,10 +300,11 @@ module ChefUtils
         redhat_based?(node) || node["platform_family"] == "amazon"
       end
 
-      # RedHat distros -- fedora and rhel platform_families, nothing else.  This is most likely not as useful as the
-      # "fedora_dervied?" helper.
+      # RedHat distros -- fedora and rhel platform_families, nothing else. This is most likely not as useful as the
+      # "fedora_derived?" helper.
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -290,7 +314,8 @@ module ChefUtils
 
       # All of the Solaris-lineage.
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -300,9 +325,10 @@ module ChefUtils
 
       # All of the BSD-lineage.
       #
-      # Note that MacOSX is not included since Mac deviates so significantly from BSD that including it would not be useful.
+      # Note that macOS is not included since macOS deviates so significantly from BSD that including it would not be useful.
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #

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

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright 2018-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");

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,6 +68,8 @@ module ChefUtils
 
       # Returns if redhat's init system is installed (not necessarily the primary init system).
       #
+      # @since 15.5
+      #
       # @return [Boolean]
       #
       def redhatrcd?

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

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright 2018-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");
@@ -161,7 +161,7 @@ module ChefUtils
         node.dig("virtualization", "system") == "openvz" && node.dig("virtualization", "role") == "host"
       end
 
-      # Determine if the current node is running under any virutalization environment
+      # Determine if the current node is running under any virtualization environment
       #
       # @param [Chef::Node] node
       # @since 15.8

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");
@@ -25,7 +25,7 @@ module ChefUtils
       # Lookup an executable through the systems search PATH.  Allows specifying an array
       # of executables to look for.  The first executable that is found, along any path entry,
       # will be the preferred one and returned first.  The extra_path will override any default
-      # extra_paths which are added (allwing the user to pass an empty array to remove them).
+      # extra_paths which are added (allowing the user to pass an empty array to remove them).
       #
       # When passed a block the block will be called with the full pathname of any executables
       # which are found, and the block should return truthy or falsey values to further filter
@@ -34,7 +34,7 @@ module ChefUtils
       # This is syntactic sugar for `where(...).first`
       #
       # This helper can be used in target mode in chef or with train using the appropriate
-      # wiring extenerally.
+      # wiring externally.
       #
       # @example Find the most appropriate python executable, searching through the system PATH
       #          plus additionally the "/usr/libexec" directory, which has the dnf libraries
@@ -55,14 +55,14 @@ module ChefUtils
       # Lookup all the instances of an an executable that can be found through the systems search PATH.
       # Allows specifying an array of executables to look for.  All the instances of the first executable
       # that is found will be returned first.  The extra_path will override any default extra_paths
-      # which are added (allwing the user to pass an empty array to remove them).
+      # which are added (allowing the user to pass an empty array to remove them).
       #
       # When passed a block the block will be called with the full pathname of any executables
       # which are found, and the block should return truthy or falsey values to further filter
       # the executable based on arbitrary criteria.
       #
       # This helper can be used in target mode in chef or with train using the appropriate
-      # wiring extenerally.
+      # wiring externally.
       #
       # @example Find all the python executables, searching through the system PATH plus additionally
       #          the "/usr/libexec" directory, which have the dnf libraries installed and available.

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");
@@ -26,7 +26,8 @@ module ChefUtils
 
       # 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]
       #
@@ -34,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]
       #
@@ -44,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]
       #
@@ -56,7 +59,8 @@ module ChefUtils
 
       # 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
+      # @param [Chef::Node] node the node to check
+      # @since 15.8
       #
       # @return [ChefUtils::VersionString]
       #
@@ -64,9 +68,10 @@ module ChefUtils
         ChefUtils::VersionString.new(node["os_version"])
       end
 
-      # Determine the installed version of PowerShell
+      # Determine the installed version of PowerShell.
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.8
       #
       # @return [ChefUtils::VersionString]
       #