aptible-cli 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85166609cc820ace0f7d804059e47335a9e9dd04
-  data.tar.gz: aff75a2d86c878dd185e18a0b5eeb153328ee248
+  metadata.gz: a6a4807415f02ddc44c0472480e3452ff0945d4a
+  data.tar.gz: 7bc74d1f880230acbbec467bdb0c8802a8d3b8cb
 SHA512:
-  metadata.gz: 0760707d72ec0f5795ca9f63211a778978a555b681827359e3634e17e3129e43826d2f68beebd34fdfc95bfb234375f66d3a230012a7e6cff52c67c37f8d7e87
-  data.tar.gz: 482ddca8bf3c13ffd67e5c4398b335fdfcbeaac44d509e64193a5e671ba471083b577b5f7d0713a4f27176c556ed64f5393ed770e0e64e96e8d075d2b5f0afe1
+  metadata.gz: c8477ebfa7cf401acdcc3e49d37e06a633489e6cbf44318f34d39bb2050e1e18452c965535964b6bc70b94c9ee9a4bcfe91131bb05c63db87ea32ddce021b309
+  data.tar.gz: 3cc698ae24440386dc5063560eb4af84d295745d043f9888cbc8104a8f6f51470231ceaa26edffb780b5fcbbf8df6c3f22480b6e1497f6d1f9065536fd57bd9f

data/README.md

@@ -52,10 +52,20 @@ Commands:
   aptible db:tunnel HANDLE                                                                                                           # Create a local tunnel to a database
   aptible db:url HANDLE                                                                                                              # Display a database URL
   aptible deploy [OPTIONS] [VAR1=VAL1] [VAR=VAL2] ...                                                                                # Deploy an app
-  aptible domains                                                                                                                    # Print an app's current virtual domains
+  aptible domains                                                                                                                    # Print an app's current virtual domains - DEPRECATED
+  aptible endpoints:database:create DATABASE                                                                                         # Create a Database Endpoint
+  aptible endpoints:deprovision [--app APP | --database DATABASE] ENDPOINT_HOSTNAME                                                  # Deprovision an App or Database Endpoint
+  aptible endpoints:https:create [--app APP] SERVICE                                                                                 # Create an App HTTPS Endpoint
+  aptible endpoints:https:modify [--app APP] ENDPOINT_HOSTNAME                                                                       # Modify an App HTTPS Endpoint
+  aptible endpoints:list [--app APP | --database DATABASE]                                                                           # List Endpoints for an App or Database
+  aptible endpoints:renew [--app APP] ENDPOINT_HOSTNAME                                                                              # Renew an App Managed TLS Endpoint
+  aptible endpoints:tcp:create [--app APP] SERVICE                                                                                   # Create an App TCP Endpoint
+  aptible endpoints:tcp:modify [--app APP] ENDPOINT_HOSTNAME                                                                         # Modify an App TCP Endpoint
+  aptible endpoints:tls:create [--app APP] SERVICE                                                                                   # Create an App TLS Endpoint
+  aptible endpoints:tls:modify [--app APP] ENDPOINT_HOSTNAME                                                                         # Modify an App TLS Endpoint
   aptible help [COMMAND]                                                                                                             # Describe available commands or one specific command
   aptible login                                                                                                                      # Log in to Aptible
-  aptible logs                                                                                                                       # Follows logs from a running app or database
+  aptible logs [--app APP | --database DATABASE]                                                                                     # Follows logs from a running app or database
   aptible operation:cancel OPERATION_ID                                                                                              # Cancel a running operation
   aptible ps                                                                                                                         # Display running processes for an app - DEPRECATED
   aptible rebuild                                                                                                                    # Rebuild an app, and restart its services

data/aptible-cli.gemspec

