hybrid_platforms_conductor 32.3.6

data/lib/hybrid_platforms_conductor/hpc_plugins/test/deploy_removes_root_access.rb

@@ -0,0 +1,49 @@
+require 'net/ssh'
+require 'hybrid_platforms_conductor/test_by_service'
+
+module HybridPlatformsConductor
+
+  module HpcPlugins
+
+    module Test
+
+      # Test that deploy removes root access
+      class DeployRemovesRootAccess < TestByService
+
+        # Check my_test_plugin.rb.sample documentation for signature details.
+        def test_for_node
+          @deployer.with_test_provisioned_instance(@config.tests_provisioner_id, @node, environment: 'deploy_removes_root_access', reuse_instance: log_debug?) do |deployer, instance|
+            # Check that we can connect with root
+            ssh_ok = false
+            begin
+              Net::SSH.start(instance.ip, 'root', password: 'root_pwd', auth_methods: ['password'], verify_host_key: :never) do |ssh|
+                ssh_ok = ssh.exec!('echo Works').strip == 'Works'
+              end
+            rescue
+            end
+            assert_equal ssh_ok, true, 'Root does not have access from the empty image'
+            if ssh_ok
+              deployer.nbr_retries_on_error = 3
+              deployer.deploy_on @node
+              # As sshd is certainly being restarted, start and stop the container to reload it.
+              deployer.restart @node
+              # Check that we can't connect with root
+              ssh_ok = false
+              begin
+                Net::SSH.start(instance.ip, 'root', password: 'root_pwd', auth_methods: ['password'], verify_host_key: :never) do |ssh|
+                  ssh_ok = ssh.exec!('echo Works').strip == 'Works'
+                end
+              rescue
+              end
+              assert_equal ssh_ok, false, 'Root can still connect on the image after deployment'
+            end
+          end
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/hybrid_platforms_conductor/hpc_plugins/test/divergence.rb

@@ -0,0 +1,25 @@
+require 'json'
+
+module HybridPlatformsConductor
+
+  module HpcPlugins
+
+    module Test
+
+      # Test that the node has not diverged since last deployment
+      class Divergence < HybridPlatformsConductor::Test
+
+        # Check my_test_plugin.rb.sample documentation for signature details.
+        def test_on_check_node(stdout, stderr, exit_status)
+          @deployer.parse_deploy_output(@node, stdout, stderr).each do |task_info|
+            error "Task #{task_info[:name]} has diverged", JSON.pretty_generate(task_info) if task_info[:status] == :changed
+          end
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/hybrid_platforms_conductor/hpc_plugins/test/executables.rb

@@ -0,0 +1,46 @@
+require 'hybrid_platforms_conductor/cmd_runner'
+
+module HybridPlatformsConductor
+
+  module HpcPlugins
+
+    module Test
+
+      # Check that all executables run correctly, from an environment/installation point of view.
+      class Executables < HybridPlatformsConductor::Test
+
+        # Check my_test_plugin.rb.sample documentation for signature details.
+        def test
+          example_platform = PlatformsHandler.new.known_platforms.first
+          example_node = example_platform.known_nodes.first
+        	[
+            "#{CmdRunner.executables_prefix}check-node --node #{example_node} --show-commands",
+            "#{CmdRunner.executables_prefix}deploy --node #{example_node} --show-commands --why-run",
+            "#{CmdRunner.executables_prefix}dump_nodes_json --help",
+            "#{CmdRunner.executables_prefix}free_ips",
+            "#{CmdRunner.executables_prefix}free_veids",
+            "#{CmdRunner.executables_prefix}get_impacted_nodes --platform #{example_platform.name} --show-commands",
+            "#{CmdRunner.executables_prefix}last_deploys --node #{example_node} --show-commands",
+            "#{CmdRunner.executables_prefix}nodes_to_deploy --node #{example_node} --show-commands",
+            "#{CmdRunner.executables_prefix}report --node #{example_node} --format stdout",
+            "#{CmdRunner.executables_prefix}run --node #{example_node} --show-commands --interactive",
+            "#{CmdRunner.executables_prefix}setup --help",
+            "#{CmdRunner.executables_prefix}ssh_config",
+            "#{CmdRunner.executables_prefix}test --help",
+            "#{CmdRunner.executables_prefix}topograph --from \"--node #{example_node}\" --to \"--node #{example_node}\" --skip-run --output graphviz:graph.gv"
+          ].each do |cmd|
+            log_debug "Testing #{cmd}"
+            exit_status, stdout, _stderr = @cmd_runner.run_cmd "#{cmd} 2>&1", no_exception: true, log_to_stdout: log_debug?
+            assert_equal(exit_status, 0, "Command #{cmd} returned code #{exit_status}:\n#{stdout}")
+          end
+          # Remove the file created by Topograph if it exists
+          File.unlink('graph.gv') if File.exist?('graph.gv')
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/hybrid_platforms_conductor/hpc_plugins/test/file_system.rb

