puppet 4.0.0 → 4.10.0

data/lib/puppet/face/generate.rb

@@ -0,0 +1,64 @@
+require 'puppet/face'
+require 'puppet/generate/type'
+
+# Create the Generate face
+Puppet::Face.define(:generate, '0.1.0') do
+  copyright 'Puppet Inc.', 2016
+  license   'Apache 2 license; see COPYING'
+
+  summary 'Generates Puppet code from Ruby definitions.'
+
+  action(:types) do
+    summary 'Generates Puppet code for custom types'
+
+    description <<-'EOT'
+      Generates definitions for custom resource types using Puppet code.
+
+      Types defined in Puppet code can be used to isolate custom type definitions
+      between different environments.
+    EOT
+
+    examples <<-'EOT'
+      Generate Puppet type definitions for all custom resource types in the current environment:
+
+          $ puppet generate types
+
+      Generate Puppet type definitions for all custom resource types in the specified environment:
+
+          $ puppet generate types --environment development
+    EOT
+
+    option '--format <format>' do
+      summary 'The generation output format to use. Supported formats: pcore.'
+      default_to { 'pcore' }
+
+      before_action do |_, _, options|
+        raise ArgumentError, "'#{options[:format]}' is not a supported format for type generation." unless ['pcore'].include?(options[:format])
+      end
+    end
+
+    option '--force' do
+      summary 'Forces the generation of output files (skips up-to-date checks).'
+      default_to { false }
+    end
+
+    when_invoked do |options|
+      generator = Puppet::Generate::Type
+      inputs = generator.find_inputs(options[:format].to_sym)
+      environment = Puppet.lookup(:current_environment)
+
+      # get the common output directory (in <envroot>/.resource_types) - create it if it does not exists
+      # error if it exists and is not a directory
+      #
+      path_to_env = environment.configuration.path_to_env
+      outputdir = File.join(path_to_env, '.resource_types')
+      if Puppet::FileSystem.exist?(outputdir) && !Puppet::FileSystem.directory?(outputdir)
+        raise ArgumentError, "The output directory '#{outputdir}' exists and is not a directory"
+      end
+      Puppet::FileSystem::mkpath(outputdir)
+
+      generator.generate(inputs, outputdir, options[:force])
+      nil
+    end
+  end
+end

data/lib/puppet/face/help/face.erb

@@ -1,4 +1,7 @@
 <%# encoding: UTF-8%>
+<% if face.deprecated? -%>
+<%= "Warning: 'puppet #{face.name}' is deprecated and will be removed in a future release." %>
+<% end %>
 <% if face.synopsis -%>
 USAGE: <%= face.synopsis %>
 

data/lib/puppet/face/help/man.erb

@@ -23,7 +23,7 @@ settings, so you can specify `--server <servername>`, or
 `--run_mode <runmode>` as an argument.
 
 See the configuration file documentation at
-<http://docs.puppetlabs.com/references/stable/configuration.html> for the
+<https://docs.puppetlabs.com/puppet/latest/reference/configuration.html> for the
 full list of acceptable parameters. A commented list of all
 configuration options can also be generated by running puppet with
 `--genconfig`.

data/lib/puppet/face/help.rb

@@ -6,22 +6,22 @@ require 'erb'
 
 Puppet::Face.define(:help, '0.0.1') do
   copyright "Puppet Labs", 2011
-  license   "Apache 2 license; see COPYING"
+  license   _("Apache 2 license; see COPYING")
 
-  summary "Display Puppet help."
+  summary _("Display Puppet help.")
 
   action(:help) do
-    summary "Display help about Puppet subcommands and their actions."
-    arguments "[<subcommand>] [<action>]"
-    returns "Short help text for the specified subcommand or action."
-    examples <<-'EOT'
+    summary _("Display help about Puppet subcommands and their actions.")
+    arguments _("[<subcommand>] [<action>]")
+    returns _("Short help text for the specified subcommand or action.")
+    examples _(<<-'EOT')
       Get help for an action:
 
       $ puppet help
     EOT
 
