puppet 5.0.0 → 6.0.0

data/lib/puppet/environments.rb

@@ -115,7 +115,7 @@ module Puppet::Environments
     def get_conf(name)
       env = get(name)
       if env
-        Puppet::Settings::EnvironmentConf.static_for(env, 0, Puppet[:static_catalogs], Puppet[:rich_data])
+        Puppet::Settings::EnvironmentConf.static_for(env, Puppet[:environment_timeout], Puppet[:static_catalogs], Puppet[:rich_data])
       else
         nil
       end
@@ -138,6 +138,23 @@ module Puppet::Environments
     end
   end
 
+  class StaticDirectory < Static
+    # Accepts a single environment in the given directory having the given name (not required to be reflected as the name
+    # of the directory)
+    # 
+    def initialize(env_name, env_dir, environment)
+      super(environment)
+      @env_dir = env_dir
+      @env_name = env_name
+    end
+
+    # @!macro loader_get_conf
+    def get_conf(name)
+      return nil unless name == @env_name
+      Puppet::Settings::EnvironmentConf.load_from(@env_dir, '')
+    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
@@ -296,14 +313,9 @@ module Puppet::Environments
       @cache_expiration_service || DefaultCacheExpirationService.new
     end
 
-    # Returns the end of time (the next Mesoamerican Long Count cycle-end after 2012 (5125+2012) = 7137,
-    # of for a 32 bit machine using Ruby < 1.9.3, the year 2038.
+    # Returns the end of time (the next Mesoamerican Long Count cycle-end after 2012 (5125+2012) = 7137
     def self.end_of_time
-      begin
-        Time.gm(7137)
-      rescue ArgumentError
-        Time.gm(2038)
-      end
+      Time.gm(7137)
     end
 
     END_OF_TIME = end_of_time
@@ -365,6 +377,7 @@ module Puppet::Environments
     # (The intention is that this could be used from a MANUAL cache eviction command (TBD)
     def clear(name)
       @cache.delete(name)
+      Puppet::GettextConfig.delete_text_domain(name)
     end
 
     # Clears all cached environments.
@@ -374,6 +387,7 @@ module Puppet::Environments
       @cache = {}
       @expirations.clear
       @next_expiration = END_OF_TIME
+      Puppet::GettextConfig.delete_environment_text_domains
     end
 
     # Clears all environments that have expired, either by exceeding their time to live, or
@@ -424,10 +438,9 @@ module Puppet::Environments
     # Also clears caches in Settings that may prevent the entry from being updated
     def evict_if_expired(name)
       if (result = @cache[name]) && (result.expired? || @cache_expiration_service.expired?(name))
-      Puppet.debug {"Evicting cache entry for environment '#{name}'"}
-        @cache.delete(name)
+        Puppet.debug {"Evicting cache entry for environment '#{name}'"}
         @cache_expiration_service.evicted(name)
-
+        clear(name)
         Puppet.settings.clear_environment_settings(name)
       end
     end

data/lib/puppet/error.rb

@@ -3,7 +3,7 @@ module Puppet
   class Error < RuntimeError
     attr_accessor :original
     def initialize(message, original=nil)
-      super(Puppet::Util::CharacterEncoding.scrub(message))
+      super(message.scrub)
       @original = original
     end
   end
@@ -27,22 +27,12 @@ module Puppet
       @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
-        "#{msg} at #{@file}:#{@line}"
-      elsif @line and @pos
-          "#{msg} at line #{@line}:#{@pos}"
-      elsif @line
-        "#{msg} at line #{@line}"
-      elsif @file
-        "#{msg} in #{@file}"
-      else
-        msg
-      end
+      msg += Puppet::Util::Errors.error_location_with_space(@file, @line, @pos)
+      msg
     end
   end
 
@@ -56,7 +46,7 @@ module Puppet
 
   # Contains an issue code and can be annotated with an environment and a node
   class ParseErrorWithIssue < Puppet::ParseError
