openvox 7.37.1 → 8.19.0

data/lib/puppet/module/task.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require_relative '../../puppet/util/logging'
 
 class Puppet::Module
   class Task
     class Error < Puppet::Error
       attr_accessor :kind, :details
+
       def initialize(message, kind, details = nil)
         super(message)
         @details = details || {}
@@ -34,22 +37,25 @@ class Puppet::Module
 
     class InvalidTask < Error
     end
+
     class InvalidMetadata < Error
     end
+
     class TaskNotFound < Error
       def initialize(task_name, module_name)
         msg = _("Task %{task_name} not found in module %{module_name}.") %
-          {task_name: task_name, module_name: module_name}
+              { task_name: task_name, module_name: module_name }
         super(msg, 'puppet.tasks/task-not-found', { 'name' => task_name })
       end
     end
 
-    FORBIDDEN_EXTENSIONS = %w{.conf .md}
+    FORBIDDEN_EXTENSIONS = %w[.conf .md]
     MOUNTS = %w[files lib scripts tasks]
 
     def self.is_task_name?(name)
       return true if name =~ /^[a-z][a-z0-9_]*$/
-      return false
+
+      false
     end
 
     def self.is_tasks_file?(path)
@@ -59,11 +65,12 @@ class Puppet::Module
     # Determine whether a file has a legal name for either a task's executable or metadata file.
     def self.is_tasks_filename?(path)
       name_less_extension = File.basename(path, '.*')
-      return false if not is_task_name?(name_less_extension)
+      return false unless is_task_name?(name_less_extension)
+
       FORBIDDEN_EXTENSIONS.each do |ext|
         return false if path.end_with?(ext)
       end
-      return true
+      true
     end
 
     def self.get_file_details(path, mod)
@@ -73,23 +80,23 @@ class Puppet::Module
       # Partition matches on the first instance it finds of the parameter
       name = "#{mod.name}#{path.partition(mod.path).last}"
 
-      { "name" => name, "path" =>  path }
+      { "name" => name, "path" => path }
     end
     private_class_method :get_file_details
 
     # Find task's required lib files and retrieve paths for both 'files' and 'implementation:files' metadata keys
     def self.find_extra_files(metadata, envname = nil)
       return [] if metadata.nil?
-      
+
       files = metadata.fetch('files', [])
       unless files.is_a?(Array)
-        msg = _("The 'files' task metadata expects an array, got %{files}.") % {files: files}
+        msg = _("The 'files' task metadata expects an array, got %{files}.") % { files: files }
         raise InvalidMetadata.new(msg, 'puppet.tasks/invalid-metadata')
       end
-      impl_files = metadata.fetch('implementations', []).flat_map do |impl| 
+      impl_files = metadata.fetch('implementations', []).flat_map do |impl|
         file_array = impl.fetch('files', [])
         unless file_array.is_a?(Array)
-          msg = _("The 'files' task metadata expects an array, got %{files}.") % {files: file_array}
+          msg = _("The 'files' task metadata expects an array, got %{files}.") % { files: file_array }
           raise InvalidMetadata.new(msg, 'puppet.tasks/invalid-metadata')
         end
         file_array
@@ -105,13 +112,13 @@ class Puppet::Module
         pup_module = Puppet::Module.find(module_name, envname)
         if pup_module.nil?
           msg = _("Could not find module %{module_name} containing task file %{filename}" %
-                  {module_name: module_name, filename: endpath})
+                  { module_name: module_name, filename: endpath })
           raise InvalidMetadata.new(msg, 'puppet.tasks/invalid-metadata')
         end
 
         unless MOUNTS.include? mount
           msg = _("Files must be saved in module directories that Puppet makes available via mount points: %{mounts}" %
-                  {mounts: MOUNTS.join(', ')})
+                  { mounts: MOUNTS.join(', ') })
           raise InvalidMetadata.new(msg, 'puppet.tasks/invalid-metadata')
         end
 
@@ -123,20 +130,20 @@ class Puppet::Module
 
         unless File.exist?(path)
           msg = _("Could not find %{path} on disk" % { path: path })
-          raise InvalidFile.new(msg)
+          raise InvalidFile, msg
         end
 
         last_char = file[-1] == '/'
         if File.directory?(path)
           unless last_char
