puppet 4.10.12 → 5.0.0

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

@@ -7,15 +7,15 @@ module Puppet::ModuleTool::Errors
       @module_name = options[:module_name]
       @modules     = options[:installed_modules]
       @version     = options[:version_range]
-      super "Could not uninstall '#{@module_name}'; no installed version matches"
+      super _("Could not uninstall '%{module_name}'; no installed version matches") % { module_name: @module_name }
     end
 
     def multiline
       message = []
-      message << "Could not uninstall module '#{@module_name}' (#{v(@version)})"
-      message << "  No installed version of '#{@module_name}' matches (#{v(@version)})"
+      message << _("Could not uninstall module '%{module_name}' (%{version})") % { module_name: @module_name, version: v(@version) }
+      message << _("  No installed version of '%{module_name}' matches (%{version})") % { module_name: @module_name, version: v(@version) }
       message += @modules.map do |mod|
-        "    '#{mod[:name]}' (#{v(mod[:version])}) is installed in #{mod[:path]}"
+        _("    '%{module_name}' (%{version}) is installed in %{path}") % { module_name: mod[:name], version: v(mod[:version]), path: mod[:path] }
       end
       message.join("\n")
     end
@@ -28,17 +28,21 @@ module Puppet::ModuleTool::Errors
       @requested_version = options[:requested_version]
       @installed_version = options[:installed_version]
 
-      super "Could not uninstall '#{@module_name}'; installed modules still depend upon it"
+      super _("Could not uninstall '%{module_name}'; installed modules still depend upon it") % { module_name: @module_name }
     end
 
     def multiline
       message = []
-      message << ("Could not uninstall module '#{@module_name}'" << (@requested_version ? " (#{v(@requested_version)})" : ''))
-      message << "  Other installed modules have dependencies on '#{@module_name}' (#{v(@installed_version)})"
+      if @requested_version
+        message << _("Could not uninstall module '%{module_name}' (v%{requested_version})") % { module_name: @module_name, requested_version: @requested_version }
+      else
+        message << _("Could not uninstall module '%{module_name}'") % { module_name: @module_name }
+      end
+      message << _("  Other installed modules have dependencies on '%{module_name}' (%{version})") % { module_name: @module_name, version: v(@installed_version) }
       message += @required_by.map do |mod|
-        "    '#{mod['name']}' (#{v(mod['version'])}) requires '#{@module_name}' (#{v(mod['version_requirement'])})"
+        _("    '%{module_name}' (%{version}) requires '%{module_dep}' (%{dep_version})") % { module_name: mod['name'], version: v(mod['version']), module_dep: @module_name, dep_version: v(mod['version_requirement']) }
       end
-      message << "    Use `puppet module uninstall --force` to uninstall this module anyway"
+      message << _("    Use `puppet module uninstall --force` to uninstall this module anyway")
       message.join("\n")
     end
   end

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

@@ -17,26 +17,26 @@ module Puppet::ModuleTool::Errors
       @dependency_name   = options[:dependency_name]
       @newer_versions    = options[:newer_versions]
       @possible_culprits = options[:possible_culprits]
-      super "Could not upgrade '#{@module_name}'; more recent versions not found"
+      super _("Could not upgrade '%{module_name}'; more recent versions not found") % { module_name: @module_name }
     end
 
     def multiline
       message = []
-      message << "Could not upgrade module '#{@module_name}' (#{vstring})"
+      message << _("Could not upgrade module '%{module_name}' (%{version})") % { module_name: @module_name, version: vstring }
       if @newer_versions.empty?
-        message << "  The installed version is already the latest version matching #{vstring}"
+        message << _("  The installed version is already the latest version matching %{version}") % { version: vstring }
       else
-        message << "  There are #{@newer_versions.length} newer versions"
-        message << "    No combination of dependency upgrades would satisfy all dependencies"
+        message << _("  There are %{count} newer versions") % { count: @newer_versions.length }
+        message << _("    No combination of dependency upgrades would satisfy all dependencies")
         unless @possible_culprits.empty?
-          message << "    Dependencies will not be automatically upgraded across major versions"
-          message << "    Upgrading one or more of these modules may permit the upgrade to succeed:"
+          message << _("    Dependencies will not be automatically upgraded across major versions")
+          message << _("    Upgrading one or more of these modules may permit the upgrade to succeed:")
           @possible_culprits.each do |name|
             message << "    - #{name}"
           end
         end
       end
-      message << "    Use `puppet module upgrade --force` to upgrade only this module"
+      message << _("    Use `puppet module upgrade --force` to upgrade only this module")
       message.join("\n")
     end
   end
