puppet 3.8.7 → 4.0.0.rc1

data/lib/puppet/face/parser.rb

@@ -2,7 +2,7 @@ require 'puppet/face'
 require 'puppet/parser'
 
 Puppet::Face.define(:parser, '0.0.1') do
-  copyright "Puppet Labs", 2011
+  copyright "Puppet Labs", 2014
   license   "Apache 2 license; see COPYING"
 
   summary "Interact directly with the parser."
@@ -16,15 +16,12 @@ Puppet::Face.define(:parser, '0.0.1') do
       syncing any resources. If no manifest files are provided, it will
       validate the default site manifest.
 
-      When validating with --parser current, the validation stops after the first
-      encountered issue.
-
-      When validating with --parser future, multiple issues per file are reported up
+      When validating multiple issues per file are reported up
       to the settings of max_error, and max_warnings. The processing stops
       after having reported issues for the first encountered file with errors.
     EOT
     examples <<-'EOT'
-      Validate the default site manifest at /etc/puppet/manifests/site.pp:
+      Validate the default site manifest at /etc/puppetlabs/puppet/manifests/site.pp:
 
       $ puppet parser validate
 
@@ -71,13 +68,14 @@ Puppet::Face.define(:parser, '0.0.1') do
     returns "A dump of the resulting AST model unless there are syntax or validation errors."
     description <<-'EOT'
       This action parses and validates the Puppet DSL syntax without compiling a catalog
-      or syncing any resources. It automatically turns on the future parser for the parsing.
+      or syncing any resources.
 
       The command accepts one or more manifests (.pp) files, or an -e followed by the puppet
       source text.
       If no arguments are given, the stdin is read (unless it is attached to a terminal)
 
-      The output format of the dumped tree is not API, it may change from time to time.
+      The output format of the dumped tree is intended for debugging purposes and is
+      not API, it may change from time to time.
     EOT
 
     option "--e <source>" do

data/lib/puppet/face/report.rb

@@ -6,9 +6,6 @@ Puppet::Indirector::Face.define(:report, '0.0.1') do
 
   summary "Create, display, and submit reports."
 
-  get_action(:find).summary "Invalid for this face."
-  get_action(:search).summary "Invalid for this face."
-  get_action(:destroy).summary "Invalid for this face."
   save = get_action(:save)
   save.summary "API only: submit a report."
   save.arguments "<report>"
@@ -34,7 +31,7 @@ Puppet::Indirector::Face.define(:report, '0.0.1') do
     EOT
     arguments "<report>"
     examples <<-'EOT'
-      From secret_agent.rb (API example):
+      API example:
 
           # ...
           report  = Puppet::Face[:catalog, '0.0.1'].apply
@@ -51,4 +48,7 @@ Puppet::Indirector::Face.define(:report, '0.0.1') do
       end
     end
   end
+  deactivate_action(:find)
+  deactivate_action(:search)
+  deactivate_action(:destroy)
 end

data/lib/puppet/face/resource.rb

@@ -10,7 +10,7 @@ Puppet::Indirector::Face.define(:resource, '0.0.1') do
     puppet resource subcommand.
   EOT
 
-  get_action(:destroy).summary "Invalid for this subcommand."
+  deactivate_action(:destroy)
 
   search = get_action(:search)
   search.summary "API only: get all resources of a single type."

data/lib/puppet/face/resource_type.rb

@@ -28,10 +28,8 @@ Puppet::Indirector::Face.define(:resource_type, '0.0.1') do
     * `doc`       (a string)
   EOT
 
-  # Action documentation overrides:
-  get_action(:save).summary = "Invalid for this subcommand."
-  get_action(:save).description "Invalid for this subcommand."
-  get_action(:destroy).summary = "Invalid for this subcommand."
+  deactivate_action(:save)
+  deactivate_action(:destroy)
 
   find = get_action(:find)
   find.summary "Retrieve info about a resource collection."
@@ -57,6 +55,11 @@ Puppet::Indirector::Face.define(:resource_type, '0.0.1') do
 
     $ puppet resource_type find ntp --terminus rest
   EOT
+  # For this face we don't want to default to the certname like other indirector
+  # based faces. Instead we want the user to always supply a argument.
+  find.when_invoked = Proc.new do |key, options|
+    call_indirection_method :find, key, options[:extra]
+  end
 
   search = get_action(:search)
   search.summary "Search for collections matching a regular expression."

data/lib/puppet/face/status.rb

@@ -6,15 +6,13 @@ Puppet::Indirector::Face.define(:status, '0.0.1') do
 
   summary "View puppet server status."
 
