diff options
author | Tim Smith <tsmith@chef.io> | 2018-01-25 14:36:07 -0800 |
---|---|---|
committer | Tim Smith <tsmith@chef.io> | 2018-02-13 13:25:20 +0000 |
commit | 2e0f18c49eb1d5bfe531fe287c66e1e082ccfc5c (patch) | |
tree | f458893ec437f904834eee1f5bb2c90928cd336a | |
parent | af4db730bb7ae2e03b6fd6ce7d2b74d2ef2e3336 (diff) | |
download | chef-2e0f18c49eb1d5bfe531fe287c66e1e082ccfc5c.tar.gz |
Add ohai_hint resource
This makes it easier to drop off a hint and reload ohai w/o bringing in cookbook dependencies.
Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r-- | lib/chef/resource/ohai_hint.rb | 81 | ||||
-rw-r--r-- | lib/chef/resources.rb | 1 | ||||
-rw-r--r-- | spec/unit/resource/ohai_hint_spec.rb | 43 |
3 files changed, 125 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..fc85b17c68 --- /dev/null +++ b/lib/chef/resource/ohai_hint.rb @@ -0,0 +1,81 @@ +# +# 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 + # Use the ohai_hint resource to pass hint data to ohai. + # @since 14.0.0 + class OhaiHint < Chef::Resource + resource_name :ohai_hint + provides :ohai_hint + + property :hint_name, String, name_property: true + property :content, Hash + property :compile_time, [true, false], default: true + + action :create do + directory ::Ohai::Config.ohai.hints_path.first do + action :create + recursive true + end + + file ohai_hint_file_path(new_resource.hint_name) do + action :create + content format_content(new_resource.content) + end + end + + action :delete do + file ohai_hint_file_path(new_resource.hint_name) do + action :delete + notifies :reload, ohai[reload ohai post hint removal] + end + + 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 b580a01c29..497252d553 100644 --- a/lib/chef/resources.rb +++ b/lib/chef/resources.rb @@ -51,6 +51,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 |