puppet 4.3.2 → 4.4.0

data/lib/puppet/util/network_device/cisco/device.rb

@@ -234,20 +234,28 @@ class Puppet::Util::NetworkDevice::Cisco::Device < Puppet::Util::NetworkDevice::
           trunking[:mode] = :trunk
         when "static access"
           trunking[:mode] = :access
+        when "dynamic auto"
+          trunking[:mode] = 'dynamic auto'
+        when "dynamic desirable"
+          trunking[:mode] = 'dynamic desirable'
         else
           raise "Unknown switchport mode: #{$1} for #{interface}"
         end
       when /^Administrative Trunking Encapsulation:\s+(.*)$/
         case $1
         when "dot1q","isl"
-          trunking[:encapsulation] = $1.to_sym if trunking[:mode] == :trunk
+          trunking[:encapsulation] = $1.to_sym if trunking[:mode] != :access
+        when "negotiate"
+          trunking[:encapsulation] = :negotiate
         else
           raise "Unknown switchport encapsulation: #{$1} for #{interface}"
         end
       when /^Access Mode VLAN:\s+(.*) \(\(Inactive\)\)$/
         # nothing
       when /^Access Mode VLAN:\s+(.*) \(.*\)$/
-        trunking[:native_vlan] = $1 if trunking[:mode] == :access
+        trunking[:access_vlan] = $1 if trunking[:mode] != :trunk
+      when /^Trunking Native Mode VLAN:\s+(.*) \(.*\)$/
+        trunking[:native_vlan] = $1 if trunking[:mode] != :access
       when /^Trunking VLANs Enabled:\s+(.*)$/
         next if trunking[:mode] == :access
         vlans = $1

data/lib/puppet/util/network_device/cisco/interface.rb

@@ -19,17 +19,18 @@ class Puppet::Util::NetworkDevice::Cisco::Interface
     :description   => [1, "description %s"],
     :speed         => [2, "speed %s"],
     :duplex        => [3, "duplex %s"],
-    :native_vlan   => [4, "switchport access vlan %s"],
-    :encapsulation => [5, "switchport trunk encapsulation %s"],
-    :mode          => [6, "switchport mode %s"],
-    :allowed_trunk_vlans => [7, "switchport trunk allowed vlan %s"],
-    :etherchannel  => [8, ["channel-group %s", "port group %s"]],
-    :ipaddress     => [9,
+    :encapsulation => [4, "switchport trunk encapsulation %s"],
+    :mode          => [5, "switchport mode %s"],
+    :access_vlan   => [6, "switchport access vlan %s"],
+    :native_vlan   => [7, "switchport trunk native vlan %s"],
+    :allowed_trunk_vlans => [8, "switchport trunk allowed vlan %s"],
+    :etherchannel  => [9, ["channel-group %s", "port group %s"]],
+    :ipaddress     => [10,
       lambda do |prefix,ip,option|
         ip.ipv6? ? "ipv6 address #{ip.to_s}/#{prefix} #{option}" :
                    "ip address #{ip.to_s} #{netmask(Socket::AF_INET,prefix)}"
       end],
-      :ensure        => [10, lambda { |value| value == :present ? "no shutdown" : "shutdown" } ]
+    :ensure        => [11, lambda { |value| value == :present ? "no shutdown" : "shutdown" } ]
   }
 
   def update(is={}, should={})
@@ -37,8 +38,20 @@ class Puppet::Util::NetworkDevice::Cisco::Interface
     command("conf t")
     command("interface #{name}")
 
-    # apply changes in a defined orders for cisco IOS devices
+    # apply changes in a defined order for cisco IOS devices
     [is.keys, should.keys].flatten.uniq.sort {|a,b| COMMANDS[a][0] <=> COMMANDS[b][0] }.each do |property|
