puppet 3.0.2 → 3.1.0.rc1

data/lib/puppet/dsl/resource_decorator.rb

@@ -0,0 +1,56 @@
+require 'puppet/dsl/blank_slate'
+require 'puppet/dsl/resource_reference'
+
+module Puppet
+  # @since 3.1 
+  # @status EXPERIMENTAL
+  module DSL
+    # Thin decorator layer for accessing attributes of array/hash-like objects.
+    # @see Puppet::DSL::Context#create_resource  Context#create_resource for examples of usage
+    #
+    class ResourceDecorator < BlankSlate
+
+      # Initializes new object.
+      # @overload initialize(resource, {|r| block})
+      # @param resource [#[], #[]=] any object responding to these methods
+      # @yieldparam r [ResourceDecorator] the `self` when evaluating the ruby block
+      # @param block [ruby] the Ruby DSL statements to evaluate.
+      #
+      def initialize(resource, &block)
+        @resource = resource
+        block.call self
+      end
+
+      # A proxy method allowing direct access to resource parameters instead of
+      # having to use `#[]` or `#[]=`
+      #
+      # After a first call it creates a cached version of the created access method.
+      #
+      # @example
+      #   # allows using this
+      #   r.title = "I am a resource"
+      #   # instead of this
+      #   r[:title] = "I am a resource"
+      #
+      def method_missing(name, *args)
+        if name.to_s =~ /\A(.*)=\z/
+          define_singleton_method name do |*a|
+            value = a.first
+            value = value.reference if value.is_a? ::Puppet::DSL::ResourceReference
+            value = value.to_s  unless value.is_a? ::Puppet::Resource
+            @resource[$1.to_sym] = value
+          end
+
+          self.__send__ name, *args
+        else
+          define_singleton_method name do
+            @resource[name]
+          end
+
+          self.__send__ name, *args
+        end
+      end
+
+    end
+  end
+end

data/lib/puppet/dsl/resource_reference.rb

@@ -0,0 +1,95 @@
+require 'puppet/dsl/resource_decorator'
+require 'puppet/dsl/parser'
+require 'puppet/parser/resource/param'
+require 'puppet/parser/resource'
+
+module Puppet
+  # @since 3.1 
+  # @status EXPERIMENTAL
+  module DSL
+    # ResourceReference is a thin wrapper for assigning references to the
+    # resources and creating overrides.
+    #
+    class ResourceReference
+      # @return [Puppet::Parser::Resource] referenced resource
+      #
+      attr_reader :resource
+
+      # Creates a new ResourceReference.
+      # @param typeref [String] the name of the type
+      # @param name [String] the name of a resource instance of this type
+      # @raise [ArgumentError] if the referenced _typename_/_name_ is not found
+      #
+      def initialize(typeref, name)
+        @resource = Puppet::DSL::Parser.current_scope.findresource typeref.type_name, name
+        raise ArgumentError, "resource `#{typeref.type_name}[#{name}]' not found" unless @resource
+      end
+
+      # This method is used by ResourceDecorator for stringifying references.
+      # @return [String] the resource in string form
+      #
+      def reference
+        @resource.to_s
+      end
+      alias to_s reference
+
+      # Creates overrides for a resource and returns the resulting overrides as a Hash.
+      # @overload override(options)
+      # @overload override(options, {|r| block}
+      # @overload override({|r| block})
+      # @param options [Hash] parameter name to value mapping of values to override.
+      # @param r [ResourceReference] the `self` when evaluating the Ruby DSL block.
+      # @param block [ruby] Ruby DSL statements to be executed.
+      # @return [Hash] a hash with a mapping from parameter name to value with overridden name/values.
+      # @raise [ArgumentError] when no block or options have been supplied.
+      #
+      def override(options = {}, &block)
+        raise ArgumentError, "no block or options supplied" if options == {} and block.nil?
+
+        Puppet::DSL::ResourceDecorator.new(options, &block) unless block.nil?
+        scope = Puppet::DSL::Parser.current_scope
+
+        # for compatibility with Puppet parser
+        params = options.map do |k, v|
+          Puppet::Parser::Resource::Param.new :name => k, :value => v, :source => scope.source
+        end
+
+        resource = Puppet::Parser::Resource.new @resource.type, @resource.name,
+                                                :parameters => params, :scope => scope,
+                                                :source => scope.source
+
+        override = scope.compiler.add_override resource
+
+        result = {}
+        override.each do |_, v|
+          result.merge! v.name => v.value
+        end
+        result
+      end
+
+      # Realizes referenced virtual resource.
+      # @return [Puppet::Parser::Collector, nil] collector containing the realized resource, or nil if it is not virtual.
+      #
+      def realize
+        return unless @resource.virtual
+        scope = Puppet::DSL::Parser.current_scope
+        c = Puppet::Parser::Collector.new scope, @type, nil, nil, :virtual
+        c.resources = [@resource]
+        scope.compiler.add_collection c
+        c
+      end
+
+      # Collects referenced exported resource
+      # @return [Puppet::Parser::Collector, nil] collector containing the collected resource, or nil if it is not exported.
+      #
+      def collect
+        return unless @resource.exported
+        scope = Puppet::DSL::Parser.current_scope
+        c = Puppet::Parser::Collector.new scope, @type, nil, nil, :exported
+        c.resources = [@resource]
+        scope.compiler.add_collection c
+        c
+      end
+    end
+  end
+end