@@ -49,13 +49,13 @@ module Puppet::ModuleTool::Errors
       @conditions        = options[:conditions]
       @action            = options[:action]
 
-      super "Could not #{@action} '#{@module_name}' (#{vstring}); downgrades are not allowed"
+      super _("Could not %{action} '%{module_name}' (%{version}); downgrades are not allowed") % { action: @action, module_name: @module_name, version: vstring }
     end
 
     def multiline
       message = []
-      message << "Could not #{@action} module '#{@module_name}' (#{vstring})"
-      message << "  Downgrading is not allowed."
+      message << _("Could not %{action} module '%{module_name}' (%{version})") % { action: @action, module_name: @module_name, version: vstring }
+      message << _("  Downgrading is not allowed.")
 
       message.join("\n")
     end

data/lib/puppet/module_tool/install_directory.rb

@@ -19,7 +19,7 @@ module Puppet
 
         begin
           @target.mkpath
-          Puppet.notice "Created target directory #{@target}"
+          Puppet.notice _("Created target directory %{dir}") % { dir: @target }
         rescue SystemCallError => orig_error
           raise converted_to_friendly_error(module_name, version, orig_error)
         end

data/lib/puppet/module_tool/installed_modules.rb

@@ -54,14 +54,14 @@ module Puppet::ModuleTool
     class ModuleRelease < SemanticPuppet::Dependency::ModuleRelease
       attr_reader :mod, :metadata
 
-      def initialize(source, mod)
+      def initialize(source, mod, strict_semver = true)
         @mod = mod
         @metadata = mod.metadata
         name = mod.forge_name.tr('/', '-')
         begin
           version = SemanticPuppet::Version.parse(mod.version)
         rescue SemanticPuppet::Version::ValidationFailure => e
-          Puppet.warning "#{mod.name} (#{mod.path}) has an invalid version number (#{mod.version}). The version has been set to 0.0.0. If you are the maintainer for this module, please update the metadata.json with a valid Semantic Version (http://semver.org)."
+          Puppet.warning _("%{module_name} (%{path}) has an invalid version number (%{version}). The version has been set to 0.0.0. If you are the maintainer for this module, please update the metadata.json with a valid Semantic Version (http://semver.org).") % { module_name: mod.name, path: mod.path, version: mod.version }
           version = SemanticPuppet::Version.parse("0.0.0")
         end
         release = "#{name}@#{version}"
@@ -70,7 +70,7 @@ module Puppet::ModuleTool
 
         if mod.dependencies
           mod.dependencies.each do |dependency|
-            results = Puppet::ModuleTool.parse_module_dependency(release, dependency)
+            results = Puppet::ModuleTool.parse_module_dependency(release, dependency, strict_semver)
             dep_name, parsed_range, range = results
 
             add_constraint('initialize', dep_name, range.to_s) do |node|

data/lib/puppet/module_tool/local_tarball.rb

@@ -8,11 +8,11 @@ module Puppet::ModuleTool
   class LocalTarball < SemanticPuppet::Dependency::Source
     attr_accessor :release
 
-    def initialize(filename)
+    def initialize(filename, strict_semver = true)
       unpack(filename, tmpdir)
       Puppet.debug "Unpacked local tarball to #{tmpdir}"
 
-      mod = Puppet::Module.new('tarball', tmpdir, nil)
+      mod = Puppet::Module.new('tarball', tmpdir, nil, strict_semver)
       @release = ModuleRelease.new(self, mod)
     end
 
@@ -52,7 +52,7 @@ module Puppet::ModuleTool
 
         if mod.dependencies
           dependencies = mod.dependencies.map do |dep|
-            Puppet::ModuleTool.parse_module_dependency(release, dep)[0..1]
+            Puppet::ModuleTool.parse_module_dependency(release, dep, mod.strict_semver?)[0..1]
           end
           dependencies = Hash[dependencies]
         end
@@ -83,7 +83,7 @@ module Puppet::ModuleTool
       begin
         Puppet::ModuleTool::Applications::Unpacker.unpack(file, destination)
       rescue Puppet::ExecutionFailure => e
-        raise RuntimeError, "Could not extract contents of module archive: #{e.message}"
+        raise RuntimeError, _("Could not extract contents of module archive: %{message}") % { message: e.message }
       end
     end
   end

data/lib/puppet/module_tool/metadata.rb

@@ -68,7 +68,7 @@ module Puppet::ModuleTool
       validate_version_range(version_requirement) if version_requirement
 
       if dup = @data['dependencies'].find { |d| d.full_module_name == name && d.version_requirement != version_requirement }
