hybrid_platforms_conductor 33.0.1 → 33.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 557dadbcc02ee1031ca9a68fcbb1093c8760bfa171213a069f8e312a555f3c6d
-  data.tar.gz: 354d4948c3acc65fccbd227baf1b43a9b6950b27ecb7296b030997ea585bff84
+  metadata.gz: 8698bc386b9a607d4dda6b8a21ee754860b8027a26f851be1887ec8bbe3aaa96
+  data.tar.gz: ddb3c31da1f23113755fcfc07d97785b0ddc03611922568401043405e50014e8
 SHA512:
-  metadata.gz: 61b623a49511b2e649386cb5b8fdcd2ef0535578a88a4e3972597de378a1172bbfc3365f14264d49c0917ec9419b140b5f53ef2c390fc95c8b43ac821b6fc798
-  data.tar.gz: '0589c2444d2580aaf70cc27636b52984b51668ff0470ec0d1a3ebd4ea709c19856926308bffc62c60caeebe30fc5c9bdadbd8d7f2fdf373fc1b6f7422fa28bf4'
+  metadata.gz: 8076f914cd5675de3b990e78191569ba96c368c840644183c5a52f75feaa67f2b93172465595f8d6619c921c694ea16fb05eed18cc559b560f8dae7c5584fdf0
+  data.tar.gz: 42b83e310c9f03473e50c4b9694f3320126ebcbe30a4777845eecda87da4ccad78ffb7bcd99f4fb6b2e8b6f98f131052ae667389961602bb525e7e888fb71243

data/CHANGELOG.md

