script_executor 1.3.2 → 1.3.4

data/.ruby-gemset

@@ -0,0 +1 @@
+script_executor

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3

data/CHANGES

@@ -32,4 +32,12 @@
 
 == Version 1.3.2
 
-* Big fix.
+* Big fix.
+
+== Version 1.3.3
+
+* Big fix.
+
+== Version 1.3.4
+
+* Internal refactoring.

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source "https://rubygems.org"
 
 group :default do
   gem "highline"
@@ -15,16 +15,9 @@ group :test do
   gem "mocha"
 end
 
-#group :debug do
-#  if RUBY_VERSION.include? "1.9"
-#    unless File.exist? "#{ENV['GEM_HOME']}/gems/linecache19-0.5.13/lib/linecache19.rb"
-#      `curl -OL http://rubyforge.org/frs/download.php/75414/linecache19-0.5.13.gem`
-#      `gem i linecache19-0.5.13.gem`
-#    end
-#
-#    gem "linecache19", "0.5.13"
-#    gem "ruby-debug-base19x", "0.11.30.pre10"
-#    gem "ruby-debug-ide", "0.4.17.beta14"
-#  end
-#end
+group :debug do
+  gem "ruby-debug-base19x", "0.11.30.pre12"
+  gem "ruby-debug-ide", "0.4.17"
+end
+
 

data/Gemfile.lock

@@ -1,6 +1,7 @@
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
+    debugger-ruby_core_source (1.2.2)
     diff-lcs (1.1.3)
     file_utils (1.0.6)
     gemcutter (0.7.1)
@@ -11,6 +12,7 @@ GEM
     mocha (0.13.1)
       metaclass (~> 0.0.1)
     net-ssh (2.6.2)
+    rake (10.0.4)
     rspec (2.12.0)
       rspec-core (~> 2.12.0)
       rspec-expectations (~> 2.12.0)
@@ -19,6 +21,11 @@ GEM
     rspec-expectations (2.12.1)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.12.0)
+    ruby-debug-base19x (0.11.30.pre12)
+      debugger-ruby_core_source (>= 1.1.4)
+      rake (>= 0.8.1)
+    ruby-debug-ide (0.4.17)
+      rake (>= 0.8.1)
 
 PLATFORMS
   ruby
@@ -30,3 +37,5 @@ DEPENDENCIES
   mocha
   net-ssh
   rspec
+  ruby-debug-base19x (= 0.11.30.pre12)
+  ruby-debug-ide (= 0.4.17)

data/README.md

@@ -4,39 +4,115 @@
 
 Add this line to your application's Gemfile:
 
-    gem 'script_executor'
-
+```bash
+gem 'script_executor'
+```
 And then execute:
 
-    $ bundle
+```bash
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install script_executor
+```bash
+gem install script_executor
+```
 
 ## Usage
-    
-    executor = ScriptExecutor.new
 
-    executor.execute "ls" # execute locally
+```ruby
+# Create executor
+executor = ScriptExecutor.new
+```
+
+* Execute local command:
+
+```ruby
+executor.execute "ls"
+```
+
+* Execute remote command:
+
+```ruby
+server_info = {
+  :remote => true,
+  :domain => "some.host",
+  :user => "some.user",
+}
+
+executor.execute server_info.merge(:script => "ls -al")
+```
+
+* Execute remote command as 'sudo':
+
+```ruby
+executor.execute server_info.merge({:sudo => true, :script => "/etc/init.d/tomcat stop"})
+```
+
+* Execute remote command with code block:
+
+```ruby
+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'):
+
+```ruby
+server_info.merge(:capture_output => true, :suppress_output => true)
+
+result = executor.execute server_info.merge(:script => "whoami")
+
+puts result # ENV['USER']
+```
+
+* Simulate remote execution:
+
+```ruby
+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:
+
+```ruby
+require 'script_locator'
+
+include ScriptLocator
+
+puts scripts(__FILE__) # [command1, command2]
+
+name = "john"
+
+result = evaluate_script_body(result['command1'], binding)
+
+puts result # john
+__END__
+
+[command1]
 
-    executor.execute :remote => true, :script => "ls -al", :domain => "localhost", :user => "user" # execute remote
+echo "<%= name %>"
 
-    executor.remote_execute :script => "ls -al", :domain => "localhost", :user => "user" # execute remote
+[command2]
 
