hybrid_platforms_conductor 32.17.0 → 33.0.2

data/lib/hybrid_platforms_conductor/cmd_runner.rb

@@ -3,9 +3,13 @@ require 'tempfile'
 require 'tty-command'
 require 'hybrid_platforms_conductor/logger_helpers'
 require 'hybrid_platforms_conductor/io_router'
+require 'hybrid_platforms_conductor/core_extensions/symbol/zero'
+
+Symbol.include HybridPlatformsConductor::CoreExtensions::Symbol::Zero
 
 module HybridPlatformsConductor
 
+  # API to execute local commands, with IO control over files, stdout, timeouts, exceptions.
   class CmdRunner
 
     class UnexpectedExitCodeError < StandardError
@@ -21,7 +25,7 @@ module HybridPlatformsConductor
     # Result::
     # * String: The executable prefix
     def self.executables_prefix
-      $0.include?('/') ? "#{File.dirname($0)}/" : ''
+      $PROGRAM_NAME.include?('/') ? "#{File.dirname($PROGRAM_NAME)}/" : ''
     end
 
     # Dry-run switch. When true, then commands are just printed out without being executed.
@@ -33,7 +37,7 @@ module HybridPlatformsConductor
     # Parameters::
     # * *logger* (Logger): Logger to be used [default = Logger.new(STDOUT)]
     # * *logger_stderr* (Logger): Logger to be used for stderr [default = Logger.new(STDERR)]
-    def initialize(logger: Logger.new(STDOUT), logger_stderr: Logger.new(STDERR))
+    def initialize(logger: Logger.new($stdout), logger_stderr: Logger.new($stderr))
       init_loggers(logger, logger_stderr)
       @dry_run = false
     end
@@ -42,8 +46,7 @@ module HybridPlatformsConductor
     #
     # Parameters::
     # * *options_parser* (OptionParser): The option parser to complete
-    # * *parallel* (Boolean): Do we activate options regarding parallel execution? [default = true]
-    def options_parse(options_parser, parallel: true)
+    def options_parse(options_parser)
       options_parser.separator ''
       options_parser.separator 'Command runner options:'
       options_parser.on('-s', '--show-commands', 'Display the commands that would be run instead of running them') do
@@ -86,7 +89,7 @@ module HybridPlatformsConductor
       expected_code = [expected_code] unless expected_code.is_a?(Array)
       if @dry_run
         out cmd
-        return expected_code.first, '', ''
+        [expected_code.first, '', '']
       else
         log_debug "#{timeout.nil? ? '' : "[ Timeout #{timeout} ] - "}#{cmd.light_cyan.bold}"
         exit_status = nil
@@ -100,15 +103,13 @@ module HybridPlatformsConductor
               FileUtils.mkdir_p(File.dirname(log_to_file))
               File.open(log_to_file, 'w')
             end
-          else
-            nil
           end
         start_time = Time.now if log_debug?
         bash_file = nil
         if force_bash
           bash_file = Tempfile.new('hpc_bash')
           bash_file.write(cmd)
-          bash_file.chmod 0700
+          bash_file.chmod 0o700
           bash_file.close
           cmd = "/bin/bash -c #{bash_file.path}"
         end
@@ -149,10 +150,10 @@ module HybridPlatformsConductor
         rescue
           exit_status = :command_error
           cmd_stdout = cmd_result_stdout
-          cmd_stderr = "#{cmd_result_stderr.empty? ? '' : "#{cmd_result_stderr}\n"}#{$!}\n#{$!.backtrace.join("\n")}"
+          cmd_stderr = "#{cmd_result_stderr.empty? ? '' : "#{cmd_result_stderr}\n"}#{$ERROR_INFO}\n#{$ERROR_INFO.backtrace.join("\n")}"
         ensure
-          file_output.close unless file_output.nil?
-          bash_file.unlink unless bash_file.nil?
+          file_output&.close
+          bash_file&.unlink
         end
         if log_debug?
           elapsed = Time.now - start_time
@@ -169,7 +170,7 @@ module HybridPlatformsConductor
             raise exit_status == :timeout ? TimeoutError : UnexpectedExitCodeError, error_title
           end
         end
-        return exit_status, cmd_stdout, cmd_stderr
+        [exit_status, cmd_stdout, cmd_stderr]
       end
     end
 

data/lib/hybrid_platforms_conductor/cmdb.rb

@@ -16,8 +16,8 @@ module HybridPlatformsConductor
     # * *platforms_handler* (PlatformsHandler): Platforms Handler to be used. [default: PlatformsHandler.new]
     # * *nodes_handler* (NodesHandler): Nodes Handler to be used. [default: NodesHandler.new]
     def initialize(
-      logger: Logger.new(STDOUT),
-      logger_stderr: Logger.new(STDERR),
+      logger: Logger.new($stdout),
+      logger_stderr: Logger.new($stderr),
       config: Config.new,
       cmd_runner: CmdRunner.new,
       platforms_handler: PlatformsHandler.new,

data/lib/hybrid_platforms_conductor/common_config_dsl/bitbucket.rb

@@ -4,9 +4,10 @@ module HybridPlatformsConductor
 
   module CommonConfigDsl
 
+    # Add common Bitbucket config DSL to declare known Bitbucket repositories
     module Bitbucket
 
-      # Initialize the DSL 
+      # Initialize the DSL
       def init_bitbucket
         # List of Bitbucket repositories definitions
         # Array< Hash<Symbol, Object> >

data/lib/hybrid_platforms_conductor/common_config_dsl/confluence.rb

@@ -2,9 +2,10 @@ module HybridPlatformsConductor
 
   module CommonConfigDsl
 
+    # Add common Confluence config DSL to declare known Confluence installations
     module Confluence
 
-      # Initialize the DSL 
+      # Initialize the DSL
       def init_confluence
         # Confluence configuration (can be nil if none)
         # Hash<Symbol, Object> or nil. See #confluence_info to know details.

data/lib/hybrid_platforms_conductor/common_config_dsl/file_system_tests.rb

@@ -19,7 +19,7 @@ module HybridPlatformsConductor
       # Array< Hash<Symbol, Object> >
       attr_reader :fs_paths_rules
 
-      # Initialize the DSL 
+      # Initialize the DSL
       def init_file_system_tests
         @fs_paths_rules = []
         @context = {
@@ -49,7 +49,7 @@ module HybridPlatformsConductor
           paths: paths.flatten,
           nodes_selectors_stack: current_nodes_selectors_stack,
           context: @context.clone,
-          state: :present              
+          state: :present
         }
       end
 
@@ -84,7 +84,7 @@ module HybridPlatformsConductor
           select_confs_for_node(node, fs_paths_rules).
           inject({}) do |merged_paths, paths_info|
             if paths_info[:context][:file_system_type] == file_system_type
-              merged_paths.merge(Hash[paths_info[:paths].map do |path|
+              merged_paths.merge(paths_info[:paths].map do |path|
                 [
                   path,
                   {
@@ -92,9 +92,10 @@ module HybridPlatformsConductor
                     context: paths_info[:context]
                   }
                 ]
-              end]) do |path, rule_info_1, rule_info_2|
+              end.to_h) do |path, rule_info_1, rule_info_2|
                 # Just check that configuration is not inconsistent
                 raise "Inconsistent rule for #{file_system_type} file system checks in configuration for #{node}: #{path} is marked as being both #{rule_info_1[:state]} and #{rule_info_2[:state]}" if rule_info_1[:state] != rule_info_2[:state]
+
                 rule_info_2
               end
             else

data/lib/hybrid_platforms_conductor/common_config_dsl/github.rb

@@ -5,9 +5,10 @@ module HybridPlatformsConductor
 
   module CommonConfigDsl
 
+    # Add common Github config DSL to declare known Github repositories
     module Github
 
-      # Initialize the DSL 
+      # Initialize the DSL
       def init_github
         # List of Github repositories definitions
         # Array< Hash<Symbol, Object> >
@@ -18,10 +19,10 @@ module HybridPlatformsConductor
       # Register new Github repositories
       #
       # Parameters::
-      # * *url* (String): URL to the Github API [default: 'https://api.github.com']
       # * *user* (String): User or organization name, storing repositories
+      # * *url* (String): URL to the Github API [default: 'https://api.github.com']
       # * *repos* (Array<String> or Symbol): List of repository names from this project, or :all for all [default: :all]
-      def github_repos(url: 'https://api.github.com', user:, repos: :all)
+      def github_repos(user:, url: 'https://api.github.com', repos: :all)
         @github_repos << {
           url: url,
           user: user,

data/lib/hybrid_platforms_conductor/common_config_dsl/idempotence_tests.rb

@@ -38,7 +38,7 @@ module HybridPlatformsConductor
       def ignore_idempotence_tasks(tasks_to_ignore)
         @ignored_idempotence_tasks << {
           ignored_tasks: tasks_to_ignore,
-          nodes_selectors_stack: current_nodes_selectors_stack,
+          nodes_selectors_stack: current_nodes_selectors_stack
         }
       end
 
@@ -49,7 +49,7 @@ module HybridPlatformsConductor
       def ignore_divergent_tasks(tasks_to_ignore)
         @ignored_divergent_tasks << {
           ignored_tasks: tasks_to_ignore,
-          nodes_selectors_stack: current_nodes_selectors_stack,
+          nodes_selectors_stack: current_nodes_selectors_stack
         }
       end
 

data/lib/hybrid_platforms_conductor/config.rb

@@ -1,4 +1,5 @@
 require 'cleanroom'
+require 'hybrid_platforms_conductor/core_extensions/cleanroom/fix_kwargs'
 require 'git'
 require 'ice_cube'
 require 'hybrid_platforms_conductor/plugins'
@@ -8,7 +9,8 @@ module HybridPlatformsConductor
   # Object used to access the whole configuration
   class Config
 
-    include LoggerHelpers, Cleanroom
+    include Cleanroom
+    include LoggerHelpers
 
     class << self
 
@@ -35,6 +37,7 @@ module HybridPlatformsConductor
     # Directory of the definition of the platforms
     #   String
     attr_reader :hybrid_platforms_dir
+
     expose :hybrid_platforms_dir
 
     # List of expected failures info. Each info has the following properties:
@@ -60,7 +63,7 @@ module HybridPlatformsConductor
     # Parameters::
     # * *logger* (Logger): Logger to be used [default = Logger.new(STDOUT)]
     # * *logger_stderr* (Logger): Logger to be used for stderr [default = Logger.new(STDERR)]
-    def initialize(logger: Logger.new(STDOUT), logger_stderr: Logger.new(STDERR))
+    def initialize(logger: Logger.new($stdout), logger_stderr: Logger.new($stderr))
       init_loggers(logger, logger_stderr)
       @hybrid_platforms_dir = File.expand_path(ENV['hpc_platforms'].nil? ? '.' : ENV['hpc_platforms'])
       # Stack of the nodes selectors scopes
@@ -94,7 +97,7 @@ module HybridPlatformsConductor
       end
       # Call initializers if needed
       Config.mixin_initializers.each do |mixin_init_method|
-        self.send(mixin_init_method)
+        send(mixin_init_method)
       end
       include_config_from "#{@hybrid_platforms_dir}/hpc_config.rb"
     end
@@ -105,7 +108,7 @@ module HybridPlatformsConductor
     # * *dsl_file* (String): Path to the DSL file
     def include_config_from(dsl_file)
       log_debug "Include config from #{dsl_file}"
-      self.evaluate_file(dsl_file)
+      evaluate_file(dsl_file)
     end
     expose :include_config_from
 
@@ -116,6 +119,7 @@ module HybridPlatformsConductor
     # * *dir* (String): Directory containing the Dockerfile defining the image
     def os_image(image, dir)
       raise "OS image #{image} already defined to #{@os_images[image]}" if @os_images.key?(image)
+
       @os_images[image] = dir
     end
     expose :os_image

data/lib/hybrid_platforms_conductor/confluence.rb

@@ -34,7 +34,7 @@ module HybridPlatformsConductor
     # * *confluence_password* (String): Confluence password to be used when querying the API
     # * *logger* (Logger): Logger to be used [default = Logger.new(STDOUT)]
     # * *logger_stderr* (Logger): Logger to be used for stderr [default = Logger.new(STDERR)]
-    def initialize(confluence_url, confluence_user_name, confluence_password, logger: Logger.new(STDOUT), logger_stderr: Logger.new(STDERR))
+    def initialize(confluence_url, confluence_user_name, confluence_password, logger: Logger.new($stdout), logger_stderr: Logger.new($stderr))
       init_loggers(logger, logger_stderr)
       @confluence_url = confluence_url
       @confluence_user_name = confluence_user_name

data/lib/hybrid_platforms_conductor/connector.rb

@@ -15,8 +15,8 @@ module HybridPlatformsConductor
     # * *cmd_runner* (CmdRunner): Command executor to be used. [default: CmdRunner.new]
     # * *nodes_handler* (NodesHandler): NodesHandler to be used. [default: NodesHandler.new]
     def initialize(
-      logger: Logger.new(STDOUT),
-      logger_stderr: Logger.new(STDERR),
+      logger: Logger.new($stdout),
+      logger_stderr: Logger.new($stderr),
       config: Config.new,
       cmd_runner: CmdRunner.new,
       nodes_handler: NodesHandler.new
@@ -45,8 +45,10 @@ module HybridPlatformsConductor
       @stderr_io = stderr_io
     end
 
+    # rubocop:disable Lint/UnusedMethodArgument
     # Prepare connections to a given set of nodes.
     # Useful to prefetch metadata or open bulk connections.
+    # This method is supposed to be overridden by sub-classes (hence the rubocop exception).
     #
     # Parameters::
     # * *nodes* (Array<String>): Nodes to prepare the connection to
@@ -57,6 +59,7 @@ module HybridPlatformsConductor
     def with_connection_to(nodes, no_exception: false)
       yield nodes
     end
+    # rubocop:enable Lint/UnusedMethodArgument
 
     private
 

data/lib/hybrid_platforms_conductor/core_extensions/cleanroom/fix_kwargs.rb

@@ -0,0 +1,116 @@
+# This is a patch of cleanroom Rubygem v1.0.0 that adds kwargs support for Ruby 3.
+# TODO: Remove this patch when the following code will be merged in a new version of cleanroom:
+# https://github.com/sethvargo/cleanroom/compare/master...Muriel-Salvan:handle_kwargs?expand=1
+
+module Cleanroom
+
+  # Add kwargs support
+  module ClassMethods
+
+    #
+    # Expose the given method to the DSL.
+    #
+    # @param [Symbol] name
+    #
+    def expose(name)
+      raise NameError, "undefined method `#{name}' for class `#{self.name}'" unless public_method_defined?(name)
+
+      exposed_methods_with_kwargs[name] = true if instance_method(name).parameters.any? { |(arg_type, _arg_name)| KWARGS_TYPES.include?(arg_type) }
+      exposed_methods[name] = true
+    end
+
+    private
+
+    # Define the types of argument types that point kwargs arguments.
+    # Useful to treat them differently as when defining a method with kwargs, Ruby will pass parameters having a to_hash method differently to such methods:
+    #
+    # See this example illustrating the difference in treatment with and without kwargs in the method definition:
+    # def without_kwargs(*args)
+    #   p args
+    # end
+    # def with_kwargs(*args, **kwargs)
+    #   p args
+    #   p kwargs
+    # end
+    # s_without_to_hash = 'Without to_hash'
+    # s_with_to_hash = 'With to_hash'
+    # s_with_to_hash.define_singleton_method(:to_hash) { { string: self.to_s } }
+    # without_kwargs(s_without_to_hash)
+    #   ["Without to_hash"]
+    # without_kwargs(s_with_to_hash)
+    #   ["With to_hash"]
+    # with_kwargs(s_without_to_hash)
+    #   ["Without to_hash"]
+    #   {}
+    # with_kwargs(s_with_to_hash)
+    #   []
+    #   {:string=>"With to_hash"}
+    KWARGS_TYPES = %i[key keyreq]
+
+    #
+    # The list of exposed methods with kwargs.
+    #
+    # @return [Hash]
+    #
+    def exposed_methods_with_kwargs
+      @exposed_methods_with_kwargs ||= from_superclass(:exposed_methods_with_kwargs, {}).dup
+    end
+
+    #
+    # The cleanroom instance for this class. This method is intentionally
+    # NOT cached!
+    #
+    # @return [Class]
+    #
+    def cleanroom
+      exposed = exposed_methods.keys
+      exposed_with_kwargs = exposed_methods_with_kwargs.keys
+      parent = name || 'Anonymous'
+
+      Class.new(Object) do
+        class << self
+
+          def class_eval
+            raise Cleanroom::InaccessibleError.new(:class_eval, self)
+          end
+
+          def instance_eval
+            raise Cleanroom::InaccessibleError.new(:instance_eval, self)
+          end
+
+        end
+
+        define_method(:initialize) do |instance|
+          define_singleton_method(:__instance__) do
+            raise Cleanroom::InaccessibleError.new(:__instance__, self) unless caller[0].include?(__FILE__)
+
+            instance
+          end
+        end
+
+        (exposed - exposed_with_kwargs).each do |exposed_method|
+          define_method(exposed_method) do |*args, &block|
+            __instance__.public_send(exposed_method, *args, &block)
+          end
+        end
+
+        exposed_with_kwargs.each do |exposed_method|
+          define_method(exposed_method) do |*args, **kwargs, &block|
+            __instance__.public_send(exposed_method, *args, **kwargs, &block)
+          end
+        end
+
+        define_method(:class_eval) do
+          raise Cleanroom::InaccessibleError.new(:class_eval, self)
+        end
+
+        define_method(:inspect) do
+          "#<#{parent} (Cleanroom)>"
+        end
+        alias_method :to_s, :inspect
+      end
+    end
+
+  end
+
+end

data/lib/hybrid_platforms_conductor/core_extensions/symbol/zero.rb

@@ -0,0 +1,24 @@
+module HybridPlatformsConductor
+
+  module CoreExtensions
+
+    module Symbol
+
+      # As it is better to test status code 0 with zero? and as we use status codes as symbols in case of errors, make the zero? call return appropriately.
+      module Zero
+
+        # Does the symbol equal zero?
+        #
+        # Result::
+        # * false: It does not.
+        def zero?
+          false
+        end
+
+      end
+
+    end
+
+  end
+
+end