puppet 4.10.0 → 5.0.0

data/CONTRIBUTING.md

@@ -66,6 +66,23 @@ for advice.
 * Make sure you have added the necessary tests for your changes.
 * Run _all_ the tests to assure nothing else was accidentally broken.
 
+## Writing Translatable Code
+
+We use [gettext tooling](https://github.com/puppetlabs/gettext-setup-gem) to
+extract user-facing strings and pull in translations based on the user's locale
+at runtime. In order for this tooling to work, all user-facing strings must be
+wrapped in the `_()` translation function, so they can be extracted into files
+for the translators.
+
+When adding user-facing strings to your work, follow these guidelines:
+* Use full sentences. Strings built up out of concatenated bits are hard to translate.
+* Use string formatting instead of interpolation.
+    Ex. `_('Creating new user %{name}.') % { name: user.name }`
+* Use `n_()` for pluralization. (see gettext gem docs linked above for details)
+
+It is the responsibility of contributors and code reviewers to ensure that all
+user-facing strings are marked in new PRs before merging.
+
 ## Making Trivial Changes
 
 ### Documentation

data/Gemfile

@@ -13,7 +13,6 @@ end
 # C Ruby (MRI) or Rubinius, but NOT Windows
 platforms :ruby do
   gem 'pry', :group => :development
-  gem 'yard', :group => :development
   gem 'redcarpet', '~> 2.0', :group => :development
   gem "racc", "1.4.9", :group => :development
 
@@ -25,18 +24,15 @@ end
 
 gem "puppet", :path => File.dirname(__FILE__), :require => false
 gem "facter", *location_for(ENV['FACTER_LOCATION'] || ['> 2.0', '< 4'])
-gem "hiera", *location_for(ENV['HIERA_LOCATION'] || ['>= 2.0', '< 4'])
+gem "hiera", *location_for(ENV['HIERA_LOCATION'] || ['>= 3.2.1', '< 4'])
 # PUP-7115 - return to a gem dependency in Puppet 5
 # gem "semantic_puppet", *location_for(ENV['SEMANTIC_PUPPET_LOCATION'] || ['>= 0.1.3', '< 2'])
-gem "rake", "10.1.1", :require => false
-# Hiera has an unbound dependency on json_pure
-# json_pure 2.0.2+ officially requires Ruby >= 2.0, but should have specified that in 2.0
-gem 'json_pure', '~> 1.8', :require => false
 # i18n support (gettext-setup and dependencies)
 gem 'gettext-setup', '>= 0.10', '< 1.0', :require => false
 gem 'locale', '~> 2.1', :require => false
 
 group(:development, :test) do
+  gem "rake", "10.1.1", :require => false
   gem "rspec", "~> 3.1", :require => false
   gem "rspec-its", "~> 1.1", :require => false
   gem "rspec-collection_matchers", "~> 1.1", :require => false
@@ -55,29 +51,29 @@ group(:development, :test) do
   gem "json-schema", "2.1.1", :require => false, :platforms => [:ruby, :jruby]
 
   gem "rubocop", "~> 0.39.0", :platforms => [:ruby]
+  # pin rainbow gem as 2.2.1 requires rubygems 2.6.9+ and (donotwant)
+  gem "rainbow", "< 2.2.1", :platforms => [:ruby]
 
   gem 'rdoc', "~> 4.1", :platforms => [:ruby]
+  gem 'yard'
 
   # webmock requires addressable as as of 2.5.0 addressable started
   # requiring the public_suffix gem which requires Ruby 2
   gem 'addressable', '< 2.5.0'
   gem 'webmock', '~> 1.24'
   gem 'vcr', '~> 2.9'
-  gem "hocon", :require => false
   gem "hiera-eyaml", :require => false
 end
 
 group(:development) do
   if RUBY_PLATFORM != 'java'
-    gem 'ruby-prof', :require => false
+    gem 'ruby-prof', '>= 0.16.0', :require => false
   end
 end
 
 group(:extra) do
   gem "rack", "~> 1.4", :require => false
-  gem "net-ssh", '~> 2.1', :require => false
   gem "puppetlabs_spec_helper", :require => false
-  gem "tzinfo", :require => false
   gem "msgpack", :require => false
 end
 

data/MAINTAINERS

@@ -29,11 +29,6 @@
       "email": "branan@puppet.com",
       "name": "Branan Riley"
     },
-    {
-      "github": "whopper",
-      "email": "whopper@puppet.com",
-      "name": "Will Hopper"
-    },
     {
       "github": "Iristyle",
       "name": "Ethan J. Brown"

data/Rakefile

@@ -92,8 +92,9 @@ task(:commits) do
       raise "\n\n\n\tThis commit summary didn't match CONTRIBUTING.md guidelines:\n" \
         "\n\t\t#{commit_summary}\n" \
         "\tThe commit summary (i.e. the first line of the commit message) should start with one of:\n"  \
-        "\t\t(pup-<digits>) # this is most common and should be a ticket at tickets.puppetlabs.com\n" \
+        "\t\t(PUP-<digits>) # this is most common and should be a ticket at tickets.puppet.com\n" \
         "\t\t(docs)\n" \
+        "\t\t(docs)(DOCUMENT-<digits>)\n" \
         "\t\t(maint)\n" \
         "\t\t(packaging)\n" \
         "\n\tThis test for the commit summary is case-insensitive.\n\n\n"

data/conf/auth.conf

@@ -57,6 +57,27 @@
 # (ie exactly as if auth yes was present).
 #
 
+# CONTROLLING FILE ACCESS (previously in fileserver.conf)
+
+# In previous versions of Puppet, you controlled file access by adding
+# rules to fileserver.conf. In Puppet 5 with Puppet Server, you can control
+# file access in auth.conf by controlling the /file_metadata(s)/<mount point>,
+# /file_content(s)/<mount point>, and /static_file_content/<file> paths. See the
+# Puppet Server documentation at
+# https://docs.puppet.com/puppetserver/latest/config_file_auth.html.
+#
+# If you are not using Puppet Server, or are using Puppet Server but with the
+# "jruby-puppet.use-legacy-auth-conf" setting set to "true", you could set the
+# desired file access in a new rule in this file. For example:
+#
+# path ~ ^/file_(metadata|content)s?/extra_files/
+# auth yes
+# allow /^(.+)\.example\.com$/
+# allow_ip 192.168.100.0/24
+#
+# If added to auth.conf BEFORE the default "path /file" rule, this rule
+# will add stricter restrictions to the extra_files mount point.
+
 ### Authenticated ACLs - these rules apply only when the client
 ### has a valid certificate and is thus authenticated
 

data/conf/fileserver.conf

@@ -27,16 +27,11 @@
 
 # PERMISSIONS
 
-# Every static mount point should have an `allow *` line; setting more
-# granular permissions in this file is deprecated. Instead, you can
-# control file access in auth.conf by controlling the
-# /file_metadata(s)/<mount point> and /file_content(s)/<mount point> paths.
-# For example:
+# The ability to set permissions - for example, using the allow, allow_ip, or
+# deny directives - has been removed. Instead, you can control file access in
+# auth.conf by controlling the /file_metadata(s)/<mount point> and
+# /file_content(s)/<mount point> paths.
 #
-# path ~ ^/file_(metadata|content)s?/extra_files/
-# auth yes
-# allow /^(.+)\.example\.com$/
-# allow_ip 192.168.100.0/24
-#
-# If added to auth.conf BEFORE the default "path /file" rule, this rule
-# will add stricter restrictions to the extra_files mount point.
+# For details and an example, see the auth.conf file. If you're using Puppet
+# Server, see the Puppet Server documentation at
+# https://docs.puppet.com/puppetserver/latest/config_file_auth.html.

data/conf/hiera.yaml

@@ -0,0 +1,11 @@
+---
+# Hiera 5 Global configuration file
+
+version: 5
+
+# defaults:
+#   data_hash: yaml_data
+# hierarchy:
+#  - name: Common
+#    data_hash: yaml_data
+hierarchy: []

data/ext/debian/puppet-common.install

@@ -1,4 +1,3 @@
 debian/puppet.conf etc/puppet
 debian/tmp/usr/bin/puppet usr/bin
-debian/tmp/usr/bin/extlookup2hiera usr/bin
 debian/tmp/usr/lib/ruby/vendor_ruby/* usr/lib/ruby/vendor_ruby

data/ext/debian/puppet-common.manpages

@@ -1,5 +1,4 @@
 man/man5/puppet.conf.5
-man/man8/extlookup2hiera.8
 man/man8/puppet.8
 man/man8/puppet-agent.8
 man/man8/puppet-apply.8
@@ -26,5 +25,4 @@ man/man8/puppet-parser.8
 man/man8/puppet-plugin.8
 man/man8/puppet-report.8
 man/man8/puppet-resource.8
-man/man8/puppet-resource_type.8
 man/man8/puppet-status.8

data/ext/hiera/hiera.yaml

@@ -0,0 +1,15 @@
+---
+version: 5
+defaults:
+  # The default value for "datadir" is "data" under the same directory as the hiera.yaml
+  # file (this file)
+  # When specifying a datadir, make sure the directory exists.
+  # See https://docs.puppet.com/puppet/latest/environments.html for further details on environments.
+  # datadir: data
+  # data_hash: yaml_data
+hierarchy:
+  - name: "Per-node data (yaml version)"
+    path: "nodes/%{::trusted.certname}.yaml"
+  - name: "Other YAML hierarchy levels"
+    paths:
+      - "common.yaml"

data/ext/logcheck/puppet

@@ -1,6 +1,6 @@
 ^\w{3} [ :0-9]{11} [._[:alnum:]-]+ puppet-master\[[0-9]+\]: (Handled resources in|Resource comparison took|Searched for (host|resources|resource params and tags) in) [0-9.]+ seconds
 ^\w{3} [ :0-9]{11} [._[:alnum:]-]+ puppet-master\[[0-9]+\]: Starting Puppet server version [.0-9]+$
-^\w{3} [ :0-9]{11} [._[:alnum:]-]+ puppet-master\[[0-9]+\]: Compiled catalog for [._[:alnum:]-]+ in [.0-9]+ seconds$
+^\w{3} [ :0-9]{11} [._[:alnum:]-]+ puppet-master\[[0-9]+\]: Compiled catalog for [._[:alnum:]-]+ in environment [_[:alnum:]]+ in [.[:digit:]]+ seconds$
 ^\w{3} [ :0-9]{11} [._[:alnum:]-]+ puppet-master\[[0-9]+\]: Caught TERM; shutting down$
 ^\w{3} [ :0-9]{11} [._[:alnum:]-]+ puppet-master\[[0-9]+\]: Shutting down$
 ^\w{3} [ :0-9]{11} [._[:alnum:]-]+ puppet-agent\[[0-9]+\]: Starting Puppet client version [.0-9]+$

data/ext/project_data.yaml

@@ -7,7 +7,7 @@ summary: 'Puppet, an automated configuration management tool'
 description: 'Puppet, an automated configuration management tool'
 version_file: 'lib/puppet/version.rb'
 # files and gem_files are space separated lists
-files: '[A-Z]* install.rb bin lib conf man examples ext tasks spec'
+files: '[A-Z]* install.rb bin lib conf man examples ext tasks spec locales'
 # The gem specification bits only work on Puppet >= 3.0rc, NOT 2.7.x and earlier
 gem_files: '[A-Z]* install.rb bin lib conf man examples ext tasks spec locales'
 gem_test_files: 'spec/**/*'
@@ -18,8 +18,7 @@ gem_required_ruby_version: '>= 1.9.3'
 gem_required_rubygems_version: '> 1.3.1'
 gem_runtime_dependencies:
   facter: ['> 2.0', '< 4']
-  hiera: ['>= 2.0', '< 4']
-  json_pure: '~> 1.8'
+  hiera: ['>= 3.2.1', '< 4']
   # PUP-7115 - return to a gem dependency in Puppet 5
   # semantic_puppet: ['>= 0.1.3', '< 2']
   gettext-setup: ['>= 0.10', '< 1']
@@ -33,14 +32,13 @@ gem_rdoc_options:
 gem_platform_dependencies:
   universal-darwin:
     gem_runtime_dependencies:
-      CFPropertyList: '~> 2.2.6'
+      CFPropertyList: '~> 2.2'
   x86-mingw32:
     gem_runtime_dependencies:
       # Pinning versions that require native extensions
       ffi: '~> 1.9.6'
       # win32-xxxx gems are pinned due to PUP-6445
       win32-dir: '= 0.4.9'
-      win32-eventlog: '= 0.6.5'
       win32-process: '= 0.7.5'
       # Use of win32-security is deprecated
       win32-security: '= 0.2.5'
@@ -51,7 +49,6 @@ gem_platform_dependencies:
       ffi: '~> 1.9.6'
       # win32-xxxx gems are pinned due to PUP-6445
       win32-dir: '= 0.4.9'
-      win32-eventlog: '= 0.6.5'
       win32-process: '= 0.7.5'
       # Use of win32-security is deprecated
       win32-security: '= 0.2.5'

data/ext/puppet-test

@@ -235,30 +235,6 @@ Suite.new :local_catalog, "Local catalog handling" do
     end
 end
 
-Suite.new :resource_type, "Managing resource types" do
-    newtest :find, "Find a type" do
-        Puppet::Resource::Type.terminus_class = :parser
-        ARGV.each do |name|
-            json = Puppet::Resource::Type.find(name).to_pson
-            data = PSON.parse(json)
-            p Puppet::Resource::Type.from_data_hash(data)
-        end
-    end
-
-    newtest :search_types, "Find all types" do
-        Puppet::Resource::Type.terminus_class = :rest
-        result = Puppet::Resource::Type.search("*")
-        result.each { |r| p r }
-    end
-
-    newtest :restful_type, "Find a type and return it via REST" do
-        Puppet::Resource::Type.terminus_class = :rest
-        ARGV.each do |name|
-            p Puppet::Resource::Type.find(name)
-        end
-    end
-end
-
 Suite.new :remote_catalog, "Remote catalog handling" do
     def prepare
         $args[:cache] = false

data/ext/rack/config.ru

@@ -20,10 +20,10 @@ ARGV << "--logdir"  << "/var/log/puppetlabs/puppetmaster"
 ARGV << "--rundir"  << "/var/run/puppetlabs/puppetmaster"
 ARGV << "--codedir"  << "/etc/puppetlabs/code"
 
-# always_cache_features is a performance improvement and safe for a master to
+# disable always_retry_plugsin as a performance improvement. This is safe for a master to
 # apply. This is intended to allow agents to recognize new features that may be
 # delivered during catalog compilation.
-ARGV << "--always_cache_features"
+ARGV << "--no-always_retry_plugins"
 
 # NOTE: it's unfortunate that we have to use the "CommandLine" class
 #  here to launch the app, but it contains some initialization logic

data/ext/redhat/puppet.spec.erb

@@ -189,7 +189,6 @@ touch %{buildroot}%{_localstatedir}/log/puppet/masterhttp.log
 %defattr(-, root, root, 0755)
 %doc LICENSE README.md examples
 %{_bindir}/puppet
-%{_bindir}/extlookup2hiera
 %{puppet_libdir}/*
 %if 0%{?_with_systemd}
 %{_unitdir}/puppet.service
@@ -239,9 +238,7 @@ touch %{buildroot}%{_localstatedir}/log/puppet/masterhttp.log
 %{_mandir}/man8/puppet-plugin.8.gz
 %{_mandir}/man8/puppet-report.8.gz
 %{_mandir}/man8/puppet-resource.8.gz
-%{_mandir}/man8/puppet-resource_type.8.gz
 %{_mandir}/man8/puppet-status.8.gz
-%{_mandir}/man8/extlookup2hiera.8.gz
 # These need to be owned by puppet so the server can
 # write to them. The separate %defattr's are required
 # to work around RH Bugzilla 681540

data/ext/windows/service/daemon.rb

@@ -4,13 +4,14 @@ require 'fileutils'
 require 'win32/daemon'
 require 'win32/dir'
 require 'win32/process'
-require 'win32/eventlog'
+
+# This file defines utilities for logging to eventlog. While it lives inside
+# Puppet, it is completely independent and loads no other parts of Puppet, so we
+# can safely require *just* it.
+require 'puppet/util/windows/eventlog'
 
 class WindowsDaemon < Win32::Daemon
   CREATE_NEW_CONSOLE          = 0x00000010
-  EVENTLOG_ERROR_TYPE         = 0x0001
-  EVENTLOG_WARNING_TYPE       = 0x0002
-  EVENTLOG_INFORMATION_TYPE   = 0x0004
 
   @run_thread = nil
   @LOG_TO_FILE = false
@@ -127,23 +128,16 @@ class WindowsDaemon < Win32::Daemon
         File.open(LOG_FILE, 'a:UTF-8') { |f| f.puts("#{Time.now} Puppet (#{level}): #{msg}") }
       end
 
-      case level
-        when :debug, :info, :notice
-          report_windows_event(EVENTLOG_INFORMATION_TYPE,0x01,msg.to_s)
-        when :err, :alert, :emerg, :crit
-          report_windows_event(EVENTLOG_ERROR_TYPE,0x03,msg.to_s)
-        else
-          report_windows_event(EVENTLOG_WARNING_TYPE,0x02,msg.to_s)
-      end
+      native_type, native_id = Puppet::Util::Windows::EventLog.to_native(level)
+      report_windows_event(native_type, native_id, msg.to_s)
     end
   end
 
   def report_windows_event(type,id,message)
     begin
       eventlog = nil
-      eventlog = Win32::EventLog.open("Application")
+      eventlog = Puppet::Util::Windows::EventLog.open("Puppet")
       eventlog.report_event(
-        :source      => "Puppet",
         :event_type  => type,   # EVENTLOG_ERROR_TYPE, etc
         :event_id    => id,     # 0x01 or 0x02, 0x03 etc.
         :data        => message # "the message"

data/install.rb

@@ -493,7 +493,7 @@ end
 # Change directory into the puppet root so we don't get the wrong files for install.
 FileUtils.cd File.dirname(__FILE__) do
   # Set these values to what you want installed.
-  configs = glob(%w{conf/auth.conf conf/puppet.conf})
+  configs = glob(%w{conf/auth.conf conf/puppet.conf conf/hiera.yaml})
   bins  = glob(%w{bin/*})
   rdoc  = glob(%w{bin/* lib/**/*.rb README* }).reject { |e| e=~ /\.(bat|cmd)$/ }
   ri    = glob(%w{bin/*.rb lib/**/*.rb}).reject { |e| e=~ /\.(bat|cmd)$/ }

