hybrid_platforms_conductor 32.4.2 → 32.7.2

data/spec/hybrid_platforms_conductor_test/api/actions_executor/connectors/ssh/node_helpers_spec.rb

@@ -13,7 +13,7 @@ describe HybridPlatformsConductor::ActionsExecutor do
 
       it 'provides an SSH URL that can be used by other processes to connect to this node' do
         with_test_platform_for_remote_testing do
-          expect(test_connector.ssh_url).to eq 'test_user@hpc.node'
+          expect(test_connector.ssh_url).to eq 'hpc.node'
         end
       end
 

data/spec/hybrid_platforms_conductor_test/api/actions_executor/connectors/ssh/remote_actions_spec.rb

@@ -6,7 +6,7 @@ describe HybridPlatformsConductor::ActionsExecutor do
 
       it 'executes bash commands remotely' do
         with_test_platform_for_remote_testing(
-          expected_cmds: [[/.+\/ssh test_user@hpc\.node \/bin\/bash <<'EOF'\nbash_cmd.bash\nEOF/, proc { [0, 'Bash commands executed on node', ''] }]],
+          expected_cmds: [[/.+\/ssh hpc\.node \/bin\/bash <<'EOF'\nbash_cmd.bash\nEOF/, proc { [0, 'Bash commands executed on node', ''] }]],
           expected_stdout: 'Bash commands executed on node'
         ) do
           test_connector.remote_bash('bash_cmd.bash')
