puppet 4.0.0 → 4.10.0

data/lib/puppet/util.rb

@@ -10,6 +10,7 @@ require 'puppet/util/platform'
 require 'puppet/util/symbolic_file_mode'
 require 'puppet/file_system/uniquefile'
 require 'securerandom'
+require 'puppet/util/character_encoding'
 
 module Puppet
 module Util
@@ -21,24 +22,118 @@ module Util
   require 'puppet/util/posix'
   extend Puppet::Util::POSIX
 
+  # Can't use Puppet.features.microsoft_windows? as it may be mocked out in a test.  This can cause test recurring test failures
+  require 'puppet/util/windows/process' if Puppet::Util::Platform.windows?
+
   extend Puppet::Util::SymbolicFileMode
 
-  # Run some code with a specific environment.  Resets the environment back to
-  # what it was at the end of the code.
-  def self.withenv(hash)
-    saved = ENV.to_hash
-    hash.each do |name, val|
-      ENV[name.to_s] = val
+  def default_env
+    Puppet.features.microsoft_windows? ?
+      :windows :
+      :posix
+  end
+  module_function :default_env
+
+  # @param name [String] The name of the environment variable to retrieve
+  # @param mode [Symbol] Which operating system mode to use e.g. :posix or :windows.  Use nil to autodetect
+  # @return [String] Value of the specified environment variable.  nil if it does not exist
+  # @api private
+  def get_env(name, mode = default_env)
+    if mode == :windows
+      Puppet::Util::Windows::Process.get_environment_strings.each do |key, value |
+        if name.casecmp(key) == 0 then
+          return value
+        end
+      end
+      return nil
+    else
+      ENV[name]
+    end
+  end
+  module_function :get_env
+
+  # @param mode [Symbol] Which operating system mode to use e.g. :posix or :windows.  Use nil to autodetect
+  # @return [Hash] A hashtable of all environment variables
+  # @api private
+  def get_environment(mode = default_env)
+    case mode
+      when :posix
+        ENV.to_hash
+      when :windows
+        Puppet::Util::Windows::Process.get_environment_strings
+      else
+        raise "Unable to retrieve the environment for mode #{mode}"
+    end
+  end
+  module_function :get_environment
+
+  # Removes all environment variables
+  # @param mode [Symbol] Which operating system mode to use e.g. :posix or :windows.  Use nil to autodetect
+  # @api private
+  def clear_environment(mode = default_env)
+    case mode
+      when :posix
+        ENV.clear
+      when :windows
+        Puppet::Util::Windows::Process.get_environment_strings.each do |key, _|
+          Puppet::Util::Windows::Process.set_environment_variable(key, nil)
+        end
+      else
+        raise "Unable to clear the environment for mode #{mode}"
+    end
+  end
+  module_function :clear_environment
+
+  # @param name [String] The name of the environment variable to set
+  # @param value [String] The value to set the variable to.  nil deletes the environment variable
+  # @param mode [Symbol] Which operating system mode to use e.g. :posix or :windows.  Use nil to autodetect
+  # @api private
+  def set_env(name, value = nil, mode = default_env)
+    case mode
+      when :posix
+        ENV[name] = value
+      when :windows
+        Puppet::Util::Windows::Process.set_environment_variable(name,value)
+      else
+        raise "Unable to set the environment variable #{name} for mode #{mode}"
+    end
+  end
+  module_function :set_env
+
+  # @param name [Hash] Environment variables to merge into the existing environment.  nil values will remove the variable
+  # @param mode [Symbol] Which operating system mode to use e.g. :posix or :windows.  Use nil to autodetect
+  # @api private
+  def merge_environment(env_hash, mode = default_env)
+    case mode
+      when :posix
+        env_hash.each { |name, val| ENV[name.to_s] = val }
+      when :windows
+        env_hash.each do |name, val|
+          Puppet::Util::Windows::Process.set_environment_variable(name.to_s, val)
+        end
+      else
+        raise "Unable to merge given values into the current environment for mode #{mode}"
     end
