aptible-cli 0.16.6 → 0.16.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00beffb5298954baab427a850fca6f30be69ab59f6c5ff098a2d65ee64546094
-  data.tar.gz: 5c56645ed8df1aeb780248bdbf68658410d8aba3589f8daa84b6b89498464539
+  metadata.gz: 35f34899ac1d54918f9f5852b665196f65f8a40daa70a405ffd10c64f0a6014a
+  data.tar.gz: 8c0703501a28277b3775fe85b80b53ccdfc9a36256073da64119995f84b17534
 SHA512:
-  metadata.gz: 01f8a8d9f7370c9ffbdcb83f9c17f83668b5e7c42cd7a35f5a397156f72a279f394777fd92feebf93395520a267027b04c12f5b5a557000b50c3cb67c6f64583
-  data.tar.gz: b1182433b759c81561d79488d6937f5badc84b3b58f75c2ed1387cb71f4102a2dc15a304810c3db5b25f3c39fd9f1a3a8e2d290a20f97a97e114c8b5efe0dfc6
+  metadata.gz: 3da14de30e9885ee58a3d03141a6c854beaf499825faac9dae1deeebb676ceab16ee57b0a68f6148592ccca8b87d385c3052c426cf6fc028d34b86eb84d3b8d2
+  data.tar.gz: 634ece7c98758d5164ef56fa5a82bfbbe7974568f5d806d8e93cfd4e50c027ec7834785eaebb05307eb00dfa2a6e9b769b5b20c1415f84c4b026e73c5a14bbe1

data/Gemfile

@@ -6,7 +6,7 @@ gem 'rack', '~> 1.0'
 
 group :test do
   gem 'webmock'
-  gem 'codecov', require: false
+  gem 'codecov', '~> 0.1.0', require: false
 end
 
 # Specify your gem's dependencies in aptible-cli.gemspec

data/README.md

@@ -34,7 +34,8 @@ Commands:
   aptible apps:deprovision                                                                                                                # Deprovision an app
   aptible apps:scale SERVICE [--container-count COUNT] [--container-size SIZE_MB]                                                         # Scale a service
   aptible backup:list DB_HANDLE                                                                                                           # List backups for a database
-  aptible backup:purge BACKUP_ID                                                                                                          # Permanently delete a backup
+  aptible backup:orphaned                                                                                                                 # List backups associated with deprovisioned databases
+  aptible backup:purge BACKUP_ID                                                                                                          # Permanently delete a backup and any copies of it
   aptible backup:restore BACKUP_ID [--environment ENVIRONMENT_HANDLE] [--handle HANDLE] [--container-size SIZE_MB] [--disk-size SIZE_GB]  # Restore a backup
   aptible config                                                                                                                          # Print an app's current configuration
   aptible config:add [VAR1=VAL1] [VAR2=VAL2] [...]                                                                                        # Add an ENV variable to an app
@@ -49,7 +50,7 @@ Commands:
   aptible db:execute HANDLE SQL_FILE [--on-error-stop]                                                                                    # Executes sql against a database
   aptible db:list                                                                                                                         # List all databases
   aptible db:reload HANDLE                                                                                                                # Reload a database
-  aptible db:replicate HANDLE REPLICA_HANDLE [--container-size SIZE_MB] [--disk-size SIZE_GB]                                             # Create a replica/follower of a database
+  aptible db:replicate HANDLE REPLICA_HANDLE [--container-size SIZE_MB] [--disk-size SIZE_GB] [--logical --version VERSION]               # Create a replica/follower of a database
   aptible db:restart HANDLE [--container-size SIZE_MB] [--disk-size SIZE_GB]                                                              # Restart a database
   aptible db:tunnel HANDLE                                                                                                                # Create a local tunnel to a database
   aptible db:url HANDLE                                                                                                                   # Display a database URL

data/aptible-cli.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'aptible-resource', '~> 1.1'
-  spec.add_dependency 'aptible-api', '~> 1.0'
+  spec.add_dependency 'aptible-api', '~> 1.2'
   spec.add_dependency 'aptible-auth', '~> 1.1.0'
   spec.add_dependency 'aptible-billing', '~> 1.0'
   spec.add_dependency 'thor', '~> 0.20.0'

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