data/lib/puppet/dsl/type_reference.rb

@@ -0,0 +1,102 @@
+require 'puppet/parser/collector'
+require 'puppet/parser/resource/param'
+require 'puppet/dsl/resource_reference'
+require 'puppet/dsl/resource_decorator'
+require 'puppet/dsl/parser'
+
+module Puppet
+  # @since 3.1 
+  # @status EXPERIMENTAL
+  module DSL
+
+    # TypeReference object is returned by `Context#const_missing`.
+    # It allows to set defaults, create collections and get references for
+    # resources of given type.
+    #
+    class TypeReference
+
+      # @return [String] Puppet type represented by this reference
+      #
+      attr_reader :type_name
+      alias to_s type_name
+
+      # Creates new TypeReference of the given _typename_ type.
+      # @param typename [String] the name of the type to create a reference to.
+      # @raise [NameError] when resource type is not found
+      #
+      def initialize(typename)
+        name = Puppet::Resource.canonicalize_type typename
+        if Puppet::DSL::Context.const_defined? name
+          @type_name = name
+          @cache = {}
+        else
+          raise NameError, "resource type `#{name}' not found"
+        end
+      end
+
+      # Produces a reference to a resource identified by the given _reference_.
+      # The result is cached for future use.
+      # @return [ResourceReference] reference to resource identified by the given _reference_
+      # @raise [ArgumentError] when resource cannot be found.
+      #
+      def [](reference)
+        @cache[reference] ||= Puppet::DSL::ResourceReference.new self, reference
+      end
+
+      # Creates a collection for exported resources.
+      # @return [Puppet::Parser::Collector] for exported instances of this type reference's type.
+      #
+      def collect
+        scope = Puppet::DSL::Parser.current_scope
+        c = Puppet::Parser::Collector.new scope, @type_name, nil, nil, :exported
+        scope.compiler.add_collection c
+        c
+      end
+
+      # Creates a collection for virtual resources.
+      # @return [Puppet::Parser::Collector] for virtual instances of this type reference's type.
+      #
+      def realize
+        scope = Puppet::DSL::Parser.current_scope
+        c = Puppet::Parser::Collector.new scope, @type_name, nil, nil, :virtual
+        scope.compiler.add_collection c
+        c
+      end
+
+      # Sets and/or gets defaults for the resource type this type reference represents. The values
+      # returned are the defaults in effect after the operation.
+      # @overload defaults()
+      #   @return [Hash] a parameter to value mapping of the current set of defaults.
+      #
+      # @overload defaults(options)
+      #   Sets the defaults in the given options hash as new default values. Only changes
+      #   values for the given keys.
+      #   @param options [Hash] mapping from parameter name to value of new defaults to set.
+      #
+      # @overload defaults(options, {|r| block})
+      #   @param options [Hash] a parameter to value mapping of the new defaults to set.
+      #   @param r [ResourceDecorator] the `self` when evaluating the Ruby DSL block.
+      #   @param block [ruby] a block in which Ruby DSL statements can be executed for the resource type.
+      # @return [Hash] mapping from parameter name to value of the resulting set of defaults.
+      #
+      def defaults(options = {}, &block)
+        if options != {} or block
+          Puppet::DSL::ResourceDecorator.new(options, &block) unless block.nil?
+
+          # for compatibility with Puppet parser
+          options = options.map do |k, v|
+            Puppet::Parser::Resource::Param.new :name => k, :value => v
+          end
+          Puppet::DSL::Parser.current_scope.define_settings @type_name, options
+        end
+
+        result = {}
+        Puppet::DSL::Parser.current_scope.lookupdefaults(@type_name).map do |_, v|
+          result[v.name] = v.value
+        end
+        result
+      end
+
+    end
+  end
+end

data/lib/puppet/error.rb

