**V3**: create-route can now take in a port for tcp domains

- add kubernetes check when checking for tcp in domains
- use actions/route_create and delete actions/v3/route_create
- refactored protocols method on domain

Co-authored-by: Sarah Weinstein <sweinstein@pivotal.io>

[#162107369]

Author: weymanf

app/actions/manifest_route_update.rb

@@ -1,5 +1,5 @@
 require 'cloud_controller/app_manifest/manifest_route'
-require 'actions/v3/route_create'
+require 'actions/route_create'
 
 module VCAP::CloudController
   class ManifestRouteUpdate
@@ -40,15 +40,13 @@ def update(app_guid, message, user_audit_info)
             manifest_triggered: true
           )
         end
-      rescue Sequel::ValidationFailed => e
+      rescue Sequel::ValidationFailed, RouteCreate::Error => e
         raise InvalidRoute.new(e.message)
       end
 
       private
 
       def find_or_create_valid_route(app, manifest_route, user_audit_info)
-        logger = Steno.logger('cc.action.route_update')
-
         manifest_route[:candidate_host_domain_pairs].each do |candidate|
           potential_domain = candidate[:domain]
           existing_domain = Domain.find(name: potential_domain)
@@ -71,14 +69,18 @@ def find_or_create_valid_route(app, manifest_route, user_audit_info)
               raise CloudController::Errors::ApiError.new_from_details('NotAuthorized')
             end
 
-            route_hash = {
-              host: host,
-              domain_guid: existing_domain.guid,
-              path: manifest_route[:path],
-              port: manifest_route[:port] || 0,
-              space_guid: app.space.guid
-            }
-            route = V3::RouteCreate.create_route(route_hash: route_hash, user_audit_info: user_audit_info, logger: logger, manifest_triggered: true)
+            message = RouteCreateMessage.new({
+              'host' => host,
+              'path' => manifest_route[:path],
+              'port' => manifest_route[:port],
+            })
+
+            route = RouteCreate.new(user_audit_info).create(
+              message: message,
+              space: app.space,
+              domain: existing_domain,
+              manifest_triggered: true,
+            )
           elsif route.space.guid != app.space.guid
             raise InvalidRoute.new('Routes cannot be mapped to destinations in different spaces')
           end

app/actions/route_create.rb

@@ -7,10 +7,11 @@ def initialize(user_audit_info)
       @user_audit_info = user_audit_info
     end
 
-    def create(message:, space:, domain:)
+    def create(message:, space:, domain:, manifest_triggered: false)
       route = Route.new(
         host: message.host || '',
         path: message.path || '',
+        port: message.port || 0,
         space: space,
         domain: domain,
       )
@@ -25,7 +26,7 @@ def create(message:, space:, domain:)
         route,
         @user_audit_info,
         message.audit_hash,
-        manifest_triggered: false,
+        manifest_triggered: manifest_triggered,
       )
 
       if VCAP::CloudController::Config.kubernetes_api_configured?
@@ -34,7 +35,7 @@ def create(message:, space:, domain:)
 
       route
     rescue Sequel::ValidationFailed => e
-      validation_error!(e, route.host, route.path, space, domain)
+      validation_error!(e, route.host, route.path, route.port, space, domain)
     end
 
     private
@@ -43,7 +44,7 @@ def route_crd_client
       @route_crd_client ||= CloudController::DependencyLocator.instance.route_crd_client
     end
 
-    def validation_error!(error, host, path, space, domain)
+    def validation_error!(error, host, path, port, space, domain)
       if error.errors.on(:domain)&.include?(:invalid_relation)
         error!("Invalid domain. Domain '#{domain.name}' is not available in organization '#{space.organization.name}'.")
       end
@@ -52,12 +53,21 @@ def validation_error!(error, host, path, space, domain)
         error!("Routes quota exceeded for space '#{space.name}'.")
       end
 
+      if error.errors.on(:space)&.include?(:total_reserved_route_ports_exceeded)
+        error!("Reserved route ports quota exceeded for space '#{space.name}'.")
+      end
+
       if error.errors.on(:organization)&.include?(:total_routes_exceeded)
         error!("Routes quota exceeded for organization '#{space.organization.name}'.")
       end
 
+      if error.errors.on(:organization)&.include?(:total_reserved_route_ports_exceeded)
+        error!("Reserved route ports quota exceeded for organization '#{space.organization.name}'.")
+      end
+
       validation_error_host!(error, host, domain)
       validation_error_path!(error, host, path, domain)
