aptible-cli 0.6.8 → 0.6.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a3f6b5e9a9f9f325832789f7bbac423de2276c8
-  data.tar.gz: 328b06f1dcf9cb13c0df4f63f587fb4b79145a57
+  metadata.gz: c58858b887b9868e017e93d7248f4e7d1f898dc2
+  data.tar.gz: 7b2d52cc1b316205abb7d35c13722a32dccda29a
 SHA512:
-  metadata.gz: 8618af8eaf81ca409c8dfd680a00744f265a72da22d87767d679b93c6deadc6d8edf2951fcd488521d68a92ffdbb60f2969a995fb5ad0f3c30afc0ee2858ff48
-  data.tar.gz: 9da5825e8c2d8e2476ffce6268406f421cc357edd7fc8290801b1b342fe760351082f0f4864e782b113a0a1e8291b3226d815af3b50d23d0438cc0b97106e5d9
+  metadata.gz: 2c326bb7a9cc09e2689804e43b0fa00643eb759dbe838f572b0dc44df32caba6f6b76f1a14375e4aa6c1d5cac83457b8a37274c72f14ed843b6afcaa6acb2287
+  data.tar.gz: 07bd87aa8c414600d845ce133c868ad1a0df02e9c6518f6202717eabd7f12d8d7b95df42cc5a1f4177bb4f315e6950fc4fa6e13b64059ce2f12f8b0b0a6bf2c3

data/aptible-cli.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 2.0'
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'climate_control'
 end

data/lib/aptible/cli/agent.rb

@@ -8,6 +8,7 @@ require_relative 'helpers/environment'
 require_relative 'helpers/app'
 require_relative 'helpers/database'
 require_relative 'helpers/env'
+require_relative 'helpers/tunnel'
 
 require_relative 'subcommands/apps'
 require_relative 'subcommands/config'

data/lib/aptible/cli/helpers/database.rb

@@ -44,18 +44,6 @@ module Aptible
           say ''
         end
 
-        def establish_connection(database, local_port)
-          ENV['ACCESS_TOKEN'] = fetch_token
-          ENV['APTIBLE_DATABASE'] = database.handle
-
-          remote_port = claim_remote_port(database)
-          ENV['TUNNEL_PORT'] = remote_port
-
-          tunnel_args = "-L #{local_port}:localhost:#{remote_port}"
-          command = "ssh #{tunnel_args} #{common_ssh_args(database)}"
-          Kernel.exec(command)
-        end
-
         def clone_database(source, dest_handle)
           op = source.create_operation(type: 'clone', handle: dest_handle)
           poll_for_success(op)
@@ -63,35 +51,33 @@ module Aptible
           databases_from_handle(dest_handle, source.account).first
         end
 
-        def dump_database(database)
-          execute_local_tunnel(database) do |url|
-            filename = "#{database.handle}.dump"
-            say "Dumping to #{filename}"
-            `pg_dump #{url} > #{filename}`
+        # Creates a local tunnel and yields the helper
+
+        def with_local_tunnel(database, port = 0)
+          env = {
+            'ACCESS_TOKEN' => fetch_token,
+            'APTIBLE_DATABASE' => database.href
+          }
+          command = ['ssh', '-q'] + ssh_args(database)
+          Helpers::Tunnel.new(env, command).tap do |tunnel_helper|
+            tunnel_helper.start(port)
+            yield tunnel_helper
+            tunnel_helper.stop
           end
         end
 
-        # Creates a local tunnel and yields the url to it
-        def execute_local_tunnel(database)
-          local_port = random_local_port
-          pid = fork { establish_connection(database, local_port) }
-
-          # TODO: Better test for connection readiness
-          sleep 10
+        # Creates a local PG tunnel and yields the url to it
 
-          auth = "aptible:#{database.passphrase}"
-          host = "localhost:#{local_port}"
-          yield "postgresql://#{auth}@#{host}/db"
-        ensure
-          Process.kill('HUP', pid) if pid
-        end
+        def with_postgres_tunnel(database)
+          if database.type != 'postgresql'
+            fail Thor::Error, 'This command only works for PostgreSQL'
+          end
 