@@ -49,11 +49,19 @@ module Aptible
 
         def replicate_database(source, dest_handle, options)
           replication_params = {
-            type: 'replicate',
             handle: dest_handle,
             container_size: options[:container_size],
             disk_size: options[:size]
           }.reject { |_, v| v.nil? }
+
+          if options[:logical]
+            replication_params[:type] = 'replicate_logical'
+            replication_params[:docker_ref] =
+              options[:database_image].docker_repo
+          else
+            replication_params[:type] = 'replicate'
+          end
+
           op = source.create_operation!(replication_params)
           attach_to_operation_logs(op)
 

data/lib/aptible/cli/resource_formatter.rb

@@ -4,6 +4,41 @@ module Aptible
       class << self
         NO_NESTING = Object.new.freeze
 
+        def inject_backup(node, backup, include_db: false)
+          description = "#{backup.id}: #{backup.created_at}, " \
+                        "#{backup.aws_region}"
+
+          if include_db
+            db = backup.database_with_deleted
+            node.keyed_object('database', 'id') do |n|
+              inject_deleted_database(n, db, backup.account)
+            end
+
+            description = "#{description}, " \
+                          "#{db.handle} deleted at #{db.deleted_at}"
+          end
+
+          node.value('id', backup.id)
+          node.value('description', description)
+          node.value('created_at', backup.created_at)
+          node.value('region', backup.aws_region)
+          node.value('size', backup.size)
+
+          if backup.copied_from
+            node.keyed_object('copied_from', 'description') do |n|
+              inject_backup(n, backup.copied_from)
+            end
+          end
+        end
+
+        def inject_deleted_database(node, database, account)
+          node.value('id', database.id)
+          node.value('handle', database.handle)
+          node.value('type', database.type)
+          node.value('deleted_at', database.deleted_at)
+          attach_account(node, account)
+        end
+
         def inject_account(node, account)
           node.value('id', account.id)
           node.value('handle', account.handle)
@@ -47,6 +82,7 @@ module Aptible
 
           node.value('type', database.type)
           node.value('status', database.status)
+
           node.value('connection_url', database.connection_url)
 
           node.list('credentials') do |creds_list|
@@ -54,7 +90,6 @@ module Aptible
               creds_list.object { |n| inject_credential(n, cred) }
             end
           end
-
           attach_account(node, account)
         end
 

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

@@ -23,7 +23,8 @@ module Aptible
               handle = options[:handle]
               unless handle
                 ts_suffix = backup.created_at.getgm.strftime '%Y-%m-%d-%H-%M-%S'
-                handle = "#{backup.database.handle}-at-#{ts_suffix}"
+                handle =
+                  "#{backup.database_with_deleted.handle}-at-#{ts_suffix}"
               end
 
               destination_account = if options[:environment]
@@ -69,24 +70,50 @@ module Aptible
               database = ensure_database(options.merge(db: handle))
 
               Formatter.render(Renderer.current) do |root|
-                root.keyed_list('description') do |l|
+                root.keyed_list('description') do |node|
                   database.each_backup do |backup|
-                    break if backup.created_at < min_created_at
-                    description = "#{backup.id}: #{backup.created_at}, " \
-                      "#{backup.aws_region}"
+                    if backup.created_at < min_created_at && !backup.copied_from
+                      break
+                    end
+                    node.object do |n|
+                      ResourceFormatter.inject_backup(n, backup)
+                    end
+                  end
+                end
+              end
+            end
 