-        raise ArgumentError, "Dependency conflict for #{full_module_name}: Dependency #{name} was given conflicting version requirements #{version_requirement} and #{dup.version_requirement}. Verify that there are no duplicates in the metadata.json."
+        raise ArgumentError, _("Dependency conflict for %{module_name}: Dependency %{name} was given conflicting version requirements %{version_requirement} and %{dup_version}. Verify that there are no duplicates in the metadata.json.") % { module_name: full_module_name, name: name, version_requirement: version_requirement, dup_version: dup.version_requirement }
       end
 
       dep = Dependency.new(name, version_requirement, repository)
@@ -174,24 +174,24 @@ module Puppet::ModuleTool
 
       err = case modname
       when nil, '', :namespace_missing
-        "the field must be a namespaced module name"
+        _("the field must be a namespaced module name")
       when /[^a-z0-9_]/i
-        "the module name contains non-alphanumeric (or underscore) characters"
+        _("the module name contains non-alphanumeric (or underscore) characters")
       when /^[^a-z]/i
-        "the module name must begin with a letter"
+        _("the module name must begin with a letter")
       else
-        "the namespace contains non-alphanumeric characters"
+        _("the namespace contains non-alphanumeric characters")
       end
 
-      raise ArgumentError, "Invalid 'name' field in metadata.json: #{err}"
+      raise ArgumentError, _("Invalid 'name' field in metadata.json: %{err}") % { err: err }
     end
 
     # Validates that the version string can be parsed as per SemVer.
     def validate_version(version)
-      return if SemVer.valid?(version)
+      return if SemanticPuppet::Version.valid?(version)
 
-      err = "version string cannot be parsed as a valid Semantic Version"
-      raise ArgumentError, "Invalid 'version' field in metadata.json: #{err}"
+      err = _("version string cannot be parsed as a valid Semantic Version")
+      raise ArgumentError, _("Invalid 'version' field in metadata.json: %{err}") % { err: err }
     end
 
     # Validates that the given _value_ is a symbolic name that starts with a letter
@@ -203,19 +203,22 @@ module Puppet::ModuleTool
       err = nil
       if value.is_a?(String)
         unless value =~ /^[a-zA-Z][a-zA-Z0-9_]*$/
-          err = value =~ /^[a-zA-Z]/ ? 'contains non-alphanumeric characters' : 'must begin with a letter'
+          if value =~ /^[a-zA-Z]/
+            raise ArgumentError, _("field 'data_provider' contains non-alphanumeric characters")
+          else
+            raise ArgumentError, _("field 'data_provider' must begin with a letter")
+          end
         end
       else
-        err = 'must be a string'
+        raise ArgumentError, _("field 'data_provider' must be a string")
       end
-      raise ArgumentError, "field 'data_provider' #{err}" if err
     end
 
     # Validates that the version range can be parsed by Semantic.
     def validate_version_range(version_range)
       SemanticPuppet::VersionRange.parse(version_range)
     rescue ArgumentError => e
-      raise ArgumentError, "Invalid 'version_range' field in metadata.json: #{e}"
+      raise ArgumentError, _("Invalid 'version_range' field in metadata.json: %{err}") % { err: e }
     end
   end
 end

data/lib/puppet/module_tool/shared_behaviors.rb

@@ -29,14 +29,14 @@ module Puppet::ModuleTool::Shared
     @urls     = {}
     @versions = Hash.new { |h,k| h[k] = [] }
 
-    Puppet.notice "Downloading from #{forge.uri} ..."
+    Puppet.notice _("Downloading from %{uri} ...") % { uri: forge.uri }
     author, modname = Puppet::ModuleTool.username_and_modname_from(@module_name)
     info = forge.remote_dependency_info(author, modname, @options[:version])
     info.each do |pair|
       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 = SemanticPuppet::Version.parse(rel['version']) rescue SemanticPuppet::Version::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']
@@ -76,10 +76,10 @@ module Puppet::ModuleTool::Shared
       }
 
       if forced?
-        range = SemVer[@version] rescue SemVer['>= 0.0.0']
+        range = SemanticPuppet::VersionRange.parse(@version, @strict_semver) rescue SemanticPuppet::VersionRange.parse('>= 0.0.0', @strict_semver)
       else
         range = (@conditions[mod]).map do |r|
-          SemVer[r[:dependency]] rescue SemVer['>= 0.0.0']
+          SemanticPuppet::VersionRange.parse(r[:dependency], @strict_semver) rescue SemanticPuppet::VersionRange.parse('>= 0.0.0', @strict_semver)
         end.inject(&:&)
       end
 