-        def random_local_port
-          # Allocate a dummy server to discover an available port
-          dummy = TCPServer.new('127.0.0.1', 0)
-          port = dummy.addr[1]
-          dummy.close
-          port
+          with_local_tunnel(database) do |tunnel_helper|
+            auth = "aptible:#{database.passphrase}"
+            host = "localhost:#{tunnel_helper.port}"
+            yield "postgresql://#{auth}@#{host}/db"
+          end
         end
 
         def local_url(database, local_port)
@@ -102,20 +88,15 @@ module Aptible
           "127.0.0.1:#{local_port}#{uri.path}"
         end
 
-        def claim_remote_port(database)
-          ENV['ACCESS_TOKEN'] = fetch_token
-
-          `ssh #{common_ssh_args(database)} 2>/dev/null`.chomp
-        end
-
-        def common_ssh_args(database)
+        def ssh_args(database)
           host = database.account.bastion_host
           port = database.account.bastion_port
 
-          opts = " -o 'SendEnv=*' -o StrictHostKeyChecking=no " \
-                 '-o UserKnownHostsFile=/dev/null'
-          connection_args = "-p #{port} root@#{host}"
-          "#{opts} #{connection_args}"
+          ['-o', 'SendEnv=APTIBLE_DATABASE',
+           '-o', 'SendEnv=ACCESS_TOKEN',
+           '-o', 'StrictHostKeyChecking=no',
+           '-o', 'UserKnownHostsFile=/dev/null',
+           '-p', port.to_s, "root@#{host}"]
         end
       end
     end

data/lib/aptible/cli/helpers/tunnel.rb

@@ -0,0 +1,76 @@
+require 'socket'
+require 'open3'
+
+module Aptible
+  module CLI
+    module Helpers
+      class Tunnel
+        def initialize(env, cmd)
+          @env = env
+          @cmd = cmd
+        end
+
+        def start(desired_port = 0, err_fd = $stderr)
+          @local_port = desired_port
+          @local_port = random_local_port if @local_port == 0
+
+          # First, grab a remote port
+          out, err, status = Open3.capture3(@env, *@cmd)
+          fail "Failed to request remote port: #{err}" unless status.success?
+          remote_port = out.chomp
+
+          # Then, spin up a SSH session using that port and port forwarding
+          tunnel_env = @env.merge(
+            'TUNNEL_PORT' => remote_port, # Request a specific port
+            'TUNNEL_SIGNAL_OPEN' => '1'   # Request signal when tunnel is up
+          )
+
+          tunnel_cmd = @cmd + [
+            '-L', "#{@local_port}:localhost:#{remote_port}",
+            '-o', 'SendEnv=TUNNEL_PORT',
+            '-o', 'SendEnv=TUNNEL_SIGNAL_OPEN'
+          ]
+
+          r_pipe, w_pipe = IO.pipe
+          @pid = Process.spawn(tunnel_env, *tunnel_cmd, in: :close,
+                                                        out: w_pipe,
+                                                        err: err_fd)
+
+          # Wait for the tunnel to come up before returning. The other end
+          # will send a message on stdout to indicate that the tunnel is ready.
+          w_pipe.close
+          begin
+            r_pipe.readline
+          rescue EOFError
+            raise 'Server closed the tunnel'
+          end
+        end
+
+        def stop
+          fail 'You must call #start before calling #stop' if @pid.nil?
+          Process.kill('HUP', @pid)
+          wait
+        end
+
+        def wait
+          Process.wait @pid
+        end
+
+        def port
+          fail 'You must call #start before calling #port!' if @local_port.nil?
+          @local_port
+        end
+
+        private
+
+        def random_local_port
+          # Allocate a dummy server to discover an available port
+          dummy = TCPServer.new('127.0.0.1', 0)
+          port = dummy.addr[1]
+          dummy.close
+          port
+        end
+      end
+    end
+  end
+end