-                    l.object do |o|
-                      o.value('id', backup.id)
-                      o.value('description', description)
-                      o.value('created_at', backup.created_at)
-                      o.value('region', backup.aws_region)
+            desc 'backup:orphaned', 'List backups associated with ' \
+                                    'deprovisioned databases'
+            option :environment
+            option :max_age, default: '1y',
+                             desc: 'Limit backups returned '\
+                                   '(example usage: 1w, 1y, etc.)'
+            define_method 'backup:orphaned' do
+              age = ChronicDuration.parse(options[:max_age])
+              raise Thor::Error, "Invalid age: #{options[:max_age]}" if age.nil?
+              min_created_at = Time.now - age
+
+              Formatter.render(Renderer.current) do |root|
+                root.keyed_list('description') do |node|
+                  scoped_environments(options).each do |account|
+                    account.each_orphaned_backup do |backup|
+                      created_at = backup.created_at
+                      copied_from = backup.copied_from
+                      break if created_at < min_created_at && !copied_from
+                      node.object do |n|
+                        ResourceFormatter.inject_backup(
+                          n, backup, include_db: true
+                        )
+                      end
                     end
                   end
                 end
               end
             end
 
-            desc 'backup:purge BACKUP_ID', 'Permanently delete a backup'
+            desc 'backup:purge BACKUP_ID',
+                 'Permanently delete a backup and any copies of it'
             define_method 'backup:purge' do |backup_id|
               backup = Aptible::Api::Backup.find(backup_id, token: fetch_token)
               raise Thor::Error, "Backup ##{backup_id} not found" if backup.nil?

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

@@ -122,20 +122,39 @@ module Aptible
             end
 
             desc 'db:replicate HANDLE REPLICA_HANDLE ' \
-                 '[--container-size SIZE_MB] [--disk-size SIZE_GB]',
+                 '[--container-size SIZE_MB] [--disk-size SIZE_GB] ' \
+                 '[--logical --version VERSION]',
                  'Create a replica/follower of a database'
             option :environment
             option :container_size, type: :numeric
             option :size, type: :numeric
             option :disk_size, type: :numeric
+            option :logical, type: :boolean
+            option :version, type: :string
             define_method 'db:replicate' do |source_handle, dest_handle|
               source = ensure_database(options.merge(db: source_handle))
