puppet 4.5.2-universal-darwin → 4.5.3-universal-darwin

data/lib/puppet/util/plist.rb

@@ -45,7 +45,7 @@ module Puppet::Util::Plist
                                                   {:failonfail => true, :combine => true})
           return parse_plist(plist)
         rescue Puppet::ExecutionFailure => detail
-          Puppet.warning("Cannot read file #{path}; Puppet is skipping it.\n" + "Details: #{detail}")
+          Puppet.warning("Cannot read file #{file_path}; Puppet is skipping it.\n" + "Details: #{detail}")
         end
       end
     end

data/lib/puppet/util/windows/taskscheduler.rb

@@ -158,6 +158,20 @@ module Win32
 
     MAX_RUN_TIMES = TASK_MAX_RUN_TIMES
 
+    # unfortunately MSTask.h does not specify the limits for any settings
+    # so these were determined with some experimentation
+    # if values too large are written, its suspected there may be internal
+    # limits may be exceeded, corrupting the job
+    # used for max application name and path values
+    MAX_PATH                = 260
+    # UNLEN from lmcons.h is 256
+    # https://technet.microsoft.com/it-it/library/bb726984(en-us).aspx specifies 104
+    MAX_ACCOUNT_LENGTH      = 256
+    # command line max length is limited to 8191, choose something high but still enough that we don't blow out CLI
+    MAX_PARAMETERS_LENGTH   = 4096
+    # in testing, this value could be set to a length of 99999, but saving / loading the task failed
+    MAX_COMMENT_LENGTH      = 8192
+
     # Returns a new TaskScheduler object. If a work_item (and possibly the
     # the trigger) are passed as arguments then a new work item is created and
     # associated with that trigger, although you can still activate other tasks
@@ -212,7 +226,7 @@ module Win32
                 name_ptr_ptr = FFI::Pointer.new(:pointer, names_array_ptr)
                 for i in 0 ... count
                   name_ptr_ptr[i].read_com_memory_pointer do |name_ptr|
-                    array << name_ptr.read_arbitrary_wide_string_up_to(256)
+                    array << name_ptr.read_arbitrary_wide_string_up_to(MAX_PATH)
                   end
                 end
               end
@@ -269,12 +283,15 @@ module Win32
     #
     def save(file = nil)
       raise Error.new('No currently active task. ITask is NULL.') if @pITask.nil?
+      raise Error.new('Account information must be set on the current task to save it properly.') if !@account_information_set
 
       reset = true
 
       begin
         @pITask.QueryInstance(COM::PersistFile) do |pIPersistFile|
-          pIPersistFile.Save(wide_string(file), 1)
+          wide_file = wide_string(file)
+          pIPersistFile.Save(wide_file, 1)
+          pIPersistFile.SaveCompleted(wide_file)
         end
       rescue
         reset = false
@@ -311,6 +328,15 @@ module Win32
     # bad. In this case the task is created but a warning is generated and
     # false is returned.
     #
+    # Note that if intending to use SYSTEM, specify an empty user and nil password
+    #
+    # Calling task.set_account_information('SYSTEM', nil) will generally not
+    # work, except for one special case where flags are also set like:
+    # task.flags = Win32::TaskScheduler::TASK_FLAG_RUN_ONLY_IF_LOGGED_ON
+    #
+    # This must be done prior to the 1st save() call for the task to be
+    # properly registered and visible through the MMC snap-in / schtasks.exe
+    #
     def set_account_information(user, password)
       raise Error.new('No current task scheduler. ITaskScheduler is NULL.') if @pITS.nil?
       raise Error.new('No currently active task. ITask is NULL.') if @pITask.nil?
@@ -321,11 +347,15 @@ module Win32
         if (user.nil? || user=="") && (password.nil? || password=="")
           @pITask.SetAccountInformation(wide_string(""), FFI::Pointer::NULL)
         else
+          if user.length > MAX_ACCOUNT_LENGTH
+            raise Error.new("User has exceeded maximum allowed length #{MAX_ACCOUNT_LENGTH}")
+          end
           user = wide_string(user)
           password = wide_string(password)
           @pITask.SetAccountInformation(user, password)
         end
 