@@ -20,9 +20,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{spec/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'aptible-resource', '~> 0.4.0'
-  spec.add_dependency 'aptible-api', '~> 0.9.27'
-  spec.add_dependency 'aptible-auth', '~> 0.11.13'
+  spec.add_dependency 'aptible-resource', '~> 1.0', '>= 1.0.1'
+  spec.add_dependency 'aptible-api', '~> 1.0'
+  spec.add_dependency 'aptible-auth', '~> 1.0'
+  spec.add_dependency 'aptible-billing', '~> 1.0'
   spec.add_dependency 'thor', '~> 0.19.1'
   spec.add_dependency 'git'
   spec.add_dependency 'term-ansicolor'

data/lib/aptible/cli/agent.rb

@@ -11,6 +11,9 @@ require_relative 'helpers/operation'
 require_relative 'helpers/environment'
 require_relative 'helpers/app'
 require_relative 'helpers/database'
+require_relative 'helpers/app_or_database'
+require_relative 'helpers/vhost'
+require_relative 'helpers/vhost/option_set_builder'
 require_relative 'helpers/tunnel'
 
 require_relative 'subcommands/apps'
@@ -26,6 +29,7 @@ require_relative 'subcommands/ssh'
 require_relative 'subcommands/backup'
 require_relative 'subcommands/operation'
 require_relative 'subcommands/inspect'
+require_relative 'subcommands/endpoints'
 
 module Aptible
   module CLI
@@ -47,6 +51,7 @@ module Aptible
       include Subcommands::Backup
       include Subcommands::Operation
       include Subcommands::Inspect
+      include Subcommands::Endpoints
 
       # Forward return codes on failures.
       def self.exit_on_failure?
@@ -116,8 +121,10 @@ module Aptible
       private
 
       def deprecated(msg)
-        say "DEPRECATION NOTICE: #{msg}"
-        say 'Please contact support@aptible.com with any questions.'
+        $stderr.puts yellow([
+          "DEPRECATION NOTICE: #{msg}",
+          'Please contact support@aptible.com with any questions.'
+        ].join("\n"))
       end
 
       def nag_toolbelt

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

@@ -132,6 +132,25 @@ module Aptible
           end
         end
 
+        def ensure_service(options, type)
+          app = ensure_app(options)
+          service = app.services.find { |s| s.process_type == type }
+
+          if service.nil?
+            valid_types = if app.services.empty?
+                            'NONE (deploy the app first)'
+                          else
+                            app.services.map(&:process_type).join(', ')
+                          end
+
+            raise Thor::Error, "Service with type #{type} does not " \
+                               "exist for app #{app.handle}. Valid " \
+                               "types: #{valid_types}."
+          end
+
+          service
+        end
+
         def apps_from_handle(handle, environment)
           if environment
             environment.apps

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

@@ -0,0 +1,34 @@
+module Aptible
+  module CLI
+    module Helpers
+      module AppOrDatabase
+        include Helpers::App
+        include Helpers::Database
+
+        module ClassMethods
+          def app_or_database_options
+            app_options
+            option :database
+          end
+        end
+
+        def ensure_app_or_database(options = {})
+          if options[:app] && options[:database]
+            m = 'You must specify only one of --app and --database'
+            raise Thor::Error, m
+          end
+
+          if options[:database]
+            ensure_database(options.merge(db: options[:database]))
+          else
+            ensure_app(options)
+          end
+        end
+
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+module Aptible
+  module CLI
+    module Helpers
+      module Vhost
+        def explain_vhost(service, vhost)
+          say "Service: #{service.process_type}"
+          say "Hostname: #{vhost.external_host}"
+          say "Status: #{vhost.status}"
+
+          case vhost.type
+          when 'tcp', 'tls'
+            ports = if vhost.container_ports.any?
+                      vhost.container_ports.map(&:to_s).join(' ')
+                    else
+                      'all'
+                    end
+            say "Type: #{vhost.type}"
+            say "Ports: #{ports}"
+          when 'http', 'http_proxy_protocol'
+            port = vhost.container_port ? vhost.container_port : 'default'
+            say 'Type: https'
+            say "Port: #{port}"
+          end
+
+          say "Internal: #{vhost.internal}"
+
+          ip_whitelist = if vhost.ip_whitelist.any?
+                           vhost.ip_whitelist.join(' ')
+                         else
+                           'all traffic'
+                         end
+          say "IP Whitelist: #{ip_whitelist}"
+
+          say "Default Domain Enabled: #{vhost.default}"
+          say "Default Domain: #{vhost.virtual_domain}" if vhost.default
+
+          say "Managed TLS Enabled: #{vhost.acme}"
+          if vhost.acme
+            say "Managed TLS Domain: #{vhost.user_domain}"
+            say 'Managed TLS DNS Challenge Hostname: ' \
+                "#{vhost.acme_dns_challenge_host}"
+            say "Managed TLS Status: #{vhost.acme_status}"
+          end
+        end
+
+        def provision_vhost_and_explain(service, vhost)
+          op = vhost.create_operation!(type: 'provision')
+          attach_to_operation_logs(op)
+          explain_vhost(service, vhost.reload)
+          # TODO: Instructions if ACME is enabled?
+        end
+
+        def find_vhost(service_enumerator, hostname)
+          seen = []
+
+          service_enumerator.each do |service|
+            service.each_vhost do |vhost|
+              seen << vhost.external_host
+              return vhost if vhost.external_host == hostname
+            end
+          end
+
+          e = "Endpoint with hostname #{hostname} does not exist"
+          e = "#{e} (valid hostnames: #{seen.join(', ')})" if seen.any?
+          raise Thor::Error, e
+        end
+
+        def each_vhost(resource, &block)
+          return enum_for(:each_vhost, resource) unless block_given?
+
+          klass = resource.class
+          if klass == Aptible::Api::App
+            resource.each_service(&block)
+          elsif klass == Aptible::Api::Database
+            [resource.service].each(&block)
+          else
+            raise "Unexpected resource: #{klass}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,292 @@
+module Aptible
+  module CLI
+    module Helpers
+      module Vhost
+        class OptionSetBuilder
+          FLAGS = %i(
+            environment
+            app
+            database
+            create
+            tls
+            ports
+            port
+          ).freeze
+
+          def initialize(&block)
+            FLAGS.each { |f| instance_variable_set("@#{f}", false) }
+            instance_exec(&block) if block
+          end
+
+          def declare_options(thor)
+            thor.instance_exec(self) do |builder|
+              option :environment
+
+              if builder.app?
+                app_options
+
+                if builder.create?
+                  option(
+                    :default_domain,
+                    type: :boolean,
+                    desc: 'Enable Default Domain on this Endpoint'
+                  )
+
+                  option(
+                    :internal,
+                    type: :boolean,
+                    desc: 'Restrict this Endpoint to internal traffic'
+                  )
+                end
+
+                if builder.ports?
+                  option(
+                    :ports,
+                    type: :array,
+                    desc: 'A list of ports to expose on this Endpoint'
+                  )
+                end
+
+                if builder.port?
+                  option(
+                    :port,
+                    type: :numeric,
+                    desc: 'A port to expose on this Endpoint'
+                  )
+                end
+              end
+
+              option(
+                :ip_whitelist,
+                type: :array,
+                desc: 'A list of IPv4 sources (addresses or CIDRs) to ' \
+                      'which to restrict traffic to this Endpoint'
+              )
+
+              unless builder.create?
+                # Yes, it has to be a dash...
+                # See: https://github.com/erikhuda/thor/pull/551
+                option(
+                  :'no-ip_whitelist',
+                  type: :boolean,
+                  desc: 'Disable IP Whitelist'
+                )
+              end
+
+              if builder.tls?
+                option(
+                  :certificate_file,
+                  type: :string,
+                  desc: 'A file containing a certificate to use on this ' \
+                        'Endpoint'
+                )
+                option(
+                  :private_key_file,
+                  type: :string,
+                  desc: 'A file containing a private key to use on this ' \
+                        'Endpoint'
+                )
+
+                option(
+                  :managed_tls,
+                  type: :boolean,
+                  desc: 'Enable Managed TLS on this Endpoint'
+                )
+
+                option(
+                  :managed_tls_domain,
+                  desc: 'A domain to use for Managed TLS'
+                )
+
+                option(
+                  :certificate_fingerprint,
+                  type: :string,
+                  desc: 'The fingerprint of an existing Certificate to use ' \
+                        'on this Endpoint'
+                )
+              end
+            end
+          end
+
+          def prepare(account, options)
+            options = options.dup # We're going to delete keys here
+            verify_option_conflicts(options)
+
+            params = {}
+
+            params[:ip_whitelist] = options.delete(:ip_whitelist) do
+              create? ? [] : nil
+            end
+
+            if options.delete(:'no-ip_whitelist') { false }
+              params[:ip_whitelist] = []
+            end
+
+            params[:container_port] = options.delete(:port) if port?
+
+            if ports?
+              raw_ports = options.delete(:ports) do
+                create? ? [] : nil
+              end
+
+              if raw_ports
+                params[:container_ports] = raw_ports.map do |p|
+                  begin
+                    Integer(p)
+                  rescue ArgumentError
+                    m = "Invalid port: #{p}"
+                    raise Thor::Error, m
+                  end
+                end
+              end
+            end
+
+            if app?
+              params[:internal] = options.delete(:internal) do
+                create? ? false : nil
+              end
+
+              params[:default] = options.delete(:default_domain) do
+                create? ? false : nil
+              end
+
+              options.delete(:app)
+            else
+              params[:internal] = false
+            end
+
+            process_tls(account, options, params) if tls?
+
+            options.delete(:environment)
+
+            # NOTE: This is here to ensure that specs don't test for options
+            # that are not declared. This is not expected to happen when using
+            # this.
+            raise "Unexpected options: #{options}" if options.any?
+
+            params.delete_if { |_, v| v.nil? }
+          end
+
+          FLAGS.each do |f|
+            define_method("#{f}?") { instance_variable_get("@#{f}") }
+          end
+
+          private
+
+          FLAGS.each do |f|
+            define_method("#{f}!") { instance_variable_set("@#{f}", true) }
+          end
+
+          def process_tls(account, options_in, params_out)
+            # Certificate fingerprint option
+            if (fingerprint = options_in.delete(:certificate_fingerprint))
+              params_out[:certificate] = find_certificate(account, fingerprint)
+            end
+
+            # Ad-hoc certificate option
+            certificate_file = options_in.delete(:certificate_file)
+            private_key_file = options_in.delete(:private_key_file)
+
+            if certificate_file || private_key_file
+              if certificate_file.nil?
+                raise Thor::Error, "Missing #{to_flag(:certificate_file)}"
+              end
+
+              if private_key_file.nil?
+                raise Thor::Error, "Missing #{to_flag(:private_key_file)}"
+              end
+
+              opts = begin
+                       {
+                         certificate_body: File.read(certificate_file),
+                         private_key: File.read(private_key_file)
+                       }
+                     rescue StandardError => e
+                       m = 'Failed to read certificate or private key ' \
+                         "file: #{e}"
+                       raise Thor::Error, m
+                     end
+
+              params_out[:certificate] = account.create_certificate!(opts)
+            end
+
+            # ACME option
+            params_out[:acme] = options_in.delete(:managed_tls) do
+              create? ? false : nil
+            end
+
+            params_out[:user_domain] = options_in.delete(:managed_tls_domain)
+
+            if create? && params_out[:acme] && params_out[:user_domain].nil?
+              e = "#{to_flag(:managed_tls_domain)} is required to enable " \
+                  'Managed TLS'
+              raise Thor::Error, e
+            end
+          end
+
+          def find_certificate(account, fingerprint)
+            matches = []
+            account.each_certificate do |certificate|
+              if certificate.sha256_fingerprint == fingerprint
+                return certificate
+              end
+
+              if certificate.sha256_fingerprint.start_with?(fingerprint)
+                matches << certificate
+              end
+            end
+
+            matches = matches.uniq(&:sha256_fingerprint)
+
+            case matches.size
+            when 0
+              e = "No certificate matches fingerprint #{fingerprint}"
+              raise Thor::Error, e
+            when 1
+              return matches.first
+            else
+              e = 'Too many certificates match fingerprint ' \
+                  "#{fingerprint}, pass a more specific fingerprint "
+              raise Thor::Error, e
+            end
+          end
+
+          def verify_option_conflicts(options)
+            conflict_groups = [
+              [
+                %i(certificate_file private_key_file),
+                %i(certificate_fingerprint),
+                %i(managed_tls managed_tls_domain),
+                %i(default_domain)
+              ],
+              [
+                %i(no-ip_whitelist),
+                %i(ip_whitelist)
+              ]
+            ]
+
+            conflict_groups.each do |group|
+              matches = group.map do |g|
+                g.any? { |k| !!options[k] }
+              end
+
+              next unless matches.select { |m| !!m }.size > 1
+
+              selected = group.flatten.select do |o|
+                !!options[o]
+              end
+
+              flags = selected.map { |s| to_flag(s) }
+              e = "Conflicting options provided: #{flags.join(', ')}"
+              raise Thor::Error, e
+            end
+          end
+
+          def to_flag(sym)
+            "--#{sym.to_s.tr('_', '-')}"
+          end
+        end
+      end
+    end
+  end
+end