chef-utils 0.0.1 → 15.5.9

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

@@ -0,0 +1,314 @@
+#
+# 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 PlatformFamily
+      include Internal
+
+      # Determine if the current node is arch linux.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def arch?(node = __getnode)
+        node["platform_family"] == "arch"
+      end
+      # chef-sugar backcompat methods
+      alias_method :arch_linux?, :arch?
+
+      # Determine if the current node is aix
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def aix?(node = __getnode)
+        node["platform_family"] == "aix"
+      end
+
+      # Determine if the current node is a member of the debian family.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def debian?(node = __getnode)
+        node["platform_family"] == "debian"
+      end
+
+      # Determine if the current node is a member of the fedora family.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def fedora?(node = __getnode)
+        node["platform_family"] == "fedora"
+      end
+
+      # Determine if the current node is a member of the OSX family.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def macos?(node = __getnode)
+        node["platform_family"] == "mac_os_x"
+      end
+      alias_method :osx?, :macos?
+      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
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def rhel?(node = __getnode)
+        node["platform_family"] == "rhel"
+      end
+      alias_method :el?, :rhel?
+
+      # Determine if the current node is a rhel6 compatible build (RHEL, CentOS, Oracle or Scientific Linux)
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def rhel6?(node = __getnode)
+        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)
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def rhel7?(node = __getnode)
+        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)
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def rhel8?(node = __getnode)
+        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.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def amazon?(node = __getnode)
+        node["platform_family"] == "amazon"
+      end
+      alias_method :amazon_linux?, :amazon?
+
+      # Determine if the current node is solaris2
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def solaris2?(node = __getnode)
+        node["platform_family"] == "solaris2"
+      end
+      # chef-sugar backcompat methods
+      alias_method :solaris?, :solaris2?
+
+      # Determine if the current node is smartos
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def smartos?(node = __getnode)
+        node["platform_family"] == "smartos"
+      end
+
+      # Determine if the current node is a member of the suse family.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def suse?(node = __getnode)
+        node["platform_family"] == "suse"
+      end
+
+      # Determine if the current node is a member of the gentoo family.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def gentoo?(node = __getnode)
+        node["platform_family"] == "gentoo"
+      end
+
+      # Determine if the current node is freebsd
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def freebsd?(node = __getnode)
+        node["platform_family"] == "freebsd"
+      end
+
+      # Determine if the current node is openbsd
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def openbsd?(node = __getnode)
+        node["platform_family"] == "openbsd"
+      end
+
+      # Determine if the current node is netbsd
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def netbsd?(node = __getnode)
+        node["platform_family"] == "netbsd"
+      end
+
+      # Determine if the current node is dragonflybsd
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def dragonflybsd?(node = __getnode)
+        node["platform_family"] == "dragonflybsd"
+      end
+
+      # Determine if the current node is a member of the windows family.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def windows?(node = __getnode(true))
+        # This is all somewhat complicated.  We prefer to get the node object so that chefspec can
+        # stub the node object.  But we also have to deal with class-parsing time where there is
+        # no node object, so we have to fall back to RUBY_PLATFORM based detection.  We cannot pull
+        # the node object out of the Chef.run_context.node global object here (which is what the
+        # false flag to __getnode is about) because some run-time code also cannot run under chefspec
+        # on non-windows where the node is stubbed to windows.
+        #
+        # As a result of this the `windows?` helper and the `ChefUtils.windows?` helper do not behave
+        # the same way in that the latter is not stubbable by chefspec.
+        #
+        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).
+      #
+      # @return [Boolean]
+      #
+      def windows_ruby?
+        !!(RUBY_PLATFORM =~ /mswin|mingw32|windows/)
+      end
+
+      #
+      # Platform-Family-like Helpers
+      #
+      # These are meta-helpers which address the issue that platform_family is single valued and cannot
+      # be an array while a tree-like Taxonomy is what is called for in some cases.
+      #
+
+      # If it uses RPM, it goes in here (rhel, fedora, amazon, suse platform_families).  Deliberately does not
+      # include AIX because bff is AIX's primary package manager and adding it here would make this substantially
+      # 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
+      #
+      # @return [Boolean]
+      #
+      def rpm_based?(node = __getnode)
+        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".
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def fedora_derived?(node = __getnode)
+        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.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def redhat_based?(node = __getnode)
+        %w{rhel fedora}.include?(node["platform_family"])
+      end
+
+      # All of the Solaris-lineage.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def solaris_based?(node = __getnode)
+        %w{solaris2 smartos omnios openindiana opensolaris nexentacore}.include?(node["platform"])
+      end
+
+      # 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.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def bsd_based?(node = __getnode)
+        # we could use os, platform_family or platform here equally
+        %w{netbsd freebsd openbsd dragonflybsd}.include?(node["platform"])
+      end
+
+      extend self
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+#
+# 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 "train_helpers"
+
+module ChefUtils
+  module DSL
+    # NOTE: these are mixed into the service resource+providers specifically and deliberately not
+    # injected into the global namespace
+    module Service
+      include Internal
+      include TrainHelpers
+
+      # Returns if debian's old rc.d manager is installed (not necessarily the primary init system).
+      #
+      # @return [Boolean]
+      #
+      def debianrcd?
+        file_exist?("/usr/sbin/update-rc.d")
+      end
+
+      # Returns if debian's old invoke rc.d manager is installed (not necessarily the primary init system).
+      #
+      # @return [Boolean]
+      #
+      def invokercd?
+        file_exist?("/usr/sbin/invoke-rc.d")
+      end
+
+      # Returns if upstart is installed (not necessarily the primary init system).
+      #
+      # @return [Boolean]
+      #
+      def upstart?
+        file_exist?("/sbin/initctl")
+      end
+
+      # Returns if insserv is installed (not necessarily the primary init system).
+      #
+      # @return [Boolean]
+      #
+      def insserv?
+        file_exist?("/sbin/insserv")
+      end
+
+      # Returns if redhat's init system is installed (not necessarily the primary init system).
+      #
+      # @return [Boolean]
+      #
+      def redhatrcd?
+        file_exist?("/sbin/chkconfig")
+      end
+
+      def service_script_exist?(type, script)
+        case type
+        when :initd
+          file_exist?("/etc/init.d/#{script}")
+        when :upstart
+          file_exist?("/etc/init/#{script}.conf")
+        when :xinetd
+          file_exist?("/etc/xinetd.d/#{script}")
+        when :etc_rcd
+          file_exist?("/etc/rc.d/#{script}")
+        when :systemd
+          file_exist?("/etc/init.d/#{script}") ||
+            ChefUtils::DSL::Introspection.has_systemd_service_unit?(script) ||
+            ChefUtils::DSL::Introspection.has_systemd_unit?(script)
+        else
+          raise ArgumentError, "type of service must be one of :initd, :upstart, :xinetd, :etc_rcd, or :systemd"
+        end
+      end
+
+      extend self
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+#--
+# Copyright:: Copyright 2019-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 "stringio" unless defined?(StringIO)
+require_relative "../internal"
+
+module ChefUtils
+  module DSL
+    module TrainHelpers
+      include Internal
+
+      #
+      # FIXME: generally these helpers all use the pattern of checking for target_mode?
+      # and then if it is we use train.  That approach should likely be flipped so that
+      # even when we're running without target mode we still use inspec in its local
+      # mode.
+      #
+
+      # Train wrapper around File.exist? to make it local mode aware.
+      #
+      # @param filename filename to check
+      # @return [Boolean] if it exists
+      #
+      def file_exist?(filename)
+        if __transport_connection
+          __transport_connection.file(filename).exist?
+        else
+          File.exist?(filename)
+        end
+      end
+
+      # XXX: modifications to the StringIO won't get written back
+      # FIXME: this is very experimental and may be a bad idea and may break at any time
+      # @api private
+      #
+      def file_open(*args, &block)
+        if __transport_connection
+          content = __transport_connection.file(args[0]).content
+          string_io = StringIO.new content
+          yield string_io if block_given?
+          string_io
+        else
+          File.open(*args, &block)
+        end
+      end
+
+      extend self
+    end
+  end
+end