chef 17.2.29 → 17.3.48

data/lib/chef/provider/file.rb

@@ -157,7 +157,7 @@ class Chef
       end
 
       action :delete do
-        if ::File.exists?(new_resource.path)
+        if ::File.exist?(new_resource.path)
           converge_by("delete file #{new_resource.path}") do
             do_backup unless file_class.symlink?(new_resource.path)
             ::File.delete(new_resource.path)
@@ -393,7 +393,7 @@ class Chef
         # a nil tempfile is okay, means the resource has no content or no new content
         return if tempfile.nil?
         # but a tempfile that has no path or doesn't exist should not happen
-        if tempfile.path.nil? || !::File.exists?(tempfile.path)
+        if tempfile.path.nil? || !::File.exist?(tempfile.path)
           raise "#{ChefUtils::Dist::Infra::CLIENT} is confused, trying to deploy a file that has no path or does not exist..."
         end
 

data/lib/chef/provider/lwrp_base.rb

@@ -45,7 +45,7 @@ class Chef
       def load_current_resource; end
 
       # class methods
-      class <<self
+      class << self
         include Chef::Mixin::ConvertToClassName
         include Chef::Mixin::FromFile
 

data/lib/chef/provider/package/habitat.rb

@@ -0,0 +1,168 @@
+#
+# Copyright:: 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 "../../http/simple"
+require_relative "../../json_compat"
+require_relative "../../exceptions"
+require_relative "../package"
+# Bring in needed shared methods
+
+class Chef
+  class Provider
+    class Package
+      class Habitat < Chef::Provider::Package
+        use_multipackage_api
+        use "../../resource/habitat/habitat_shared"
+        provides :habitat_package
+
+        def load_current_resource
+          @current_resource = Chef::Resource::HabitatPackage.new(new_resource.name)
+          current_resource.package_name(strip_version(new_resource.package_name))
+
+          @candidate_version = candidate_versions
+          current_resource.version(current_versions)
+
+          current_resource
+        end
+
+        def install_package(names, versions)
+          names.zip(versions).map do |n, v|
+            opts = ["pkg", "install", "--channel", new_resource.channel, "--url", new_resource.bldr_url]
+            opts += ["--auth", new_resource.auth_token] if new_resource.auth_token
+            opts += ["#{strip_version(n)}/#{v}", new_resource.options]
+            opts += ["--binlink"] if new_resource.binlink
+            opts += ["--force"] if new_resource.binlink.eql? :force
+            hab(opts)
+          end
+        end
+
+        alias_method :upgrade_package, :install_package
+
+        def remove_package(names, versions)
+          # raise 'It is too dangerous to :remove packages with the habitat_package resource right now. This functionality should be deferred to the hab cli.'
+          names.zip(versions).map do |n, v|
+            opts = %w{pkg uninstall}
+            opts += ["--keep-latest", new_resource.keep_latest ] if new_resource.keep_latest
+            opts += ["#{strip_version(n).chomp("/")}#{v}", new_resource.options]
+            opts += ["--exclude"] if new_resource.exclude
+            opts += ["--no-deps"] if new_resource.no_deps
+            hab(opts)
+            # action :remove
+          end
+        end
+
+        alias_method :purge_package, :remove_package
+
+        private
+
+        def validate_name!(name)
+          raise ArgumentError, "package name must be specified as 'origin/name', use the 'version' property to specify a version" unless name.squeeze("/").count("/") < 2
+        end
+
+        def strip_version(name)
+          validate_name!(name)
+          n = name.squeeze("/").chomp("/").sub(%r{^\/}, "")
+          n = n[0..(n.rindex("/") - 1)] while n.count("/") >= 2
+          n
+        end
+
+        def platform_target
+          if windows?
+            "target=x86_64-windows"
+          elsif node["kernel"]["release"].to_i < 3
+            "target=x86_64-linux-kernel2"
+          else
+            ""
+          end
+        end
+
+        def depot_package(name, version = nil)
+          @depot_package ||= {}
+          @depot_package[name] ||=
+            begin
+              origin, pkg_name = name.split("/")
+              name_version = [pkg_name, version].compact.join("/").squeeze("/").chomp("/").sub(%r{^\/}, "")
+              url = if new_resource.bldr_url.include?("/v1/")
+                      "#{new_resource.bldr_url.chomp("/")}/depot/channels/#{origin}/#{new_resource.channel}/pkgs/#{name_version}"
+                    else
+                      "#{new_resource.bldr_url.chomp("/")}/v1/depot/channels/#{origin}/#{new_resource.channel}/pkgs/#{name_version}"
+                    end
+              url << "/latest" unless name_version.count("/") >= 2
+              url << "?#{platform_target}" unless platform_target.empty?
+
+              headers = {}
+              headers["Authorization"] = "Bearer #{new_resource.auth_token}" if new_resource.auth_token
+
+              Chef::JSONCompat.parse(http.get(url, headers))
+            rescue Net::HTTPServerException
+              nil
+            end
+        end
+
+        def package_version(name, version = nil)
+          p = depot_package(name, version)
+          "#{p["ident"]["version"]}/#{p["ident"]["release"]}" unless p.nil?
+        end
+
+        def http
+          # FIXME: use SimpleJSON when the depot mime-type is fixed
+          @http ||= Chef::HTTP::Simple.new(new_resource.bldr_url.to_s)
+        end
+
+        def candidate_versions
+          package_name_array.zip(new_version_array).map do |n, v|
+            package_version(n, v)
+          end
+        end
+
+        def current_versions
+          package_name_array.map do |n|
+            installed_version(n)
+          end
+        end
+
+        def installed_version(ident)
+          hab("pkg", "path", ident).stdout.chomp.split(windows? ? "\\" : "/")[-2..-1].join("/")
+        rescue Mixlib::ShellOut::ShellCommandFailed
+          nil
+        end
+
+        # This is used by the superclass Chef::Provider::Package
+        def version_requirement_satisfied?(current_version, new_version)
+          return false if new_version.nil? || current_version.nil?
+
+          nv_parts = new_version.squeeze("/").split("/")
+
+          if nv_parts.count < 2
+            current_version.squeeze("/").split("/")[0] == new_version.squeeze("/")
+          else
+            current_version.squeeze("/") == new_resource.version.squeeze("/")
+          end
+        end
+
+        # This is used by the superclass Chef::Provider::Package
+        def version_compare(v1, v2)
+          require "mixlib/versioning" unless defined?(Mixlib::Versioning)
+          # Convert the package version (X.Y.Z/DATE) into a version that Mixlib::Versioning understands (X.Y.Z+DATE)
+          hab_v1 = Mixlib::Versioning.parse(v1.tr("/", "+"))
+          hab_v2 = Mixlib::Versioning.parse(v2.tr("/", "+"))
+          hab_v1 <=> hab_v2
+        end
+      end
+    end
+  end
+end

