Class: Train::Extras::CommandWrapperBase

Inherits:

Object

• Object
• Train::Extras::CommandWrapperBase

Defined in:

lib/train/extras/command_wrapper.rb

Overview

Define the interface of all command wrappers.

Direct Known Subclasses

LinuxCommand, WindowsCommand

Instance Method Summary

• #run(_command) ⇒ String

  Wrap a command and return the augmented command which can be executed.

• #verify ⇒ Any

  Verify that the command wrapper is initialized properly and working.

Instance Method Details

#run(_command) ⇒ String

Wrap a command and return the augmented command which can be executed.

Parameters:

• command (Strin) —

  that will be wrapper

Returns:

• (String) —

  result of wrapping the command

Raises:

• (Train::ClientError)

# File 'lib/train/extras/command_wrapper.rb', line 21

def run(_command)
  raise Train::ClientError, "#{self.class} does not implement #run(command)"
end

#verify ⇒ Any

Verify that the command wrapper is initialized properly and working.

Returns:

• (Any) —

  verification result, nil if all went well, otherwise a message

Raises:

• (Train::ClientError)

# File 'lib/train/extras/command_wrapper.rb', line 13

def verify
  raise Train::ClientError, "#{self.class} does not implement #verify()"
end