puppet 3.2.4 → 3.3.0.rc2

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

@@ -9,7 +9,7 @@ class Puppet::Resource::Rest < Puppet::Indirector::REST
 
   def deserialize_save(content_type, body)
     # Body is [ral_res.to_resource, transaction.report]
-    format = Puppet::Network::FormatHandler.protected_format(content_type)
+    format = Puppet::Network::FormatHandler.format_for(content_type)
     ary = format.intern(Array, body)
     [Puppet::Resource.from_pson(ary[0]), Puppet::Transaction::Report.from_pson(ary[1])]
   end

data/lib/puppet/indirector/resource_type/parser.rb

@@ -2,9 +2,26 @@ require 'puppet/resource/type'
 require 'puppet/indirector/code'
 require 'puppet/indirector/resource_type'
 
+# The main terminus for Puppet::Resource::Type
+#
+# This exposes the known resource types from within Puppet. Only find
+# and search are supported. When a request is received, Puppet will
+# attempt to load all resource types (by parsing manifests and modules) and
+# returns a description of the resource types found. The format of these
+# objects is documented at {Puppet::Resource::Type}.
+#
+# @api public
 class Puppet::Indirector::ResourceType::Parser < Puppet::Indirector::Code
   desc "Return the data-form of a resource type."
 
+  # Find will return the first resource_type with the given name. It is
+  # not possible to specify the kind of the resource type.
+  #
+  # @param request [Puppet::Indirector::Request] The request object.
+  #   The only parameters used from the request are `environment` and
+  #   `key`, which corresponds to the resource type's `name` field.
+  # @return [Puppet::Resource::Type, nil]
+  # @api public
   def find(request)
     krt = request.environment.known_resource_types
 
@@ -20,19 +37,21 @@ class Puppet::Indirector::ResourceType::Parser < Puppet::Indirector::Code
     nil
   end
 
-  # This is the "search" indirection method for resource types.  It searches
-  #  through a specified environment for all custom declared classes
-  #  (a.k.a 'hostclasses'), defined types (a.k.a. 'definitions'), and nodes.
+  # Search for resource types using a regular expression. Unlike `find`, this
+  # allows you to filter the results by the "kind" of the resource type
+  # ("class", "defined_type", or "node"). All three are searched if no
+  # `kind` filter is given. This also accepts the special string "`*`"
+  # to return all resource type objects.
+  #
+  # @param request [Puppet::Indirector::Request] The request object. The
+  #   `key` field holds the regular expression used to search, and
+  #   `options[:kind]` holds the kind query parameter to filter the
+  #   result as described above. The `environment` field specifies the
+  #   environment used to load resources.
+  #
+  # @return [Array<Puppet::Resource::Type>, nil]
   #
-  # @param [Puppet::Indirector::Request] request
-  #   Important properties of the request parameter:
-  #   1. request.environment : The environment in which to look for types.
-  #   2. request.key : A String that will be treated as a regular expression to
-  #         be matched against the names of the available types.  You may also
-  #         pass a "*", which will match all available types.
-  #   3. request.options[:kind] : a String that can be used to filter the output
-  #         to only return the desired kinds.  The current supported values are
-  #         'class', 'defined_type', and 'node'.
+  # @api public
   def search(request)
     krt = request.environment.known_resource_types
     # Make sure we've got all of the types loaded.

data/lib/puppet/interface.rb

@@ -101,7 +101,7 @@ class Puppet::Interface
     def [](name, version)
       unless face = Puppet::Interface::FaceCollection[name, version]
         # REVISIT (#18042) no sense in rechecking if version == :current -- josh
-        if current = Puppet::Interface::FaceCollection[name, :current]
+        if Puppet::Interface::FaceCollection[name, :current]
           raise Puppet::Error, "Could not find version #{version} of #{name}"
         else
           raise Puppet::Error, "Could not find Puppet Face #{name.to_s}"

data/lib/puppet/interface/documentation.rb

@@ -7,9 +7,6 @@ class Puppet::Interface
 
       # We need to identify an indent: the minimum number of whitespace
       # characters at the start of any line in the text.
-      #
-      # Using split rather than each_line is because the later only takes a
-      # block on Ruby 1.8.5 / Centos, and we support that. --daniel 2011-05-03
       indent = text.split(/\n/).map {|x| x.index(/[^\s]/) }.compact.min
 
       if indent > 0 then
@@ -79,7 +76,7 @@ class Puppet::Interface
 
     # @api private
     def build_synopsis(face, action = nil, arguments = nil)
