hybrid_platforms_conductor 32.17.0 → 33.0.2

data/spec/hybrid_platforms_conductor_test/test_connector.rb

@@ -45,7 +45,7 @@ module HybridPlatformsConductorTest
     #
     # Parameters::
     # * *options_parser* (OptionParser): The option parser to complete
-    def options_parse(options_parser)
+    def options_parse(_options_parser)
       @calls << [:options_parse]
     end
 
@@ -102,7 +102,7 @@ module HybridPlatformsConductorTest
     # * *bash_cmds* (String): Bash commands to execute
     def remote_bash(bash_cmds)
       @calls << [:remote_bash, bash_cmds]
-      @remote_bash_code.call(@stdout_io, @stderr_io, self) unless @remote_bash_code.nil?
+      @remote_bash_code&.call(@stdout_io, @stderr_io, self)
     end
 
     # Execute an interactive shell on the remote node
@@ -140,7 +140,7 @@ module HybridPlatformsConductorTest
       extra_opts[:owner] = owner if owner
       extra_opts[:group] = group if group
       @calls << [:remote_copy, from, to] + (extra_opts.empty? ? [] : [extra_opts])
-      @remote_copy_code.call(@stdout_io, @stderr_io, self) unless @remote_copy_code.nil?
+      @remote_copy_code&.call(@stdout_io, @stderr_io, self)
     end
 
     # Integer: The current desired timeout

data/spec/hybrid_platforms_conductor_test/test_log_no_read_plugin.rb

@@ -0,0 +1,84 @@
+module HybridPlatformsConductorTest
+
+  # Test log without reading actions
+  class TestLogNoReadPlugin < HybridPlatformsConductor::Log
+
+    class << self
+
+      attr_accessor :calls
+
+    end
+
+    # Get actions to save logs
+    # [API] - This method is mandatory.
+    # [API] - The following API components are accessible:
+    # * *@config* (Config): Main configuration API.
+    # * *@nodes_handler* (NodesHandler): Nodes handler API.
+    # * *@actions_executor* (ActionsExecutor): Actions executor API.
+    #
+    # Parameters::
+    # * *node* (String): Node for which logs are being saved
+    # * *services* (Array<String>): The list of services that have been deployed on this node
+    # * *deployment_info* (Hash<Symbol,Object>): Additional information to attach to the logs
+    # * *exit_status* (Integer or Symbol): Exit status of the deployment
+    # * *stdout* (String): Deployment's stdout
+    # * *stderr* (String): Deployment's stderr
+    # Result::
+    # * Array< Hash<Symbol,Object> >: List of actions to be done
+    def actions_to_save_logs(node, services, deployment_info, exit_status, stdout, stderr)
+      TestLogNoReadPlugin.calls << {
+        method: :actions_to_save_logs,
+        node: node,
+        services: services,
+        # Don't store the date
+        deployment_info: deployment_info.reject { |k, _v| k == :date },
+        exit_status: exit_status,
+        stdout: stdout,
+        stderr: stderr
+      }
+      [{ bash: "echo Save test logs to #{node}" }]
+    end
+
+    # Get deployment logs from a node.
+    # This method can use the result of actions previously run to read logs, as returned by the actions_to_read_logs method.
+    # [API] - This method is mandatory.
+    # [API] - The following API components are accessible:
+    # * *@config* (Config): Main configuration API.
+    # * *@nodes_handler* (NodesHandler): Nodes handler API.
+    # * *@actions_executor* (ActionsExecutor): Actions executor API.
+    #
+    # Parameters::
+    # * *node* (String): The node we want deployment logs from
+    # * *exit_status* (Integer, Symbol or nil): Exit status of actions to read logs, or nil if no action was returned by actions_to_read_logs
+    # * *stdout* (String or nil): stdout of actions to read logs, or nil if no action was returned by actions_to_read_logs
+    # * *stderr* (String or nil): stderr of actions to read logs, or nil if no action was returned by actions_to_read_logs
+    # Result::
+    # * Hash<Symbol,Object>: Deployment log information:
+    #   * *error* (String): Error string in case deployment logs could not be retrieved. If set then further properties will be ignored. [optional]
+    #   * *services* (Array<String>): List of services deployed on the node
+    #   * *deployment_info* (Hash<Symbol,Object>): Deployment metadata
+    #   * *exit_status* (Integer or Symbol): Deployment exit status
+    #   * *stdout* (String): Deployment stdout
+    #   * *stderr* (String): Deployment stderr
+    def logs_for(node, exit_status, stdout, stderr)
+      TestLogNoReadPlugin.calls << {
+        method: :logs_for,
+        node: node,
+        exit_status: exit_status,
+        stdout: stdout,
+        stderr: stderr
+      }
+      {
+        services: %w[unknown],
+        deployment_info: {
+          user: 'test_user'
+        },
+        exit_status: 666,
+        stdout: 'Deployment test stdout',
+        stderr: 'Deployment test stderr'
+      }
+    end
+
+  end
+
+end

