chef 12.5.1 → 12.6.0

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

@@ -35,6 +35,10 @@ class Chef
         end
 
         def load_current_resource
+          if @new_resource.gid
+            Chef::Log.warn("The 'gid' attribute is not implemented by the Windows platform. Please use the 'group' resource to assign a user to a group.")
+          end          
+
           @current_resource = Chef::Resource::User.new(@new_resource.name)
           @current_resource.username(@new_resource.username)
           user_info = nil
@@ -42,7 +46,6 @@ class Chef
             user_info = @net_user.get_info
 
             @current_resource.uid(user_info[:user_id])
-            @current_resource.gid(user_info[:primary_group_id])
             @current_resource.comment(user_info[:full_name])
             @current_resource.home(user_info[:home_dir])
             @current_resource.shell(user_info[:script_path])
@@ -65,7 +68,7 @@ class Chef
             Chef::Log.debug("#{@new_resource} password has changed")
             return true
           end
-          [ :uid, :gid, :comment, :home, :shell ].any? do |user_attrib|
+          [ :uid, :comment, :home, :shell ].any? do |user_attrib|
             !@new_resource.send(user_attrib).nil? && @new_resource.send(user_attrib) != @current_resource.send(user_attrib)
           end
         end
@@ -100,7 +103,6 @@ class Chef
           field_list = {
             'comment' => 'full_name',
             'home' => 'home_dir',
-            'gid' => 'primary_group_id',
             'uid' => 'user_id',
             'shell' => 'script_path',
             'password' => 'password'

data/lib/chef/recipe.rb

@@ -97,10 +97,8 @@ class Chef
     # true<TrueClass>:: If all the parameters are present
     # false<FalseClass>:: If any of the parameters are missing
     def tagged?(*tags)
-      return false if run_context.node[:tags].nil?
-
       tags.each do |tag|
-        return false unless run_context.node[:tags].include?(tag)
+        return false unless run_context.node.tags.include?(tag)
       end
       true
     end
@@ -111,10 +109,10 @@ class Chef
     # tags<Array>:: A list of tags
     #
     # === Returns
-    # tags<Array>:: The current list of run_context.node[:tags]
+    # tags<Array>:: The current list of run_context.node.tags
     def untag(*tags)
       tags.each do |tag|
-        run_context.node.normal[:tags].delete(tag)
+        run_context.node.tags.delete(tag)
       end
     end
 

data/lib/chef/resource.rb

@@ -19,7 +19,6 @@
 #
 
 require 'chef/exceptions'
-require 'chef/mixin/params_validate'
 require 'chef/dsl/platform_introspection'
 require 'chef/dsl/data_query'
 require 'chef/dsl/registry_helper'
@@ -37,9 +36,11 @@ require 'chef/platform'
 require 'chef/resource/resource_notification'
 require 'chef/provider_resolver'
 require 'chef/resource_resolver'
+require 'chef/provider'
 require 'set'
 
 require 'chef/mixin/deprecation'
+require 'chef/mixin/properties'
 require 'chef/mixin/provides'
 require 'chef/mixin/shell_out'
 require 'chef/mixin/powershell_out'
@@ -61,6 +62,34 @@ class Chef
     include Chef::Mixin::ShellOut
     include Chef::Mixin::PowershellOut
 
+    # Bring in `property` and `property_type`
+    include Chef::Mixin::Properties
+
+    #
+    # The name of this particular resource.
+    #
+    # This special resource attribute is set automatically from the declaration
+    # of the resource, e.g.
+    #
+    #   execute 'Vitruvius' do
+    #     command 'ls'
+    #   end
+    #
+    # Will set the name to "Vitruvius".
+    #
+    # This is also used in to_s to show the resource name, e.g. `execute[Vitruvius]`.
+    #
+    # This is also used for resource notifications and subscribes in the same manner.
+    #
+    # This will coerce any object into a string via #to_s.  Arrays are a special case
+    # so that `package ["foo", "bar"]` becomes package[foo, bar] instead of the more
+    # awkward `package[["foo", "bar"]]` that #to_s would produce.
+    #
+    # @param name [Object] The name to set, typically a String or Array
+    # @return [String] The name of this Resource.
+    #
+    property :name, String, coerce: proc { |v| v.is_a?(Array) ? v.join(', ') : v.to_s }, desired_state: false
+
     #
     # The node the current Chef run is using.
     #
@@ -132,30 +161,6 @@ class Chef
       @sensitive = false
     end
 
-    #
-    # The list of properties defined on this resource.
-    #
-    # Everything defined with `property` is in this list.
-    #
-    # @param include_superclass [Boolean] `true` to include properties defined
-    #   on superclasses; `false` or `nil` to return the list of properties
-    #   directly on this class.
-    #
-    # @return [Hash<Symbol,Property>] The list of property names and types.
-    #
-    def self.properties(include_superclass=true)
-      @properties ||= {}
-      if include_superclass
-        if superclass.respond_to?(:properties)
-          superclass.properties.merge(@properties)
-        else
-          @properties.dup
-        end
-      else
-        @properties
-      end
-    end
-
     #
     # The action or actions that will be taken when this resource is run.
     #
@@ -204,6 +209,8 @@ class Chef
     #     actions have been run.  This is the default.
     #   - `immediate`, `immediately`: Will run the action on the other resource
     #     immediately (before any other action is run).
+    #   - `before`: Will run the action on the other resource
+    #     immediately *before* the action is actually run.
     #
     # @example Resource by string
     #   file '/foo.txt' do
@@ -246,9 +253,11 @@ class Chef
           notifies_delayed(action, resource)
         when 'immediate', 'immediately'
           notifies_immediately(action, resource)
+        when 'before'
+          notifies_before(action, resource)
         else
           raise ArgumentError,  "invalid timing: #{timing} for notifies(#{action}, #{resources.inspect}, #{timing}) resource #{self} "\
-          "Valid timings are: :delayed, :immediate, :immediately"
+          "Valid timings are: :delayed, :immediate, :immediately, :before"
         end
       end
 
@@ -272,6 +281,8 @@ class Chef
     #     actions have been run.  This is the default.
     #   - `immediate`, `immediately`: The action will run immediately following
     #     the other resource being updated.
+    #   - `before`: The action will run immediately before the
+    #     other resource is updated.
     #
     # @example Resources by string
     #   file '/foo.txt' do
@@ -597,12 +608,26 @@ class Chef
           events.resource_failed(self, action, e)
           raise customize_exception(e)
         end
-      ensure
-        @elapsed_time = Time.now - start_time
-        # Reporting endpoint doesn't accept a negative resource duration so set it to 0.
-        # A negative value can occur when a resource changes the system time backwards
-        @elapsed_time = 0 if @elapsed_time < 0
-        events.resource_completed(self)
+      end
+    ensure
+      @elapsed_time = Time.now - start_time
+      # Reporting endpoint doesn't accept a negative resource duration so set it to 0.
+      # A negative value can occur when a resource changes the system time backwards
+      @elapsed_time = 0 if @elapsed_time < 0
+      events.resource_completed(self)
+    end
+
+    #
+    # If we are currently initializing the resource, this will be true.
+    #
+    # Do NOT use this. It may be removed. It is for internal purposes only.
+    # @api private
+    attr_reader :resource_initializing
+    def resource_initializing=(value)
+      if value
+        @resource_initializing = true
+      else
+        remove_instance_variable(:@resource_initializing)
       end
     end
 
@@ -660,13 +685,18 @@ class Chef
     end
 
     def to_hash
+      # Grab all current state, then any other ivars (backcompat)
+      result = {}
+      self.class.state_properties.each do |p|
+        result[p.name] = p.get(self)
+      end
       safe_ivars = instance_variables.map { |ivar| ivar.to_sym } - FORBIDDEN_IVARS
-      instance_vars = Hash.new
       safe_ivars.each do |iv|
         key = iv.to_s.sub(/^@/,'').to_sym
-        instance_vars[key] = instance_variable_get(iv)
+        next if result.has_key?(key)
+        result[key] = instance_variable_get(iv)
       end
-      instance_vars
+      result
     end
 
     def self.json_create(o)
@@ -681,7 +711,6 @@ class Chef
     # Resource Definition Interface (for resource developers)
     #
 
-    include Chef::Mixin::ParamsValidate
     include Chef::Mixin::Deprecation
 
     #
@@ -714,240 +743,6 @@ class Chef
       provider(arg)
     end
 
-    #
-    # Create a property on this resource class.
-    #
-    # If a superclass has this property, or if this property has already been
-    # defined by this resource, this will *override* the previous value.
-    #
-    # @param name [Symbol] The name of the property.
-    # @param type [Object,Array<Object>] The type(s) of this property.
-    #   If present, this is prepended to the `is` validation option.
-    # @param options [Hash<Symbol,Object>] Validation options.
-    #   @option options [Object,Array] :is An object, or list of
-    #     objects, that must match the value using Ruby's `===` operator
-    #     (`options[:is].any? { |v| v === value }`).
-    #   @option options [Object,Array] :equal_to An object, or list
-    #     of objects, that must be equal to the value using Ruby's `==`
-    #     operator (`options[:is].any? { |v| v == value }`)
-    #   @option options [Regexp,Array<Regexp>] :regex An object, or
-    #     list of objects, that must match the value with `regex.match(value)`.
-    #   @option options [Class,Array<Class>] :kind_of A class, or
-    #     list of classes, that the value must be an instance of.
-    #   @option options [Hash<String,Proc>] :callbacks A hash of
-    #     messages -> procs, all of which match the value. The proc must
-    #     return a truthy or falsey value (true means it matches).
-    #   @option options [Symbol,Array<Symbol>] :respond_to A method
-    #     name, or list of method names, the value must respond to.
-    #   @option options [Symbol,Array<Symbol>] :cannot_be A property,
-    #     or a list of properties, that the value cannot have (such as `:nil` or
-    #     `:empty`). The method with a questionmark at the end is called on the
-    #     value (e.g. `value.empty?`). If the value does not have this method,
-    #     it is considered valid (i.e. if you don't respond to `empty?` we
-    #     assume you are not empty).
-    #   @option options [Proc] :coerce A proc which will be called to
-    #     transform the user input to canonical form. The value is passed in,
-    #     and the transformed value returned as output. Lazy values will *not*
-    #     be passed to this method until after they are evaluated. Called in the
-    #     context of the resource (meaning you can access other properties).
-    #   @option options [Boolean] :required `true` if this property
-    #     must be present; `false` otherwise. This is checked after the resource
-    #     is fully initialized.
-    #   @option options [Boolean] :name_property `true` if this
-    #     property defaults to the same value as `name`. Equivalent to
-    #     `default: lazy { name }`, except that #property_is_set? will
-    #     return `true` if the property is set *or* if `name` is set.
-    #   @option options [Boolean] :name_attribute Same as `name_property`.
-    #   @option options [Object] :default The value this property
-    #     will return if the user does not set one. If this is `lazy`, it will
-    #     be run in the context of the instance (and able to access other
-    #     properties).
-    #   @option options [Boolean] :desired_state `true` if this property is
-    #     part of desired state. Defaults to `true`.
-    #   @option options [Boolean] :identity `true` if this property
-    #     is part of object identity. Defaults to `false`.
-    #
-    # @example Bare property
-    #   property :x
-    #
-    # @example With just a type
-    #   property :x, String
-    #
-    # @example With just options
-    #   property :x, default: 'hi'
-    #
-    # @example With type and options
-    #   property :x, String, default: 'hi'
-    #
-    def self.property(name, type=NOT_PASSED, **options)
-      name = name.to_sym
-
-      options.each { |k,v| options[k.to_sym] = v if k.is_a?(String) }
-
-      options[:instance_variable_name] = :"@#{name}" if !options.has_key?(:instance_variable_name)
-      options.merge!(name: name, declared_in: self)
-
-      if type == NOT_PASSED
-        # If a type is not passed, the property derives from the
-        # superclass property (if any)
-        if properties.has_key?(name)
-          property = properties[name].derive(**options)
-        else
-          property = property_type(**options)
-        end
-
-      # If a Property is specified, derive a new one from that.
-      elsif type.is_a?(Property) || (type.is_a?(Class) && type <= Property)
-        property = type.derive(**options)
-
-      # If a primitive type was passed, combine it with "is"
-      else
-        if options[:is]
-          options[:is] = ([ type ] + [ options[:is] ]).flatten(1)
-        else
-          options[:is] = type
-        end
-        property = property_type(**options)
-      end
-
-      local_properties = properties(false)
-      local_properties[name] = property
-
-      property.emit_dsl
-    end
-
-    #
-    # Create a reusable property type that can be used in multiple properties
-    # in different resources.
-    #
-    # @param options [Hash<Symbol,Object>] Validation options. see #property for
-    #   the list of options.
-    #
-    # @example
-    #   property_type(default: 'hi')
-    #
-    def self.property_type(**options)
-      Property.derive(**options)
-    end
-
-    #
-    # The name of this particular resource.
-    #
-    # This special resource attribute is set automatically from the declaration
-    # of the resource, e.g.
-    #
-    #   execute 'Vitruvius' do
-    #     command 'ls'
-    #   end
-    #
-    # Will set the name to "Vitruvius".
-    #
-    # This is also used in to_s to show the resource name, e.g. `execute[Vitruvius]`.
-    #
-    # This is also used for resource notifications and subscribes in the same manner.
-    #
-    # This will coerce any object into a string via #to_s.  Arrays are a special case
-    # so that `package ["foo", "bar"]` becomes package[foo, bar] instead of the more
-    # awkward `package[["foo", "bar"]]` that #to_s would produce.
-    #
-    # @param name [Object] The name to set, typically a String or Array
-    # @return [String] The name of this Resource.
-    #
-    property :name, String, coerce: proc { |v| v.is_a?(Array) ? v.join(', ') : v.to_s }, desired_state: false
-
-    #
-    # Whether this property has been set (or whether it has a default that has
-    # been retrieved).
-    #
-    # @param name [Symbol] The name of the property.
-    # @return [Boolean] `true` if the property has been set.
-    #
-    def property_is_set?(name)
-      property = self.class.properties[name.to_sym]
-      raise ArgumentError, "Property #{name} is not defined in class #{self}" if !property
-      property.is_set?(self)
-    end
-
-    #
-    # Clear this property as if it had never been set. It will thereafter return
-    # the default.
-    # been retrieved).
-    #
-    # @param name [Symbol] The name of the property.
-    #
-    def reset_property(name)
-      property = self.class.properties[name.to_sym]
-      raise ArgumentError, "Property #{name} is not defined in class #{self}" if !property
-      property.reset(self)
-    end
-
-    #
-    # Create a lazy value for assignment to a default value.
-    #
-    # @param block The block to run when the value is retrieved.
-    #
-    # @return [Chef::DelayedEvaluator] The lazy value
-    #
-    def self.lazy(&block)
-      DelayedEvaluator.new(&block)
-    end
-
-    #
-    # Get or set the list of desired state properties for this resource.
-    #
-    # State properties are properties that describe the desired state
-    # of the system, such as file permissions or ownership.
-    # In general, state properties are properties that could be populated by
-    # examining the state of the system (e.g., File.stat can tell you the
-    # permissions on an existing file). Contrarily, properties that are not
-    # "state properties" usually modify the way Chef itself behaves, for example
-    # by providing additional options for a package manager to use when
-    # installing a package.
-    #
-    # This list is used by the Chef client auditing system to extract
-    # information from resources to describe changes made to the system.
-    #
-    # This method is unnecessary when declaring properties with `property`;
-    # properties are added to state_properties by default, and can be turned off
-    # with `desired_state: false`.
-    #
-    # ```ruby
-    # property :x # part of desired state
-    # property :y, desired_state: false # not part of desired state
-    # ```
-    #
-    # @param names [Array<Symbol>] A list of property names to set as desired
-    #   state.
-    #
-    # @return [Array<Property>] All properties in desired state.
-    #
-    def self.state_properties(*names)
-      if !names.empty?
-        names = names.map { |name| name.to_sym }.uniq
-
-        local_properties = properties(false)
-        # Add new properties to the list.
-        names.each do |name|
-          property = properties[name]
-          if !property
-            self.property name, instance_variable_name: false, desired_state: true
-          elsif !property.desired_state?
-            self.property name, desired_state: true
-          end
-        end
-
-        # If state_attrs *excludes* something which is currently desired state,
-        # mark it as desired_state: false.
-        local_properties.each do |name,property|
-          if property.desired_state? && !names.include?(name)
-            self.property name, desired_state: false
-          end
-        end
-      end
-
-      properties.values.select { |property| property.desired_state? }
-    end
-
     #
     # Set or return the list of "state properties" implemented by the Resource
     # subclass.
@@ -972,56 +767,6 @@ class Chef
       state_properties(*names).map { |property| property.name }
     end
 
-    #
-    # Set the identity of this resource to a particular set of properties.
-    #
-    # This drives #identity, which returns data that uniquely refers to a given
-    # resource on the given node (in such a way that it can be correlated
-    # across Chef runs).
-    #
-    # This method is unnecessary when declaring properties with `property`;
-    # properties can be added to identity during declaration with
-    # `identity: true`.
-    #
-    # ```ruby
-    # property :x, identity: true # part of identity
-    # property :y # not part of identity
-    # ```
-    #
-    # If no properties are marked as identity, "name" is considered the identity.
-    #
-    # @param names [Array<Symbol>] A list of property names to set as the identity.
-    #
-    # @return [Array<Property>] All identity properties.
-    #
-    def self.identity_properties(*names)
-      if !names.empty?
-        names = names.map { |name| name.to_sym }
-
-        # Add or change properties that are not part of the identity.
-        names.each do |name|
-          property = properties[name]
-          if !property
-            self.property name, instance_variable_name: false, identity: true
-          elsif !property.identity?
-            self.property name, identity: true
-          end
-        end
-
-        # If identity_properties *excludes* something which is currently part of
-        # the identity, mark it as identity: false.
-        properties.each do |name,property|
-          if property.identity? && !names.include?(name)
-            self.property name, identity: false
-          end
-        end
-      end
-
-      result = properties.values.select { |property| property.identity? }
-      result = [ properties[:name] ] if result.empty?
-      result
-    end
-
     #
     # Set the identity of this resource to a particular property.
     #
@@ -1513,6 +1258,9 @@ class Chef
     # resolve_resource_reference on each in turn, causing them to
     # resolve lazy/forward references.
     def resolve_notification_references
+      run_context.before_notifications(self).each { |n|
+        n.resolve_resource_reference(run_context.resource_collection)
+      }
       run_context.immediate_notifications(self).each { |n|
         n.resolve_resource_reference(run_context.resource_collection)
       }
@@ -1521,6 +1269,11 @@ class Chef
       }
     end
 
+    # Helper for #notifies
+    def notifies_before(action, resource_spec)
+      run_context.notifies_before(Notification.new(resource_spec, action, self))
+    end
+
     # Helper for #notifies
     def notifies_immediately(action, resource_spec)
       run_context.notifies_immediately(Notification.new(resource_spec, action, self))
@@ -1616,6 +1369,10 @@ class Chef
       "#{declared_type}[#{@name}]"
     end
 
+    def before_notifications
+      run_context.before_notifications(self)
+    end
+
     def immediate_notifications
       run_context.immediate_notifications(self)
     end