Contents

module HybridPlatformsConductor

  module HpcPlugins

    module Action

      # Execute Bash commands locally
      class Bash < HybridPlatformsConductor::Action

        # Setup the action.
        # This is called by the constructor itself, when an action is instantiated to be executed for a node.
        # [API] - This method is optional
        # [API] - @cmd_runner is accessible
        # [API] - @actions_executor is accessible
        #
        # Parameters::
        # * *cmd* (String or SecretString): The bash command to execute
        def setup(cmd)
          @cmd = cmd
        end

        # Execute the action
        # [API] - This method is mandatory
        # [API] - @cmd_runner is accessible
        # [API] - @actions_executor is accessible
        # [API] - @action_info is accessible with the action details
        # [API] - @node (String) can be used to know on which node the action is to be executed
        # [API] - @connector (Connector or nil) can be used to access the node's connector if the action needs remote connection
        # [API] - @timeout (Integer) should be used to make sure the action execution does not get past this number of seconds
        # [API] - @stdout_io can be used to log stdout messages
        # [API] - @stderr_io can be used to log stderr messages
        # [API] - run_cmd(String) method can be used to execute a command. See CmdRunner#run_cmd to know about the result's signature.
        def execute
          log_debug "[#{@node}] - Execute local Bash commands \"#{@cmd}\"..."
          run_cmd @cmd
        end

      end

    end

  end

end

Version data entries

18 entries across 18 versions & 1 rubygems

Version	Path
hybrid_platforms_conductor-33.9.5	lib/hybrid_platforms_conductor/hpc_plugins/action/bash.rb
hybrid_platforms_conductor-33.9.4	lib/hybrid_platforms_conductor/hpc_plugins/action/bash.rb
hybrid_platforms_conductor-33.9.2	lib/hybrid_platforms_conductor/hpc_plugins/action/bash.rb
hybrid_platforms_conductor-33.9.1	lib/hybrid_platforms_conductor/hpc_plugins/action/bash.rb
hybrid_platforms_conductor-33.9.0	lib/hybrid_platforms_conductor/hpc_plugins/action/bash.rb
hybrid_platforms_conductor-33.8.4	lib/hybrid_platforms_conductor/hpc_plugins/action/bash.rb
hybrid_platforms_conductor-33.8.3	lib/hybrid_platforms_conductor/hpc_plugins/action/bash.rb
hybrid_platforms_conductor-33.8.2	lib/hybrid_platforms_conductor/hpc_plugins/action/bash.rb
hybrid_platforms_conductor-33.8.1	lib/hybrid_platforms_conductor/hpc_plugins/action/bash.rb
hybrid_platforms_conductor-33.8.0	lib/hybrid_platforms_conductor/hpc_plugins/action/bash.rb
hybrid_platforms_conductor-33.7.4	lib/hybrid_platforms_conductor/hpc_plugins/action/bash.rb
hybrid_platforms_conductor-33.7.3	lib/hybrid_platforms_conductor/hpc_plugins/action/bash.rb
hybrid_platforms_conductor-33.7.2	lib/hybrid_platforms_conductor/hpc_plugins/action/bash.rb
hybrid_platforms_conductor-33.7.1	lib/hybrid_platforms_conductor/hpc_plugins/action/bash.rb
hybrid_platforms_conductor-33.7.0	lib/hybrid_platforms_conductor/hpc_plugins/action/bash.rb
hybrid_platforms_conductor-33.6.0	lib/hybrid_platforms_conductor/hpc_plugins/action/bash.rb
hybrid_platforms_conductor-33.5.1	lib/hybrid_platforms_conductor/hpc_plugins/action/bash.rb
hybrid_platforms_conductor-33.5.0	lib/hybrid_platforms_conductor/hpc_plugins/action/bash.rb