data/spec/hybrid_platforms_conductor_test/test_log_plugin.rb

@@ -0,0 +1,105 @@
+module HybridPlatformsConductorTest
+
+  # Test log
+  class TestLogPlugin < HybridPlatformsConductor::Log
+
+    class << self
+
+      attr_accessor :calls
+
+    end
+
+    # Get actions to save logs
+    # [API] - This method is mandatory.
+    # [API] - The following API components are accessible:
+    # * *@config* (Config): Main configuration API.
+    # * *@nodes_handler* (NodesHandler): Nodes handler API.
+    # * *@actions_executor* (ActionsExecutor): Actions executor API.
+    #
+    # Parameters::
+    # * *node* (String): Node for which logs are being saved
+    # * *services* (Array<String>): The list of services that have been deployed on this node
+    # * *deployment_info* (Hash<Symbol,Object>): Additional information to attach to the logs
+    # * *exit_status* (Integer or Symbol): Exit status of the deployment
+    # * *stdout* (String): Deployment's stdout
+    # * *stderr* (String): Deployment's stderr
+    # Result::
+    # * Array< Hash<Symbol,Object> >: List of actions to be done
+    def actions_to_save_logs(node, services, deployment_info, exit_status, stdout, stderr)
+      TestLogPlugin.calls << {
+        method: :actions_to_save_logs,
+        node: node,
+        services: services,
+        # Don't store the date
+        deployment_info: deployment_info.reject { |k, _v| k == :date },
+        exit_status: exit_status,
+        stdout: stdout,
+        stderr: stderr
+      }
+      [{ bash: "echo Save test logs to #{node}" }]
+    end
+
+    # Get actions to read logs.
+    # If provided, this method can return some actions to be executed that will fetch logs from servers or remote nodes.
+    # By using this method to run actions instead of the synchronous method logs_from, such actions will be run in parallel which can greatly improve time-consuming operations when querying a lot of nodes.
+    # [API] - This method is optional.
+    # [API] - The following API components are accessible:
+    # * *@config* (Config): Main configuration API.
+    # * *@nodes_handler* (NodesHandler): Nodes handler API.
+    # * *@actions_executor* (ActionsExecutor): Actions executor API.
+    #
+    # Parameters::
+    # * *node* (String): Node for which deployment logs are being read
+    # Result::
+    # * Array< Hash<Symbol,Object> >: List of actions to be done
+    def actions_to_read_logs(node)
+      TestLogPlugin.calls << {
+        method: :actions_to_read_logs,
+        node: node
+      }
+      [{ bash: "echo Read logs for #{node}" }]
+    end
+
+    # Get deployment logs from a node.
+    # This method can use the result of actions previously run to read logs, as returned by the actions_to_read_logs method.
+    # [API] - This method is mandatory.
+    # [API] - The following API components are accessible:
+    # * *@config* (Config): Main configuration API.
+    # * *@nodes_handler* (NodesHandler): Nodes handler API.
+    # * *@actions_executor* (ActionsExecutor): Actions executor API.
+    #
+    # Parameters::
+    # * *node* (String): The node we want deployment logs from
+    # * *exit_status* (Integer, Symbol or nil): Exit status of actions to read logs, or nil if no action was returned by actions_to_read_logs
+    # * *stdout* (String or nil): stdout of actions to read logs, or nil if no action was returned by actions_to_read_logs
+    # * *stderr* (String or nil): stderr of actions to read logs, or nil if no action was returned by actions_to_read_logs
+    # Result::
+    # * Hash<Symbol,Object>: Deployment log information:
+    #   * *error* (String): Error string in case deployment logs could not be retrieved. If set then further properties will be ignored. [optional]
+    #   * *services* (Array<String>): List of services deployed on the node
+    #   * *deployment_info* (Hash<Symbol,Object>): Deployment metadata
+    #   * *exit_status* (Integer or Symbol): Deployment exit status
+    #   * *stdout* (String): Deployment stdout
+    #   * *stderr* (String): Deployment stderr
+    def logs_for(node, exit_status, stdout, stderr)
+      TestLogPlugin.calls << {
+        method: :logs_for,
+        node: node,
+        exit_status: exit_status,
+        stdout: stdout,
+        stderr: stderr
+      }
+      {
+        services: %w[unknown],
+        deployment_info: {
+          user: 'test_user'
+        },
+        exit_status: 666,
+        stdout: 'Deployment test stdout',
+        stderr: 'Deployment test stderr'
+      }
+    end
+
+  end
+
+end