data/lib/chef/provider/package/powershell.rb

@@ -124,6 +124,11 @@ class Chef
           command.push("-RequiredVersion #{version}") if version
           command.push("-Source #{new_resource.source}") if new_resource.source && cmdlet_name =~ Regexp.union(/Install-Package/, /Find-Package/)
           command.push("-SkipPublisherCheck") if new_resource.skip_publisher_check && cmdlet_name !~ /Find-Package/
+          if new_resource.options && cmdlet_name !~ Regexp.union(/Get-Package/, /Find-Package/)
+            new_resource.options.each do |arg|
+              command.push(arg) unless command.include?(arg)
+            end
+          end
           command.push(").Version")
           command.join(" ")
         end

data/lib/chef/providers.rb

@@ -74,6 +74,7 @@ require_relative "provider/package/cab"
 require_relative "provider/package/powershell"
 require_relative "provider/package/msu"
 require_relative "provider/package/snap"
+require_relative "provider/package/habitat"
 
 require_relative "provider/service/arch"
 require_relative "provider/service/freebsd"

data/lib/chef/resource/chef_client_config.rb

@@ -29,7 +29,7 @@ class Chef
       examples <<~DOC
       **Bare minimum #{ChefUtils::Dist::Infra::PRODUCT} client.rb**:
 
