chef 13.12.14-universal-mingw32 → 14.0.190-universal-mingw32

data/lib/chef/resource/mount.rb

@@ -21,146 +21,40 @@ require "chef/resource"
 
 class Chef
   class Resource
-    # Use the mount resource to manage a mounted file system.
     class Mount < Chef::Resource
-
-      identity_attr :device
-
-      state_attrs :mount_point, :device_type, :fstype, :username, :password, :domain
+      description "Use the mount resource to manage a mounted file system."
 
       default_action :mount
       allowed_actions :mount, :umount, :unmount, :remount, :enable, :disable
 
       # this is a poor API please do not re-use this pattern
-      property :supports, Hash, default: lazy { { remount: false } },
-                                coerce: proc { |x| x.is_a?(Array) ? x.each_with_object({}) { |i, m| m[i] = true } : x }
+      property :supports, Hash,
+        default: lazy { { remount: false } },
+        coerce: proc { |x| x.is_a?(Array) ? x.each_with_object({}) { |i, m| m[i] = true } : x }
 
       property :password, String, sensitive: true
 
-      def initialize(name, run_context = nil)
-        super
-        @mount_point = name
-        @device = nil
-        @device_type = :device
-        @fsck_device = "-"
-        @fstype = "auto"
-        @options = ["defaults"]
-        @dump = 0
-        @pass = 2
-        @mounted = false
-        @enabled = false
-        @username = nil
-        @password = nil
-        @domain = nil
-      end
-
-      def mount_point(arg = nil)
-        set_or_return(
-          :mount_point,
-          arg,
-          :kind_of => [ String ]
-        )
-      end
-
-      def device(arg = nil)
-        set_or_return(
-          :device,
-          arg,
-          :kind_of => [ String ]
-        )
-      end
-
-      def device_type(arg = nil)
-        real_arg = arg.kind_of?(String) ? arg.to_sym : arg
-        valid_devices = if RUBY_PLATFORM =~ /solaris/i
-                          [ :device ]
-                        else
-                          [ :device, :label, :uuid ]
-                        end
-        set_or_return(
-          :device_type,
-          real_arg,
-          :equal_to => valid_devices
-        )
-      end
-
-      def fsck_device(arg = nil)
-        set_or_return(
-          :fsck_device,
-          arg,
-          :kind_of => [ String ]
-        )
-      end
-
-      def fstype(arg = nil)
-        set_or_return(
-          :fstype,
-          arg,
-          :kind_of => [ String ]
-        )
-      end
-
-      def options(arg = nil)
-        ret = set_or_return(
-                            :options,
-                            arg,
-                            :kind_of => [ Array, String ]
-                            )
-
-        if ret.is_a? String
-          ret.tr(",", " ").split(/ /)
-        else
-          ret
-        end
-      end
-
-      def dump(arg = nil)
-        set_or_return(
-          :dump,
-          arg,
-          :kind_of => [ Integer, FalseClass ]
-        )
-      end
+      property :mount_point, String, name_property: true
+      property :device, String, identity: true
 
-      def pass(arg = nil)
-        set_or_return(
-          :pass,
-          arg,
-          :kind_of => [ Integer, FalseClass ]
-        )
-      end
-
-      def mounted(arg = nil)
-        set_or_return(
-          :mounted,
-          arg,
-          :kind_of => [ TrueClass, FalseClass ]
-        )
-      end
+      property :device_type, [String, Symbol],
+        coerce: proc { |arg| arg.kind_of?(String) ? arg.to_sym : arg },
+        default: :device,
+        equal_to: RUBY_PLATFORM =~ /solaris/i ? %i{ device } : %i{ device label uuid }
 
-      def enabled(arg = nil)
-        set_or_return(
-          :enabled,
-          arg,
-          :kind_of => [ TrueClass, FalseClass ]
-        )
-      end
+      property :fsck_device, String, default: "-"
+      property :fstype, [String, nil], default: "auto"
 