@@ -97,7 +97,7 @@ module Puppet::ModuleTool::Shared
       end
 
       if !(forced? || @installed[mod].empty? || source.last[:name] == :you)
-        next if range === SemVer.new(@installed[mod].first.version)
+        next if range === SemanticPuppet::Version.parse(@installed[mod].first.version)
         action = :upgrade
       elsif @installed[mod].empty?
         action = :install
@@ -151,7 +151,7 @@ module Puppet::ModuleTool::Shared
           cache_path = forge.retrieve(release[:file])
         end
       rescue OpenURI::HTTPError => e
-        raise RuntimeError, "Could not download module: #{e.message}", e.backtrace
+        raise RuntimeError, _("Could not download module: %{message}") % { message: e.message }, e.backtrace
       end
 
       [

data/lib/puppet/module_tool/skeleton/templates/generator/Gemfile

@@ -3,7 +3,7 @@ source ENV['GEM_SOURCE'] || 'https://rubygems.org'
 puppetversion = ENV.key?('PUPPET_VERSION') ? ENV['PUPPET_VERSION'] : ['>= 3.3']
 gem 'metadata-json-lint'
 gem 'puppet', puppetversion
-gem 'puppetlabs_spec_helper', '>= 1.0.0'
+gem 'puppetlabs_spec_helper', '>= 1.2.0'
 gem 'puppet-lint', '>= 1.0.0'
 gem 'facter', '>= 1.7.0'
 gem 'rspec-puppet'

data/lib/puppet/module_tool/skeleton/templates/generator/README.md.erb

@@ -61,10 +61,16 @@ examples and code samples for doing things with your module.
 
 ## Reference
 
-Here, include a complete list of your module's classes, types, providers,
-facts, along with the parameters for each. Users refer to this section (thus
-the name "Reference") to find specific details; most users don't read it per
-se.
+Users need a complete list of your module's classes, types, defined types providers, facts, and functions, along with the parameters for each. You can provide this list either via Puppet Strings code comments or as a complete list in this Reference section.
+
+* If you are using Puppet Strings code comments, this Reference section should include Strings information so that your users know how to access your documentation.
+
+* If you are not using Puppet Strings, include a list of all of your classes, defined types, and so on, along with their parameters. Each element in this listing should include:
+
+  * The data type, if applicable.
+  * A description of what the element does.
+  * Valid values, if the data type doesn't make it obvious.
+  * Default value, if any.
 
 ## Limitations
 

data/lib/puppet/module_tool/skeleton/templates/generator/Rakefile

@@ -24,9 +24,9 @@ task :validate do
   end
 end
 
-desc 'Run metadata_lint, lint, validate, and spec tests.'
+desc 'Run lint, validate, and spec tests.'
 task :test do
-  [:metadata_lint, :lint, :validate, :spec].each do |test|
+  [:lint, :validate, :spec].each do |test|
     Rake::Task[test].invoke
   end
 end

data/lib/puppet/module_tool/tar.rb

@@ -11,7 +11,8 @@ module Puppet::ModuleTool::Tar
     elsif Puppet::Util.which('tar') && ! Puppet::Util::Platform.windows?
       Gnu.new
     else
-      raise RuntimeError, 'No suitable tar implementation found'
+      #TRANSLATORS "tar" is a program name and should not be translated
+      raise RuntimeError, _('No suitable tar implementation found')
     end
   end
 end

data/lib/puppet/module_tool/tar/mini.rb

@@ -3,77 +3,24 @@ class Puppet::ModuleTool::Tar::Mini
     Zlib::GzipReader.open(sourcefile) do |reader|
       Archive::Tar::Minitar.unpack(reader, destdir, find_valid_files(reader)) do |action, name, stats|
         case action
-        when :dir
+        when :file_done
+          File.chmod(0644, "#{destdir}/#{name}")
+        when :dir, :file_start
           validate_entry(destdir, name)
-          set_dir_mode!(stats)
-          Puppet.debug("Extracting: #{destdir}/#{name}")
-        when :file_start
-          # Octal string of the old file mode.
-          validate_entry(destdir, name)
-          set_file_mode!(stats)
           Puppet.debug("Extracting: #{destdir}/#{name}")
         end
-        set_default_user_and_group!(stats)
-        stats
       end
     end
   end
 
   def pack(sourcedir, destfile)
     Zlib::GzipWriter.open(destfile) do |writer|
-      Archive::Tar::Minitar.pack(sourcedir, writer) do |step, name, stats|
-        # TODO smcclellan 2017-10-31 Set permissions here when this yield block
-        # executes before the header is written. As it stands, the `stats`
-        # argument isn't mutable in a way that will effect the desired mode for
-        # the file.
-      end
+      Archive::Tar::Minitar.pack(sourcedir, writer)
     end
   end
 
   private
 
-  EXECUTABLE = 0755
-  NOT_EXECUTABLE = 0644
-  USER_EXECUTE = 0100
-
-  def set_dir_mode!(stats)
-    if stats.key?(:mode)
-      # This is only the case for `pack`, so this code will not run.
-      stats[:mode] = EXECUTABLE
-    elsif stats.key?(:entry)
-      old_mode = stats[:entry].instance_variable_get(:@mode)
-      if old_mode.is_a?(Fixnum)
-        stats[:entry].instance_variable_set(:@mode, EXECUTABLE)
-      end
-    end
-  end
-
-  # Sets a file mode to 0755 if the file is executable by the user.
-  # Sets a file mode to 0644 if the file mode is set (non-Windows).
-  def sanitized_mode(old_mode)
-    old_mode & USER_EXECUTE != 0 ? EXECUTABLE : NOT_EXECUTABLE
-  end
-
-  def set_file_mode!(stats)
-    if stats.key?(:mode)
-      # This is only the case for `pack`, so this code will not run.
-      stats[:mode] = sanitized_mode(stats[:mode])
-    elsif stats.key?(:entry)
-      old_mode = stats[:entry].instance_variable_get(:@mode)
-      # If the user can execute the file, set 0755, otherwise 0644.
-      if old_mode.is_a?(Fixnum)
-        new_mode = sanitized_mode(old_mode)
-        stats[:entry].instance_variable_set(:@mode, new_mode)
-      end
-    end
-  end
-
-  # Sets UID and GID to 0 for standardization.
-  def set_default_user_and_group!(stats)
-    stats[:uid] = 0
-    stats[:gid] = 0
-  end
-
   # Find all the valid files in tarfile.
   #
   # This check was mainly added to ignore 'x' and 'g' flags from the PAX

data/lib/puppet/network/auth_config_parser.rb

@@ -28,11 +28,12 @@ class AuthConfigParser
         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}"
