chef-sugar-sre 5.1.13

data/lib/chef/sugar/shell.rb

@@ -0,0 +1,151 @@
+#
+# Copyright 2013-2015, Seth Vargo <sethvargo@gmail.com>
+#
+# 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 'mixlib/shellout'
+require 'pathname'
+
+class Chef
+  module Sugar
+    module Shell
+      extend self
+
+      #
+      # Finds a command in $PATH
+      #
+      # @param [String] cmd
+      #   the command to find
+      #
+      # @return [String, nil]
+      #
+      def sugar_which(cmd)
+        if Pathname.new(cmd).absolute?
+          File.executable?(cmd) ? cmd : nil
+        else
+          paths = ENV['PATH'].split(::File::PATH_SEPARATOR) + %w(/bin /usr/bin /sbin /usr/sbin)
+
+          paths.each do |path|
+            possible = File.join(path, cmd)
+            return possible if File.executable?(possible)
+          end
+
+          nil
+        end
+      end
+
+      #
+      # The platform-specific output path to +/dev/null+.
+      #
+      # @return [String]
+      #
+      def dev_null(node)
+        if defined?(ChefUtils)
+          ChefUtils.windows?(node) ? 'NUL' : '/dev/null'
+        else
+          Chef::Sugar::PlatformFamily.windows?(node) ? 'NUL' : '/dev/null'
+        end
+      end
+
+      #
+      # Boolean method to check if a command line utility is installed.
+      #
+      # @param [String] cmd
+      #   the command to find
+      #
+      # @return [Boolean]
+      #   true if the command is found in the path, false otherwise
+      #
+      def installed?(cmd)
+        !sugar_which(cmd).nil?
+      end
+
+      #
+      # Checks if the given binary is installed and exists at the given
+      # version. Also see {version_for}.
+      #
+      # @param [String] cmd
+      #   the command to check
+      # @param [String] expected_version
+      #   the version to check
+      # @param [String] flag
+      #   the flag to use to check the version of the binary
+      #
+      # @return [Boolean]
+      #   true if the command exists and is at the given version, false
+      #   otherwise
+      #
+      def installed_at_version?(cmd, expected_version, flag = '--version')
+        return false if !installed?(cmd)
+
+        version = version_for(cmd, flag)
+        return false if version.nil?
+
+        if expected_version.is_a?(Regexp)
+          !version.match(expected_version).nil?
+        else
+          version.include?(expected_version)
+        end
+      end
+
+      #
+      # The version for a given command. This method does NOT check if the
+      # command exists! It is assumed the command existence has been
+      # checked with +sugar_which+ or similar. To simply check if an installed
+      # version is acceptable, please see {installed_at_version}.
+      #
+      # Assumptions:
+      #   1. The command exists.
+      #   2. The command outputs version information to +$stdout+ or +$stderr+.
+      #      Did you know that java outputs its version to $stderr?
+      #
+      #
+      # @param [String] cmd
+      #   the command to find the version for
+      # @param [String] flag
+      #   the flag to use to get the version
+      #
+      # @return [String]
+      #   the entire output of the version command (stderr and stdout)
+      #
+      def version_for(cmd, flag = '--version')
+        cmd = Mixlib::ShellOut.new("#{cmd} #{flag}")
+        cmd.run_command
+        cmd.error!
+        [cmd.stdout.strip, cmd.stderr.strip].join("\n")
+      end
+    end
+
+    module DSL
+      # @see Chef::Sugar::Shell#sugar_which
+      def sugar_which(cmd); Chef::Sugar::Shell.sugar_which(cmd); end
+
+      # @see Chef::Sugar::Shell#dev_null
+      def dev_null; Chef::Sugar::Shell.dev_null(node); end
+
+      # @see Chef::Sugar::Shell#installed?
+      def installed?(cmd); Chef::Sugar::Shell.installed?(cmd); end
+
+      # @see Chef::Sugar::Shell#installed_at_version?
+      def installed_at_version?(cmd, version, flag = '--version')
+        Chef::Sugar::Shell.installed_at_version?(cmd, version, flag)
+      end
+
+      # @see Chef::Sugar::Shell#version_for
+      def version_for(cmd, flag = '--version')
+        Chef::Sugar::Shell.version_for(cmd, flag)
+      end
+    end
+  end
+end

