hybrid_platforms_conductor 33.0.0 → 33.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae17e600c52586447071f6f463ee1525754327c0be4a147bec7d3ebcb13b018d
-  data.tar.gz: 9e4dc83a6d37fc9c17b99fd9a16eae20b73673dd492dde52679a159ed922a3d5
+  metadata.gz: 557dadbcc02ee1031ca9a68fcbb1093c8760bfa171213a069f8e312a555f3c6d
+  data.tar.gz: 354d4948c3acc65fccbd227baf1b43a9b6950b27ecb7296b030997ea585bff84
 SHA512:
-  metadata.gz: d9b89fc3f6ed1fe6e87f23aa1519b32dc62bdcf861b0332088909b1ac8945adf273425c97860c0df5131069921c6adfed60d265cbfe9c1d50a6e4cd5099cc420
-  data.tar.gz: d9b3d6d66250552aaec66672b2b9fc97843eb39fc5578a34b74c44f9a4511bccf7978ef59559a4a21b276557e6293418e3350b8151308000d478e22aba84ab56
+  metadata.gz: 61b623a49511b2e649386cb5b8fdcd2ef0535578a88a4e3972597de378a1172bbfc3365f14264d49c0917ec9419b140b5f53ef2c390fc95c8b43ac821b6fc798
+  data.tar.gz: '0589c2444d2580aaf70cc27636b52984b51668ff0470ec0d1a3ebd4ea709c19856926308bffc62c60caeebe30fc5c9bdadbd8d7f2fdf373fc1b6f7422fa28bf4'

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# [v33.0.1](https://github.com/sweet-delights/hybrid-platforms-conductor/compare/v33.0.0...v33.0.1) (2021-06-16 16:22:41)
+
+### Patches
+
+* [[#49] Added lint checks in CI and corrected all non acceptable lint errors](https://github.com/sweet-delights/hybrid-platforms-conductor/commit/b3188532e679f845f66966e7c8054ce8db63be26)
+
 # [v33.0.0](https://github.com/sweet-delights/hybrid-platforms-conductor/compare/v32.18.0...v33.0.0) (2021-06-15 16:10:47)
 
 ### Breaking changes

data/bin/check-node

@@ -12,7 +12,6 @@ executable = HybridPlatformsConductor::Executable.new(
   end
 end
 nodes_handler = executable.nodes_handler
-actions_executor = executable.actions_executor
 deployer = executable.deployer
 
 executable.parse_options!

data/bin/deploy

@@ -2,7 +2,6 @@
 require 'hybrid_platforms_conductor/executable'
 
 executable = HybridPlatformsConductor::Executable.new
-actions_executor = executable.actions_executor
 deployer = executable.deployer
 
 executable.parse_options!

data/bin/get_impacted_nodes

@@ -22,7 +22,6 @@ executable = HybridPlatformsConductor::Executable.new(nodes_selection_options: f
 end
 nodes_handler = executable.nodes_handler
 platforms_handler = executable.platforms_handler
-cmd_runner = executable.cmd_runner
 executable.parse_options!
 raise 'No platform specified. Please use --platform option' if platform.nil?
 

data/bin/last_deploys

@@ -8,12 +8,12 @@ possible_string_sorts = %i[
   node
   user
 ]
-possible_sorts = Hash[possible_string_sorts.map do |property_name|
+possible_sorts = possible_string_sorts.map do |property_name|
   [
     property_name,
     proc { |node, deploy_info| [deploy_info.key?(:error) || !deploy_info.key?(property_name) ? '' : deploy_info[property_name], node] }
   ]
-end]
+end.to_h
 
 sort_by = :node
 sort_desc = false
@@ -21,7 +21,7 @@ executable = HybridPlatformsConductor::Executable.new(deploy_options: false) do
   opts.on('-r', '--sort-by SORT', "Specify a sort. Possible values are: #{possible_sorts.keys.sort.join(', ')}. Each value can append _desc to specify a reverse sorting. Defaults to #{sort_by}.") do |sort_name|
     if sort_name =~ /^(.+)_desc$/
       sort_desc = true
-      sort_name = $1
+      sort_name = Regexp.last_match(1)
     end
     sort_by = sort_name.to_sym
   end
@@ -32,8 +32,8 @@ deployer = executable.deployer
 executable.parse_options!
 raise "Unknown sort name: #{sort_by}. Should be one of #{possible_sorts.keys.join(', ')}." unless possible_sorts.key?(sort_by)
 
-sorted_deploy_info = Hash[
-  deployer.deployment_info_from(nodes_handler.select_nodes(executable.selected_nodes.empty? ? [{ all: true }] : executable.selected_nodes)).
+sorted_deploy_info = deployer.
+  deployment_info_from(nodes_handler.select_nodes(executable.selected_nodes.empty? ? [{ all: true }] : executable.selected_nodes)).
   map do |node, deploy_info|
     decorated_deploy_info = deploy_info.merge(node: node)
     if deploy_info.key?(:deployment_info)
@@ -42,8 +42,9 @@ sorted_deploy_info = Hash[
     end
     decorated_deploy_info[:services] = deploy_info[:services].join(', ') if deploy_info.key?(:services)
     [node, decorated_deploy_info]
-  end
-].sort_by(&possible_sorts[sort_by])
+  end.
+  to_h.
+  sort_by(&possible_sorts[sort_by])
 sorted_deploy_info.reverse! if sort_desc
 info_displayed = {
   node: 'Node',

data/bin/nodes_to_deploy

@@ -21,7 +21,7 @@ deployer = executable.deployer
 
 executable.parse_options!
 
-nodes = (nodes_handler.select_nodes(executable.selected_nodes.empty? ? [{ all: true }] : executable.selected_nodes))
+nodes = nodes_handler.select_nodes(executable.selected_nodes.empty? ? [{ all: true }] : executable.selected_nodes)
 
 unless ignore_schedule
   # Select nodes to be deployed, based first on deployment schedule
@@ -67,7 +67,7 @@ unless ignore_deploy_info
       node_impacted = false
       # Loop over all possible repositories concerned by this deployment
       repo_idx = 0
-      while node_deploy_info[:deployment_info].key?("repo_name_#{repo_idx}".to_sym) do
+      while node_deploy_info[:deployment_info].key?("repo_name_#{repo_idx}".to_sym)
         repo_name = node_deploy_info[:deployment_info]["repo_name_#{repo_idx}".to_sym]
         commit_id = node_deploy_info[:deployment_info]["commit_id_#{repo_idx}".to_sym]
         impacted_nodes = cache_impacted_nodes.dig(repo_name, commit_id)

data/bin/setup

@@ -7,10 +7,10 @@ platforms_handler = executable.platforms_handler
 executable.parse_options!
 
 platforms_handler.known_platforms.each do |platform|
-  if platform.respond_to?(:setup)
-    executable.out "===== Setup platform #{platform.name}..."
-    platform.setup
-    executable.out "===== Platform #{platform.name} setup successfully."
-    executable.out ''
-  end
+  next unless platform.respond_to?(:setup)
+
+  executable.out "===== Setup platform #{platform.name}..."
+  platform.setup
+  executable.out "===== Platform #{platform.name} setup successfully."
+  executable.out ''
 end

data/bin/topograph

@@ -17,7 +17,7 @@ executable.parse_options!
 
 # Initialize the topograph
 from_nodes, to_nodes = topographer.resolve_from_to
-topographer.get_json_files
+topographer.json_files
 
 # The list of clusters to group nodes into 1 graphviz node to simplify the graph.
 known_nodes_lists = nodes_handler.known_nodes_lists

data/lib/hybrid_platforms_conductor/action.rb

@@ -16,8 +16,8 @@ module HybridPlatformsConductor
     # * *actions_executor* (ActionsExecutor): Actions Executor to be used. [default: ActionsExecutor.new]
     # * *action_info* (Object or nil): Action info needed to setup the action, or nil if none [default: nil]
     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,
       actions_executor: ActionsExecutor.new,
@@ -27,7 +27,7 @@ module HybridPlatformsConductor
       @cmd_runner = cmd_runner
       @actions_executor = actions_executor
       @action_info = action_info
-      setup(@action_info) if self.respond_to?(:setup)
+      setup(@action_info) if respond_to?(:setup)
     end
 
     # Do we need a connector to execute this action on a node?
@@ -53,7 +53,7 @@ module HybridPlatformsConductor
       @timeout = timeout
       @stdout_io = stdout_io
       @stderr_io = stderr_io
-      @connector.prepare_for(@node, @timeout, @stdout_io, @stderr_io) if @connector
+      @connector&.prepare_for(@node, @timeout, @stdout_io, @stderr_io)
     end
 
     private

data/lib/hybrid_platforms_conductor/actions_executor.rb

@@ -35,7 +35,7 @@ module HybridPlatformsConductor
     # * *config* (Config): Config to be used. [default = Config.new]
     # * *cmd_runner* (CmdRunner): Command runner to be used. [default = CmdRunner.new]
     # * *nodes_handler* (NodesHandler): Nodes handler to be used. [default = NodesHandler.new]
-    def initialize(logger: Logger.new(STDOUT), logger_stderr: Logger.new(STDERR), config: Config.new, cmd_runner: CmdRunner.new, nodes_handler: NodesHandler.new)
+    def initialize(logger: Logger.new($stdout), logger_stderr: Logger.new($stderr), config: Config.new, cmd_runner: CmdRunner.new, nodes_handler: NodesHandler.new)
       init_loggers(logger, logger_stderr)
       @config = config
       @cmd_runner = cmd_runner
@@ -74,17 +74,17 @@ module HybridPlatformsConductor
       end
       # Display options connectors might have
       @connector_plugins.each do |connector_name, connector|
-        if connector.respond_to?(:options_parse)
-          options_parser.separator ''
-          options_parser.separator "Connector #{connector_name} options:"
-          connector.options_parse(options_parser)
-        end
+        next unless connector.respond_to?(:options_parse)
+
+        options_parser.separator ''
+        options_parser.separator "Connector #{connector_name} options:"
+        connector.options_parse(options_parser)
       end
     end
 
     # Validate that parsed parameters are valid
     def validate_params
-      @connector_plugins.values.each do |connector|
+      @connector_plugins.each_value do |connector|
         connector.validate_params if connector.respond_to?(:validate_params)
       end
     end
@@ -124,6 +124,7 @@ module HybridPlatformsConductor
           nodes_actions_set.each do |action_type, action_info|
             raise 'Cannot have concurrent executions for interactive sessions' if concurrent && action_type == :interactive && action_info
             raise "Unknown action type #{action_type}" unless @action_plugins.key?(action_type)
+
             action = @action_plugins[action_type].new(
               logger: @logger,
               logger_stderr: @logger_stderr,
@@ -144,7 +145,7 @@ module HybridPlatformsConductor
           actions_per_node[node].concat(resolved_nodes_actions)
         end
       end
-      result = Hash[actions_per_node.keys.map { |node| [node, nil] }]
+      result = actions_per_node.keys.map { |node| [node, nil] }.to_h
       with_connections_prepared_to(nodes_needing_connectors, no_exception: true) do |connected_nodes|
         missing_nodes = []
         connected_nodes.each do |node, connector|
@@ -158,7 +159,7 @@ module HybridPlatformsConductor
         # Prepare the result (stdout or nil per node)
         unless accessible_nodes.empty?
           # If we run in parallel then clone the connectors, so that each node has its own instance for thread-safe code.
-          connected_nodes = Hash[connected_nodes.map { |node, connector| [node, connector.clone] }] if concurrent
+          connected_nodes = connected_nodes.transform_values(&:clone) if concurrent
           @nodes_handler.for_each_node_in(
             accessible_nodes,
             parallel: concurrent,
@@ -192,10 +193,11 @@ module HybridPlatformsConductor
     #     * *connected_nodes* (Hash<String, Connector or Symbol>): Prepared connectors (or Symbol in case of failure with no_exception), per node name
     def with_connections_prepared_to(nodes, no_exception: false)
       # Make sure every node needing connectors finds a connector
-      nodes_needing_connectors = Hash[nodes.map { |node| [node, nil] }]
-      @connector_plugins.each do |connector_name, connector|
+      nodes_needing_connectors = nodes.map { |node| [node, nil] }.to_h
+      @connector_plugins.each_value do |connector|
         nodes_without_connectors = nodes_needing_connectors.select { |_node, selected_connector| selected_connector.nil? }.keys
         break if nodes_without_connectors.empty?
+
         (connector.connectable_nodes_from(nodes_without_connectors) & nodes_without_connectors).each do |node|
           nodes_needing_connectors[node] = connector if nodes_needing_connectors[node].nil?
         end
@@ -213,23 +215,20 @@ module HybridPlatformsConductor
         if connector_name.nil?
           # All plugins have been prepared.
           # Call our client code.
-          yield Hash[nodes_needing_connectors.map do |node, selected_connector|
-            [
-              node,
-              selected_connector.nil? ? :no_connector : selected_connector
-            ]
-          end]
+          yield(nodes_needing_connectors.transform_values do |selected_connector|
+            selected_connector.nil? ? :no_connector : selected_connector
+          end)
         else
           connector = @connector_plugins[connector_name]
           selected_nodes = nodes_needing_connectors.select { |_node, selected_connector| selected_connector == connector }.keys
           if selected_nodes.empty?
-            preparation_code.call(remaining_plugins_to_prepare[1..-1])
+            preparation_code.call(remaining_plugins_to_prepare[1..])
           else
             connector.with_connection_to(selected_nodes, no_exception: no_exception) do |connected_nodes|
               (selected_nodes - connected_nodes).each do |node_in_error|
                 nodes_needing_connectors[node_in_error] = :connection_error
               end
-              preparation_code.call(remaining_plugins_to_prepare[1..-1])
+              preparation_code.call(remaining_plugins_to_prepare[1..])
             end
           end
         end
@@ -269,8 +268,6 @@ module HybridPlatformsConductor
         if log_to_file
           FileUtils.mkdir_p(File.dirname(log_to_file))
           File.open(log_to_file, 'w')
-        else
-          nil
         end
       stdout_queue = Queue.new
       stderr_queue = Queue.new
@@ -284,28 +281,26 @@ module HybridPlatformsConductor
           (log_to_stdout ? [@logger_stderr] : []) +
           (file_output.nil? ? [] : [file_output])
       ) do
-        begin
-          log_debug "[#{node}] - Execute #{actions.size} actions on #{node}..."
-          actions.each do |action|
-            action.prepare_for(node, connector, remaining_timeout, stdout_queue, stderr_queue)
-            start_time = Time.now
-            action.execute
-            remaining_timeout -= Time.now - start_time unless remaining_timeout.nil?
-          end
-        rescue ConnectionError
-          exit_status = :connection_error
-          stderr_queue << "#{$!}\n"
-        rescue CmdRunner::UnexpectedExitCodeError
-          exit_status = :failed_command
-          stderr_queue << "#{$!}\n"
-        rescue CmdRunner::TimeoutError
-          # Error has already been logged in stderr
-          exit_status = :timeout
-        rescue
-          log_error "Uncaught exception while executing actions on #{node}: #{$!}\n#{$!.backtrace.join("\n")}"
-          stderr_queue << "#{$!}\n"
-          exit_status = :failed_action
+        log_debug "[#{node}] - Execute #{actions.size} actions on #{node}..."
+        actions.each do |action|
+          action.prepare_for(node, connector, remaining_timeout, stdout_queue, stderr_queue)
+          start_time = Time.now
+          action.execute
+          remaining_timeout -= Time.now - start_time unless remaining_timeout.nil?
         end
+      rescue ConnectionError
+        exit_status = :connection_error
+        stderr_queue << "#{$ERROR_INFO}\n"
+      rescue CmdRunner::UnexpectedExitCodeError
+        exit_status = :failed_command
+        stderr_queue << "#{$ERROR_INFO}\n"
+      rescue CmdRunner::TimeoutError
+        # Error has already been logged in stderr
+        exit_status = :timeout
+      rescue
+        log_error "Uncaught exception while executing actions on #{node}: #{$ERROR_INFO}\n#{$ERROR_INFO.backtrace.join("\n")}"
+        stderr_queue << "#{$ERROR_INFO}\n"
+        exit_status = :failed_action
       end
       [exit_status, stdout, stderr]
     end

data/lib/hybrid_platforms_conductor/bitbucket.rb

@@ -38,7 +38,7 @@ module HybridPlatformsConductor
     # * *bitbucket_password* (String): Bitbucket 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(bitbucket_url, bitbucket_user_name, bitbucket_password, logger: Logger.new(STDOUT), logger_stderr: Logger.new(STDERR))
+    def initialize(bitbucket_url, bitbucket_user_name, bitbucket_password, logger: Logger.new($stdout), logger_stderr: Logger.new($stderr))
       init_loggers(logger, logger_stderr)
       @bitbucket_url = bitbucket_url
       @bitbucket_user_name = bitbucket_user_name
@@ -106,10 +106,11 @@ module HybridPlatformsConductor
       http_response = nil
       loop do
         begin
-          http_response = URI.open(api_url, http_basic_authentication: [@bitbucket_user_name, @bitbucket_password])
+          http_response = URI.parse(api_url).open(http_basic_authentication: [@bitbucket_user_name, @bitbucket_password])
         rescue
-          raise if retries == 0
-          log_warn "Got error #{$!} on #{@bitbucket_user_name}@#{api_url}. Will retry #{retries} times..."
+          raise if retries.zero?
+
+          log_warn "Got error #{$ERROR_INFO} on #{@bitbucket_user_name}@#{api_url}. Will retry #{retries} times..."
           retries -= 1
           sleep 1
         end

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,