data/lib/aptible/cli/subcommands/db.rb

@@ -1,4 +1,5 @@
 require 'term/ansicolor'
+require 'uri'
 
 module Aptible
   module CLI
@@ -50,15 +51,19 @@ module Aptible
             option :environment
             define_method 'db:dump' do |handle|
               database = ensure_database(options.merge(db: handle))
-              dump_database(database)
+              with_postgres_tunnel(database) do |url|
+                filename = "#{handle}.dump"
+                say "Dumping to #{filename}"
+                `pg_dump #{url} > #{filename}`
+              end
             end
 
             desc 'db:execute HANDLE SQL_FILE', 'Executes sql against a database'
             option :environment
             define_method 'db:execute' do |handle, sql_path|
               database = ensure_database(options.merge(db: handle))
-              execute_local_tunnel(database) do |url|
-                say "Executing #{sql_path} against #{database.handle}"
+              with_postgres_tunnel(database) do |url|
+                say "Executing #{sql_path} against #{handle}"
                 `psql #{url} < #{sql_path}`
               end
             end
@@ -67,21 +72,31 @@ module Aptible
             option :environment
             option :port, type: :numeric
             define_method 'db:tunnel' do |handle|
+              desired_port = Integer(options[:port] || 0)
               database = ensure_database(options.merge(db: handle))
-              local_port = options[:port] || random_local_port
-
               say 'Creating tunnel...', :green
-              say "Connect at #{local_url(database, local_port)}", :green
 
-              uri = URI(local_url(database, local_port))
-              db = uri.path.gsub(%r{^/}, '')
-              say 'Or, use the following arguments:', :green
-              say("* Host: #{uri.host}", :green)
-              say("* Port: #{uri.port}", :green)
-              say("* Username: #{uri.user}", :green) unless uri.user.empty?
-              say("* Password: #{uri.password}", :green)
-              say("* Database: #{db}", :green) unless db.empty?
-              establish_connection(database, local_port)
+              with_local_tunnel(database, desired_port) do |tunnel_helper|
+                port = tunnel_helper.port
+                say "Connect at #{local_url(database, port)}", :green
+
+                uri = URI(local_url(database, port))
+                db = uri.path.gsub(%r{^/}, '')
+                say 'Or, use the following arguments:', :green
+                say("* Host: #{uri.host}", :green)
+                say("* Port: #{uri.port}", :green)
+                say("* Username: #{uri.user}", :green) unless uri.user.empty?
+                say("* Password: #{uri.password}", :green)
+                say("* Database: #{db}", :green) unless db.empty?
+
+                say 'Connected. Ctrl-C to close connection.'
+
+                begin
+                  tunnel_helper.wait
+                rescue Interrupt
+                  say 'Closing tunnel'
+                end
+              end
             end
 
             desc 'db:deprovision HANDLE', 'Deprovision a database'

data/lib/aptible/cli/subcommands/logs.rb

@@ -22,7 +22,7 @@ module Aptible
               port = app.account.dumptruck_port
 
               ENV['ACCESS_TOKEN'] = fetch_token
-              ENV['APTIBLE_APP'] = app.handle
+              ENV['APTIBLE_APP'] = app.href
               ENV['APTIBLE_CLI_COMMAND'] = 'logs'
 
               opts = " -o 'SendEnv=*' -o StrictHostKeyChecking=no " \

data/lib/aptible/cli/subcommands/ps.rb

@@ -20,7 +20,7 @@ module Aptible
               port = app.account.dumptruck_port
 
               set_env('ACCESS_TOKEN', fetch_token)
-              set_env('APTIBLE_APP', app.handle)
+              set_env('APTIBLE_APP', app.href)
               set_env('APTIBLE_CLI_COMMAND', 'ps')
 
               opts = " -o 'SendEnv=*' -o StrictHostKeyChecking=no " \

data/lib/aptible/cli/subcommands/ssh.rb