-      def username(arg = nil)
-        set_or_return(
-          :username,
-          arg,
-          :kind_of => [ String ]
-        )
-      end
+      property :options, [Array, String, nil],
+        coerce: proc { |arg| arg.kind_of?(String) ? arg.split(",") : arg },
+        default: %w{defaults}
 
-      def domain(arg = nil)
-        set_or_return(
-          :domain,
-          arg,
-          :kind_of => [ String ]
-        )
-      end
+      property :dump, [Integer, FalseClass], default: 0
+      property :pass, [Integer, FalseClass], default: 2
+      property :mounted, [TrueClass, FalseClass], default: false
+      property :enabled, [TrueClass, FalseClass], default: false
+      property :username, String
+      property :domain, String
 
       private
 

data/lib/chef/resource/msu_package.rb

@@ -21,14 +21,14 @@ require "chef/mixin/uris"
 
 class Chef
   class Resource
-    # Use the msu_package resource to install Microsoft Update(MSU) packages on Microsoft Windows machines.
-    #
-    # @since 12.17
     class MsuPackage < Chef::Resource::Package
       include Chef::Mixin::Uris
 
       resource_name :msu_package
-      provides :msu_package, os: "windows"
+      provides :msu_package
+
+      description "Use the msu_package resource to install Microsoft Update(MSU) packages on Microsoft Windows machines."
+      introduced "12.17"
 
       allowed_actions :install, :remove
       default_action :install

data/lib/chef/resource/ohai.rb

@@ -19,14 +19,16 @@
 
 class Chef
   class Resource
-    # Use the ohai resource to reload the Ohai configuration on a node. This allows recipes that change system attributes
-    # (like a recipe that adds a user) to refer to those attributes later on during the chef-client run.
     class Ohai < Chef::Resource
       resource_name :ohai
       provides :ohai
 
+      description "Use the ohai resource to reload the Ohai configuration on a node."\
+                  " This allows recipes that change system attributes (like a recipe"\
+                  " that adds a user) to refer to those attributes later on during the chef-client run."
+
       property :ohai_name, name_property: true
-      property :plugin, [String]
+      property :plugin, String
 
       default_action :reload
       allowed_actions :reload

data/lib/chef/resource/ohai_hint.rb

@@ -0,0 +1,93 @@
+#
+# 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 "Use the ohai_hint 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

data/lib/chef/resource/openbsd_package.rb

@@ -25,14 +25,14 @@ require "chef/mixin/shell_out"
 
 class Chef
   class Resource
-    # Use the openbsd_package resource to manage packages for the OpenBSD platform.
-    #
-    # @since 12.1
     class OpenbsdPackage < Chef::Resource::Package
       include Chef::Mixin::ShellOut
 
       resource_name :openbsd_package
       provides :package, os: "openbsd"
+
+      description "Use the openbsd_package resource to manage packages for the OpenBSD platform."
+      introduced "12.1"
     end
   end
 end

data/lib/chef/resource/openssl_dhparam.rb

@@ -0,0 +1,80 @@
+#
+# Copyright:: Copyright 2009-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 "chef/resource"
+
+class Chef
+  class Resource
+    class OpensslDhparam < Chef::Resource
+      require "chef/mixin/openssl_helper"
+      include Chef::Mixin::OpenSSLHelper
+
+      resource_name :openssl_dhparam
+
+      description "Use the openssl_dhparam resource to generate dhparam.pem files. If a"\
+                  " valid dhparam.pem file is found at the specified location, no new file"\
+                  " will be created. If a file is found at the specified location but it is"\
+                  " not a valid dhparam file, it will be overwritten."
+      introduced "14.0"
+
+      property :path, String,
+               description: "The path to write the file to if it's different than the resource name.",
+               name_property: true
+
+      property :key_length, Integer,
+               equal_to: [1024, 2048, 4096, 8192],
+               validation_message: "key_length must be 1024, 2048, 4096, or 8192.",
+               description: "The desired bit length of the generated key.",
+               default: 2048
+
+      property :generator, Integer,
+               equal_to: [2, 5],
+               validation_message: "generator must be either 2 or 5.",
+               description: "The desired Diffie-Hellmann generator.",
+               default: 2
+
+      property :owner, [String, nil],
+               description: "The owner of all files created by the resource."
+
+      property :group, [String, nil],
+               description: "The group of all files created by the resource."
+
+      property :mode, [Integer, String],
+               description: "The permission mode of all files created by the resource.",
+               default: "0640"
+
+      action :create do
+        description "Create the dhparam file"
+
+        unless dhparam_pem_valid?(new_resource.path)
+          converge_by("Create a dhparam file #{new_resource.path}") do
+            dhparam_content = gen_dhparam(new_resource.key_length, new_resource.generator).to_pem
+
+            declare_resource(:file, new_resource.path) do
+              action :create
+              owner new_resource.owner unless new_resource.owner.nil?
+              group new_resource.group unless new_resource.group.nil?
+              mode new_resource.mode
+              sensitive true
+              content dhparam_content
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/resource/openssl_rsa_private_key.rb

