aptible-cli 0.24.0 → 0.24.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4a13b0f26d5c480053eb37bcee8287e8f15fa7f48f17a2d2b435ec3c6adf694
-  data.tar.gz: f0f4d6fc308ab9bde7ebf4c76cf804e1990e35dd13fdbf03e0407128df6a6d1c
+  metadata.gz: a86dab95f37f3e63919dd105b9eca70af63753165bfa6fb2436e626844831bdd
+  data.tar.gz: 01ee1b79365b6a8cbb1399843de3abbc7857e061c6b376ac57b355a55c34e8f6
 SHA512:
-  metadata.gz: 702b8966a0f5d6c67a0d5bd0c2496cbc90b0fa17c5c4214cbb74c59854ea8810a75723dfe68a6562528ca5955e47657b876b39d23221d6ddde5ecd6e0f7b314f
-  data.tar.gz: 50e7d05a0119c694fff4f7924fad1517fd3a4bc94ecbb9d35c27f3aa6af9166070201c6c4241846208dd6adeb447de366af83dd47f76c5835301972717b240db
+  metadata.gz: 404722114100e706aee73134ad66100f5ddeaf71417eea3b8ac065c493acd17f5a2464a0542233fc0fe20af3b26d4b0fc3598ac87b799396238cbf05bc559738
+  data.tar.gz: 2c3a6d45e49401f49ef01985a927f221c029c724ef79993388a42dded813989a57868636d4c4b313a6decb756255dbbb9bce08e67770a3ba7fea654ea18bf946

data/.github/workflows/test.yml

@@ -48,3 +48,18 @@ jobs:
                contains(needs.*.result, 'failure')
             || contains(needs.*.result, 'cancelled')
           }}
+
+  report-version:
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/master'
+    steps:
+      - name: Report version
+        run: |
+          curl -sS -X POST -u "$ENFORCER_USERNAME:$ENFORCER_PASSWORD" \
+           -H "Content-Type: application/json" \
+           -d '{"name":"aptible-cli", "type":"client", "version": "${{ github.sha }}"}' \
+          "$ENFORCER_API/repo_version"
+        env:
+          ENFORCER_API: https://app-83237.aptible-test-leeroy.com
+          ENFORCER_USERNAME: aptible
+          ENFORCER_PASSWORD: ${{ secrets.ENFORCER_PASSWORD }}

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    aptible-cli (0.24.0)
+    aptible-cli (0.24.2)
       activesupport (>= 4.0, < 6.0)
       aptible-api (~> 1.6.5)
       aptible-auth (~> 1.2.5)

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

@@ -15,7 +15,7 @@ module Aptible
         module ClassMethods
           def app_options
             option :app
-            option :environment
+            option :environment, aliases: '--env'
             option :remote, aliases: '-r'
           end
         end

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

@@ -37,11 +37,17 @@ module Aptible
 
         def ensure_default_environment
           environments = Aptible::Api::Account.all(token: fetch_token)
-          return environments.first if environments.count == 1
-
-          raise Thor::Error, <<-ERR.gsub(/\s+/, ' ').strip
-            Multiple environments available, please specify with --environment
-          ERR
+          case environments.count
+          when 0
+            e = 'No environments. Go to https://app.aptible.com/ to proceed'
+            raise Thor::Error, e
+          when 1
+            return environments.first
+          else
+            raise Thor::Error, <<-ERR.gsub(/\s+/, ' ').strip
+              Multiple environments available, please specify with --environment or --env
+            ERR
+          end
         end
       end
     end

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

@@ -38,8 +38,10 @@ module Aptible
           # operation failed, poll_for_success will immediately fall through to
           # the error message.
           unless code == 0
-            e = 'Disconnected from logs, waiting for operation to complete'
-            CLI.logger.warn e
+            msg = ['Disconnected from logs, waiting for operation to complete',
+                   'Once complete, the logs can be viewed here:',
+                   "    #{ui_log_url(operation)}"]
+            msg.each { |e| CLI.logger.warn e }
             poll_for_success(operation)
           end
         end
@@ -76,8 +78,9 @@ module Aptible
           res = http.request(Net::HTTP::Get.new(uri.request_uri, headers))
           # note: res body with a 200 is target redirect location for download
           if !res || res.code != '200' || res.body.nil?
-            raise Thor::Error, 'Unable to retrieve the operation\'s logs. '\
-            'If the issue persists please contact support for assistance.'
+            raise Thor::Error, 'Unable to retrieve the operation\'s logs. ' \
+            'If the issue persists please contact support for assistance, or ' \
+            "view them at #{ui_log_url(operation)}"
           end
           res
         end