-      The absolute minimum configuration necessary for a node to communicate with the Infra Server is the URL of the Infra Server. All other configuration options either have values at the server side (Policyfiles, Roles, Environments, etc) or have default values determined at client startup.
+      The absolute minimum configuration necessary for a node to communicate with the #{ChefUtils::Dist::Server::PRODUCT} is the URL of the #{ChefUtils::Dist::Server::PRODUCT}. All other configuration options either have values at the server side (Policyfiles, Roles, Environments, etc) or have default values determined at client startup.
 
       ```ruby
       chef_client_config 'Create client.rb' do
@@ -184,6 +184,10 @@ class Chef
         coerce: proc { |x| x.map { |v| string_to_symbol(v).capitalize } },
         default: []
 
+      property :policy_persist_run_list, [true, false],
+        description: "Override run lists defined in a Policyfile with the `run_list` defined on the #{ChefUtils::Dist::Server::PRODUCT}.",
+        introduced: "17.3"
+
       property :minimal_ohai, [true, false],
         description: "Run a minimal set of Ohai plugins providing data necessary for the execution of #{ChefUtils::Dist::Infra::PRODUCT}'s built-in resources. Setting this to true will skip many large and time consuming data sets such as `cloud` or `packages`. Setting this this to true may break cookbooks that assume all Ohai data will be present."
 
@@ -277,7 +281,8 @@ class Chef
             report_handlers: format_handler(new_resource.report_handlers),
             ssl_verify_mode: new_resource.ssl_verify_mode,
             start_handlers: format_handler(new_resource.start_handlers),
-            additional_config: new_resource.additional_config
+            additional_config: new_resource.additional_config,
+            policy_persist_run_list: new_resource.policy_persist_run_list
           )
           mode "0640"
           action :create

data/lib/chef/resource/chef_client_cron.rb

@@ -106,7 +106,7 @@ class Chef
         description: "The e-mail address to e-mail any cron task failures to."
 
       property :accept_chef_license, [true, false],
-        description: "Accept the Chef Online Master License and Services Agreement. See <https://www.chef.io/online-master-agreement/>",
+        description: "Accept the Chef Online Master License and Services Agreement. See <https://www.chef.io/online-master-agreement>",
         default: false
 
       property :config_directory, String,

data/lib/chef/resource/chef_client_launchd.rb

@@ -65,7 +65,7 @@ class Chef
         description: "A random number of seconds between 0 and X to add to interval so that all #{ChefUtils::Dist::Infra::CLIENT} commands don't execute at the same time."
 
       property :accept_chef_license, [true, false],
-        description: "Accept the Chef Online Master License and Services Agreement. See <https://www.chef.io/online-master-agreement/>",
+        description: "Accept the Chef Online Master License and Services Agreement. See <https://www.chef.io/online-master-agreement>",
         default: false
 
       property :config_directory, String,

data/lib/chef/resource/chef_client_scheduled_task.rb

@@ -87,7 +87,7 @@ class Chef
         default_description: "30 if frequency is 'minute', 1 otherwise"
 
       property :accept_chef_license, [true, false],
-        description: "Accept the Chef Online Master License and Services Agreement. See <https://www.chef.io/online-master-agreement/>",
+        description: "Accept the Chef Online Master License and Services Agreement. See <https://www.chef.io/online-master-agreement>",
         default: false
 
       property :start_date, String,

data/lib/chef/resource/chef_client_systemd_timer.rb

@@ -75,7 +75,7 @@ class Chef
         default: "5min"
 
       property :accept_chef_license, [true, false],
-        description: "Accept the Chef Online Master License and Services Agreement. See <https://www.chef.io/online-master-agreement/>",
+        description: "Accept the Chef Online Master License and Services Agreement. See <https://www.chef.io/online-master-agreement>",
         default: false
 
       property :run_on_battery, [true, false],

data/lib/chef/resource/chef_client_trusted_certificate.rb

@@ -64,7 +64,7 @@ class Chef
       property :certificate, String, required: [:add],
         description: "The text of the certificate file including the BEGIN/END comment lines."
 
-      action :add do
+      action :add, description: "Add a trusted certificate to #{ChefUtils::Dist::Infra::PRODUCT}'s trusted certificate directory" do
         unless ::Dir.exist?(Chef::Config[:trusted_certs_dir])
           directory Chef::Config[:trusted_certs_dir] do
             mode "0640"
@@ -78,7 +78,7 @@ class Chef
         end
       end
 
-      action :remove do
+      action :remove, description: "Remove a trusted certificate from #{ChefUtils::Dist::Infra::PRODUCT}'s trusted certificate directory" do
         file cert_path do
           action :delete
         end

data/lib/chef/resource/chef_vault_secret.rb

@@ -33,7 +33,7 @@ class Chef
         ```ruby
         chef_vault_secret 'foo' do
           data_bag 'bar'
