rsql 0.1.9 → 0.2.0

data/README.rdoc

@@ -44,11 +44,11 @@ RSQL is invoked from the comamnd line using:
   separate fields with a tab character).
 
 -ssh _ssh_host_::
-  Establish an SSH connection before connecting to the MySQL host.
+  Establish a SSH connection before connecting to the MySQL host.
 
 -sshconfig _ssh_config_::
-  Use a specific SSH configuration file instead of the ones
-  dynamically determined.
+  Use a specific SSH configuration file instead of the default files
+  loaded at runtime by Net::SSH.
 
 -e [_query_]::
   Run a query from the command line (i.e. not interactive). If a
@@ -58,21 +58,33 @@ RSQL is invoked from the comamnd line using:
   *must* be the last option specified.
 
 The _ssh_host_ and _mysql_host_ arguments may optionally include
-_user_ and _password_ values using the following syntax:
+_user_, _password_, or _port_ values using the following syntax:
 
-  [<user>[:<password>]@]<host>
-
-An empty password can be provided by simply listing nothing between
-demarcation points:
-
-  root:@127.0.0.1
+  [<user>[:<password>]@]<host>[:<port>]
 
 Once at the +rsql+ prompt, normal MySQL queries can be entered as
 expected, ending each with a semicolon (;) for columnar output or \G
 for line-by-line output formatting.
 
 Ruby commands will be evaluated for any content entered at the RSQL
-prompt beginning with a period (.).
+prompt beginning with a period.
+
+==== Command Line Examples
+
+Connect as the "root" user to a MySQL server running on the local
+host, with no password (because there are no characters listed between
+the colon and the at sign):
+
+  rsql root:@127.0.0.1
+
+Connect as the "readonly" user to the "internal.database.com" host's
+MySQL server after establishing a SSH tunnel to the
+"external.acme.com" gateway. In this case, we are either expecting
+that our SSH configuration is set up with the right user name. Because
+we did not provide a password for MySQL, one will be obtained directly
+from the console (without echoing the characters typed):
+
+  rsql -ssh external.acme.com readonly@database.acme.com
 
 == GETTING STARTED
 
@@ -86,6 +98,8 @@ downloaded with the source.
 
 == LICENSE
 
+RSQL is licensed under the MIT License:
+
 Copyright (C) 2011 by Brad Robel-Forrest <brad+rsql@gigglewax.com>
 
 Permission is hereby granted, free of charge, to any person obtaining

data/bin/rsql

@@ -27,6 +27,7 @@ begin
 rescue LoadError
 end
 
+require 'tmpdir'
 require 'thread'
 require 'timeout'
 require 'readline'
@@ -92,10 +93,12 @@ def get_password(prompt)
 end
 
 # safely separate login credentials while preserving "emtpy" values--
-# anything of the form [<username>[:<password]@]<host>
+# anything of the form [<username>[:<password]@]<host>[:<port>]
 #
 def split_login(str)
     login = []
+    # search from the right so we don't pick out ampersands in a
+    # password or username
     if i = str.rindex(?@)
         login << str[i+1..-1]
         if 0 < i
@@ -114,6 +117,11 @@ def split_login(str)
     else
         login << str
     end
+    if login.first.sub!(/:(\d+)$/,'')
+        login << $1.to_i
+    else
+        login << nil
+    end
 end
 
 if ARGV.delete('-version')
@@ -139,7 +147,7 @@ end
 if i = ARGV.index('-ssh')
     require 'net/ssh'
     ARGV.delete_at(i)
-    (ssh_host, ssh_user, ssh_password) = split_login(ARGV.delete_at(i))
+    (ssh_host, ssh_user, ssh_password, ssh_port) = split_login(ARGV.delete_at(i))
 end
 
 if i = ARGV.index('-sshconfig')
@@ -165,8 +173,9 @@ if ARGV.size < 1
 
 usage: #{bn} [-version] [-help] [-verbose]
 #{prefix}[-rc <rcfile>] [-maxrows <max>] [-batch <field_separator>]
-#{prefix}[-ssh [<ssh_user>[:<ssh_password>]@]<ssh_host>] [-sshconfig <ssh_config>]
-#{prefix}[<mysql_user>[:<mysql_password>]@]<mysql_host>
+#{prefix}[-ssh [<ssh_user>[:<ssh_password>]@]<ssh_host>[:<ssh_port>]
+#{prefix}[-sshconfig <ssh_config>]
+#{prefix}[<mysql_user>[:<mysql_password>]@]<mysql_host>[:<mysql_port>]
 #{prefix}[<database>] [-e <remaining_args_as_input>]
 
   If -ssh is used, a SSH tunnel is established before trying to
