aptible-cli 0.8.3 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15ef26a1d8174bd57b27355dac98734659336277
-  data.tar.gz: 5521c5143aa5b261a2a929d24f5933aceb339711
+  metadata.gz: cd702a7afbcc8290e375387617c228b388b69918
+  data.tar.gz: bbbcb95f4ebc9deac6671049c7534c83e2127d1e
 SHA512:
-  metadata.gz: 2cedfbebbf101cac17f840d8701cf5198238c8081dc09059aaa87e8f78f4963530441090855adb62a96cdf411ed6ed24197279db96ede0dde7cccc50bc89325f
-  data.tar.gz: a8a342ebd3e1c1f6512dbe9c1d5f9cb86382dc8ab1f49bd589f5dabacadaa2bac1ce8b5c81bc1568dcf98f3b6f5c0a0ff971b8a18d2462dfad7c0a90e7b1c623
+  metadata.gz: c975747091a4d3232c190baee45865bd38dcde4fe8c585ac78a3b86050f5e382432ed78e719e6fb3ae947fd5e1f213e765ff336d3e07886d97b26feb4ae6fae9
+  data.tar.gz: e2b3152c9a2e6a9398b8dc87031b7791b7ad614836d9a548fa9721db3b7864101f53734cf55701940e8c9cd0db93c73b6fbd0ff694c1a7a5f8e0d6733ee02fac

