script_executor

ScriptExecutor - This library helps to execute code, locally or remote over ssh

Installation

Add this line to your application's Gemfile:

gem 'script_executor'

And then execute:

bundle

Or install it yourself as:

gem install script_executor

Usage

# Create executor
executor = ScriptExecutor.new

• Execute local command:

executor.execute "ls"

• Execute remote command:

server_info = {
  :remote => true,
  :domain => "some_host",
  :user => "some_user",
  :password => "some_password"
}

executor.execute server_info.merge(:script => "ls -al")

• Execute remote command as 'sudo':

executor.execute server_info.merge({:sudo => true, :script => "/etc/init.d/tomcat stop"})

• Execute remote command with code block:

executor.execute server_info.merge(:sudo => true) do
  %Q(
    /etc/init.d/tomcat stop
    /etc/init.d/tomcat start
  )
end

• Execute remote command while capturing and suppressing output (default is 'false'):

server_info.merge(:capture_output => true, :suppress_output => true)

result = executor.execute server_info.merge(:script => "whoami")

puts result # ENV['USER']

• Simulate remote execution:

server_info.merge(:simulate => true)

executor.execute server_info.merge(:script => "whoami") # generate commands without actual execution

Using ScriptLocator

You can keep scripts that needs to be executed embedded into your code (as in examples above), move them into separate file or keep them in same file behind "END" Ruby directive. The latter gives you the ability to keep command and code together thus simplifying access to code.

For example, if you want to create script with 2 commands (command1, command2), you can use "scripts" and "evaluate_script_body" methods:

require 'script_locator'

include ScriptLocator

scripts = scripts(__FILE__) # [command1, command2]

name = "john"

result = evaluate_script_body(scripts[:command1][:code], binding)

puts result # john
__END__

[command1]

echo "<%= name %>"

[command2]

echo "test2"

Using BaseProvision

• Create project configuration file:

# base.conf.json
{
  "node": {
    "domain": "22.22.22.22", // remote host, see "config.vm.synced_folder"
    "port": "22",            // default ssh port
    "user": "vagrant",       // vagrant user name
    "password": "vagrant",   // vagrant user password
    "home": "/home/vagrant",
    "remote": true
  },

  "project": {
    "home": "#{node.home}/acceptance_demo",
    "ruby_version": "2.2.3",
    "gemset": "acceptance_demo"
  }
}

• Create file with shell commands:

# script.sh


[echo]

echo "Hello world!"


[ubuntu_update]

sudo apt-get update

• Create provision based on thor and use it:

# install.thor

class MyProvision < Thor
  @provision = BaseProvision.new self, 'base.conf.json', ['script.sh']
  @provision.create_thor_methods(self)
  
  desc "local_command", "local_command"
  def local_command
    invoke :echo
    invoke :ubuntu_update
  end
end

my_provision = MyProvision.new

thor my_provision:echo
thor my_provision:ubuntu_update

thor my_provision:local_command

Contributing

• Fork it
• Create your feature branch (git checkout -b my-new-feature)
• Commit your changes (git commit -am 'Added some feature')
• Push to the branch (git push origin my-new-feature)
• Create new Pull Request