+          #TRANSLATORS "path" is a configuration file entry and should not be translated
+          raise Puppet::ConfigurationError, _("Missing or invalid 'path' before right directive at line %{count} of %{file}") % { count: count, file: @file }
         end
         parse_right_directive(right, $1, $2, count)
       else
-        raise Puppet::ConfigurationError, "Invalid line #{count}: #{line}"
+        raise Puppet::ConfigurationError, _("Invalid line %{count}: %{line}") % { count: count, line: line }
       end
       count += 1
     }
@@ -50,22 +51,22 @@ class AuthConfigParser
     value.strip!
     case var
     when "allow"
-      modify_right(right, :allow, value, "allowing %s access", count)
+      modify_right(right, :allow, value, _("allowing %s access"), count)
     when "deny"
-      modify_right(right, :deny, value, "denying %s access", count)
+      modify_right(right, :deny, value, _("denying %s access"), count)
     when "allow_ip"
-      modify_right(right, :allow_ip, value, "allowing IP %s access", count)
+      modify_right(right, :allow_ip, value, _("allowing IP %s access"), count)
     when "deny_ip"
-      modify_right(right, :deny_ip, value, "denying IP %s access", count)
+      modify_right(right, :deny_ip, value, _("denying IP %s access"), count)
     when "method"
-      modify_right(right, :restrict_method, value, "allowing 'method' %s", count)
+      modify_right(right, :restrict_method, value, _("allowing 'method' %s"), count)
     when "environment"
-      modify_right(right, :restrict_environment, value, "adding environment %s", count)
+      modify_right(right, :restrict_environment, value, _("adding environment %s"), count)
     when /auth(?:enticated)?/
-      modify_right(right, :restrict_authenticated, value, "adding authentication %s", count)
+      modify_right(right, :restrict_authenticated, value, _("adding authentication %s"), count)
     else
       raise Puppet::ConfigurationError,
-        "Invalid argument '#{var}' at line #{count}"
+        _("Invalid argument '%{var}' at line %{count}") % { var: var, count: count }
     end
   end
 
@@ -76,7 +77,7 @@ class AuthConfigParser
         right.info msg % val
         right.send(method, val)
       rescue Puppet::AuthStoreError => detail
-        raise Puppet::ConfigurationError, "#{detail} at line #{count} of #{@file}", detail.backtrace
+        raise Puppet::ConfigurationError, _("%{detail} at line %{count} of %{file}") % { detail: detail, count: count, file: @file }, detail.backtrace
       end
     end
   end