chef-utils 0.0.1 → 15.5.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d24b5af451ff85da3c24ed21d9d8d4719952c363a04c0e2256b3d2ec20331ec5
-  data.tar.gz: f3657404413ddaa19753f0426897f78f9400e2eab85b7a576b77fd8b87b49424
+  metadata.gz: b52b97bdb973d51382ed8a0594fb95f8be34727380d03d2a5929b3beb3156364
+  data.tar.gz: ae37e164b4891c0fdd66c5e90a75813906b2c70311b0ceff6ca3f505f83412d3
 SHA512:
-  metadata.gz: 1aea2d3445fd00f009ea1fe6093bfcbe4d8b9f2b20b68aa986ea39152f18631daee4a8b59b3ff92e7f63d599073d68e11361a6d401ff76ba8603118c364a3749
-  data.tar.gz: 950ad3d80a9dab08ff42add5da97499d99e3d80d4e0f5bb2312344215480b3191f868f47e76c13ff70ce9125804a50ccd77c21e250ffd5b29e7b677d6ed49c60
+  metadata.gz: 68a6d7ea11a8f15d308748723cd2376ac01f1dc90c713fdf9735cc57d83f59a725e6e2a4b0747b20f659a5ea2f39df91f36a0720aa908a798ac7f003000b4ea1
+  data.tar.gz: bb88ff0308fb16377e49de5c1a63bb4b6341bec4fa26eb9674ef17476b3a88f3080c7622eab48beb4bd5aa206a61d2ad852093664ae3b50ee9f1723e3f0d7931

data/chef-utils.gemspec

@@ -6,13 +6,21 @@ require "chef-utils/version"
 Gem::Specification.new do |spec|
   spec.name          = "chef-utils"
   spec.version       = ChefUtils::VERSION
-  spec.authors       = ["Adam Jacob"]
-  spec.email         = ["adam@chef.io"]
+  spec.authors       = ["Chef Software, Inc"]
+  spec.email         = ["oss@chef.io"]
 
   spec.summary       = %q{Basic utility functions for Core Chef development}
-  spec.homepage      = "https://github.com/chef/chef"
+  spec.homepage      = "https://github.com/chef/chef/tree/master/chef-utils"
   spec.license       = "Apache-2.0"
 
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/chef/chef/issues",
+    "changelog_uri" => "https://github.com/chef/chef/CHANGELOG.md",
+    "documentation_uri" => "https://github.com/chef/chef/tree/master/chef-utils/README.md",
+    "homepage_uri" => "https://github.com/chef/chef/tree/master/chef-utils",
+    "source_code_uri" => "https://github.com/chef/chef/tree/master/chef-utils",
+  }
+
   spec.require_paths = ["lib"]
 
   #

data/lib/chef-utils.rb

@@ -0,0 +1,43 @@
+#
+# Copyright:: Copyright 2015-2019, 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 "chef-utils/dsl/architecture"
+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/service"
+require_relative "chef-utils/dsl/train_helpers"
+require_relative "chef-utils/dsl/which"
+require_relative "chef-utils/mash"
+
+# This is the Chef Infra Client DSL, not everytihng needs to go in here
+module ChefUtils
+  include ChefUtils::DSL::Architecture
+  include ChefUtils::DSL::OS
+  include ChefUtils::DSL::PlatformFamily
+  include ChefUtils::DSL::Platform
+  include ChefUtils::DSL::Introspection
+  # 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
+  # ChefUtils::DSL::Service is deliberately excluded
+
+  CANARY = 1 # used as a guard for requires
+  extend self
+end

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