+        @account_information_set = true
         bool = true
       rescue Puppet::Util::Windows::Error => e
         raise e unless e.code == SCHED_E_ACCOUNT_INFORMATION_NOT_SET
@@ -350,7 +380,7 @@ module Win32
         FFI::MemoryPointer.new(:pointer) do |ptr|
           @pITask.GetAccountInformation(ptr)
           ptr.read_com_memory_pointer do |str_ptr|
-            user = str_ptr.read_arbitrary_wide_string_up_to(256) if ! str_ptr.null?
+            user = str_ptr.read_arbitrary_wide_string_up_to(MAX_ACCOUNT_LENGTH) if ! str_ptr.null?
           end
         end
       rescue Puppet::Util::Windows::Error => e
@@ -374,7 +404,7 @@ module Win32
         @pITask.GetApplicationName(ptr)
 
         ptr.read_com_memory_pointer do |str_ptr|
-          app = str_ptr.read_arbitrary_wide_string_up_to(256) if ! str_ptr.null?
+          app = str_ptr.read_arbitrary_wide_string_up_to(MAX_PATH) if ! str_ptr.null?
         end
       end
 
@@ -388,6 +418,10 @@ module Win32
       raise Error.new('No currently active task. ITask is NULL.') if @pITask.nil?
       raise TypeError unless app.is_a?(String)
 
+      # the application name is written to a .job file on disk, so is subject to path limitations
+      if app.length > MAX_PATH
+        raise Error.new("Application name has exceeded maximum allowed length #{MAX_PATH}")
+      end
       @pITask.SetApplicationName(wide_string(app))
 
       app
@@ -405,7 +439,7 @@ module Win32
         @pITask.GetParameters(ptr)
 
         ptr.read_com_memory_pointer do |str_ptr|
-          param = str_ptr.read_arbitrary_wide_string_up_to(256) if ! str_ptr.null?
+          param = str_ptr.read_arbitrary_wide_string_up_to(MAX_PARAMETERS_LENGTH) if ! str_ptr.null?
         end
       end
 
@@ -421,6 +455,10 @@ module Win32
       raise Error.new('No currently active task. ITask is NULL.') if @pITask.nil?
       raise TypeError unless param.is_a?(String)
 
+      if param.length > MAX_PARAMETERS_LENGTH
+        raise Error.new("Parameters has exceeded maximum allowed length #{MAX_PARAMETERS_LENGTH}")
+      end
+
       @pITask.SetParameters(wide_string(param))
 
       param
@@ -438,7 +476,7 @@ module Win32
         @pITask.GetWorkingDirectory(ptr)
 
         ptr.read_com_memory_pointer do |str_ptr|
-          dir = str_ptr.read_arbitrary_wide_string_up_to(256) if ! str_ptr.null?
+          dir = str_ptr.read_arbitrary_wide_string_up_to(MAX_PATH) if ! str_ptr.null?
         end
       end
 
@@ -452,6 +490,10 @@ module Win32
       raise Error.new('No currently active task. ITask is NULL.') if @pITask.nil?
       raise TypeError unless dir.is_a?(String)
 
+      if dir.length > MAX_PATH
+        raise Error.new("Working directory has exceeded maximum allowed length #{MAX_PATH}")
+      end
+
       @pITask.SetWorkingDirectory(wide_string(dir))
 
       dir
@@ -465,28 +507,30 @@ module Win32
       raise Error.new('No current task scheduler. ITaskScheduler is NULL.') if @pITS.nil?
       raise Error.new('No currently active task. ITask is NULL.') if @pITask.nil?
 
+      priority_name = ''
+
       FFI::MemoryPointer.new(:dword, 1) do |ptr|
         @pITask.GetPriority(ptr)
 
         pri = ptr.read_dword
         if (pri & IDLE) != 0
-          priority = 'idle'
+          priority_name = 'idle'
         elsif (pri & NORMAL) != 0
-          priority = 'normal'
+          priority_name = 'normal'
         elsif (pri & HIGH) != 0