@@ -0,0 +1,93 @@
+#
+# Copyright:: Copyright 2009-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 "chef/resource"
+
+class Chef
+  class Resource
+    class OpensslRsaPrivateKey < Chef::Resource
+      require "chef/mixin/openssl_helper"
+      include Chef::Mixin::OpenSSLHelper
+
+      resource_name :openssl_rsa_private_key
+      provides :openssl_rsa_private_key
+      provides :openssl_rsa_key # legacy cookbook resource name
+
+      description "Use the openssl_rsa_private_key resource to generate RSA private key files."\
+                  " If a valid RSA key file can be opened at the specified location, no new file"\
+                  " will be created. If the RSA key file cannot be opened, either because it does"\
+                  " not exist or because the password to the RSA key file does not match the"\
+                  " password in the recipe, it will be overwritten."
+      introduced "14.0"
+
+      property :path, String,
+               description: "The path to write the file to it's different than the resource name.",
+               name_property: true
+
+      property :key_length, Integer,
+               equal_to: [1024, 2048, 4096, 8192],
+               validation_message: "key_length (bits) must be 1024, 2048, 4096, or 8192.",
+               description: "The desired bit length of the generated key.",
+               default: 2048
+
+      property :key_pass, String,
+               description: "The desired passphrase for the key."
+
+      property :key_cipher, String,
+               equal_to: OpenSSL::Cipher.ciphers,
+               validation_message: "key_cipher must be a cipher known to openssl. Run `openssl list-cipher-algorithms` to see available options.",
+               description: "The designed cipher to use when generating your key. Run `openssl list-cipher-algorithms` to see available options.",
+               default: "des3"
+
+      property :owner, [String, nil],
+               description: "The owner of all files created by the resource."
+
+      property :group, [String, nil],
+               description: "The group of all files created by the resource."
+
+      property :mode, [Integer, String],
+               description: "The permission mode of all files created by the resource.",
+               default: "0600"
+
+      property :force, [TrueClass, FalseClass],
+               description: "Force creating the key even if the existing key exists.",
+               default: false
+
+      action :create do
+        return if new_resource.force || priv_key_file_valid?(new_resource.path, new_resource.key_pass)
+
+        converge_by("create #{new_resource.key_length} bit RSA key #{new_resource.path}") do
+          if new_resource.key_pass
+            unencrypted_rsa_key = gen_rsa_priv_key(new_resource.key_length)
+            rsa_key_content = encrypt_rsa_key(unencrypted_rsa_key, new_resource.key_pass, new_resource.key_cipher)
+          else
+            rsa_key_content = gen_rsa_priv_key(new_resource.key_length).to_pem
+          end
+
+          declare_resource(:file, new_resource.path) do
+            action :create
+            owner new_resource.owner unless new_resource.owner.nil?
+            group new_resource.group unless new_resource.group.nil?
+            mode new_resource.mode
+            sensitive true
+            content rsa_key_content
+          end
+        end
+      end
+    end
+  end
+end