@@ -0,0 +1,117 @@
+#
+# Copyright:: Copyright 2018-2019, 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 Architecture
+      include Internal
+
+      # Determine if the current architecture is 64-bit
+      #
+      # @return [Boolean]
+      #
+      def _64_bit?(node = __getnode)
+        %w{amd64 x86_64 ppc64 ppc64le s390x ia64 sparc64 aarch64 arch64 arm64 sun4v sun4u}
+          .include?(node["kernel"]["machine"])
+      end
+
+      # Determine if the current architecture is 32-bit
+      #
+      # @return [Boolean]
+      #
+      def _32_bit?(node = __getnode)
+        !_64_bit?(node)
+      end
+
+      # Determine if the current architecture is i386
+      #
+      # @return [Boolean]
+      #
+      def i386?(node = __getnode)
+        _32_bit?(node) && intel?(node)
+      end
+
+      # Determine if the current architecture is Intel.
+      #
+      # @return [Boolean]
+      #
+      def intel?(node = __getnode)
+        %w{i86pc i386 x86_64 amd64 i686}.include?(node["kernel"]["machine"])
+      end
+
+      # Determine if the current architecture is SPARC.
+      #
+      # @return [Boolean]
+      #
+      def sparc?(node = __getnode)
+        %w{sun4u sun4v}.include?(node["kernel"]["machine"])
+      end
+
+      # Determine if the current architecture is Powerpc64 Big Endian
+      #
+      # @return [Boolean]
+      #
+      def ppc64?(node = __getnode)
+        %w{ppc64}.include?(node["kernel"]["machine"])
+      end
+
+      # Determine if the current architecture is Powerpc64 Little Endian
+      #
+      # @return [Boolean]
+      #
+      def ppc64le?(node = __getnode)
+        %w{ppc64le}.include?(node["kernel"]["machine"])
+      end
+
+      # Determine if the current architecture is PowerPC.
+      #
+      # @return [Boolean]
+      #
+      def powerpc?(node = __getnode)
+        %w{powerpc}.include?(node["kernel"]["machine"])
+      end
+
+      # Determine if the current architecture is 32-bit ARM
+      #
+      # @return [Boolean]
+      #
+      def armhf?(node = __getnode)
+        %w{armhf}.include?(node["kernel"]["machine"])
+      end
+
+      # Determine if the current architecture is s390x
+      #
+      # @return [Boolean]
+      #
+      def s390x?(node = __getnode)
+        %w{s390x}.include?(node["kernel"]["machine"])
+      end
+
+      # Determine if the current architecture is s390
+      #
+      # @return [Boolean]
+      #
+      def s390?(node = __getnode)
+        %w{s390}.include?(node["kernel"]["machine"])
+      end
+
+      extend self
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+#
+# Copyright:: Copyright 2018-2019, 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 "train_helpers"
+
+module ChefUtils
+  module DSL
+    # This is for "introspection" helpers in the sense that we are inspecting the
+    # actual server or image under management to determine running state (duck-typing the system).
+    # The helpers here may use the node object state from ohai, but typically not the big 5:  platform,
+    # platform_family, platform_version, arch, os.  The helpers here should infer somewhat
+    # higher level facts about the system.
+    #
+    module Introspection
+      include TrainHelpers
+
+      # Returns whether the node is a docker container.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def docker?(node = __getnode)
+        # Using "File.exist?('/.dockerinit') || File.exist?('/.dockerenv')" makes Travis sad,
+        # and that makes us sad too.
+        !!(node && node.read("virtualization", "systems", "docker") == "guest")
+      end
+
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def systemd?(node = __getnode)
+        file_exist?("/proc/1/comm") && file_open("/proc/1/comm").gets.chomp == "systemd"
+      end
+
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def kitchen?(node = __getnode)
+        ENV.key?("TEST_KITCHEN")
+      end
+
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def ci?(node = __getnode)
+        ENV.key?("CI")
+      end
+
+      # @param [String] svc_name
+      #
+      # @return [Boolean]
+      #
+      def has_systemd_service_unit?(svc_name)
+        %w{ /etc /usr/lib /lib /run }.any? do |load_path|
+          file_exist?(
+            "#{load_path}/systemd/system/#{svc_name.gsub(/@.*$/, "@")}.service"
+          )
+        end
+      end
+
+      # @param [String] svc_name
+      #
+      # @return [Boolean]
+      #
+      def has_systemd_unit?(svc_name)
+        # TODO: stop supporting non-service units with service resource
+        %w{ /etc /usr/lib /lib /run }.any? do |load_path|
+          file_exist?("#{load_path}/systemd/system/#{svc_name}")
+        end
+      end
+
+      extend self
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+#
+# Copyright:: Copyright 2018-2019, 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 OS
+      include Internal
+
+      #
+      # NOTE CAREFULLY: Most node['os'] values should not appear in this file at all.
+      #
+      # For cases where node['os'] == node['platform_family'] == node['platform'] then
+      # only the platform helper should be added.
+      #
+
+      # Determine if the current node is linux.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def linux?(node = __getnode)
+        node["os"] == "linux"
+      end
+
+      # Determine if the current node is darwin.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def darwin?(node = __getnode)
+        node["os"] == "darwin"
+      end
+
+      extend self
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+#
+# Copyright:: Copyright 2018-2019, 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 PathSanity
+      include Internal
+
+      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)
+      end
+
+      class << self
+        def sane_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
+      end
+
+      extend self
+    end
+  end
+end

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