-            msg = _("Directories specified in task metadata must include a trailing slash: %{dir}" % { dir: file } )
+            msg = _("Directories specified in task metadata must include a trailing slash: %{dir}" % { dir: file })
             raise InvalidMetadata.new(msg, 'puppet.tasks/invalid-metadata')
           end
           dir_files = Dir.glob("#{path}**/*").select { |f| File.file?(f) }
           dir_files.map { |f| get_file_details(f, pup_module) }
         else
           if last_char
-            msg = _("Files specified in task metadata cannot include a trailing slash: %{file}" % { file: file } )
+            msg = _("Files specified in task metadata cannot include a trailing slash: %{file}" % { file: file })
             raise InvalidMetadata.new(msg, 'puppet.task/invalid-metadata')
           end
           get_file_details(path, pup_module)
@@ -165,7 +172,7 @@ class Puppet::Module
           path = executables.find { |real_impl| File.basename(real_impl) == impl['name'] }
           unless path
             msg = _("Task metadata for task %{name} specifies missing implementation %{implementation}" % { name: name, implementation: impl['name'] })
-            raise InvalidTask.new(msg, 'puppet.tasks/missing-implementation', { missing: [impl['name']] } )
+            raise InvalidTask.new(msg, 'puppet.tasks/missing-implementation', { missing: [impl['name']] })
           end
           { "name" => impl['name'], "path" => path }
         end
@@ -177,11 +184,11 @@ class Puppet::Module
       implementations = executables.select { |impl| File.basename(impl, '.*') == basename }
       if implementations.empty?
         msg = _('No source besides task metadata was found in directory %{directory} for task %{name}') %
-          { name: name, directory: directory }
+              { name: name, directory: directory }
         raise InvalidTask.new(msg, 'puppet.tasks/no-implementation')
       elsif implementations.length > 1
-        msg =_("Multiple executables were found in directory %{directory} for task %{name}; define 'implementations' in metadata to differentiate between them") %
-          { name: name, directory: implementations[0] }
+        msg = _("Multiple executables were found in directory %{directory} for task %{name}; define 'implementations' in metadata to differentiate between them") %
+              { name: name, directory: implementations[0] }
         raise InvalidTask.new(msg, 'puppet.tasks/multiple-implementations')
       end
 
@@ -204,7 +211,7 @@ class Puppet::Module
 
     def self.tasks_in_module(pup_module)
       task_files = Dir.glob(File.join(pup_module.tasks_directory, '*'))
-        .keep_if { |f| is_tasks_file?(f) }
+                      .keep_if { |f| is_tasks_file?(f) }
 
       module_executables = task_files.reject(&method(:is_tasks_metadata_filename?)).map.to_a
 
@@ -218,8 +225,8 @@ class Puppet::Module
     attr_reader :name, :module, :metadata_file
 
     # file paths must be relative to the modules task directory
-    def initialize(pup_module, task_name,  module_executables, metadata_file = nil)
-      if !Puppet::Module::Task.is_task_name?(task_name)
+    def initialize(pup_module, task_name, module_executables, metadata_file = nil)
+      unless Puppet::Module::Task.is_task_name?(task_name)
         raise InvalidName, _("Task names must start with a lowercase letter and be composed of only lowercase letters, numbers, and underscores")
       end
 
@@ -232,14 +239,12 @@ class Puppet::Module
     end
 
     def self.read_metadata(file)
-      # MultiJSON has a bug that improperly errors when loading an empty string
-      # so we handle it here for now. See: PUP-11629
       if file
         content = Puppet::FileSystem.read(file, :encoding => 'utf-8')
         content.empty? ? {} : Puppet::Util::Json.load(content)
       end
     rescue SystemCallError, IOError => err
-      msg = _("Error reading metadata: %{message}" % {message: err.message})
+      msg = _("Error reading metadata: %{message}" % { message: err.message })
       raise InvalidMetadata.new(msg, 'puppet.tasks/unreadable-metadata')
     rescue Puppet::Util::Json::ParseError => err
       raise InvalidMetadata.new(err.message, 'puppet.tasks/unparseable-metadata')
@@ -259,8 +264,8 @@ class Puppet::Module
     end
 
     def ==(other)
-      self.name == other.name &&
-      self.module == other.module
+      name == other.name &&
+        self.module == other.module
     end
 
     def environment_name
@@ -276,7 +281,7 @@ class Puppet::Module
 
     # Abstracted here so we can add support for subdirectories later
     def self.task_name_from_path(path)
-      return File.basename(path, '.*')
+      File.basename(path, '.*')
     end
     private_class_method :task_name_from_path
   end

data/lib/puppet/module.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../puppet/util/logging'
 require_relative 'module/task'
 require_relative 'module/plan'
@@ -33,6 +35,7 @@ class Puppet::Module
   # of +path+, return +nil+
   def self.find(modname, environment = nil)
     return nil unless modname
+
     # Unless a specific environment is given, use the current environment
     env = environment ? Puppet.lookup(:environments).get!(environment) : Puppet.lookup(:current_environment)
     env.module(modname)
@@ -42,19 +45,22 @@ class Puppet::Module
     # it must be a directory
     fullpath = File.join(path, name)
     return false unless Puppet::FileSystem.directory?(fullpath)
-    return is_module_directory_name?(name)
+
+    is_module_directory_name?(name)
   end
 
   def self.is_module_directory_name?(name)
     # it must match an installed module name according to forge validator
     return true if name =~ /^[a-z][a-z0-9_]*$/
-    return false
+
+    false
   end
 
   def self.is_module_namespaced_name?(name)
     # it must match the full module name according to forge validator
-    return true if name =~ /^[a-zA-Z0-9]+[-][a-z][a-z0-9_]*$/
-    return false
+    return true if name =~ /^[a-zA-Z0-9]+-[a-z][a-z0-9_]*$/
+
+    false
   end
 
   # @api private
@@ -90,16 +96,14 @@ class Puppet::Module
 
   # @deprecated The puppetversion module metadata field is no longer used.
   def validate_puppet_version
-    return
+    nil
   end
 
   def has_metadata?
-    begin
-      load_metadata
-      @metadata.is_a?(Hash) && !@metadata.empty?
-    rescue Puppet::Module::MissingMetadata
-      false
-    end
+    load_metadata
+    @metadata.is_a?(Hash) && !@metadata.empty?
+  rescue Puppet::Module::MissingMetadata
+    false
   end
 
   FILETYPES.each do |type, location|
@@ -112,7 +116,7 @@ class Puppet::Module
         return false
       end
 
-      return true
+      true
     end
 
     # A method for returning a given file of a given type.
@@ -130,7 +134,8 @@ class Puppet::Module
       end
 
       return nil unless Puppet::FileSystem.exist?(full_path)
-      return full_path
+
+      full_path
     end
 
     # Return the base directory for the given type
@@ -166,9 +171,9 @@ class Puppet::Module
     end
 
     if Puppet::FileSystem.exist?(full_path)
-      return full_path
+      full_path
     else
-      return nil
+      nil
     end
   end
 
@@ -199,9 +204,9 @@ class Puppet::Module
     end
 
     if Puppet::FileSystem.exist?(full_path)
-      return full_path
+      full_path
     else
-      return nil
+      nil
     end
   end
 
@@ -209,16 +214,20 @@ class Puppet::Module
     return @license_file if defined?(@license_file)
 
     return @license_file = nil unless path
+
     @license_file = File.join(path, "License")
   end
 
   def read_metadata
     md_file = metadata_file
-    md_file.nil? ? {} : Puppet::Util::Json.load(File.read(md_file, :encoding => 'utf-8'))
+    return {} if md_file.nil?
+
+    content = File.read(md_file, :encoding => 'utf-8')
+    content.empty? ? {} : Puppet::Util::Json.load(content)
   rescue Errno::ENOENT
     {}
   rescue Puppet::Util::Json::ParseError => e
-    #TRANSLATORS 'metadata.json' is a specific file name and should not be translated.
+    # TRANSLATORS 'metadata.json' is a specific file name and should not be translated.
     msg = _("%{name} has an invalid and unparsable metadata.json file. The parse error: %{error}") % { name: name, error: e.message }
     case Puppet[:strict]
     when :off
