chef 16.18.30 → 17.10.163

data/lib/chef/provider/service/freebsd.rb

@@ -130,27 +130,21 @@ class Chef
         # The variable name used in /etc/rc.conf for enabling this service
         def service_enable_variable_name
           @service_enable_variable_name ||=
-            begin
-              # Look for name="foo" in the shell script @init_command. Use this for determining the variable name in /etc/rc.conf
-              # corresponding to this service
-              # For example: to enable the service mysql-server with the init command /usr/local/etc/rc.d/mysql-server, you need
-              # to set mysql_enable="YES" in /etc/rc.conf$
-              if init_command
-                ::File.open(init_command) do |rcscript|
-                  rcscript.each_line do |line|
-                    if line =~ /^name="?(\w+)"?/
-                      return $1 + "_enable"
-                    end
+            if init_command
+              ::File.open(init_command) do |rcscript|
+                rcscript.each_line do |line|
+                  if line =~ /^name="?(\w+)"?/
+                    return $1 + "_enable"
                   end
                 end
-                # some scripts support multiple instances through symlinks such as openvpn.
-                # We should get the service name from rcvar.
-                logger.trace("name=\"service\" not found at #{init_command}. falling back to rcvar")
-                shell_out!("#{init_command} rcvar").stdout[/(\w+_enable)=/, 1]
-              else
-                # for why-run mode when the rcd_script is not there yet
-                new_resource.service_name
               end
+              # some scripts support multiple instances through symlinks such as openvpn.
+              # We should get the service name from rcvar.
+              logger.trace("name=\"service\" not found at #{init_command}. falling back to rcvar")
+              shell_out!("#{init_command} rcvar").stdout[/(\w+_enable)=/, 1]
+            else
+              # for why-run mode when the rcd_script is not there yet
+              new_resource.service_name
             end
         end
 
@@ -161,9 +155,9 @@ class Chef
               case line
               when /^#{Regexp.escape(var_name)}="(\w+)"/
                 enabled_state_found!
-                if $1 =~ /^yes$/i
+                if $1.casecmp?("yes")
                   current_resource.enabled true
-                elsif $1 =~ /^(no|none)$/i
+                elsif $1.casecmp?("no") || $1.casecmp?("none")
                   current_resource.enabled false
                 end
               end
@@ -171,7 +165,7 @@ class Chef
           end
 
           if current_resource.enabled.nil?
-            logger.trace("#{new_resource.name} enable/disable state unknown")
+            logger.debug("#{new_resource.name} enable/disable state unknown")
             current_resource.enabled false
           end
         end

data/lib/chef/provider/service/macosx.rb

@@ -105,7 +105,7 @@ class Chef
 
         def start_service
           if @current_resource.running
-            logger.trace("#{@new_resource} already running, not starting")
+            logger.debug("#{@new_resource} already running, not starting")
           else
             if @new_resource.start_command
               super
@@ -117,7 +117,7 @@ class Chef
 
         def stop_service
           unless @current_resource.running
-            logger.trace("#{@new_resource} not running, not stopping")
+            logger.debug("#{@new_resource} not running, not stopping")
           else
             if @new_resource.stop_command
               super
@@ -153,7 +153,7 @@ class Chef
         #
         def enable_service
           if @current_resource.enabled
-            logger.trace("#{@new_resource} already enabled, not enabling")
+            logger.debug("#{@new_resource} already enabled, not enabling")
           else
             load_service
           end
@@ -161,7 +161,7 @@ class Chef
 
         def disable_service
           unless @current_resource.enabled
-            logger.trace("#{@new_resource} not enabled, not disabling")
+            logger.debug("#{@new_resource} not enabled, not disabling")
           else
             unload_service
           end

data/lib/chef/provider/service/systemd.rb

@@ -76,6 +76,30 @@ class Chef::Provider::Service::Systemd < Chef::Provider::Service::Simple
     end
   end
 
+  def systemd_service_status
+    @systemd_service_status ||= begin
+      # Collect all the status information for a service and returns it at once
+      options, args = get_systemctl_options_args
+      s = shell_out!(systemctl_path, args, "show", "-p", "UnitFileState", "-p", "ActiveState", new_resource.service_name, **options)
+      # e.g. /bin/systemctl --system show  -p UnitFileState -p ActiveState sshd.service
+      # Returns something like:
+      # ActiveState=active
+      # UnitFileState=enabled
+      status = {}
+      s.stdout.each_line do |line|
+        k, v = line.strip.split("=")
+        status[k] = v
+      end
+
+      # Assert requisite keys exist
+      unless status.key?("UnitFileState") && status.key?("ActiveState")
+        raise Chef::Exceptions::Service, "'#{systemctl_path} show' not reporting status for #{new_resource.service_name}!"
+      end
+
+      status
+    end
+  end
+
   def get_systemctl_options_args
     if new_resource.user
       raise NotImplementedError, "#{new_resource} does not support the user property on a target_mode host (yet)" if Chef::Config.target_mode?