data/aptible-cli.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{spec/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'aptible-api', '~> 0.9.16'
+  spec.add_dependency 'aptible-api', '~> 0.9.20'
   spec.add_dependency 'aptible-auth', '~> 0.11.12'
   spec.add_dependency 'aptible-resource', '~> 0.3.6'
   spec.add_dependency 'thor', '~> 0.19.1'
@@ -29,10 +29,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'chronic_duration', '~> 0.10.6'
   spec.add_dependency 'win32-process' if Gem.win_platform?
   spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'aptible-tasks', '>= 0.2.0'
+  spec.add_development_dependency 'aptible-tasks', '~> 0.5.8'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.2'
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'climate_control'
+  spec.add_development_dependency 'climate_control', '= 0.0.3'
   spec.add_development_dependency 'fabrication', '~> 2.15.2'
 end

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

@@ -55,14 +55,14 @@ module Aptible
 
         # Creates a local tunnel and yields the helper
 
-        def with_local_tunnel(database, port = 0)
-          op = database.create_operation!(type: 'tunnel', status: 'succeeded')
+        def with_local_tunnel(credential, port = 0)
+          op = credential.create_operation!(type: 'tunnel', status: 'succeeded')
 
-          with_ssh_cmd(op) do |base_ssh_cmd, credential|
+          with_ssh_cmd(op) do |base_ssh_cmd, ssh_credential|
             ssh_cmd = base_ssh_cmd + ['-o', 'SendEnv=ACCESS_TOKEN']
             ssh_env = { 'ACCESS_TOKEN' => fetch_token }
 
-            socket_path = credential.ssh_port_forward_socket
+            socket_path = ssh_credential.ssh_port_forward_socket
             tunnel_helper = Helpers::Tunnel.new(ssh_env, ssh_cmd, socket_path)
 
             tunnel_helper.start(port)
@@ -78,20 +78,48 @@ module Aptible
             raise Thor::Error, 'This command only works for PostgreSQL'
           end
 
-          with_local_tunnel(database) do |tunnel_helper|
-            auth = "aptible:#{database.passphrase}"
-            host = "localhost.aptible.in:#{tunnel_helper.port}"
-            yield "postgresql://#{auth}@#{host}/db"
+          credential = find_tunnel_credential(database)
+
+          with_local_tunnel(credential) do |tunnel_helper|
+            yield local_url(credential, tunnel_helper.port)
           end
         end
 
-        def local_url(database, local_port)
-          remote_url = database.connection_url
+        def local_url(credential, local_port)
+          remote_url = credential.connection_url
           uri = URI.parse(remote_url)
 
           "#{uri.scheme}://#{uri.user}:#{uri.password}@" \
           "localhost.aptible.in:#{local_port}#{uri.path}"
         end
+
+        def find_tunnel_credential(database, type = nil)
+          unless database.provisioned?
+            raise Thor::Error, "Database #{database.handle} is not provisioned"
+          end
+
+          finder = proc { |c| c.default }
+          finder = proc { |c| c.type == type } if type
+          credential = database.database_credentials.find(&finder)
+
+          return credential if credential
+
+          types = database.database_credentials.map(&:type)
+
+          # On v1, we fallback to the DB. We make sure to make --type work, to
+          # avoid a confusing experience for customers.
+          if database.account.stack.version == 'v1'
+            types << database.type
+            types.uniq!
+            return database if type.nil? || type == database.type
+          end
+
+          valid = types.join(', ')
+
+          err = 'No default credential for database'
+          err = "No credential with type #{type} for database" if type
+          raise Thor::Error, "#{err}, valid credential types: #{valid}"
+        end
       end
     end
   end

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

@@ -3,10 +3,30 @@ module Aptible
     module Helpers
       module Ssh
         def connect_to_ssh_portal(operation, *extra_ssh_args)
-          # TODO: Should we rescue Interrupt here?
           with_ssh_cmd(operation) do |base_ssh_cmd|
             ssh_cmd = base_ssh_cmd + extra_ssh_args
-            Kernel.system(*ssh_cmd)
+            begin
+              Kernel.system(*ssh_cmd)
+            rescue Interrupt
+              # Assuming we have a TTY, there are two cases here. Either SSH
+              # itself has a TTY, in which case it is controlling the TTY and
+              # the CLI won't be receiving SIGINT when CTRL+C is pressed, or
+              # SSH has no TTY, in which case the CLI and SSH are sharing the
+              # same process group, and will both receive SIGINT when CTRL+C
+              # is pressed and exit accordingly.
+              #
+              # I'm not sure how this *should* work on Windows, but it appears
+              # to work pretty much the same way, except that we'll get an ugly
+              # "Terminate batch job (Y/N)?" prompt in the no-TTY-for-SSH case,
+              # which we're likely to have a hard time handling.
+              #
+              # Note that this DOES NOT handle the case where the CLI is sent
+              # SIGINT by another process (as opposed to the line discipline).
+              # In this case, SSH will continue running in the background. This
+              # is something we should fix, but for now this 'simple' fix is
+              # enough to addresses the ugly stack trace we show when
+              # CTRL+C'ing out of logs.
+            end
           end
         end
 

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

@@ -71,16 +71,30 @@ module Aptible
             desc 'db:tunnel HANDLE', 'Create a local tunnel to a database'
             option :environment
             option :port, type: :numeric
+            option :type, type: :string
             define_method 'db:tunnel' do |handle|
               desired_port = Integer(options[:port] || 0)
               database = ensure_database(options.merge(db: handle))
-              say 'Creating tunnel...', :green
 
-              with_local_tunnel(database, desired_port) do |tunnel_helper|
+              credential = find_tunnel_credential(database, options[:type])
+
+              say "Creating #{credential.type} tunnel to #{database.handle}...",
+                  :green
+
+              if options[:type].nil?
+                types = database.database_credentials.map(&:type)
+                unless types.empty?
+                  valid = types.join(', ')
+                  say 'Use --type TYPE to specify a tunnel type', :green
+                  say "Valid types for #{database.handle}: #{valid}", :green
+                end
+              end
+
+              with_local_tunnel(credential, desired_port) do |tunnel_helper|
                 port = tunnel_helper.port
-                say "Connect at #{local_url(database, port)}", :green
+                say "Connect at #{local_url(credential, port)}", :green
 
-                uri = URI(local_url(database, port))
+                uri = URI(local_url(credential, port))
                 db = uri.path.gsub(%r{^/}, '')
                 say 'Or, use the following arguments:', :green
                 say("* Host: #{uri.host}", :green)

data/lib/aptible/cli/version.rb

@@ -1,5 +1,5 @@
 module Aptible
   module CLI
-    VERSION = '0.8.3'.freeze
+    VERSION = '0.8.4'.freeze
   end
 end

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

@@ -20,18 +20,114 @@ describe Aptible::CLI::Agent do
       end.to raise_error("Could not find database #{handle}")
     end
 
-    it 'should print a message about how to connect' do
-      allow(Aptible::Api::Database).to receive(:all) { [database] }
-      local_url = 'postgresql://aptible:password@localhost.aptible.in: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(7).times
-      subject.send('db:tunnel', handle)
+    context 'valid database' do
+      before { allow(Aptible::Api::Database).to receive(:all) { [database] } }
+
+      it 'prints a message explaining how to connect' do
+        cred = Fabricate(:database_credential, default: true, type: 'foo',
+                                               database: database)
+
+        expect(subject).to receive(:with_local_tunnel).with(cred, 0)
+          .and_yield(socat_helper)
+
+        expect(subject).to receive(:say)
+          .with('Creating foo tunnel to foobar...', :green)
+
+        local_url = 'postgresql://aptible:password@localhost.aptible.in:4242/db'
+        expect(subject).to receive(:say)
+          .with("Connect at #{local_url}", :green)
+
+        # db:tunnel should also explain each component of the URL and suggest
+        # the --type argument:
+        expect(subject).to receive(:say).exactly(9).times
+        subject.send('db:tunnel', handle)
+      end
+
+      it 'defaults to a default credential' do
+        ok = Fabricate(:database_credential, default: true, database: database)
+        Fabricate(:database_credential, database: database, type: 'foo')
+        Fabricate(:database_credential, database: database, type: 'bar')
+
+        messages = []
+        allow(subject).to receive(:say) { |m, *| messages << m }
+        expect(subject).to receive(:with_local_tunnel).with(ok, 0)
+
+        subject.send('db:tunnel', handle)
+
+        expect(messages.grep(/use --type type/im)).not_to be_empty
+        expect(messages.grep(/valid types.*foo.*bar/im)).not_to be_empty
+      end
+
+      it 'supports --type' do
+        subject.options = { type: 'foo' }
+
+        Fabricate(:database_credential, default: true, database: database)
+        ok = Fabricate(:database_credential, type: 'foo', database: database)
+        Fabricate(:database_credential, type: 'bar', database: database)
+
+        allow(subject).to receive(:say)
+        expect(subject).to receive(:with_local_tunnel).with(ok, 0)
+        subject.send('db:tunnel', handle)
+      end
+
+      it 'fails when there is no default database credential nor type' do
+        Fabricate(:database_credential, default: false, database: database)
+
+        expect { subject.send('db:tunnel', handle) }
+          .to raise_error(/no default credential/im)
+      end
+
+      it 'fails when the type is incorrect' do
+        subject.options = { type: 'bar' }
+
+        Fabricate(:database_credential, type: 'foo', database: database)
+
+        expect { subject.send('db:tunnel', handle) }
+          .to raise_error(/no credential with type bar/im)
+      end
+
+      it 'fails when the database is not provisioned' do
+        database.stub(status: 'pending')
+
+        expect { subject.send('db:tunnel', handle) }
+          .to raise_error(/foobar is not provisioned/im)
+      end
+
+      context 'v1 stack' do
+        before { database.account.stack.stub(version: 'v1') }
+        before { allow(subject).to receive(:say) }
+
+        it 'falls back to the database itself if no type is given' do
+          expect(subject).to receive(:with_local_tunnel).with(database, 0)
+          subject.send('db:tunnel', handle)
+        end
+
+        it 'falls back to the database itself if type matches' do
+          subject.options = { type: 'bar' }
+          database.stub(type: 'bar')
+
+          expect(subject).to receive(:with_local_tunnel).with(database, 0)
+          subject.send('db:tunnel', handle)
+        end
+
+        it 'does not fall back to the database itself if type mismatches' do
+          subject.options = { type: 'bar' }
+          database.stub(type: 'foo')
+
+          expect { subject.send('db:tunnel', handle) }
+            .to raise_error(/no credential with type bar/im)
+        end
+
+        it 'does not suggest other types that do not exist' do
+          messages = []
+          allow(subject).to receive(:say) { |m, *| messages << m }
+          expect(subject).to receive(:with_local_tunnel).with(database, 0)
+
+          subject.send('db:tunnel', handle)
+
+          expect(messages.grep(/use --type type/im)).to be_empty
+        end
+      end
     end
   end
 

data/spec/fabricators/account_fabricator.rb

@@ -4,6 +4,7 @@ Fabricator(:account, from: :stub_account) do
   bastion_host 'localhost'
   dumptruck_port 1234
   handle 'aptible'
+  stack
 
   apps { [] }
   databases { [] }

data/spec/fabricators/database_credential_fabricator.rb

@@ -0,0 +1,11 @@
+class StubDatabaseCredential < OpenStruct; end
+
+Fabricator(:database_credential, from: :stub_database_credential) do
+  database
+
+  default false
+  type 'postgresql'
+  connection_url 'postgresql://aptible:password@10.252.1.125:49158/db'
+
+  after_create { |credential| database.database_credentials << credential }
+end

data/spec/fabricators/database_fabricator.rb

@@ -1,4 +1,8 @@
-class StubDatabase < OpenStruct; end
+class StubDatabase < OpenStruct
+  def provisioned?
+    status == 'provisioned'
+  end
+end
 
 Fabricator(:database, from: :stub_database) do
   type 'postgresql'
@@ -6,10 +10,12 @@ Fabricator(:database, from: :stub_database) do
     Fabricate.sequence(:database) { |i| "#{attrs[:type]}-#{i}" }
   end
   passphrase 'password'
+  status 'provisioned'
   connection_url 'postgresql://aptible:password@10.252.1.125:49158/db'
   account
 
   backups { [] }
+  database_credentials { [] }
 
   after_create { |database| database.account.databases << database }
 end

data/spec/fabricators/stack_fabricator.rb

@@ -0,0 +1,9 @@
+class StubStack < OpenStruct; end
+
+Fabricator(:stack, from: :stub_stack) do
+  name 'foo'
+  version 'v2'
+
+  apps { [] }
+  databases { [] }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aptible-cli
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.4
 platform: ruby
 authors:
 - Frank Macreery
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-06 00:00:00.000000000 Z
+date: 2017-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aptible-api
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.16
+        version: 0.9.20
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.16
+        version: 0.9.20
 - !ruby/object:Gem::Dependency
   name: aptible-auth
   requirement: !ruby/object:Gem::Requirement
@@ -126,16 +126,16 @@ dependencies:
   name: aptible-tasks
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.5.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.5.8
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -182,16 +182,16 @@ dependencies:
   name: climate_control
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.3
 - !ruby/object:Gem::Dependency
   name: fabrication
   requirement: !ruby/object:Gem::Requirement
@@ -263,9 +263,11 @@ files:
 - spec/fabricators/account_fabricator.rb
 - spec/fabricators/app_fabricator.rb
 - spec/fabricators/backup_fabricator.rb
+- spec/fabricators/database_credential_fabricator.rb
 - spec/fabricators/database_fabricator.rb
 - spec/fabricators/operation_fabricator.rb
 - spec/fabricators/service_fabricator.rb
+- spec/fabricators/stack_fabricator.rb
 - spec/fabricators/vhost_fabricator.rb
 - spec/mock/git
 - spec/mock/ssh
@@ -315,9 +317,11 @@ test_files:
 - spec/fabricators/account_fabricator.rb
 - spec/fabricators/app_fabricator.rb
 - spec/fabricators/backup_fabricator.rb
+- spec/fabricators/database_credential_fabricator.rb
 - spec/fabricators/database_fabricator.rb
 - spec/fabricators/operation_fabricator.rb
 - spec/fabricators/service_fabricator.rb
+- spec/fabricators/stack_fabricator.rb
 - spec/fabricators/vhost_fabricator.rb
 - spec/mock/git
 - spec/mock/ssh