-    attr_reader :issue_code, :basic_message
+    attr_reader :issue_code, :basic_message, :arguments
     attr_accessor :environment, :node
 
     # @param message [String] The error message
@@ -65,19 +55,34 @@ module Puppet
     # @param pos [Integer] The position on the line
     # @param original [Exception] Original exception
     # @param issue_code [Symbol] The issue code
+    # @param arguments [Hash{Symbol=>Object}] Issue arguments
     #
-    def initialize(message, file=nil, line=nil, pos=nil, original=nil, issue_code= nil)
+    def initialize(message, file=nil, line=nil, pos=nil, original=nil, issue_code= nil, arguments = nil)
       super(message, file, line, pos, original)
       @issue_code = issue_code
       @basic_message = message
+      @arguments = arguments
     end
 
     def to_s
       msg = super
-      msg = "Could not parse for environment #{environment}: #{msg}" if environment
-      msg = "#{msg} on node #{node}" if node
+      msg = _("Could not parse for environment %{environment}: %{message}") % { environment: environment, message: msg } if environment
+      msg = _("%{message} on node %{node}") % { message: msg, node: node } if node
       msg
     end
+
+    def self.from_issue_and_stack(issue, args = {})
+      filename, line = Puppet::Pops::PuppetStack.top_of_stack
+
+      self.new(
+            issue.format(args),
+            filename,
+            line,
+            nil,
+            nil,
+            issue.issue_code,
+            args)
+    end
   end
 
   # An error that already contains location information in the message text
@@ -97,4 +102,16 @@ module Puppet
   class LockError < Puppet::Error
   end
 
+  # An Error suitable for raising an error with details in a Puppet::Datatypes::Error
+  # that can be used as a value in the Puppet Language
+  #
+  class ErrorWithData < Puppet::Error
+    include ExternalFileError
+    attr_reader :error_data
+
+    def initialize(error_data, message, file: nil, line: nil, pos: nil, original:nil)
+      super(message, file, line, pos, original)
+      @error_data = error_data
+    end
+  end
 end

data/lib/puppet/etc.rb

@@ -109,7 +109,7 @@ module Puppet::Etc
     # Defines Puppet::Etc::Passwd struct class. Contains all of the original
     # member fields of Etc::Passwd, and additional "canonical_" versions of
     # these fields as well. API compatible with Etc::Passwd. Because Struct.new
-    # defines a new Class object, we memozie to avoid superfluous extra Class
+    # defines a new Class object, we memoize to avoid superfluous extra Class
     # instantiations.
     def puppet_etc_passwd_class
       @password_class ||= Struct.new(*Etc::Passwd.members, *Etc::Passwd.members.map { |member| "canonical_#{member}".to_sym })
@@ -133,7 +133,7 @@ module Puppet::Etc
     # @api private
     # @param [Etc::Passwd or Etc::Group struct]
     # @return [Puppet::Etc::Passwd or Puppet::Etc::Group struct] a new struct
-    #   object with the original struct values overidden to UTF-8, if valid. For
+    #   object with the original struct values overridden to UTF-8, if valid. For
     #   invalid values originating in UTF-8, invalid characters are replaced with
     #   '?'. For each member the struct also contains a corresponding
     #   :canonical_<member name> struct member.
@@ -143,10 +143,12 @@ module Puppet::Etc
       struct.each_pair do |member, value|
         if value.is_a?(String)
           new_struct["canonical_#{member}".to_sym] = value.dup
-          new_struct[member] = Puppet::Util::CharacterEncoding.scrub(Puppet::Util::CharacterEncoding.override_encoding_to_utf_8(value))
+          new_struct[member] = Puppet::Util::CharacterEncoding.override_encoding_to_utf_8(value).scrub
         elsif value.is_a?(Array)
           new_struct["canonical_#{member}".to_sym] = value.inject([]) { |acc, elem| acc << elem.dup }