@@ -98,7 +122,7 @@ class Chef::Provider::Service::Systemd < Chef::Provider::Service::Simple
 
   def start_service
     if current_resource.running
-      logger.trace("#{new_resource} already running, not starting")
+      logger.debug("#{new_resource} already running, not starting")
     else
       if new_resource.start_command
         super
@@ -111,7 +135,7 @@ class Chef::Provider::Service::Systemd < Chef::Provider::Service::Simple
 
   def stop_service
     unless current_resource.running
-      logger.trace("#{new_resource} not running, not stopping")
+      logger.debug("#{new_resource} not running, not stopping")
     else
       if new_resource.stop_command
         super
@@ -146,7 +170,7 @@ class Chef::Provider::Service::Systemd < Chef::Provider::Service::Simple
 
   def enable_service
     if current_resource.masked || current_resource.indirect
-      logger.trace("#{new_resource} cannot be enabled: it is masked or indirect")
+      logger.debug("#{new_resource} cannot be enabled: it is masked or indirect")
       return
     end
     options, args = get_systemctl_options_args
@@ -155,7 +179,7 @@ class Chef::Provider::Service::Systemd < Chef::Provider::Service::Simple
 
   def disable_service
     if current_resource.masked || current_resource.indirect
-      logger.trace("#{new_resource} cannot be disabled: it is masked or indirect")
+      logger.debug("#{new_resource} cannot be disabled: it is masked or indirect")
       return
     end
     options, args = get_systemctl_options_args
@@ -173,25 +197,30 @@ class Chef::Provider::Service::Systemd < Chef::Provider::Service::Simple
   end
 
   def is_active?
-    options, args = get_systemctl_options_args
-    shell_out(systemctl_path, args, "is-active", new_resource.service_name, "--quiet", **options).exitstatus == 0
+    # Note: "activating" is not active (as with type=notify or a oneshot)
+    systemd_service_status["ActiveState"] == "active"
   end
 
   def is_enabled?
-    options, args = get_systemctl_options_args
-    shell_out(systemctl_path, args, "is-enabled", new_resource.service_name, "--quiet", **options).exitstatus == 0
+    # if the service is in sysv compat mode, shellout to determine if enabled
+    if systemd_service_status["UnitFileState"] == "bad"
+      options, args = get_systemctl_options_args
+      return shell_out(systemctl_path, args, "is-enabled", new_resource.service_name, "--quiet", **options).exitstatus == 0
+    end
+    # See https://github.com/systemd/systemd/blob/master/src/systemctl/systemctl-is-enabled.c
+    # Note: enabled-runtime is excluded because this is volatile, and the state of enabled-runtime
+    # specifically means that the service is not enabled
+    %w{enabled static generated alias indirect}.include?(systemd_service_status["UnitFileState"])
   end
 
   def is_indirect?
-    options, args = get_systemctl_options_args
-    s = shell_out(systemctl_path, args, "is-enabled", new_resource.service_name, **options)
-    s.stdout.include?("indirect")
+    systemd_service_status["UnitFileState"] == "indirect"
   end
 
   def is_masked?
-    options, args = get_systemctl_options_args
-    s = shell_out(systemctl_path, args, "is-enabled", new_resource.service_name, **options)
-    s.exitstatus != 0 && s.stdout.include?("masked")
+    # Note: masked-runtime is excluded, because runtime is volatile, and
+    # because masked-runtime is not masked.
+    systemd_service_status["UnitFileState"] == "masked"
   end
 
   private

data/lib/chef/provider/service/upstart.rb

@@ -28,10 +28,6 @@ class Chef
         # to maintain a local state of service across restart's internal calls
         attr_accessor :upstart_service_running
 
-        provides :service, platform_family: "debian", override: true do
-          upstart?
-        end
-
         UPSTART_STATE_FORMAT = %r{\S+ \(?(start|stop)?\)? ?[/ ](\w+)}.freeze
 
         # Returns true if the configs for the service name has upstart variable