-          priority = 'high'
+          priority_name = 'high'
         elsif (pri & REALTIME) != 0
-          priority = 'realtime'
+          priority_name = 'realtime'
         elsif (pri & BELOW_NORMAL) != 0
-          priority = 'below_normal'
+          priority_name = 'below_normal'
         elsif (pri & ABOVE_NORMAL) != 0
-          priority = 'above_normal'
+          priority_name = 'above_normal'
         else
-          priority = 'unknown'
+          priority_name = 'unknown'
         end
       end
 
-      priority
+      priority_name
     end
 
     # Sets the priority of the task. The +priority+ should be a numeric
@@ -534,6 +578,13 @@ module Win32
         end
       end
 
+      # preload task with the SYSTEM account
+      # empty string '' means 'SYSTEM' per MSDN, so default it
+      # given an account is necessary for creation of a task
+      # note that a user may set SYSTEM explicitly, but that has problems
+      # https://msdn.microsoft.com/en-us/library/windows/desktop/aa381276(v=vs.85).aspx
+      set_account_information('', nil)
+
       @pITask
     end
 
@@ -699,7 +750,7 @@ module Win32
         @pITask.GetComment(ptr)
 
         ptr.read_com_memory_pointer do |str_ptr|
-          comment = str_ptr.read_arbitrary_wide_string_up_to(256) if ! str_ptr.null?
+          comment = str_ptr.read_arbitrary_wide_string_up_to(MAX_COMMENT_LENGTH) if ! str_ptr.null?
         end
       end
 
@@ -712,6 +763,10 @@ module Win32
       raise Error.new('No currently active task. ITask is NULL.') if @pITask.nil?
       raise TypeError unless comment.is_a?(String)
 
+      if comment.length > MAX_COMMENT_LENGTH
+        raise Error.new("Comment has exceeded maximum allowed length #{MAX_COMMENT_LENGTH}")
+      end
+
       @pITask.SetComment(wide_string(comment))
       comment
     end
@@ -727,7 +782,7 @@ module Win32
         @pITask.GetCreator(ptr)
 
         ptr.read_com_memory_pointer do |str_ptr|
-          creator = str_ptr.read_arbitrary_wide_string_up_to(256) if ! str_ptr.null?
+          creator = str_ptr.read_arbitrary_wide_string_up_to(MAX_ACCOUNT_LENGTH) if ! str_ptr.null?
         end
       end
 
@@ -740,6 +795,11 @@ module Win32
       raise Error.new('No currently active task. ITask is NULL.') if @pITask.nil?
       raise TypeError unless creator.is_a?(String)
 
+      if creator.length > MAX_ACCOUNT_LENGTH
+        raise Error.new("Creator has exceeded maximum allowed length #{MAX_ACCOUNT_LENGTH}")
+      end
+
+
       @pITask.SetCreator(wide_string(creator))
       creator
     end
@@ -808,14 +868,8 @@ module Win32
 
     # Returns whether or not the scheduled task exists.
     def exists?(job_name)
-      bool = false
-      Dir.foreach("#{ENV['SystemRoot']}/Tasks"){ |file|
-        if File.basename(file, '.job') == job_name
-          bool = true
-          break
-        end
-      }
-      bool
+      # task name comparison is case insensitive
+      tasks.any? { |name| name.casecmp(job_name + '.job') == 0 }
     end
 
     private
@@ -887,6 +941,7 @@ module Win32
       # Ensure that COM reference is decremented properly
       @pITask.Release if @pITask && ! @pITask.null?
       @pITask = nil
+      @account_information_set = false
     end
 
     def populate_trigger(task_trigger, trigger)
@@ -927,9 +982,10 @@ module Win32
 
           trigger_struct = COM::TASK_TRIGGER.new(trigger_ptr)
           trigger_struct[:cbTriggerSize] = COM::TASK_TRIGGER.size