-    option "--version VERSION" do
-      summary "The version of the subcommand for which to show help."
+    option "--version " + _("VERSION") do
+      summary _("The version of the subcommand for which to show help.")
     end
 
     default
@@ -47,7 +47,7 @@ Puppet::Face.define(:help, '0.0.1') do
           EOT
           353.times{i,x=i.divmod(1184);a,b=x.divmod(37);print(c[a]*b)}
         end
-        raise ArgumentError, "Puppet help only takes two (optional) arguments: a subcommand and an action"
+        raise ArgumentError, _("Puppet help only takes two (optional) arguments: a subcommand and an action")
       end
 
       version = :current
@@ -56,7 +56,7 @@ Puppet::Face.define(:help, '0.0.1') do
           version = options[:version]
         else
           if args.length == 0 then
-            raise ArgumentError, "Version only makes sense when a Faces subcommand is given"
+            raise ArgumentError, _("Version only makes sense when a Faces subcommand is given")
           end
         end
       end
@@ -66,7 +66,7 @@ Puppet::Face.define(:help, '0.0.1') do
       facename, actionname = args
       if legacy_applications.include? facename then
         if actionname then
-          raise ArgumentError, "Legacy subcommands don't take actions"
+          raise ArgumentError, _("Legacy subcommands don't take actions")
         end
         return render_application_help(facename)
       else
@@ -77,29 +77,35 @@ Puppet::Face.define(:help, '0.0.1') do
 
   def render_application_help(applicationname)
     return Puppet::Application[applicationname].help
+  rescue StandardError, LoadError => detail
+    msg = _(<<-MSG)
+Could not load help for the application #{applicationname}.
+Please check the error logs for more information.
+
+Detail: "#{detail.message}"
+MSG
+    fail ArgumentError, msg, detail.backtrace
   end
 
   def render_face_help(facename, actionname, version)
     face, action = load_face_help(facename, actionname, version)
     return template_for(face, action).result(binding)
-  end
-
-  def load_face_help(facename, actionname, version)
-    begin
-      face = Puppet::Face[facename.to_sym, version]
-    rescue Puppet::Error => detail
-      msg = <<-MSG
+  rescue StandardError, LoadError => detail
+    msg = _(<<-MSG)
 Could not load help for the face #{facename}.
 Please check the error logs for more information.
 
 Detail: "#{detail.message}"
-      MSG
-      fail ArgumentError, msg, detail.backtrace
-    end
+MSG
+    fail ArgumentError, msg, detail.backtrace
+  end
+
+  def load_face_help(facename, actionname, version)
+    face = Puppet::Face[facename.to_sym, version]
     if actionname
       action = face.get_action(actionname.to_sym)
       if not action
-        fail ArgumentError, "Unable to load action #{actionname} from #{face}"
+        fail ArgumentError, _("Unable to load action #{actionname} from #{face}")
       end
     end
 
@@ -140,9 +146,11 @@ Detail: "#{detail.message}"
       if (is_face_app?(appname))
         begin
           face = Puppet::Face[appname, :current]
-          result << [appname, face.summary]
-        rescue Puppet::Error
-          result << [ "! #{appname}", "! Subcommand unavailable due to error. Check error logs." ]
+          # Add deprecation message to summary if the face is deprecated
+          summary = face.deprecated? ? face.summary + _(" (Deprecated)") : face.summary
+          result << [appname, summary]
+        rescue StandardError, LoadError
+          result << [ "! #{appname}", _("! Subcommand unavailable due to error. Check error logs.") ]
         end
       else
         result << [appname, horribly_extract_summary_from(appname)]
@@ -162,8 +170,8 @@ Detail: "#{detail.message}"
           return md[1]
         end
       end
-    rescue StandardError
-      result << [ "! #{appname}", "! Subcommand unavailable due to error. Check error logs." ]
+    rescue StandardError, LoadError
+      return _("! Subcommand unavailable due to error. Check error logs.")
     end
     return ''
   end

data/lib/puppet/face/key.rb