@@ -65,15 +61,8 @@ class Chef
             end
           end
 
-          platform, version = Chef::Platform.find_platform_and_version(run_context.node)
-          if platform == "ubuntu" && (8.04..9.04).cover?(version.to_f)
-            @upstart_job_dir = "/etc/event.d"
-            @upstart_conf_suffix = ""
-          else
-            @upstart_job_dir = "/etc/init"
-            @upstart_conf_suffix = ".conf"
-          end
-
+          @upstart_job_dir = "/etc/init"
+          @upstart_conf_suffix = ".conf"
           @command_success = true # new_resource.status_command= false, means upstart used
           @config_file_found = true
           @upstart_command_success = true

data/lib/chef/provider/service/windows.rb

@@ -85,7 +85,7 @@ class Chef::Provider::Service::Windows < Chef::Provider::Service
 
       state = current_state
       if state == RUNNING
-        logger.trace "#{@new_resource} already started - nothing to do"
+        logger.debug "#{@new_resource} already started - nothing to do"
       elsif state == START_PENDING
         logger.trace "#{@new_resource} already sent start signal - waiting for start"
         wait_for_state(RUNNING)
@@ -114,7 +114,7 @@ class Chef::Provider::Service::Windows < Chef::Provider::Service
         raise Chef::Exceptions::Service, "Service #{@new_resource} can't be started from state [#{state}]"
       end
     else
-      logger.trace "#{@new_resource} does not exist - nothing to do"
+      logger.debug "#{@new_resource} does not exist - nothing to do"
     end
   end
 
@@ -133,7 +133,7 @@ class Chef::Provider::Service::Windows < Chef::Provider::Service
         end
         @new_resource.updated_by_last_action(true)
       elsif state == STOPPED
-        logger.trace "#{@new_resource} already stopped - nothing to do"
+        logger.debug "#{@new_resource} already stopped - nothing to do"
       elsif state == STOP_PENDING
         logger.trace "#{@new_resource} already sent stop signal - waiting for stop"
         wait_for_state(STOPPED)
@@ -141,7 +141,7 @@ class Chef::Provider::Service::Windows < Chef::Provider::Service
         raise Chef::Exceptions::Service, "Service #{@new_resource} can't be stopped from state [#{state}]"
       end
     else
-      logger.trace "#{@new_resource} does not exist - nothing to do"
+      logger.debug "#{@new_resource} does not exist - nothing to do"
     end
   end
 
@@ -156,7 +156,7 @@ class Chef::Provider::Service::Windows < Chef::Provider::Service
       end
       @new_resource.updated_by_last_action(true)
     else
-      logger.trace "#{@new_resource} does not exist - nothing to do"
+      logger.debug "#{@new_resource} does not exist - nothing to do"
     end
   end
 
@@ -164,7 +164,7 @@ class Chef::Provider::Service::Windows < Chef::Provider::Service
     if Win32::Service.exists?(@new_resource.service_name)
       set_startup_type(:automatic)
     else
-      logger.trace "#{@new_resource} does not exist - nothing to do"
+      logger.debug "#{@new_resource} does not exist - nothing to do"
     end
   end
 
@@ -172,18 +172,18 @@ class Chef::Provider::Service::Windows < Chef::Provider::Service
     if Win32::Service.exists?(@new_resource.service_name)
       set_startup_type(:disabled)
     else
-      logger.trace "#{@new_resource} does not exist - nothing to do"
+      logger.debug "#{@new_resource} does not exist - nothing to do"
     end
   end
 
   action :create do
     if Win32::Service.exists?(new_resource.service_name)
-      logger.trace "#{new_resource} already exists - nothing to do"
+      logger.debug "#{new_resource} already exists - nothing to do"
       return
     end
 
     converge_by("create service #{new_resource.service_name}") do
-      Win32::Service.new(windows_service_config)
+      Win32::Service.new(**windows_service_config)
     end
 
     converge_delayed_start
@@ -191,7 +191,7 @@ class Chef::Provider::Service::Windows < Chef::Provider::Service
 
   action :delete do
     unless Win32::Service.exists?(new_resource.service_name)
-      logger.trace "#{new_resource} does not exist - nothing to do"
+      logger.debug "#{new_resource} does not exist - nothing to do"
       return
     end
 
@@ -209,7 +209,7 @@ class Chef::Provider::Service::Windows < Chef::Provider::Service
     converge_if_changed :service_type, :startup_type, :error_control,
       :binary_path_name, :load_order_group, :dependencies,
       :run_as_user, :display_name, :description do