+      validation_error_port!(error, host, port, domain)
 
       error!(error.message)
     end
@@ -71,6 +81,10 @@ def validation_error_host!(error, host, domain)
         error!('Route conflicts with a reserved system route.')
       end
 
+      if error.errors.on(:host)&.include?(:format)
+        error!('Host format is invalid.')
+      end
+
       if error.errors.on(:host)&.include?(:wildcard_host_not_supported_for_internal_domain)
         error!('Wildcard hosts are not supported for internal domains.')
       end
@@ -90,6 +104,10 @@ def validation_error_host!(error, host, domain)
           error!("Route already exists with host '#{host}' for domain '#{domain.name}'.")
         end
       end
+
+      if error.errors.on(:host)&.include?(:host_and_path_domain_tcp)
+        error!("Routes with protocol 'tcp' do not support paths or hosts.")
+      end
     end
 
     def validation_error_path!(error, host, path, domain)
@@ -125,6 +143,28 @@ def validation_error_path!(error, host, path, domain)
       end
     end
 
+    def validation_error_port!(error, host, port, domain)
+      if error.errors.on(:port)&.include?(:port_required)
+        error!("Routes with protocol 'tcp' must specify a port.")
+      end
+
+      if error.errors.on(:port)&.include?(:port_unavailable)
+        error!("Port '#{port}' is not available. Try a different port or use a different domain.")
+      end
+
+      if error.errors.on([:host, :domain_id, :port])&.include?(:unique)
+        error!("Route already exists with port '#{port}' for domain '#{domain.name}'.")
+      end
+
+      if error.errors.on(:port)&.include?(:port_taken)
+        error!("Port '#{port}' is not available. Try a different port or use a different domain.")
+      end
+
+      if error.errors.on(:port)&.include?(:port_unsupported)
+        error!("Routes with protocol 'http' do not support ports.")
+      end
+    end
+
     def error!(message)
       raise Error.new(message)
     end

app/actions/v3/route_create.rb

@@ -8,6 +8,7 @@ class RouteCreateMessage < MetadataBaseMessage
     register_allowed_keys [
       :host,
       :path,
+      :port,
       :relationships
     ]
 
@@ -47,6 +48,10 @@ class RouteCreateMessage < MetadataBaseMessage
         message: 'cannot be exactly /',
       }
 
+    validates :port,
+      allow_nil: true,
+      numericality: { only_integer: true, greater_than_or_equal_to: 0, less_than_or_equal_to: 65535 }
+
     validates :relationships, presence: true
 
     validates_with NoAdditionalKeysValidator

app/messages/route_create_message.rb

@@ -144,17 +144,15 @@ def in_suspended_org?
     end
 
     def protocols
-      return ['http'] if self.private?
-
-      # If Kubernetes is enabled that implies that we are using istio, not the routing API
-      k8s_enabled = Config.config.get(:kubernetes, :host_url).present?
-      return ['tcp'] if !k8s_enabled && self.router_group_guid
-
       ['http']
     end
 
     private
 
+    def k8s_enabled?
+      Config.config.get(:kubernetes, :host_url).present?
+    end
+
     def validate_change_owning_organization(organization)
       return if self.new? || owning_organization == organization
 

app/models/runtime/domain.rb

@@ -60,7 +60,16 @@ def shared?
       true
     end
 
+    def protocols
+      return ['tcp'] if self.tcp?
+
+      ['http']
+    end
+
     def tcp?
+      # If Kubernetes is enabled that implies that we are using istio, not the routing API
+      return false if k8s_enabled?
+
       if router_group_guid.present?
         if @router_group_type.nil?
           router_group = routing_api_client.router_group(router_group_guid)

app/models/runtime/shared_domain.rb

@@ -31,6 +31,7 @@ def to_hash
         updated_at: route.updated_at,
         host: route.host,
         path: route.path,
+        port: route.port,
         url: build_url,
         destinations: route.route_mappings.map { |rm| RouteDestinationPresenter.new(rm).to_hash },
         metadata: {
@@ -80,6 +81,10 @@ def build_links
     end
 
     def build_url
+      if route.port && route.port > 0
+        return "#{route.domain.name}:#{route.port}"
+      end
+
       if route.host.empty?
         return "#{route.domain.name}#{route.path}"
       end