-          raw_data({'auth' => 'baz'})
+          raw_data({ 'auth' => 'baz' })
           admins 'jtimberman'
           search '*:*'
         end
@@ -45,7 +45,7 @@ class Chef
         chef_vault_secret 'root-password' do
           admins 'jtimberman,paulmooring'
           data_bag 'secrets'
-          raw_data({'auth' => 'DoNotUseThisPasswordForRoot'})
+          raw_data({ 'auth' => 'DoNotUseThisPasswordForRoot' })
           search '*:*'
         end
         ```

data/lib/chef/resource/dsc_resource.rb

@@ -74,7 +74,7 @@ class Chef
 
       property :module_version, String,
         introduced: "12.21",
-        description: "The version number of the module to use. PowerShell 5.0.10018.0 (or higher) supports having multiple versions of a module installed. This should be specified along with the module_name."
+        description: "The version number of the module to use. PowerShell 5.0.10018.0 (or higher) supports having multiple versions of a module installed. This should be specified along with the `module_name` property."
 
       def property(property_name, value = nil)
         unless property_name.is_a?(Symbol)

data/lib/chef/resource/execute.rb

@@ -304,9 +304,9 @@ class Chef
         gives a recipe full control over the command issued in a much cleaner, more
         direct manner.
 
-        **Use the search recipe DSL method to find users**:
+        **Use the search Infra Language helper to find users**:
 
-        The following example shows how to use the `search` method in the Recipe DSL to
+        The following example shows how to use the `search` method in the Chef Infra Language to
         search for users:
 
         ```ruby
@@ -515,7 +515,7 @@ class Chef
 
       property :command, [ String, Array ],
         name_property: true,
-        description: "An optional property to set the command to be executed if it differs from the resource block's name."
+        description: "An optional property to set the command to be executed if it differs from the resource block's name. Note: Use the **execute** resource to run a single command. Use multiple **execute** resource blocks to run multiple commands."
 
       property :umask, [ String, Integer ],
         description: "The file mode creation mask, or umask."

data/lib/chef/resource/gem_package.rb

@@ -83,7 +83,8 @@ class Chef
 
       property :clear_sources, [ TrueClass, FalseClass, nil ],
         description: "Set to `true` to download a gem from the path specified by the `source` property (and not from RubyGems).",
-        default: lazy { Chef::Config[:clear_gem_sources] }, desired_state: false
+        default: lazy { Chef::Config[:clear_gem_sources] },
+        default_description: "false unless `clear_gem_sources` set to true in the `client.rb` config.", desired_state: false
 
       property :gem_binary, String, desired_state: false,
         description: "The path of a gem binary to use for the installation. By default, the same version of Ruby that is used by #{ChefUtils::Dist::Infra::PRODUCT} will be used."