-      output = PrettyPrint.format do |s|
+      PrettyPrint.format do |s|
         s.text("puppet #{face}")
         s.text(" #{action}") unless action.nil?
         s.text(" ")
@@ -105,7 +102,6 @@ class Puppet::Interface
         display_global_options.sort.each do |option|
           wrap = %w{ [ ] }
           s.group(0, *wrap) do
-            desc = Puppet.settings.setting(option).desc
             type = Puppet.settings.setting(option).default
             type ||= Puppet.settings.setting(option).type.to_s.upcase
             s.text "--#{option} #{type}"
@@ -134,11 +130,11 @@ class Puppet::Interface
     #   Sets examples.
     #   @param text [String] Example text
     #   @api public
-    #   @returns [void]
+    #   @return [void]
     #   @dsl Faces
     # @overload examples
     #   Returns documentation of examples
-    #   @returns [String] The examples
+    #   @return [String] The examples
     #   @api private
     attr_doc :examples
 
@@ -147,11 +143,11 @@ class Puppet::Interface
     #   Sets optional notes.
     #   @param text [String] The notes
     #   @api public
-    #   @returns [void]
+    #   @return [void]
     #   @dsl Faces
     # @overload notes
     #   Returns any optional notes
-    #   @returns [String] The notes
+    #   @return [String] The notes
     #   @api private
     attr_doc :notes
 
@@ -160,11 +156,11 @@ class Puppet::Interface
     #   Sets the license text
     #   @param text [String] the license text
     #   @api public
-    #   @returns [void]
+    #   @return [void]
     #   @dsl Faces
     # @overload license
     #   Returns the license
-    #   @returns [String] The license
+    #   @return [String] The license
     #   @api private
     attr_doc :license
 

data/lib/puppet/interface/option.rb

@@ -84,7 +84,7 @@ class Puppet::Interface::Option
     unless found = declaration.match(/^-+(?:\[no-\])?([^ =]+)/) then
       raise ArgumentError, "Can't find a name in the declaration #{declaration.inspect}"
     end
-    name = found.captures.first
+    found.captures.first
   end
 
   # @api private

data/lib/puppet/interface/option_builder.rb

@@ -57,7 +57,7 @@ class Puppet::Interface::OptionBuilder
   def after_action(&block)
     block or raise ArgumentError, "#{@option} after_action requires a block"
     if @option.after_action
-      raise ArgumentError, "#{@option} already has a after_action set"
+      raise ArgumentError, "#{@option} already has an after_action set"
     end
     unless block.arity == 3 then
       raise ArgumentError, "after_action takes three arguments, action, args, and options"

data/lib/puppet/metatype/manager.rb

@@ -131,7 +131,7 @@ module Manager
   def rmtype(name)
     # Then create the class.
 
-    klass = rmclass(name, :hash => @types)
+    rmclass(name, :hash => @types)
 
     singleton_class.send(:remove_method, "new#{name}") if respond_to?("new#{name}")
   end
@@ -145,7 +145,7 @@ module Manager
     @types ||= {}
 
     # We are overwhelmingly symbols here, which usually match, so it is worth
-    # having this special-case to return quickly.  Like, 25K to 300 symbols to
+    # having this special-case to return quickly.  Like, 25K symbols vs. 300
     # strings in this method. --daniel 2012-07-17
     return @types[name] if @types[name]
 

data/lib/puppet/module.rb

@@ -147,6 +147,12 @@ class Puppet::Module
     init_manifests + searched_manifests
   end
 
+  def all_manifests
+    return [] unless File.exists?(manifests)
+
+    Dir.glob(File.join(manifests, '**', '*.{rb,pp}'))
+  end
+
   def metadata_file
     return @metadata_file if defined?(@metadata_file)
 
@@ -234,7 +240,7 @@ class Puppet::Module
 
       dep_mod = begin
         environment.module_by_forge_name(forge_name)
-      rescue => e
+      rescue
         nil
       end
 

data/lib/puppet/module_tool.rb

@@ -17,7 +17,7 @@ module Puppet
     # Is this a directory that shouldn't be checksummed?
     #
     # TODO: Should this be part of Checksums?
-    # TODO: Rename this method to reflect it's purpose?
+    # TODO: Rename this method to reflect its purpose?
     # TODO: Shouldn't this be used when building packages too?
     def self.artifact?(path)
       case File.basename(path)

data/lib/puppet/module_tool/applications/application.rb

