puppet 3.4.3 → 3.5.0.rc1

data/lib/puppet/environments.rb

@@ -0,0 +1,187 @@
+# @api private
+module Puppet::Environments
+  # @api private
+  module EnvironmentCreator
+    # Create an anonymous environment.
+    #
+    # @param module_path [String] A list of module directories separated by the
+    #   PATH_SEPARATOR
+    # @param manifest [String] The path to the manifest
+    # @return A new environment with the `name` `:anonymous`
+    #
+    # @api private
+    def for(module_path, manifest)
+      Puppet::Node::Environment.create(:anonymous,
+                                       module_path.split(File::PATH_SEPARATOR),
+                                       manifest)
+    end
+  end
+
+  # @!macro [new] loader_search_paths
+  #   A list of indicators of where the loader is getting its environments from.
+  #   @return [Array<String>] The URIs of the load locations
+  #
+  # @!macro [new] loader_list
+  #   @return [Array<Puppet::Node::Environment>] All of the environments known
+  #     to the loader
+  #
+  # @!macro [new] loader_get
+  #   Find a named environment
+  #
+  #   @param name [String,Symbol] The name of environment to find
+  #   @return [Puppet::Node::Environment, nil] the requested environment or nil
+  #     if it wasn't found
+
+  # A source of pre-defined environments.
+  #
+  # @api private
+  class Static
+    include EnvironmentCreator
+
+    def initialize(*environments)
+      @environments = environments
+    end
+
+    # @!macro loader_search_paths
+    def search_paths
+      ["data:text/plain,internal"]
+    end
+
+    # @!macro loader_list
+    def list
+      @environments
+    end
+
+    # @!macro loader_get
+    def get(name)
+      @environments.find do |env|
+        env.name == name.intern
+      end
+    end
+  end
+
+  # Old-style environments that come either from explicit stanzas in
+  # puppet.conf or from dynamic environments created from use of `$environment`
+  # in puppet.conf.
+  #
+  # @example Explicit Stanza
+  #   [environment_name]
+  #   modulepath=/var/my_env/modules
+  #
+  # @example Dynamic Environments
+  #   [master]
+  #   modulepath=/var/$environment/modules
+  #
+  # @api private
+  class Legacy
+    include EnvironmentCreator
+
+    # @!macro loader_search_paths
+    def search_paths
+      ["file://#{Puppet[:config]}"]
+    end
+
+    # @note The list of environments for the Legacy environments is always
+    #   empty.
+    #
+    # @!macro loader_list
+    def list
+      []
+    end
+
+    # @note Because the Legacy system cannot list out all of its environments,
+    #   get is able to return environments that are not returned by a call to
+    #   {#list}.
+    #
+    # @!macro loader_get
+    def get(name)
+      Puppet::Node::Environment.new(name)
+    end
+  end
+
+  # Reads environments from a directory on disk. Each environment is
+  # represented as a sub-directory. The environment's manifest setting is the
+  # `manifest` directory of the environment directory. The environment's
+  # modulepath setting is the global modulepath (from the `[master]` section
+  # for the master) prepended with the `modules` directory of the environment
+  # directory.
+  #
+  # @api private
+  class Directories
+    def initialize(environment_dir, global_module_path)
+      @environment_dir = environment_dir
+      @global_module_path = global_module_path
+    end
+
+    # Generate an array of directory loaders from a path string.
+    # @param path [String] path to environment directories
+    # @param global_module_path [String] the global modulepath setting
+    # @return [Array<Puppet::Environments::Directories>] An array
+    #   of configured directory loaders.
+    def self.from_path(path, global_module_path)
+      environments = path.split(File::PATH_SEPARATOR)
+      environments.map do |dir|
+        Puppet::Environments::Directories.new(dir, global_module_path)
+      end
+    end
+
+    # @!macro loader_search_paths
+    def search_paths
+      ["file://#{@environment_dir}"]
+    end
+
+    # @!macro loader_list
+    def list
+      base = Puppet::FileSystem.path_string(@environment_dir)
+
+      if Puppet::FileSystem.directory?(@environment_dir)
+        Puppet::FileSystem.children(@environment_dir).select do |child|
+          name = Puppet::FileSystem.basename_string(child)
+          Puppet::FileSystem.directory?(child) &&
+             Puppet::Node::Environment.valid_name?(name)
+        end.collect do |child|
+          name = Puppet::FileSystem.basename_string(child)
+          Puppet::Node::Environment.create(
+            name.intern,
+            [File.join(base, name, "modules")] + @global_module_path,
+            File.join(base, name, "manifests"))
+        end
+      else
+        []
+      end
+    end
+
+    # @!macro loader_get
+    def get(name)
+      list.find { |env| env.name == name.intern }
+    end
+  end
+
+  # Combine together multiple loaders to act as one.
+  # @api private
+  class Combined
+    def initialize(*loaders)
+      @loaders = loaders
+    end
+
+    # @!macro loader_search_paths
+    def search_paths
+      @loaders.collect(&:search_paths).flatten
+    end
+
+    # @!macro loader_list
+    def list
+      @loaders.collect(&:list).flatten
+    end
+
+    # @!macro loader_get
+    def get(name)
+      @loaders.each do |loader|
+        if env = loader.get(name)
+          return env
+        end
+      end
+      nil
+    end
+  end
+end

