chef 18.9.4 → 18.11.11

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

@@ -28,159 +28,159 @@ class Chef
       description "Use the **habitat_sup** resource to runs a Chef Habitat supervisor for one or more Chef Habitat services. The resource is commonly used in conjunction with `habitat_service` which will manage the services loaded and started within the supervisor."
       introduced "17.3"
       examples <<~DOC
-      **Set up with just the defaults**
+        **Set up with just the defaults**
 
-      ```ruby
-      habitat_sup 'default'
-      ```
+        ```ruby
+        habitat_sup 'default'
+        ```
 
-      **Update listen ports and use Supervisor toml config**
+        **Update listen ports and use Supervisor toml config**
 
-      ```ruby
-      habitat_sup 'test-options' do
-        listen_http '0.0.0.0:9999'
-        listen_gossip '0.0.0.0:9998'
-        toml_config true
-      end
-      ```
+        ```ruby
+        habitat_sup 'test-options' do
+          listen_http '0.0.0.0:9999'
+          listen_gossip '0.0.0.0:9998'
+          toml_config true
+        end
+        ```
 
-      **Use with an on-prem Habitat Builder. Note: Access to public builder may not be available due to your company policies**
+        **Use with an on-prem Habitat Builder. Note: Access to public builder may not be available due to your company policies**
 
-      ```ruby
-      habitat_sup 'default' do
-        bldr_url 'https://bldr.example.com'
-      end
-      ```
+        ```ruby
+        habitat_sup 'default' do
+          bldr_url 'https://bldr.example.com'
+        end
+        ```
 
-      **Using update_condition**
+        **Using update_condition**
 
-      ```ruby
-      habitat_sup 'default' do
-        bldr_url 'https://bldr.example.com'
-        habitat_channel 'dev'
-        update_condition 'track-channel'
-      end
-      ```
-
-      **Provide event stream information**
-
-      ```ruby
-      habitat_sup 'default' do
-        license 'accept'
-        event_stream_application 'myapp'
-        event_stream_environment 'production'
-        event_stream_site 'MySite'
-        event_stream_url 'automate.example.com:4222'
-        event_stream_token 'myawesomea2clitoken='
-        event_stream_cert '/hab/cache/ssl/mycert.crt'
-      end
-      ```
+        ```ruby
+        habitat_sup 'default' do
+          bldr_url 'https://bldr.example.com'
+          habitat_channel 'dev'
+          update_condition 'track-channel'
+        end
+        ```
+
+        **Provide event stream information**
+
+        ```ruby
+        habitat_sup 'default' do
+          license 'accept'
+          event_stream_application 'myapp'
+          event_stream_environment 'production'
+          event_stream_site 'MySite'
+          event_stream_url 'automate.example.com:4222'
+          event_stream_token 'myawesomea2clitoken='
+          event_stream_cert '/hab/cache/ssl/mycert.crt'
+        end
+        ```
 
-      **Provide specific versions**
+        **Provide specific versions**
 
-      ```ruby
-      habitat_sup 'default' do
-        bldr_url 'https://bldr.example.com'
-        sup_version '1.5.50'
-        launcher_version '13458'
-        service_version '0.6.0' # WINDOWS ONLY
-      end
-      ```
+        ```ruby
+        habitat_sup 'default' do
+          bldr_url 'https://bldr.example.com'
+          sup_version '1.5.50'
+          launcher_version '13458'
+          service_version '0.6.0' # WINDOWS ONLY
+        end
+        ```
 
-      **Set latest version of packages to retain**
+        **Set latest version of packages to retain**
 
-      habitat_sup 'default' do
-        bldr_url 'https://bldr.example.com'
-        sup_version '1.5.86'
-        launcher_version '13458'
-        service_version '0.6.0' # WINDOWS ONLY
-        keep_latest '2'
-      end
-      ```
+        habitat_sup 'default' do
+          bldr_url 'https://bldr.example.com'
+          sup_version '1.5.86'
+          launcher_version '13458'
+          service_version '0.6.0' # WINDOWS ONLY
+          keep_latest '2'
+        end
+        ```
       DOC
 
       property :bldr_url, String,
