puppet 4.10.0 → 5.0.0

data/lib/puppet/face/config.rb

@@ -2,18 +2,18 @@ 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"
+  copyright "Puppet Inc.", 2011
+  license   _("Apache 2 license; see COPYING")
 
-  summary "Interact with Puppet's settings."
+  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 https://docs.puppetlabs.com/puppet/latest/reference/configuration.html."
 
-  option "--section SECTION_NAME" do
+  option "--section " + _("SECTION_NAME") do
     default_to { "main" }
-    summary "The section of the configuration file to interact with."
+    summary _("The section of the configuration file to interact with.")
     description <<-EOT
       The section of the puppet.conf configuration file to interact with.
 
@@ -31,8 +31,8 @@ Puppet::Face.define(:config, '0.0.1') do
   end
 
   action(:print) do
-    summary "Examine Puppet's current settings."
-    arguments "(all | <setting> [<setting> ...]"
+    summary _("Examine Puppet's current settings.")
+    arguments _("(all | <setting> [<setting> ...]")
     description <<-'EOT'
       Prints the value of a single setting or a list of settings.
 
@@ -68,7 +68,7 @@ Puppet::Face.define(:config, '0.0.1') do
       }
 
       Puppet.override(Puppet.base_context(loader_settings),
-                     "New environment loaders generated from the requested section.") do
+                     _("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)
@@ -85,8 +85,8 @@ Puppet::Face.define(:config, '0.0.1') do
   end
 
   action(:set) do
-    summary "Set Puppet's settings."
-    arguments "[setting_name] [setting_value]"
+    summary _("Set Puppet's settings.")
+    arguments _("[setting_name] [setting_value]")
     description <<-'EOT'
       Updates values in the `puppet.conf` configuration file.
     EOT

data/lib/puppet/face/epp.rb

@@ -4,15 +4,15 @@ require 'puppet/parser/files'
 require 'puppet/file_system'
 
 Puppet::Face.define(:epp, '0.0.1') do
-  copyright "Puppet Labs", 2014
-  license   "Apache 2 license; see COPYING"
+  copyright "Puppet Inc.", 2014
+  license   _("Apache 2 license; see COPYING")
 
-  summary "Interact directly with the EPP template parser/renderer."
+  summary _("Interact directly with the EPP template parser/renderer.")
 
   action(:validate) do
-    summary "Validate the syntax of one or more EPP templates."
-    arguments "[<template>] [<template> ...]"
-    returns "Nothing, or encountered syntax errors."
+    summary _("Validate the syntax of one or more EPP templates.")
+    arguments _("[<template>] [<template> ...]")
+    returns _("Nothing, or encountered syntax errors.")
     description <<-'EOT'
       This action validates EPP syntax without producing any output.
 
@@ -31,7 +31,7 @@ Puppet::Face.define(:epp, '0.0.1') do
     EOT
 
     option("--[no-]continue_on_error") do
-      summary "Whether or not to continue after errors are reported for a template."
+      summary _("Whether or not to continue after errors are reported for a template.")
     end
 
     examples <<-'EOT'
@@ -75,7 +75,7 @@ Puppet::Face.define(:epp, '0.0.1') do
         else
           # This is not an error since a validate of all files in an empty
           # directory should not be treated as a failed validation.
-          Puppet.notice "No template specified. No action taken"
+          Puppet.notice _("No template specified. No action taken")
         end
       end
 
@@ -92,19 +92,19 @@ Puppet::Face.define(:epp, '0.0.1') do
         end
       end
       if !missing_files.empty?
-        raise Puppet::Error, "One or more file(s) specified did not exist:\n" + missing_files.map { |f| "   #{f}" }.join("\n")
+        raise Puppet::Error, _("One or more file(s) specified did not exist:\n") + missing_files.map { |f| "   #{f}" }.join("\n")
       else
         # Exit with 1 if there were errors
-        raise Puppet::Error, "Errors while validating epp" unless status
+        raise Puppet::Error, _("Errors while validating epp") unless status
       end
     end
   end
 
 
   action (:dump) do
-    summary "Outputs a dump of the internal template parse tree for debugging"
+    summary _("Outputs a dump of the internal template parse tree for debugging")
     arguments "-e <source> | [<templates> ...] "
-    returns "A dump of the resulting AST model unless there are syntax or validation errors."
+    returns _("A dump of the resulting AST model unless there are syntax or validation errors.")
     description <<-'EOT'
       The dump action parses and validates the EPP syntax and dumps the resulting AST model
       in a human readable (but not necessarily an easy to understand) format.
@@ -127,17 +127,17 @@ Puppet::Face.define(:epp, '0.0.1') do
       This command ignores the --render-as setting/option.
     EOT
 
-    option("--e <source>") do
+    option("--e " + _("<source>")) do
       default_to { nil }
-      summary "Dump one epp source expression given on the command line."
+      summary _("Dump one epp source expression given on the command line.")
     end
 
     option("--[no-]validate") do
-      summary "Whether or not to validate the parsed result, if no-validate only syntax errors are reported."
+      summary _("Whether or not to validate the parsed result, if no-validate only syntax errors are reported.")
     end
 
     option("--[no-]header") do
-      summary "Whether or not to show a file name header between files."
+      summary _("Whether or not to show a file name header between files.")
     end
 
     when_invoked do |*args|
@@ -161,7 +161,7 @@ Puppet::Face.define(:epp, '0.0.1') do
         if ! STDIN.tty?
           buffer.print dump_parse(STDIN.read, 'stdin', options, false)
         else
-          raise Puppet::Error, "No input to parse given on command line or stdin"
+          raise Puppet::Error, _("No input to parse given on command line or stdin")
         end
       else
         templates, missing_files = args.reduce([[],[]]) do |memo, file|
@@ -180,7 +180,7 @@ Puppet::Face.define(:epp, '0.0.1') do
         end
 
         if !missing_files.empty?
-          raise Puppet::Error, "One or more file(s) specified did not exist:\n" + missing_files.collect { |f| "   #{f}" }.join("\n")
+          raise Puppet::Error, _("One or more file(s) specified did not exist:\n") + missing_files.collect { |f| "   #{f}" }.join("\n")
         end
       end
       buffer.string
@@ -188,9 +188,9 @@ Puppet::Face.define(:epp, '0.0.1') do
   end
 
   action (:render) do
-    summary "Renders an epp template as text"
+    summary _("Renders an epp template as text")
     arguments "-e <source> | [<templates> ...] "
-    returns "A rendered result of one or more given templates."
+    returns _("A rendered result of one or more given templates.")
     description <<-'EOT'
       This action renders one or more EPP templates.
 
@@ -286,29 +286,29 @@ Puppet::Face.define(:epp, '0.0.1') do
           $ puppet epp render -e '<% $facts[osfamily] %>' --facts data.yaml
     EOT
 
-    option("--node <node_name>") do
-      summary "The name of the node for which facts are obtained. Defaults to facts for the local node."
+    option("--node " + _("<node_name>")) do
+      summary _("The name of the node for which facts are obtained. Defaults to facts for the local node.")
     end
 
-    option "--e <source>" do
+    option("--e " + _("<source>")) do
       default_to { nil }
-      summary "Render one inline epp template given on the command line."
+      summary _("Render one inline epp template given on the command line.")
     end
 
-    option("--values <values_hash>") do
-      summary "A Hash in Puppet DSL form given as arguments to the template being rendered."
+    option("--values " + _("<values_hash>")) do
+      summary _("A Hash in Puppet DSL form given as arguments to the template being rendered.")
     end
 
-    option("--values_file <pp_or_yaml_file>") do
-      summary "A .pp or .yaml file that is processed to produce a hash of values for the template."
+    option("--values_file " + _("<pp_or_yaml_file>")) do
+      summary _("A .pp or .yaml file that is processed to produce a hash of values for the template.")
     end
 
-    option("--facts <facts_file>") do
-      summary "A .yaml or .json file containing a hash of facts made available in $facts and $trusted"
+    option("--facts " + _("<facts_file>")) do
+      summary _("A .yaml or .json file containing a hash of facts made available in $facts and $trusted")
     end
 
     option("--[no-]header") do
-      summary "Whether or not to show a file name header between rendered results."
+      summary _("Whether or not to show a file name header between rendered results.")
     end
 
     when_invoked do |*args|
@@ -328,7 +328,7 @@ Puppet::Face.define(:epp, '0.0.1') do
         if ! STDIN.tty?
           buffer.print render_inline(STDIN.read, compiler, options)
         else
-          raise Puppet::Error, "No input to process given on command line or stdin"
+          raise Puppet::Error, _("No input to process given on command line or stdin")
         end
       else
         show_filename = args.count > 1
@@ -342,7 +342,7 @@ Puppet::Face.define(:epp, '0.0.1') do
           end
         end
       end
-      raise Puppet::Error, "error while rendering epp" unless status
+      raise Puppet::Error, _("error while rendering epp") unless status
       buffer.string
     end
   end
@@ -381,13 +381,13 @@ Puppet::Face.define(:epp, '0.0.1') do
           evaluating_parser = Puppet::Pops::Parser::EvaluatingParser.new
           template_values = evaluating_parser.evaluate_file(compiler.topscope, values_file)
         else
-          Puppet.err("Only .yaml or .pp can be used as a --values_file")
+          Puppet.err(_("Only .yaml or .pp can be used as a --values_file"))
         end
       rescue => e
-        Puppet.err("Could not load --values_file #{e.message}")
+        Puppet.err(_("Could not load --values_file %{error}") % { error: e.message })
       end
       if !(template_values.nil? || template_values.is_a?(Hash))
-        Puppet.err("--values_file option must evaluate to a Hash or undef/nil, got: '#{template_values.class}'")
+        Puppet.err(_("--values_file option must evaluate to a Hash or undef/nil, got: '%{template_class}'") % { template_class: template_values.class })
       end
     end
 
@@ -400,7 +400,7 @@ Puppet::Face.define(:epp, '0.0.1') do
       when Hash
         template_values.nil? ? result : template_values.merge(result)
       else
-        Puppet.err("--values option must evaluate to a Hash or undef, got: '#{result.class}'")
+        Puppet.err(_("--values option must evaluate to a Hash or undef, got: '%{values_class}'") % { values_class: result.class })
       end
     else
       template_values
@@ -486,7 +486,7 @@ Puppet::Face.define(:epp, '0.0.1') do
       end
 
       unless given_facts.instance_of?(Hash)
-        raise "Incorrect formatted data in #{fact_file} given via the --facts flag"
+        raise _("Incorrect formatted data in %{fact_file} given via the --facts flag") % { fact_file: fact_file }
       end
       # It is difficult to add to or modify the set of facts once the node is created
       # as changes does not show up in parameters. Rather than manually patching up

data/lib/puppet/face/facts.rb

@@ -2,10 +2,10 @@ require 'puppet/indirector/face'
 require 'puppet/node/facts'
 
 Puppet::Indirector::Face.define(:facts, '0.0.1') do
-  copyright "Puppet Labs", 2011
-  license   "Apache 2 license; see COPYING"
+  copyright "Puppet Inc.", 2011
+  license   _("Apache 2 license; see COPYING")
 
-  summary "Retrieve and store facts."
+  summary _("Retrieve and store facts.")
   description <<-'EOT'
     This subcommand manages facts, which are collections of normalized system
     information used by Puppet. It can read facts directly from the local system
@@ -13,8 +13,8 @@ Puppet::Indirector::Face.define(:facts, '0.0.1') do
   EOT
 
   find = get_action(:find)
-  find.summary "Retrieve a node's facts."
-  find.arguments "[<node_certname>]"
+  find.summary _("Retrieve a node's facts.")
+  find.arguments _("[<node_certname>]")
   find.returns <<-'EOT'
     A hash containing some metadata and (under the "values" key) the set
     of facts for the requested node. When used from the Ruby API: A

data/lib/puppet/face/generate.rb

@@ -4,12 +4,12 @@ require 'puppet/generate/type'
 # Create the Generate face
 Puppet::Face.define(:generate, '0.1.0') do
   copyright 'Puppet Inc.', 2016
-  license   'Apache 2 license; see COPYING'
+  license   _('Apache 2 license; see COPYING')
 
-  summary 'Generates Puppet code from Ruby definitions.'
+  summary _('Generates Puppet code from Ruby definitions.')
 
   action(:types) do
-    summary 'Generates Puppet code for custom types'
+    summary _('Generates Puppet code for custom types')
 
     description <<-'EOT'
       Generates definitions for custom resource types using Puppet code.
@@ -28,17 +28,17 @@ Puppet::Face.define(:generate, '0.1.0') do
           $ puppet generate types --environment development
     EOT
 
-    option '--format <format>' do
-      summary 'The generation output format to use. Supported formats: pcore.'
+    option '--format ' + _('<format>') do
+      summary _('The generation output format to use. Supported formats: pcore.')
       default_to { 'pcore' }
 
       before_action do |_, _, options|
-        raise ArgumentError, "'#{options[:format]}' is not a supported format for type generation." unless ['pcore'].include?(options[:format])
+        raise ArgumentError, _("'%{format}' is not a supported format for type generation.") % { format: options[:format] } unless ['pcore'].include?(options[:format])
       end
     end
 
     option '--force' do
-      summary 'Forces the generation of output files (skips up-to-date checks).'
+      summary _('Forces the generation of output files (skips up-to-date checks).')
       default_to { false }
     end
 
@@ -53,7 +53,7 @@ Puppet::Face.define(:generate, '0.1.0') do
       path_to_env = environment.configuration.path_to_env
       outputdir = File.join(path_to_env, '.resource_types')
       if Puppet::FileSystem.exist?(outputdir) && !Puppet::FileSystem.directory?(outputdir)
-        raise ArgumentError, "The output directory '#{outputdir}' exists and is not a directory"
+        raise ArgumentError, _("The output directory '%{outputdir}' exists and is not a directory") % { outputdir: outputdir }
       end
       Puppet::FileSystem::mkpath(outputdir)
 

data/lib/puppet/face/help.rb

@@ -5,7 +5,7 @@ require 'pathname'
 require 'erb'
 
 Puppet::Face.define(:help, '0.0.1') do
-  copyright "Puppet Labs", 2011
+  copyright "Puppet Inc.", 2011
   license   _("Apache 2 license; see COPYING")
 
   summary _("Display Puppet help.")
@@ -78,11 +78,11 @@ Puppet::Face.define(:help, '0.0.1') do
   def render_application_help(applicationname)
     return Puppet::Application[applicationname].help
   rescue StandardError, LoadError => detail
-    msg = _(<<-MSG)
-Could not load help for the application #{applicationname}.
+    msg = _(<<-MSG) % { applicationname: applicationname, detail: detail.message }
+Could not load help for the application %{applicationname}.
 Please check the error logs for more information.
 
-Detail: "#{detail.message}"
+Detail: "%{detail}"
 MSG
     fail ArgumentError, msg, detail.backtrace
   end
@@ -91,11 +91,11 @@ MSG
     face, action = load_face_help(facename, actionname, version)
     return template_for(face, action).result(binding)
   rescue StandardError, LoadError => detail
-    msg = _(<<-MSG)
-Could not load help for the face #{facename}.
+    msg = _(<<-MSG) % { facename: facename, detail: detail.message }
+Could not load help for the face %{facename}.
 Please check the error logs for more information.
 
-Detail: "#{detail.message}"
+Detail: "%{detail}"
 MSG
     fail ArgumentError, msg, detail.backtrace
   end
@@ -105,7 +105,7 @@ MSG
     if actionname
       action = face.get_action(actionname.to_sym)
       if not action
-        fail ArgumentError, _("Unable to load action #{actionname} from #{face}")
+        fail ArgumentError, _("Unable to load action %{actionname} from %{face}") % { actionname: actionname, face: face }
       end
     end
 

data/lib/puppet/face/key.rb

@@ -1,10 +1,10 @@
 require 'puppet/indirector/face'
 
 Puppet::Indirector::Face.define(:key, '0.0.1') do
-  copyright "Puppet Labs", 2011
-  license   "Apache 2 license; see COPYING"
+  copyright "Puppet Inc.", 2011
+  license   _("Apache 2 license; see COPYING")
 
-  summary "Create, save, and remove certificate keys."
+  summary _("Create, save, and remove certificate keys.")
   description <<-'EOT'
     This subcommand manages certificate private keys. Keys are created
     automatically by puppet agent and when certificate requests are generated

data/lib/puppet/face/man.rb

@@ -4,10 +4,10 @@ require 'pathname'
 require 'erb'
 
 Puppet::Face.define(:man, '0.0.1') do
-  copyright "Puppet Labs", 2011
-  license   "Apache 2 license; see COPYING"
+  copyright "Puppet Inc.", 2011
+  license   _("Apache 2 license; see COPYING")
 
-  summary "Display Puppet manual pages."
+  summary _("Display Puppet manual pages.")
 
   description <<-EOT
     This subcommand displays manual pages for all Puppet subcommands. If the
@@ -23,9 +23,9 @@ Puppet::Face.define(:man, '0.0.1') do
   EOT
 
   action(:man) do
-    summary "Display the manual page for a Puppet subcommand."
-    arguments "<subcommand>"
-    returns <<-'EOT'
+    summary _("Display the manual page for a Puppet subcommand.")
+    arguments _("<subcommand>")
+    returns _(<<-'EOT')
       The man data, in Markdown format, suitable for consumption by Ronn.
 
       RENDERING ISSUES: To skip fancy formatting and output the raw Markdown
@@ -75,7 +75,7 @@ Puppet::Face.define(:man, '0.0.1') do
         # ronn is a stupid about pager selection, we can be smarter. :)
         if pager then ENV['PAGER'] = pager end
 
-        args  = "--man --manual='Puppet Manual' --organization='Puppet Labs, LLC'"
+        args  = "--man --manual='Puppet Manual' --organization='Puppet Inc., LLC'"
         # manual pages could contain UTF-8 text
         IO.popen("#{ronn} #{args}", 'w:UTF-8') do |fh| fh.write text end
 

data/lib/puppet/face/module/build.rb

@@ -1,6 +1,6 @@
 Puppet::Face.define(:module, '1.0.0') do
   action(:build) do
-    summary "Build a module release package."
+    summary _("Build a module release package.")
     description <<-EOT
       Prepares a local module for release on the Puppet Forge by building a
       ready-to-upload archive file.
@@ -13,7 +13,7 @@ Puppet::Face.define(:module, '1.0.0') do
       `pkg` directory.
     EOT
 
-    returns "Pathname object representing the path to the release archive."
+    returns _("Pathname object representing the path to the release archive.")
 
     examples <<-EOT
       Build a module release:
@@ -30,12 +30,12 @@ Puppet::Face.define(:module, '1.0.0') do
       Module built: /Users/kelseyhightower/puppetlabs-apache/pkg/puppetlabs-apache-0.0.1.tar.gz
     EOT
 
-    arguments "[<path>]"
+    arguments _("[<path>]")
 
     when_invoked do |*args|
       options = args.pop
       if options.nil? or args.length > 1 then
-        raise ArgumentError, "puppet module build only accepts 0 or 1 arguments"
+        raise ArgumentError, _("puppet module build only accepts 0 or 1 arguments")
       end
 
       module_path = args.first
@@ -43,11 +43,11 @@ Puppet::Face.define(:module, '1.0.0') do
         pwd = Dir.pwd
         module_path = Puppet::ModuleTool.find_module_root(pwd)
         if module_path.nil?
-          raise "Unable to find metadata.json in module root #{pwd} or parent directories. See <https://docs.puppetlabs.com/puppet/latest/reference/modules_publishing.html> for required file format."
+          raise _("Unable to find metadata.json in module root %{pwd} or parent directories. See <https://docs.puppetlabs.com/puppet/latest/reference/modules_publishing.html> for required file format.") % { pwd: pwd }
         end
       else
         unless Puppet::ModuleTool.is_module_root?(module_path)
-          raise "Unable to find metadata.json in module root #{module_path} or parent directories. See <https://docs.puppetlabs.com/puppet/latest/reference/modules_publishing.html> for required file format."
+          raise _("Unable to find metadata.json in module root %{module_path} or parent directories. See <https://docs.puppetlabs.com/puppet/latest/reference/modules_publishing.html> for required file format.") % { module_path: module_path }
         end
       end
 
@@ -57,7 +57,7 @@ Puppet::Face.define(:module, '1.0.0') do
 
     when_rendering :console do |return_value|
       # Get the string representation of the Pathname object.
-      "Module built: " + return_value.expand_path.to_s
+      _("Module built: ") + return_value.expand_path.to_s
     end
   end
 end

data/lib/puppet/face/module/changes.rb

@@ -1,6 +1,6 @@
 Puppet::Face.define(:module, '1.0.0') do
   action(:changes) do
-    summary "Show modified files of an installed module."
+    summary _("Show modified files of an installed module.")
     description <<-EOT
       Shows any files in a module that have been modified since it was
       installed. This action compares the files on disk to the md5 checksums
@@ -8,7 +8,7 @@ Puppet::Face.define(:module, '1.0.0') do
       metadata.json.
     EOT
 
-    returns "Array of strings representing paths of modified files."
+    returns _("Array of strings representing paths of modified files.")
 
     examples <<-EOT
       Show modified files of an installed module:
@@ -18,21 +18,21 @@ Puppet::Face.define(:module, '1.0.0') do
       lib/puppet/provider/vcsrepo.rb
     EOT
 
-    arguments "<path>"
+    arguments _("<path>")
 
     when_invoked do |path, options|
       Puppet::ModuleTool.set_option_defaults options
       unless root_path = Puppet::ModuleTool.find_module_root(path)
-        raise ArgumentError, "Could not find a valid module at #{path.inspect}"
+        raise ArgumentError, _("Could not find a valid module at %{path}") % { path: path.inspect }
       end
       Puppet::ModuleTool::Applications::Checksummer.run(root_path, options)
     end
 
     when_rendering :console do |return_value|
       if return_value.empty?
-        Puppet.notice "No modified files"
+        Puppet.notice _("No modified files")
       else
-        Puppet.warning "#{return_value.size} files modified"
+        Puppet.warning _("%{count} files modified") % { count: return_value.size }
       end
       return_value.map do |changed_file|
         "#{changed_file}"