data/spec/hybrid_platforms_conductor_test/test_plugins/global.rb

@@ -20,6 +20,7 @@ module HybridPlatformsConductorTest
       # Check my_test_plugin.rb.sample documentation for signature details.
       def test
         raise 'Failing test' if Global.fail
+
         Global.nbr_runs += 1
       end
 

data/spec/hybrid_platforms_conductor_test/test_plugins/node.rb

@@ -33,6 +33,7 @@ module HybridPlatformsConductorTest
       # Check my_test_plugin.rb.sample documentation for signature details.
       def test_for_node
         raise "Failing test #{@name} for #{@node}" if Node.fail_for.key?(@name) && Node.fail_for[@name].include?(@node)
+
         sleep_time = Node.sleeps.dig(@name, @node)
         sleep sleep_time unless sleep_time.nil?
         Node.runs << [@name, @node]

data/spec/hybrid_platforms_conductor_test/test_plugins/node_check.rb

@@ -29,6 +29,7 @@ module HybridPlatformsConductorTest
       # Check my_test_plugin.rb.sample documentation for signature details.
       def test_on_check_node(stdout, stderr, exit_status)
         raise 'Failing test' if NodeCheck.fail_for.include? @node
+
         NodeCheck.runs << [@name, @node, stdout, stderr, exit_status]
       end
 

data/spec/hybrid_platforms_conductor_test/test_plugins/platform.rb

@@ -30,6 +30,7 @@ module HybridPlatformsConductorTest
       def test_on_platform
         platform_name = @platform.name
         raise 'Failing test' if Platform.fail_for.include? platform_name
+
         sleep_time = Platform.sleeps.dig(@name, platform_name)
         sleep sleep_time unless sleep_time.nil?
         Platform.runs << [@name, platform_name]

data/spec/hybrid_platforms_conductor_test/test_plugins/several_checks.rb

@@ -32,14 +32,14 @@ module HybridPlatformsConductorTest
       # Check my_test_plugin.rb.sample documentation for signature details.
       def test_on_node
         {
-          "test_#{@node}.sh" => proc do |stdout, stderr, exit_code|
+          "test_#{@node}.sh" => proc do |stdout, stderr|
             SeveralChecks.runs << [@name, @node, "Node SSH test: #{stdout.join("\n")} - #{stderr.join("\n")}"]
           end
         }
       end
 
       # Check my_test_plugin.rb.sample documentation for signature details.
-      def test_on_check_node(stdout, stderr, exit_status)
+      def test_on_check_node(stdout, _stderr, _exit_status)
         SeveralChecks.runs << [@name, @node, "Node check-node test: #{stdout}"]
       end
 