-          trigger_struct[:wBeginYear] = trigger['start_year'] || 0
-          trigger_struct[:wBeginMonth] = trigger['start_month'] || 0
-          trigger_struct[:wBeginDay] = trigger['start_day'] || 0
+          now = Time.now
+          trigger_struct[:wBeginYear] = trigger['start_year'] || now.year
+          trigger_struct[:wBeginMonth] = trigger['start_month'] || now.month
+          trigger_struct[:wBeginDay] = trigger['start_day'] || now.day
           trigger_struct[:wEndYear] = trigger['end_year'] || 0
           trigger_struct[:wEndMonth] = trigger['end_month'] || 0
           trigger_struct[:wEndDay] = trigger['end_day'] || 0
@@ -940,7 +996,7 @@ module Win32
           trigger_struct[:rgFlags] = trigger['flags'] || 0
           trigger_struct[:TriggerType] = trigger['trigger_type'] || :TASK_TIME_TRIGGER_ONCE
           trigger_struct[:Type] = trigger_type_union
-          trigger_struct[:wRandomMinutesInterval] = trigger['random_minutes_interval']
+          trigger_struct[:wRandomMinutesInterval] = trigger['random_minutes_interval'] || 0
 
           task_trigger.SetTrigger(trigger_struct)
         end

data/lib/puppet/version.rb

@@ -7,7 +7,7 @@
 
 
 module Puppet
-  PUPPETVERSION = '4.5.2'
+  PUPPETVERSION = '4.5.3'
 
   ##
   # version is a public API method intended to always provide a fast and

data/spec/integration/parser/parameter_defaults_spec.rb

@@ -120,7 +120,7 @@ require 'puppet_spec/language'
       end
 
       it 'fails when no value is provided for required first parameter', :if => call_type == 'EPP' do
-        expect_fail(params, [], /default expression for \$b tries to illegally access not yet evaluated \$a/)
+        expect_fail(params, [], /expects a value for parameter \$a/)
       end
 
       it "will use the referenced parameter's given value" do

data/spec/integration/util/windows/security_spec.rb

@@ -476,6 +476,7 @@ describe "Puppet::Util::Windows::Security", :if => Puppet.features.microsoft_win
           it "should retrieve the user sid" do
             sid = nil
             user = Puppet::Util::Windows::ADSI::User.create("puppet#{rand(10000)}")
+            user.password = 'PUPPET_RULeZ_123!'
             user.commit
             begin
               sid = Puppet::Util::Windows::ADSI::User.new(user.name).sid.sid

data/spec/unit/functions/new_spec.rb

@@ -90,6 +90,26 @@ describe 'the new function' do
       )).to have_resource('Notify[Integer, 1]')
     end
 