@@ -1,4 +1,4 @@
-module Puppet # :nodoc:
+module Puppet
   # The base class for all Puppet errors. It can wrap another exception
   class Error < RuntimeError
     attr_reader :original

data/lib/puppet/face/help.rb

@@ -1,6 +1,5 @@
 require 'puppet/face'
 require 'puppet/application/face_base'
-require 'puppet/util/command_line'
 require 'puppet/util/constant_inflector'
 require 'pathname'
 require 'erb'
@@ -123,7 +122,7 @@ Detail: "#{detail.message}"
 
   # Return a list of applications that are not simply just stubs for Faces.
   def legacy_applications
-    Puppet::Util::CommandLine.available_subcommands.reject do |appname|
+    Puppet::Application.available_application_names.reject do |appname|
       (is_face_app?(appname)) or (exclude_from_docs?(appname))
     end.sort
   end
@@ -134,7 +133,7 @@ Detail: "#{detail.message}"
   #  element in the outer array is a pair whose first element is a String containing the application
   #  name, and whose second element is a String containing the summary for that application.
   def all_application_summaries()
-    Puppet::Util::CommandLine.available_subcommands.sort.inject([]) do |result, appname|
+    Puppet::Application.available_application_names.sort.inject([]) do |result, appname|
       next result if exclude_from_docs?(appname)
 
       if (is_face_app?(appname))
@@ -152,7 +151,6 @@ Detail: "#{detail.message}"
 
   def horribly_extract_summary_from(appname)
     begin
-      require "puppet/application/#{appname}"
       help = Puppet::Application[appname].help.split("\n")
       # Now we find the line with our summary, extract it, and return it.  This
       # depends on the implementation coincidence of how our pages are

data/lib/puppet/face/man.rb

@@ -59,7 +59,13 @@ Puppet::Face.define(:man, '0.0.1') do
       # OK, if we have Ronn on the path we can delegate to it and override the
       # normal output process.  Otherwise delegate to a pager on the raw text,
       # otherwise we finally just delegate to our parent.  Oh, well.
-      ENV['LESS'] ||= 'FRSX'    # emulate git...
+
+      # These are the same options for less that git normally uses.
+      # -R : Pass through color control codes (allows display of colors)
+      # -X : Don't init/deinit terminal (leave display on screen on exit)
+      # -F : automatically exit if display fits entirely on one screen
+      # -S : don't wrap long lines
+      ENV['LESS'] ||= 'FRSX'
 
       ronn  = Puppet::Util.which('ronn')
       pager = [ENV['MANPAGER'], ENV['PAGER'], 'less', 'most', 'more'].
@@ -84,7 +90,7 @@ Puppet::Face.define(:man, '0.0.1') do
 
   def legacy_applications
     # The list of applications, less those that are duplicated as a face.
-    Puppet::Util::CommandLine.available_subcommands.reject do |appname|
+    Puppet::Application.available_application_names.reject do |appname|
       Puppet::Face.face? appname.to_sym, :current or
         # ...this is a nasty way to exclude non-applications. :(
         %w{face_base indirection_base}.include? appname

data/lib/puppet/feature/pson.rb

@@ -1,6 +1,4 @@
 Puppet.features.add(:pson) do
-  require 'puppet/external/pson/common'
-  require 'puppet/external/pson/version'
-  require 'puppet/external/pson/pure'
+  Puppet.deprecation_warning "There is no need to check for pson support. It is always available."
   true
 end

data/lib/puppet/indirector/catalog/active_record.rb

@@ -5,6 +5,9 @@ require 'puppet/resource/catalog'
 class Puppet::Resource::Catalog::ActiveRecord < Puppet::Indirector::ActiveRecord
   use_ar_model Puppet::Rails::Host
 
+  desc "A component of ActiveRecord storeconfigs. ActiveRecord-based storeconfigs
+    and inventory are deprecated. See http://links.puppetlabs.com/activerecord-deprecation"
+
   def initialize
     Puppet.deprecation_warning "ActiveRecord-based storeconfigs and inventory are deprecated. See http://links.puppetlabs.com/activerecord-deprecation"
     super

data/lib/puppet/indirector/catalog/compiler.rb

@@ -4,8 +4,7 @@ require 'puppet/indirector/code'
 require 'yaml'
 
 class Puppet::Resource::Catalog::Compiler < Puppet::Indirector::Code
-  desc "Puppet's catalog compilation interface, and its back-end is
-    Puppet's compiler"
+  desc "Compiles catalogs on demand using Puppet's compiler."
 
   include Puppet::Util
 

data/lib/puppet/indirector/catalog/queue.rb