@@ -12,4 +12,5 @@ Puppet::Indirector::Face.define(:key, '0.0.1') do
     subcommand directly.
   EOT
 
+  deprecate
 end

data/lib/puppet/face/man.rb

@@ -12,7 +12,7 @@ Puppet::Face.define(:man, '0.0.1') do
   description <<-EOT
     This subcommand displays manual pages for all Puppet subcommands. If the
     `ronn` gem (<https://github.com/rtomayko/ronn/>) is installed on your
-    system, puppet man will display fully-formated man pages. If `ronn` is not
+    system, puppet man will display fully-formatted man pages. If `ronn` is not
     available, puppet man will display the raw (but human-readable) source text
     in a pager.
   EOT
@@ -76,11 +76,13 @@ Puppet::Face.define(:man, '0.0.1') do
         if pager then ENV['PAGER'] = pager end
 
         args  = "--man --manual='Puppet Manual' --organization='Puppet Labs, LLC'"
-        IO.popen("#{ronn} #{args}", 'w') do |fh| fh.write text end
+        # manual pages could contain UTF-8 text
+        IO.popen("#{ronn} #{args}", 'w:UTF-8') do |fh| fh.write text end
 
         ''                      # suppress local output, neh?
       elsif pager then
-        IO.popen(pager, 'w') do |fh| fh.write text end
+        # manual pages could contain UTF-8 text
+        IO.popen(pager, 'w:UTF-8') do |fh| fh.write text end
         ''
       else
         text

data/lib/puppet/face/module/changes.rb

@@ -4,7 +4,8 @@ Puppet::Face.define(:module, '1.0.0') do
     description <<-EOT
       Shows any files in a module that have been modified since it was
       installed. This action compares the files on disk to the md5 checksums
-      included in the module's metadata.
+      included in the module's checksums.json or, if that is missing, in
+      metadata.json.
     EOT
 
     returns "Array of strings representing paths of modified files."

data/lib/puppet/face/module/generate.rb

@@ -236,7 +236,7 @@ module Puppet::ModuleTool::Generate
         content = block[path.read, binding]
 
         target = path.parent + path.basename(".#{type}")
-        target.open('w') { |f| f.write(content) }
+        target.open('w:UTF-8') { |f| f.write(content) }
         path.unlink
       end
     end

data/lib/puppet/face/module/install.rb

@@ -21,7 +21,7 @@ Puppet::Face.define(:module, '1.0.0') do
 
       $ puppet module install puppetlabs-vcsrepo
       Preparing to install into /etc/puppetlabs/code/modules ...
-      Downloading from http://forgeapi.puppetlabs.com ...
+      Downloading from https://forgeapi.puppet.com ...
       Installing -- do not interrupt ...
       /etc/puppetlabs/code/modules
       └── puppetlabs-vcsrepo (v0.0.4)
@@ -30,7 +30,7 @@ Puppet::Face.define(:module, '1.0.0') do
 
       $ puppet module install puppetlabs-vcsrepo --environment development
       Preparing to install into /etc/puppetlabs/code/environments/development/modules ...
-      Downloading from http://forgeapi.puppetlabs.com ...
+      Downloading from https://forgeapi.puppet.com ...
       Installing -- do not interrupt ...
       /etc/puppetlabs/code/environments/development/modules
       └── puppetlabs-vcsrepo (v0.0.4)
@@ -39,7 +39,7 @@ Puppet::Face.define(:module, '1.0.0') do
 
       $ puppet module install puppetlabs-vcsrepo -v 0.0.4
       Preparing to install into /etc/puppetlabs/modules ...
-      Downloading from http://forgeapi.puppetlabs.com ...
+      Downloading from https://forgeapi.puppet.com ...
       Installing -- do not interrupt ...
       /etc/puppetlabs/code/modules
       └── puppetlabs-vcsrepo (v0.0.4)
@@ -48,7 +48,7 @@ Puppet::Face.define(:module, '1.0.0') do
 
       $ puppet module install puppetlabs-vcsrepo --target-dir=/opt/puppetlabs/puppet/modules
       Preparing to install into /opt/puppetlabs/puppet/modules ...
-      Downloading from http://forgeapi.puppetlabs.com ...
+      Downloading from https://forgeapi.puppet.com ...
       Installing -- do not interrupt ...
       /opt/puppetlabs/puppet/modules
       └── puppetlabs-vcsrepo (v0.0.4)
@@ -57,7 +57,7 @@ Puppet::Face.define(:module, '1.0.0') do
 
       $ puppet module install puppetlabs-vcsrepo --target-dir=/opt/puppetlabs/puppet/modules --modulepath /etc/puppetlabs/code/modules
       Preparing to install into /opt/puppetlabs/puppet/modules ...
-      Downloading from http://forgeapi.puppetlabs.com ...
+      Downloading from https://forgeapi.puppet.com ...
       Installing -- do not interrupt ...
       /opt/puppetlabs/puppet/modules
       └── puppetlabs-vcsrepo (v0.0.4)
@@ -66,7 +66,7 @@ Puppet::Face.define(:module, '1.0.0') do
 
       $ puppet module install puppetlabs-vcsrepo-0.0.4.tar.gz
       Preparing to install into /etc/puppetlabs/code/modules ...
-      Downloading from http://forgeapi.puppetlabs.com ...
+      Downloading from https://forgeapi.puppet.com ...
       Installing -- do not interrupt ...
       /etc/puppetlabs/code/modules
       └── puppetlabs-vcsrepo (v0.0.4)

data/lib/puppet/face/parser.rb

@@ -107,7 +107,7 @@ Puppet::Face.define(:parser, '0.0.1') do
         missing_files = files - available_files
 
         dumps = available_files.collect do |file|
-          dump_parse(File.read(file), file, options)
+          dump_parse(Puppet::FileSystem.read(file, :encoding => 'utf-8'), file, options)
         end.join("")
 
         if missing_files.empty?
@@ -146,13 +146,16 @@ Puppet::Face.define(:parser, '0.0.1') do
   # @api private
   def validate_manifest(manifest = nil)
     env = Puppet.lookup(:current_environment)
-    validation_environment = manifest ? env.override_with(:manifest => manifest) : env
-
-    validation_environment.check_for_reparse
-    validation_environment.known_resource_types.clear
-
-  rescue => detail
-    Puppet.log_exception(detail)
-    exit(1)
+    loaders = Puppet::Pops::Loaders.new(env)
+    Puppet.override( {:loaders => loaders } , 'For puppet parser validate') do
+      begin
+        validation_environment = manifest ? env.override_with(:manifest => manifest) : env
+        validation_environment.check_for_reparse
+        validation_environment.known_resource_types.clear
+      rescue => detail
+        Puppet.log_exception(detail)
+        exit(1)
+      end
+    end
   end
 end

data/lib/puppet/face/plugin.rb

@@ -1,4 +1,7 @@
 require 'puppet/face'
+require 'puppet/configurer/downloader_factory'
+require 'puppet/configurer/plugin_handler'
+
 Puppet::Face.define(:plugin, '0.0.1') do
   copyright "Puppet Labs", 2011
   license   "Apache 2 license; see COPYING"
@@ -37,21 +40,11 @@ Puppet::Face.define(:plugin, '0.0.1') do
     EOT
 
     when_invoked do |options|
-      require 'puppet/configurer/downloader'
       remote_environment_for_plugins = Puppet::Node::Environment.remote(Puppet[:environment])
-      result = Puppet::Configurer::Downloader.new("plugin",
-                                         Puppet[:plugindest],
-                                         Puppet[:pluginsource],
-                                         Puppet[:pluginsignore],
-                                         remote_environment_for_plugins).evaluate
-      if Puppet.features.external_facts?
-          result += Puppet::Configurer::Downloader.new("pluginfacts",
-                                             Puppet[:pluginfactdest],
-                                             Puppet[:pluginfactsource],
-                                             Puppet[:pluginsignore],
-                                             remote_environment_for_plugins).evaluate
-      end
-      result
+
+      factory = Puppet::Configurer::DownloaderFactory.new
+      handler = Puppet::Configurer::PluginHandler.new(factory)
+      handler.download_plugins(remote_environment_for_plugins)
     end
 
     when_rendering :console do |value|

data/lib/puppet/face/status.rb

@@ -37,11 +37,14 @@ Puppet::Indirector::Face.define(:status, '0.0.1') do
     This action requires that the server's `auth.conf` file allow find
     access to the `status` REST terminus. Puppet agent does not use this
     facility, and it is turned off by default. See
-    <http://docs.puppetlabs.com/guides/rest_auth_conf.html> for more details.
+    <https://docs.puppetlabs.com/puppet/latest/reference/config_file_auth.html>
+    for more details.
   EOT
   find.examples <<-'EOT'
     Check the status of the configured puppet master:
 
     $ puppet status find --terminus rest
   EOT
+  
+  deprecate
 end

data/lib/puppet/feature/base.rb

@@ -17,8 +17,15 @@ end
 Puppet.features.add(:microsoft_windows) do
   begin
     # ruby
-    require 'Win32API'          # case matters in this require!
-    require 'win32ole'
+    require 'Win32API' # case matters in this require!
+
+    # Note: Setting codepage here globally ensures all strings returned via
+    # WIN32OLE (Ruby's late-bound COM support) are encoded in Encoding::UTF_8
+    #
+    # Also, this does not modify the value of WIN32OLE.locale - which defaults
+    # to 2048 (at least on US English Windows) and is not listed in the MS
+    # locales table, here: https://msdn.microsoft.com/en-us/library/ms912047(v=winembedded.10).aspx
+    require 'win32ole' ; WIN32OLE.codepage = WIN32OLE::CP_UTF8
     # gems
     require 'win32/process'
     require 'win32/dir'

data/lib/puppet/feature/cfacter.rb

@@ -2,6 +2,7 @@ require 'facter'
 require 'puppet/util/feature'
 
 Puppet.features.add :cfacter do
+  Puppet.deprecation_warning("The cfacter setting is deprecated. You can use Facter 3 and higher without this setting.")
   begin
     require 'cfacter'
 

data/lib/puppet/feature/cfpropertylist.rb

@@ -0,0 +1,3 @@
+require 'puppet/util/feature'
+
+Puppet.features.add(:cfpropertylist, :libs => ['cfpropertylist'])

data/lib/puppet/feature/external_facts.rb

@@ -1,5 +1,5 @@
 require 'facter'
 
 Puppet.features.add(:external_facts) {
-  Facter.respond_to?(:search_external)
+  true
 }

data/lib/puppet/feature/hiera_eyaml.rb

@@ -0,0 +1,3 @@
+require 'puppet/util/feature'
+
+Puppet.features.add(:hiera_eyaml, :libs => ['hiera/backend/eyaml/parser/parser'])

data/lib/puppet/feature/hocon.rb

@@ -0,0 +1,3 @@
+require 'puppet/util/feature'
+
+Puppet.features.add(:hocon, :libs => ['hocon'])

data/lib/puppet/feature/telnet.rb

@@ -0,0 +1,9 @@
+require 'puppet/util/feature'
+
+Puppet.features.add :telnet do
+  begin
+    require 'net/telnet'
+  rescue LoadError
+    false
+  end
+end

data/lib/puppet/file_bucket/dipper.rb

@@ -2,6 +2,8 @@ require 'pathname'
 require 'puppet/file_bucket'
 require 'puppet/file_bucket/file'
 require 'puppet/indirector/request'
+require 'puppet/util/diff'
+require 'tempfile'
 
 class Puppet::FileBucket::Dipper
   include Puppet::Util::Checksums
@@ -22,7 +24,7 @@ class Puppet::FileBucket::Dipper
       @rest_path  = nil
     else
       @local_path = nil
-      @rest_path = "https://#{server}:#{port}/#{environment}/file_bucket_file/"
+      @rest_path = "filebucket://#{server}:#{port}/"
     end
     @checksum_type = Puppet[:digest_algorithm].to_sym
     @digest = method(@checksum_type)
@@ -56,6 +58,46 @@ class Puppet::FileBucket::Dipper
     end
   end
 
+  # Diffs two filebucket files identified by their sums
+  def diff(checksum_a, checksum_b, file_a, file_b)
+    raise RuntimeError, "Diff is not supported on this platform" if Puppet[:diff] == ""
+    if checksum_a
+      source_path = "#{@rest_path}#{@checksum_type}/#{checksum_a}"
+      if checksum_b
+        file_diff = Puppet::FileBucket::File.indirection.find(
+          source_path,
+          :bucket_path => @local_path,
+          :diff_with => checksum_b)
+      elsif file_b
+        tmp_file = ::Tempfile.new('diff')
+        begin
+          restore(tmp_file.path, checksum_a)
+          file_diff = Puppet::Util::Diff.diff(tmp_file.path, file_b)
+        ensure
+          tmp_file.close
+          tmp_file.unlink
+        end
+      else
+        raise Puppet::Error, "Please provide a file or checksum do diff with"
+      end
+    elsif file_a
+      if checksum_b
+        tmp_file = ::Tempfile.new('diff')
+        begin
+          restore(tmp_file.path, checksum_b)
+          file_diff = Puppet::Util::Diff.diff(file_a, tmp_file.path)
+        ensure
+          tmp_file.close
+          tmp_file.unlink
+        end
+      elsif file_b
+        file_diff = Puppet::Util::Diff.diff(file_a, file_b)
+      end
+    end
+    raise Puppet::Error, "Failed to diff files" unless file_diff
+    file_diff.to_s
+  end
+
   # Retrieves a file by sum.
   def getfile(sum)
     get_bucket_file(sum).to_s
@@ -109,10 +151,24 @@ class Puppet::FileBucket::Dipper
     end
   end
 
+  # List Filebucket content.
+  def list(fromdate, todate)
+    raise Puppet::Error, "Listing remote file buckets is not allowed" unless local?
+
+    source_path = "#{@rest_path}#{@checksum_type}/"
+    file_bucket_list = Puppet::FileBucket::File.indirection.find(
+      source_path,
+      :bucket_path => @local_path,
+      :list_all => true,
+      :fromdate => fromdate,
+      :todate => todate)
+    raise Puppet::Error, "File not found" unless file_bucket_list
+    file_bucket_list.to_s
+  end
+
   private
   def absolutize_path( path )
     Pathname.new(path).realpath
   end
 
 end
-

data/lib/puppet/file_serving/http_metadata.rb

@@ -0,0 +1,46 @@
+require 'puppet/file_serving/metadata'
+
+# Simplified metadata representation, suitable for the information
+# that is available from HTTP headers.
+class Puppet::FileServing::HttpMetadata < Puppet::FileServing::Metadata
+
+  def initialize(http_response, path = '/dev/null')
+    super(path)
+
+    # ignore options that do not apply to HTTP metadata
+    @owner = @group = @mode = nil
+
+    # hash available checksums for eventual collection
+    @checksums = {}
+    # use a default mtime in case there is no usable HTTP header
+    @checksums[:mtime] = "{mtime}#{Time.now}"
+
+    if checksum = http_response['content-md5']
+      # convert base64 digest to hex
+      checksum = checksum.unpack("m0").first.unpack("H*").first
+      @checksums[:md5] = "{md5}#{checksum}"
+    end
+
+    if last_modified = http_response['last-modified']
+      mtime = DateTime.httpdate(last_modified).to_time
+      @checksums[:mtime] = "{mtime}#{mtime}"
+    end
+
+    @ftype = 'file'
+
+    self
+  end
+
+  # Override of the parent class method. Does not call super!
+  # We can only return metadata that was extracted from the
+  # HTTP headers during #initialize.
+  def collect
+    # Prefer the checksum_type from the indirector request options
+    # but fall back to the alternative otherwise
+    [ @checksum_type, :md5, :mtime ].each do |type|
+      @checksum_type = type
+      @checksum = @checksums[type]
+      return if @checksum
+    end
+  end
+end