@@ -241,12 +250,13 @@ class Puppet::Module
 
     [:source, :author, :version, :license, :dependencies].each do |attr|
       value = data[attr.to_s]
-      raise MissingMetadata, "No #{attr} module metadata provided for #{self.name}" if value.nil?
+      raise MissingMetadata, "No #{attr} module metadata provided for #{name}" if value.nil?
 
       if attr == :dependencies
         unless value.is_a?(Array)
-          raise MissingMetadata, "The value for the key dependencies in the file metadata.json of the module #{self.name} must be an array, not: '#{value}'"
+          raise MissingMetadata, "The value for the key dependencies in the file metadata.json of the module #{name} must be an array, not: '#{value}'"
         end
+
         value.each do |dep|
           name = dep['name']
           dep['name'] = name.tr('-', '/') unless name.nil?
@@ -286,12 +296,13 @@ class Puppet::Module
     return @metadata_file if defined?(@metadata_file)
 
     return @metadata_file = nil unless path
+
     @metadata_file = File.join(path, "metadata.json")
   end
 
   def hiera_conf_file
     unless defined?(@hiera_conf_file)
-       @hiera_conf_file = path.nil? ? nil : File.join(path, Puppet::Pops::Lookup::HieraConfig::CONFIG_FILE_NAME)
+      @hiera_conf_file = path.nil? ? nil : File.join(path, Puppet::Pops::Lookup::HieraConfig::CONFIG_FILE_NAME)
     end
     @hiera_conf_file
   end
@@ -313,7 +324,7 @@ class Puppet::Module
     subpath("facts.d")
   end
 
-  #@return [String]
+  # @return [String]
   def locale_directory
     subpath("locales")
   end
@@ -325,7 +336,7 @@ class Puppet::Module
   # @return true if the module has a directory for the locale, false
   #         false otherwise
   def has_translations?(locale)
-    return Puppet::FileSystem.exist?(File.join(locale_directory, locale))
+    Puppet::FileSystem.exist?(File.join(locale_directory, locale))
   end
 
   def has_external_facts?
@@ -355,7 +366,7 @@ class Puppet::Module
   end
 
   def required_by
-    environment.module_requirements[self.forge_name] || {}
+    environment.module_requirements[forge_name] || {}
   end
 
   # Identify and mark unmet dependencies.  A dependency will be marked unmet
@@ -402,8 +413,8 @@ class Puppet::Module
         :name => name,
         :version_constraint => version_string.gsub(/^(?=\d)/, "v"),
         :parent => {
-          :name => self.forge_name,
-          :version => self.version.gsub(/^(?=\d)/, "v")
+          :name => forge_name,
+          :version => version.gsub(/^(?=\d)/, "v")
         },
         :mod_details => {
           :installed_version => dep_mod.nil? ? nil : dep_mod.version
@@ -416,32 +427,32 @@ class Puppet::Module
         next
       end
 
-      if version_string
-        begin
-          required_version_semver_range = self.class.parse_range(version_string)
-          actual_version_semver = SemanticPuppet::Version.parse(dep_mod.version)
-        rescue ArgumentError
-          error_details[:reason] = :non_semantic_version
-          unmet_dependencies << error_details
-          next
-        end
+      next unless version_string
 
-        unless required_version_semver_range.include? actual_version_semver
-          error_details[:reason] = :version_mismatch
-          unmet_dependencies << error_details
-          next
-        end
+      begin
+        required_version_semver_range = self.class.parse_range(version_string)
+        actual_version_semver = SemanticPuppet::Version.parse(dep_mod.version)
+      rescue ArgumentError
+        error_details[:reason] = :non_semantic_version
+        unmet_dependencies << error_details
+        next
       end
+
+      next if required_version_semver_range.include? actual_version_semver
+
+      error_details[:reason] = :version_mismatch
+      unmet_dependencies << error_details
+      next
     end
 
     unmet_dependencies
   end
 
   def ==(other)
-    self.name == other.name &&
-    self.version == other.version &&
-    self.path == other.path &&
-    self.environment == other.environment
+    name == other.name &&
+      version == other.version &&
+      path == other.path &&
+      environment == other.environment
   end
 
   private
@@ -452,8 +463,9 @@ class Puppet::Module
       relative_pattern = Puppet::FileSystem::PathPattern.relative(extended)
     rescue Puppet::FileSystem::PathPattern::InvalidPattern => error
       raise Puppet::Module::InvalidFilePattern.new(
-        "The pattern \"#{pattern}\" to find manifests in the module \"#{name}\" " +
-        "is invalid and potentially unsafe.", error)
+        "The pattern \"#{pattern}\" to find manifests in the module \"#{name}\" " \
+        "is invalid and potentially unsafe.", error
+      )
     end
 
     relative_pattern.prefix_with(@absolute_path_to_manifests)