-      description: "The Habitat Builder URL for the `habitat_package` resource, if needed."
+        description: "The Habitat Builder URL for the `habitat_package` resource, if needed."
 
       property :permanent_peer, [true, false], default: false,
-      description: "Only valid for `:run` action, passes `--permanent-peer` to the hab command."
+        description: "Only valid for `:run` action, passes `--permanent-peer` to the hab command."
 
       property :listen_ctl, String,
-      description: "Only valid for `:run` action, passes `--listen-ctl` with the specified address and port, e.g., `0.0.0.0:9632`, to the hab command."
+        description: "Only valid for `:run` action, passes `--listen-ctl` with the specified address and port, e.g., `0.0.0.0:9632`, to the hab command."
 
       property :listen_gossip, String,
-      description: "Only valid for `:run` action, passes `--listen-gossip` with the specified address and port, e.g., `0.0.0.0:9638`, to the hab command."
+        description: "Only valid for `:run` action, passes `--listen-gossip` with the specified address and port, e.g., `0.0.0.0:9638`, to the hab command."
 
       property :listen_http, String,
-      description: "Only valid for `:run` action, passes `--listen-http` with the specified address and port, e.g., `0.0.0.0:9631`, to the hab command."
+        description: "Only valid for `:run` action, passes `--listen-http` with the specified address and port, e.g., `0.0.0.0:9631`, to the hab command."
 
       property :org, String, default: "default",
-      description: "Only valid for `:run` action, passes `--org` with the specified org name to the hab command."
+        description: "Only valid for `:run` action, passes `--org` with the specified org name to the hab command."
 
       property :peer, [String, Array], coerce: proc { |b| b.is_a?(String) ? [b] : b },
-      description: "Only valid for `:run` action, passes `--peer` with the specified initial peer to the hab command."
+        description: "Only valid for `:run` action, passes `--peer` with the specified initial peer to the hab command."
 
       property :ring, String,
-      description: "Only valid for `:run` action, passes `--ring` with the specified ring key name to the hab command."
+        description: "Only valid for `:run` action, passes `--ring` with the specified ring key name to the hab command."
 
       property :hab_channel, String,
-      description: "The channel to install Habitat from. Defaults to stable"
+        description: "The channel to install Habitat from. Defaults to stable"
 
       property :auto_update, [true, false], default: false,
-      description: "Passes `--auto-update`. This will set the Habitat supervisor to automatically update itself any time a stable version has been released."
+        description: "Passes `--auto-update`. This will set the Habitat supervisor to automatically update itself any time a stable version has been released."
 
-      property :auth_token, String,
-      description: "Auth token for accessing a private organization on bldr. This value is templated into the appropriate service file."
+      property :auth_token, String, sensitive: true,
+        description: "Auth token for accessing a private organization on bldr. This value is templated into the appropriate service file."
 
-      property :gateway_auth_token, String,
-      description: "Auth token for accessing the supervisor's HTTP gateway. This value is templated into the appropriate service file."
+      property :gateway_auth_token, String, sensitive: true,
+        description: "Auth token for accessing the supervisor's HTTP gateway. This value is templated into the appropriate service file."
 
       property :update_condition, String,
-      description: "Passes `--update-condition` dictating when this service should updated. Defaults to `latest`. Options are `latest` or `track-channel` **_Note: This requires a minimum habitat version of 1.5.71_**
+        description: "Passes `--update-condition` dictating when this service should updated. Defaults to `latest`. Options are `latest` or `track-channel` **_Note: This requires a minimum habitat version of 1.5.71_**
       - `latest`: Runs the latest package that can be found in the configured channel and local packages.
       - `track-channel`: Always run what is at the head of a given channel. This enables service rollback where demoting a package from a channel will cause the package to rollback to an older version of the package. A ramification of enabling this condition is packages newer than the package at the head of the channel will be automatically uninstalled during a service rollback."
 
       property :limit_no_files, String,
