hybrid_platforms_conductor 32.17.1 → 32.18.0

data/spec/hybrid_platforms_conductor_test/helpers/deployer_test_helpers.rb

@@ -69,7 +69,7 @@ module HybridPlatformsConductorTest
                   }
                 end
               end
-              actions << proc { |actions_per_nodes| expect_actions_to_upload_logs(actions_per_nodes, services.keys, sudo: sudo) }
+              actions << proc { |actions_per_nodes| expect_actions_to_upload_logs(actions_per_nodes, services.keys) }
             end
             actions
           end
@@ -109,7 +109,7 @@ module HybridPlatformsConductorTest
             additional_config: ''
           )
             platform_name = check_mode ? 'platform' : 'my_remote_platform'
-            with_test_platform(nodes_info, !check_mode, additional_config) do |repository|
+            with_test_platform(nodes_info, !check_mode, additional_config + "\nsend_logs_to :test_log") do |repository|
               # Mock the ServicesHandler accesses
               expect_services_to_deploy = Hash[nodes_info[:nodes].map do |node, node_info|
                 [node, node_info[:services]]

data/spec/hybrid_platforms_conductor_test/test_log_no_read_plugin.rb

@@ -0,0 +1,82 @@
+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.select { |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,103 @@
+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.select { |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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hybrid_platforms_conductor
 version: !ruby/object:Gem::Version
-  version: 32.17.1
+  version: 32.18.0
 platform: ruby
 authors:
 - Muriel Salvan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-03 00:00:00.000000000 Z
+date: 2021-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: range_operators
@@ -354,6 +354,7 @@ extra_rdoc_files:
 - docs/executables/dump_nodes_json.md
 - docs/plugins/platform_handler/serverless_chef.md
 - docs/plugins/platform_handler/yaml_inventory.md
+- docs/plugins/log/remote_fs.md
 - docs/plugins/provisioner/proxmox.md
 - docs/plugins/provisioner/podman.md
 - docs/plugins/provisioner/docker.md
@@ -533,6 +534,7 @@ files:
 - docs/plugins/cmdb/platform_handlers.md
 - docs/plugins/connector/local.md
 - docs/plugins/connector/ssh.md
+- docs/plugins/log/remote_fs.md
 - docs/plugins/platform_handler/serverless_chef.md
 - docs/plugins/platform_handler/yaml_inventory.md
 - docs/plugins/provisioner/docker.md
@@ -679,6 +681,8 @@ files:
 - lib/hybrid_platforms_conductor/hpc_plugins/connector/local.rb
 - lib/hybrid_platforms_conductor/hpc_plugins/connector/my_connector.rb.sample
 - lib/hybrid_platforms_conductor/hpc_plugins/connector/ssh.rb
+- lib/hybrid_platforms_conductor/hpc_plugins/log/my_log_plugin.rb.sample
+- lib/hybrid_platforms_conductor/hpc_plugins/log/remote_fs.rb
 - lib/hybrid_platforms_conductor/hpc_plugins/platform_handler/platform_handler_plugin.rb.sample
 - lib/hybrid_platforms_conductor/hpc_plugins/platform_handler/serverless_chef.rb
 - lib/hybrid_platforms_conductor/hpc_plugins/platform_handler/serverless_chef/dsl_parser.rb
@@ -733,6 +737,7 @@ files:
 - lib/hybrid_platforms_conductor/hpc_plugins/test_report/templates/confluence.html.erb
 - lib/hybrid_platforms_conductor/io_router.rb
 - lib/hybrid_platforms_conductor/json_dumper.rb
+- lib/hybrid_platforms_conductor/log.rb
 - lib/hybrid_platforms_conductor/logger_helpers.rb
 - lib/hybrid_platforms_conductor/mutex_dir
 - lib/hybrid_platforms_conductor/nodes_handler.rb
@@ -783,6 +788,7 @@ files:
 - spec/hybrid_platforms_conductor_test/api/deployer/check_spec.rb
 - spec/hybrid_platforms_conductor_test/api/deployer/config_dsl_spec.rb
 - spec/hybrid_platforms_conductor_test/api/deployer/deploy_spec.rb
+- spec/hybrid_platforms_conductor_test/api/deployer/log_plugins/remote_fs_spec.rb
 - spec/hybrid_platforms_conductor_test/api/deployer/parse_deploy_output_spec.rb
 - spec/hybrid_platforms_conductor_test/api/deployer/provisioner_spec.rb
 - spec/hybrid_platforms_conductor_test/api/deployer/provisioners/docker/Dockerfile
@@ -925,6 +931,8 @@ files:
 - spec/hybrid_platforms_conductor_test/serverless_chef_repositories/several_nodes/policyfiles/test_policy_2.rb
 - spec/hybrid_platforms_conductor_test/test_action.rb
 - spec/hybrid_platforms_conductor_test/test_connector.rb
+- spec/hybrid_platforms_conductor_test/test_log_no_read_plugin.rb
+- spec/hybrid_platforms_conductor_test/test_log_plugin.rb
 - spec/hybrid_platforms_conductor_test/test_plugins/global.rb
 - spec/hybrid_platforms_conductor_test/test_plugins/node.rb
 - spec/hybrid_platforms_conductor_test/test_plugins/node_check.rb