+  end
+  module_function :merge_environment
 
+  # Run some code with a specific environment.  Resets the environment back to
+  # what it was at the end of the code.
+  # Windows can store Unicode chars in the environment as keys or values, but
+  # Ruby's ENV tries to roundtrip them through the local codepage, which can
+  # cause encoding problems - underlying helpers use Windows APIs on Windows
+  # see https://bugs.ruby-lang.org/issues/8822
+  def withenv(hash, mode = :posix)
+    saved = get_environment(mode)
+    merge_environment(hash, mode)
     yield
   ensure
-    ENV.clear
-    saved.each do |name, val|
-      ENV[name] = val
+    if saved
+      clear_environment(mode)
+      merge_environment(saved, mode)
     end
   end
-
+  module_function :withenv
 
   # Execute a given chunk of code with a new umask.
   def self.withumask(mask)
@@ -147,14 +242,16 @@ module Util
     if absolute_path?(bin)
       return bin if FileTest.file? bin and FileTest.executable? bin
     else
-      ENV['PATH'].split(File::PATH_SEPARATOR).each do |dir|
+      exts = Puppet::Util.get_env('PATHEXT')
+      exts = exts ? exts.split(File::PATH_SEPARATOR) : %w[.COM .EXE .BAT .CMD]
+      Puppet::Util.get_env('PATH').split(File::PATH_SEPARATOR).each do |dir|
         begin
           dest = File.expand_path(File.join(dir, bin))
         rescue ArgumentError => e
           # if the user's PATH contains a literal tilde (~) character and HOME is not set, we may get
           # an ArgumentError here.  Let's check to see if that is the case; if not, re-raise whatever error
           # was thrown.
-          if e.to_s =~ /HOME/ and (ENV['HOME'].nil? || ENV['HOME'] == "")
+          if e.to_s =~ /HOME/ and (Puppet::Util.get_env('HOME').nil? || Puppet::Util.get_env('HOME') == "")
             # if we get here they have a tilde in their PATH.  We'll issue a single warning about this and then
             # ignore this path element and carry on with our lives.
             Puppet::Util::Warnings.warnonce("PATH contains a ~ character, and HOME is not set; ignoring PATH element '#{dir}'.")
@@ -166,8 +263,6 @@ module Util
           end
         else
           if Puppet.features.microsoft_windows? && File.extname(dest).empty?
-            exts = ENV['PATHEXT']
-            exts = exts ? exts.split(File::PATH_SEPARATOR) : %w[.COM .EXE .BAT .CMD]
             exts.each do |ext|
               destext = File.expand_path(dest + ext)
               return destext if FileTest.file? destext and FileTest.executable? destext
@@ -260,7 +355,15 @@ module Util
       $stdout.reopen(stdout)
       $stderr.reopen(stderr)
 
-      3.upto(256){|fd| IO::new(fd).close rescue nil}
+      begin
+        Dir.foreach('/proc/self/fd') do |f|
+          if f != '.' && f != '..' && f.to_i >= 3
+            IO::new(f.to_i).close rescue nil
+          end
+        end
+      rescue Errno::ENOENT # /proc/self/fd not found
+        3.upto(256){|fd| IO::new(fd).close rescue nil}
+      end
 
       block.call if block
     end
@@ -348,6 +451,7 @@ module Util
 
     begin
       file     = Puppet::FileSystem.pathname(file)
+      # encoding for Uniquefile is not important here because the caller writes to it as it sees fit
       tempfile = Puppet::FileSystem::Uniquefile.new(Puppet::FileSystem.basename_string(file), Puppet::FileSystem.dir_string(file))
 
       # Set properties of the temporary file before we write the content, because
@@ -454,16 +558,14 @@ module Util
   module_function :exit_on_fail
 
   def deterministic_rand(seed,max)
-    if defined?(Random) == 'constant' && Random.class == Class
-      Random.new(seed).rand(max).to_s
-    else
-      srand(seed)
-      result = rand(max).to_s
-      srand()
-      result
-    end
+    deterministic_rand_int(seed, max).to_s
   end
   module_function :deterministic_rand