+      # Work around for old documentation which shows :native_vlan used for access vlan
+      if property == :access_vlan and should[:mode] != :trunk and should[:access_vlan].nil?
+        should[:access_vlan] = should[:native_vlan]
+      end
+
+      # Don't change non-operational mode parameters
+      next if property == :access_vlan and should[:mode] == :trunk
+      next if property == :native_vlan and should[:mode] == :access
+      next if property == :encapsulation and should[:mode] == :access
+
+      Puppet.debug("comparing #{property}: #{is[property]} == #{should[property]}")
+
       # They're equal, so do nothing.
       next if is[property] == should[property]
 

data/lib/puppet/util/network_device/transport/ssh.rb

@@ -68,9 +68,13 @@ class Puppet::Util::NetworkDevice::Transport::Ssh < Puppet::Util::NetworkDevice:
   end
 
   def close
-    @channel.close if @channel
-    @channel = nil
-    @ssh.close if @ssh
+    begin
+      @channel.close if @channel
+      @channel = nil
+      @ssh.close if @ssh
+    rescue IOError
+      Puppet.debug "device terminated ssh session impolitely"
+    end
   end
 
   def expect(prompt)

data/lib/puppet/util/network_device/transport/telnet.rb

@@ -1,44 +1,47 @@
 require 'puppet/util/network_device'
 require 'puppet/util/network_device/transport'
 require 'puppet/util/network_device/transport/base'
-require 'net/telnet'
-
-class Puppet::Util::NetworkDevice::Transport::Telnet < Puppet::Util::NetworkDevice::Transport::Base
-    def initialize(verbose = false)
-      super()
-      @verbose = verbose
-    end
-
-    def handles_login?
-      false
-    end
-
-    def connect
-      @telnet = Net::Telnet::new("Host" => host, "Port" => port || 23,
-                                 "Timeout" => 10,
-                                 "Prompt" => default_prompt)
-    end
-
-    def close
-      @telnet.close if @telnet
-      @telnet = nil
-    end
-
-    def expect(prompt)
-      @telnet.waitfor(prompt) do |out|
-        yield out if block_given?
+
+if Puppet.features.telnet?
+  require 'net/telnet'
+
+  class Puppet::Util::NetworkDevice::Transport::Telnet < Puppet::Util::NetworkDevice::Transport::Base
+      def initialize(verbose = false)
+        super()
+        @verbose = verbose
+      end
+
+      def handles_login?
+        false
+      end
+
+      def connect
+        @telnet = Net::Telnet::new("Host" => host, "Port" => port || 23,
+                                   "Timeout" => 10,
+                                   "Prompt" => default_prompt)
       end
-    end
 
-    def command(cmd, options = {})
-      send(cmd)
-      expect(options[:prompt] || default_prompt) do |output|
-        yield output if block_given?
+      def close
+        @telnet.close if @telnet
+        @telnet = nil
       end
-    end
 
-    def send(line)
-      Puppet.debug("telnet: send #{line}") if @verbose
-      @telnet.puts(line)
-    end
+      def expect(prompt)
+        @telnet.waitfor(prompt) do |out|
+          yield out if block_given?
+        end
+      end
+
+      def command(cmd, options = {})
+        send(cmd)
+        expect(options[:prompt] || default_prompt) do |output|
+          yield output if block_given?
+        end
+      end
+
+      def send(line)
+        Puppet.debug("telnet: send #{line}") if @verbose
+        @telnet.puts(line)
+      end
+  end
 end

data/lib/puppet/util/plist.rb