-          new_struct[member] = value.inject([]) { |acc, elem| acc << Puppet::Util::CharacterEncoding.scrub(Puppet::Util::CharacterEncoding.override_encoding_to_utf_8(elem)) }
+          new_struct[member] = value.inject([]) do |acc, elem|
+            acc << Puppet::Util::CharacterEncoding.override_encoding_to_utf_8(elem).scrub
+          end
         else
           new_struct["canonical_#{member}".to_sym] = value
           new_struct[member] = value
@@ -156,6 +158,3 @@ module Puppet::Etc
     end
   end
 end
-
-
-

data/lib/puppet/external/dot.rb

@@ -15,7 +15,7 @@ module DOT
 
   # if we don't like 4 spaces, we can change it any time
 
-  def change_tab (t)
+  def change_tab(t)
     $tab  = t
     $tab2 = t * 2
   end
@@ -118,7 +118,7 @@ module DOT
 
     attr_accessor :name
 
-    def initialize (params = {})
+    def initialize(params = {})
       @label = params['name'] ? params['name'] : ''
     end
 
@@ -134,7 +134,7 @@ module DOT
     # attr_reader :parent
     attr_accessor :name, :options
 
-    def initialize (params = {}, option_list = [])
+    def initialize(params = {}, option_list = [])
       super(params)
       @name   = params['name']   ? params['name']   : nil
       @parent = params['parent'] ? params['parent'] : nil
@@ -168,7 +168,7 @@ module DOT
 
     attr_accessor :label
 
-    def initialize (params = {})
+    def initialize(params = {})
       super(params)
       @name = params['label'] ? params['label'] : ''
     end
@@ -181,10 +181,7 @@ module DOT
   # node element
 
   class DOTNode < DOTElement
-
-    @ports
-
-    def initialize (params = {}, option_list = NODE_OPTS)
+    def initialize(params = {}, option_list = NODE_OPTS)
       super(params, option_list)
       @ports = params['ports'] ? params['ports'] : []
     end
@@ -193,11 +190,11 @@ module DOT
       @ports.each { |i| yield i }
     end
 
-    def << (thing)
+    def <<(thing)
       @ports << thing
     end
 
-    def push (thing)
+    def push(thing)
       @ports.push(thing)
     end
 
@@ -205,16 +202,16 @@ module DOT
       @ports.pop
     end
 
-    def to_s (t = '')
+    def to_s(t = '')
 
       # This code is totally incomprehensible; it needs to be replaced!
 
       label = @options['shape'] != 'record' && @ports.length == 0 ?
           @options['label'] ?
-            t + $tab + "label = \"#{@options['label']}\"\n" :
+            t + $tab + "label = #{stringify(@options['label'])}\n" :
             '' :
           t + $tab + 'label = "' + " \\\n" +
-          t + $tab2 + "#{@options['label']}| \\\n" +
+          t + $tab2 + "#{stringify(@options['label'])}| \\\n" +
           @ports.collect{ |i|
             t + $tab2 + i.to_s
           }.join( "| \\\n" ) + " \\\n" +
@@ -229,17 +226,19 @@ module DOT
         t + "]\n"
     end
 
+    private
+
+    def stringify(s)
+      %("#{s.gsub('"', '\\"')}")
+    end
+
   end
 
   # A subgraph element is the same to graph, but has another header in dot
   # notation.
 
   class DOTSubgraph < DOTElement
-
-    @nodes
-    @dot_string
-
-    def initialize (params = {}, option_list = GRAPH_OPTS)
+    def initialize(params = {}, option_list = GRAPH_OPTS)
       super(params, option_list)
       @nodes      = params['nodes'] ? params['nodes'] : []
       @dot_string = 'graph'
@@ -249,11 +248,11 @@ module DOT
       @nodes.each{ |i| yield i }
     end
 
-    def << (thing)
+    def <<(thing)
       @nodes << thing
     end
 
-    def push (thing)
+    def push(thing)
       @nodes.push( thing )
     end
 
@@ -261,7 +260,7 @@ module DOT
       @nodes.pop
     end
 