@@ -2,4 +2,8 @@ require 'puppet/resource/catalog'
 require 'puppet/indirector/queue'
 
 class Puppet::Resource::Catalog::Queue < Puppet::Indirector::Queue
+
+  desc "Part of async storeconfigs, requiring the puppet queue daemon. ActiveRecord-based storeconfigs
+    and inventory are deprecated. See http://links.puppetlabs.com/activerecord-deprecation"
+
 end

data/lib/puppet/indirector/catalog/static_compiler.rb

@@ -3,6 +3,36 @@ require 'puppet/resource/catalog'
 require 'puppet/indirector/code'
 
 class Puppet::Resource::Catalog::StaticCompiler < Puppet::Indirector::Code
+
+  desc %q{Compiles catalogs on demand using the optional static compiler. This
+    functions similarly to the normal compiler, but it replaces puppet:/// file
+    URLs with explicit metadata and file content hashes, expecting puppet agent
+    to fetch the exact specified content from the filebucket. This guarantees
+    that a given catalog will always result in the same file states. It also
+    decreases catalog application time and fileserver load, at the cost of
+    increased compilation time.
+
+    This terminus works today, but cannot be used without additional
+    configuration. Specifically:
+
+    You must create a `Filebucket['puppet']` resource in site.pp (or somewhere
+    else where it will be added to every node's catalog). The title of this
+    resource **MUST** be "puppet"; the static compiler treats this title as magical.
+
+        # Note: the special $servername var always contains the master's FQDN,
+        # even if it was reached at a different name.
+        filebucket { puppet:
+          server => $servername,
+          path   => false,
+        }
+
+    You must set `catalog_terminus = static_compiler` in the puppet master's puppet.conf.
+
+    If you are using multiple puppet masters, you must configure load balancer
+    affinity for agent nodes. This is because puppet masters other than the one
+    that compiled a given catalog may not have stored the required file contents
+    in their filebuckets.}
+
   def compiler
     @compiler ||= indirection.terminus(:compiler)
   end

data/lib/puppet/indirector/catalog/store_configs.rb

@@ -2,4 +2,7 @@ require 'puppet/indirector/store_configs'
 require 'puppet/resource/catalog'
 
 class Puppet::Resource::Catalog::StoreConfigs < Puppet::Indirector::StoreConfigs
+
+  desc %q{Part of the "storeconfigs" feature. Should not be directly set by end users.}
+
 end

data/lib/puppet/indirector/certificate_request/rest.rb

@@ -6,4 +6,5 @@ class Puppet::SSL::CertificateRequest::Rest < Puppet::Indirector::REST
 
   use_server_setting(:ca_server)
   use_port_setting(:ca_port)
+  use_srv_service(:ca)
 end

data/lib/puppet/indirector/certificate_revocation_list/rest.rb

@@ -6,4 +6,5 @@ class Puppet::SSL::CertificateRevocationList::Rest < Puppet::Indirector::REST
 
   use_server_setting(:ca_server)
   use_port_setting(:ca_port)
+  use_srv_service(:ca)
 end

data/lib/puppet/indirector/certificate_status/file.rb

@@ -7,6 +7,10 @@ require 'puppet/ssl/host'
 require 'puppet/ssl/key'
 
 class Puppet::Indirector::CertificateStatus::File < Puppet::Indirector::Code
+
+  desc "Manipulate certificate status on the local filesystem. Only functional
+    on the CA."
+
   def ca
     raise ArgumentError, "This process is not configured as a certificate authority" unless Puppet::SSL::CertificateAuthority.ca?
     Puppet::SSL::CertificateAuthority.new

data/lib/puppet/indirector/certificate_status/rest.rb

@@ -7,4 +7,5 @@ class Puppet::Indirector::CertificateStatus::Rest < Puppet::Indirector::REST
 
   use_server_setting(:ca_server)
   use_port_setting(:ca_port)
+  use_srv_service(:ca)
 end

data/lib/puppet/indirector/facts/active_record.rb

@@ -6,6 +6,9 @@ require 'puppet/indirector/active_record'
 class Puppet::Node::Facts::ActiveRecord < Puppet::Indirector::ActiveRecord
   use_ar_model Puppet::Rails::Host
 
+  desc "A component of ActiveRecord storeconfigs and inventory. ActiveRecord-based storeconfigs
+    and inventory are deprecated. See http://links.puppetlabs.com/activerecord-deprecation"
+
   def initialize
     Puppet.deprecation_warning "ActiveRecord-based storeconfigs and inventory are deprecated. See http://links.puppetlabs.com/activerecord-deprecation"
     super