-  get_action(:destroy).summary "Invalid for this subcommand."
-  get_action(:save).summary "Invalid for this subcommand."
-  get_action(:save).description "Invalid for this subcommand."
-  get_action(:search).summary "Invalid for this subcommand."
+  deactivate_action(:destroy)
+  deactivate_action(:save)
+  deactivate_action(:search)
 
   find = get_action(:find)
   find.default = true
   find.summary "Check status of puppet master server."
-  find.arguments "<dummy_text>"
   find.returns <<-'EOT'
     A "true" response or a low-level connection error. When used from the Ruby
     API: returns a Puppet::Status object.
@@ -32,22 +30,18 @@ Puppet::Indirector::Face.define(:status, '0.0.1') do
   EOT
   find.short_description <<-EOT
     Checks whether a Puppet server is properly receiving and processing HTTP
-    requests. Due to a known bug, this action requires a dummy argument, the
-    content of which is irrelevant. This action is only useful when used with
-    '--terminus rest', and will always return true when invoked locally.
+    requests. This action is only useful when used with '--terminus rest',
+    and will always return true when invoked locally.
   EOT
   find.notes <<-'EOT'
     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.
-
-    Although this action always returns an unnamed status object, it requires a
-    dummy argument. This is a known bug.
   EOT
   find.examples <<-'EOT'
     Check the status of the configured puppet master:
 
-    $ puppet status find x --terminus rest
+    $ puppet status find --terminus rest
   EOT
 end

data/lib/puppet/feature/base.rb

@@ -49,16 +49,9 @@ Puppet.features.add :diff, :libs => %w{diff/lcs diff/lcs/hunk}
 # We have augeas
 Puppet.features.add(:augeas, :libs => ["augeas"])
 
-# We have RRD available
-Puppet.features.add(:rrd_legacy, :libs => ["RRDtool"])
-Puppet.features.add(:rrd, :libs => ["RRD"])
-
 # We have OpenSSL
 Puppet.features.add(:openssl, :libs => ["openssl"])
 
-# We have CouchDB
-Puppet.features.add(:couchdb, :libs => ["couchrest"])
-
 # We have sqlite
 Puppet.features.add(:sqlite, :libs => ["sqlite3"])
 

data/lib/puppet/file_bucket/dipper.rb

@@ -94,10 +94,9 @@ class Puppet::FileBucket::Dipper
         end
         ::File.open(file, ::File::WRONLY|::File::TRUNC|::File::CREAT) { |of|
           of.binmode
-          source_stream = newcontents.stream do |source_stream|
+          newcontents.stream do |source_stream|
             FileUtils.copy_stream(source_stream, of)
           end
-          #of.print(newcontents)
         }
         ::File.chmod(changed, file) if changed
       else

data/lib/puppet/file_bucket/file.rb

@@ -14,16 +14,11 @@ class Puppet::FileBucket::File
   attr :bucket_path
 
   def self.supported_formats
-    [:s, :pson]
+    [:binary]
   end
 
   def self.default_format
-    # This should really be :raw, like is done for Puppet::FileServing::Content
-    # but this class hasn't historically supported `from_raw`, so switching
-    # would break compatibility between newer 3.x agents talking to older 3.x
-    # masters. However, to/from_s has been supported and achieves the desired
-    # result without breaking compatibility.
-    :s
+    :binary
   end
 
   def initialize(contents, options = {})
@@ -64,42 +59,34 @@ class Puppet::FileBucket::File
   end
 
   def to_s
-    @contents.to_s
+    to_binary
+  end
+
+  def to_binary
+    @contents.to_binary
   end
 
   def contents
-    to_s
+    to_binary
   end
 
   def name
     "#{checksum_type}/#{checksum_data}"
   end
 
-  def self.from_s(contents)
+  def self.from_binary(contents)
     self.new(contents)
   end
 
   def to_data_hash
     # Note that this serializes the entire data to a string and places it in a hash.
-    { "contents" => contents.to_s }
+    { "contents" => contents.to_binary }
   end
 
   def self.from_data_hash(data)
     self.new(data["contents"])
   end
 
-  def to_pson
-    Puppet.deprecation_warning("Serializing Puppet::FileBucket::File objects to pson is deprecated.")
-    to_data_hash.to_pson
-  end
-
-  # This method is deprecated, but cannot be removed for awhile, otherwise
-  # older agents sending pson couldn't backup to filebuckets on newer masters
-  def self.from_pson(pson)
-    Puppet.deprecation_warning("Deserializing Puppet::FileBucket::File objects from pson is deprecated. Upgrade to a newer version.")
-    self.from_data_hash(pson)
-  end
-
   private
 
   class StringContents