-      description: "allows you to set LimitNOFILE in the systemd service when used Note: Linux Only."
+        description: "allows you to set LimitNOFILE in the systemd service when used Note: Linux Only."
 
       property :license, String, equal_to: ["accept"],
-      description: "Specifies acceptance of habitat license when set to `accept`."
+        description: "Specifies acceptance of habitat license when set to `accept`."
 
       property :health_check_interval, [String, Integer], coerce: proc { |h| h.is_a?(String) ? h : h.to_s },
-      description: "The interval (seconds) on which to run health checks."
+        description: "The interval (seconds) on which to run health checks."
 
       property :event_stream_application, String,
-      description: "The name of your application that will be displayed in the Chef Automate Applications Dashboard."
+        description: "The name of your application that will be displayed in the Chef Automate Applications Dashboard."
 
       property :event_stream_environment, String,
-      description: "The application environment for the supervisor, this is for grouping in the Applications Dashboard."
+        description: "The application environment for the supervisor, this is for grouping in the Applications Dashboard."
 
       property :event_stream_site, String,
-      description: "Application Dashboard label for the 'site' of the application - can be filtered in the dashboard."
+        description: "Application Dashboard label for the 'site' of the application - can be filtered in the dashboard."
 
       property :event_stream_url, String,
-      description: "`AUTOMATE_HOSTNAME:4222` - the Chef Automate URL with port 4222 specified Note: The port can be changed if needed."
+        description: "`AUTOMATE_HOSTNAME:4222` - the Chef Automate URL with port 4222 specified Note: The port can be changed if needed."
 
       property :event_stream_token, String,
-      description: "Chef Automate token for sending application event stream data."
+        description: "Chef Automate token for sending application event stream data."
 
       property :event_stream_cert, String,
-      description: "With `Intermediary Certificates` or, Automate 2 being set to use TLS with a valid cert, you will need to provide `Habitat` with your certificate for communication with Automate to work. [Follow these steps!](https://automate.chef.io/docs/applications-setup/#share-the-tls-certificate-with-chef-habitat)."
+        description: "With `Intermediary Certificates` or, Automate 2 being set to use TLS with a valid cert, you will need to provide `Habitat` with your certificate for communication with Automate to work. [Follow these steps!](https://automate.chef.io/docs/applications-setup/#share-the-tls-certificate-with-chef-habitat)."
 
       property :sup_version, String,
-      description: "Allows you to choose which version of supervisor you would like to install. Note: If a version is provided, it will also install that version of habitat if not previously installed."
+        description: "Allows you to choose which version of supervisor you would like to install. Note: If a version is provided, it will also install that version of habitat if not previously installed."
 
       property :launcher_version, String,
-      description: "Allows you to choose which version of launcher to install."
+        description: "Allows you to choose which version of launcher to install."
 
       property :service_version, String, # Windows only
-      description: "Allows you to choose which version of the **_Windows Service_** to install."
+        description: "Allows you to choose which version of the **_Windows Service_** to install."
 
       property :keep_latest, String,
-      description: "Automatically cleans up old packages. If this flag is enabled, service startup will initiate an uninstall of all previous versions of the associated package. This also applies when a service is restarted due to an update. If a number is passed to this argument, that number of latest versions will be kept. The same logic applies to the Supervisor package `env:HAB_KEEP_LATEST_PACKAGES=1` Note: This requires Habitat version `1.5.86+`"
+        description: "Automatically cleans up old packages. If this flag is enabled, service startup will initiate an uninstall of all previous versions of the associated package. This also applies when a service is restarted due to an update. If a number is passed to this argument, that number of latest versions will be kept. The same logic applies to the Supervisor package `env:HAB_KEEP_LATEST_PACKAGES=1` Note: This requires Habitat version `1.5.86+`"
 
       property :toml_config, [true, false], default: false,
-      description: "Supports using the Supervisor toml configuration instead of passing exec parameters to the service, [reference](https://www.habitat.sh/docs/reference/#supervisor-config)."
+        description: "Supports using the Supervisor toml configuration instead of passing exec parameters to the service, [reference](https://www.habitat.sh/docs/reference/#supervisor-config)."
 
       action :run, description: "The `run` action handles installing Habitat using the `habitat_install` resource, ensures that the appropriate versions of the `core/hab-sup` and `core/hab-launcher` packages are installed using `habitat_package`, and then drops off the appropriate init system definitions and manages the service." do
         habitat_install new_resource.name do
@@ -281,15 +281,13 @@ class Chef
         # validate that peers have been passed with a port # for toml file
         def peer_list_with_port
           if new_resource.peer
-            peer_list = []
-            new_resource.peer.each do |p|
-              peer_list << if !/.*:.*/.match?(p)
-                             p + ":9632"
-                           else
-                             p
-                           end
+            peer_list = new_resource.peer.map do |p|
+              if !/.*:.*/.match?(p)
+                p + ":9632"
+              else
+                p
+              end
             end
-            peer_list
           end
         end
 

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

@@ -34,16 +34,16 @@ class Chef
           content(Unit: {
                     Description: "The Habitat Supervisor",
                   },
-                  Service: {
-                    LimitNOFILE: new_resource.limit_no_files,
-                    Environment: service_environment,
-                    ExecStart: "/bin/hab sup run #{exec_start_options}",
-                    ExecStop: "/bin/hab sup term",
-                    Restart: "on-failure",
-                  }.compact,
-                  Install: {
-                    WantedBy: "default.target",
-                  })
+            Service: {
+              LimitNOFILE: new_resource.limit_no_files,
+              Environment: service_environment,
+              ExecStart: "/bin/hab sup run #{exec_start_options}",
+              ExecStop: "/bin/hab sup term",
+              Restart: "on-failure",
+            }.compact,
+            Install: {
+              WantedBy: "default.target",
+            })
           action :create
         end
 

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

@@ -66,9 +66,9 @@ class Chef
           local true
           cookbook "habitat"
           variables exec_start_options: exec_start_options,
-                    bldr_url: new_resource.bldr_url,
-                    auth_token: new_resource.auth_token,
-                    gateway_auth_token: new_resource.gateway_auth_token
+            bldr_url: new_resource.bldr_url,
+            auth_token: new_resource.auth_token,
+            gateway_auth_token: new_resource.gateway_auth_token
           # win_launcher: win_version
           action :touch
         end

data/lib/chef/resource/habitat_config.rb

@@ -26,18 +26,18 @@ class Chef
       description "Use the **habitat_config** resource to apply a configuration to a Chef Habitat service."
       introduced "17.3"
       examples <<~DOC
-      **Configure your nginx defaults**
-
-      ```ruby
-      habitat_config 'nginx.default' do
-        config({
-          worker_count: 2,
-          http: {
-            keepalive_timeout: 120
-          }
-          })
-        end
-        ```
+        **Configure your nginx defaults**
+
+        ```ruby
+        habitat_config 'nginx.default' do
+          config({
+            worker_count: 2,
+            http: {
+              keepalive_timeout: 120
+            }
+            })
+          end
+          ```
       DOC
 
       property :config, Mash, required: true, coerce: proc { |m| m.is_a?(Hash) ? Mash.new(m) : m },
@@ -53,7 +53,7 @@ class Chef
       property :remote_sup_http, String, default: "127.0.0.1:9631", desired_state: false,
         description: "Address for remote supervisor http port. Used to pull existing."
 
-      property :gateway_auth_token, String, desired_state: false,
+      property :gateway_auth_token, String, sensitive: true, desired_state: false,
         description: "Auth token for accessing the remote supervisor's http port."
 
       property :user, String, desired_state: false,

data/lib/chef/resource/habitat_install.rb

