chef 17.0.242-universal-mingw32 → 17.4.25-universal-mingw32

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

@@ -0,0 +1,67 @@
+#
+# 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 "habitat_sup"
+
+class Chef
+  class Resource
+    class HabitatSupSystemd < HabitatSup
+      provides :habitat_sup, os: "linux"
+      provides :habitat_sup_systemd
+
+      action :run do
+        super()
+
+        service_environment = []
+        service_environment.push("HAB_BLDR_URL=#{new_resource.bldr_url}") if new_resource.bldr_url
+        service_environment.push("HAB_AUTH_TOKEN=#{new_resource.auth_token}") if new_resource.auth_token
+        service_environment.push("HAB_SUP_GATEWAY_AUTH_TOKEN=#{new_resource.gateway_auth_token}") if new_resource.gateway_auth_token
+        systemd_unit "hab-sup.service" do
+          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",
+                  })
+          action :create
+        end
+
+        service "hab-sup" do
+          subscribes :restart, "systemd_unit[hab-sup.service]"
+          subscribes :restart, "habitat_package[core/hab-sup]"
+          subscribes :restart, "habitat_package[core/hab-launcher]"
+          subscribes :restart, "template[/hab/sup/default/config/sup.toml]"
+          action %i{enable start}
+          not_if { node["chef_packages"]["chef"]["chef_root"].include?("/pkgs/chef/chef-infra-client") }
+        end
+      end
+
+      action :stop do
+        service "hab-sup" do
+          action :stop
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+#
+# 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 "win32/service" if RUBY_PLATFORM =~ /mswin|mingw32|windows/
+require_relative "habitat_sup"
+
+class Chef
+  class Resource
+    class HabitatSupWindows < HabitatSup
+      provides :habitat_sup, os: "windows"
+      provides :habitat_sup_windows
+
+      service_file = ::File.expand_path("../support/HabService.dll.config.erb")
+      win_service_config = "C:/hab/svc/windows-service/HabService.dll.config"
+
+      action :run do
+        super()
+
+        # TODO: There has to be a better way to handle auth token on windows
+        # than the system wide environment variable
+        auth_action = new_resource.auth_token ? :create : :delete
+        env "HAB_AUTH_TOKEN" do
+          value new_resource.auth_token if new_resource.auth_token
+          action auth_action
+        end
+
+        gateway_auth_action = new_resource.gateway_auth_token ? :create : :delete
+        env "HAB_SUP_GATEWAY_AUTH_TOKEN" do
+          value new_resource.gateway_auth_token if new_resource.gateway_auth_token
+          action gateway_auth_action
+        end
+
+        bldr_action = new_resource.bldr_url ? :create : :delete
+        env "HAB_BLDR_URL" do
+          value new_resource.bldr_url if new_resource.bldr_url
+          action bldr_action
+        end
+
+        habitat_package "core/windows-service" do
+          bldr_url new_resource.bldr_url if new_resource.bldr_url
+          version new_resource.service_version if new_resource.service_version
+        end
+
+        execute "hab pkg exec core/windows-service install" do
+          not_if { ::Win32::Service.exists?("Habitat") }
+        end
+
+        # win_version = `dir /D /B C:\\hab\\pkgs\\core\\hab-launcher`.split().last
+
+        template win_service_config.to_s do
+          source ::File.expand_path("../support/HabService.dll.config.erb", __dir__)
+          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
+          # win_launcher: win_version
+          action :touch
+        end
+
+        service "Habitat" do
+          subscribes :restart, "env[HAB_AUTH_TOKEN]"
+          subscribes :restart, "env[HAB_SUP_GATEWAY_AUTH_TOKEN]"
+          subscribes :restart, "env[HAB_BLDR_URL]"
+          subscribes :restart, "template[#{win_service_config}]"
+          subscribes :restart, "habitat_package[core/hab-sup]"
+          subscribes :restart, "habitat_package[core/hab-launcher]"
+          subscribes :restart, "template[C:/hab/sup/default/config/sup.toml]"
+          action %i{enable start}
+          not_if { node["chef_packages"]["chef"]["chef_root"].include?("/pkgs/chef/chef-infra-client") }
+        end
+      end
+    end
+  end
+end

data/lib/chef/resource/habitat_config.rb