@@ -47,6 +47,16 @@ module Puppet::ModuleTool
           elsif require_modulefile
             raise ArgumentError, "No Modulefile found."
           end
+          extra_metadata_path = File.join(@path, 'metadata.json')
+          if File.file?(extra_metadata_path)
+            File.open(extra_metadata_path) do |f|
+              begin
+                @metadata.extra_metadata = PSON.load(f)
+              rescue PSON::ParserError
+                raise ArgumentError, "Could not parse JSON #{extra_metadata_path}"
+              end
+            end
+          end
         end
         @metadata
       end

data/lib/puppet/module_tool/applications/installer.rb

@@ -122,7 +122,7 @@ module Puppet::ModuleTool
 
       #
       # Resolve installation conflicts by checking if the requested module
-      # or one of it's dependencies conflicts with an installed module.
+      # or one of its dependencies conflicts with an installed module.
       #
       # Conflicts occur under the following conditions:
       #
@@ -153,7 +153,10 @@ module Puppet::ModuleTool
                 :version => release[:version][:vstring]
               }
               dependency = is_dependency ? dependency_info : nil
-              latest_version = @versions["#{@module_name}"].sort_by { |h| h[:semver] }.last[:vstring]
+              all_versions = @versions["#{@module_name}"].sort_by { |h| h[:semver] }
+              versions = all_versions.select { |x| x[:semver].special == '' }
+              versions = all_versions if versions.empty?
+              latest_version = versions.last[:vstring]
 
               raise InstallConflictError,
                 :requested_module  => @module_name,
@@ -172,7 +175,7 @@ module Puppet::ModuleTool
       # Check if a file is a vaild module package.
       # ---
       # FIXME: Checking for a valid module package should be more robust and
-      # use the acutal metadata contained in the package. 03132012 - Hightower
+      # use the actual metadata contained in the package. 03132012 - Hightower
       # +++
       #
       def is_module_package?(name)

data/lib/puppet/module_tool/dependency.rb

@@ -2,6 +2,8 @@ module Puppet::ModuleTool
 
   class Dependency
 
+    attr_reader :full_module_name, :username, :name, :version_requirement, :repository
+
     # Instantiates a new module dependency with a +full_module_name+ (e.g.
     # "myuser-mymodule"), and optional +version_requirement+ (e.g. "0.0.1") and
     # optional repository (a URL string).

data/lib/puppet/module_tool/errors/upgrader.rb

@@ -14,7 +14,7 @@ module Puppet::ModuleTool::Errors
       @installed_version = options[:installed_version]
       @dependency_name   = options[:dependency_name]
       @conditions        = options[:conditions]
-      super "Could not upgrade '#{@module_name}'; module is not installed"
+      super "Could not upgrade '#{@module_name}';"
     end
 
     def multiline

data/lib/puppet/module_tool/metadata.rb

@@ -79,6 +79,14 @@ module Puppet::ModuleTool
       @description = description
     end
 
+    def extra_metadata
+      @extra_metadata || {}
+    end
+
+    def extra_metadata=(extra_metadata)
+      @extra_metadata = extra_metadata
+    end
+
     def project_page
       @project_page || 'UNKNOWN'
     end
@@ -121,21 +129,25 @@ module Puppet::ModuleTool
       end
     end
 
+    def to_hash()
+      return extra_metadata.merge({
+        'name'         => @full_module_name,
+        'version'      => @version,
+        'source'       => source,
+        'author'       => author,
+        'license'      => license,
+        'summary'      => summary,
+        'description'  => description,
+        'project_page' => project_page,
+        'dependencies' => dependencies,
+        'types'        => types,
+        'checksums'    => checksums
+      })
+    end
+
     # Return the PSON record representing this instance.
     def to_pson(*args)
-      return {
-        :name         => @full_module_name,
-        :version      => @version,
-        :source       => source,
-        :author       => author,
-        :license      => license,
-        :summary      => summary,
-        :description  => description,
-        :project_page => project_page,
-        :dependencies => dependencies,
-        :types        => types,
-        :checksums    => checksums
-      }.to_pson(*args)
+      return to_hash.to_pson(*args)
     end
   end
 end

data/lib/puppet/module_tool/modulefile.rb

@@ -57,18 +57,18 @@ module Puppet::ModuleTool
       @metadata.license = license
     end
 
-   # Set the summary
-   def summary(summary)
+    # Set the summary
+    def summary(summary)
       @metadata.summary = summary
     end
 
-   # Set the description
-   def description(description)
+    # Set the description
+    def description(description)
       @metadata.description = description