+    context 'when prefixed by a sign' do
+      { '+1'     => 1,
+        '-1'     => -1,
+        '+ 1'    => 1,
+        '- 1'    => -1,
+        '+0x10'  => 16,
+        '+ 0x10' => 16,
+        '-0x10'  => -16,
+        '- 0x10' => -16
+      }.each do |str, result|
+        it "produces #{result} from the string '#{str}'" do
+          expect(compile_to_catalog(<<-"MANIFEST"
+            $x = Integer.new("#{str}")
+            notify { "${type($x, generalized)}, $x": }
+          MANIFEST
+          )).to have_resource("Notify[Integer, #{result}]")
+        end
+      end
+    end
+
     context "when radix is not set it uses default and" do
       { "10"     => 10,
         "010"    => 8,
@@ -131,7 +151,11 @@ describe 'the new function' do
         "010"    => 2,
         "00010"  => 2,
         '0B111'  => 7,
-        '0b111'  => 7
+        '0b111'  => 7,
+        '+0B111' => 7,
+        '-0b111' => -7,
+        '+ 0B111'=> 7,
+        '- 0b111'=> -7
       }.each do |str, result|
         it "produces #{result} from the string '#{str}'" do
           expect(compile_to_catalog(<<-"MANIFEST"
@@ -142,8 +166,12 @@ describe 'the new function' do
         end
       end
 
-      { "0x10"  => :error,
-        '0X10'  => :error
+      { '0x10'  => :error,
+        '0X10'  => :error,
+        '+0X10' => :error,
+        '-0X10' => :error,
+        '+ 0X10'=> :error,
+        '- 0X10'=> :error
       }.each do |str, result|
         it "errors when given the non binary value compliant string '#{str}'" do
           expect{compile_to_catalog(<<-"MANIFEST"
@@ -158,6 +186,10 @@ describe 'the new function' do
       { "10"     => 8,
         "010"    => 8,
         "00010"  => 8,
+        '+00010' => 8,
+        '-00010' => -8,
+        '+ 00010'=> 8,
+        '- 00010'=> -8,
       }.each do |str, result|
         it "produces #{result} from the string '#{str}'" do
           expect(compile_to_catalog(<<-"MANIFEST"
@@ -172,6 +204,10 @@ describe 'the new function' do
         '0X10'  => :error,
         '0B10'  => :error,
         '0b10'  => :error,
+        '+0b10' => :error,
+        '-0b10' => :error,
+        '+ 0b10'=> :error,
+        '- 0b10'=> :error,
       }.each do |str, result|
         it "errors when given the non octal value compliant string '#{str}'" do
           expect{compile_to_catalog(<<-"MANIFEST"
@@ -190,6 +226,10 @@ describe 'the new function' do
         "0X10"   => 16,
         "0b1"    => 16*11+1,
         "0B1"    => 16*11+1,
+        '+0B1'   => 16*11+1,
+        '-0B1'   => -16*11-1,
+        '+ 0B1'  => 16*11+1,
+        '- 0B1'  => -16*11-1,
       }.each do |str, result|
         it "produces #{result} from the string '#{str}'" do
           expect(compile_to_catalog(<<-"MANIFEST"
@@ -201,6 +241,10 @@ describe 'the new function' do
       end
 
       { '0XGG'  => :error,
+        '+0XGG' => :error,
+        '-0XGG' => :error,
+        '+ 0XGG'=> :error,
+        '- 0XGG'=> :error,
       }.each do |str, result|
         it "errors when given the non octal value compliant string '#{str}'" do
           expect{compile_to_catalog(<<-"MANIFEST"
@@ -226,7 +270,6 @@ describe 'the new function' do
       end
 
       { '0X10'  => :error,
-        '0X10'  => :error,
         '0b10'  => :error,
         '0B10'  => :error,
       }.each do |str, result|
@@ -291,6 +334,10 @@ describe 'the new function' do
     { 42 => "Notify[Integer, 42]",
       42.3 => "Notify[Float, 42.3]",
       "42.0" => "Notify[Float, 42.0]",
+      "+42.0" => "Notify[Float, 42.0]",
+      "-42.0" => "Notify[Float, -42.0]",
+      "+ 42.0" => "Notify[Float, 42.0]",
+      "- 42.0" => "Notify[Float, -42.0]",
       "42.3" => "Notify[Float, 42.3]",
       "0x10" => "Notify[Integer, 16]",
       "010" => "Notify[Integer, 8]",
@@ -321,6 +368,10 @@ describe 'the new function' do
     { 42     => "Notify[Float, 42.0]",
       42.3   => "Notify[Float, 42.3]",
       "42.0" => "Notify[Float, 42.0]",
+      "+42.0" => "Notify[Float, 42.0]",
+      "-42.0" => "Notify[Float, -42.0]",
+      "+ 42.0" => "Notify[Float, 42.0]",
+      "- 42.0" => "Notify[Float, -42.0]",
       "42.3" => "Notify[Float, 42.3]",
       "0x10" => "Notify[Float, 16.0]",
       "010"  => "Notify[Float, 10.0]",
@@ -514,7 +565,7 @@ describe 'the new function' do
   context 'when invoked on String' do
     { {}            => 'Notify[String, {}]',
       []            => 'Notify[String, []]',
-      {'a'=>true}   => 'Notify[String, {"a" => true}]',
+      {'a'=>true}   => "Notify[String, {'a' => true}]",
       [1,2,3,4]     => 'Notify[String, [1, 2, 3, 4]]',
       [[1,2],[3,4]] => 'Notify[String, [[1, 2], [3, 4]]]',
       'abcd'        => 'Notify[String, abcd]',