hybrid_platforms_conductor 32.17.0 → 33.0.2

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

@@ -1,8 +1,8 @@
 describe HybridPlatformsConductor::ActionsExecutor do
 
-  context 'checking connector plugin ssh' do
+  context 'when checking connector plugin ssh' do
 
-    context 'checking additional helpers' do
+    context 'when checking additional helpers' do
 
       # Return the connector to be tested
       #
@@ -35,44 +35,47 @@ describe HybridPlatformsConductor::ActionsExecutor do
         begin_marker = node.nil? ? /^Host \*$/ : /^# #{Regexp.escape(node)} - .+$/
         start_idx = ssh_config_lines.index { |line| line =~ begin_marker }
         return nil if start_idx.nil?
+
         end_markers = [
           /^\# \w+ - .+$/,
           /^\#+$/
         ]
-        end_idx = ssh_config_lines[start_idx + 1..-1].index { |line| end_markers.any? { |end_marker| line =~ end_marker } }
+        end_idx = ssh_config_lines[start_idx + 1..].index { |line| end_markers.any? { |end_marker| line =~ end_marker } }
         end_idx = end_idx.nil? ? -1 : start_idx + end_idx
-        ssh_config_lines[start_idx..end_idx].select do |line|
-          stripped_line = line.strip
-          !stripped_line.empty? && stripped_line[0] != '#'
-        end.join("\n") + "\n"
+        "#{
+          ssh_config_lines[start_idx..end_idx].select do |line|
+            stripped_line = line.strip
+            !stripped_line.empty? && stripped_line[0] != '#'
+          end.join("\n")
+        }\n"
       end
 
       it 'generates a global configuration with user from hpc_ssh_user environment variable' do
-        with_test_platform do
+        with_test_platform({}) do
           ENV['hpc_ssh_user'] = 'test_user'
-          expect(ssh_config_for(nil)).to eq <<~EOS
+          expect(ssh_config_for(nil)).to eq <<~EO_SSH_CONFIG
             Host *
               User test_user
               ControlPath #{Dir.tmpdir}/hpc_ssh/hpc_ssh_mux_%h_%p_%r
               PubkeyAcceptedKeyTypes +ssh-dss
-          EOS
+          EO_SSH_CONFIG
         end
       end
 
       it 'generates a global configuration with user from USER environment variable' do
-        with_test_platform do
+        with_test_platform({}) do
           ENV['USER'] = 'test_user'
-          expect(ssh_config_for(nil)).to eq <<~EOS
+          expect(ssh_config_for(nil)).to eq <<~EO_SSH_CONFIG
             Host *
               User test_user
               ControlPath #{Dir.tmpdir}/hpc_ssh/hpc_ssh_mux_%h_%p_%r
               PubkeyAcceptedKeyTypes +ssh-dss
-          EOS
+          EO_SSH_CONFIG
         end
       end
 
       it 'generates a global configuration with user taken from whoami when no env variable is set' do
-        with_test_platform do
+        with_test_platform({}) do
           original_user = ENV['USER']
           begin
             ENV.delete 'USER'
@@ -83,12 +86,12 @@ describe HybridPlatformsConductor::ActionsExecutor do
                 ['whoami', proc { [0, 'test_whoami_user', ''] }]
               ]
             ) do
-              expect(ssh_config_for(nil)).to eq <<~EOS
+              expect(ssh_config_for(nil)).to eq <<~EO_SSH_CONFIG
                 Host *
                   User test_whoami_user
                   ControlPath #{Dir.tmpdir}/hpc_ssh/hpc_ssh_mux_%h_%p_%r
                   PubkeyAcceptedKeyTypes +ssh-dss
-              EOS
+              EO_SSH_CONFIG
             end
           ensure
             ENV['USER'] = original_user
@@ -97,309 +100,325 @@ describe HybridPlatformsConductor::ActionsExecutor do
       end
 
       it 'generates a global configuration with user from setting' do
-        with_test_platform do
+        with_test_platform({}) do
           test_connector.ssh_user = 'test_user'
-          expect(ssh_config_for(nil)).to eq <<~EOS
+          expect(ssh_config_for(nil)).to eq <<~EO_SSH_CONFIG
             Host *
               User test_user
               ControlPath #{Dir.tmpdir}/hpc_ssh/hpc_ssh_mux_%h_%p_%r
               PubkeyAcceptedKeyTypes +ssh-dss