@@ -0,0 +1,339 @@
+#
+# Copyright:: Copyright 2018-2019, 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 Platform
+      include Internal
+
+      # NOTE: if you are adding new platform helpers they should all have the `_platform?` suffix.
+      #       DO NOT add new short aliases without the suffix (they will be deprecated in the future)
+      #       aliases here are mostly for backwards compatibility with chef-sugar and new ones are DISCOURAGED.
+      #       generally there should be one obviously correct way to do things.
+
+      # Determine if the current node is linux mint.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def linuxmint?(node = __getnode)
+        node["platform"] == "linuxmint"
+      end
+      # chef-sugar backcompat methods
+      alias_method :mint?, :linuxmint?
+      alias_method :linux_mint?, :linuxmint?
+      alias_method :linuxmint_platform?, :linuxmint?
+
+      # Determine if the current node is ubuntu.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def ubuntu?(node = __getnode)
+        node["platform"] == "ubuntu"
+      end
+      alias_method :ubuntu_platform?, :ubuntu?
+
+      # Determine if the current node is raspbian.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def raspbian?(node = __getnode)
+        node["platform"] == "raspbian"
+      end
+      alias_method :raspbian_platform?, :raspbian?
+
+      # Determine if the current node is debian.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def debian_platform?(node = __getnode)
+        node["platform"] == "debian"
+      end
+
+      # Determine if the current node is amazon linux.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def amazon_platform?(node = __getnode)
+        node["platform"] == "amazon"
+      end
+
+      # Determine if the current node is redhat enterprise.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def redhat?(node = __getnode)
+        node["platform"] == "redhat"
+      end
+      # chef-sugar backcompat methods
+      alias_method :redhat_enterprise?, :redhat?
+      alias_method :redhat_enterprise_linux?, :redhat?
+      alias_method :redhat_platform?, :redhat?
+
+      # Determine if the current node is centos.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def centos?(node = __getnode)
+        node["platform"] == "centos"
+      end
+      alias_method :centos_platform?, :centos?
+
+      # Determine if the current node is oracle linux.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def oracle?(node = __getnode)
+        node["platform"] == "oracle"
+      end
+      # chef-sugar backcompat methods
+      alias_method :oracle_linux?, :oracle?
+      alias_method :oracle_platform?, :oracle?
+
+      # Determine if the current node is scientific linux.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def scientific?(node = __getnode)
+        node["platform"] == "scientific"
+      end
+      # chef-sugar backcompat methods
+      alias_method :scientific_linux?, :scientific?
+      alias_method :scientific_platform?, :scientific?
+
+      # Determine if the current node is clearos.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def clearos?(node = __getnode)
+        node["platform"] == "clearos"
+      end
+      alias_method :clearos_platform?, :clearos?
+
+      # Determine if the current node is fedora.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def fedora_platform?(node = __getnode)
+        node["platform"] == "fedora"
+      end
+
+      # Determine if the current node is arch
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def arch_platform?(node = __getnode)
+        node["platform"] == "arch"
+      end
+
+      # Determine if the current node is solaris2
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def solaris2_platform?(node = __getnode)
+        node["platform"] == "solaris2"
+      end
+
+      # Determine if the current node is smartos
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def smartos_platform?(node = __getnode)
+        node["platform"] == "smartos"
+      end
+
+      # Determine if the current node is omnios
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def omnios?(node = __getnode)
+        node["platform"] == "omnios"
+      end
+      alias_method :omnios_platform?, :omnios?
+
+      # Determine if the current node is openindiana
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def openindiana?(node = __getnode)
+        node["platform"] == "openindiana"
+      end
+      alias_method :openindiana_platform?, :openindiana?
+
+      # Determine if the current node is nexentacore
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def nexentacore?(node = __getnode)
+        node["platform"] == "nexentacore"
+      end
+      alias_method :nexentacore_platform?, :nexentacore?
+
+      # Determine if the current node is aix
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def aix_platform?(node = __getnode)
+        node["platform"] == "aix"
+      end
+
+      # Determine if the current node is freebsd
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def freebsd_platform?(node = __getnode)
+        node["platform"] == "freebsd"
+      end
+
+      # Determine if the current node is openbsd
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def openbsd_platform?(node = __getnode)
+        node["platform"] == "openbsd"
+      end
+
+      # Determine if the current node is netbsd
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def netbsd_platform?(node = __getnode)
+        node["platform"] == "netbsd"
+      end
+
+      # Determine if the current node is dragonflybsd
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def dragonfly_platform?(node = __getnode)
+        node["platform"] == "dragonfly"
+      end
+
+      # Determine if the current node is MacOS.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def macos_platform?(node = __getnode)
+        node["platform"] == "mac_os_x"
+      end
+      alias_method :mac_os_x_platform?, :macos_platform?
+
+      # Determine if the current node is gentoo
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def gentoo_platform?(node = __getnode)
+        node["platform"] == "gentoo"
+      end
+
+      # Determine if the current node is slackware.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def slackware_platform?(node = __getnode)
+        node["platform"] == "slackware"
+      end
+
+      # Determine if the current node is SuSE.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def suse_platform?(node = __getnode)
+        node["platform"] == "suse"
+      end
+
+      # Determine if the current node is OpenSuSE.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def opensuse?(node = __getnode)
+        node["platform"] == "opensuse" || node["platform"] == "opensuseleap"
+      end
+      alias_method :opensuse_platform?, :opensuse?
+      alias_method :opensuseleap_platform?, :opensuse?
+      alias_method :leap_platform?, :opensuse?
+      # NOTE: to anyone adding :tumbleweed_platform? - :[opensuse]leap_platform? should be false on tumbleweed, :opensuse[_platform]? should be true
+
+      # Determine if the current node is Windows.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def windows_platform?(node = __getnode)
+        node["platform"] == "windows"
+      end
+
+      extend self
+    end
+  end
+end