chef-utils 15.7.32 → 15.11.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74f53da2880ca1ca796c9cc0d52a3315d99a790120c4996c2b99be6e1cdfd2b9
-  data.tar.gz: 91b7a00a02f44d22f174b0655d1431285f16bfff862a3942984767ccf2c9b299
+  metadata.gz: a926b8a7f54e03d457db79b651d0be61ec103c51c3910fe480d449ab550571ba
+  data.tar.gz: 9189b342fec5fe66f1e4a8b847139203c1cfdd8fc9c2cfe370bf436609808c81
 SHA512:
-  metadata.gz: 8c11c164763c9f57713ca5d238e0d0c44d13922d07662200be62569bc00a97bb9b11af9bcf825f3feda89b0cdfb09bc16146817a9dc6a345f99bd3e3f0f275e7
-  data.tar.gz: 1a209177fb2bedf3760507bd7e2cc78845e9d21738dc54e6505d91671bbb3dafc3ef3920381dd3b52a61a0232bbe2325d03181a730b5a04a861baeabd4b080dc
+  metadata.gz: cf7a1a3174a9e5b7a914d85df41792a5ac7a148206a86fe919d213d1947082252aeacff37667a1d504491dbb44d39b84a732637aabe919cfd9857bc24a882999
+  data.tar.gz: 011d32fc1d2efd8e5affd4fd48ca1c0484975fcad34e2e3f5eab8bd11aebbb9287f9f5c5238a5e531bf8e341a34e1c4b805482573c80acb272536644f5155574

data/lib/chef-utils.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright 2015-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");
@@ -16,24 +16,31 @@
 #
 
 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/path_sanity"
 require_relative "chef-utils/dsl/platform"
 require_relative "chef-utils/dsl/platform_family"
+require_relative "chef-utils/dsl/platform_version"
 require_relative "chef-utils/dsl/service"
 require_relative "chef-utils/dsl/train_helpers"
+require_relative "chef-utils/dsl/virtualization"
 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
+# This is the Chef Infra Client DSL, not everything needs to go in here
 module ChefUtils
   include ChefUtils::DSL::Architecture
+  include ChefUtils::DSL::Cloud
+  include ChefUtils::DSL::Introspection
   include ChefUtils::DSL::OS
-  include ChefUtils::DSL::PlatformFamily
   include ChefUtils::DSL::Platform
-  include ChefUtils::DSL::Introspection
+  include ChefUtils::DSL::PlatformFamily
+  include ChefUtils::DSL::PlatformVersion
+  include ChefUtils::DSL::TrainHelpers
+  include ChefUtils::DSL::Virtualization
   include ChefUtils::DSL::Windows
   # FIXME: include ChefUtils::DSL::Which in Chef 16.0
   # FIXME: include ChefUtils::DSL::PathSanity in Chef 16.0

data/lib/chef-utils/dsl/architecture.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");
@@ -22,7 +22,9 @@ module ChefUtils
     module Architecture
       include Internal
 
-      # Determine if the current architecture is 64-bit
+      # Determine if the current architecture is 64-bit.
+      #
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -31,7 +33,9 @@ module ChefUtils
           .include?(node["kernel"]["machine"])
       end
 
-      # Determine if the current architecture is 32-bit
+      # Determine if the current architecture is 32-bit.
+      #
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -39,7 +43,9 @@ module ChefUtils
         !_64_bit?(node)
       end
 
-      # Determine if the current architecture is i386
+      # Determine if the current architecture is i386.
+      #
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -49,6 +55,8 @@ module ChefUtils
 
       # Determine if the current architecture is Intel.
       #
+      # @since 15.5
+      #
       # @return [Boolean]
       #
       def intel?(node = __getnode)
@@ -57,13 +65,17 @@ module ChefUtils
 
       # Determine if the current architecture is SPARC.
       #
+      # @since 15.5
+      #
       # @return [Boolean]
       #
       def sparc?(node = __getnode)
         %w{sun4u sun4v}.include?(node["kernel"]["machine"])
       end
 
-      # Determine if the current architecture is PowerPC 64bit Big Endian
+      # Determine if the current architecture is PowerPC 64bit Big Endian.
+      #
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -71,7 +83,9 @@ module ChefUtils
         %w{ppc64}.include?(node["kernel"]["machine"])
       end
 
-      # Determine if the current architecture is PowerPC 64bit Little Endian
+      # Determine if the current architecture is PowerPC 64bit Little Endian.
+      #
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -81,21 +95,37 @@ module ChefUtils
 
       # Determine if the current architecture is PowerPC.
       #
+      # @since 15.5
+      #
       # @return [Boolean]
       #
       def powerpc?(node = __getnode)
         %w{powerpc}.include?(node["kernel"]["machine"])
       end
 
-      # Determine if the current architecture is 32-bit ARM
+      # Determine if the current architecture is arm
+      #
+      # @since 15.10
+      #
+      # @return [Boolean]
+      #
+      def arm?(node = __getnode)
+        %w{armv6l armv7l armhf aarch64 arm64 arch64}.include?(node["kernel"]["machine"])
+      end
+
+      # Determine if the current architecture is 32-bit ARM hard float.
+      #
+      # @since 15.5
       #
       # @return [Boolean]
       #
       def armhf?(node = __getnode)