@@ -125,7 +112,7 @@ class Puppet::FileBucket::File
       Puppet::Util::Checksums.method(base_method).call(@contents)
     end
 
-    def to_s
+    def to_binary
       # This is not so horrible as for FileContent, but still possible to mutate the content that the
       # checksum is based on... so semi horrible...
       return @contents;
@@ -150,7 +137,7 @@ class Puppet::FileBucket::File
       Puppet::Util::Checksums.method(:"#{base_method}_file").call(@path)
     end
 
-    def to_s
+    def to_binary
       Puppet::FileSystem::binread(@path)
     end
   end

data/lib/puppet/file_serving/base.rb

@@ -20,7 +20,7 @@ class Puppet::FileServing::Base
   end
 
   # Return the full path to our file.  Fails if there's no path set.
-  def full_path(dummy_argument=:work_arround_for_ruby_GC_bug)
+  def full_path
     if relative_path.nil? or relative_path == "" or relative_path == "."
        full_path = path
      else
@@ -79,16 +79,6 @@ class Puppet::FileServing::Base
     }
   end
 
-  def to_pson_data_hash
-    {
-      # No 'document_type' since we don't send these bare
-      'data'       => to_data_hash,
-      'metadata' => {
-        'api_version' => 1
-        }
-    }
-  end
-
   def self.absolute?(path)
     Puppet::Util.absolute_path?(path, :posix) or (Puppet.features.microsoft_windows? and Puppet::Util.absolute_path?(path, :windows))
   end

data/lib/puppet/file_serving/content.rb

@@ -12,20 +12,18 @@ class Puppet::FileServing::Content < Puppet::FileServing::Base
   attr_writer :content
 
   def self.supported_formats
-    [:raw]
+    [:binary]
   end
 
-  def self.from_raw(content)
+  def self.from_binary(content)
     instance = new("/this/is/a/fake/path")
     instance.content = content
     instance
   end
 
-  # BF: we used to fetch the file content here, but this is counter-productive
-  # for puppetmaster streaming of file content. So collect just returns itself
+  # This is no longer used, but is still called by the file server implementations when interacting
+  # with their model abstraction.
   def collect(source_permissions = nil)
-    return if stat.ftype == "directory"
-    self
   end
 
   # Read the content of our file in.
@@ -39,7 +37,7 @@ class Puppet::FileServing::Content < Puppet::FileServing::Base
     @content
   end
 
-  def to_raw
+  def to_binary
     File.new(full_path, "rb")
   end
 end

data/lib/puppet/file_serving/metadata.rb

@@ -17,7 +17,7 @@ class Puppet::FileServing::Metadata < Puppet::FileServing::Base
   PARAM_ORDER = [:mode, :ftype, :owner, :group]
 
   def checksum_type=(type)
-    raise(ArgumentError, "Unsupported checksum type #{type}") unless respond_to?("#{type}_file")
+    raise(ArgumentError, "Unsupported checksum type #{type}") unless Puppet::Util::Checksums.respond_to?("#{type}_file")
 
     @checksum_type = type
   end
@@ -27,7 +27,7 @@ class Puppet::FileServing::Metadata < Puppet::FileServing::Base
 
     def initialize(stat, source_permissions = nil)
       @stat = stat
-      @source_permissions_ignore = source_permissions == :ignore
+      @source_permissions_ignore = (!source_permissions || source_permissions == :ignore)
     end
 
     def owner
@@ -53,6 +53,7 @@ class Puppet::FileServing::Metadata < Puppet::FileServing::Base
     def initialize(stat, path, source_permissions = nil)
       super(stat, source_permissions)
       @path = path
+      raise(ArgumentError, "Unsupported Windows source permissions option #{source_permissions}") unless @source_permissions_ignore
     end
 
     { :owner => 'S-1-5-32-544',
@@ -60,45 +61,7 @@ class Puppet::FileServing::Metadata < Puppet::FileServing::Base
       :mode => 0644
     }.each do |method, default_value|
       define_method method do