data/lib/chef/sugar/vagrant.rb

@@ -0,0 +1,77 @@
+#
+# Copyright 2013-2015, Seth Vargo <sethvargo@gmail.com>
+#
+# 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.
+#
+
+class Chef
+  module Sugar
+    module Vagrant
+      extend self
+
+      #
+      # Determine if the current node is running in vagrant mode.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #   true if the machine is currently running vagrant, false
+      #   otherwise
+      #
+      def vagrant?(node)
+        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)
+        node.key?('vagrant')
+      end
+
+      #
+      # Check if "vagrantup.com" is included in the node's domain. Technically,
+      # this would make Chef Sugar falsely detect +vagrant?+ on any of
+      # Hashicorp's servers. But if that edge case becomes a serious problem,
+      # @mitchellh has my phone number.
+      #
+      # @param (see vagrant?)
+      # @return (see vagrant?)
+      #
+      def vagrant_domain?(node)
+        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)
+        node.key?('etc') && node['etc'].key?('passwd') && node['etc']['passwd'].key?('vagrant')
+      end
+    end
+
+    module DSL
+      # @see Chef::Sugar::Vagrant#vagrant?
+      def vagrant?; Chef::Sugar::Vagrant.vagrant?(node); end
+    end
+  end
+end

data/lib/chef/sugar/version.rb

@@ -0,0 +1,21 @@
+#
+# Copyright 2013-2015, Seth Vargo <sethvargo@gmail.com>
+#
+# 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.
+#
+
+class Chef
+  module Sugar
+    VERSION = "5.1.13"
+  end
+end

data/lib/chef/sugar/virtualization.rb

@@ -0,0 +1,151 @@
+#
+# Copyright 2014, Joseph J. Nuspl Jr. <nuspl@nvwls.com>
+#
+# 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.
+#
+
+class Chef
+  module Sugar
+    module Virtualization
+      extend self
+
+      #
+      # Determine if the current node is running under KVM.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #   true if the machine is currently running under KVM, false
+      #   otherwise
+      #
+      def kvm?(node)
+        node.key?('virtualization') && node['virtualization']['system'] == 'kvm'
+      end
+
+      #
+      # Determine if the current node is running in a linux container.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #   true if the machine is currently running in a container, false
+      #   otherwise
+      #
+      def lxc?(node)
+        node.key?('virtualization') && node['virtualization']['system'] == 'lxc'
+      end
+
+      #
+      # Determine if the current node is running under Parallels Desktop.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #   true if the machine is currently running under Parallels Desktop, false
+      #   otherwise
+      #
+      def parallels?(node)
+        node.key?('virtualization') && node['virtualization']['system'] == 'parallels'
+      end
+
+      #
+      # Determine if the current node is running under VirtualBox.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #   true if the machine is currently running under VirtualBox, false
+      #   otherwise
+      #
+      def virtualbox?(node)
+        node.key?('virtualization') && node['virtualization']['system'] == 'vbox'
+      end
+
+      #
+      # Determine if the current node is running under VMware.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #   true if the machine is currently running under VMware, false
+      #   otherwise
+      #
+      def vmware?(node)
+        node.key?('virtualization') && node['virtualization']['system'] == 'vmware'
+      end
+
+      #
+      # Determine if the current node is running under openvz.
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #   true if the machine is currently running under openvz, false
+      #   otherwise
+      #
+      def openvz?(node)
+        node.key?('virtualization') && node['virtualization']['system'] == 'openvz'
+      end
+
+      def virtual?(node)
+        openvz?(node) || vmware?(node) || virtualbox?(node) || parallels?(node) || lxc?(node) || kvm?(node)
+      end
+
+      def physical?(node)
+        !virtual?(node)
+      end
+    end
+
+    module DSL
+      # @see Chef::Sugar::Virtualization#kvm?
+      def kvm?
+        Chef::Sugar::Virtualization.kvm?(node)
+      end
+
+      # @see Chef::Sugar::Virtualization#lxc?
+      def lxc?
+        Chef::Sugar::Virtualization.lxc?(node)
+      end
+
+      # @see Chef::Sugar::Virtualization#parallels?
+      def parallels?
+        Chef::Sugar::Virtualization.parallels?(node)
+      end
+
+      # @see Chef::Sugar::Virtualization#virtualbox?
+      def virtualbox?
+        Chef::Sugar::Virtualization.virtualbox?(node)
+      end
+
+      # @see Chef::Sugar::Virtualization#vmware?
+      def vmware?
+        Chef::Sugar::Virtualization.vmware?(node)
+      end
+
+      # @see Chef::Sugar::Virtualization#openvz?
+      def openvz?
+        Chef::Sugar::Virtualization.openvz?(node)
+      end
+
+      # @see Chef::Sugar::Virtualization#virtual?
+      def virtual?
+        Chef::Sugar::Virtualization.virtual?(node)
+      end
+
+      # @see Chef::Sugar::Virtualization#physical?
+      def physical?
+        Chef::Sugar::Virtualization.physical?(node)
+      end
+    end
+  end
+end