-          EOS
+          EO_SSH_CONFIG
         end
       end
 
       it 'generates a global configuration with known hosts file' do
-        with_test_platform do
+        with_test_platform({}) do
           test_connector.ssh_user = 'test_user'
-          expect(ssh_config_for(nil, known_hosts_file: '/path/to/known_hosts')).to eq <<~EOS
+          expect(ssh_config_for(nil, known_hosts_file: '/path/to/known_hosts')).to eq <<~EO_SSH_CONFIG
             Host *
               User test_user
               ControlPath #{Dir.tmpdir}/hpc_ssh/hpc_ssh_mux_%h_%p_%r
               PubkeyAcceptedKeyTypes +ssh-dss
               UserKnownHostsFile /path/to/known_hosts
-          EOS
+          EO_SSH_CONFIG
         end
       end
 
       it 'generates a global configuration without strict host key checking' do
-        with_test_platform do
+        with_test_platform({}) do
           test_connector.ssh_user = 'test_user'
           test_connector.ssh_strict_host_key_checking = false
-          expect(ssh_config_for(nil)).to eq <<~EOS
+          expect(ssh_config_for(nil)).to eq <<~EO_SSH_CONFIG
             Host *
               User test_user
               ControlPath #{Dir.tmpdir}/hpc_ssh/hpc_ssh_mux_%h_%p_%r
               PubkeyAcceptedKeyTypes +ssh-dss
               StrictHostKeyChecking no
-          EOS
+          EO_SSH_CONFIG
         end
       end
 
       it 'includes the gateway definition from environment' do
-        with_test_platform({}, false, 'gateway :gateway1, \'Host my_gateway\'') do
-          ENV['hpc_ssh_gateways_conf'] = 'gateway1'
-          expect(test_connector.ssh_config).to match /^Host my_gateway$/
+        with_test_platform({}, additional_config: 'gateway :gateway_1, \'Host my_gateway\'') do
+          ENV['hpc_ssh_gateways_conf'] = 'gateway_1'
+          expect(test_connector.ssh_config).to match(/^Host my_gateway$/)
         end
       end
 
       it 'includes the gateway definition from setting' do
-        with_test_platform({}, false, 'gateway :gateway1, \'Host my_gateway\'') do
-          test_connector.ssh_gateways_conf = :gateway1
-          expect(test_connector.ssh_config).to match /^Host my_gateway$/
+        with_test_platform({}, additional_config: 'gateway :gateway_1, \'Host my_gateway\'') do
+          test_connector.ssh_gateways_conf = :gateway_1
+          expect(test_connector.ssh_config).to match(/^Host my_gateway$/)
         end
       end
 
       it 'includes the gateway definition with a different ssh executable' do
-        with_test_platform({}, false, 'gateway :gateway1, \'Host my_gateway_<%= @ssh_exec %>\'') do
-          test_connector.ssh_gateways_conf = :gateway1
-          expect(test_connector.ssh_config(ssh_exec: 'new_ssh')).to match /^Host my_gateway_new_ssh$/
+        with_test_platform({}, additional_config: 'gateway :gateway_1, \'Host my_gateway_<%= @ssh_exec %>\'') do
+          test_connector.ssh_gateways_conf = :gateway_1
+          expect(test_connector.ssh_config(ssh_exec: 'new_ssh')).to match(/^Host my_gateway_new_ssh$/)
         end
       end
 
       it 'does not include the gateway definition if it is not selected' do
-        with_test_platform({}, false, 'gateway :gateway2, \'Host my_gateway\'') do
-          test_connector.ssh_gateways_conf = :gateway1
-          expect(test_connector.ssh_config).not_to match /^Host my_gateway$/
+        with_test_platform({}, additional_config: 'gateway :gateway_2, \'Host my_gateway\'') do
+          test_connector.ssh_gateways_conf = :gateway_1
+          expect(test_connector.ssh_config).not_to match(/^Host my_gateway$/)
         end
       end
 
       it 'generates a simple config for a node with host_ip' do