@@ -17,7 +17,7 @@ describe HybridPlatformsConductor::ActionsExecutor do
         with_test_platform_for_remote_testing(
           expected_cmds: [
             [
-              /.+\/ssh test_user@hpc\.node \/bin\/bash <<'EOF'\nbash_cmd.bash\nEOF/,
+              /.+\/ssh hpc\.node \/bin\/bash <<'EOF'\nbash_cmd.bash\nEOF/,
               proc do |cmd, log_to_file: nil, log_to_stdout: true, log_stdout_to_io: nil, log_stderr_to_io: nil, expected_code: 0, timeout: nil, no_exception: false|
                 expect(timeout).to eq 5
                 [0, '', '']
@@ -33,7 +33,7 @@ describe HybridPlatformsConductor::ActionsExecutor do
       it 'executes interactive commands remotely' do
         with_test_platform_for_remote_testing do
           expect(test_connector).to receive(:system) do |cmd|
-            expect(cmd).to match /^.+\/ssh test_user@hpc\.node$/
+            expect(cmd).to match /^.+\/ssh hpc\.node$/
           end
           test_connector.remote_interactive
         end
@@ -43,7 +43,7 @@ describe HybridPlatformsConductor::ActionsExecutor do
         with_test_platform_for_remote_testing(
           expected_cmds: [
             [
-              /cd \/path\/to && tar\s+--create\s+--gzip\s+--file -\s+src.file \| \/.+\/ssh\s+test_user@hpc\.node\s+"tar\s+--extract\s+--gunzip\s+--file -\s+--directory \/remote_path\/to\/dst.dir\s+--owner root\s+"/,
+              /cd \/path\/to && tar\s+--create\s+--gzip\s+--file -\s+src.file \| \/.+\/ssh\s+hpc\.node\s+"tar\s+--extract\s+--gunzip\s+--file -\s+--directory \/remote_path\/to\/dst.dir\s+--owner root\s+"/,
               proc { [0, '', ''] }
             ]
           ]
@@ -56,7 +56,7 @@ describe HybridPlatformsConductor::ActionsExecutor do
         with_test_platform_for_remote_testing(
           expected_cmds: [
             [
-              /cd \/path\/to && tar\s+--create\s+--gzip\s+--file -\s+src.file \| \/.+\/ssh\s+test_user@hpc\.node\s+"tar\s+--extract\s+--gunzip\s+--file -\s+--directory \/remote_path\/to\/dst.dir\s+--owner root\s+"/,
+              /cd \/path\/to && tar\s+--create\s+--gzip\s+--file -\s+src.file \| \/.+\/ssh\s+hpc\.node\s+"tar\s+--extract\s+--gunzip\s+--file -\s+--directory \/remote_path\/to\/dst.dir\s+--owner root\s+"/,
               proc do |cmd, log_to_file: nil, log_to_stdout: true, log_stdout_to_io: nil, log_stderr_to_io: nil, expected_code: 0, timeout: nil, no_exception: false|
                 expect(timeout).to eq 5
                 [0, '', '']
@@ -76,7 +76,7 @@ describe HybridPlatformsConductor::ActionsExecutor do
             [
               /.+\/hpc_temp_cmds_.+\.sh$/,
               proc do |received_cmd|
-                expect(File.read(received_cmd)).to match /.+\/ssh test_user@hpc\.node \/bin\/bash <<'EOF'\n#{Regexp.escape(cmd)}\nEOF/
+                expect(File.read(received_cmd)).to match /.+\/ssh hpc\.node \/bin\/bash <<'EOF'\n#{Regexp.escape(cmd)}\nEOF/
                 [0, 'Bash commands executed on node', '']
               end
             ]
@@ -92,7 +92,7 @@ describe HybridPlatformsConductor::ActionsExecutor do
         with_test_platform_for_remote_testing(
           expected_cmds: [
             [
-              /cd \/path\/to && tar\s+--create\s+--gzip\s+--file -\s+src.file \| \/.+\/ssh\s+test_user@hpc\.node\s+"sudo tar\s+--extract\s+--gunzip\s+--file -\s+--directory \/remote_path\/to\/dst.dir\s+--owner root\s+"/,
+              /cd \/path\/to && tar\s+--create\s+--gzip\s+--file -\s+src.file \| \/.+\/ssh\s+hpc\.node\s+"sudo -u root tar\s+--extract\s+--gunzip\s+--file -\s+--directory \/remote_path\/to\/dst.dir\s+--owner root\s+"/,
               proc { [0, '', ''] }
             ]
           ]
@@ -101,11 +101,25 @@ describe HybridPlatformsConductor::ActionsExecutor do
         end
       end
 
+      it 'copies files remotely with a different sudo' do
+        with_test_platform_for_remote_testing(
+          expected_cmds: [
+            [
+              /cd \/path\/to && tar\s+--create\s+--gzip\s+--file -\s+src.file \| \/.+\/ssh\s+hpc\.node\s+"other_sudo --user root tar\s+--extract\s+--gunzip\s+--file -\s+--directory \/remote_path\/to\/dst.dir\s+--owner root\s+"/,
+              proc { [0, '', ''] }
+            ]
+          ],
+          additional_config: 'sudo_for { |user| "other_sudo --user #{user}" }'
+        ) do
+          test_connector.remote_copy('/path/to/src.file', '/remote_path/to/dst.dir', sudo: true)
+        end
+      end
+
       it 'copies files remotely with a different owner' do
         with_test_platform_for_remote_testing(
           expected_cmds: [
             [
-              /cd \/path\/to && tar\s+--create\s+--gzip\s+--file -\s+--owner remote_user\s+src.file \| \/.+\/ssh\s+test_user@hpc\.node\s+"tar\s+--extract\s+--gunzip\s+--file -\s+--directory \/remote_path\/to\/dst.dir\s+--owner root\s+"/,
+              /cd \/path\/to && tar\s+--create\s+--gzip\s+--file -\s+--owner remote_user\s+src.file \| \/.+\/ssh\s+hpc\.node\s+"tar\s+--extract\s+--gunzip\s+--file -\s+--directory \/remote_path\/to\/dst.dir\s+--owner root\s+"/,
               proc { [0, '', ''] }
             ]
           ]
@@ -118,7 +132,7 @@ describe HybridPlatformsConductor::ActionsExecutor do
         with_test_platform_for_remote_testing(
           expected_cmds: [
             [
-              /cd \/path\/to && tar\s+--create\s+--gzip\s+--file -\s+--group remote_group\s+src.file \| \/.+\/ssh\s+test_user@hpc\.node\s+"tar\s+--extract\s+--gunzip\s+--file -\s+--directory \/remote_path\/to\/dst.dir\s+--owner root\s+"/,
+              /cd \/path\/to && tar\s+--create\s+--gzip\s+--file -\s+--group remote_group\s+src.file \| \/.+\/ssh\s+hpc\.node\s+"tar\s+--extract\s+--gunzip\s+--file -\s+--directory \/remote_path\/to\/dst.dir\s+--owner root\s+"/,
               proc { [0, '', ''] }
             ]
           ]
@@ -127,6 +141,30 @@ describe HybridPlatformsConductor::ActionsExecutor do
         end
       end
 
+      it 'executes bash commands remotely without Session Exec capabilities' do
+        with_test_platform_for_remote_testing(
+          expected_cmds: [[/^\{ cat \| .+\/ssh hpc\.node -T; } <<'EOF'\nbash_cmd.bash\nEOF$/, proc { [0, 'Bash commands executed on node', ''] }]],
+          expected_stdout: 'Bash commands executed on node',
+          session_exec: false
+        ) do
+          test_connector.remote_bash('bash_cmd.bash')
+        end
+      end
+
+      it 'copies files remotely without Session Exec capabilities' do
+        with_test_platform_for_remote_testing(
+          expected_cmds: [
+            [
+              /^scp -S .+\/ssh \/path\/to\/src.file hpc\.node:\/remote_path\/to\/dst.dir$/,
+              proc { [0, '', ''] }
+            ]
+          ],
+          session_exec: false
+        ) do
+          test_connector.remote_copy('/path/to/src.file', '/remote_path/to/dst.dir')
+        end
+      end
+
     end
 
   end

data/spec/hybrid_platforms_conductor_test/api/nodes_handler/common_spec.rb

@@ -124,4 +124,32 @@ describe HybridPlatformsConductor::NodesHandler do
     end
   end
 
+    it 'computes the correct sudo for different nodes' do
+      with_test_platform(
+        {
+          nodes: {
+            'node1' => {},
+            'node2' => {},
+            'node3' => {}
+          }
+        },
+        false,
+        '
+          for_nodes(%w[node1 node2]) do
+            sudo_for { |user| "alt_sudo1 -p #{user}" }
+          end
+          for_nodes(\'node2\') do
+            sudo_for { |user| "alt_sudo2 -q #{user}" }
+          end
+        '
+      ) do
+        expect(test_nodes_handler.sudo_on('node1')).to eq 'alt_sudo1 -p root'
+        expect(test_nodes_handler.sudo_on('node1', 'test_user')).to eq 'alt_sudo1 -p test_user'
+        expect(test_nodes_handler.sudo_on('node2')).to eq 'alt_sudo2 -q root'
+        expect(test_nodes_handler.sudo_on('node2', 'test_user')).to eq 'alt_sudo2 -q test_user'
+        expect(test_nodes_handler.sudo_on('node3')).to eq 'sudo -u root'
+        expect(test_nodes_handler.sudo_on('node3', 'test_user')).to eq 'sudo -u test_user'
+      end
+    end
+
 end

data/spec/hybrid_platforms_conductor_test/api/nodes_handler/config_dsl_spec.rb

@@ -0,0 +1,71 @@
+describe HybridPlatformsConductor::NodesHandler do
+
+  context 'checking config DSL' do
+
+    it 'adds helpers for master cmdbs' do
+      with_test_platform(
+        {
+          nodes: {
+            'node1' => {},
+            'node2' => {},
+            'node3' => {}
+          }
+        },
+        false,
+        '
+          master_cmdbs(
+            test_cmdb: :property1,
+            test_cmdb2: :property2
+          )
+          for_nodes(\'node2\') do
+            master_cmdbs(test_cmdb: :property3)
+          end
+        '
+      ) do
+        register_test_cmdb(%i[test_cmdb test_cmdb2])
+        expect(test_config.cmdb_masters).to eq [
+          {
+            nodes_selectors_stack: [],
+            cmdb_masters: {
+              test_cmdb: [:property1],
+              test_cmdb2: [:property2]
+            }
+          },
+          {
+            nodes_selectors_stack: ['node2'],
+            cmdb_masters: {
+              test_cmdb: [:property3]
+            }
+          }
+        ]
+      end
+    end
+
+    it 'adds helpers for configurable sudo' do
+      with_test_platform(
+        {
+          nodes: {
+            'node1' => {},
+            'node2' => {},
+            'node3' => {}
+          }
+        },
+        false,
+        '
+          sudo_for { |user| "alt_sudo1 -p #{user}" }
+          for_nodes(\'node2\') do
+            sudo_for { |user| "alt_sudo2 -q #{user}" }
+          end
+        '
+      ) do
+        expect(test_config.sudo_procs.size).to eq 2
+        expect(test_config.sudo_procs[0][:nodes_selectors_stack]).to eq []
+        expect(test_config.sudo_procs[0][:sudo_proc].call('test_user')).to eq 'alt_sudo1 -p test_user'
+        expect(test_config.sudo_procs[1][:nodes_selectors_stack]).to eq ['node2']
+        expect(test_config.sudo_procs[1][:sudo_proc].call('test_user')).to eq 'alt_sudo2 -q test_user'
+      end
+    end
+
+  end
+
+end

data/spec/hybrid_platforms_conductor_test/executables/options/common_spec.rb

@@ -50,7 +50,8 @@ describe 'executables\' common options' do
         with_test_platform_for_common_options do
           exit_code, stdout, stderr = run executable, *(['--debug'] + default_options)
           expect(exit_code).to eq 0
-          expect(stderr).to eq ''
+          # Make sure to ignore the deployment markers from stderr.
+          expect(stderr.gsub("===== [ node1 / node1_service ] - HPC Service Check ===== Begin\n===== [ node1 / node1_service ] - HPC Service Check ===== End\n", '')).to eq ''
         end
       end
 

data/spec/hybrid_platforms_conductor_test/helpers/cmd_runner_helpers.rb

@@ -8,14 +8,27 @@ module HybridPlatformsConductorTest
       # Run expectations on the expected commands to be called.
       #
       # Parameters::
-      # * *commands* (Array< [String or Regexp, Proc] >): Expected commands that should be called on CmdRunner: the command name or regexp and the corresponding mocked code
-      #   * Parameters::
-      #     * Same parameters as CmdRunner@run_cmd
+      # * *commands* (Array<Array>): List of expected commands that should be called on CmdRunner. Each specification is a list containing those items:
+      #   * *0* (String or Regexp): The command name or regexp matching the command name
+      #   * *1* (Proc): The mocking code to be called in place of the real command:
+      #     * Parameters::
+      #       * Same parameters as CmdRunner@run_cmd
+      #     * Result::
+      #       * Same results as CmdRunner@run_cmd
+      #   * *2* (Hash): Optional hash of options. Can be ommited. [default = {}]
+      #     * *optional* (Boolean): If true then don't fail if the command to be mocked has not been called [default: false]
       # * *cmd_runner* (CmdRunner): The CmdRunner to mock [default: test_cmd_runner]
       # * Proc: Code called with the command runner mocked
       def with_cmd_runner_mocked(commands, cmd_runner: test_cmd_runner)
-        unexpected_commands = []
-        remaining_expected_commands = commands.clone
+        remaining_expected_commands = commands.map do |(expected_command, command_code, options)|
+          [
+            expected_command,
+            command_code,
+            {
+              optional: false
+            }.merge(options || {})
+          ]
+        end
         # We need to protect the access to this array as the mocked commands can be called by competing threads
         remaining_expected_commands_mutex = Mutex.new
         allow(cmd_runner).to receive(:run_cmd) do |cmd, log_to_file: nil, log_to_stdout: true, log_stdout_to_io: nil, log_stderr_to_io: nil, expected_code: 0, timeout: nil, no_exception: false|
@@ -23,7 +36,7 @@ module HybridPlatformsConductorTest
           found_command = nil
           found_command_code = nil
           remaining_expected_commands_mutex.synchronize do
-            remaining_expected_commands.delete_if do |(expected_command, command_code)|
+            remaining_expected_commands.delete_if do |(expected_command, command_code, _options)|
               break unless found_command.nil?
               if (expected_command.is_a?(String) && expected_command == cmd) || (expected_command.is_a?(Regexp) && cmd =~ expected_command)
                 found_command = expected_command
@@ -64,14 +77,19 @@ module HybridPlatformsConductorTest
             log_stderr_to_io << mocked_stderr if !mocked_stderr.empty? && !log_stderr_to_io.nil?
             [mocked_exit_status, mocked_stdout, mocked_stderr]
           else
-            logger.error "[ Mocked CmdRunner ] - !!! Unexpected command run: #{cmd}"
-            unexpected_commands << cmd
-            [:unexpected_command_to_mock, '', "Could not mock unexpected command #{cmd}"]
+            raise "Unexpected command run:\n#{cmd}\nRemaining expected commands:\n#{
+              remaining_expected_commands.map do |(expected_command, _command_code, _options)|
+                expected_command
+              end.join("\n")
+            }"
           end
         end
         yield
-        expect(unexpected_commands).to eq []
-        expect(remaining_expected_commands).to eq([]), "Expected CmdRunner commands were not run:\n#{remaining_expected_commands.map(&:first).join("\n")}"
+        expect(
+          remaining_expected_commands.select do |(_expected_command, _command_code, options)|
+            !options[:optional]
+          end
+        ).to eq([]), "Expected CmdRunner commands were not run:\n#{remaining_expected_commands.map(&:first).join("\n")}"
         # Un-mock the command runner
         allow(cmd_runner).to receive(:run_cmd).and_call_original
       end

data/spec/hybrid_platforms_conductor_test/helpers/connector_ssh_helpers.rb

@@ -10,39 +10,58 @@ module HybridPlatformsConductorTest
       # Parameters::
       # * *nodes_connections* (Hash<String, Hash<Symbol,Object> >): Nodes' connections info, per node name:
       #   * *connection* (String): Connection string (fqdn, IP...) used by SSH
+      #   * *ip* (String): IP used by SSH (can be different from connection in case of transformed SSH) [default: connection]
       #   * *user* (String): User used by SSH
       #   * *times* (Integer): Number of times this connection should be used [default: 1]
       #   * *control_master_create_error* (String or nil): Error to simulate during the SSH ControlMaster creation, or nil for none [default: nil]
       # * *with_control_master_create* (Boolean): Do we create the control master? [default: true]
       # * *with_control_master_check* (Boolean): Do we check the control master? [default: false]
       # * *with_control_master_destroy* (Boolean): Do we destroy the control master? [default: true]
+      # * *with_control_master_destroy_optional* (Boolean): If true, then consider the ControlMaster destruction to be optional [default: false]
       # * *with_strict_host_key_checking* (Boolean): Do we use strict host key checking? [default: true]
       # * *with_batch_mode* (Boolean): Do we use BatchMode when creating the control master? [default: true]
+      # * *with_session_exec* (Boolean): Do we use Sessien Exec capabilities when creating the control master? [default: true]
       # Result::
-      # * Array< [String or Regexp, Proc] >: The expected commands that should be used, and their corresponding mocked code
+      # * Array<Array>: The expected commands that should be used, and their corresponding mocked code and options
       def ssh_expected_commands_for(
         nodes_connections,
         with_control_master_create: true,
         with_control_master_check: false,
         with_control_master_destroy: true,
+        with_control_master_destroy_optional: false,
         with_strict_host_key_checking: true,
-        with_batch_mode: true
+        with_batch_mode: true,
+        with_session_exec: true
       )
         nodes_connections.map do |node, node_connection_info|
           node_connection_info[:times] = 1 unless node_connection_info.key?(:times)
           ssh_commands_once = []
           ssh_commands_per_connection = []
           if with_strict_host_key_checking
+            ip = node_connection_info[:ip] || node_connection_info[:connection]
             ssh_commands_once.concat([
               [
-                "ssh-keyscan #{node_connection_info[:connection]}",
-                proc { [0, "#{node_connection_info[:connection]} ssh-rsa fake_host_key_for_#{node_connection_info[:connection]}", ''] }
+                "ssh-keyscan #{ip}",
+                proc { [0, "#{ip} ssh-rsa fake_host_key_for_#{ip}", ''] }
               ]
             ])
           end
           if with_control_master_create
+            control_master_created = false
             ssh_commands_per_connection << [
-              /^.+\/ssh #{with_batch_mode ? '-o BatchMode=yes ' : ''}-o ControlMaster=yes -o ControlPersist=yes #{Regexp.escape(node_connection_info[:user])}@hpc\.#{Regexp.escape(node)} true$/,
+              if with_session_exec
+                /^.+\/ssh #{with_batch_mode ? '-o BatchMode=yes ' : ''}-o ControlMaster=yes -o ControlPersist=yes hpc\.#{Regexp.escape(node)} true$/
+              else
+                # Mock the user hitting enter as the Control Master will be created in another thread and the main thread waits for user input.
+                expect($stdin).to receive(:gets) do
+                  # We have to wait for the Control Master creation thread to actually create the Control Master before hitting Enter.
+                  while !control_master_created do
+                    sleep 0.1
+                  end
+                  "\n"
+                end
+                /^xterm -e '.+\/ssh -o ControlMaster=yes -o ControlPersist=yes hpc\.#{Regexp.escape(node)}'$/
+              end,
               proc do
                 control_file = test_actions_executor.connector(:ssh).send(:control_master_file, node_connection_info[:connection], '22', node_connection_info[:user])
                 # Fail if the ControlMaster file already exists, as would SSH do if the file is stalled
@@ -51,6 +70,10 @@ module HybridPlatformsConductorTest
                 elsif node_connection_info[:control_master_create_error].nil?
                   # Really touch a fake control file, as ssh connector checks for its existence
                   File.write(control_file, '')
+                  control_master_created = true
+                  # If there is no Session Exec, this is done in a separate thread.
+                  # So keep it alive until the user wants to stop it (which is done using an ssh -O exit command).
+                  loop { sleep 0.1 } unless with_session_exec
                   [0, '', '']
                 else
                   [255, '', node_connection_info[:control_master_create_error]]
@@ -60,18 +83,19 @@ module HybridPlatformsConductorTest
           end
           if with_control_master_check
             ssh_commands_per_connection << [
-              /^.+\/ssh -O check #{Regexp.escape(node_connection_info[:user])}@hpc\.#{Regexp.escape(node)}$/,
+              /^.+\/ssh -O check hpc\.#{Regexp.escape(node)}$/,
               proc { [0, '', ''] }
             ]
           end
           if with_control_master_destroy
             ssh_commands_per_connection << [
-              /^.+\/ssh -O exit #{Regexp.escape(node_connection_info[:user])}@hpc\.#{Regexp.escape(node)} 2>&1 \| grep -v 'Exit request sent\.'$/,
+              /^.+\/ssh -O exit hpc\.#{Regexp.escape(node)} 2>&1 \| grep -v 'Exit request sent\.'$/,
               proc do
                 # Really mock the control file deletion
                 File.unlink(test_actions_executor.connector(:ssh).send(:control_master_file, node_connection_info[:connection], '22', node_connection_info[:user]))
                 [1, '', '']
-              end
+              end,
+              { optional: with_control_master_destroy_optional }
             ]
           end
           ssh_commands_once + ssh_commands_per_connection * node_connection_info[:times]
@@ -94,9 +118,23 @@ module HybridPlatformsConductorTest
       # * *expected_stderr* (String): Expected stderr after client code execution [default: '']
       # * *timeout* (Integer or nil): Timeout to prepare the connector for [default: nil]
       # * *password* (String or nil): Password to set for the node, or nil for none [default: nil]
+      # * *additional_config* (String): Additional config [default: '']
+      # * *session_exec* (Boolean): Do we mock a node having an SSH connection accepting Session Exec? [default: true]
       # * Proc: Client code to execute testing
-      def with_test_platform_for_remote_testing(expected_cmds: [], expected_stdout: '', expected_stderr: '', timeout: nil, password: nil)
-        with_test_platform(nodes: { 'node' => { meta: { host_ip: '192.168.42.42' } } }) do
+      def with_test_platform_for_remote_testing(
+        expected_cmds: [],
+        expected_stdout: '',
+        expected_stderr: '',
+        timeout: nil,
+        password: nil,
+        additional_config: '',
+        session_exec: true
+      )
+        with_test_platform(
+          { nodes: { 'node' => { meta: { host_ip: '192.168.42.42', ssh_session_exec: session_exec ? 'true' : 'false' } } } },
+          false,
+          additional_config
+        ) do
           with_cmd_runner_mocked(
             [
               ['which env', proc { [0, "/usr/bin/env\n", ''] }],
@@ -105,7 +143,8 @@ module HybridPlatformsConductorTest
               (password ? [['sshpass -V', proc { [0, "sshpass 1.06\n", ''] }]] : []) +
               ssh_expected_commands_for(
                 { 'node' => { connection: '192.168.42.42', user: 'test_user' } },
-                with_batch_mode: password.nil?
+                with_batch_mode: password.nil?,
+                with_session_exec: session_exec
               ) +
               expected_cmds
           ) do