+
+              if options[:logical]
+                if source.type != 'postgresql'
+                  raise Thor::Error, 'Logical replication only works for ' \
+                                     'PostgreSQL'
+                end
+                if options[:version]
+                  image = find_database_image(source.type, options[:version])
+                else
+                  raise Thor::Error, '--version is required for logical ' \
+                                     'replication'
+                end
+              end
+
               CLI.logger.info "Replicating #{source_handle}..."
 
               opts = {
                 environment: options[:environment],
                 container_size: options[:container_size],
-                size: options[:disk_size] || options[:size]
+                size: options[:disk_size] || options[:size],
+                logical: options[:logical],
+                database_image: image || nil
               }.delete_if { |_, v| v.nil? }
 
               CLI.logger.warn([

data/lib/aptible/cli/version.rb

@@ -1,5 +1,5 @@
 module Aptible
   module CLI
-    VERSION = '0.16.6'.freeze
+    VERSION = '0.16.7'.freeze
   end
 end

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

@@ -2,14 +2,17 @@ require 'spec_helper'
 
 describe Aptible::CLI::Agent do
   let(:token) { 'some-token' }
-  let(:account) { Fabricate(:account, handle: 'test') }
+  let(:account) { Fabricate(:account, handle: 'test', id: 1) }
   let(:alt_account) { Fabricate(:account, handle: 'alt') }
   let(:database) { Fabricate(:database, account: account, handle: 'some-db') }
   let!(:backup) do
     # created_at: 2016-06-14 13:24:11 +0000
     Fabricate(
       :backup,
-      database: database, created_at: Time.at(1465910651), account: account
+      database_with_deleted: database,
+      created_at: Time.at(1465910651),
+      account: account,
+      id: 1
     )
   end
 
@@ -179,6 +182,50 @@ describe Aptible::CLI::Agent do
     end
   end
 
+  describe '#backup:orphaned' do
+    before { allow(Aptible::Api::Account).to receive(:all) { [account] } }
+    before do
+      m = allow(account).to receive(:each_orphaned_backup)
+      ages = [
+        1.day, 2.days, 3.days, 4.days,
+        5.days, 2.weeks, 3.weeks, 1.month,
+        1.year
+      ]
+      ages.each do |age|
+        b = Fabricate(:backup, database: database, created_at: age.ago,
+                               account: account)
+        allow(b).to receive(:database_with_deleted).and_return(database)
+        m.and_yield(b)
+        b
+      end
+    end
+    before { subject.options = { max_age: '1w' } }
+
+    it 'can show a subset of backups' do
+      subject.send('backup:orphaned')
+      puts captured_output_text
+      expect(captured_output_text.split("\n").size).to eq(5)
+    end
+
+    it 'allows scoping via environment' do
+      subject.options = { max_age: '1w', environment: database.account.handle }
+      subject.send('backup:orphaned')
+      expect(captured_output_text.split("\n").size).to eq(5)
+    end
+
+    it 'shows more backups if requested' do
+      subject.options = { max_age: '2y' }
+      subject.send('backup:orphaned')
+      expect(captured_output_text.split("\n").size).to eq(9)
+    end
+
+    it 'errors out if max_age is invalid' do
+      subject.options = { max_age: 'foobar' }
+      expect { subject.send('backup:orphaned') }
+        .to raise_error(Thor::Error, 'Invalid age: foobar')
+    end
+  end
+
   describe '#backup:purge' do
     it 'fails if the backup cannot be found' do
       expect(Aptible::Api::Backup).to receive(:find)

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

@@ -519,6 +519,69 @@ describe Aptible::CLI::Agent do
       expect { subject.send('db:replicate', 'nope', 'replica') }
         .to raise_error(Thor::Error, 'Could not find database nope')
     end
+
+    it 'allows logical replication of a database with --version set' do
+      master = Fabricate(:database, handle: 'master')
+      databases << master
+      replica = Fabricate(:database,
+                          account: master.account,
+                          handle: 'replica')
+
+      dbimg = Fabricate(:database_image,
+                        type: 'postgresql',
+                        version: 10,
+                        docker_repo: 'aptible/postgresql:10')
+
+      expect(subject).to receive(:find_database_image).with('postgresql', 10)
+        .and_return(dbimg)
+
+      op = Fabricate(:operation)
+
+      params = { type: 'replicate_logical', handle: 'replica',
+                 docker_ref: dbimg.docker_repo }
+      expect(master).to receive(:create_operation!)
+        .with(**params).and_return(op)
+
+      expect(subject).to receive(:attach_to_operation_logs).with(op) do
+        databases << replica
+        replica
+      end
+
+      provision = Fabricate(:operation)
+
+      expect(replica).to receive_message_chain(:operations, :last)
+        .and_return(provision)
+
+      expect(subject).to receive(:attach_to_operation_logs).with(provision)
+
+      expect(replica).to receive(:reload).and_return(replica)
+
+      subject.options = { logical: true, version: 10 }
+      subject.send('db:replicate', 'master', 'replica')
+
+      expect(captured_logs).to match(/replicating master/i)
+    end
+
+    it 'fails if logical replication requested without --version' do
+      master = Fabricate(:database, handle: 'master', type: 'postgresql')
+      databases << master
+
+      subject.options = { type: 'replicate', handle: 'replica', logical: true }
+      expect { subject.send('db:replicate', 'master', 'replica') }
+        .to raise_error(Thor::Error, '--version is required for logical ' \
+                                     'replication')
+    end
+
+    it 'fails if logical replication requested for non-postgres db' do
+      master = Fabricate(:database, handle: 'master', type: 'mysql')
+      databases << master
+
+      subject.options = { type: 'replicate', handle: 'replica',
+                          logical: true, version: 10 }
+      expect { subject.send('db:replicate', 'master', 'replica') }
+        .to raise_error(Thor::Error, 'Logical replication only works for ' \
+                                     'PostgreSQL')
+    end
   end
 
   describe '#db:dump' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aptible-cli
 version: !ruby/object:Gem::Version
-  version: 0.16.6
+  version: 0.16.7
 platform: ruby
 authors:
 - Frank Macreery
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-14 00:00:00.000000000 Z
+date: 2020-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aptible-resource
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: aptible-auth
   requirement: !ruby/object:Gem::Requirement