-        with_test_platform(nodes: { 'node' => { meta: { host_ip: '192.168.42.42' } } }) do
-          expect(ssh_config_for('node')).to eq <<~EOS
+        with_test_platform({ nodes: { 'node' => { meta: { host_ip: '192.168.42.42' } } } }) do
+          expect(ssh_config_for('node')).to eq <<~EO_SSH_CONFIG
             Host hpc.node
               Hostname 192.168.42.42
-          EOS
+          EO_SSH_CONFIG
         end
       end
 
       it 'generates a simple config for several nodes' do
-        with_test_platform(nodes: {
-          'node1' => { meta: { host_ip: '192.168.42.1' } },
-          'node2' => { meta: { host_ip: '192.168.42.2' } },
-          'node3' => { meta: { host_ip: '192.168.42.3' } }
-        }) do
-          expect(ssh_config_for('node1')).to eq <<~EOS
+        with_test_platform(
+          {
+            nodes: {
+              'node1' => { meta: { host_ip: '192.168.42.1' } },
+              'node2' => { meta: { host_ip: '192.168.42.2' } },
+              'node3' => { meta: { host_ip: '192.168.42.3' } }
+            }
+          }
+        ) do
+          expect(ssh_config_for('node1')).to eq <<~EO_SSH_CONFIG
             Host hpc.node1
               Hostname 192.168.42.1
-          EOS
-          expect(ssh_config_for('node2')).to eq <<~EOS
+          EO_SSH_CONFIG
+          expect(ssh_config_for('node2')).to eq <<~EO_SSH_CONFIG
             Host hpc.node2
               Hostname 192.168.42.2
-          EOS
-          expect(ssh_config_for('node3')).to eq <<~EOS
+          EO_SSH_CONFIG
+          expect(ssh_config_for('node3')).to eq <<~EO_SSH_CONFIG
             Host hpc.node3
               Hostname 192.168.42.3
-          EOS
+          EO_SSH_CONFIG
         end
       end
 
       it 'generates a simple config for several nodes even when some of them can\'t be connected' do
-        with_test_platform(nodes: {
-          'node1' => { meta: { host_ip: '192.168.42.1' } },
-          'node2' => { meta: {} },
-          'node3' => { meta: { host_ip: '192.168.42.3' } }
-        }) do
-          expect(ssh_config_for('node1')).to eq <<~EOS
+        with_test_platform(
+          {
+            nodes: {
+              'node1' => { meta: { host_ip: '192.168.42.1' } },
+              'node2' => { meta: {} },
+              'node3' => { meta: { host_ip: '192.168.42.3' } }
+            }
+          }
+        ) do
+          expect(ssh_config_for('node1')).to eq <<~EO_SSH_CONFIG
             Host hpc.node1
               Hostname 192.168.42.1
-          EOS
+          EO_SSH_CONFIG
           expect(ssh_config_for('node2')).to eq "\n"
-          expect(ssh_config_for('node3')).to eq <<~EOS
+          expect(ssh_config_for('node3')).to eq <<~EO_SSH_CONFIG
             Host hpc.node3
               Hostname 192.168.42.3
-          EOS
+          EO_SSH_CONFIG
         end
       end
 
       it 'selects nodes when generating the config' do
-        with_test_platform(nodes: {
-          'node1' => { meta: { host_ip: '192.168.42.1' } },
-          'node2' => { meta: { host_ip: '192.168.42.2' } },
-          'node3' => { meta: { host_ip: '192.168.42.3' } }
-        }) do
-          expect(ssh_config_for('node1', nodes: %w[node1 node3])).to eq <<~EOS
+        with_test_platform(
+          {
+            nodes: {
+              'node1' => { meta: { host_ip: '192.168.42.1' } },
+              'node2' => { meta: { host_ip: '192.168.42.2' } },
+              'node3' => { meta: { host_ip: '192.168.42.3' } }
+            }
+          }
+        ) do
+          expect(ssh_config_for('node1', nodes: %w[node1 node3])).to eq <<~EO_SSH_CONFIG
             Host hpc.node1
               Hostname 192.168.42.1
-          EOS
+          EO_SSH_CONFIG
           expect(ssh_config_for('node2', nodes: %w[node1 node3])).to eq nil
         end
       end
 
       it 'generates an alias if the node has a hostname' do