data/spec/hybrid_platforms_conductor_test/test_secrets_reader_plugin.rb

@@ -0,0 +1,45 @@
+require 'hybrid_platforms_conductor/secrets_reader'
+
+module HybridPlatformsConductorTest
+
+  # Mock a secrets reader plugin
+  class TestSecretsReaderPlugin < HybridPlatformsConductor::SecretsReader
+
+    class << self
+
+      attr_accessor :calls, :deployer, :mocked_secrets
+
+    end
+
+    # Return secrets for a given service to be deployed on a node.
+    # [API] - This method is mandatory
+    # [API] - The following API components are accessible:
+    # * *@config* (Config): Main configuration API.
+    # * *@cmd_runner* (CmdRunner): Command Runner API.
+    # * *@nodes_handler* (NodesHandler): Nodes handler API.
+    #
+    # Parameters::
+    # * *node* (String): Node to be deployed
+    # * *service* (String): Service to be deployed
+    # Result::
+    # * Hash: The secrets
+    def secrets_for(node, service)
+      # Get the name by looking into the plugins' map
+      plugin_name, _plugin = TestSecretsReaderPlugin.deployer.instance_variable_get(:@secrets_readers).find { |_plugin_name, plugin| plugin == self }
+      TestSecretsReaderPlugin.calls << {
+        instance: plugin_name,
+        node: node,
+        service: service
+      }
+      TestSecretsReaderPlugin.mocked_secrets.dig(node, service, plugin_name) || {
+        node => {
+          service => {
+            plugin_name.to_s => 'Secret value'
+          }
+        }
+      }
+    end
+
+  end
+
+end

data/spec/hybrid_platforms_conductor_test/tests_report_plugin.rb

@@ -4,9 +4,11 @@ module HybridPlatformsConductorTest
   class TestsReportPlugin < HybridPlatformsConductor::TestReport
 
     class << self
+
       # Reports (that can be compared), per report name
       # Array< Hash<Symbol, Object> >
       attr_accessor :reports
+
     end
 
     # Handle tests reports
@@ -15,12 +17,9 @@ module HybridPlatformsConductorTest
         global_tests: report_from(global_tests),
         platform_tests: report_from(platform_tests),
         node_tests: report_from(node_tests),
-        errors_per_test: Hash[group_errors(node_tests, :test_name).map do |test_name, errors|
-          [
-            test_name,
-            errors.map { |error| error.split("\n").first }
-          ]
-        end],
+        errors_per_test: group_errors(node_tests, :test_name).transform_values do |errors|
+          errors.map { |error| error.split("\n").first }
+        end,
         nodes_by_nodes_list: nodes_by_nodes_list
       }
     end

data/spec/spec_helper.rb

@@ -32,7 +32,7 @@ RSpec.configure do |config|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
 
     # Increase the diffs length being output, as some tests are dealing with a few lines of stdout
-    expectations.max_formatted_output_length = 65536
+    expectations.max_formatted_output_length = 65_536
 
   end
 
@@ -55,57 +55,56 @@ RSpec.configure do |config|
   # triggering implicit auto-inclusion in groups with matching metadata.
   config.shared_context_metadata_behavior = :apply_to_host_groups
 
-# The settings below are suggested to provide a good initial experience
-# with RSpec, but feel free to customize to your heart's content.
-=begin
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+
   # This allows you to limit a spec run to individual examples or groups
   # you care about by tagging them with `:focus` metadata. When nothing
   # is tagged with `:focus`, all examples get run. RSpec also provides
   # aliases for `it`, `describe`, and `context` that include `:focus`
   # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
-  config.filter_run_when_matching :focus
+  # config.filter_run_when_matching :focus
 
   # Allows RSpec to persist some state between runs in order to support
   # the `--only-failures` and `--next-failure` CLI options. We recommend
   # you configure your source control system to ignore this file.