@@ -0,0 +1,107 @@
+# 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"
+require_relative "../json_compat"
+require_relative "../resource"
+
+class Chef
+  class Resource
+    class HabitatConfig < Chef::Resource
+      unified_mode true
+
+      provides :habitat_config
+
+      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
+        ```
+      DOC
+
+      property :config, Mash, required: true, coerce: proc { |m| m.is_a?(Hash) ? Mash.new(m) : m },
+        description: "The configuration to apply as a ruby hash, for example, `{ worker_count: 2, http: { keepalive_timeout: 120 } }`."
+
+      property :service_group, String, name_property: true, desired_state: false,
+        description: "The service group to apply the configuration to. For example, `nginx.default`"
+
+      property :remote_sup, String, default: "127.0.0.1:9632", desired_state: false,
+        description: "Address to a remote supervisor's control gateway."
+
+      # Http port needed for querying/comparing current config value
+      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,
+        description: "Auth token for accessing the remote supervisor's http port."
+
+      property :user, String, desired_state: false,
+        description: "Name of user key to use for encryption. Passes `--user` to `hab config apply`."
+
+      load_current_value do
+        http_uri = "http://#{remote_sup_http}"
+
+        begin
+          headers = {}
+          headers["Authorization"] = "Bearer #{gateway_auth_token}" if property_is_set?(:gateway_auth_token)
+          census = Mash.new(Chef::HTTP::SimpleJSON.new(http_uri).get("/census", headers))
+          sc = census["census_groups"][service_group]["service_config"]["value"]
+        rescue
+          # Default to a blank config if anything (http error, json parsing, finding
+          # the config object) goes wrong
+          sc = {}
+        end
+        config sc
+      end
+
+      action :apply, description: "applies the given configuration" do
+        converge_if_changed do
+          # Use the current timestamp as the serial number/incarnation
+          incarnation = Time.now.tv_sec
+
+          opts = []
+          # opts gets flattened by shell_out_compact later
+          opts << ["--remote-sup", new_resource.remote_sup] if new_resource.remote_sup
+          opts << ["--user", new_resource.user] if new_resource.user
+
+          tempfile = Tempfile.new(["habitat_config", ".toml"])
+          begin
+            tempfile.write(render_toml(new_resource.config))
+            tempfile.close
+
+            hab("config", "apply", opts, new_resource.service_group, incarnation, tempfile.path)
+          ensure
+            tempfile.close
+            tempfile.unlink
+          end
+        end
+      end
+
+      action_class do
+        use "../resource/habitat/habitat_shared"
+      end
+    end
+  end
+end

data/lib/chef/resource/habitat_install.rb

@@ -0,0 +1,247 @@
+#
+# 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 "../resource"
+class Chef
+  class Resource
+    class HabitatInstall < Chef::Resource
+      unified_mode true
+      provides :habitat_install
+
+      description "Use the **habitat_install** resource to install Chef Habitat."
+      introduced "17.3"
+      examples <<~DOC
+      **Installation Without a Resource Name**
+
+      ```ruby
+      habitat_install
+      ```
+
+      **Installation specifying a habitat builder URL**
+
+      ```ruby
+      habitat_install 'install habitat' do
+        bldr_url 'http://localhost'
+      end
+      ```
+
+      **Installation specifying version and habitat builder URL**
+
+      ```ruby
+      habitat_install 'install habitat' do
+        bldr_url 'http://localhost'
+        hab_version '1.5.50'
+      end
+      ```
+      DOC
+
+      property :name, String, default: "install habitat",
+        description: "Name of the resource block. This has no impact other than logging."
+
+      property :install_url, String, default: "https://raw.githubusercontent.com/habitat-sh/habitat/master/components/hab/install.sh",
+        description: "URL to the install script, default is from the [habitat repo](https://raw.githubusercontent.com/habitat-sh/habitat/master/components/hab/install.sh) ."
+
+      property :bldr_url, String,
+        description: "Optional URL to an alternate Habitat Builder."
+
+      property :create_user, [true, false], default: true,
+        description: "Creates the `hab` system user."
+
+      property :tmp_dir, String,
+        description: "Sets TMPDIR environment variable for location to place temp files. Note: This is required if `/tmp` and `/var/tmp` are mounted `noexec`."
+
+      property :license, String, equal_to: ["accept"],
+        description: "Specifies acceptance of habitat license when set to `accept`."
+
+      property :hab_version, String,
+        description: "Specify the version of `Habitat` you would like to install."
+
+      action :install, description: "Installs Habitat. Does nothing if the `hab` binary is found in the default location for the system (`/bin/hab` on Linux, `/usr/local/bin/hab` on macOS, `C:/habitat/hab.exe` on Windows)" do
+        if ::File.exist?(hab_path)
+          cmd = shell_out!([hab_path, "--version"].flatten.compact.join(" "))
+          version = %r{hab (\d*\.\d*\.\d[^\/]*)}.match(cmd.stdout)[1]
+          return if version == new_resource.hab_version
+        end
+
+        if windows?
+          # Retrieve version information
+          uri = "https://packages.chef.io/files"
+          package_name = "hab-x86_64-windows"
+          habfile = "#{Chef::Config[:file_cache_path]}/#{package_name}.zip"
+
+          # TODO: Figure out how to properly validate the shasum for windows. Doesn't seem it's published
+          # as a .sha265sum like for the linux .tar.gz
+          download = "#{uri}/stable/habitat/latest/hab-x86_64-windows.zip"
+
+          remote_file habfile do
+            source download
+          end
+
+          archive_file "#{package_name}.zip" do
+            path habfile
+            destination "#{Chef::Config[:file_cache_path]}/habitat"
+            action :extract
+            not_if { ::Dir.exist?('c:\habitat') }
+          end
+
+          directory 'c:\habitat' do
+            notifies :run, "powershell_script[installing from archive]", :immediately
+          end
+
+          powershell_script "installing from archive" do
+            code <<-EOH
+      Move-Item -Path #{Chef::Config[:file_cache_path]}/habitat/hab-*/* -Destination C:/habitat -Force
+            EOH
+            action :nothing
+          end
+
+          # TODO: This won't self heal if missing until the next upgrade
+          windows_path 'C:\habitat' do
+            action :add
+          end
+        else
+          package %w{curl tar gzip}
+
+          if new_resource.create_user
+            group "hab"
+
+            user "hab" do
+              gid "hab"
+              system true
+            end
+          end
+
+          remote_file ::File.join(Chef::Config[:file_cache_path], "hab-install.sh") do
+            source new_resource.install_url
+            sensitive true
+          end
+
+          execute "installing with hab-install.sh" do
+            command hab_command
+            environment(
+              {
+                "HAB_BLDR_URL" => "bldr_url",
+                "TMPDIR" => "tmp_dir",
+              }.each_with_object({}) do |(var, property), env|
+                env[var] = new_resource.send(property.to_sym) if new_resource.send(property.to_sym)
+              end
+            )
+          end
+        end
+        execute "hab license accept" if new_resource.license == "accept"
+      end
+
+      # TODO: Work out cleanest method to implement upgrade that will support effortless installs as well as standard chef-client
+      # action :upgrade do
+      #   if platform_family?('windows')
+      #     # Retrieve version information
+      #     uri = 'https://packages.chef.io/files'
+      #     package_name = 'hab-x86_64-windows'
+      #     zipfile = "#{Chef::Config[:file_cache_path]}/#{package_name}.zip"
+
+      #     # TODO: Figure out how to properly validate the shasum for windows. Doesn't seem it's published
+      #     # as a .sha265sum like for the linux .tar.gz
+      #     download = "#{uri}/stable/habitat/latest/hab-x86_64-windows.zip"
+
+      #     remote_file zipfile do
+      #       source download
+      #     end
+
+      #     if Chef::VERSION.to_i < 15
+      #       ruby_block "#{package_name}.zip" do
+      #         block do
+      #           require 'zip'
+      #           Zip::File.open(zipfile) do |zip_file|
+      #             zip_file.each do |f|
+      #               fpath = "#{Chef::Config[:file_cache_path]}/habitat/" + f.name
+      #               zip_file.extract(f, fpath) # unless ::File.exist?(fpath)
+      #             end
+      #           end
+      #         end
+      #         action :run
+      #       end
+      #     else
+      #       archive_file "#{package_name}.zip" do
+      #         path zipfile
+      #         destination "#{Chef::Config[:file_cache_path]}/habitat"
+      #         action :extract
+      #       end
+      #     end
+
+      #     powershell_script 'installing from archive' do
+      #       code <<-EOH
+      #       Move-Item -Path #{Chef::Config[:file_cache_path]}/habitat/hab-*/* -Destination C:/habitat -Force
+      #       EOH
+      #     end
+
+      #     # TODO: This won't self heal if missing until the next upgrade
+      #     if Chef::VERSION.to_i < 14
+      #       env 'PATH_c-habitat' do
+      #         key_name 'PATH'
+      #         delim ';' # this was missing
+      #         value 'C:\habitat'
+      #         action :modify
+      #       end
+      #     else
+      #       windows_path 'C:\habitat' do
+      #         action :add
+      #       end
+      #     end
+      #   else
+      #     remote_file ::File.join(Chef::Config[:file_cache_path], 'hab-install.sh') do
+      #       source new_resource.install_url
+      #       sensitive true
+      #     end
+
+      #     execute 'installing with hab-install.sh' do
+      #       command hab_command
+      #       environment(
+      #         {
+      #           'HAB_BLDR_URL' => 'bldr_url',
+      #           'TMPDIR' => 'tmp_dir',
+      #         }.each_with_object({}) do |(var, property), env|
+      #           env[var] = new_resource.send(property.to_sym) if new_resource.send(property.to_sym)
+      #         end
+      #       )
+      #       not_if { ::File.exist?('/bin/hab') }
+      #     end
+      #   end
+      # end
+
+      action_class do
+        use "../resource/habitat/habitat_shared"
+
+        def hab_path
+          if macos?
+            "/usr/local/bin/hab"
+          elsif windows?
+            "C:/habitat/hab.exe"
+          else
+            "/bin/hab"
+          end
+        end
+
+        def hab_command
+          cmd = "bash #{Chef::Config[:file_cache_path]}/hab-install.sh"
+          cmd << " -v #{new_resource.hab_version} " if new_resource.hab_version
+          cmd << " -t x86_64-linux-kernel2" if node["kernel"]["release"].to_i < 3
+          cmd
+        end
+      end
+    end
+  end
+end