data/lib/chef/resource/habitat/_habitat_shared.rb

@@ -0,0 +1,28 @@
+#
+# Copyright:: 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
+# li
+
+def hab(*command)
+  # Windows shell_out does not support arrays, so manually cleaning and joining
+  hab_cmd = if windows?
+              (["hab"] + command).flatten.compact.join(" ")
+            else
+              (["hab"] + command)
+            end
+  shell_out!(hab_cmd)
+rescue Errno::ENOENT
+  Chef::Log.fatal("'hab' binary not found, use the 'habitat_install' resource to install it first")
+  raise
+end

data/lib/chef/resource/habitat/habitat_package.rb

@@ -0,0 +1,129 @@
+#
+# Copyright:: 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 "../package"
+
+class Chef
+  class Resource
+    class HabitatPackage < Chef::Resource::Package
+      unified_mode true
+
+      provides :habitat_package
+      use "habitat_shared"
+      description "Use the **habitat_package** to install or remove Chef Habitat packages from Habitat Builder."
+      introduced "17.3"
+      examples <<~DOC
+      **Install core/redis**
+
+      ```ruby
+      habitat_package 'core/redis'
+      ```
+
+      **Install specific version of a package from the unstable channel**
+
+      ```ruby
+      habitat_package 'core/redis' do
+        version '3.2.3'
+        channel 'unstable'
+      end
+      ```
+
+      **Install a package with specific version and revision**
+
+      ```ruby
+      habitat_package 'core/redis' do
+        version '3.2.3/20160920131015'
+      end
+      ```
+
+      **Install a package and force linking it's binary files to the system path**
+
+      ```ruby
+      habitat_package 'core/nginx' do
+        binlink :force
+      end
+      ```
+
+      **Install a package and link it's binary files to the system path**
+
+      ```ruby
+      habitat_package 'core/nginx' do
+        options '--binlink'
+      end
+      ```
+
+      **Remove package and all of it's versions**
+
+      ```ruby
+      habitat_package 'core/nginx'
+        action :remove
+      end
+      ```
+
+      **Remove specified version of a package**
+
+      ```ruby
+      habitat_package 'core/nginx/3.2.3'
+        action :remove
+      end
+      ```
+
+      **Remove package but retain some versions Note: Only available as of Habitat 1.5.86**
+
+      ```ruby
+      habitat_package 'core/nginx'
+        keep_latest '2'
+        action :remove
+      end
+      ```
+
+      ```ruby
+      **Remove package but keep dependencies**
+      habitat_package 'core/nginx'
+        no_deps false
+        action :remove
+      end
+      ```
+      DOC
+
+      property :bldr_url, String, default: "https://bldr.habitat.sh",
+      description: "The habitat builder url where packages will be downloaded from. **Defaults to public Habitat Builder**"
+
+      property :channel, String, default: "stable",
+      description: "The release channel to install your package from."
+
+      property :auth_token, String,
+      description: "Auth token for installing a package from a private organization on Habitat builder."
+
+      property :binlink, [true, false, :force], default: false,
+      description: "If habitat should attempt to binlink the package. Acceptable values: `true`, `false`, `:force`. Will fail on binlinking if set to `true` and binary or binlink exists."
+
+      property :options, String,
+      description: "Pass any additional parameters to the habitat package command."
+
+      property :keep_latest, String,
+      description: "Ability to uninstall while retaining a specified version **This feature only works in Habitat 1.5.86+.**"
+
+      property :exclude, String,
+      description: "Identifier of one or more packages that should not be uninstalled. (ex: core/redis, core/busybox-static/1.42.2/21120102031201)"
+
+      property :no_deps, [true, false], default: false,
+      description: "Remove package but retain dependencies."
+    end
+  end
+end