data/lib/puppet/error.rb

@@ -23,12 +23,13 @@ module Puppet
         pos = nil
       end
       super(message, original)
-      @file = file
+      @file = file unless (file.is_a?(String) && file.empty?)
       @line = line
       @pos = pos
     end
     def to_s
       msg = super
+      @file = nil if (@file.is_a?(String) && @file.empty?)
       if @file and @line and @pos
         "#{msg} at #{@file}:#{@line}:#{@pos}"
       elsif @file and @line

data/lib/puppet/external/pson/common.rb

@@ -319,7 +319,7 @@ module PSON
       result
     end
   rescue PSON::NestingError
-    raise ArgumentError, "exceed depth limit"
+    raise ArgumentError, "exceed depth limit", $!.backtrace
   end
 
 

data/lib/puppet/external/pson/pure/generator.rb

@@ -46,7 +46,7 @@ module PSON
       string.gsub!(/["\\\x0-\x1f]/) { MAP[$MATCH] }
       string
     rescue => e
-      raise GeneratorError, "Caught #{e.class}: #{e}"
+      raise GeneratorError, "Caught #{e.class}: #{e}", e.backtrace
     end
   else
     def utf8_to_pson(string) # :nodoc:

data/lib/puppet/external/pson/pure/parser.rb

@@ -204,7 +204,7 @@ module PSON
           UNPARSED
         end
       rescue => e
-        raise GeneratorError, "Caught #{e.class}: #{e}"
+        raise GeneratorError, "Caught #{e.class}: #{e}", e.backtrace
       end
 
       def parse_value

data/lib/puppet/face/config.rb

@@ -1,28 +1,47 @@
 require 'puppet/face'
+require 'puppet/settings/ini_file'
 
 Puppet::Face.define(:config, '0.0.1') do
   copyright "Puppet Labs", 2011
   license   "Apache 2 license; see COPYING"
 
-  summary "Interact with Puppet's configuration options."
+  summary "Interact with Puppet's settings."
+
+  description "This subcommand can inspect and modify settings from Puppet's
+    'puppet.conf' configuration file. For documentation about individual settings,
+    see http://docs.puppetlabs.com/references/latest/configuration.html."
+
+  option "--section SECTION_NAME" do
+    default_to { "main" }
+    summary "The section of the configuration file to interact with."
+    description <<-EOT
+      The section of the puppet.conf configuration file to interact with.
+
+      The three most commonly used sections are 'main', 'master', and 'agent'.
+      'Main' is the default, and is used by all Puppet applications. Other
+      sections can override 'main' values for specific applications --- the
+      'master' section affects puppet master and puppet cert, and the 'agent'
+      section affects puppet agent.
+
+      Less commonly used is the 'user' section, which affects puppet apply. Any
+      other section will be treated as the name of a legacy environment
+      (a deprecated feature), and can only include the 'manifest' and
+      'modulepath' settings.
+    EOT
+  end
 
   action(:print) do
-    summary "Examine Puppet's current configuration settings."
+    summary "Examine Puppet's current settings."
     arguments "(all | <setting> [<setting> ...]"
-    returns <<-'EOT'
-      A single value when called with one config setting, and a list of
-      settings and values when called with multiple options or "all."
-    EOT
     description <<-'EOT'
-      Prints the value of a single configuration option or a list of
-      configuration options.
+      Prints the value of a single setting or a list of settings.
 
       This action is an alternate interface to the information available with
       `puppet <subcommand> --configprint`.
     EOT
     notes <<-'EOT'
-      By default, this action reads the configuration in agent mode.
-      Use the '--run_mode' and '--environment' flags to examine other
+      By default, this action reads the general configuration in the 'main'
+      section. Use the '--section' and '--environment' flags to examine other
       configuration domains.
     EOT
     examples <<-'EOT'
@@ -32,16 +51,55 @@ Puppet::Face.define(:config, '0.0.1') do
 
       Get a list of important directories from the master's config:
 
-      $ puppet config print all --run_mode master | grep -E "(path|dir)"
+      $ puppet config print all --section master | grep -E "(path|dir)"
     EOT
 
     when_invoked do |*args|
-      args.pop
+      options = args.pop
+
+      args = Puppet.settings.to_a.collect(&:first) if args.empty? || args == ['all']
+
+      values = Puppet.settings.values(Puppet[:environment].to_sym, options[:section].to_sym)
+      if args.length == 1
+        puts values.interpolate(args[0].to_sym)
+      else
+        args.each do |setting_name|
+          puts "#{setting_name} = #{values.interpolate(setting_name.to_sym)}"
+        end
+      end
+      nil
+    end
+  end
 
-      args = [ "all" ] if args.empty?
+  action(:set) do
+    summary "Set Puppet's settings."
+    arguments "[setting_name] [setting_value]"
+    description <<-'EOT'
+      Updates values in the `puppet.conf` configuration file.
+    EOT
+    notes <<-'EOT'
+      By default, this action manipulates the configuration in the
+      'main' section. Use the '--section' flag to manipulate other
+      configuration domains.
+    EOT
+    examples <<-'EOT'
+      Set puppet's runfile directory:
+
+      $ puppet config set rundir /var/run/puppet
+
+      Set the vardir for only the agent:
+
+      $ puppet config set vardir /var/lib/puppetagent --section agent
+    EOT
 
-      Puppet.settings[:configprint] = args.join(",")
-      Puppet.settings.print_config_options
+    when_invoked do |name, value, options|
+      path = Puppet::FileSystem.pathname(Puppet.settings.which_configuration_file)
+      Puppet::FileSystem.touch(path)
+      Puppet::FileSystem.open(path, nil, 'r+') do |file|
+        Puppet::Settings::IniFile.update(file) do |config|
+          config.set(options[:section], name, value)
+        end
+      end
       nil
     end
   end

data/lib/puppet/face/file/store.rb

@@ -11,7 +11,7 @@ Puppet::Face.define(:file, '0.0.1') do
     EOT
 
     when_invoked do |path, options|
-      file = Puppet::FileBucket::File.new(Puppet::FileSystem::File.new(path).binread)
+      file = Puppet::FileBucket::File.new(Puppet::FileSystem.binread(path))
 
       Puppet::FileBucket::File.indirection.terminus_class = :file
       Puppet::FileBucket::File.indirection.save file

data/lib/puppet/face/help.rb

@@ -88,12 +88,13 @@ Puppet::Face.define(:help, '0.0.1') do
     begin
       face = Puppet::Face[facename.to_sym, version]
     rescue Puppet::Error => detail
-      fail ArgumentError, <<-MSG
+      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
     if actionname
       action = face.get_action(actionname.to_sym)

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

@@ -1,3 +1,4 @@
+<%# encoding: UTF-8%>
 <% if action.synopsis -%>
 USAGE: <%= action.synopsis %>
 

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

@@ -1,3 +1,4 @@
+<%# encoding: UTF-8%>
 <% if face.synopsis -%>
 USAGE: <%= face.synopsis %>
 

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

@@ -1,3 +1,4 @@
+<%# encoding: UTF-8%>
 Usage: puppet <subcommand> [options] <action> [options]
 
 Available subcommands:

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

@@ -1,3 +1,4 @@
+<%# encoding: UTF-8%>
 puppet-<%= face.name %>(8) -- <%= face.summary || "Undocumented subcommand." %>
 <%= '=' * (_erbout.length - 1) %>
 
@@ -15,10 +16,10 @@ DESCRIPTION
 <% end -%>
 OPTIONS
 -------
-Note that any configuration parameter that's valid in the configuration
+Note that any setting that's valid in the configuration
 file is also a valid long argument, although it may or may not be
 relevant to the present action. For example, `server` and `run_mode` are valid
-configuration parameters, so you can specify `--server <servername>`, or
+settings, so you can specify `--server <servername>`, or
 `--run_mode <runmode>` as an argument.
 
 See the configuration file documentation at
@@ -38,18 +39,18 @@ configuration options can also be generated by running puppet with
 <% unless face.display_global_options.empty?
      face.display_global_options.uniq.sort.each do |name|
 		option = name
-		desc = Puppet.settings.setting(option).desc
+		desc = Puppet::Util::Docs.scrub(Puppet.settings.setting(option).desc)
 		type = Puppet.settings.setting(option).default
 		type ||= Puppet.settings.setting(option).type.to_s.upcase -%>
 <%= "* --#{option} #{type}" %>:
-<%= desc.gsub(/^/, '  ') || '  undocumented setting' %>
+<%= (desc || 'Undocumented setting.').gsub(/^/, '  ') %>
 <%   end
    end -%>
 <% unless face.options.empty?
      face.options.sort.each do |name|
        option = face.get_option name -%>
 <%= "* " + option.optparse.join(" | " ) %>:
-<%= option.description.gsub(/^/, '  ') || '  ' + option.summary %>
+<%= (option.description || option.summary || "Undocumented option.").gsub(/^/, '  ') %>
 <%   end
    end -%>
 
@@ -78,15 +79,15 @@ ACTIONS
   `OPTIONS`
 <%      unique_display_global_options.uniq.sort.each do |name|
 		  option = name
-		  desc = Puppet.settings.setting(option).desc
+		  desc = Puppet::Util::Docs.scrub(Puppet.settings.setting(option).desc)
 		  type = Puppet.settings.setting(option).default
 		  type ||= Puppet.settings.setting(option).type.to_s.upcase -%>
   <%= "<--#{option} #{type}>" %> -
-<%= desc.gsub(/^/, '  ') %>
+<%= (desc || "Undocumented setting.").gsub(/^/, '  ') %>
 <%      end -%>
 <%     unique_options.sort.each do |name|
          option = action.get_option name
-         text = (option.description || option.summary).chomp + "\n" -%>
+         text = (option.description || option.summary || "Undocumented option.").chomp + "\n" -%>
   <%= '<' + option.optparse.join("> | <") + '>' %> -
 <%= text.gsub(/^/, '  ') %>
 <%     end -%>