@@ -0,0 +1,45 @@
+require 'hybrid_platforms_conductor/common_config_dsl/file_system_tests'
+
+module HybridPlatformsConductor
+
+  module HpcPlugins
+
+    module Test
+
+      # Perform various tests on a node's file system
+      class FileSystem < HybridPlatformsConductor::Test
+
+        self.extend_config_dsl_with CommonConfigDsl::FileSystemTests, :init_file_system_tests
+
+        # Check my_test_plugin.rb.sample documentation for signature details.
+        def test_on_node
+          # Flatten the paths rules so that we can spot inconsistencies in configuration
+          Hash[
+            @config.aggregate_files_rules(@nodes_handler, @node).map do |path, rule_info|
+              [
+                "if sudo /bin/bash -c '[[ -d \"#{path}\" ]]' ; then echo 1 ; else echo 0 ; fi",
+                {
+                  validator: proc do |stdout, stderr|
+                    case stdout.last
+                    when '1'
+                      error "Path found that should be absent: #{path}" if rule_info[:state] == :absent
+                    when '0'
+                      error "Path not found that should be present: #{path}" if rule_info[:state] == :present
+                    else
+                      error "Could not check for existence of path #{path}", "----- STDOUT:\n#{stdout.join("\n")}----- STDERR:\n#{stderr.join("\n")}"
+                    end
+                  end,
+                  timeout: 2
+                }
+              ]
+            end
+          ]
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/hybrid_platforms_conductor/hpc_plugins/test/file_system_hdfs.rb

@@ -0,0 +1,45 @@
+require 'hybrid_platforms_conductor/common_config_dsl/file_system_tests'
+
+module HybridPlatformsConductor
+
+  module HpcPlugins
+
+    module Test
+
+      # Perform various tests on a HDFS's file system
+      class FileSystemHdfs < HybridPlatformsConductor::Test
+
+        self.extend_config_dsl_with CommonConfigDsl::FileSystemTests, :init_file_system_tests
+
+        # Check my_test_plugin.rb.sample documentation for signature details.
+        def test_on_node
+          # Flatten the paths rules so that we can spot inconsistencies in configuration
+          Hash[
+            @config.aggregate_files_rules(@nodes_handler, @node, file_system_type: :hdfs).map do |path, rule_info|
+              [
+                "if sudo#{rule_info[:context][:sudo_user] ? " -u #{rule_info[:context][:sudo_user]}" : ''} hdfs dfs -ls \"#{path}\" ; then echo 1 ; else echo 0 ; fi",
+                {
+                  validator: proc do |stdout, stderr|
+                    case stdout.last
+                    when '1'
+                      error "HDFS path found that should be absent: #{path}" if rule_info[:state] == :absent
+                    when '0'
+                      error "HDFS path not found that should be present: #{path}" if rule_info[:state] == :present
+                    else
+                      error "Could not check for existence of HDFS path #{path}", "----- STDOUT:\n#{stdout.join("\n")}----- STDERR:\n#{stderr.join("\n")}"
+                    end
+                  end,
+                  timeout: 5
+                }
+              ]
+            end
+          ]
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/hybrid_platforms_conductor/hpc_plugins/test/hostname.rb

@@ -0,0 +1,25 @@
+module HybridPlatformsConductor
+
+  module HpcPlugins
+
+    module Test
+
+      # Test that the hostname is correct
+      class Hostname < HybridPlatformsConductor::Test
+
+        # Check my_test_plugin.rb.sample documentation for signature details.
+        def test_on_node
+          {
+            'sudo hostname -s' => proc do |stdout|
+              assert_equal stdout.first, @node, "Expected hostname to be #{@node}, but got #{stdout.first} instead."
+            end
+          }
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/hybrid_platforms_conductor/hpc_plugins/test/idempotence.rb