-    def to_s (t = '')
+    def to_s(t = '')
       hdr = t + "#{@dot_string} #{@name} {\n"
 
       options = @options.to_a.collect{ |name, val|
@@ -282,7 +281,7 @@ module DOT
 
   class DOTDigraph < DOTSubgraph
 
-  def initialize (params = {}, option_list = GRAPH_OPTS)
+  def initialize(params = {}, option_list = GRAPH_OPTS)
     super(params, option_list)
     @dot_string = 'digraph'
   end
@@ -295,7 +294,7 @@ module DOT
 
     attr_accessor :from, :to
 
-    def initialize (params = {}, option_list = EDGE_OPTS)
+    def initialize(params = {}, option_list = EDGE_OPTS)
       super(params, option_list)
       @from = params['from'] ? params['from'] : nil
       @to   = params['to'] ? params['to'] : nil
@@ -305,7 +304,7 @@ module DOT
       '--'
     end
 
-    def to_s (t = '')
+    def to_s(t = '')
       t + "#{@from} #{edge_link} #{to} [\n" +
         @options.to_a.collect{ |i|
           i[1] && i[0] != 'label' ?

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

@@ -43,7 +43,7 @@ module PSON
         case
         when c.empty?             then p
         when p.const_defined?(c)  then p.const_get(c)
-        else                      raise ArgumentError, "can't find const for unregistered document type #{path}"
+        else                      raise ArgumentError, _("can't find const for unregistered document type %{path}") % { path: path}
         end
       end
     end
@@ -308,7 +308,7 @@ module PSON
       result
     end
   rescue PSON::NestingError
-    raise ArgumentError, "exceed depth limit", $!.backtrace
+    raise ArgumentError, _("exceed depth limit"), $!.backtrace
   end
 
 

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

@@ -341,7 +341,7 @@ module PSON
             '"' << PSON.utf8_to_pson(self) << '"'
           end
 
-          # Module that holds the extinding methods if, the String module is
+          # Module that holds the extending methods if, the String module is
           # included.
           module Extend
             # Raw Strings are PSON Objects (the raw bytes are stored in an array for the

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

@@ -44,7 +44,7 @@ module PSON
         /(?=\*/)      # single slash before this comment's end
         )*
         \*/               # the End of this comment
-        |[ \t\r\n]+       # whitespaces: space, horicontal tab, lf, cr
+        |[ \t\r\n]+       # whitespaces: space, horizontal tab, lf, cr
       )+
       )mx
 

data/lib/puppet/face/catalog.rb

@@ -4,7 +4,7 @@ Puppet::Indirector::Face.define(:catalog, '0.0.1') do
   copyright "Puppet Inc.", 2011
   license   "Apache 2 license; see COPYING"
 
-  summary "Compile, save, view, and convert catalogs."
+  summary _("Compile, save, view, and convert catalogs.")
   description <<-'EOT'
     This subcommand deals with catalogs, which are compiled per-node artifacts
     generated from a set of Puppet manifests. By default, it interacts with the
@@ -71,7 +71,7 @@ Puppet::Indirector::Face.define(:catalog, '0.0.1') do
       Puppet::Util::Log.newdestination(report)
 
       begin
-        benchmark(:notice, "Finished catalog run") do
+        benchmark(:notice, "Finished catalog run in %{seconds} seconds") do
           catalog.apply(:report => report)
         end
       rescue => detail

data/lib/puppet/face/config.rb

@@ -2,6 +2,7 @@ require 'puppet/face'
 require 'puppet/settings/ini_file'
 
 Puppet::Face.define(:config, '0.0.1') do
+  extend Puppet::Util::Colors
   copyright "Puppet Inc.", 2011
   license   _("Apache 2 license; see COPYING")
 
@@ -9,10 +10,12 @@ Puppet::Face.define(:config, '0.0.1') do
 
   description "This subcommand can inspect and modify settings from Puppet's
     'puppet.conf' configuration file. For documentation about individual settings,