@@ -180,14 +189,15 @@ USAGE
     exit 1
 end
 
-(mysql_host, mysql_user, mysql_password) = split_login(ARGV.shift)
-mysql_password ||= get_password("#{mysql_host}@#{mysql_host} MySQL password: ")
+(mysql_host, mysql_user, mysql_password, mysql_port) = split_login(ARGV.shift)
+mysql_password ||= get_password("#{mysql_user}@#{mysql_host} MySQL password: ")
 real_mysql_host = mysql_host
 
 if ssh_host
     # randomly pick a tcp port above 1024
+    remote_mysql_port = mysql_port || 3306
     mysql_port = rand(0xffff-1025) + 1025
-else
+elsif mysql_port.nil?
     mysql_port = 3306
 end
 
@@ -227,20 +237,35 @@ end
 
 MySQLResults.max_rows ||= batch_output ? 5000 : 1000
 
-ssh_enabled = false
-
 if ssh_host
 
     # might need to open an idle channel here so server doesn't close on
     # us...or just loop reconnection here in the thread...
 
-    port_opened = false
-    getting_password = false
     password_retry_cnt = 0
 
-    puts "SSH #{ssh_user}#{ssh_user ? '@' : ''}#{ssh_host}..." unless batch_input
+    unless batch_input
+        print "SSH #{ssh_user}#{ssh_user ? '@' : ''}#{ssh_host}..."
+        $stdout.flush
+    end
+
+    # we have to run mysql in a separate process due to the blocking
+    # nature of its calls interfering with the pure ruby ssh
+    # calls...so we'll run ssh in the background since its only
+    # purpose is to forward us in for accessing the mysql server
+
+    # we'll use a poor-man's ipc to determine when the ssh process is
+    # ready
+    ipc_fn = File.join(Dir.tmpdir, "rsql_ssh_#{$$}.pid")
+
     ssh = nil
-    ssh_thread = Thread.new do
+    ssh_pid = Process.fork do
+        File.open(ipc_fn,'w'){|f| f.puts('start')}
+        ssh_enabled = false
+        Signal.trap('INT') do
+            $stderr.puts 'Shutting down...'
+            ssh_enabled = false
+        end
         opts = {:timeout => 15}
         opts[:config] = ssh_config if ssh_config
         if verbose
@@ -254,14 +279,14 @@ if ssh_host
             opts[:password] = ssh_password if ssh_password
             ssh = Net::SSH.start(ssh_host, ssh_user, opts)
             ssh_enabled = true
+            printf "connected (#{$$})..."
+            $stdout.flush
         rescue Net::SSH::AuthenticationFailed
             if 2 < password_retry_cnt
                 $stderr.puts 'Permission denied. Giving up.'
             else
                 $stderr.puts 'Permission denied, please try again.' if ssh_password
-                getting_password = true
                 ssh_password = get_password("#{ssh_user}@#{ssh_host} SSH password: ")
-                getting_password = false
                 unless ssh_password.empty?
                     password_retry_cnt += 1
                     retry
@@ -269,39 +294,25 @@ if ssh_host
             end
         end
         if ssh_enabled
-            ssh.forward.local(mysql_port, mysql_host, 3306)
-            port_opened = true
+            ssh.forward.local(mysql_port, mysql_host, remote_mysql_port)
+            puts(verbose ? "ready (#{mysql_port} => #{remote_mysql_port})" : 'ready')
+            File.open(ipc_fn,'w'){|f| f.puts('ready')}
             ssh.loop(1) { ssh_enabled }
         end
+        File.open(ipc_fn,'w'){|f| f.puts('fail')}
     end
 
-    15.times do
-        break if !ssh_thread.alive? || (ssh_enabled && port_opened)
-        while getting_password
-            # give them extra time
-            sleep(1)
-        end
+    ipc_state = ''
+    60.times do
         sleep(1)
+        File.open(ipc_fn,'r'){|f| ipc_state = f.gets.strip}
+        break if ipc_state == 'ready' || ipc_state == 'fail'
     end
 
-    unless ssh_enabled
-        $stderr.puts "failed to connect to #{ssh_host} SSH host"
-        begin
-            ssh_thread.join
-        rescue Exception => ex
-            $stderr.puts("  => #{ex.message} (#{ex.class})")
-        end
-        exit 1
-    end
+    File.unlink(ipc_fn)
 
-    unless port_opened
-        $stderr.puts("failed to forward #{mysql_port}:#{mysql_host}:3306 via #{ssh_host} " \
-                     "ssh host in 15 seconds")
-        begin
-            ssh_thread.join
-        rescue Exception => ex
-            $stderr.puts("  => #{ex.message}: #{ex.class}")
-        end
+    unless ipc_state == 'ready'
+        $stderr.puts "failed to connect to #{ssh_host} SSH host"
         exit 1
     end
 
@@ -309,16 +320,24 @@ if ssh_host
     mysql_host = '127.0.0.1'
 end
 
-puts "MySQL #{mysql_user}@#{real_mysql_host}..." unless batch_input
+unless batch_input
+    print "MySQL #{mysql_user}@#{real_mysql_host}..."
+    $stdout.flush
+end
+
+mysql_conn = "#{mysql_host}:#{remote_mysql_port || mysql_port}"
+
 begin
     MySQLResults.conn = Mysql.new(mysql_host, mysql_user, mysql_password,
                                   MySQLResults.database_name, mysql_port)
+    puts 'connected'
 rescue Mysql::Error => ex
     if ex.message.include?('Client does not support authentication')
-        $stderr.puts "failed to connect to #{mysql_host} mysql server: unknown credentials?"
+        $stderr.puts "failed to connect to #{mysql_conn} mysql server: unknown credentials?"
     else
-        $stderr.puts "failed to connect to #{mysql_host} mysql server: #{ex.message}"
+        $stderr.puts "failed to connect to #{mysql_conn} mysql server: #{ex.message}"
     end
+    $stderr.puts ex.backtrace if verbose
     exit 1
 rescue NoMethodError
     # this happens when mysql tries to read four bytes and assume it
@@ -326,10 +345,12 @@ rescue NoMethodError
     # because the connect succeeds due to the SSH forwarded port but
     # then there isn't anybody connected on the remote side of the
     # proxy
-    $stderr.puts "failed to connect to #{mysql_host} mysql server"
+    $stderr.puts "failed to connect to #{mysql_conn} mysql server"
+    $stderr.puts ex.backtrace if verbose
     exit 1
 rescue Exception => ex
-    $stderr.puts "failed to connect to #{mysql_host} mysql server: #{ex.message} (#{ex.class})"
+    $stderr.puts "failed to connect to #{mysql_conn} mysql server: #{ex.message} (#{ex.class})"
+    $stderr.puts ex.backtrace if verbose
     exit 1
 end
 
@@ -417,7 +438,6 @@ unless MySQLResults.conn.nil?
 end
 
 sleep(0.3)
-ssh_enabled = false
 
 if Readline::HISTORY.any?
     if 100 < Readline::HISTORY.size
@@ -428,6 +448,7 @@ if Readline::HISTORY.any?
     File.open(history_fn, 'w') {|f| YAML.dump(Readline::HISTORY.to_a, f)}
 end
 
-if ssh_thread
-    safe_timeout(ssh_thread, :join, 'SSH')
+if ssh_pid && 0 <= ssh_pid
+    Process.kill('INT', ssh_pid)
+    Process.waitpid(ssh_pid)
 end

data/example.rsqlrc

@@ -92,7 +92,7 @@ INSERT IGNORE INTO #{@rsql_table}
        value=#{9**9},
        stuff=0x1234567891234567891234567890;
 }
-    sqeeze!(sql)
+    squeeze!(sql)
 end
 
 # A very common reason for recipes is simply to add parameters to be

data/lib/rsql.rb

@@ -2,9 +2,8 @@
 # Commands using an EvalContext for handling recipes.
 #
 module RSQL
-    VERSION = '0.1.9'
+    VERSION = '0.2.0'
 
-    require 'rsql/mysql'
     require 'rsql/mysql_results'
     require 'rsql/eval_context'
     require 'rsql/commands'

data/lib/rsql/eval_context.rb

@@ -149,13 +149,28 @@ module RSQL
             end
 
             begin
-                value = Thread.new{ eval('$SAFE=2;' + content) }.value
-            rescue Exception => ex
-                if @verbose
-                    $stderr.puts("#{ex.class}: #{ex.message}", ex.backtrace)
-                else
-                    $stderr.puts(ex.message.gsub(/\(eval\):\d+:/,''))
+                # in order to print out errors in a loaded script so
+                # that we have file/line info, we need to rescue their
+                # exceptions inside the evaluation
+                th = Thread.new do
+                    eval('$SAFE=2;begin;' << content << %q{
+                      rescue Exception => ex
+                        if @verbose
+                            $stderr.puts("#{ex.class}: #{ex.message}", ex.backtrace)
+                        else
+                            bt = []
+                            ex.backtrace.each do |t|
+                              break if t.include?('bin/rsql')
+                              bt << t unless t.include?('lib/rsql/') || t.include?('(eval)')
+                            end
+                            $stderr.puts(ex.message.gsub(/\(eval\):\d+:/,''),bt)
+                        end
+                      end
+                    })
                 end