@@ -0,0 +1,77 @@
+require 'json'
+require 'hybrid_platforms_conductor/common_config_dsl/idempotence_tests'
+require 'hybrid_platforms_conductor/test_by_service'
+
+module HybridPlatformsConductor
+
+  module HpcPlugins
+
+    module Test
+
+      # Test that a check-node after a deploy returns no error.
+      # This tests uses the testadmin user access once deployed.
+      # Don't forget to add the testadmin private key in your SSH agent if you run this test locally.
+      class Idempotence < TestByService
+
+        self.extend_config_dsl_with CommonConfigDsl::IdempotenceTests, :init_idempotence_tests
+
+        # Check my_test_plugin.rb.sample documentation for signature details.
+        def test_for_node
+          @deployer.with_test_provisioned_instance(@config.tests_provisioner_id, @node, environment: 'idempotence', reuse_instance: log_debug?) do |deployer, instance|
+            # First deploy as root
+            deployer.nbr_retries_on_error = 3
+            exit_status, _stdout, _stderr = deployer.deploy_on(@node)[@node]
+            if exit_status == 0
+              # As it's possible sshd has to be restarted because of a change in its conf, restart the container.
+              # Otherwise you'll get the following error upon reconnection:
+              #   System is booting up. See pam_nologin(8)
+              #   Authentication failed.
+              instance.stop
+              instance.with_running_instance(port: 22) do
+                # Now that the node has been deployed, use the a_testadmin user for the check-node (as root has no more access)
+                deployer.instance_variable_get(:@actions_executor).connector(:ssh).ssh_user = 'a_testadmin'
+                deployer.instance_variable_get(:@actions_executor).connector(:ssh).passwords.delete(@node)
+                deployer.use_why_run = true
+                deployer.nbr_retries_on_error = 0
+                result = deployer.deploy_on(@node)
+                assert_equal result.size, 1, "Wrong number of nodes being tested: #{result.size}"
+                tested_node, (exit_status, stdout, stderr) = result.first
+                if exit_status.is_a?(Symbol)
+                  # In debug mode, the logger is the normal one, already outputting the error. No need to get it back from the logs.
+                  error "Check-node could not run because of error: #{exit_status}.", log_debug? ? nil : deployer.stdouts_to_s
+                else
+                  assert_equal tested_node, @node, "Wrong node being tested: #{tested_node} should be #{@node}"
+                  assert_equal exit_status, 0, "Check-node returned error code #{exit_status}"
+                  # Check that the output of the check-node returns no changes.
+                  ignored_tasks = @nodes_handler.select_confs_for_node(@node, @config.ignored_idempotence_tasks).inject({}) do |merged_ignored_tasks, conf|
+                    merged_ignored_tasks.merge(conf[:ignored_tasks])
+                  end
+                  @deployer.parse_deploy_output(@node, stdout, stderr).each do |task_info|
+                    if task_info[:status] == :changed
+                      if ignored_tasks.key?(task_info[:name])
+                        # It was expected that this task is not idempotent
+                        log_debug "Task #{task_info[:name]} was expected to not be idempotent. Reason: #{ignored_tasks[task_info[:name]]}"
+                      else
+                        extra_details = task_info.slice(*(task_info.keys - %i[name status diffs]))
+                        error_details = []
+                        error_details << "----- Changes:\n#{task_info[:diffs].strip}\n-----" if task_info[:diffs]
+                        error_details << "----- Additional details:\n#{JSON.pretty_generate(extra_details)}\n-----" unless extra_details.empty?
+                        error "Task #{task_info[:name]} is not idempotent", error_details.empty? ? nil : error_details.join("\n")
+                      end
+                    end
+                  end
+                end
+              end
+            else
+              error 'Unable to deploy from scratch. Fix this before testing idempotence.', log_debug? ? nil : deployer.stdouts_to_s
+            end
+          end
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/hybrid_platforms_conductor/hpc_plugins/test/ip.rb

@@ -0,0 +1,38 @@
+module HybridPlatformsConductor
+
+  module HpcPlugins
+
+    module Test
+
+      # Test that the private IP address is correct
+      class Ip < HybridPlatformsConductor::Test
+
+        # Check my_test_plugin.rb.sample documentation for signature details.
+        def test_on_node
+          {
+            'sudo hostname -I' => proc do |stdout|
+              if stdout.first.nil?
+                error 'No IP returned by "hostname -I"'
+              else
+                private_ips = @nodes_handler.get_private_ips_of @node
+                if private_ips
+                  host_ips = stdout.first.split(' ').select { |ip| ip =~ /^172\.16\.\d+\.\d+$/ }.sort
+                  ref_ips = private_ips.sort
+                  assert_equal(
+                    host_ips,
+                    ref_ips,
+                    "Expected IPs to be #{ref_ips}, but got #{host_ips} instead"
+                  )
+                end
+              end
+            end
+          }
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/hybrid_platforms_conductor/hpc_plugins/test/jenkins_ci_conf.rb