data/lib/hiera/puppet_function.rb

@@ -60,7 +60,7 @@ class Hiera::PuppetFunction < Puppet::Functions::InternalFunction
 
   def lookup(scope, key, default, has_default, override, &default_block)
     unless Puppet[:strict] == :off
-      Puppet.warn_once(:deprecation, self.class.name,
+      Puppet.warn_once('deprecations', self.class.name,
         "The function '#{self.class.name}' is deprecated in favor of using 'lookup'. See https://docs.puppet.com/puppet/#{Puppet.minor_version}/reference/deprecated_language.html")
     end
     lookup_invocation = Puppet::Pops::Lookup::Invocation.new(scope, {}, {})

data/lib/puppet/agent/disabler.rb

@@ -10,20 +10,20 @@ require 'puppet/util/json_lockfile'
 #  because it used by external tools such as mcollective.
 #
 # For more information, please see docs on the website.
-#  http://links.puppetlabs.com/agent_lockfiles
+#  http://links.puppet.com/agent_lockfiles
 module Puppet::Agent::Disabler
   DISABLED_MESSAGE_JSON_KEY = "disabled_message"
 
   # Let the daemon run again, freely in the filesystem.
   def enable
-    Puppet.notice "Enabling Puppet."
+    Puppet.notice _("Enabling Puppet.")
     disable_lockfile.unlock
   end
 
   # Stop the daemon from making any catalog runs.
   def disable(msg=nil)
     data = {}
-    Puppet.notice "Disabling Puppet."
+    Puppet.notice _("Disabling Puppet.")
     if (! msg.nil?)
       data[DISABLED_MESSAGE_JSON_KEY] = msg
     end

data/lib/puppet/agent/locker.rb

@@ -11,7 +11,7 @@ require 'puppet/error'
 # Puppet API because it used by external tools such as mcollective.
 #
 # For more information, please see docs on the website.
-#  http://links.puppetlabs.com/agent_lockfiles
+#  http://links.puppet.com/agent_lockfiles
 module Puppet::Agent::Locker
   # Yield if we get a lock, else raise Puppet::LockError. Return
   # value of block yielded.
@@ -23,13 +23,13 @@ module Puppet::Agent::Locker
         lockfile.unlock
       end
     else
-      fail Puppet::LockError, 'Failed to acquire lock'
+      fail Puppet::LockError, _('Failed to acquire lock')
     end
   end
 
   # @deprecated
   def running?
-    Puppet.deprecation_warning <<-ENDHEREDOC
+    Puppet.deprecation_warning _(<<-ENDHEREDOC)
 Puppet::Agent::Locker.running? is deprecated as it is inherently unsafe.
 The only safe way to know if the lock is locked is to try lock and perform some
 action and then handle the LockError that may result.

data/lib/puppet/agent.rb

@@ -1,5 +1,6 @@
 require 'puppet/application'
 require 'puppet/error'
+require 'puppet/util/at_fork'
 
 # A general class for triggering a run of another
 # class.
@@ -31,7 +32,7 @@ class Puppet::Agent
   # Perform a run with our client.
   def run(client_options = {})
     if disabled?
-      Puppet.notice "Skipping run of #{client_class}; administratively disabled (Reason: '#{disable_message}');\nUse 'puppet agent --enable' to re-enable."
+      Puppet.notice _("Skipping run of %{client_class}; administratively disabled (Reason: '%{disable_message}');\nUse 'puppet agent --enable' to re-enable.") % { client_class: client_class, disable_message: disable_message }
       return
     end
 
@@ -39,21 +40,21 @@ class Puppet::Agent
     block_run = Puppet::Application.controlled_run do
       splay client_options.fetch :splay, Puppet[:splay]
       result = run_in_fork(should_fork) do
-        with_client(client_options[:transaction_uuid]) do |client|
+        with_client(client_options[:transaction_uuid], client_options[:job_id]) do |client|
           begin
             client_args = client_options.merge(:pluginsync => Puppet::Configurer.should_pluginsync?)
             lock { client.run(client_args) }
           rescue Puppet::LockError
-            Puppet.notice "Run of #{client_class} already in progress; skipping  (#{lockfile_path} exists)"
+            Puppet.notice _("Run of %{client_class} already in progress; skipping  (%{lockfile_path} exists)") % { client_class: client_class, lockfile_path: lockfile_path }
             return
           rescue StandardError => detail
-            Puppet.log_exception(detail, "Could not run #{client_class}: #{detail}")
+            Puppet.log_exception(detail, _("Could not run %{client_class}: %{detail}") % { client_class: client_class, detail: detail })
           end
         end
       end
       true
     end
-    Puppet.notice "Shutdown/restart in progress (#{Puppet::Application.run_status.inspect}); skipping run" unless block_run
+    Puppet.notice _("Shutdown/restart in progress (%{status}); skipping run") % { status: Puppet::Application.run_status.inspect } unless block_run
     result
   end
 
@@ -64,16 +65,26 @@ class Puppet::Agent
   def run_in_fork(forking = true)
     return yield unless forking or Puppet.features.windows?
 
-    child_pid = Kernel.fork do
-      $0 = "puppet agent: applying configuration"
-      begin
-        exit(yield)
-      rescue SystemExit
-        exit(-1)
-      rescue NoMemoryError
-        exit(-2)
+    atForkHandler = Puppet::Util::AtFork.get_handler
+
+    atForkHandler.prepare
+
+    begin
+      child_pid = Kernel.fork do
+        atForkHandler.child
+        $0 = _("puppet agent: applying configuration")
+        begin
+          exit(yield)
+        rescue SystemExit
+          exit(-1)
+        rescue NoMemoryError
+          exit(-2)
+        end
       end
+    ensure
+      atForkHandler.parent
     end
+
     exit_code = Process.waitpid2(child_pid)
     case exit_code[1].exitstatus
     when -1
@@ -88,11 +99,11 @@ class Puppet::Agent
 
   # Create and yield a client instance, keeping a reference
   # to it during the yield.
-  def with_client(transaction_uuid)
+  def with_client(transaction_uuid, job_id = nil)
     begin
-      @client = client_class.new(Puppet::Configurer::DownloaderFactory.new, transaction_uuid)
+      @client = client_class.new(Puppet::Configurer::DownloaderFactory.new, transaction_uuid, job_id)
     rescue StandardError => detail
-      Puppet.log_exception(detail, "Could not create instance of #{client_class}: #{detail}")
+      Puppet.log_exception(detail, _("Could not create instance of %{client_class}: %{detail}") % { client_class: client_class, detail: detail })
       return
     end
     yield @client

data/lib/puppet/application/agent.rb

@@ -21,7 +21,7 @@ class Puppet::Application::Agent < Puppet::Application
   def preinit
     # Do an initial trap, so that cancels don't get a stack trace.
     Signal.trap(:INT) do
-      $stderr.puts "Cancelling startup"
+      $stderr.puts _("Cancelling startup")
       exit(0)
     end
 
@@ -71,6 +71,10 @@ class Puppet::Application::Agent < Puppet::Application
     options[:waitforcert] = arg.to_i
   end
 
+  option("--job-id ID") do |arg|
+    options[:job_id] = arg
+  end
+
   def help
     <<-'HELP'
 
@@ -232,6 +236,10 @@ generated by running puppet agent with '--genconfig'.
 * --help:
   Print this help message
 
+* --job-id:
+  Attach the specified job id to the catalog request and the report used for
+  this agent run. This option only works when '--onetime' is used.
+
 * --logdest:
   Where to send log messages. Choose between 'syslog' (the POSIX syslog
   service), 'eventlog' (the Windows Event Log), 'console', or the path to a log
@@ -264,7 +272,7 @@ generated by running puppet agent with '--genconfig'.
 * --test:
   Enable the most common options used for testing. These are 'onetime',
   'verbose', 'no-daemonize', 'no-usecacheonfailure', 'detailed-exitcodes',
-  'no-splay', 'show_diff', and 'no-use_cached_catalog'.
+  'no-splay', and 'show_diff'.
 
 * --verbose:
   Turn on verbose reporting.
@@ -309,7 +317,7 @@ Luke Kanies
 
 COPYRIGHT
 ---------
-Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
+Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
 
     HELP
   end
@@ -338,19 +346,19 @@ Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
   def fingerprint
     host = Puppet::SSL::Host.new
     unless cert = host.certificate || host.certificate_request
-      $stderr.puts "Fingerprint asked but no certificate nor certificate request have yet been issued"
+      $stderr.puts _("Fingerprint asked but no certificate nor certificate request have yet been issued")
       exit(1)
       return
     end
     unless digest = cert.digest(options[:digest].to_s)
-      raise ArgumentError, "Could not get fingerprint for digest '#{options[:digest]}'"
+      raise ArgumentError, _("Could not get fingerprint for digest '%{digest}'") % { digest: options[:digest] }
     end
     puts digest.to_s
   end
 
   def onetime(daemon)
     begin
-      exitstatus = daemon.agent.run
+      exitstatus = daemon.agent.run(:job_id => options[:job_id])
     rescue => detail
       Puppet.log_exception(detail)
     end
@@ -367,7 +375,7 @@ Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
   end
 
   def main(daemon)
-    Puppet.notice "Starting Puppet client version #{Puppet.version}"
+    Puppet.notice _("Starting Puppet client version %{version}") % { version: Puppet.version }
     daemon.start
   end
 
@@ -377,14 +385,13 @@ Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
     Puppet.settings.handlearg("--no-splay")
     Puppet.settings.handlearg("--show_diff")
     Puppet.settings.handlearg("--no-daemonize")
-    Puppet.settings.handlearg("--no-use_cached_catalog")
     options[:verbose] = true
     Puppet[:onetime] = true
     options[:detailed_exitcodes] = true
   end
 
   def setup
-    raise ArgumentError, "The puppet agent command does not take parameters" unless command_line.args.empty?
+    raise ArgumentError, _("The puppet agent command does not take parameters") unless command_line.args.empty?
 
     setup_test if options[:test]