-        with_test_platform(nodes: { 'node' => { meta: { host_ip: '192.168.42.42', hostname: 'my_hostname.my_domain' } } }) do
-          expect(ssh_config_for('node')).to eq <<~EOS
+        with_test_platform({ nodes: { 'node' => { meta: { host_ip: '192.168.42.42', hostname: 'my_hostname.my_domain' } } } }) do
+          expect(ssh_config_for('node')).to eq <<~EO_SSH_CONFIG
             Host hpc.node my_hostname.my_domain
               Hostname 192.168.42.42
-          EOS
+          EO_SSH_CONFIG
         end
       end
 
       it 'generates aliases if the node has private ips' do
-        with_test_platform(nodes: { 'node' => { meta: { host_ip: '192.168.42.42', private_ips: ['192.168.42.1', '192.168.42.2'] } } }) do
-          expect(ssh_config_for('node')).to eq <<~EOS
+        with_test_platform({ nodes: { 'node' => { meta: { host_ip: '192.168.42.42', private_ips: ['192.168.42.1', '192.168.42.2'] } } } }) do
+          expect(ssh_config_for('node')).to eq <<~EO_SSH_CONFIG
             Host hpc.node hpc.192.168.42.1 hpc.192.168.42.2
               Hostname 192.168.42.42
-          EOS
+          EO_SSH_CONFIG
         end
       end
 
       it 'generates a simple config for a node with hostname' do
-        with_test_platform(nodes: { 'node' => { meta: { hostname: 'my_hostname.my_domain' } } }) do
-          expect(ssh_config_for('node')).to eq <<~EOS
+        with_test_platform({ nodes: { 'node' => { meta: { hostname: 'my_hostname.my_domain' } } } }) do
+          expect(ssh_config_for('node')).to eq <<~EO_SSH_CONFIG
             Host hpc.node my_hostname.my_domain
               Hostname my_hostname.my_domain
-          EOS
+          EO_SSH_CONFIG
         end
       end
 
       it 'generates a simple config for a node with private_ips' do
-        with_test_platform(nodes: { 'node' => { meta: { private_ips: ['192.168.42.1', '192.168.42.2'] } } }) do
-          expect(ssh_config_for('node')).to eq <<~EOS
+        with_test_platform({ nodes: { 'node' => { meta: { private_ips: ['192.168.42.1', '192.168.42.2'] } } } }) do
+          expect(ssh_config_for('node')).to eq <<~EO_SSH_CONFIG
             Host hpc.node hpc.192.168.42.1 hpc.192.168.42.2
               Hostname 192.168.42.1
-          EOS
+          EO_SSH_CONFIG
         end
       end
 
       it 'uses node forced gateway information' do
-        with_test_platform(nodes: { 'node' => { meta: { host_ip: '192.168.42.42', gateway: 'test_gateway', gateway_user: 'test_gateway_user' } } }) do
-          expect(ssh_config_for('node')).to eq <<~EOS
+        with_test_platform({ nodes: { 'node' => { meta: { host_ip: '192.168.42.42', gateway: 'test_gateway', gateway_user: 'test_gateway_user' } } } }) do
+          expect(ssh_config_for('node')).to eq <<~EO_SSH_CONFIG
             Host hpc.node
               Hostname 192.168.42.42
               ProxyCommand ssh -q -W %h:%p test_gateway_user@test_gateway
-          EOS
+          EO_SSH_CONFIG
         end
       end
 
       it 'uses node default gateway information and user from environment' do
-        with_test_platform(nodes: { 'node' => { meta: { host_ip: '192.168.42.42', gateway: 'test_gateway' } } }) do
+        with_test_platform({ nodes: { 'node' => { meta: { host_ip: '192.168.42.42', gateway: 'test_gateway' } } } }) do
           ENV['hpc_ssh_gateway_user'] = 'test_gateway_user'
-          expect(ssh_config_for('node')).to eq <<~EOS
+          expect(ssh_config_for('node')).to eq <<~EO_SSH_CONFIG
             Host hpc.node
               Hostname 192.168.42.42
               ProxyCommand ssh -q -W %h:%p test_gateway_user@test_gateway
-          EOS
+          EO_SSH_CONFIG
         end
       end
 
       it 'uses node default gateway information and user from setting' do