@@ -0,0 +1,56 @@
+require 'nokogiri'
+require 'hybrid_platforms_conductor/credentials'
+require 'hybrid_platforms_conductor/common_config_dsl/bitbucket'
+
+module HybridPlatformsConductor
+
+  module HpcPlugins
+
+    module Test
+
+      # Check that all repositories have a correct Jenkins CI configuration.
+      class JenkinsCiConf < HybridPlatformsConductor::Test
+
+        self.extend_config_dsl_with CommonConfigDsl::Bitbucket, :init_bitbucket
+
+        # Check my_test_plugin.rb.sample documentation for signature details.
+        def test
+          @config.for_each_bitbucket_repo do |bitbucket, repo_info|
+            if repo_info[:jenkins_ci_url].nil?
+              error "Repository #{repo_info[:name]} does not have any Jenkins CI URL configured."
+            else
+              Credentials.with_credentials_for(:jenkins_ci, @logger, @logger_stderr, url: repo_info[:jenkins_ci_url]) do |jenkins_user, jenkins_password|
+                # Get its config
+                begin
+                  doc = Nokogiri::XML(open("#{repo_info[:jenkins_ci_url]}/config.xml", http_basic_authentication: [jenkins_user, jenkins_password]).read)
+                  # Check that this job builds the correct Bitbucket repository
+                  assert_equal(
+                    doc.xpath('/org.jenkinsci.plugins.workflow.multibranch.WorkflowMultiBranchProject/sources/data/jenkins.branch.BranchSource/source/serverUrl').text,
+                    bitbucket.bitbucket_url,
+                    "Job #{repo_info[:jenkins_ci_url]} does not build repository from Bitbucket"
+                  )
+                  assert_equal(
+                    doc.xpath('/org.jenkinsci.plugins.workflow.multibranch.WorkflowMultiBranchProject/sources/data/jenkins.branch.BranchSource/source/repoOwner').text.downcase,
+                    repo_info[:project].downcase,
+                    "Job #{repo_info[:jenkins_ci_url]} does not build repository from project #{repo_info[:project]}"
+                  )
+                  assert_equal(
+                    doc.xpath('/org.jenkinsci.plugins.workflow.multibranch.WorkflowMultiBranchProject/sources/data/jenkins.branch.BranchSource/source/repository').text,
+                    repo_info[:name],
+                    "Job #{repo_info[:jenkins_ci_url]} does not build repository named #{repo_info[:name]}"
+                  )
+                rescue
+                  error "Error while checking Jenkins CI job for #{repo_info[:project]}/#{repo_info[:name]} from URL #{repo_info[:jenkins_ci_url]}: #{$!}"
+                end
+              end
+            end
+          end
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/hybrid_platforms_conductor/hpc_plugins/test/jenkins_ci_masters_ok.rb

@@ -0,0 +1,54 @@
+require 'json'
+require 'hybrid_platforms_conductor/credentials'
+require 'hybrid_platforms_conductor/common_config_dsl/bitbucket'
+
+module HybridPlatformsConductor
+
+  module HpcPlugins
+
+    module Test
+
+      # Check that all repositories have a successful master branch on a Jenkins CI
+      class JenkinsCiMastersOk < HybridPlatformsConductor::Test
+
+        self.extend_config_dsl_with CommonConfigDsl::Bitbucket, :init_bitbucket
+
+        SUCCESS_STATUSES = [
+          # Add nil as the status of a currently running job (which is always the case for hybrid-platforms) is null
+          nil,
+          # Add ABORTED as it is impossible to make Groovy Pipelines return SUCCESS when we want to abort it normally.
+          'ABORTED',
+          'SUCCESS'
+        ]
+
+        # Check my_test_plugin.rb.sample documentation for signature details.
+        def test
+          @config.for_each_bitbucket_repo do |_bitbucket, repo_info|
+            if repo_info[:jenkins_ci_url].nil?
+              error "Repository #{repo_info[:name]} does not have any Jenkins CI URL configured."
+            else
+              master_info_url = "#{repo_info[:jenkins_ci_url]}/job/master/api/json"
+              Credentials.with_credentials_for(:jenkins_ci, @logger, @logger_stderr, url: master_info_url) do |jenkins_user, jenkins_password|
+                begin
+                  # Get the master branch info from the API
+                  master_info = JSON.parse(open(master_info_url, http_basic_authentication: [jenkins_user, jenkins_password]).read)
+                  # Get the last build's URL
+                  last_build_info_url = "#{master_info['lastBuild']['url']}/api/json"
+                  last_build_info = JSON.parse(open(last_build_info_url, http_basic_authentication: [jenkins_user, jenkins_password]).read)
+                  log_debug "Build info for #{master_info_url}:\n#{JSON.pretty_generate(last_build_info)}"
+                  error "Last build for job #{repo_info[:project]}/#{repo_info[:name]} is in status #{last_build_info['result']}: #{master_info['lastBuild']['url']}" unless SUCCESS_STATUSES.include?(last_build_info['result'])
+                rescue
+                  error "Error while checking Jenkins CI job for #{repo_info[:project]}/#{repo_info[:name]} from URL #{master_info_url}: #{$!}"
+                end
+              end
+            end
+          end
+        end
+
+      end
+
+    end
+
+  end
+
+end