@@ -96,6 +99,10 @@ module Aptible
           end
           res
         end
+
+        def ui_log_url(operation)
+          "https://app.aptible.com/operations/#{operation.id}"
+        end
       end
     end
   end

data/lib/aptible/cli/helpers/vhost/option_set_builder.rb

@@ -20,7 +20,7 @@ module Aptible
 
           def declare_options(thor)
             thor.instance_exec(self) do |builder|
-              option :environment
+              option :environment, aliases: '--env'
 
               if builder.database?
                 option :database

data/lib/aptible/cli/resource_formatter.rb

@@ -157,6 +157,7 @@ module Aptible
           node.value('command', service.command || 'CMD')
           node.value('container_count', service.container_count)
           node.value('container_size', service.container_memory_limit_mb)
+          node.value('container_profile', service.instance_class.to_s[/[a-z]/])
 
           attach_app(node, app)
         end

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

@@ -9,7 +9,7 @@ module Aptible
             include Helpers::Token
 
             desc 'apps', 'List all applications'
-            option :environment
+            option :environment, aliases: '--env'
             def apps
               Formatter.render(Renderer.current) do |root|
                 root.grouped_keyed_list(
@@ -28,7 +28,7 @@ module Aptible
             end
 
             desc 'apps:create HANDLE', 'Create a new application'
-            option :environment
+            option :environment, aliases: '--env'
             define_method 'apps:create' do |handle|
               environment = ensure_environment(options)
               app = environment.create_app(handle: handle)
@@ -69,9 +69,11 @@ module Aptible
                 raise Thor::Error, m
               end
 
-              if container_count.nil? && container_size.nil?
-                raise Thor::Error,
-                      'Provide at least --container-count or --container-size'
+              if container_count.nil? && container_size.nil? &&
+                 container_profile.nil?
+                m = 'Provide at least --container-count, --container-size, ' \
+                    'or --container-profile'
+                raise Thor::Error, m
               end
 
               # We don't validate any parameters here: API will do that for us.
@@ -104,7 +106,7 @@ module Aptible
                  ' ENVIRONMENT_HANDLE]', 'Rename an app handle. In order'\
                  ' for the new app handle to appear in log drain and metric'\
                  ' drain destinations, you must restart the app.'
-            option :environment
+            option :environment, aliases: '--env'
             define_method 'apps:rename' do |old_handle, new_handle|
               env = ensure_environment(options)
               app = ensure_app(options.merge(app: old_handle))

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

@@ -14,7 +14,8 @@ module Aptible
                  '[--key-arn KEY_ARN]',
                  'Restore a backup'
             option :handle, desc: 'a name to use for the new database'
-            option :environment, desc: 'a different environment to restore to'
+            option :environment, aliases: '--env',
+                                 desc: 'a different environment to restore to'
             option :container_size, type: :numeric
             option :size, type: :numeric
             option :disk_size, type: :numeric
@@ -68,9 +69,9 @@ module Aptible
             end
 
             desc 'backup:list DB_HANDLE', 'List backups for a database'
-            option :environment
+            option :environment, aliases: '--env'
             option :max_age,
-                   default: '1mo',
+                   default: '99y',
                    desc: 'Limit backups returned (example usage: 1w, 1y, etc.)'
             define_method 'backup:list' do |handle|
               age = ChronicDuration.parse(options[:max_age])
@@ -95,8 +96,8 @@ module Aptible
 
             desc 'backup:orphaned', 'List backups associated with ' \
                                     'deprovisioned databases'
-            option :environment
-            option :max_age, default: '1y',
+            option :environment, aliases: '--env'
+            option :max_age, default: '99y',
                              desc: 'Limit backups returned '\
                                    '(example usage: 1w, 1y, etc.)'
             define_method 'backup:orphaned' do

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

@@ -1,5 +1,4 @@
 require 'shellwords'
-
 module Aptible
   module CLI
     module Subcommands
@@ -72,6 +71,7 @@ module Aptible
               # FIXME: define_method - ?! Seriously, WTF Thor.
               app = ensure_app(options)
               env = Hash[args.map do |arg|
+                arg = arg.split('=')[0]
                 validate_env_key!(arg)
                 [arg, '']
               end]

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

@@ -14,7 +14,7 @@ module Aptible
             include Term::ANSIColor
 
             desc 'db:list', 'List all databases'
-            option :environment
+            option :environment, aliases: '--env'
             define_method 'db:list' do
               Formatter.render(Renderer.current) do |root|
                 root.grouped_keyed_list(
@@ -63,7 +63,7 @@ module Aptible
             option :disk_size, default: 10, type: :numeric
             option :size, type: :numeric
             option :key_arn, type: :string
-            option :environment
+            option :environment, aliases: '--env'
             option :container_profile, type: :string,
                                        desc: 'Examples: m c r'
             option :iops, type: :numeric
@@ -126,7 +126,7 @@ module Aptible
             end
 
             desc 'db:clone SOURCE DEST', 'Clone a database to create a new one'
-            option :environment
+            option :environment, aliases: '--env'
             define_method 'db:clone' do |source_handle, dest_handle|
               # TODO: Deprecate + recommend backup
               source = ensure_database(options.merge(db: source_handle))
@@ -139,7 +139,7 @@ module Aptible
                  '[--container-profile PROFILE] [--iops IOPS] ' \
                  '[--logical --version VERSION] [--key-arn KEY_ARN]',
                  'Create a replica/follower of a database'
-            option :environment
+            option :environment, aliases: '--env'
             option :container_size, type: :numeric
             option :size, type: :numeric
             option :disk_size, type: :numeric
@@ -191,7 +191,7 @@ module Aptible
 
             desc 'db:dump HANDLE [pg_dump options]',
                  'Dump a remote database to file'
-            option :environment
+            option :environment, aliases: '--env'
             define_method 'db:dump' do |handle, *dump_options|
               database = ensure_database(options.merge(db: handle))
               with_postgres_tunnel(database) do |url|
@@ -204,7 +204,7 @@ module Aptible
 
             desc 'db:execute HANDLE SQL_FILE [--on-error-stop]',
                  'Executes sql against a database'
-            option :environment
+            option :environment, aliases: '--env'
             option :on_error_stop, type: :boolean
             define_method 'db:execute' do |handle, sql_path|
               database = ensure_database(options.merge(db: handle))
@@ -217,7 +217,7 @@ module Aptible
             end
 
             desc 'db:tunnel HANDLE', 'Create a local tunnel to a database'
-            option :environment
+            option :environment, aliases: '--env'
             option :port, type: :numeric
             option :type, type: :string
             define_method 'db:tunnel' do |handle|
@@ -262,7 +262,7 @@ module Aptible
             end
 
             desc 'db:deprovision HANDLE', 'Deprovision a database'
-            option :environment
+            option :environment, aliases: '--env'
             define_method 'db:deprovision' do |handle|
               database = ensure_database(options.merge(db: handle))
               CLI.logger.info "Deprovisioning #{database.handle}..."
@@ -278,7 +278,7 @@ module Aptible
             end
 
             desc 'db:backup HANDLE', 'Backup a database'
-            option :environment
+            option :environment, aliases: '--env'
             define_method 'db:backup' do |handle|
               database = ensure_database(options.merge(db: handle))
               CLI.logger.info "Backing up #{database.handle}..."
@@ -287,7 +287,7 @@ module Aptible
             end
 
             desc 'db:reload HANDLE', 'Reload a database'
-            option :environment
+            option :environment, aliases: '--env'
             define_method 'db:reload' do |handle|
               database = ensure_database(options.merge(db: handle))
               CLI.logger.info "Reloading #{database.handle}..."
@@ -300,7 +300,7 @@ module Aptible
                  '[--container-profile PROFILE] [--iops IOPS] ' \
                  '[--volume-type [gp2, gp3]]',
                  'Restart a database'
-            option :environment
+            option :environment, aliases: '--env'
             option :container_size, type: :numeric
             option :container_profile, type: :string,
                                        desc: 'Examples: m c r'
@@ -335,7 +335,7 @@ module Aptible
             desc 'db:modify HANDLE ' \
                  '[--iops IOPS] [--volume-type [gp2, gp3]]',
                  'Modify a database disk'
-            option :environment
+            option :environment, aliases: '--env'
             option :iops, type: :numeric
             option :volume_type
             define_method 'db:modify' do |handle|
@@ -354,7 +354,7 @@ module Aptible
             end
 
             desc 'db:url HANDLE', 'Display a database URL'
-            option :environment
+            option :environment, aliases: '--env'
             option :type, type: :string
             define_method 'db:url' do |handle|
               database = ensure_database(options.merge(db: handle))
@@ -371,7 +371,7 @@ module Aptible
                  ' ENVIRONMENT_HANDLE]', 'Rename a database handle. In order'\
                  ' for the new database handle to appear in log drain and'\
                  ' metric drain destinations, you must reload the database.'
-            option :environment
+            option :environment, aliases: '--env'
             define_method 'db:rename' do |old_handle, new_handle|
               env = ensure_environment(options)
               db = ensure_database(options.merge(db: old_handle))

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

@@ -8,7 +8,7 @@ module Aptible
             include Helpers::Token
 
             desc 'environment:list', 'List all environments'
-            option :environment
+            option :environment, aliases: '--env'
             define_method 'environment:list' do
               Formatter.render(Renderer.current) do |root|
                 root.keyed_list(
@@ -25,7 +25,7 @@ module Aptible
 
             desc 'environment:ca_cert',
                  'Retrieve the CA certificate associated with the environment'
-            option :environment
+            option :environment, aliases: '--env'
             define_method 'environment:ca_cert' do
               Formatter.render(Renderer.current) do |root|
                 root.grouped_keyed_list(

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

@@ -19,11 +19,11 @@ module Aptible
               option :drain_databases, default: true, type: :boolean
               option :drain_ephemeral_sessions, default: true, type: :boolean
               option :drain_proxies, default: true, type: :boolean
-              option :environment
+              option :environment, aliases: '--env'
             end
 
             desc 'log_drain:list', 'List all Log Drains'
-            option :environment
+            option :environment, aliases: '--env'
             define_method 'log_drain:list' do
               Formatter.render(Renderer.current) do |root|
                 root.grouped_keyed_list(
@@ -137,7 +137,7 @@ module Aptible
 
             desc 'log_drain:deprovision HANDLE --environment ENVIRONMENT',
                  'Deprovisions a log drain'
-            option :environment
+            option :environment, aliases: '--env'
             define_method 'log_drain:deprovision' do |handle|
               account = ensure_environment(options)
               drain = ensure_log_drain(account, handle)

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

@@ -11,7 +11,7 @@ module Aptible
             desc 'maintenance:apps',
                  'List Apps impacted by maintenance schedules where '\
                  'restarts are required'
-            option :environment
+            option :environment, aliases: '--env'
             define_method 'maintenance:apps' do
               found_maintenance = false
               m = maintenance_apps
@@ -46,7 +46,7 @@ module Aptible
             desc 'maintenance:dbs',
                  'List Databases impacted by maintenance schedules where '\
                  'restarts are required'
-            option :environment
+            option :environment, aliases: '--env'
             define_method 'maintenance:dbs' do
               found_maintenance = false
               m = maintenance_databases

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

@@ -18,7 +18,7 @@ module Aptible
             include Helpers::MetricDrain
 
             desc 'metric_drain:list', 'List all Metric Drains'
-            option :environment
+            option :environment, aliases: '--env'
             define_method 'metric_drain:list' do
               Formatter.render(Renderer.current) do |root|
                 root.grouped_keyed_list(
@@ -40,7 +40,7 @@ module Aptible
                  '--db DATABASE_HANDLE --environment ENVIRONMENT',
                  'Create an InfluxDB Metric Drain'
             option :db, type: :string
-            option :environment
+            option :environment, aliases: '--env'
 
             define_method 'metric_drain:create:influxdb' do |handle|
               account = ensure_environment(options)
@@ -66,7 +66,7 @@ module Aptible
             option :password, type: :string
             option :url, type: :string
             option :db, type: :string
-            option :environment
+            option :environment, aliases: '--env'
             define_method 'metric_drain:create:influxdb:custom' do |handle|
               account = ensure_environment(options)
 
@@ -95,7 +95,7 @@ module Aptible
             option :org, type: :string
             option :token, type: :string
             option :url, type: :string
-            option :environment
+            option :environment, aliases: '--env'
             define_method 'metric_drain:create:influxdb:customv2' do |handle|
               account = ensure_environment(options)
 
@@ -121,7 +121,7 @@ module Aptible
                  'Create a Datadog Metric Drain'
             option :api_key, type: :string
             option :site, type: :string
-            option :environment
+            option :environment, aliases: '--env'
             define_method 'metric_drain:create:datadog' do |handle|
               account = ensure_environment(options)
 
@@ -150,7 +150,7 @@ module Aptible
 
             desc 'metric_drain:deprovision HANDLE --environment ENVIRONMENT',
                  'Deprovisions a Metric Drain'
-            option :environment
+            option :environment, aliases: '--env'
             define_method 'metric_drain:deprovision' do |handle|
               account = ensure_environment(options)
               drain = ensure_metric_drain(account, handle)

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

@@ -65,11 +65,14 @@ module Aptible
                 end
               end
             end
+
             no_commands do
               alias_method 'services:sizing_policy',
                            'services:autoscaling_policy'
             end
 
+            map 'services:sizing_policy' => 'services:autoscaling_policy'
+
             desc 'services:autoscaling_policy:set SERVICE '\
                    '--autoscaling-type (horizontal|vertical) '\
                    '[--metric-lookback-seconds SECONDS] '\
@@ -196,10 +199,14 @@ module Aptible
                 service.create_service_sizing_policy!(**args)
               end
             end
+
             no_commands do
               alias_method 'services:sizing_policy:set',
                            'services:autoscaling_policy:set'
             end
+
+            map 'services:sizing_policy:set' =>
+                'services:autoscaling_policy:set'
           end
         end
       end

data/lib/aptible/cli/version.rb

@@ -1,5 +1,5 @@
 module Aptible
   module CLI
-    VERSION = '0.24.0'.freeze
+    VERSION = '0.24.2'.freeze
   end
 end

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

@@ -93,11 +93,13 @@ describe Aptible::CLI::Agent do
 
       s1 = Fabricate(
         :service,
-        app: app, process_type: 's1', command: 'true', container_count: 2
+        app: app, process_type: 's1', command: 'true', container_count: 2,
+        instance_class: 'm5'
       )
       s2 = Fabricate(
         :service,
-        app: app, process_type: 's2', container_memory_limit_mb: 2048
+        app: app, process_type: 's2', container_memory_limit_mb: 2048,
+        instance_class: 'r5'
       )
 
       expected_json = [
@@ -118,6 +120,7 @@ describe Aptible::CLI::Agent do
               'id' => s1.id,
               'command' => s1.command,
               'container_count' => s1.container_count,
+              'container_profile' => 'm',
               'container_size' => s1.container_memory_limit_mb,
               'created_at' => fmt_time(s1.created_at)
             },
@@ -126,6 +129,7 @@ describe Aptible::CLI::Agent do
               'id' => s2.id,
               'command' => 'CMD',
               'container_count' => s2.container_count,
+              'container_profile' => 'r',
               'container_size' => s2.container_memory_limit_mb,
               'created_at' => fmt_time(s2.created_at)
             }

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

@@ -109,6 +109,17 @@ describe Aptible::CLI::Agent do
       subject.send('config:unset', 'FOO')
     end
 
+    it 'unsets environment variables even if the user passes a value' do
+      expect(app).to receive(:create_operation!)
+        .with(type: 'configure', env: { 'FOO' => '' })
+        .and_return(operation)
+
+      expect(subject).to receive(:attach_to_operation_logs)
+        .with(operation)
+
+      subject.send('config:unset', 'FOO=whoops')
+    end
+
     it 'rejects environment variables that start with -' do
       expect { subject.send('config:rm', '-foo') }
         .to raise_error(/invalid argument/im)

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

@@ -142,7 +142,8 @@ describe Aptible::CLI::Agent do
 
       expect { subject.send('operation:logs', 1) }
         .to raise_error('Unable to retrieve the operation\'s logs. '\
-          'If the issue persists please contact support for assistance.')
+          'If the issue persists please contact support for assistance, ' \
+          "or view them at https://app.aptible.com/operations/#{operation_id}")
     end
     it 'errors when body is empty' do
       operation_id = SecureRandom.uuid
@@ -163,7 +164,8 @@ describe Aptible::CLI::Agent do
 
       expect { subject.send('operation:logs', 1) }
         .to raise_error('Unable to retrieve the operation\'s logs. '\
-          'If the issue persists please contact support for assistance.')
+          'If the issue persists please contact support for assistance, ' \
+          "or view them at https://app.aptible.com/operations/#{operation_id}")
     end
     it 'errors when s3 itself returns an error code' do
       operation_id = SecureRandom.uuid

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

@@ -46,6 +46,14 @@ describe Aptible::CLI::Agent do
       expect(captured_output_text.split("\n")).to include('Container Count: 3')
     end
 
+    it 'lists container profile' do
+      Fabricate(:service, app: app, instance_class: 'u7')
+      subject.send('services')
+
+      expect(captured_output_text.split("\n"))
+        .to include('Container Profile: u')
+    end
+
     it 'lists multiple services' do
       Fabricate(:service, app: app, process_type: 'foo')
       Fabricate(:service, app: app, process_type: 'bar')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aptible-cli
 version: !ruby/object:Gem::Version
-  version: 0.24.0
+  version: 0.24.2
 platform: ruby
 authors:
 - Frank Macreery
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-13 00:00:00.000000000 Z
+date: 2025-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -472,7 +472,7 @@ homepage: https://github.com/aptible/aptible-cli
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -487,8 +487,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.0.3.1
+signing_key:
 specification_version: 4
 summary: Command-line interface for Aptible services
 test_files: