chef 18.10.17 → 19.1.164

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

@@ -1,5 +1,5 @@
 #
-# Copyright:: Chef Software Inc.
+#  Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 #
 # License:: Apache License, Version 2.0
 #
@@ -22,107 +22,109 @@ class Chef
   class Resource
     class HabitatPackage < Chef::Resource::Package
 
-      provides :habitat_package
+      provides :habitat_package, target_mode: true
+      target_mode support: :full
+
       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
-        ```
+      **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**"
+      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."
+      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."
+      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."
+      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."
+      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+.**"
+      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)"
+      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."
+      description: "Remove package but retain dependencies."
     end
   end
 end

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

@@ -1,5 +1,5 @@
 #
-# Copyright:: Chef Software, Inc.
+#  Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,175 +21,176 @@ class Chef
   class Resource
     class HabitatSup < Chef::Resource
 
-      provides :habitat_sup do |_node|
+      provides(:habitat_sup, target_mode: true) do |_node|
         false
       end
+      target_mode support: :full
 
       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."
+      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."
+      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
           license new_resource.license
           hab_version new_resource.sup_version if new_resource.sup_version
-          not_if { ::File.exist?("/bin/hab") }
-          not_if { ::File.exist?("/usr/bin/hab") }
-          not_if { ::File.exist?("c:/habitat/hab.exe") }
-          not_if { ::File.exist?("c:/ProgramData/Habitat/hab.exe") }
+          not_if { ::TargetIO::File.exist?("/bin/hab") }
+          not_if { ::TargetIO::File.exist?("/usr/bin/hab") }
+          not_if { ::TargetIO::File.exist?("c:/habitat/hab.exe") }
+          not_if { ::TargetIO::File.exist?("c:/ProgramData/Habitat/hab.exe") }
         end
 
         habitat_package "core/hab-sup" do
@@ -205,7 +206,7 @@ class Chef
         if windows?
           directory "C:/hab/sup/default/config" do
             recursive true
-            only_if { ::Dir.exist?("C:/hab") }
+            only_if { ::TargetIO::Dir.exist?("C:/hab") }
             only_if { use_toml_config }
             action :create
           end
@@ -235,14 +236,14 @@ class Chef
               keep_latest_packages: new_resource.keep_latest
             )
             only_if { use_toml_config }
-            only_if { ::Dir.exist?("C:/hab/sup/default/config") }
+            only_if { ::TargetIO::Dir.exist?("C:/hab/sup/default/config") }
           end
         else
           directory "/hab/sup/default/config" do
             mode "0755"
             recursive true
             only_if { use_toml_config }
-            only_if { ::Dir.exist?("/hab") }
+            only_if { ::TargetIO::Dir.exist?("/hab") }
             action :create
           end
 
@@ -271,7 +272,7 @@ class Chef
               keep_latest_packages: new_resource.keep_latest
             )
             only_if { use_toml_config }
-            only_if { ::Dir.exist?("/hab/sup/default/config") }
+            only_if { ::TargetIO::Dir.exist?("/hab/sup/default/config") }
           end
         end
       end

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

@@ -1,5 +1,5 @@
 #
-# Copyright:: Chef Software, Inc.
+#  Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -20,8 +20,9 @@ require_relative "habitat_sup"
 class Chef
   class Resource
     class HabitatSupSystemd < HabitatSup
-      provides :habitat_sup, os: "linux"
-      provides :habitat_sup_systemd
+      provides :habitat_sup, os: "linux", target_mode: true
+      provides :habitat_sup_systemd, target_mode: true
+      target_mode support: :full
 
       action :run do
         super()
@@ -34,16 +35,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

@@ -1,5 +1,5 @@
 #
-# Copyright:: Chef Software, Inc.
+#  Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -23,6 +23,7 @@ class Chef
     class HabitatSupWindows < HabitatSup
       provides :habitat_sup, os: "windows"
       provides :habitat_sup_windows
+      target_mode support: false
 
       service_file = ::File.expand_path("../support/HabService.dll.config.erb")
       win_service_config = "C:/hab/svc/windows-service/HabService.dll.config"
@@ -66,9 +67,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