data/lib/chef/sugar.rb

@@ -0,0 +1,51 @@
+#
+# Copyright 2013-2015, Seth Vargo <sethvargo@gmail.com>
+#
+# 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 'chef/recipe'
+require 'chef/resource'
+require 'chef/provider'
+
+class Chef
+  module Sugar
+    require_relative 'sugar/architecture'
+    require_relative 'sugar/cloud'
+    require_relative 'sugar/constraints'
+    require_relative 'sugar/constraints_dsl'
+    require_relative 'sugar/data_bag'
+    require_relative 'sugar/docker'
+    require_relative 'sugar/filters'
+    require_relative 'sugar/init'
+    require_relative 'sugar/ip'
+    require_relative 'sugar/kernel'
+    require_relative 'sugar/kitchen'
+    require_relative 'sugar/node'
+    require_relative 'sugar/platform'
+    require_relative 'sugar/platform_family'
+    require_relative 'sugar/ruby'
+    require_relative 'sugar/run_context'
+    require_relative 'sugar/shell'
+    require_relative 'sugar/vagrant'
+    require_relative 'sugar/version'
+    require_relative 'sugar/virtualization'
+  end
+end
+
+Chef::Recipe.send(:include, Chef::Sugar::DSL)
+Chef::Recipe.send(:include, Chef::Sugar::RecipeDSL) # TODO: this is a hack
+Chef::Resource.send(:include, Chef::Sugar::DSL)
+Chef::Provider.send(:include, Chef::Sugar::DSL)
+
+Object.send(:include, Chef::Sugar::Kernel)

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: chef-sugar-sre
+version: !ruby/object:Gem::Version
+  version: 5.1.13
+platform: ruby
+authors:
+- Seth Vargo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-12 00:00:00.000000000 Z
+dependencies: []
+description: A series of helpful sugar of the Chef core and other resources to make
+  a cleaner, more lean recipe DSL, enforce DRY principles, and make writing Chef recipes
+  an awesome experience! [Forked by Combell SRE for Chef 16]
+email:
+- sethvargo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/chef/sugar.rb
+- lib/chef/sugar/architecture.rb
+- lib/chef/sugar/cloud.rb
+- lib/chef/sugar/constraints.rb
+- lib/chef/sugar/constraints_dsl.rb
+- lib/chef/sugar/core_extensions.rb
+- lib/chef/sugar/core_extensions/array.rb
+- lib/chef/sugar/core_extensions/object.rb
+- lib/chef/sugar/core_extensions/string.rb
+- lib/chef/sugar/data_bag.rb
+- lib/chef/sugar/deprecation.rb
+- lib/chef/sugar/docker.rb
+- lib/chef/sugar/filters.rb
+- lib/chef/sugar/init.rb
+- lib/chef/sugar/ip.rb
+- lib/chef/sugar/kernel.rb
+- lib/chef/sugar/kitchen.rb
+- lib/chef/sugar/node.rb
+- lib/chef/sugar/platform.rb
+- lib/chef/sugar/platform_family.rb
+- lib/chef/sugar/ruby.rb
+- lib/chef/sugar/run_context.rb
+- lib/chef/sugar/shell.rb
+- lib/chef/sugar/vagrant.rb
+- lib/chef/sugar/version.rb
+- lib/chef/sugar/virtualization.rb
+homepage: https://github.com/chef/chef-sugar
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A collection of helper methods and modules that make working with Chef recipes
+  awesome.
+test_files: []