-        Win32::Service.configure(windows_service_config(:configure))
+        Win32::Service.configure(**windows_service_config(:configure))
       end
 
     converge_delayed_start
@@ -222,7 +222,7 @@ class Chef::Provider::Service::Windows < Chef::Provider::Service
         logger.info("#{@new_resource} enabled")
       end
     else
-      logger.trace("#{@new_resource} already enabled - nothing to do")
+      logger.debug("#{@new_resource} already enabled - nothing to do")
     end
     load_new_resource_state
     @new_resource.enabled(true)
@@ -235,7 +235,7 @@ class Chef::Provider::Service::Windows < Chef::Provider::Service
         logger.info("#{@new_resource} disabled")
       end
     else
-      logger.trace("#{@new_resource} already disabled - nothing to do")
+      logger.debug("#{@new_resource} already disabled - nothing to do")
     end
     load_new_resource_state
     @new_resource.enabled(false)
@@ -248,7 +248,7 @@ class Chef::Provider::Service::Windows < Chef::Provider::Service
         set_startup_type(startup_type)
       end
     else
-      logger.trace("#{@new_resource} startup_type already #{startup_type} - nothing to do")
+      logger.debug("#{@new_resource} startup_type already #{startup_type} - nothing to do")
     end
 
     converge_delayed_start
@@ -268,7 +268,7 @@ class Chef::Provider::Service::Windows < Chef::Provider::Service
       password: new_resource.run_as_password,
     }.reject { |k, v| v.nil? || v.length == 0 }
 
-    Win32::Service.configure(new_config)
+    Win32::Service.configure(**new_config)
     logger.info "#{new_resource} configured."
 
     grant_service_logon(new_resource.run_as_user) if new_resource.run_as_user != "localsystem"
@@ -395,7 +395,7 @@ class Chef::Provider::Service::Windows < Chef::Provider::Service
       config[:service_name]  = new_resource.service_name
       config[:delayed_start] = new_resource.delayed_start ? 1 : 0
 
-      Win32::Service.configure(config)
+      Win32::Service.configure(**config)
     end
   end
 

data/lib/chef/provider/service.rb

@@ -82,7 +82,7 @@ class Chef
 
       action :enable do
         if current_resource.enabled
-          logger.trace("#{new_resource} already enabled - nothing to do")
+          logger.debug("#{new_resource} already enabled - nothing to do")
         else
           converge_by("enable service #{new_resource}") do
             enable_service
@@ -100,7 +100,7 @@ class Chef
             logger.info("#{new_resource} disabled")
           end
         else
-          logger.trace("#{new_resource} already disabled - nothing to do")
+          logger.debug("#{new_resource} already disabled - nothing to do")
         end
         load_new_resource_state
         new_resource.enabled(false)
@@ -108,7 +108,7 @@ class Chef
 
       action :mask do
         if current_resource.masked
-          logger.trace("#{new_resource} already masked - nothing to do")
+          logger.debug("#{new_resource} already masked - nothing to do")
         else
           converge_by("mask service #{new_resource}") do
             mask_service
@@ -126,7 +126,7 @@ class Chef
             logger.info("#{new_resource} unmasked")
           end
         else
-          logger.trace("#{new_resource} already unmasked - nothing to do")
+          logger.debug("#{new_resource} already unmasked - nothing to do")
         end
         load_new_resource_state
         new_resource.masked(false)
@@ -139,7 +139,7 @@ class Chef
             logger.info("#{new_resource} started")
           end
         else
-          logger.trace("#{new_resource} already running - nothing to do")
+          logger.debug("#{new_resource} already running - nothing to do")
         end
         load_new_resource_state
         new_resource.running(true)
@@ -152,7 +152,7 @@ class Chef
             logger.info("#{new_resource} stopped")
           end
         else
-          logger.trace("#{new_resource} already stopped - nothing to do")
+          logger.debug("#{new_resource} already stopped - nothing to do")
         end
         load_new_resource_state
         new_resource.running(false)

data/lib/chef/provider/subversion.rb

@@ -55,38 +55,38 @@ class Chef
         end
       end
 
-      action :checkout do
+      action :checkout, description: "Clone or check out the source. When a checkout is available, this provider does nothing." do
         if target_dir_non_existent_or_empty?
           converge_by("perform checkout of #{new_resource.repository} into #{new_resource.destination}") do