@@ -24,7 +24,7 @@ module Aptible
 
               ENV['ACCESS_TOKEN'] = fetch_token
               ENV['APTIBLE_COMMAND'] = command_from_args(*args)
-              ENV['APTIBLE_APP'] = app.handle
+              ENV['APTIBLE_APP'] = app.href
 
               opts = options[:force_tty] ? '-t -t' : ''
               opts << " -o 'SendEnv=*' -o StrictHostKeyChecking=no " \

data/lib/aptible/cli/version.rb

@@ -1,5 +1,5 @@
 module Aptible
   module CLI
-    VERSION = '0.6.8'
+    VERSION = '0.6.9'
   end
 end

data/spec/aptible/cli/helpers/tunnel_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'climate_control'
+
+describe Aptible::CLI::Helpers::Tunnel do
+  around do |example|
+    mocks_path = File.expand_path('../../../../mock', __FILE__)
+    path = "#{mocks_path}:#{ENV['PATH']}"
+    ClimateControl.modify PATH: path do
+      example.run
+    end
+  end
+
+  it 'reuses the port it was given' do
+    helper = described_class.new({}, ['ssh_mock.rb'])
+
+    r, w = IO.pipe
+    helper.start(0, w)
+    helper.stop
+
+    expect(r.readline.chomp).to eq('6')
+    expect(r.readline.chomp).to eq('-L')
+    expect(r.readline.chomp).to match(/\d+:localhost:1234$/)
+    expect(r.readline.chomp).to eq('-o')
+    expect(r.readline.chomp).to eq('SendEnv=TUNNEL_PORT')
+    expect(r.readline.chomp).to eq('-o')
+    expect(r.readline.chomp).to eq('SendEnv=TUNNEL_SIGNAL_OPEN')
+
+    r.close
+    w.close
+  end
+
+  it 'accepts a desired port' do
+    helper = described_class.new({}, ['ssh_mock.rb'])
+    r, w = IO.pipe
+    helper.start(5678, w)
+    helper.stop
+
+    expect(r.readline.chomp).to eq('6')
+    expect(r.readline.chomp).to eq('-L')
+    expect(r.readline.chomp).to eq('5678:localhost:1234')
+    expect(r.readline.chomp).to eq('-o')
+    expect(r.readline.chomp).to eq('SendEnv=TUNNEL_PORT')
+    expect(r.readline.chomp).to eq('-o')
+    expect(r.readline.chomp).to eq('SendEnv=TUNNEL_SIGNAL_OPEN')
+
+    r.close
+    w.close
+  end
+
+  it 'captures and displays port discovery errors' do
+    helper = described_class.new({ 'FAIL_PORT' => '1' }, ['ssh_mock.rb'])
+    expect { helper.start }.to raise_error(/Something went wrong/)
+  end
+
+  it 'captures and displays tunnel errors' do
+    helper = described_class.new({ 'FAIL_TUNNEL' => '1' }, ['ssh_mock.rb'])
+    expect do
+      helper.start(0, File.open(File::NULL, 'w'))
+    end.to raise_error(/Server closed the tunnel/)
+  end
+
+  it 'should fail if #port is called before #start' do
+    socat = described_class.new({}, [])
+    expect { socat.port }.to raise_error(/You must call #start/)
+  end
+
+  it 'should fail if #stop is called before #start' do
+    socat = described_class.new({}, [])
+    expect { socat.stop }.to raise_error(/You must call #start/)
+  end
+end

data/spec/aptible/cli/subcommands/db_spec.rb

@@ -7,12 +7,13 @@ end
 class Account < OpenStruct
 end
 
+class SocatHelperMock < OpenStruct
+end
+
 describe Aptible::CLI::Agent do
   before { subject.stub(:ask) }
   before { subject.stub(:save_token) }
   before { subject.stub(:fetch_token) { double 'token' } }
-  before { subject.stub(:random_local_port) { 4242 } }
-  before { subject.stub(:establish_connection) }
 
   let(:account) do
     Account.new(bastion_host: 'localhost',
@@ -24,7 +25,14 @@ describe Aptible::CLI::Agent do
       type: 'postgresql',
       handle: 'foobar',
       passphrase: 'password',
-      connection_url: 'postgresql://aptible:password@10.252.1.125:49158/db'
+      connection_url: 'postgresql://aptible:password@10.252.1.125:49158/db',
+      account: account
+    )
+  end
+
+  let(:socat_helper) do
+    SocatHelperMock.new(
+      port: 4242
     )
   end
 
@@ -39,11 +47,14 @@ describe Aptible::CLI::Agent do
     it 'should print a message about how to connect' do
       allow(Aptible::Api::Database).to receive(:all) { [database] }
       local_url = 'postgresql://aptible:password@127.0.0.1:4242/db'
+
+      expect(subject).to receive(:with_local_tunnel).with(database, 0)
+        .and_yield(socat_helper)
       expect(subject).to receive(:say).with('Creating tunnel...', :green)
       expect(subject).to receive(:say).with("Connect at #{local_url}", :green)
 
       # db:tunnel should also explain each component of the URL:
-      expect(subject).to receive(:say).exactly(6).times
+      expect(subject).to receive(:say).exactly(7).times
       subject.send('db:tunnel', 'foobar')
     end
   end

data/spec/mock/ssh_mock.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+# Emulate server behavior
+
+if ENV['TUNNEL_PORT']
+  fail 'Something went wrong!' if ENV['FAIL_TUNNEL']
+  puts 'TUNNEL READY'
+else
+  fail 'Something went wrong!' if ENV['FAIL_PORT']
+  puts 1234
+end
+
+# Log to stderr so we can collect in test
+
+$stderr.puts ARGV.size
+ARGV.each do |a|
+  $stderr.puts a
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aptible-cli
 version: !ruby/object:Gem::Version
-  version: 0.6.8
+  version: 0.6.9
 platform: ruby
 authors:
 - Frank Macreery
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-18 00:00:00.000000000 Z
+date: 2016-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aptible-api
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Aptible CLI
 email:
 - frank@macreery.com
@@ -176,6 +190,7 @@ files:
 - lib/aptible/cli/helpers/environment.rb
 - lib/aptible/cli/helpers/operation.rb
 - lib/aptible/cli/helpers/token.rb
+- lib/aptible/cli/helpers/tunnel.rb
 - lib/aptible/cli/subcommands/apps.rb
 - lib/aptible/cli/subcommands/config.rb
 - lib/aptible/cli/subcommands/db.rb
@@ -188,11 +203,13 @@ files:
 - lib/aptible/cli/version.rb
 - spec/aptible/cli/agent_spec.rb
 - spec/aptible/cli/helpers/handle_from_git_remote.rb
+- spec/aptible/cli/helpers/tunnel_spec.rb
 - spec/aptible/cli/subcommands/apps_spec.rb
 - spec/aptible/cli/subcommands/db_spec.rb
 - spec/aptible/cli/subcommands/domains_spec.rb
 - spec/aptible/cli/subcommands/logs_spec.rb
 - spec/aptible/cli/subcommands/ps_spec.rb
+- spec/mock/ssh_mock.rb
 - spec/spec_helper.rb
 homepage: https://github.com/aptible/aptible-cli
 licenses:
@@ -221,9 +238,11 @@ summary: Command-line interface for Aptible services
 test_files:
 - spec/aptible/cli/agent_spec.rb
 - spec/aptible/cli/helpers/handle_from_git_remote.rb
+- spec/aptible/cli/helpers/tunnel_spec.rb
 - spec/aptible/cli/subcommands/apps_spec.rb
 - spec/aptible/cli/subcommands/db_spec.rb
 - spec/aptible/cli/subcommands/domains_spec.rb
 - spec/aptible/cli/subcommands/logs_spec.rb
 - spec/aptible/cli/subcommands/ps_spec.rb
+- spec/mock/ssh_mock.rb
 - spec/spec_helper.rb