-        %w{armhf}.include?(node["kernel"]["machine"])
+        %w{armv6l armv7l armhf}.include?(node["kernel"]["machine"])
       end
 
-      # Determine if the current architecture is s390x
+      # Determine if the current architecture is s390x.
+      #
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -103,7 +133,9 @@ module ChefUtils
         %w{s390x}.include?(node["kernel"]["machine"])
       end
 
-      # Determine if the current architecture is s390
+      # Determine if the current architecture is s390.
+      #
+      # @since 15.5
       #
       # @return [Boolean]
       #

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

@@ -0,0 +1,143 @@
+#
+# 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 Cloud
+      include Internal
+
+      # Determine if the current node is "in the cloud".
+      #
+      # @param [Chef::Node] node the node to check
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #
+      def cloud?(node = __getnode)
+        # cloud is always present, but nil if not on a cloud
+        !node["cloud"].nil?
+      end
+
+      # Return true if the current current node is in EC2.
+      #
+      # @param [Chef::Node] node the node to check
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #
+      def ec2?(node = __getnode)
+        node.key?("ec2")
+      end
+
+      # Return true if the current current node is in GCE.
+      #
+      # @param [Chef::Node] node the node to check
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #
+      def gce?(node = __getnode)
+        node.key?("gce")
+      end
+
+      # Return true if the current current node is in Rackspace.
+      #
+      # @param [Chef::Node] node the node to check
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #
+      def rackspace?(node = __getnode)
+        node.key?("rackspace")
+      end
+
+      # Return true if the current current node is in Eucalyptus.
+      #
+      # @param [Chef::Node] node the node to check
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #
+      def eucalyptus?(node = __getnode)
+        node.key?("eucalyptus")
+      end
+      # chef-sugar backcompat method
+      alias_method :euca?, :eucalyptus?
+
+      # Return true if the current current node is in Linode.
+      #
+      # @param [Chef::Node] node the node to check
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #
+      def linode?(node = __getnode)
+        node.key?("linode")
+      end
+
+      # Return true if the current current node is in OpenStack.
+      #
+      # @param [Chef::Node] node the node to check
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #
+      def openstack?(node = __getnode)
+        node.key?("openstack")
+      end
+
+      # Return true if the current current node is in Azure.
+      #
+      # @param [Chef::Node] node the node to check
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #
+      def azure?(node = __getnode)
+        node.key?("azure")
+      end
+
+      # Return true if the current current node is in DigitalOcean.
+      #
+      # @param [Chef::Node] node the node to check
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #
+      def digital_ocean?(node = __getnode)
+        node.key?("digital_ocean")
+      end
+      # chef-sugar backcompat method
+      alias_method :digitalocean?, :digital_ocean?
+
+      # Return true if the current current node is in SoftLayer.
+      #
+      # @param [Chef::Node] node the node to check
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #
+      def softlayer?(node = __getnode)
+        node.key?("softlayer")
+      end
+
+      extend self
+    end
+  end
+end

data/lib/chef-utils/dsl/introspection.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");
@@ -30,7 +30,8 @@ module ChefUtils
 
       # Determine if the node is a docker container.
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -42,7 +43,8 @@ module ChefUtils
 
       # Determine if the node uses the systemd init system.
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -52,7 +54,8 @@ module ChefUtils
 
       # Determine if the node is running in Test Kitchen.
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -62,7 +65,8 @@ module ChefUtils
 
       # Determine if the node is running in a CI system that sets the CI env var.
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -73,6 +77,7 @@ module ChefUtils
       # Determine if the a systemd service unit is present on the system.
       #
       # @param [String] svc_name
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -87,6 +92,7 @@ module ChefUtils
       # Determine if the a systemd unit of any type is present on the system.
       #
       # @param [String] svc_name
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -97,6 +103,19 @@ module ChefUtils
         end
       end
 
+      # Determine if the current node includes the given recipe name.
+      #
+      # @param [String] recipe_name
+      # @since 15.8
+      #
+      # @return [Boolean]
+      #
+      def includes_recipe?(recipe_name, node = __getnode)
+        node.recipe?(recipe_name)
+      end
+      # chef-sugar backcompat method
+      alias_method :include_recipe?, :includes_recipe?
+
       extend self
     end
   end

data/lib/chef-utils/dsl/os.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");
@@ -29,9 +29,10 @@ module ChefUtils
       # only the platform helper should be added.
       #
 
-      # Determine if the current node is linux.
+      # Determine if the current node is Linux.
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #
@@ -39,9 +40,10 @@ module ChefUtils
         node["os"] == "linux"
       end
 
-      # Determine if the current node is darwin.
+      # Determine if the current node is Darwin.
       #
-      # @param [Chef::Node] node
+      # @param [Chef::Node] node the node to check
+      # @since 15.5
       #
       # @return [Boolean]
       #

data/lib/chef-utils/dsl/path_sanity.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");
@@ -23,6 +23,7 @@ module ChefUtils
     module PathSanity
       include Internal
 
+      # @since 15.5
       def sanitized_path(env = nil)
         env_path = env ? env["PATH"] : __env_path
         env_path = "" if env_path.nil?