Add chef-sugar cloud helpers to chef-utils (#9305)

Add chef-sugar cloud helpers to chef-utils

5 files changed, 233 insertions, 2 deletions

diff --git a/chef-utils/README.md b/chef-utils/README.md
index c94dc29312..a5eafeae65 100644
--- a/chef-utils/README.md
+++ b/chef-utils/README.md
@@ -120,6 +120,19 @@ Architecture Helpers allow you to determine the processor architecture of your n
 * `s390x?`
 * `s390?`
 
+### Cloud Helpers
+
+* `cloud?` - if the node is running in any cloud, including internal ones
+* `ec2?` - if the node is running in ec2
+* `gce?` - if the node is running in gce
+* `rackspace?` - if the node is running in rackspace
+* `eucalyptus?` - if the node is running under eucalyptus
+* `linode?` - if the node is running in linode
+* `openstack?` - if the node is running under openstack
+* `azure?` - if the node is running in azure
+* `digital_ocean?` - if the node is running in digital ocean
+* `softlayer?` - if the node is running in softlayer
+
 ### Train Helpers
 
 **EXPERIMENTAL**: APIs may have breaking changes any time without warning
diff --git a/chef-utils/lib/chef-utils.rb b/chef-utils/lib/chef-utils.rb
index eb4a52e717..596737892c 100644
--- a/chef-utils/lib/chef-utils.rb
+++ b/chef-utils/lib/chef-utils.rb
@@ -16,6 +16,7 @@
 #
 
 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"
@@ -30,10 +31,11 @@ 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::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::Windows
   # FIXME: include ChefUtils::DSL::Which in Chef 16.0
   # FIXME: include ChefUtils::DSL::PathSanity in Chef 16.0
diff --git a/chef-utils/lib/chef-utils/dsl/cloud.rb b/chef-utils/lib/chef-utils/dsl/cloud.rb
new file mode 100644
index 0000000000..6aba9d1b51
--- /dev/null
+++ b/chef-utils/lib/chef-utils/dsl/cloud.rb
@@ -0,0 +1,132 @@
+#
+# Copyright:: Copyright 2018-2020, 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
+      #
+      # @return [Boolean]
+      #
+      def cloud?(node = __getnode)
+        node.key?("cloud")
+      end
+
+      # Return true if the current current node is in EC2
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def ec2?(node = __getnode)
+        node.key?("ec2")
+      end
+
+      # Return true if the current current node is in GCE
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def gce?(node = __getnode)
+        node.key?("gce")
+      end
+
+      # Return true if the current current node is in Rackspace
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def rackspace?(node = __getnode)
+        node.key?("rackspace")
+      end
+
+      # Return true if the current current node is in Eucalyptus
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def eucalyptus?(node = __getnode)
+        node.key?("eucalyptus")
+      end
+      alias_method :euca?, :eucalyptus?
+
+      # Return true if the current current node is in Linode
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def linode?(node = __getnode)
+        node.key?("linode")
+      end
+
+      # Return true if the current current node is in Openstack
+      #
+      # @param [Chef::Node] node
+      #
+      # @return [Boolean]
+      #
+      def openstack?(node = __getnode)
+        node.key?("openstack")
+      end
+
+      # Return true if the current current node is in Azure
+      #
+      # @param [Chef::Node] node
+      #
+      # @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
+      #
+      # @return [Boolean]
+      #
+      def digital_ocean?(node = __getnode)
+        node.key?("digital_ocean")
+      end
+      alias_method :digitalocean?, :digital_ocean?
+
+      # Return true if the current current node is in SoftLayer
+      #
+      # @param [Chef::Node] node
+      #   the node to check
+      #
+      # @return [Boolean]
+      #
+      def softlayer?(node = __getnode)
+        node.key?("softlayer")
+      end
+
+      extend self
+    end
+  end
+end
diff --git a/chef-utils/spec/spec_helper.rb b/chef-utils/spec/spec_helper.rb
index 98dce52440..4d9b5518d1 100644
--- a/chef-utils/spec/spec_helper.rb
+++ b/chef-utils/spec/spec_helper.rb
@@ -3,6 +3,7 @@ require "chef-utils"
 # FIXME: dynamically generate this for accuracy
 HELPER_MODULES = [
   ChefUtils::DSL::Architecture,
+  ChefUtils::DSL::Cloud,
   ChefUtils::DSL::Introspection,
   ChefUtils::DSL::OS,
   ChefUtils::DSL::PathSanity,
@@ -19,6 +20,7 @@ PLATFORM_HELPERS = (ChefUtils::DSL::Platform.methods - Module.methods).freeze
 PLATFORM_FAMILY_HELPERS = (ChefUtils::DSL::PlatformFamily.methods - Module.methods).freeze
 INTROSPECTION_HELPERS = (ChefUtils::DSL::Introspection.methods - Module.methods).freeze
 WINDOWS_HELPERS = (ChefUtils::DSL::Windows.methods - Module.methods).freeze
+CLOUD_HELPERS = (ChefUtils::DSL::Cloud.methods - Module.methods).freeze
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
diff --git a/chef-utils/spec/unit/dsl/cloud_spec.rb b/chef-utils/spec/unit/dsl/cloud_spec.rb
new file mode 100644
index 0000000000..ebf24c7818
--- /dev/null
+++ b/chef-utils/spec/unit/dsl/cloud_spec.rb
@@ -0,0 +1,82 @@
+#
+# Copyright:: Copyright 2018-2020, 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 "spec_helper"
+require "fauxhai"
+
+def cloud_reports_true_for(*args, node:)
+  args.each do |method|
+    it "reports true for #{method}" do
+      expect(described_class.send(method, node)).to be true
+    end
+  end
+  (CLOUD_HELPERS - args).each do |method|
+    it "reports false for #{method}" do
+      expect(described_class.send(method, node)).to be false
+    end
+  end
+end
+
+RSpec.describe ChefUtils::DSL::Cloud do
+  ( HELPER_MODULES - [ described_class ] ).each do |klass|
+    it "does not have methods that collide with #{klass}" do
+      expect((klass.methods - Module.methods) & CLOUD_HELPERS).to be_empty
+    end
+  end
+
+  CLOUD_HELPERS.each do |helper|
+    it "has the #{helper} in the ChefUtils module" do
+      expect(ChefUtils).to respond_to(helper)
+    end
+  end
+
+  context "on ec2" do
+    cloud_reports_true_for(:cloud?, :ec2?, node: { "ec2" => {}, "cloud" => {} })
+  end
+
+  context "on gce" do
+    cloud_reports_true_for(:cloud?, :gce?, node: { "gce" => {}, "cloud" => {} })
+  end
+
+  context "on rackspace" do
+    cloud_reports_true_for(:cloud?, :rackspace?, node: { "rackspace" => {}, "cloud" => {} })
+  end
+
+  context "on eucalyptus" do
+    cloud_reports_true_for(:cloud?, :eucalyptus?, :euca?, node: { "eucalyptus" => {}, "cloud" => {} })
+  end
+
+  context "on linode" do
+    cloud_reports_true_for(:cloud?, :linode?, node: { "linode" => {}, "cloud" => {} })
+  end
+
+  context "on openstack" do
+    cloud_reports_true_for(:cloud?, :openstack?, node: { "openstack" => {}, "cloud" => {} })
+  end
+
+  context "on azure" do
+    cloud_reports_true_for(:cloud?, :azure?, node: { "azure" => {}, "cloud" => {} })
+  end
+
+  context "on digital_ocean" do
+    cloud_reports_true_for(:cloud?, :digital_ocean?, :digitalocean?, node: { "digital_ocean" => {}, "cloud" => {} })
+  end
+
+  context "on softlayer" do
+    cloud_reports_true_for(:cloud?, :softlayer?, node: { "softlayer" => {}, "cloud" => {} })
+  end
+end