hybrid_platforms_conductor 32.3.6

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

@@ -0,0 +1,47 @@
+module HybridPlatformsConductor
+
+  module HpcPlugins
+
+    module Test
+
+      # Check that the repository is having a Git linear strategy on master.
+      class LinearStrategy < HybridPlatformsConductor::Test
+
+        # Number of seconds of the period after which we tolerate non-linear history in git
+        LOOKING_PERIOD = 6 * 31 * 24 * 60 * 60 # 6 months
+
+        # Check my_test_plugin.rb.sample documentation for signature details.
+        def test_on_platform
+          _exit_status, stdout, _stderr = @cmd_runner.run_cmd(
+            "cd #{@platform.repository_path} && git --no-pager log --merges --pretty=format:\"%H\"",
+            log_to_stdout: log_debug?
+          )
+          stdout.split("\n").each do |merge_commit_id|
+            _exit_status, stdout, _stderr = @cmd_runner.run_cmd(<<~EOS, log_to_stdout: log_debug?, no_exception: true, expected_code: [0, 1])
+              cd #{@platform.repository_path} && \
+              git --no-pager log \
+                $(git merge-base \
+                  --octopus \
+                  $(git --no-pager log #{merge_commit_id} --max-count 1 --pretty=format:\"%P\") \
+                )..#{merge_commit_id} \
+                --pretty=format:\"%H\" \
+                --graph \
+              | grep '|'
+            EOS
+            if !stdout.empty?
+              _exit_status, stdout, _stderr = @cmd_runner.run_cmd(
+                "cd #{@platform.repository_path} && git --no-pager log #{merge_commit_id} --pretty=format:%aI",
+                log_to_stdout: log_debug?
+              )
+              error "Git history is not linear because of Merge commit #{merge_commit_id}" if Time.now - Time.parse(stdout.strip) < LOOKING_PERIOD
+            end
+          end
+        end
+
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,82 @@
+module HybridPlatformsConductor
+
+  module HpcPlugins
+
+    module Test
+
+      # Test that the node's local users
+      class LocalUsers < HybridPlatformsConductor::Test
+
+        # Config DSL extension for this test plugin
+        module ConfigDslExtension
+
+          # List of users that should be absent from local users. Each info has the following properties:
+          # * *nodes_selectors_stack* (Array<Object>): Stack of nodes selectors impacted by this rule
+          # * *users* (Array<String>): List of users.
+          # Array< Hash<Symbol, Object> >
+          attr_reader :users_that_should_be_absent
+
+          # List of users that should be present from local users. Each info has the following properties:
+          # * *nodes_selectors_stack* (Array<Object>): Stack of nodes selectors impacted by this rule
+          # * *users* (Array<String>): List of users.
+          # Array< Hash<Symbol, Object> >
+          attr_reader :users_that_should_be_present
+
+          # Initialize the DSL 
+          def init_local_users_test
+            @users_that_should_be_absent = []
+            @users_that_should_be_present = []
+          end
+
+          # Set a list of local users that should be absent.
+          #
+          # Parameters::
+          # * *users* (String or Array<String>): List of (or single) users
+          def check_local_users_do_not_exist(users)
+            @users_that_should_be_absent << {
+              nodes_selectors_stack: current_nodes_selectors_stack,
+              users: users.is_a?(Array) ? users : [users]
+            }
+          end
+
+          # Set a list of local users that should be present.
+          #
+          # Parameters::
+          # * *users* (String or Array<String>): List of (or single) users
+          def check_local_users_do_exist(users)
+            @users_that_should_be_present << {
+              nodes_selectors_stack: current_nodes_selectors_stack,
+              users: users.is_a?(Array) ? users : [users]
+            }
+          end
+
+        end
+
+        self.extend_config_dsl_with ConfigDslExtension, :init_local_users_test
+
+        # Check my_test_plugin.rb.sample documentation for signature details.
+        def test_on_node
+          {
+            "sudo cat /etc/passwd" => proc do |stdout|
+              passwd_users = stdout.map { |passwd_line| passwd_line.split(':').first }
+              missing_users = @nodes_handler.
+                select_confs_for_node(@node, @config.users_that_should_be_present).
+                inject([]) { |merged_users, users_info| merged_users + users_info[:users] }.
+                uniq - passwd_users
+              error "Missing local users that should be present: #{missing_users.join(', ')}" unless missing_users.empty?
+              extra_users = passwd_users & @nodes_handler.
+                select_confs_for_node(@node, @config.users_that_should_be_absent).
+                inject([]) { |merged_users, users_info| merged_users + users_info[:users] }.
+                uniq
+              error "Extra local users that should be absent: #{extra_users.join(', ')}" unless extra_users.empty?
+            end
+          }
+        end
+
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,120 @@
+module HybridPlatformsConductor
+
+  module HpcPlugins
+
+    module Test
+
+      # Various tests on mounts
+      class Mounts < HybridPlatformsConductor::Test
+
+        # Config DSL extension for this test plugin
+        module ConfigDslExtension
+
+          # List of mount rules that should be absent. Each info has the following properties:
+          # * *nodes_selectors_stack* (Array<Object>): Stack of nodes selectors impacted by this rule
+          # * *mount_rules* (Hash<String or Regexp, String or Regexp>): List of rules to check for absence.
+          # Array< Hash<Symbol, Object> >
+          attr_reader :mount_rules_that_should_be_absent
+
+          # List of mount rules that should be present. Each info has the following properties:
+          # * *nodes_selectors_stack* (Array<Object>): Stack of nodes selectors impacted by this rule
+          # * *mount_rules* (Hash<String or Regexp, String or Regexp>): List of rules to check for presence.
+          # Array< Hash<Symbol, Object> >
+          attr_reader :mount_rules_that_should_be_present
+
+          # Initialize the DSL 
+          def init_mounts_test
+            @mount_rules_that_should_be_absent = []
+            @mount_rules_that_should_be_present = []
+          end
+
+          # Give a list of mounts rules to check for absence
+          #
+          # Parameters::
+          # * *mount_rules* (Hash<String or Regexp, String or Regexp>):
+          #     List of (or single) sets of { source => destination } mounts that should not be present.
+          #     Each source or destination can be a string for exact match, or a regexp to match a pattern on the mounts done on the node.
+          def check_mounts_do_not_include(mount_rules)
+            @mount_rules_that_should_be_absent << {
+              mount_rules: mount_rules,
+              nodes_selectors_stack: current_nodes_selectors_stack
+            }
+          end
+
+          # Give a list of mounts rules to check for presence
+          #
+          # Parameters::
+          # * *mount_rules* (Hash<String or Regexp, String or Regexp>):
+          #     List of (or single) sets of { source => destination } mounts that should be present.
+          #     Each source or destination can be a string for exact match, or a regexp to match a pattern on the mounts done on the node.
+          def check_mounts_do_include(mount_rules)
+            @mount_rules_that_should_be_present << {
+              mount_rules: mount_rules,
+              nodes_selectors_stack: current_nodes_selectors_stack
+            }
+          end
+
+        end
+
+        self.extend_config_dsl_with ConfigDslExtension, :init_mounts_test
+
+        # Check my_test_plugin.rb.sample documentation for signature details.
+        def test_on_node
+          {
+            'sudo mount' => proc do |stdout|
+              mounts_info = stdout.map do |line|
+                fields = line.split
+                {
+                  src: fields[0],
+                  dst: fields[2],
+                  type: fields[4],
+                  options: fields[5][1..-2].split(',')
+                }
+              end
+              # Check all mount rules
+              @nodes_handler.select_confs_for_node(@node, @config.mount_rules_that_should_be_present).each do |mount_rules_info|
+                mount_rules_info[:mount_rules].each do |rule_src, rule_dst|
+                  error "Missing mount matching #{rule_src} => #{rule_dst}", "Mounts: #{JSON.pretty_generate(mounts_info)}" unless mounts_info.any? { |mount_info| mount_matches?(mount_info, rule_src, rule_dst) }
+                end
+              end
+              @nodes_handler.select_confs_for_node(@node, @config.mount_rules_that_should_be_absent).each do |mount_rules_info|
+                mount_rules_info[:mount_rules].each do |rule_src, rule_dst|
+                  extra_mounts = mounts_info.select { |mount_info| mount_matches?(mount_info, rule_src, rule_dst) }
+                  error "The following mounts should not be present: #{extra_mounts.map { |mount_info| "#{mount_info[:src]} => #{mount_info[:dst]}" }.join(', ')} as forbidden by the rule #{rule_src} => #{rule_dst}", "Mounts: #{JSON.pretty_generate(mounts_info)}" unless extra_mounts.empty?
+                end
+              end
+            end
+          }
+        end
+
+        private
+
+        # Does a given mount info matches a rule source and destination?
+        #
+        # Parameters::
+        # * *mount_info* (Hash<Symbol,Object>): The mount info
+        #   * *src* (String): Mount source
+        #   * *dst* (String): Mount destination
+        #   * *type* (String): Mount type
+        #   * *options* (Array<String>): Mount options
+        # * *rule_src* (String or Regexp): Rule source
+        # * *rule_dst* (String or Regexp): Rule destination
+        # Result::
+        # * Boolean: Does a given mount info matches a rule source and destination?
+        def mount_matches?(mount_info, rule_src, rule_dst)
+          (
+            (rule_src.is_a?(String) && mount_info[:src] == rule_src) ||
+            (rule_src.is_a?(Regexp) && mount_info[:src] =~ rule_src)
+          ) && (
+            (rule_dst.is_a?(String) && mount_info[:dst] == rule_dst) ||
+            (rule_dst.is_a?(Regexp) && mount_info[:dst] =~ rule_dst)
+          )
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/hybrid_platforms_conductor/hpc_plugins/test/my_test_plugin.rb.sample

@@ -0,0 +1,143 @@
+# This file is an example of a generic Test plugin.
+# The MyTestPlugin example contains example of code that could be used to write a plugin for new tests.
+module HybridPlatformsConductor
+
+  module HpcPlugins
+
+    module Test
+
+      # Brief description of the plugin here.
+      # The name should match the file name.
+      # It should always inherit from Tests::Test.
+      #
+      # A test plugin can define 1 or several test methods, whose name will drive the way the test is run:
+      # * test: Global test run once.
+      # * test_for_platform: Platform-specific test run once per platform.
+      # * test_for_node: Node-specific test run once per node.
+      # * test_on_node: Node-specific test that test some SSH command execution directly on the node.
+      # * test_on_check_node: Node-specific test that test the result of a why-run deployment on the node.
+      # * self.only_on_platforms: Give a list of the platform types this test is supposed to run on. If nil, it means all.
+      # * self.only_on_nodes: Give a list of the node names this test is supposed to run on. If nil, it means all.
+      #
+      # In all instance methods of a test plugin, the following variables are accessible:
+      # * @nodes_handler (NodesHandler): Nodes handler used to access information about the platforms
+      # * @deployer (Deployer): Deployer used to deploy or check on the platforms
+      # In all instance methods of a test plugin, the following methods can be used for assertions (see their description in the file test.rb):
+      # * assert_equal(tested_object, expected_object, error_msg): Check equality between 2 objects and logs an error in case of mismatch.
+      # * assert_match(tested_object, expected_object, error_msg): Check string Regexp matching and logs an error in case of mismatch.
+      # * error(message): Log an error.
+      class MyTestPlugin < HybridPlatformsConductor::Test
+
+        # Are dependencies met before using this plugin?
+        # [API] - This method is optional
+        #
+        # Result::
+        # * Boolean: Are dependencies met before using this plugin?
+        def self.valid?
+          true
+        end
+
+        # Add a Mixin to the DSL parsing the platforms configuration file.
+        # This can be used by any plugin to add plugin-specific configuration getters and setters, accessible later from NodesHandler instances.
+        # An optional initializer can also be given.
+        # [API] - Those calls are optional
+        module MyDSLExtension
+
+          attr_accessor :my_property
+
+          # Initialize the DSL
+          def init_my_dsl_extension
+            @my_property = 42
+          end
+
+        end
+        self.extend_config_dsl_with MyDSLExtension, :init_my_dsl_extension
+
+        # Run test
+        def test
+          # If this method is defined, it will be simply run as is.
+          # This is useful to code global tests, that are not specific to 1 node or 1 platform.
+          assert_equal 2 + 2, 4, 'If this is displayed, it\'s serious!'
+        end
+
+        # Run test for each platform
+        # [API] - @platform can be used to adapt the code with the platform handling this node.
+        def test_for_platform
+          # If this method is defined, it will be used to execute once per platform to be tested.
+          assert_match @platform.repository_path, /my_platform_.+/, 'Platform name does not follow naming convention'
+        end
+
+        # Run test for each node
+        # [API] - @node can be used to adapt the code with the node.
+        def test_for_node
+          # If this method is defined, it will be used to execute once per node to be tested.
+          assert_match @node, /my_node_.+/, 'Node name does not follow naming convention'
+        end
+
+        # Run test using SSH commands on the node.
+        # Instead of executing the SSH commands directly on each node for each test, this method returns the list of commands to run and the test framework then groups them in 1 SSH connection.
+        # [API] - @node can be used to adapt the command with the node.
+        #
+        # Result::
+        # * Hash<String,Object>: For each command to execute, information regarding the assertion.
+        #   * Values can be:
+        #     * Proc: The code block making the test given the stdout of the command. Here is the Proc description:
+        #       * Parameters::
+        #         * *stdout* (Array<String>): List of lines of the stdout of the command.
+        #         * *stderr* (Array<String>): List of lines of the stderr of the command.
+        #         * *return_code* (Integer): The return code of the command.
+        #     * Hash<Symbol,Object>: More complete information, that can contain the following keys:
+        #       * *validator* (Proc): The proc containing the assertions to perform (as described above). This key is mandatory.
+        #       * *timeout* (Integer): Timeout to wait for this command to execute.
+        def test_on_node
+          # If this method is defined, it will be used to execute SSH commands on each node that is being tested.
+          # For each SSH command, a validator code block will be called with the stdout of the command run remotely on the node.
+          # In place of a simple validator code block, a more complex structure can be used to give more info (for example timeout).
+          {
+            'echo 1' => proc do |stdout|
+              assert_equal stdout.first, '1', 'Echo did not return 1 on the node!!!'
+            end,
+            "./longer_test_that_should_return_success.sh --hostname #{@node}" => {
+              validator: proc do |stdout|
+                error 'Test run but failed' if stdout.first == 'Start test' && !(stdout.last =~ /Success/)
+              end,
+              timeout: 30 # If the SSH session does not return in less than 30 seconds, we consider the test failed.
+            }
+          }
+        end
+
+        # Perform some testing on the check-node output.
+        # [API] - @node can be used to know for which node the test is being run.
+        #
+        # Parameters::
+        # * *stdout* (String): The check-node output
+        # * *stderr* (String): The check-node standard error
+        # * *exit_status* (Integer): The check-node exit status
+        def test_on_check_node(stdout, stderr, exit_status)
+          # If this method is defined, the tests runner will execute a why-run deploy on the node and call this method to have assertions on the stdout of the why-run deploy.
+          assert_match stdout.split("\n").last, /Success/, 'check-node did not end correctly'
+        end
+
+        # Limit the list of platform types for these tests.
+        #
+        # Result::
+        # * Array<Symbol> or nil: List of platform types allowed for this test, or nil for all
+        def self.only_on_platforms
+          [:chef]
+        end
+
+        # Limit the list of nodes for these tests.
+        #
+        # Result::
+        # * Array<String or Regex> or nil: List of nodes allowed for this test, or nil for all. Regular expressions matching node names can also be used.
+        def self.only_on_nodes
+          [/^xaehpc.+/, 'project-pinger']
+        end
+
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,74 @@
+module HybridPlatformsConductor
+
+  module HpcPlugins
+
+    module Test
+
+      # Test that the node has no orphan files
+      class OrphanFiles < HybridPlatformsConductor::Test
+
+        # Config DSL extension for this test plugin
+        module ConfigDslExtension
+
+          # List of paths to ignore info. Each info has the following properties:
+          # * *nodes_selectors_stack* (Array<Object>): Stack of nodes selectors impacted by this rule
+          # * *ignored_paths* (Array<String>): List of paths to ignore.
+          # Array< Hash<Symbol, Object> >
+          attr_reader :ignored_orphan_files_paths
+
+          # Initialize the DSL 
+          def init_orphan_files_test
+            # List of paths to ignore info. Each info has the following properties:
+            # * *nodes_selectors_stack* (Array<Object>): Stack of nodes selectors impacted by this rule
+            # * *ignored_paths* (Array<String>): List of paths to ignore.
+            # Array< Hash<Symbol, Object> >
+            @ignored_orphan_files_paths = []
+          end
+
+          # Ignore a list of paths for orphan files testing
+          #
+          # Parameters::
+          # * *paths_to_ignore* (String or Array<String>): List of paths to ignore
+          def ignore_orphan_files_from(paths_to_ignore)
+            @ignored_orphan_files_paths << {
+              ignored_paths: paths_to_ignore.is_a?(Array) ? paths_to_ignore : [paths_to_ignore],
+              nodes_selectors_stack: current_nodes_selectors_stack,
+            }
+          end
+
+        end
+
+        self.extend_config_dsl_with ConfigDslExtension, :init_orphan_files_test
+
+        # List of directories to always ignore
+        DIRECTORIES_TO_ALWAYS_IGNORE = [
+          '/proc',
+          '/sys/kernel/debug',
+          '/sys/kernel/slab'
+        ]
+
+        # Check my_test_plugin.rb.sample documentation for signature details.
+        def test_on_node
+          {
+            "sudo /usr/bin/find / \\( #{@nodes_handler.
+              select_confs_for_node(@node, @config.ignored_orphan_files_paths).
+              inject(DIRECTORIES_TO_ALWAYS_IGNORE) { |merged_paths, paths_to_ignore_info| merged_paths + paths_to_ignore_info[:ignored_paths] }.
+              uniq.
+              map { |dir| "-path #{dir}" }.
+              join(' -o ')
+            } \\) -prune -o -nogroup -nouser -print" => {
+              validator: proc do |stdout|
+                assert_equal stdout, [], "#{stdout.size} orphan files found.", stdout.join("\n")
+              end,
+              timeout: 300
+            }
+          }
+        end
+
+      end
+
+    end
+
+  end
+
+end