-            shell_out!(checkout_command, run_options)
+            shell_out!(checkout_command, **run_options)
           end
         else
-          logger.trace "#{new_resource} checkout destination #{new_resource.destination} already exists or is a non-empty directory - nothing to do"
+          logger.debug "#{new_resource} checkout destination #{new_resource.destination} already exists or is a non-empty directory - nothing to do"
         end
       end
 
-      action :export do
+      action :export, description: "Export the source, excluding or removing any version control artifacts." do
         if target_dir_non_existent_or_empty?
           action_force_export
         else
-          logger.trace "#{new_resource} export destination #{new_resource.destination} already exists or is a non-empty directory - nothing to do"
+          logger.debug "#{new_resource} export destination #{new_resource.destination} already exists or is a non-empty directory - nothing to do"
         end
       end
 
-      action :force_export do
+      action :force_export, description: "Export the source, excluding or removing any version control artifacts and force an export of the source that is overwriting the existing copy (if it exists)." do
         converge_by("export #{new_resource.repository} into #{new_resource.destination}") do
-          shell_out!(export_command, run_options)
+          shell_out!(export_command, **run_options)
         end
       end
 
-      action :sync do
+      action :sync, description: "Update the source to the specified version, or get a new clone or checkout. This action causes a hard reset of the index and working tree, discarding any uncommitted changes." do
         assert_target_directory_valid!
         if ::File.exist?(::File.join(new_resource.destination, ".svn"))
           current_rev = find_current_revision
           logger.trace "#{new_resource} current revision: #{current_rev} target revision: #{revision_int}"
           unless current_revision_matches_target_revision?
             converge_by("sync #{new_resource.destination} from #{new_resource.repository}") do
-              shell_out!(sync_command, run_options)
+              shell_out!(sync_command, **run_options)
               logger.info "#{new_resource} updated to revision: #{revision_int}"
             end
           end
@@ -121,16 +121,14 @@ class Chef
       # up the revision id by asking the server
       # If the specified revision is an integer, trust it.
       def revision_int
-        @revision_int ||= begin
-          if /^\d+$/.match?(new_resource.revision)
-            new_resource.revision
-          else
-            command = scm(:info, new_resource.repository, new_resource.svn_info_args, authentication, "-r#{new_resource.revision}")
-            svn_info = shell_out!(command, run_options(cwd: cwd, returns: [0, 1])).stdout
-
-            extract_revision_info(svn_info)
-          end
-        end
+        @revision_int ||= if /^\d+$/.match?(new_resource.revision)
+                            new_resource.revision
+                          else
+                            command = scm(:info, new_resource.repository, new_resource.svn_info_args, authentication, "-r#{new_resource.revision}")
+                            svn_info = shell_out!(command, **run_options(cwd: cwd, returns: [0, 1])).stdout
+
+                            extract_revision_info(svn_info)
+                          end
       end
 
       alias :revision_slug :revision_int
@@ -139,7 +137,7 @@ class Chef
         return nil unless ::File.exist?(::File.join(new_resource.destination, ".svn"))
 
         command = scm(:info)
-        svn_info = shell_out!(command, run_options(cwd: cwd, returns: [0, 1])).stdout
+        svn_info = shell_out!(command, **run_options(cwd: cwd, returns: [0, 1])).stdout
 
         extract_revision_info(svn_info)
       end

data/lib/chef/provider/support/yum_repo.erb

@@ -1,4 +1,4 @@
-# This file was generated by Chef
+# This file was generated by Chef Infra
 # Do NOT modify this file by hand.
 
 [<%= @config.repositoryid %>]

data/lib/chef/provider/support/zypper_repo.erb

@@ -1,15 +1,17 @@
-# This file was generated by Chef
+# This file was generated by Chef Infra
 # Do NOT modify this file by hand.
 
 [<%= @config.repo_name %>]
 <% %w{ type enabled autorefresh gpgcheck gpgkey baseurl mirrorlist path priority keeppackages mode refresh_cache }.each do |prop| -%>
-<%  next if @config.send(prop.to_sym).nil? -%>
+<%  next if @config.send(prop.to_sym).nil? || (@config.send(prop.to_sym).is_a?(Array) && @config.send(prop.to_sym).empty?) -%>
 <%= prop %>=<%=
        case @config.send(prop.to_sym)
        when TrueClass
          '1'
        when FalseClass
          '0'
+       when Array
+         @config.send(prop.to_sym).join("\n       ")
        else
          @config.send(prop.to_sym)
        end %>