@@ -24,28 +24,28 @@ class Chef
       description "Use the **habitat_install** resource to install Chef Habitat."
       introduced "17.3"
       examples <<~DOC
-      **Installation Without a Resource Name**
+        **Installation Without a Resource Name**
 
-      ```ruby
-      habitat_install
-      ```
+        ```ruby
+        habitat_install
+        ```
 
-      **Installation specifying a habitat builder URL**
+        **Installation specifying a habitat builder URL**
 
-      ```ruby
-      habitat_install 'install habitat' do
-        bldr_url 'http://localhost'
-      end
-      ```
+        ```ruby
+        habitat_install 'install habitat' do
+          bldr_url 'http://localhost'
+        end
+        ```
 
-      **Installation specifying version and habitat builder URL**
+        **Installation specifying version and habitat builder URL**
 
-      ```ruby
-      habitat_install 'install habitat' do
-        bldr_url 'http://localhost'
-        hab_version '1.5.50'
-      end
-      ```
+        ```ruby
+        habitat_install 'install habitat' do
+          bldr_url 'http://localhost'
+          hab_version '1.5.50'
+        end
+        ```
       DOC
 
       property :name, String, default: "install habitat",

data/lib/chef/resource/habitat_service.rb

@@ -118,7 +118,7 @@ class Chef
       property :remote_sup_http, String, default: "127.0.0.1:9631", desired_state: false,
         description: "IP address and port used to communicate with the remote supervisor. If this value is invalid, the resource will update the supervisor configuration each time #{ChefUtils::Dist::Server::PRODUCT} runs."
 
-      property :gateway_auth_token, String, desired_state: false,
+      property :gateway_auth_token, String, sensitive: true, desired_state: false,
         description: "Auth token for accessing the remote supervisor's http port."
 
       property :update_condition, [Symbol, String], equal_to: [:latest, "latest", :'track-channel', "track-channel"], default: :latest, coerce: proc { |s| s.is_a?(String) ? s.to_sym : s },

data/lib/chef/resource/habitat_user_toml.rb

@@ -21,18 +21,18 @@ class Chef
       description "Use the **habitat_user_toml** to template a `user.toml` for Chef Habitat services. Configurations set in the  `user.toml` override the `default.toml` for a given package, which makes it an alternative to applying service group level configuration."
       introduced "17.3"
       examples <<~DOC
-      **Configure user specific settings to nginx**
+        **Configure user specific settings to nginx**
 
-      ```ruby
-      habitat_user_toml 'nginx' do
-        config({
-          worker_count: 2,
-          http: {
-            keepalive_timeout: 120
-          }
-          })
-        end
-        ```
+        ```ruby
+        habitat_user_toml 'nginx' do
+          config({
+            worker_count: 2,
+            http: {
+              keepalive_timeout: 120
+            }
+            })
+          end
+          ```
       DOC
 
       property :config, Mash, required: true, coerce: proc { |m| m.is_a?(Hash) ? Mash.new(m) : m },
@@ -73,7 +73,7 @@ class Chef
         def wmi_property_from_query(wmi_property, wmi_query)
           @wmi = ::WIN32OLE.connect("winmgmts://")
           result = @wmi.ExecQuery(wmi_query)
-          return unless result.each.count > 0
+          return unless result.each.any?
 
           result.each.next.send(wmi_property)
         end

data/lib/chef/resource/helpers/cron_validations.rb

@@ -29,7 +29,7 @@ class Chef
         return true if spec == "*"
 
         if spec.respond_to? :to_int
-          return spec >= min && spec <= max
+          return spec.between?(min, max)
         end
 
         # Lists of individual values, ranges, and step values all share the validity range for type
@@ -38,7 +38,7 @@ class Chef
           return false unless /^\d+$/.match?(x)
 
           x = x.to_i
-          return false unless x >= min && x <= max
+          return false unless x.between?(min, max)
         end
         true
       end

data/lib/chef/resource/homebrew_cask.rb