-    see https://docs.puppetlabs.com/puppet/latest/reference/configuration.html."
+    see https://puppet.com/docs/puppet/latest/configuration.html."
 
+  DEFAULT_SECTION_MARKER = Object.new
+  DEFAULT_SECTION = "main"
   option "--section " + _("SECTION_NAME") do
-    default_to { "main" }
+    default_to { DEFAULT_SECTION_MARKER } #Sentinel object for default detection during commands
     summary _("The section of the configuration file to interact with.")
     description <<-EOT
       The section of the puppet.conf configuration file to interact with.
@@ -36,7 +39,7 @@ Puppet::Face.define(:config, '0.0.1') do
     description <<-'EOT'
       Prints the value of a single setting or a list of settings.
 
-      This action is an alternate interface to the information available with
+      This action is a replacement interface to the information available with
       `puppet <subcommand> --configprint`.
     EOT
     notes <<-'EOT'
@@ -57,7 +60,15 @@ Puppet::Face.define(:config, '0.0.1') do
     when_invoked do |*args|
       options = args.pop
 
-      args = Puppet.settings.to_a.collect(&:first) if args.empty? || args == ['all']
+      @default_section = false
+      if options[:section] == DEFAULT_SECTION_MARKER
+        options[:section] = DEFAULT_SECTION
+        @default_section = true
+      end
+
+      render_all_settings = args.empty? || args == ['all']
+
+      args = Puppet.settings.to_a.collect(&:first) if render_all_settings
 
       values_from_the_selected_section =
         Puppet.settings.values(nil, options[:section].to_sym)
@@ -67,23 +78,79 @@ Puppet::Face.define(:config, '0.0.1') do
         :basemodulepath => values_from_the_selected_section.interpolate(:basemodulepath),
       }
 
+      to_be_rendered = nil
       Puppet.override(Puppet.base_context(loader_settings),
                      _("New environment loaders generated from the requested section.")) do
         # And now we can lookup values that include those from environments configured from
         # the requested section
         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
+
+        if Puppet::Util::Log.sendlevel?(:info)
+          warn_default_section(options[:section]) if @default_section
+          report_section_and_environment(options[:section], Puppet.settings[:environment])
+        end
+
+        to_be_rendered = {}
+        args.sort.each do |setting_name|
+          to_be_rendered[setting_name] = values.print(setting_name.to_sym)
         end
       end
-      nil
+
+      # convert symbols to strings before formatting output
+      if render_all_settings
+        to_be_rendered = stringifyhash(to_be_rendered)
+      end
+      to_be_rendered
+    end
+
+    when_rendering :console do |to_be_rendered|
+      output = ''
+      if to_be_rendered.keys.length > 1
+        to_be_rendered.keys.sort.each do |setting|
+          output << "#{setting} = #{to_be_rendered[setting]}\n"
+        end
+      else
+        output << "#{to_be_rendered.to_a[0].last}\n"
+      end
+
+      output
     end
   end
 
+  def stringifyhash(hash)
+    newhash = {}
+    hash.each do |key, val|
+      key = key.to_s
+      if val.is_a? Hash
+        newhash[key] = stringifyhash(val)
+      elsif val.is_a? Symbol
+        newhash[key] = val.to_s
+      else
+        newhash[key] = val
+      end
+    end
+    newhash
+  end
+
+  def warn_default_section(section_name)
+    messages = []
+    messages << _("No section specified; defaulting to '%{section_name}'.") %
+      { section_name: section_name }
+    #TRANSLATORS '--section' is a command line option and should not be translated
+    messages << _("Set the config section by using the `--section` flag.")
+    #TRANSLATORS `puppet config --section user print foo` is a command line example and should not be translated
+    messages << _("For example, `puppet config --section user print foo`.")
+    messages << _("For more information, see https://puppet.com/docs/puppet/latest/configuration.html")
+
+    Puppet.warning(messages.join("\n"))
+  end
+
+  def report_section_and_environment(section_name, environment_name)
+      $stderr.puts colorize(:hyellow,
+        _("Resolving settings from section '%{section_name}' in environment '%{environment_name}'") %
+          { section_name: section_name, environment_name: environment_name })
+  end
+
   action(:set) do
     summary _("Set Puppet's settings.")
     arguments _("[setting_name] [setting_value]")