data/lib/puppet/module_tool/applications/application.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'net/http'
 require_relative '../../../puppet/util/json'
 require_relative '../../../puppet/util/colors'
@@ -26,13 +28,18 @@ module Puppet::ModuleTool
         when Net::HTTPOK, Net::HTTPCreated
           Puppet.notice success
         else
-          errors = Puppet::Util::Json.load(response.body)['error'] rescue "HTTP #{response.code}, #{response.body}"
+          errors = begin
+            Puppet::Util::Json.load(response.body)['error']
+          rescue
+            "HTTP #{response.code}, #{response.body}"
+          end
           Puppet.warning "#{failure} (#{errors})"
         end
       end
 
       def metadata(require_metadata = false)
         return @metadata if @metadata
+
         @metadata = Puppet::ModuleTool::Metadata.new
 
         unless @path
@@ -43,15 +50,13 @@ module Puppet::ModuleTool
           raise ArgumentError, _("Unable to find metadata.json in module root at %{path} See https://puppet.com/docs/puppet/latest/modules_publishing.html for required file format.") % { path: @path }
         end
 
-        metadata_path   = File.join(@path, 'metadata.json')
+        metadata_path = File.join(@path, 'metadata.json')
 
         if File.file?(metadata_path)
           File.open(metadata_path) do |f|
-            begin
-              @metadata.update(Puppet::Util::Json.load(f))
-            rescue Puppet::Util::Json::ParseError => ex
-              raise ArgumentError, _("Could not parse JSON %{metadata_path}") % { metadata_path: metadata_path }, ex.backtrace
-            end
+            @metadata.update(Puppet::Util::Json.load(f))
+          rescue Puppet::Util::Json::ParseError => ex
+            raise ArgumentError, _("Could not parse JSON %{metadata_path}") % { metadata_path: metadata_path }, ex.backtrace
           end
         end
 
@@ -59,7 +64,7 @@ module Puppet::ModuleTool
           Puppet.warning _("A Modulefile was found in the root directory of the module. This file will be ignored and can safely be removed.")
         end
 
-        return @metadata
+        @metadata
       end
 
       def load_metadata!
@@ -79,11 +84,11 @@ module Puppet::ModuleTool
           raise ArgumentError, _("Invalid version format: %{version} (Semantic Versions are acceptable: http://semver.org)") % { version: version }
         end
 
-        return {
+        {
           :module_name => module_name,
-          :author      => author,
-          :dir_name    => shortname,
-          :version     => version
+          :author => author,
+          :dir_name => shortname,
+          :version => version
         }
       end
     end

data/lib/puppet/module_tool/applications/checksummer.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require_relative '../../../puppet/util/json'
 require_relative '../../../puppet/module_tool/checksums'
 
 module Puppet::ModuleTool
   module Applications
     class Checksummer < Application
-
       def initialize(path, options = {})
         @path = Pathname.new(path)
         super(options)
@@ -14,7 +15,6 @@ module Puppet::ModuleTool
         changes = []
         sums = Puppet::ModuleTool::Checksums.new(@path)
         checksums.each do |child_path, canonical_checksum|
-
           # Avoid checksumming the checksums.json file
           next if File.basename(child_path) == "checksums.json"
 
@@ -44,7 +44,7 @@ module Puppet::ModuleTool
         elsif metadata_file.exist?
           # Check metadata.json too; legacy modules store their checksums there.
           Puppet::Util::Json.load(metadata_file.read)['checksums'] or
-          raise ArgumentError, _("No file containing checksums found.")
+            raise ArgumentError, _("No file containing checksums found.")
         else
           raise ArgumentError, _("No file containing checksums found.")
         end