@@ -1,3 +1,45 @@
+# [v33.1.1](https://github.com/sweet-delights/hybrid-platforms-conductor/compare/v33.1.0...v33.1.1) (2021-06-18 13:19:39)
+
+### Patches
+
+* [[Fix] Corrected bugs on log remote_fs plugin not working in dry-run and topographer](https://github.com/sweet-delights/hybrid-platforms-conductor/commit/90dcde919b6fc99b8f79fc642fef8b4150a5a9d6)
+
+# [v33.1.0](https://github.com/sweet-delights/hybrid-platforms-conductor/compare/v33.0.4...v33.1.0) (2021-06-18 11:37:28)
+
+## Global changes
+### Patches
+
+* [[Feature(connector_local)] [#68] Add sudo support when copying files using the local connector](https://github.com/sweet-delights/hybrid-platforms-conductor/commit/7725beca4429de0e81bcac0c0ac4fe149e625da2)
+
+## Changes for connector_local
+### Features
+
+* [[Feature(connector_local)] [#68] Add sudo support when copying files using the local connector](https://github.com/sweet-delights/hybrid-platforms-conductor/commit/7725beca4429de0e81bcac0c0ac4fe149e625da2)
+
+# [v33.0.4](https://github.com/sweet-delights/hybrid-platforms-conductor/compare/v33.0.3...v33.0.4) (2021-06-18 10:09:57)
+
+## Global changes
+### Patches
+
+* [[Fix(cmd_runner)] [#69] Make sure commands are run in unbundled env](https://github.com/sweet-delights/hybrid-platforms-conductor/commit/0795c1ffdcf1b355c9dc91423bb6b7d88918fcf7)
+
+## Changes for cmd_runner
+### Patches
+
+* [[Fix(cmd_runner)] [#69] Make sure commands are run in unbundled env](https://github.com/sweet-delights/hybrid-platforms-conductor/commit/0795c1ffdcf1b355c9dc91423bb6b7d88918fcf7)
+
+# [v33.0.3](https://github.com/sweet-delights/hybrid-platforms-conductor/compare/v33.0.2...v33.0.3) (2021-06-17 12:42:32)
+
+### Patches
+
+* [[#49] Corrected minor warnings and added tests that no warning occurs anymore in rspec](https://github.com/sweet-delights/hybrid-platforms-conductor/commit/57e9936da05431ca469a98d7f079211d9278574f)
+
+# [v33.0.2](https://github.com/sweet-delights/hybrid-platforms-conductor/compare/v33.0.1...v33.0.2) (2021-06-17 11:15:29)
+
+### Patches
+
+* [[#49] Corrected warnings to prepare migration to Ruby 3](https://github.com/sweet-delights/hybrid-platforms-conductor/commit/8f3e758a881dcd988540d660b2df8a38fe39d1ca)
+
 # [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

data/lib/hybrid_platforms_conductor/cmd_runner.rb

@@ -130,18 +130,20 @@ module HybridPlatformsConductor
               (log_to_stdout ? [@logger_stderr] : []) +
               (file_output.nil? ? [] : [file_output])
           ) do
-            cmd_result = TTY::Command.new(
-              printer: :null,
-              pty: true,
-              timeout: timeout,
-              uuid: false
-            ).run!(cmd) do |stdout, stderr|
-              stdout_queue << stdout if stdout
-              stderr_queue << stderr if stderr
+            Bundler.with_unbundled_env do
+              cmd_result = TTY::Command.new(
+                printer: :null,
+                pty: true,
+                timeout: timeout,
+                uuid: false
+              ).run!(cmd) do |stdout, stderr|
+                stdout_queue << stdout if stdout
+                stderr_queue << stderr if stderr
+              end
+              exit_status = cmd_result.exit_status
+              cmd_stdout = cmd_result.out
+              cmd_stderr = cmd_result.err
             end
-            exit_status = cmd_result.exit_status
-            cmd_stdout = cmd_result.out
-            cmd_stderr = cmd_result.err
           end
         rescue TTY::Command::TimeoutExceeded
           exit_status = :timeout

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'

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/deployer.rb

@@ -5,7 +5,6 @@ require 'securerandom'
 require 'time'
 require 'hybrid_platforms_conductor/actions_executor'
 require 'hybrid_platforms_conductor/cmd_runner'
-require 'hybrid_platforms_conductor/executable'
 require 'hybrid_platforms_conductor/logger_helpers'
 require 'hybrid_platforms_conductor/nodes_handler'
 require 'hybrid_platforms_conductor/services_handler'
@@ -147,6 +146,7 @@ module HybridPlatformsConductor
             logger: @logger,
             logger_stderr: @logger_stderr,
             config: @config,
+            cmd_runner: @cmd_runner,
             nodes_handler: @nodes_handler,
             actions_executor: @actions_executor
           )

data/lib/hybrid_platforms_conductor/hpc_plugins/connector/local.rb

@@ -50,7 +50,9 @@ module HybridPlatformsConductor
         # [API] - @stdout_io can be used to send stdout output
         # [API] - @stderr_io can be used to send stderr output
         def remote_interactive
-          system "cd #{workspace_for(@node)} ; /bin/bash"
+          Bundler.with_unbundled_env do
+            system "cd #{workspace_for(@node)} ; /bin/bash"
+          end
         end
 
         # rubocop:disable Lint/UnusedMethodArgument
@@ -73,7 +75,11 @@ module HybridPlatformsConductor
         def remote_copy(from, to, sudo: false, owner: nil, group: nil)
           # If the destination is a relative path, prepend the workspace dir to it.
           to = "#{workspace_for(@node)}/#{to}" unless to.start_with?('/')
-          FileUtils.cp_r from, to
+          if sudo
+            run_cmd "#{@nodes_handler.sudo_on(@node)} cp -r \"#{from}\" \"#{to}\""
+          else
+            FileUtils.cp_r from, to unless @cmd_runner.dry_run
+          end
         end
         # rubocop:enable Lint/UnusedMethodArgument
 

data/lib/hybrid_platforms_conductor/hpc_plugins/log/remote_fs.rb

@@ -121,7 +121,9 @@ module HybridPlatformsConductor
           # ...
           # ===== STDERR =====
           # ...
-          if exit_status.is_a?(Symbol)
+          if @cmd_runner.dry_run
+            { error: 'No log to show in dry-run mode' }
+          elsif exit_status.is_a?(Symbol)
             { error: "Error: #{exit_status}\n#{stderr}" }
           else
             stdout_lines = stdout.split("\n")

data/lib/hybrid_platforms_conductor/hpc_plugins/platform_handler/serverless_chef.rb

@@ -74,18 +74,16 @@ module HybridPlatformsConductor
         # [API] - @cmd_runner is accessible.
         def setup
           required_version = YAML.load_file("#{@repository_path}/chef_versions.yml")['workstation']
-          Bundler.with_unbundled_env do
-            exit_status, stdout, _stderr = @cmd_runner.run_cmd '/opt/chef-workstation/bin/chef --version', expected_code: [0, :command_error]
-            existing_version =
-              if exit_status == :command_error
-                'not installed'
-              else
-                expected_match = stdout.match(/^Chef Workstation version: (.+)\.\d+$/)
-                expected_match.nil? ? 'unreadable' : expected_match[1]
-              end
-            log_debug "Current Chef version: #{existing_version}. Required version: #{required_version}"
-            @cmd_runner.run_cmd "curl -L https://omnitruck.chef.io/install.sh | #{@cmd_runner.root? ? '' : 'sudo '}bash -s -- -P chef-workstation -v #{required_version}" unless existing_version == required_version
-          end
+          exit_status, stdout, _stderr = @cmd_runner.run_cmd '/opt/chef-workstation/bin/chef --version', expected_code: [0, :command_error]
+          existing_version =
+            if exit_status == :command_error
+              'not installed'
+            else
+              expected_match = stdout.match(/^Chef Workstation version: (.+)\.\d+$/)
+              expected_match.nil? ? 'unreadable' : expected_match[1]
+            end
+          log_debug "Current Chef version: #{existing_version}. Required version: #{required_version}"
+          @cmd_runner.run_cmd "curl -L https://omnitruck.chef.io/install.sh | #{@cmd_runner.root? ? '' : 'sudo '}bash -s -- -P chef-workstation -v #{required_version}" unless existing_version == required_version
         end
 
         # Get the list of known nodes.
@@ -160,27 +158,25 @@ module HybridPlatformsConductor
             current_package_info = File.exist?(package_info_file) ? JSON.parse(File.read(package_info_file)).transform_keys(&:to_sym) : {}
             next if current_package_info == package_info
 
-            Bundler.with_unbundled_env do
-              policy_file = "policyfiles/#{service}.rb"
-              if local_environment
-                local_policy_file = "policyfiles/#{service}.local.rb"
-                # In local mode, we always regenerate the lock file as we may modify the run list
-                run_list = known_cookbook_paths.any? { |cookbook_path| File.exist?("#{@repository_path}/#{cookbook_path}/hpc_test/recipes/before_run.rb") } ? ['hpc_test::before_run'] : []
-                dsl_parser = DslParser.new
-                dsl_parser.parse("#{@repository_path}/#{policy_file}")
-                run_list.concat dsl_parser.calls.find { |call_info| call_info[:method] == :run_list }[:args].flatten
-                run_list << 'hpc_test::after_run' if known_cookbook_paths.any? { |cookbook_path| File.exist?("#{@repository_path}/#{cookbook_path}/hpc_test/recipes/after_run.rb") }
-                File.write("#{@repository_path}/#{local_policy_file}", File.read("#{@repository_path}/#{policy_file}") + "\nrun_list #{run_list.map { |recipe| "'#{recipe}'" }.join(', ')}\n")
-                policy_file = local_policy_file
-              end
-              lock_file = "#{File.dirname(policy_file)}/#{File.basename(policy_file, '.rb')}.lock.json"
-              # If the policy lock file does not exist, generate it
-              @cmd_runner.run_cmd "cd #{@repository_path} && /opt/chef-workstation/bin/chef install #{policy_file} --chef-license accept" unless File.exist?("#{@repository_path}/#{lock_file}")
-              extra_cp_data_bags = File.exist?("#{@repository_path}/data_bags") ? " && cp -ar data_bags/ #{package_dir}/" : ''
-              @cmd_runner.run_cmd "cd #{@repository_path} && \
-                #{@cmd_runner.root? ? '' : 'sudo '}rm -rf #{package_dir} && \
-                /opt/chef-workstation/bin/chef export #{policy_file} #{package_dir} --chef-license accept#{extra_cp_data_bags}"
+            policy_file = "policyfiles/#{service}.rb"
+            if local_environment
+              local_policy_file = "policyfiles/#{service}.local.rb"
+              # In local mode, we always regenerate the lock file as we may modify the run list
+              run_list = known_cookbook_paths.any? { |cookbook_path| File.exist?("#{@repository_path}/#{cookbook_path}/hpc_test/recipes/before_run.rb") } ? ['hpc_test::before_run'] : []
+              dsl_parser = DslParser.new
+              dsl_parser.parse("#{@repository_path}/#{policy_file}")
+              run_list.concat dsl_parser.calls.find { |call_info| call_info[:method] == :run_list }[:args].flatten
+              run_list << 'hpc_test::after_run' if known_cookbook_paths.any? { |cookbook_path| File.exist?("#{@repository_path}/#{cookbook_path}/hpc_test/recipes/after_run.rb") }
+              File.write("#{@repository_path}/#{local_policy_file}", File.read("#{@repository_path}/#{policy_file}") + "\nrun_list #{run_list.map { |recipe| "'#{recipe}'" }.join(', ')}\n")
+              policy_file = local_policy_file
             end
+            lock_file = "#{File.dirname(policy_file)}/#{File.basename(policy_file, '.rb')}.lock.json"
+            # If the policy lock file does not exist, generate it
+            @cmd_runner.run_cmd "cd #{@repository_path} && /opt/chef-workstation/bin/chef install #{policy_file} --chef-license accept" unless File.exist?("#{@repository_path}/#{lock_file}")
+            extra_cp_data_bags = File.exist?("#{@repository_path}/data_bags") ? " && cp -ar data_bags/ #{package_dir}/" : ''
+            @cmd_runner.run_cmd "cd #{@repository_path} && \
+              #{@cmd_runner.root? ? '' : 'sudo '}rm -rf #{package_dir} && \
+              /opt/chef-workstation/bin/chef export #{policy_file} #{package_dir} --chef-license accept#{extra_cp_data_bags}"
             next if @cmd_runner.dry_run
 
             # Create secrets file

data/lib/hybrid_platforms_conductor/hpc_plugins/provisioner/proxmox.rb

@@ -221,7 +221,7 @@ module HybridPlatformsConductor
         #   * *:exited*: The instance has run and is now stopped
         #   * *:error*: The instance is in error
         def state
-          if @lxc_details.nil?
+          if !defined?(@lxc_details) || @lxc_details.nil?
             :missing
           else
             status = nil

data/lib/hybrid_platforms_conductor/log.rb

@@ -12,16 +12,19 @@ module HybridPlatformsConductor
     # * *logger* (Logger): Logger to be used [default: Logger.new(STDOUT)]
     # * *logger_stderr* (Logger): Logger to be used for stderr [default: Logger.new(STDERR)]
     # * *config* (Config): Config to be used. [default: Config.new]
+    # * *cmd_runner* (CmdRunner): CmdRunner to be used [default: CmdRunner.new]
     # * *nodes_handler* (NodesHandler): Nodes handler to be used. [default: NodesHandler.new]
     # * *actions_executor* (ActionsExecutor): Actions executor to be used. [default: ActionsExecutor.new]
     def initialize(
       logger: Logger.new($stdout),
       logger_stderr: Logger.new($stderr),
       config: Config.new,
+      cmd_runner: CmdRunner.new,
       nodes_handler: NodesHandler.new,
       actions_executor: ActionsExecutor.new
     )
       super(logger: logger, logger_stderr: logger_stderr, config: config)
+      @cmd_runner = cmd_runner
       @nodes_handler = nodes_handler
       @actions_executor = actions_executor
     end

data/lib/hybrid_platforms_conductor/topographer.rb

@@ -304,7 +304,8 @@ module HybridPlatformsConductor
 
     # Define clusters of ips with 24 bits ranges.
     def define_clusters_ip_24
-      @nodes_graph.each_key do |node_name|
+      # Clone keys as we modify the hash in the loop
+      @nodes_graph.keys.clone.each do |node_name|
         next unless @nodes_graph[node_name][:type] == :node && !@node_metadata[node_name][:private_ips].nil? && !@node_metadata[node_name][:private_ips].empty?
 
         ip_24 = "#{@node_metadata[node_name][:private_ips].first.split('.')[0..2].join('.')}.0/24"

data/lib/hybrid_platforms_conductor/version.rb

@@ -1,5 +1,5 @@
 module HybridPlatformsConductor
 
-  VERSION = '33.0.1'
+  VERSION = '33.1.1'
 
 end

data/spec/hybrid_platforms_conductor_test.rb

@@ -6,6 +6,7 @@ require 'hybrid_platforms_conductor/actions_executor'
 require 'hybrid_platforms_conductor/cmd_runner'
 require 'hybrid_platforms_conductor/credentials'
 require 'hybrid_platforms_conductor/deployer'
+require 'hybrid_platforms_conductor/executable'
 require 'hybrid_platforms_conductor/log'
 require 'hybrid_platforms_conductor/nodes_handler'
 require 'hybrid_platforms_conductor/platform_handler'
@@ -160,6 +161,23 @@ module HybridPlatformsConductorTest
           }
         )
       end
+
+      config.around do |example|
+        # Make sure we activate warnings for the example to be run
+        org_warnings = false
+        RSpec.configure do |rspec_config|
+          org_warnings = rspec_config.warnings?
+          rspec_config.warnings = true
+        end
+        begin
+          expect { example.run }.not_to output.to_stderr
+        ensure
+          RSpec.configure do |rspec_config|
+            rspec_config.warnings = org_warnings
+          end
+        end
+      end
+
     end
 
     private

data/spec/hybrid_platforms_conductor_test/api/actions_executor/actions/bash_spec.rb

@@ -6,8 +6,10 @@ describe HybridPlatformsConductor::ActionsExecutor do
       with_test_platform_for_action_plugins do |repository|
         expect(
           test_actions_executor.execute_actions(
-            'node' => {
-              bash: "echo TestContent >#{repository}/test_file ; echo TestStdout ; echo TestStderr 1>&2"
+            {
+              'node' => {
+                bash: "echo TestContent >#{repository}/test_file ; echo TestStdout ; echo TestStderr 1>&2"
+              }
             }
           )['node']
         ).to eq [0, "TestStdout\n", "TestStderr\n"]

data/spec/hybrid_platforms_conductor_test/api/actions_executor/actions/interactive_spec.rb

@@ -4,7 +4,7 @@ describe HybridPlatformsConductor::ActionsExecutor do
 
     it 'executes remote interactive session' do
       with_test_platform_for_action_plugins do
-        test_actions_executor.execute_actions('node' => { interactive: true })
+        test_actions_executor.execute_actions({ 'node' => { interactive: true } })
         expect(test_actions_executor.connector(:test_connector).calls).to eq [
           [:connectable_nodes_from, ['node']],
           [:with_connection_to, ['node'], { no_exception: true }],