-    executor.remote_execute :sudo => true, :script => "/etc/init.d/tomcat stop", :domain => "somehost", :user => "user" # execute remote
+echo "test2"
+```
 
-    server_info = {  
-      :domain => "some.host",
-      :user => "some.user",
-    }
 
-    executor.remote_execute :sudo => true, server_info do # execute remote with sudo
-      %Q(
-        /etc/init.d/tomcat stop
-        /etc/init.d/tomcat start
-      )
-    end
 
 ## Contributing
 

data/lib/executable.rb

@@ -1,3 +1 @@
-require 'rubygems' unless Object.const_defined?(:Gem)
-
 require 'script_executor/executable'

data/lib/script_executor.rb

@@ -1,3 +1 @@
-require 'rubygems' unless Object.const_defined?(:Gem)
-
 require 'script_executor/script_executor'

data/lib/script_executor/executable.rb

@@ -1,14 +1,8 @@
-require 'net/ssh'
-require "highline/import"
-
-require 'script_executor/output_buffer'
+require 'script_executor/local_command'
+require 'script_executor/remote_command'
 
 module Executable
 
-  def output
-    @output ||= $stdout
-  end
-
   def execute params={}, &code
     if params.class != Hash
       simple_commands = commands_from_object(params)
@@ -21,120 +15,25 @@ module Executable
     commands = locate_commands script, &code
 
     if commands.nil?
-      output.puts "No commands were provided!"
-      return
-    end
-
-    commands = sudo(commands) if params[:sudo]
-
-    remote         = params[:remote]
-    domain         = params[:domain]
-    user           = params[:user]
-    password       = params[:password]
-    capture_output = params[:capture_output]
-    suppress_output = params[:suppress_output]
-    simulate       = params[:simulate]
-    line_action    = params[:line_action]
-
-    print_execution commands, remote, domain, user, nil, simulate
+      output.puts "No command was provided!"
+    else
+      commands = sudo(commands) if params[:sudo]
 
-    unless simulate
-      storage = capture_output ? OutputBuffer.new : nil
-      suppress_output = suppress_output.nil? ? capture_output : suppress_output
+      remote = params.delete(:remote)
+      line_action = params.delete(:line_action)
 
       if remote
-        execute_ssh commands, domain, user, password, line_action, suppress_output, storage
+        command = RemoteCommand.new params
       else
-        execute_command commands, password, line_action, suppress_output, storage
+        command = LocalCommand.new params
       end
 
-      storage.buffer.join("\n") if storage
+      command.execute commands, line_action
     end
   end
 
   private
 
-  def print_execution commands, remote, domain, user, identity_file, simulate
-    if remote
-      ssh_command = ssh_command(domain, user, identity_file)
-
-      if simulate
-        output.puts "Remote script: '#{ssh_command}'"
-        output.puts "-------"
-        print_commands commands
-        output.puts "-------"
-      else
-        output.puts "Remote execution on: '#{ssh_command}'"
-        output.puts "-------"
-        print_commands commands
-        output.puts "-------"
-      end
-    else
-      if simulate
-        output.puts "Script:"
-        output.puts "-------"
-        print_commands commands
-        output.puts "-------"
-      else
-        output.puts "Local execution:"
-        output.puts "-------"
-        print_commands(commands)
-        output.puts "-------"
-      end
-    end
-  end
-
-  def print_commands commands
-    lines = StringIO.new commands
-
-    lines.each_line do |line|
-      output.puts line
-    end
-  end
-
-  def execute_command commands, password, line_action, suppress_output, storage
-    commands = commands + inline_password(password) if password
-
-    IO.popen(commands) do |pipe|
-      pipe.each("\r") do |line|
-        output.print(line) unless suppress_output
-
-        storage.save(line.chomp) if storage
-
-        line_action.call(line) if line_action
-      end
-    end
-  end
-
-  def inline_password password
-    password ? "<<EOF\n#{password}\nEOF" : ""
-  end
-
-  def execute_ssh commands, domain, user, password, line_action, suppress_output, storage
-    if password.nil?
-      password = ask("Enter password for #{user}: ") { |q| q.echo = '*' }
-    end
-
-    Net::SSH.start(domain, user, :password => password) do |session|
-      session.exec "#{commands}" do |channel, _, line|
-        if line =~ /^\[sudo\] password for user:/ || line =~ /sudo password:/
-          #puts "Password request"
-          channel.request_pty # <- problem must be here.
-          channel.send_data password + "\n"
-        else
-          output.print(line) unless suppress_output
-
-          storage.save(line.chomp) if storage
-
-          line_action.call(line) if line_action
-        end
-      end
-
-      # run the aggregated event loop
-      session.loop
-    end
-  end
-
   def locate_commands script, &code
     if block_given?
       commands_from_block &code
@@ -163,16 +62,6 @@ module Executable
     end
   end
 
-  def ssh_command domain, user, identity_file
-    cmd = user.nil? ? domain : "#{user}@#{domain}"
-
-    cmd << " -i #{identity_file}" if identity_file
-
-    #cmd << " -t -t"
-
-    "ssh #{cmd}"
-  end
-
   def sudo commands
     "sudo -S -p 'sudo password: ' -s -- '#{commands}'"
   end

data/lib/script_executor/local_command.rb

@@ -0,0 +1,78 @@
+#require "open3"
+#@stdout, @stderr, @status = Open3.capture3(stdin)
+
+class LocalCommand
+  attr_accessor :simulate
+
+  attr_reader :password, :suppress_output, :capture_output, :simulate
+
+  def initialize params
+    @password = params[:password]
+    @suppress_output = params[:suppress_output]
+    @capture_output = params[:capture_output]
+    @simulate = params[:simulate]
+  end
+
+  def execute commands, line_action
+    print_commands commands, $stdout
+
+    unless simulate
+      storage = capture_output ? OutputBuffer.new : nil
+      output = suppress_output ? nil : $stdout
+
+      commands = commands + inline_password(password) if password
+
+      IO.popen(commands) do |pipe|
+        pipe.each("\r") do |line|
+          output.print(line) if output
+          storage.save(line.chomp) if storage
+
+          line_action.call(line) if line_action
+        end
+      end
+
+      storage.buffer.join("\n") if storage
+    end
+  end
+
+  private
+
+  def print_commands commands, output
+    if simulate
+      output.puts "Script:"
+      output.puts "-------"
+
+      lines = StringIO.new commands
+
+      lines.each_line do |line|
+        output.puts line
+      end
+
+      output.puts "-------"
+    else
+      output.puts "Local execution:"
+      output.puts "-------"
+
+      lines = StringIO.new commands
+
+      lines.each_line do |line|
+        output.puts line
+      end
+
+      output.puts "-------"
+    end
+  end
+
+  def inline_password password
+    password ? "<<EOF\n#{password}\nEOF" : ""
+  end
+end
+
+#require 'shellwords'
+#
+#def bash(command)
+#  escaped_command = Shellwords.escape(command)
+#  system "bash -c #{escaped_command}"
+#end
+
+