-        with_test_platform(nodes: { 'node' => { meta: { host_ip: '192.168.42.42', gateway: 'test_gateway' } } }) do
+        with_test_platform({ nodes: { 'node' => { meta: { host_ip: '192.168.42.42', gateway: 'test_gateway' } } } }) do
           test_connector.ssh_gateway_user = 'test_gateway_user'
-          expect(ssh_config_for('node')).to eq <<~EOS
+          expect(ssh_config_for('node')).to eq <<~EO_SSH_CONFIG
             Host hpc.node
               Hostname 192.168.42.42
               ProxyCommand ssh -q -W %h:%p test_gateway_user@test_gateway
-          EOS
+          EO_SSH_CONFIG
         end
       end
 
       it 'uses node forced gateway information with a different ssh executable' do
-        with_test_platform(nodes: { 'node' => { meta: { host_ip: '192.168.42.42', gateway: 'test_gateway', gateway_user: 'test_gateway_user' } } }) do
-          expect(ssh_config_for('node', ssh_exec: 'new_ssh')).to eq <<~EOS
+        with_test_platform({ nodes: { 'node' => { meta: { host_ip: '192.168.42.42', gateway: 'test_gateway', gateway_user: 'test_gateway_user' } } } }) do
+          expect(ssh_config_for('node', ssh_exec: 'new_ssh')).to eq <<~EO_SSH_CONFIG
             Host hpc.node
               Hostname 192.168.42.42
               ProxyCommand new_ssh -q -W %h:%p test_gateway_user@test_gateway
-          EOS
+          EO_SSH_CONFIG
         end
       end
 
       it 'uses node default gateway information with a different ssh executable' do
-        with_test_platform(nodes: { 'node' => { meta: { host_ip: '192.168.42.42', gateway: 'test_gateway' } } }) do
+        with_test_platform({ nodes: { 'node' => { meta: { host_ip: '192.168.42.42', gateway: 'test_gateway' } } } }) do
           test_connector.ssh_gateway_user = 'test_gateway_user'
-          expect(ssh_config_for('node', ssh_exec: 'new_ssh')).to eq <<~EOS
+          expect(ssh_config_for('node', ssh_exec: 'new_ssh')).to eq <<~EO_SSH_CONFIG
             Host hpc.node
               Hostname 192.168.42.42
               ProxyCommand new_ssh -q -W %h:%p test_gateway_user@test_gateway