+
+  def deterministic_rand_int(seed,max)
+    Random.new(seed).rand(max)
+  end
+  module_function :deterministic_rand_int
 end
 end
 

data/lib/puppet/vendor/deep_merge/deep_merge.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
     "lib/deep_merge/rails_compat.rb",
     "test/test_deep_merge.rb"
   ]
-  s.homepage = %q{http://github.com/danielsdeleo/deep_merge}
+  s.homepage = %q{https://github.com/danielsdeleo/deep_merge}
   s.require_paths = ["lib"]
   s.summary = %q{Merge Deeply Nested Hashes}
   s.test_files = [

data/lib/puppet/vendor/deep_merge/test/test_deep_merge.rb

@@ -213,7 +213,7 @@ class TestDeepMerge < Test::Unit::TestCase
     DeepMerge::deep_merge!(hash_src, hash_dst)
     assert_equal({"property" => {"bedroom_count" => {"king_bed" => [nil, 3], "queen_bed" => [4, nil, 1]}, "bathroom_count" => [nil, "2", "1"]}}, hash_dst)
 
-    # test parameter management for knockout_prefix and overwrite unmergable
+    # test parameter management for knockout_prefix and overwrite unmergeable
     assert_raise(DeepMerge::InvalidParameter) {DeepMerge::deep_merge!(hash_src, hash_dst, {:knockout_prefix => ""})}
     assert_raise(DeepMerge::InvalidParameter) {DeepMerge::deep_merge!(hash_src, hash_dst, {:preserve_unmergeables => true, :knockout_prefix => ""})}
     assert_raise(DeepMerge::InvalidParameter) {DeepMerge::deep_merge!(hash_src, hash_dst, {:preserve_unmergeables => true, :knockout_prefix => "--"})}

data/lib/puppet/vendor/load_semantic_puppet.rb

@@ -0,0 +1 @@
+$: << File.join([File.dirname(__FILE__), "semantic_puppet/lib"])

data/lib/puppet/vendor/pathspec/LICENSE

@@ -1,6 +1,6 @@
 Apache License
                            Version 2.0, January 2004
-                        http://www.apache.org/licenses/
+                        https://www.apache.org/licenses/
 
    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
@@ -192,7 +192,7 @@ Apache 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
+       https://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,

data/lib/puppet/vendor/pathspec/README.md

@@ -3,7 +3,7 @@ pathspec-ruby
 
 Match Path Specifications, such as .gitignore, in Ruby!
 
-Follows .gitignore syntax defined on [gitscm](http://git-scm.com/docs/gitignore)
+Follows .gitignore syntax defined on [gitscm](https://git-scm.com/docs/gitignore)
 
 .gitignore functionality ported from [Python pathspec](https://pypi.python.org/pypi/pathspec/0.2.2) by [@cpburnz](https://github.com/cpburnz/python-path-specification)
 

data/lib/puppet/vendor/pathspec/lib/pathspec.rb

@@ -75,7 +75,8 @@ class PathSpec
 
   # Generate specs from a filename, such as a .gitignore
   def self.from_filename(filename, type=:git)
-    self.from_lines(File.open(filename, 'r'))
+    # .gitignore is a UTF-8 file
+    self.from_lines(File.open(filename, 'r', :encoding => Encoding::UTF_8), type)
   end
 
   def self.from_lines(lines, type=:git)

data/lib/puppet/vendor/require_vendored.rb

@@ -1,7 +1,6 @@
 # This adds upfront requirements on vendored code found under lib/vendor/x
 # Add one requirement per vendored package (or a comment if it is loaded on demand).
 
-# The vendored library 'semantic' is loaded on demand.
 # The vendored library 'rgen' is loaded on demand.
 # The vendored library 'pathspec' is loaded on demand.
 # The vendored library 'deep_merge' is loaded on demand.

data/lib/puppet/vendor/rgen/README.rdoc

@@ -43,7 +43,7 @@ Change to the 'test' folder and run the test suite:
 
 == Documentation
 
-RDoc documentation is available at Github: http://mthiede.github.com/rgen/
+RDoc documentation is available at Github: https://mthiede.github.com/rgen/
 
 Find the main documentation parts for:
 * RGen::MetamodelBuilder

data/lib/puppet/vendor/rgen_patch.rb

@@ -12,7 +12,7 @@
 #
 # This patch changes the implementation so that the test for MMBase/
 # MMGeneric is made prior to the iteration, thus avoiding the iteration
-# alltogether for all non model objects
+# altogether for all non model objects
 #
 # The patch also changes the setXXX method to allow it to optimize the way
 # it ensures that the added elements are unique. Calling the addXXX method

data/lib/puppet/vendor/semantic/lib/semantic.rb

@@ -1,7 +1,5 @@
-module Semantic
-  autoload :Version, 'semantic/version'
-  autoload :VersionRange, 'semantic/version_range'
-  autoload :Dependency, 'semantic/dependency'
+require 'puppet/vendor/semantic_puppet/lib/semantic_puppet'
 
-  VERSION = '0.0.1'
-end
+$stderr.puts "Warning: Puppet's internal vendored libraries are Private APIs and can change without warning. The 'semantic' library has been replaced with 'semantic_puppet'."
+
+Semantic = SemanticPuppet

data/lib/puppet/vendor/{semantic/lib/semantic → semantic_puppet/lib/semantic_puppet}/dependency/graph.rb

@@ -1,6 +1,6 @@
-require 'semantic/dependency'
+require 'semantic_puppet/dependency'
 
-module Semantic
+module SemanticPuppet
   module Dependency
     class Graph
       include GraphNode

data/lib/puppet/vendor/{semantic/lib/semantic → semantic_puppet/lib/semantic_puppet}/dependency/graph_node.rb

@@ -1,7 +1,7 @@
-require 'semantic/dependency'
+require 'semantic_puppet/dependency'
 require 'set'
 
-module Semantic
+module SemanticPuppet
   module Dependency
     module GraphNode
       include Comparable

data/lib/puppet/vendor/{semantic/lib/semantic → semantic_puppet/lib/semantic_puppet}/dependency/module_release.rb

@@ -1,6 +1,6 @@
-require 'semantic/dependency'
+require 'semantic_puppet/dependency'
 
-module Semantic
+module SemanticPuppet
   module Dependency
     class ModuleRelease
       include GraphNode
@@ -9,10 +9,10 @@ module Semantic
 
       # Create a new instance of a module release.
       #
-      # @param source [Semantic::Dependency::Source]
+      # @param source [SemanticPuppet::Dependency::Source]
       # @param name [String]
-      # @param version [Semantic::Version]
-      # @param dependencies [{String => Semantic::VersionRange}]
+      # @param version [SemanticPuppet::Version]
+      # @param dependencies [{String => SemanticPuppet::VersionRange}]
       def initialize(source, name, version, dependencies = {})
         @source      = source
         @name        = name.freeze
@@ -38,6 +38,18 @@ module Semantic
         return our_key <=> their_key
       end
 
+      def eql?(other)
+        other.is_a?(ModuleRelease) &&
+          @name.eql?(other.name) &&
+          @version.eql?(other.version) &&
+          dependencies.eql?(other.dependencies)
+      end
+      alias == eql?
+
+      def hash
+        @name.hash ^ @version.hash
+      end
+
       def to_s
         "#<#{self.class} #{name}@#{version}>"
       end

data/lib/puppet/vendor/{semantic/lib/semantic → semantic_puppet/lib/semantic_puppet}/dependency/source.rb

@@ -1,6 +1,6 @@
-require 'semantic/dependency'
+require 'semantic_puppet/dependency'
 
-module Semantic
+module SemanticPuppet
   module Dependency
     class Source
       def self.priority

data/lib/puppet/vendor/{semantic/lib/semantic → semantic_puppet/lib/semantic_puppet}/dependency/unsatisfiable_graph.rb

@@ -1,6 +1,6 @@
-require 'semantic/dependency'
+require 'semantic_puppet/dependency'
 
-module Semantic
+module SemanticPuppet
   module Dependency
     class UnsatisfiableGraph < StandardError
       attr_reader :graph

data/lib/puppet/vendor/{semantic/lib/semantic → semantic_puppet/lib/semantic_puppet}/dependency.rb

@@ -1,15 +1,15 @@
-require 'semantic'
+require 'semantic_puppet'
 
-module Semantic
+module SemanticPuppet
   module Dependency
     extend self
 
-    autoload :Graph,         'semantic/dependency/graph'
-    autoload :GraphNode,     'semantic/dependency/graph_node'
-    autoload :ModuleRelease, 'semantic/dependency/module_release'
-    autoload :Source,        'semantic/dependency/source'
+    autoload :Graph,         'semantic_puppet/dependency/graph'
+    autoload :GraphNode,     'semantic_puppet/dependency/graph_node'
+    autoload :ModuleRelease, 'semantic_puppet/dependency/module_release'
+    autoload :Source,        'semantic_puppet/dependency/source'
 
-    autoload :UnsatisfiableGraph, 'semantic/dependency/unsatisfiable_graph'
+    autoload :UnsatisfiableGraph, 'semantic_puppet/dependency/unsatisfiable_graph'
 
     # @!group Sources
 

data/lib/puppet/vendor/semantic_puppet/lib/semantic_puppet/gem_version.rb

@@ -0,0 +1,3 @@
+module SemanticPuppet
+  VERSION = '0.1.4'
+end

data/lib/puppet/vendor/semantic_puppet/lib/semantic_puppet/locales/config.yaml

@@ -0,0 +1,21 @@
+---
+# This is the project-specific configuration file for setting up
+# fast_gettext for your project.
+gettext:
+  # This is used for the name of the .pot and .po files; they will be
+  # called <project_name>.pot?
+  project_name: 'semantic_puppet'
+  # This is used in comments in the .pot and .po files to indicate what
+  # project the files belong to and should bea little more desctiptive than
+  # <project_name>
+  package_name: Semantic Puppet Gem
+  # The locale that the default messages in the .pot file are in
+  default_locale: en
+  # The email used for sending bug reports.
+  bugs_address: docs@puppetlabs.com
+  # The holder of the copyright.
+  copyright_holder: Puppet, Inc.
+  # Patterns for +Dir.glob+ used to find all files that might contain
+  # translatable content, relative to the project root directory
+  source_files:
+    - 'lib/**/*.rb'

data/lib/puppet/vendor/{semantic/lib/semantic → semantic_puppet/lib/semantic_puppet}/version.rb

@@ -1,8 +1,8 @@
-require 'semantic'
+require 'semantic_puppet'
 
-module Semantic
+module SemanticPuppet
 
-  # @note Semantic::Version subclasses Numeric so that it has sane Range
+  # @note SemanticPuppet::Version subclasses Numeric so that it has sane Range
   #       semantics in Ruby 1.9+.
   class Version < Numeric
     include Comparable
@@ -10,44 +10,47 @@ module Semantic
     class ValidationFailure < ArgumentError; end
 
     class << self
-      LOOSE_REGEX = /
-        \A
-        (\d+)[.](\d+)[.](\d+) # Major . Minor . Patch
-        (?: [-](.*?))?        # Prerelease
-        (?: [+](.*?))?        # Build
-        \Z
-      /x
-
       # Parse a Semantic Version string.
       #
       # @param ver [String] the version string to parse
       # @return [Version] a comparable {Version} object
       def parse(ver)
-        match, major, minor, patch, prerelease, build = *ver.match(LOOSE_REGEX)
+        match, major, minor, patch, prerelease, build = *ver.match(/\A#{REGEX_FULL}\Z/)
 
         if match.nil?
-          raise 'Version numbers MUST begin with three dot-separated numbers'
-        elsif [major, minor, patch].any? { |x| x =~ /^0\d+/ }
-          raise 'Version numbers MUST NOT contain leading zeroes'
+          raise _("Unable to parse '%{version}' as a semantic version identifier") % {version: ver}
         end
 
         prerelease = parse_prerelease(prerelease) if prerelease
-        build = parse_build_metadata(build) if build
+        # Build metadata is not yet supported in semantic_puppet, but we hope to.
+        # The following code prevents build metadata for now.
+        #build = parse_build_metadata(build) if build
+        if !build.nil?
+          raise _("'%{version}' MUST NOT include build identifiers") % {version: ver}
+        end
 
         self.new(major.to_i, minor.to_i, patch.to_i, prerelease, build)
       end
 
+      # Validate a Semantic Version string.
+      #
+      # @param ver [String] the version string to validate
+      # @return [bool] whether or not the string represents a valid Semantic Version
+      def valid?(ver)
+        !!(ver =~ /\A#{REGEX_FULL}\Z/)
+      end
+
       private
       def parse_prerelease(prerelease)
         subject = 'Prerelease identifiers'
         prerelease = prerelease.split('.', -1)
 
         if prerelease.empty? or prerelease.any? { |x| x.empty? }
-          raise "#{subject} MUST NOT be empty"
+          raise _("%{subject} MUST NOT be empty") % {subject: subject}
         elsif prerelease.any? { |x| x =~ /[^0-9a-zA-Z-]/ }
-          raise "#{subject} MUST use only ASCII alphanumerics and hyphens"
+          raise _("%{subject} MUST use only ASCII alphanumerics and hyphens") % {subject: subject}
         elsif prerelease.any? { |x| x =~ /^0\d+$/ }
-          raise "#{subject} MUST NOT contain leading zeroes"
+          raise _("%{subject} MUST NOT contain leading zeroes") % {subject: subject}
         end
 
         return prerelease.map { |x| x =~ /^\d+$/ ? x.to_i : x }
@@ -58,9 +61,9 @@ module Semantic
         build = build.split('.', -1)
 
         if build.empty? or build.any? { |x| x.empty? }
-          raise "#{subject} MUST NOT be empty"
+          raise _("%{subject} MUST NOT be empty") % {subject: subject}
         elsif build.any? { |x| x =~ /[^0-9a-zA-Z-]/ }
-          raise "#{subject} MUST use only ASCII alphanumerics and hyphens"
+          raise _("%{subject} MUST use only ASCII alphanumerics and hyphens") % {subject: subject}
         end
 
         return build
@@ -112,6 +115,16 @@ module Semantic
       return compare_prerelease(other)
     end
 
+    def eql?(other)
+      other.is_a?(Version) &&
+        @major.eql?(other.major) &&
+        @minor.eql?(other.minor) &&
+        @patch.eql?(other.patch) &&
+        @prerelease.eql?(other.instance_variable_get(:@prerelease)) &&
+        @build.eql?(other.instance_variable_get(:@build))
+    end
+    alias == eql?
+
     def to_s
       "#{major}.#{minor}.#{patch}" +
       (@prerelease.nil? || prerelease.empty? ? '' : "-" + prerelease) +
@@ -164,5 +177,19 @@ module Semantic
     def first_prerelease
       self.class.new(@major, @minor, @patch, [])
     end
+
+    public
+
+    # Version string matching regexes
+    REGEX_NUMERIC = "(0|[1-9]\\d*)[.](0|[1-9]\\d*)[.](0|[1-9]\\d*)" # Major . Minor . Patch
+    REGEX_PRE     = "(?:[-](.*?))?"            # Prerelease
+    REGEX_BUILD   = "(?:[+](.*?))?"            # Build
+    REGEX_FULL    = REGEX_NUMERIC + REGEX_PRE + REGEX_BUILD
+
+    # The lowest precedence Version possible
+    MIN = self.new(0, 0, 0, []).freeze
+
+    # The highest precedence Version possible
+    MAX = self.new((1.0/0.0), 0, 0).freeze
   end
 end