+                value = th.value
+            rescue Exception => ex
+                $stderr.puts(ex.message.gsub(/\(eval\):\d+:/,''))
             ensure
                 $stdout = orig_stdout if stdout
             end
@@ -409,7 +424,7 @@ module RSQL
 
                 if block.nil?
                     source = args.pop
-                    sql = sqeeze!(source.dup)
+                    sql = squeeze!(source.dup)
 
                     argstr = args.join(',')
                     usage << "(#{argstr})" unless argstr.empty?
@@ -534,7 +549,7 @@ module RSQL
 
             # Squeeze out any spaces.
             #
-            def sqeeze!(sql)    # :doc:
+            def squeeze!(sql)    # :doc:
                 sql.gsub!(/\s+/,' ')
                 sql.strip!
                 sql << ';' unless sql[-1] == ?;

data/lib/rsql/mysql_results.rb

@@ -21,12 +21,17 @@
 
 module RSQL
 
+    require 'mysql'
+
     ########################################
     # A wrapper to make it easier to work with MySQL results (and prettier).
     #
     class MySQLResults
 
-        HEX_RANGE = (Mysql::Field::TYPE_TINY_BLOB..Mysql::Field::TYPE_STRING)
+        HEX_RANGE = [
+                     Mysql::Field::TYPE_BLOB,
+                     Mysql::Field::TYPE_STRING,
+                    ]
 
         @@conn            = nil
         @@field_separator = ' '

data/test/test_commands.rb

@@ -9,7 +9,6 @@ end
 require 'mocha'
 
 $: << File.expand_path(File.join(File.dirname(__FILE__),'..','lib')) << File.dirname(__FILE__)
-require 'dummy_mysql.rb'
 require 'rsql/mysql_results.rb'
 require 'rsql/eval_context.rb'
 require 'rsql/commands.rb'

data/test/test_eval_context.rb

@@ -10,7 +10,6 @@ end
 require 'mocha'
 
 $: << File.expand_path(File.join(File.dirname(__FILE__),'..','lib')) << File.dirname(__FILE__)
-require 'dummy_mysql.rb'
 require 'rsql/mysql_results.rb'
 require 'rsql/eval_context.rb'
 

data/test/test_mysql_results.rb

@@ -9,7 +9,6 @@ end
 require 'mocha'
 
 $: << File.expand_path(File.join(File.dirname(__FILE__),'..','lib')) << File.dirname(__FILE__)
-require 'dummy_mysql.rb'
 require 'rsql/mysql_results.rb'
 
 class TestMySQLResults < Test::Unit::TestCase

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rsql
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 9
-  version: 0.1.9
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Brad Robel-Forrest
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-05 00:00:00 Z
+date: 2011-09-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: net-ssh
@@ -34,9 +34,25 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: mocha
+  name: mysql
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 2
+        - 8
+        - 0
+        version: 2.8.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -48,11 +64,11 @@ dependencies:
         - 12
         version: 0.9.12
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rake
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -62,11 +78,11 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: rdoc
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -76,11 +92,11 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: rcov
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -90,7 +106,7 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
 description: |
   RSQL makes working with a MySQL command line more convenient through
   the use of recipes and embedding the common operation of using a SSH
@@ -112,11 +128,9 @@ files:
 - lib/rsql/commands.rb
 - lib/rsql/eval_context.rb
 - lib/rsql/mysql_results.rb
-- test/dummy_mysql.rb
 - test/test_commands.rb
 - test/test_eval_context.rb
 - test/test_mysql_results.rb
-- lib/rsql/mysql.rb
 homepage: https://rubygems.org/gems/rsql
 licenses: []
 
@@ -126,8 +140,6 @@ rdoc_options:
 - RSQL Documentation
 - --main
 - README.rdoc
-- --exclude
-- mysql.rb
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -135,12 +147,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 51
+      hash: 55
       segments: 
       - 1
       - 8
-      - 2
-      version: 1.8.2
+      - 0
+      version: 1.8.0
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
@@ -153,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Ruby based MySQL command line with recipes.