-          EOS
+          EO_SSH_CONFIG
         end
       end
 
       it 'uses node transformed SSH connection' do
         with_test_platform(
           { nodes: {
-            'node1' => { meta: { host_ip: '192.168.42.1', gateway: 'test_gateway1', gateway_user: 'test_gateway1_user' } },
-            'node2' => { meta: { host_ip: '192.168.42.2', gateway: 'test_gateway2', gateway_user: 'test_gateway2_user' } },
+            'node1' => { meta: { host_ip: '192.168.42.1', gateway: 'test_gateway_1', gateway_user: 'test_gateway_1_user' } },
+            'node2' => { meta: { host_ip: '192.168.42.2', gateway: 'test_gateway_2', gateway_user: 'test_gateway_2_user' } },
             'node3' => { meta: { host_ip: '192.168.42.3', gateway: 'test_gateway3', gateway_user: 'test_gateway3_user' } }
           } },
-          false,
-          '
+          additional_config: <<~'EO_CONFIG'
             for_nodes(%w[node1 node3]) do
               transform_ssh_connection do |node, connection, connection_user, gateway, gateway_user|
                 ["#{connection}_#{node}_13", "#{connection_user}_#{node}_13", "#{gateway}_#{node}_13", "#{gateway_user}_#{node}_13"]
               end
             end
-            for_nodes(\'node1\') do
+            for_nodes('node1') do
               transform_ssh_connection do |node, connection, connection_user, gateway, gateway_user|
                 ["#{connection}_#{node}_1", "#{connection_user}_#{node}_1", "#{gateway}_#{node}_1", "#{gateway_user}_#{node}_1"]
               end
             end
-          ') do
+          EO_CONFIG
+        ) do
           test_connector.ssh_user = 'test_user'
-          expect(ssh_config_for('node1')).to eq <<~EOS
+          expect(ssh_config_for('node1')).to eq <<~EO_SSH_CONFIG
             Host hpc.node1
               Hostname 192.168.42.1_node1_13_node1_1
               User "test_user_node1_13_node1_1"
-              ProxyCommand ssh -q -W %h:%p test_gateway1_user_node1_13_node1_1@test_gateway1_node1_13_node1_1
-          EOS
-          expect(ssh_config_for('node2')).to eq <<~EOS
+              ProxyCommand ssh -q -W %h:%p test_gateway_1_user_node1_13_node1_1@test_gateway_1_node1_13_node1_1
+          EO_SSH_CONFIG
+          expect(ssh_config_for('node2')).to eq <<~EO_SSH_CONFIG
             Host hpc.node2
               Hostname 192.168.42.2
-              ProxyCommand ssh -q -W %h:%p test_gateway2_user@test_gateway2
-          EOS
-          expect(ssh_config_for('node3')).to eq <<~EOS
+              ProxyCommand ssh -q -W %h:%p test_gateway_2_user@test_gateway_2
+          EO_SSH_CONFIG
+          expect(ssh_config_for('node3')).to eq <<~EO_SSH_CONFIG
             Host hpc.node3
               Hostname 192.168.42.3_node3_13
               User "test_user_node3_13"
               ProxyCommand ssh -q -W %h:%p test_gateway3_user_node3_13@test_gateway3_node3_13
-          EOS
+          EO_SSH_CONFIG
         end
       end
 
       it 'generates a config compatible for passwords authentication' do
-        with_test_platform(nodes: { 'node' => { meta: { host_ip: '192.168.42.42' } } }) do
+        with_test_platform({ nodes: { 'node' => { meta: { host_ip: '192.168.42.42' } } } }) do
           test_connector.passwords['node'] = 'PaSsWoRd'
-          expect(ssh_config_for('node')).to eq <<~EOS
+          expect(ssh_config_for('node')).to eq <<~EO_SSH_CONFIG
             Host hpc.node
               Hostname 192.168.42.42
               PreferredAuthentications password
               PubkeyAuthentication no
-          EOS
+          EO_SSH_CONFIG
         end
       end
 
       it 'generates a config compatible for passwords authentication only for marked nodes' do
-        with_test_platform(nodes: {
-          'node1' => { meta: { host_ip: '192.168.42.1' } },
-          'node2' => { meta: { host_ip: '192.168.42.2' } },
-          'node3' => { meta: { host_ip: '192.168.42.3' } },
-          'node4' => { meta: { host_ip: '192.168.42.4' } }
-        }) do
+        with_test_platform(
+          {
+            nodes: {
+              'node1' => { meta: { host_ip: '192.168.42.1' } },
+              'node2' => { meta: { host_ip: '192.168.42.2' } },
+              'node3' => { meta: { host_ip: '192.168.42.3' } },
+              'node4' => { meta: { host_ip: '192.168.42.4' } }
+            }
+          }
+        ) do
           test_connector.passwords['node1'] = 'PaSsWoRd1'
           test_connector.passwords['node3'] = 'PaSsWoRd3'
-          expect(ssh_config_for('node1')).to eq <<~EOS
+          expect(ssh_config_for('node1')).to eq <<~EO_SSH_CONFIG
             Host hpc.node1
               Hostname 192.168.42.1
               PreferredAuthentications password
               PubkeyAuthentication no
-          EOS
-          expect(ssh_config_for('node2')).to eq <<~EOS
+          EO_SSH_CONFIG
+          expect(ssh_config_for('node2')).to eq <<~EO_SSH_CONFIG
             Host hpc.node2
               Hostname 192.168.42.2
-          EOS
-          expect(ssh_config_for('node3')).to eq <<~EOS
+          EO_SSH_CONFIG
+          expect(ssh_config_for('node3')).to eq <<~EO_SSH_CONFIG
             Host hpc.node3
               Hostname 192.168.42.3
               PreferredAuthentications password
               PubkeyAuthentication no
-          EOS
-          expect(ssh_config_for('node4')).to eq <<~EOS
+          EO_SSH_CONFIG
+          expect(ssh_config_for('node4')).to eq <<~EO_SSH_CONFIG
             Host hpc.node4
               Hostname 192.168.42.4
-          EOS
+          EO_SSH_CONFIG
         end
       end
 
-   end
+    end
 
   end