@@ -106,6 +173,30 @@ Puppet::Face.define(:config, '0.0.1') do
     EOT
 
     when_invoked do |name, value, options|
+
+      @default_section = false
+      if options[:section] == DEFAULT_SECTION_MARKER
+        options[:section] = DEFAULT_SECTION
+        @default_section = true
+      end
+
+      if name == 'environment' && options[:section] == 'main'
+        Puppet.warning _(<<-EOM).chomp
+The environment should be set in either the `[user]`, `[agent]`, or `[master]`
+section. Variables set in the `[agent]` section are used when running
+`puppet agent`. Variables set in the `[user]` section are used when running
+various other puppet subcommands, like `puppet apply` and `puppet module`; these
+require the defined environment directory to exist locally. Set the config
+section by using the `--section` flag. For example,
+`puppet config --section user set environment foo`. For more information, see
+https://puppet.com/docs/puppet/latest/configuration.html#environment
+        EOM
+      end
+
+      if Puppet::Util::Log.sendlevel?(:info)
+        report_section_and_environment(options[:section], Puppet.settings[:environment])
+      end
+
       path = Puppet::FileSystem.pathname(Puppet.settings.which_configuration_file)
       Puppet::FileSystem.touch(path)
       Puppet::FileSystem.open(path, nil, 'r+:UTF-8') do |file|
@@ -116,4 +207,59 @@ Puppet::Face.define(:config, '0.0.1') do
       nil
     end
   end
+
+  action(:delete) do
+    summary _("Delete a Puppet setting.")
+    arguments _("(<setting>")
+    #TRANSLATORS 'main' is a specific section name and should not be translated
+    description "Deletes a setting from the specified section. (The default is the section 'main')."
+    notes <<-'EOT'
+      By default, this action deletes the configuration setting from the 'main'
+      configuration domain. Use the '--section' flags to delete settings from other
+      configuration domains.
+    EOT
+    examples <<-'EOT'
+      Delete the setting 'setting_name' from the 'main' configuration domain:
+
+      $ puppet config delete setting_name
+
+      Delete the setting 'setting_name' from the 'master' configuration domain:
+
+      $ puppet config delete setting_name --section master
+    EOT
+
+    when_invoked do |name, options|
+
+      @default_section = false
+      if options[:section] == DEFAULT_SECTION_MARKER
+        options[:section] = DEFAULT_SECTION
+        @default_section = true
+      end
+
+      path = Puppet::FileSystem.pathname(Puppet.settings.which_configuration_file)
+      if Puppet::FileSystem.exist?(path)
+        Puppet::FileSystem.open(path, nil, 'r+:UTF-8') do |file|
+          Puppet::Settings::IniFile.update(file) do |config|
+            setting_string = config.delete(options[:section], name)
+            if setting_string
+
+              if Puppet::Util::Log.sendlevel?(:info)
+                report_section_and_environment(options[:section], Puppet.settings[:environment])
+              end
+
+              puts(_("Deleted setting from '%{section_name}': '%{setting_string}'") %
+                       { section_name: options[:section], name: name, setting_string: setting_string.strip })
+            else
+              Puppet.warning(_("No setting found in configuration file for section '%{section_name}' setting name '%{name}'") %
+                                 { section_name: options[:section], name: name })
+            end
+          end
+        end
+      else
+        #TRANSLATORS the 'puppet.conf' is a specific file and should not be translated
+        Puppet.warning(_("The puppet.conf file does not exist %{puppet_conf}") % { puppet_conf: path })
+      end
+      nil
+    end
+  end
 end