@@ -0,0 +1,130 @@
+require 'cfpropertylist'
+require 'puppet/util/execution'
+
+module Puppet::Util::Plist
+
+  class FormatError < RuntimeError; end
+
+  # So I don't have to prepend every method name with 'self.' Most of the
+  # methods are going to be Provider methods (as opposed to methods of the
+  # INSTANCE of the provider).
+  class << self
+    # Defines the magic number for binary plists
+    #
+    # @api private
+    def binary_plist_magic_number
+      "bplist00"
+    end
+
+    # Defines a default doctype string that should be at the top of most plist
+    # files. Useful if we need to modify an invalid doctype string in memory.
+    # In version 10.9 and lower of OS X the plist at
+    # /System/Library/LaunchDaemons/org.ntp.ntpd.plist had an invalid doctype
+    # string. This corrects for that.
+    def plist_xml_doctype
+      '<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">'
+    end
+
+    # Read a plist file, whether its format is XML or in Apple's "binary1"
+    # format, using the CFPropertyList gem.
+    def read_plist_file(file_path)
+      # We can't really read the file until we know the source encoding in
+      # Ruby 1.9.x, so we use the magic number to detect it.
+      # NOTE: We used IO.read originally to be Ruby 1.8.x compatible.
+      if read_file_with_offset(file_path, binary_plist_magic_number.length) == binary_plist_magic_number
+        plist_obj = new_cfpropertylist(:file => file_path)
+        convert_cfpropertylist_to_native_types(plist_obj)
+      else
+        plist_data = open_file_with_args(file_path, "r:UTF-8")
+        plist = parse_plist(plist_data, file_path)
+        return plist if plist
+
+        Puppet.debug "Plist #{file_path} ill-formatted, converting with plutil"
+        begin
+          plist = Puppet::Util::Execution.execute(['/usr/bin/plutil', '-convert', 'xml1', '-o', '/dev/stdout', file_path],
+                                                  {: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}")
+        end
+      end
+    end
+
+    # Read plist text using the CFPropertyList gem.
+    def parse_plist(plist_data, file_path = '')
+      bad_xml_doctype = /^.*<!DOCTYPE plist PUBLIC -\/\/Apple Computer.*$/
+      if plist_data =~ bad_xml_doctype
+        plist_data.gsub!( bad_xml_doctype, plist_xml_doctype )
+        Puppet.debug("Had to fix plist with incorrect DOCTYPE declaration: #{file_path}")
+      end
+
+      begin
+        plist_obj = new_cfpropertylist(:data => plist_data)
+      rescue CFFormatError => e
+        Puppet.debug "Failed with #{e.class} on #{file_path}: #{e.inspect}"
+        return nil
+      end
+      convert_cfpropertylist_to_native_types(plist_obj)
+    end
+
+    # Helper method to assist in reading a file. It's its own method for
+    # stubbing purposes
+    #
+    # @api private
+    def open_file_with_args(file, args)
+      File.open(file, args).read
+    end
+
+    # Helper method to assist in generating a new CFPropertList Plist. It's
+    # its own method for stubbing purposes
+    #
+    # @api private
+    def new_cfpropertylist(plist_opts)
+      CFPropertyList::List.new(plist_opts)
+    end
+
+    # Helper method to assist in converting a native CFPropertList object to a
+    # native Ruby object (hash). It's its own method for stubbing purposes
+    #
+    # @api private
+    def convert_cfpropertylist_to_native_types(plist_obj)
+      CFPropertyList.native_types(plist_obj.value)
+    end
+
+    # Helper method to assist in reading a file with an offset value. It's its
+    # own method for stubbing purposes
+    #
+    # @api private
+    def read_file_with_offset(file_path, offset)
+      IO.read(file_path, offset)
+    end
+
+    def to_format(format)
+      if format.to_sym == :xml
+        plist_format = CFPropertyList::List::FORMAT_XML
+      elsif format.to_sym == :binary
+        plist_format = CFPropertyList::List::FORMAT_BINARY
+      else
+        raise FormatError.new "Unknown plist format #{format}"
+      end
+    end
+
+    # This method will write a plist file using a specified format (or XML
+    # by default)
+    def write_plist_file(plist, file_path, format = :xml)
+      begin
+        plist_to_save       = CFPropertyList::List.new
+        plist_to_save.value = CFPropertyList.guess(plist)
+        plist_to_save.save(file_path, to_format(format))
+      rescue IOError => e
+        Puppet.error("Unable to write the file #{file_path}. #{e.inspect}")
+      end
+    end
+
+    def dump_plist(plist_data, format = :xml)
+      plist_to_save       = CFPropertyList::List.new
+      plist_to_save.value = CFPropertyList.guess(plist_data)
+      plist_to_save.to_str(to_format(format))
+    end
+  end
+end

data/lib/puppet/util/resource_template.rb

@@ -40,7 +40,7 @@ class Puppet::Util::ResourceTemplate
 
   def evaluate
     set_resource_variables
-    ERB.new(File.read(@file), 0, "-").result(binding)
+    ERB.new(Puppet::FileSystem.read(@file, :encoding => 'utf-8'), 0, "-").result(binding)
   end
 
   def initialize(file, resource)

data/lib/puppet/util/run_mode.rb

@@ -44,10 +44,10 @@ module Puppet
       # select the system or the user directory depending on the context of
       # this process.  The most common use is determining filesystem path
       # values for confdir and vardir.  The intended semantics are:
-      # {http://projects.puppetlabs.com/issues/16637 #16637} for Puppet 3.x
+      # {https://projects.puppetlabs.com/issues/16637 #16637} for Puppet 3.x
       #
       # @todo this code duplicates {Puppet::Settings#which\_configuration\_file}
-      #   as described in {http://projects.puppetlabs.com/issues/16637 #16637}
+      #   as described in {https://projects.puppetlabs.com/issues/16637 #16637}
       def which_dir( system, user )
         if Puppet.features.root?
           File.expand_path(system)

data/lib/puppet/util/skip_tags.rb

@@ -0,0 +1,9 @@
+require 'puppet/util/tagging'
+
+class Puppet::Util::SkipTags
+  include Puppet::Util::Tagging
+
+  def initialize(stags)
+    self.tags = stags unless defined?(@tags)
+  end
+end

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

@@ -3,7 +3,7 @@
 # Represents an access control entry, which grants or denies a subject,
 # identified by a SID, rights to a securable object.
 #
-# @see http://msdn.microsoft.com/en-us/library/windows/desktop/aa374868(v=vs.85).aspx
+# @see https://msdn.microsoft.com/en-us/library/windows/desktop/aa374868(v=vs.85).aspx
 # @api private
 class Puppet::Util::Windows::AccessControlEntry
   require 'puppet/util/windows/security'

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

@@ -2,7 +2,7 @@
 #
 # Represents a list of access control entries (ACEs).
 #
-# @see http://msdn.microsoft.com/en-us/library/windows/desktop/aa374872(v=vs.85).aspx
+# @see https://msdn.microsoft.com/en-us/library/windows/desktop/aa374872(v=vs.85).aspx
 # @api private
 class Puppet::Util::Windows::AccessControlList
   include Enumerable
@@ -76,7 +76,7 @@ class Puppet::Util::Windows::AccessControlList
         else
           new_ace.sid = new_sid
 
-          prepend_needed = old_sid == Win32::Security::SID::LocalSystem
+          prepend_needed = old_sid == Puppet::Util::Windows::SID::LocalSystem
         end
       end
       new_aces << new_ace
@@ -87,7 +87,7 @@ class Puppet::Util::Windows::AccessControlList
     if prepend_needed
       mask = Puppet::Util::Windows::File::STANDARD_RIGHTS_ALL | Puppet::Util::Windows::File::SPECIFIC_RIGHTS_ALL
       ace = Puppet::Util::Windows::AccessControlEntry.new(
-              Win32::Security::SID::LocalSystem,
+              Puppet::Util::Windows::SID::LocalSystem,
               mask)
       @aces << ace
     end

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

@@ -96,7 +96,7 @@ module Puppet::Util::Windows::ADSI
 
     ffi_convention :stdcall
 
-    # http://msdn.microsoft.com/en-us/library/windows/desktop/ms724295(v=vs.85).aspx
+    # https://msdn.microsoft.com/en-us/library/windows/desktop/ms724295(v=vs.85).aspx
     # BOOL WINAPI GetComputerName(
     #   _Out_    LPTSTR lpBuffer,
     #   _Inout_  LPDWORD lpnSize
@@ -300,7 +300,7 @@ module Puppet::Util::Windows::ADSI
       new(name, Puppet::Util::Windows::ADSI.create(name, 'user'))
     end
 
-    # UNLEN from lmcons.h - http://stackoverflow.com/a/2155176
+    # UNLEN from lmcons.h - https://stackoverflow.com/a/2155176
     MAX_USERNAME_LENGTH = 256
     def self.current_user_name
       user_name = ''
@@ -361,7 +361,7 @@ module Puppet::Util::Windows::ADSI
 
     ffi_convention :stdcall
 
-    # http://msdn.microsoft.com/en-us/library/windows/desktop/ms724432(v=vs.85).aspx
+    # https://msdn.microsoft.com/en-us/library/windows/desktop/ms724432(v=vs.85).aspx
     # BOOL WINAPI GetUserName(
     #   _Out_    LPTSTR lpBuffer,
     #   _Inout_  LPDWORD lpnSize
@@ -376,7 +376,7 @@ module Puppet::Util::Windows::ADSI
       begin
         Puppet::Util::Windows::ADSI.wmi_connection.Delete("Win32_UserProfile.SID='#{sid}'")
       rescue WIN32OLERuntimeError => e
-        # http://social.technet.microsoft.com/Forums/en/ITCG/thread/0f190051-ac96-4bf1-a47f-6b864bfacee5
+        # https://social.technet.microsoft.com/Forums/en/ITCG/thread/0f190051-ac96-4bf1-a47f-6b864bfacee5
         # Prior to Vista SP1, there's no builtin way to programmatically
         # delete user profiles (except for delprof.exe). So try to delete
         # but warn if we fail

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

@@ -19,7 +19,6 @@ module Puppet::Util::Windows::APITypes
 
   class ::FFI::Pointer
     NULL_HANDLE = 0
-    NULL_TERMINATOR_WCHAR = 0
 
     def self.from_string_to_wide_string(str, &block)
       str = Puppet::Util::Windows::String.wide_string(str)
@@ -52,6 +51,7 @@ module Puppet::Util::Windows::APITypes
 
     alias_method :read_wchar, :read_uint16
     alias_method :read_word,  :read_uint16
+    alias_method :read_array_of_wchar, :read_array_of_uint16
 
     def read_wide_string(char_length, dst_encoding = Encoding::UTF_8)
       # char_length is number of wide chars (typically excluding NULLs), *not* bytes
@@ -59,18 +59,24 @@ module Puppet::Util::Windows::APITypes
       str.encode(dst_encoding)
     end
 
-    def read_arbitrary_wide_string_up_to(max_char_length = 512)
-      # max_char_length is number of wide chars (typically excluding NULLs), *not* bytes
-      # use a pointer to read one UTF-16LE char (2 bytes) at a time
-      wchar_ptr = FFI::Pointer.new(:wchar, address)
+    # @param max_char_length [Integer] Maximum number of wide chars tp return (typically excluding NULLs), *not* bytes
+    # @param null_terminator [Symbol] Number of number of null wchar characters, *not* bytes, that determine the end of the string
+    #   null_terminator = :single_null, then the terminating sequence is two bytes of zero.   This is UNIT16 = 0
+    #   null_terminator = :double_null, then the terminating sequence is four bytes of zero.  This is UNIT32 = 0
+    def read_arbitrary_wide_string_up_to(max_char_length = 512, null_terminator = :single_null)
+      if null_terminator != :single_null && null_terminator != :double_null
+        raise "Unable to read wide strings with #{null_terminator} terminal nulls"
+      end
 
-      # now iterate 2 bytes at a time until an offset lower than max_char_length is found
-      0.upto(max_char_length - 1) do |i|
-        if wchar_ptr[i].read_wchar == NULL_TERMINATOR_WCHAR
-          return read_wide_string(i)
-        end
+      terminator_width = null_terminator == :single_null ? 1 : 2
+      reader_method = null_terminator == :single_null ? :get_uint16 : :get_uint32
+
+      # Look for a null terminating characters; if found, read up to that null (exclusive)
+      (0...max_char_length - terminator_width).each do |i|
+        return read_wide_string(i) if send(reader_method, (i * 2)) == 0
       end
 
+      # String is longer than the max; read just to the max
       read_wide_string(max_char_length)
     end
 
@@ -113,10 +119,10 @@ module Puppet::Util::Windows::APITypes
   # https://github.com/ffi/ffi/wiki/Types
 
   # Windows - Common Data Types
-  # http://msdn.microsoft.com/en-us/library/cc230309.aspx
+  # https://msdn.microsoft.com/en-us/library/cc230309.aspx
 
   # Windows Data Types
-  # http://msdn.microsoft.com/en-us/library/windows/desktop/aa383751(v=vs.85).aspx
+  # https://msdn.microsoft.com/en-us/library/windows/desktop/aa383751(v=vs.85).aspx
 
   FFI.typedef :uint16, :word
   FFI.typedef :uint32, :dword
@@ -156,7 +162,7 @@ module Puppet::Util::Windows::APITypes
   FFI.typedef :int32, :win32_long
   # FFI bool can be only 1 byte at times,
   # Win32 BOOL is a signed int, and is always 4 bytes, even on x64
-  # http://blogs.msdn.com/b/oldnewthing/archive/2011/03/28/10146459.aspx
+  # https://blogs.msdn.com/b/oldnewthing/archive/2011/03/28/10146459.aspx
   FFI.typedef :int32, :win32_bool
 
   # Same as a LONG, a 32-bit signed integer
@@ -173,7 +179,7 @@ module Puppet::Util::Windows::APITypes
   module ::FFI::WIN32
     extend ::FFI::Library
 
-    # http://msdn.microsoft.com/en-us/library/windows/desktop/aa373931(v=vs.85).aspx
+    # https://msdn.microsoft.com/en-us/library/windows/desktop/aa373931(v=vs.85).aspx
     # typedef struct _GUID {
     #   DWORD Data1;
     #   WORD  Data2;
@@ -204,7 +210,7 @@ module Puppet::Util::Windows::APITypes
       def ==(other) Windows.memcmp(other, self, size) == 0 end
     end
 
-    # http://msdn.microsoft.com/en-us/library/windows/desktop/ms724950(v=vs.85).aspx
+    # https://msdn.microsoft.com/en-us/library/windows/desktop/ms724950(v=vs.85).aspx
     # typedef struct _SYSTEMTIME {
     #   WORD wYear;
     #   WORD wMonth;
@@ -245,21 +251,21 @@ module Puppet::Util::Windows::APITypes
 
     ffi_convention :stdcall
 
-    # http://msdn.microsoft.com/en-us/library/windows/desktop/aa366730(v=vs.85).aspx
+    # https://msdn.microsoft.com/en-us/library/windows/desktop/aa366730(v=vs.85).aspx
     # HLOCAL WINAPI LocalFree(
     #   _In_  HLOCAL hMem
     # );
     ffi_lib :kernel32
     attach_function :LocalFree, [:handle], :handle
 
-    # http://msdn.microsoft.com/en-us/library/windows/desktop/ms724211(v=vs.85).aspx
+    # https://msdn.microsoft.com/en-us/library/windows/desktop/ms724211(v=vs.85).aspx
     # BOOL WINAPI CloseHandle(
     #   _In_  HANDLE hObject
     # );
     ffi_lib :kernel32
     attach_function_private :CloseHandle, [:handle], :win32_bool
 
-    # http://msdn.microsoft.com/en-us/library/windows/desktop/ms680722(v=vs.85).aspx
+    # https://msdn.microsoft.com/en-us/library/windows/desktop/ms680722(v=vs.85).aspx
     # void CoTaskMemFree(
     #   _In_opt_  LPVOID pv
     # );