@@ -46,7 +46,7 @@ class Chef
       property :owner, [String, Integer],
         description: "The owner of the Homebrew installation.",
         default: lazy { find_homebrew_username },
-        default_description: "Calculated default username"\
+        default_description: "Calculated default username" \
 
       action :install, description: "Install an application that is packaged as a Homebrew cask." do
         unless casked?

data/lib/chef/resource/homebrew_package.rb

@@ -31,33 +31,33 @@ class Chef
       description "Use the **homebrew_package** resource to manage packages for the macOS platform. Note: Starting with #{ChefUtils::Dist::Infra::PRODUCT} 16 the homebrew resource now accepts an array of packages for installing multiple packages at once."
       introduced "12.0"
       examples <<~DOC
-      **Install a package**:
+        **Install a package**:
 
-      ```ruby
-      homebrew_package 'git'
-      ```
+        ```ruby
+        homebrew_package 'git'
+        ```
 
-      **Install multiple packages at once**:
+        **Install multiple packages at once**:
 
-      ```ruby
-      homebrew_package %w(git fish ruby)
-      ```
+        ```ruby
+        homebrew_package %w(git fish ruby)
+        ```
 
-      **Specify the Homebrew user with a UUID**
+        **Specify the Homebrew user with a UUID**
 
-      ```ruby
-      homebrew_package 'git' do
-        homebrew_user 1001
-      end
-      ```
+        ```ruby
+        homebrew_package 'git' do
+          homebrew_user 1001
+        end
+        ```
 
-      **Specify the Homebrew user with a string**:
+        **Specify the Homebrew user with a string**:
 
-      ```ruby
-      homebrew_package 'vim' do
-        homebrew_user 'user1'
-      end
-      ```
+        ```ruby
+        homebrew_package 'vim' do
+          homebrew_user 'user1'
+        end
+        ```
       DOC
 
       allowed_actions :install, :upgrade, :remove, :purge

data/lib/chef/resource/homebrew_tap.rb

@@ -88,7 +88,7 @@ class Chef
             "/opt/homebrew",
             "/usr/local/Homebrew",
             "/home/linuxbrew/.linuxbrew",
-          ].filter_map { |x| x if Dir.exist?(x) }.first
+          ].select { |x| Dir.exist?(x) }.first
           tap_dir = name.gsub("/", "/homebrew-")
           ::File.directory?("#{base_path}/Library/Taps/#{tap_dir}")
         end

data/lib/chef/resource/hostname.rb

@@ -237,7 +237,7 @@ class Chef
               mode "0644"
             end
           when ::File.exist?("/usr/sbin/svccfg") # solaris 5.11
-            execute "svccfg -s system/identity:node setprop config/nodename=\'#{new_resource.hostname}\'" do
+            execute "svccfg -s system/identity:node setprop config/nodename='#{new_resource.hostname}'" do
               notifies :run, "execute[svcadm refresh]", :immediately
               notifies :run, "execute[svcadm restart]", :immediately
               not_if { shell_out!("svccfg -s system/identity:node listprop config/nodename").stdout.chomp =~ %r{config/nodename\s+astring\s+#{new_resource.hostname}} }
@@ -251,7 +251,7 @@ class Chef
               action :nothing
             end
           else
-            raise "Do not know how to set hostname on os #{node["os"]}, platform #{node["platform"]},"\
+            raise "Do not know how to set hostname on os #{node["os"]}, platform #{node["platform"]}," \
               "platform_version #{node["platform_version"]}, platform_family #{node["platform_family"]}"
           end
 

data/lib/chef/resource/http_request.rb

@@ -31,10 +31,10 @@ class Chef
       allowed_actions :get, :patch, :put, :post, :delete, :head, :options
 
       property :url, String, identity: true,
-               description: "The URL to which an HTTP request is sent."
+        description: "The URL to which an HTTP request is sent."
 
       property :headers, Hash, default: {},
-               description: "A Hash of custom headers."
+        description: "A Hash of custom headers."
 
       def initialize(name, run_context = nil)
         super