Merge pull request #6793 from chef/ohai_hint

Add ohai_hint resource from ohai cookbook

3 files changed, 140 insertions, 0 deletions

diff --git a/lib/chef/resource/ohai_hint.rb b/lib/chef/resource/ohai_hint.rb
new file mode 100644
index 0000000000..26b76806d7
--- /dev/null
+++ b/lib/chef/resource/ohai_hint.rb
@@ -0,0 +1,96 @@
+#
+# Copyright:: Copyright 2011-2018, 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.
+#
+
+class Chef
+  class Resource
+    class OhaiHint < Chef::Resource
+      resource_name :ohai_hint
+      provides :ohai_hint
+
+      description "A resource to pass hint data to Ohai to aid in configuration detection."
+      introduced "14.0"
+
+      property :hint_name,
+               String,
+               description: "The name of hints file if different from the resource name",
+               name_property: true
+
+      property :content,
+               Hash,
+               description: "Values to include in the hint file"
+
+      property :compile_time,
+               [TrueClass, FalseClass],
+               description: "Should the resource execute during the compile time phase",
+               default: true
+
+      action :create do
+        description "Create an Ohai hint file"
+
+        declare_resource(:directory, ::Ohai::Config.ohai.hints_path.first) do
+          action :create
+          recursive true
+        end
+
+        declare_resource(:file, ohai_hint_file_path(new_resource.hint_name)) do
+          action :create
+          content format_content(new_resource.content)
+        end
+      end
+
+      action :delete do
+        description "Delete an Ohai hint file"
+
+        declare_resource(:file, ohai_hint_file_path(new_resource.hint_name)) do
+          action :delete
+          notifies :reload, ohai[reload ohai post hint removal]
+        end
+
+        declare_resource(:ohai, "reload ohai post hint removal") do
+          action :nothing
+        end
+      end
+
+      action_class do
+        # given a hint filename return the platform specific hint file path
+        # @param filename [String] the name of the hint file
+        # @return [String] absolute path to the file
+        def ohai_hint_file_path(filename)
+          path = ::File.join(::Ohai::Config.ohai.hints_path.first, filename)
+          path << ".json" unless path.end_with?(".json")
+          path
+        end
+
+        # format content hash as JSON
+        # @param content [Hash] the content of the hint file
+        # @return [JSON] json representation of the content of an empty string if content was nil
+        def format_content(content)
+          return "" if content.nil? || content.empty?
+          JSON.pretty_generate(content)
+        end
+      end
+
+      # this resource forces itself to run at compile_time
+      def after_created
+        return unless compile_time
+        Array(action).each do |action|
+          run_action(action)
+        end
+      end
+    end
+  end
+end
diff --git a/lib/chef/resources.rb b/lib/chef/resources.rb
index d54e7815c4..60f3ad51f0 100644
--- a/lib/chef/resources.rb
+++ b/lib/chef/resources.rb
@@ -52,6 +52,7 @@ require "chef/resource/macports_package"
 require "chef/resource/mdadm"
 require "chef/resource/mount"
 require "chef/resource/ohai"
+require "chef/resource/ohai_hint"
 require "chef/resource/openbsd_package"
 require "chef/resource/openssl_dhparam"
 require "chef/resource/openssl_rsa_private_key"
diff --git a/spec/unit/resource/ohai_hint_spec.rb b/spec/unit/resource/ohai_hint_spec.rb
new file mode 100644
index 0000000000..1a4f6637fa
--- /dev/null
+++ b/spec/unit/resource/ohai_hint_spec.rb
@@ -0,0 +1,43 @@
+#
+# Copyright:: Copyright 2018, 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"
+
+describe Chef::Resource::OhaiHint do
+
+  let(:resource) { Chef::Resource::OhaiHint.new("foo") }
+
+  it "has a resource name of :ohai_hint" do
+    expect(resource.resource_name).to eql(:ohai_hint)
+  end
+
+  it "has a default action of create" do
+    expect(resource.action).to eql([:create])
+  end
+
+  it "supports the :nothing, :create and :delete actions" do
+    expect(resource.allowed_actions).to include(:nothing, :create, :delete)
+  end
+
+  it "runs at compile_time by default" do
+    expect(resource.compile_time).to eql(true)
+  end
+
+  it "the hint_name property is the name property" do
+    expect(resource.hint_name).to eql("foo")
+  end
+end