-        return default_value if @source_permissions_ignore
-
-        # this code remains for when source_permissions is not set to :ignore
-        begin
-          Puppet::Util::Windows::Security.send("get_#{method}", @path) || default_value
-        rescue Puppet::Util::Windows::Error => detail
-          # Very carefully catch only this specific error that result from
-          # trying to read permissions on a symlinked file that is on a volume
-          # that does not support ACLs.
-          #
-          # Unfortunately readlink method will not return the target path when
-          # the given path is not the symlink.
-          #
-          # For instance, consider:
-          #   symlink c:\link points to c:\target
-          #   FileSystem.readlink('c:/link') returns 'c:/target'
-          #   FileSystem.readlink('c:/link/file') will NOT return 'c:/target/file'
-          #
-          # Since detecting this up front is costly, since the path in question
-          # needs to be recursively split and tested at each depth in the path,
-          # we catch the standard error that will result from trying to read a
-          # file that doesn't have a DACL - 1336 is ERROR_INVALID_DACL
-          #
-          # Note that this affects any manually created symlinks as well as
-          # paths like puppet:///modules
-          return default_value if detail.code == 1336
-
-          # Also handle a VirtualBox bug where ERROR_INVALID_FUNCTION is
-          # returned when following a symlink to a volume that is not NTFS.
-          # It appears that the VirtualBox file system is not propagating
-          # the standard Win32 error code above like it should.
-          #
-          # Apologies to all who enter this code path at a later date
-          if detail.code == 1 && Facter.value(:virtual) == 'virtualbox'
-            return default_value
-          end
-
-          raise
-        end
+        return default_value
       end
     end
   end
@@ -176,24 +139,4 @@ class Puppet::FileServing::Metadata < Puppet::FileServing::Base
     new(data.delete('path'), data)
   end
 
-  PSON.register_document_type('FileMetadata',self)
-  def to_pson_data_hash
-    {
-      'document_type' => 'FileMetadata',
-      'data'          => to_data_hash,
-      'metadata'      => {
-        'api_version' => 1
-        }
-    }
-  end
-
-  def to_pson(*args)
-    to_pson_data_hash.to_pson(*args)
-  end
-
-  def self.from_pson(data)
-    Puppet.deprecation_warning("from_pson is being removed in favour of from_data_hash.")
-    self.from_data_hash(data)
-  end
-
 end

data/lib/puppet/file_serving/mount/pluginfacts.rb

@@ -6,7 +6,7 @@ require 'puppet/file_serving/mount'
 class Puppet::FileServing::Mount::PluginFacts < Puppet::FileServing::Mount
   # Return an instance of the appropriate class.
   def find(relative_path, request)
-    return nil unless mod = request.environment.modules.find { |mod|  mod.pluginfact(relative_path) }
+    return nil unless mod = request.environment.modules.find { |m|  m.pluginfact(relative_path) }
 
     path = mod.pluginfact(relative_path)
 

data/lib/puppet/file_serving/mount/plugins.rb

@@ -6,7 +6,7 @@ require 'puppet/file_serving/mount'
 class Puppet::FileServing::Mount::Plugins < Puppet::FileServing::Mount
   # Return an instance of the appropriate class.
   def find(relative_path, request)
-    return nil unless mod = request.environment.modules.find { |mod|  mod.plugin(relative_path) }
+    return nil unless mod = request.environment.modules.find { |m|  m.plugin(relative_path) }
 
     path = mod.plugin(relative_path)
 

data/lib/puppet/file_serving/terminus_helper.rb

@@ -3,6 +3,21 @@ require 'puppet/file_serving/fileset'
 
 # Define some common methods for FileServing termini.
 module Puppet::FileServing::TerminusHelper
+  # Create model instance for a file in a file server.
+  def path2instance(request, path, options = {})
+    result = model.new(path, :relative_path => options[:relative_path])
+    result.checksum_type = request.options[:checksum_type] if request.options[:checksum_type]
+    result.links = request.options[:links] if request.options[:links]
+
+    # :ignore_source_permissions is here pending investigation in PUP-3906.
+    if options[:ignore_source_permissions]
+      result.collect
+    else
+      result.collect(request.options[:source_permissions])
+    end
+    result
+  end
+
   # Create model instances for all files in a fileset.
   def path2instances(request, *paths)
     filesets = paths.collect do |path|
@@ -11,11 +26,7 @@ module Puppet::FileServing::TerminusHelper
     end
 
     Puppet::FileServing::Fileset.merge(*filesets).collect do |file, base_path|
-      inst = model.new(base_path, :relative_path => file)
-      inst.checksum_type = request.options[:checksum_type] if request.options[:checksum_type]
-      inst.links = request.options[:links] if request.options[:links]
-      inst.collect
-      inst
+      path2instance(request, base_path, :ignore_source_permissions => true, :relative_path => file)
     end
   end
 end