-   end
+    end
 
-   # Set the project page
-   def project_page(project_page)
+    # Set the project page
+    def project_page(project_page)
       @metadata.project_page = project_page
     end
   end

data/lib/puppet/module_tool/shared_behaviors.rb

@@ -36,7 +36,7 @@ module Puppet::ModuleTool::Shared
       mod_name, releases = pair
       mod_name = mod_name.gsub('/', '-')
       releases.each do |rel|
-        semver = SemVer.new(rel['version'] || '0.0.0') rescue SemVer.MIN
+        semver = SemVer.new(rel['version'] || '0.0.0') rescue SemVer::MIN
         @versions[mod_name] << { :vstring => rel['version'], :semver => semver }
         @versions[mod_name].sort! { |a, b| a[:semver] <=> b[:semver] }
         @urls["#{mod_name}@#{rel['version']}"] = rel['file']
@@ -107,7 +107,9 @@ module Puppet::ModuleTool::Shared
         @conditions.each { |_, conds| conds.delete_if { |c| c[:module] == mod } }
       end
 
-      valid_versions = @versions["#{mod}"].select { |h| range === h[:semver] }
+      versions = @versions["#{mod}"].select { |h| range === h[:semver] }
+      valid_versions = versions.select { |x| x[:semver].special == '' }
+      valid_versions = versions if valid_versions.empty?
 
       unless version = valid_versions.last
         req_module   = @module_name

data/lib/puppet/module_tool/skeleton.rb

@@ -23,7 +23,7 @@ module Puppet::ModuleTool
 
     # Return Pathname of custom templates directory.
     def custom_path
-      Pathname(Puppet.settings[:module_working_dir]) + 'skeleton'
+      Pathname(Puppet.settings[:module_skeleton_dir])
     end
 
     # Return Pathname of default template directory.

data/lib/puppet/module_tool/skeleton/templates/generator/manifests/init.pp.erb

@@ -15,16 +15,16 @@
 # Here you should define a list of variables that this module would require.
 #
 # [*sample_variable*]
-#   Explanation of how this variable affects the funtion of this class and if it
-#   has a default. e.g. "The parameter enc_ntp_servers must be set by the
+#   Explanation of how this variable affects the funtion of this class and if
+#   it has a default. e.g. "The parameter enc_ntp_servers must be set by the
 #   External Node Classifier as a comma separated list of hostnames." (Note,
-#   global variables should not be used in preference to class parameters  as of
-#   Puppet 2.6.)
+#   global variables should be avoided in favor of class parameters as
+#   of Puppet 2.6.)
 #
 # === Examples
 #
 #  class { <%= metadata.name %>:
-#    servers => [ 'pool.ntp.org', 'ntp.local.company.com' ]
+#    servers => [ 'pool.ntp.org', 'ntp.local.company.com' ],
 #  }
 #
 # === Authors

data/lib/puppet/module_tool/skeleton/templates/generator/tests/init.pp.erb

@@ -2,10 +2,11 @@
 # should have a corresponding test manifest that declares that class or defined
 # type.
 #
-# Tests are then run by using puppet apply --noop (to check for compilation errors
-# and view a log of events) or by fully applying the test in a virtual environment
-# (to compare the resulting system state to the desired state).
+# Tests are then run by using puppet apply --noop (to check for compilation
+# errors and view a log of events) or by fully applying the test in a virtual
+# environment (to compare the resulting system state to the desired state).
 #
-# Learn more about module testing here: http://docs.puppetlabs.com/guides/tests_smoke.html
+# Learn more about module testing here:
+# http://docs.puppetlabs.com/guides/tests_smoke.html
 #
 include <%= metadata.name %>

data/lib/puppet/network/auth_config_parser.rb

@@ -27,6 +27,9 @@ class AuthConfigParser
         name = $1.chomp
         right = rights.newright(name, count, @file)
       when /^\s*(allow(?:_ip)?|deny(?:_ip)?|method|environment|auth(?:enticated)?)\s+(.+?)(\s*#.*)?$/
+        if right.nil?
+          raise Puppet::ConfigurationError, "Missing or invalid 'path' before right directive at line #{count} of #{@file}"
+        end
         parse_right_directive(right, $1, $2, count)
       else
         raise Puppet::ConfigurationError, "Invalid line #{count}: #{line}"

data/lib/puppet/network/authconfig.rb

@@ -1,4 +1,3 @@
-require 'puppet/util/loadedfile'
 require 'puppet/network/rights'
 
 module Puppet