-  config.example_status_persistence_file_path = "spec/examples.txt"
+  # config.example_status_persistence_file_path = "spec/examples.txt"
 
   # Limits the available syntax to the non-monkey patched syntax that is
   # recommended. For more details, see:
   #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
   #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
   #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
-  config.disable_monkey_patching!
+  # config.disable_monkey_patching!
 
   # This setting enables warnings. It's recommended, but in some cases may
   # be too noisy due to issues in dependencies.
-  config.warnings = true
+  # config.warnings = true
 
   # Many RSpec users commonly either run the entire suite or an individual
   # file, and it's useful to allow more verbose output when running an
   # individual spec file.
-  if config.files_to_run.one?
-    # Use the documentation formatter for detailed output,
-    # unless a formatter has already been configured
-    # (e.g. via a command-line flag).
-    config.default_formatter = "doc"
-  end
+  # if config.files_to_run.one?
+  #   # Use the documentation formatter for detailed output,
+  #   # unless a formatter has already been configured
+  #   # (e.g. via a command-line flag).
+  #   config.default_formatter = "doc"
+  # end
 
   # Print the 10 slowest examples and example groups at the
   # end of the spec run, to help surface which specs are running
   # particularly slow.
-  config.profile_examples = 10
+  # config.profile_examples = 10
 
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing
   # the seed, which is printed after each run.
   #     --seed 1234
-  config.order = :random
+  # config.order = :random
 
   # Seed global randomization in this process using the `--seed` CLI option.
   # Setting this allows you to use `--seed` to deterministically reproduce
   # test failures related to randomization by passing the same `--seed` value
   # as the one that triggered the failure.
-  Kernel.srand config.seed
-=end
+  # Kernel.srand config.seed
 end

data/tools/check_md

@@ -18,7 +18,7 @@ def link_to_file(link, file)
   if link_file == ''
     file
   elsif link_file.start_with?('/')
-    link_file[1..-1]
+    link_file[1..]
   else
     File.expand_path("#{File.dirname(file)}/#{link_file}").gsub("#{Dir.pwd}/", '')
   end
@@ -29,22 +29,20 @@ end
 # Parameters::
 # * *file* (String): Markdown file to be parsed
 def parse_md(file)
-  unless @info.key?(file)
-    puts "Parsing #{file}..."
-    content = File.read(file)
-    @info[file] = {
-      anchors: content.scan(/<a name="([^"]*)"><\/a>/).map { |(anchor)| anchor },
-      links: content.scan(/\[[^\]]*\]\(([^\)]*)\)/).map { |(link)| link }
-    }
-    # Parse linked files
-    @info[file][:links].each do |link|
-      puts "Found #{file} => #{link}"
-    end
-    @info[file][:links].each do |link|
-      unless link.start_with?('http')
-        linked_file = link_to_file(link, file)
-        parse_md(linked_file) if File.exist?(linked_file) && linked_file.end_with?('.md')
-      end
+  return if @info.key?(file)
+
+  puts "Parsing #{file}..."
+  content = File.read(file)
+  @info[file] = {
+    anchors: content.scan(%r{<a name="([^"]*)"></a>}).map { |(anchor)| anchor },
+    links: content.scan(/\[[^\]]*\]\(([^)]*)\)/).map { |(link)| link }
+  }
+  # Parse linked files
+  @info[file][:links].each do |link|
+    puts "Found #{file} => #{link}"
+    unless link.start_with?('http')
+      linked_file = link_to_file(link, file)
+      parse_md(linked_file) if File.exist?(linked_file) && linked_file.end_with?('.md')
     end
   end
 end
@@ -63,9 +61,7 @@ errors = []
         anchor = link.split('#')[1]
         linked_file = link_to_file(link, file)
         if @info.key?(linked_file)
-          if anchor.nil?
-            '*'
-          elsif @info[linked_file][:anchors].include?(anchor)
+          if anchor.nil? || @info[linked_file][:anchors].include?(anchor)
             '*'
           else
             errors << "[#{file} -> #{link}] - Destination has no anchor named #{anchor}"