Allow setting the route destination port via the CF CLI map-route command using a new app-port parameter (#3733)

Co-authored-by: Maurice Brinkmann <Maurice.Brinkmann@mail.schwarz>

Author: sethboyles

.gitignore

@@ -70,3 +70,4 @@ integration/assets/test_plugin/test_plugin
 .vscode
 .secrets
 .vars
+.patch

actor/v7action/cloud_controller_client.go

@@ -143,7 +143,7 @@ type CloudControllerClient interface {
 	GetUser(userGUID string) (resources.User, ccv3.Warnings, error)
 	GetUsers(query ...ccv3.Query) ([]resources.User, ccv3.Warnings, error)
 	MakeRequestSendReceiveRaw(Method string, URL string, headers http.Header, requestBody []byte) ([]byte, *http.Response, error)
-	MapRoute(routeGUID string, appGUID string, destinationProtocol string) (ccv3.Warnings, error)
+	MapRoute(routeGUID string, appGUID string, destinationProtocol string, destinationPort int) (ccv3.Warnings, error)
 	MoveRoute(routeGUID string, spaceGUID string) (ccv3.Warnings, error)
 	PollJob(jobURL ccv3.JobURL) (ccv3.Warnings, error)
 	PollJobForState(jobURL ccv3.JobURL, state constant.JobState) (ccv3.Warnings, error)

actor/v7action/route.go

@@ -21,6 +21,7 @@ type RouteSummary struct {
 	resources.Route
 	AppNames            []string
 	AppProtocols        []string
+	AppPorts            []string
 	DomainName          string
 	SpaceName           string
 	ServiceInstanceName string
@@ -279,9 +280,13 @@ func (actor Actor) GetRouteSummaries(routes []resources.Route) ([]RouteSummary,
 		var appNames []string
 
 		protocolSet := map[string]bool{}
+		portSet := map[int]bool{}
 		for _, destination := range route.Destinations {
 			appNames = append(appNames, appNamesByGUID[destination.App.GUID])
 			protocolSet[destination.Protocol] = true
+			if destination.Port > 0 {
+				portSet[destination.Port] = true
+			}
 		}
 
 		var appProtocols []string
@@ -293,10 +298,20 @@ func (actor Actor) GetRouteSummaries(routes []resources.Route) ([]RouteSummary,
 			sort.Strings(appProtocols)
 		}
 
+		var appPorts []string
+		if len(portSet) > 0 {
+			appPorts = make([]string, 0, len(portSet))
+			for key := range portSet {
+				appPorts = append(appPorts, strconv.Itoa(key))
+			}
+			sort.Strings(appPorts)
+		}
+
 		routeSummaries = append(routeSummaries, RouteSummary{
 			Route:               route,
 			AppNames:            appNames,
 			AppProtocols:        appProtocols,
+			AppPorts:            appPorts,
 			SpaceName:           spaceNamesByGUID[route.SpaceGUID],
 			DomainName:          getDomainName(route.URL, route.Host, route.Path, route.Port),
 			ServiceInstanceName: serviceInstanceNameByRouteGUID[route.GUID],
@@ -397,8 +412,8 @@ func (actor Actor) GetRouteByAttributes(domain resources.Domain, hostname string
 	return routes[0], Warnings(ccWarnings), nil
 }
 
-func (actor Actor) MapRoute(routeGUID string, appGUID string, destinationProtocol string) (Warnings, error) {
-	warnings, err := actor.CloudControllerClient.MapRoute(routeGUID, appGUID, destinationProtocol)
+func (actor Actor) MapRoute(routeGUID string, appGUID string, destinationProtocol string, destinationPort int) (Warnings, error) {
+	warnings, err := actor.CloudControllerClient.MapRoute(routeGUID, appGUID, destinationProtocol, destinationPort)
 	return Warnings(warnings), err
 }
 

actor/v7action/route_test.go

@@ -1581,19 +1581,21 @@ var _ = Describe("Route Actions", func() {
 			routeGUID           string
 			appGUID             string
 			destinationProtocol string
+			destinationPort     int
 
 			executeErr error
 			warnings   Warnings
 		)
 
 		JustBeforeEach(func() {
-			warnings, executeErr = actor.MapRoute(routeGUID, appGUID, destinationProtocol)
+			warnings, executeErr = actor.MapRoute(routeGUID, appGUID, destinationProtocol, destinationPort)
 		})
 
 		BeforeEach(func() {
 			routeGUID = "route-guid"
 			appGUID = "app-guid"
 			destinationProtocol = "http2"
+			destinationPort = 8080
 		})
 
 		When("the cloud controller client errors", func() {
@@ -1613,10 +1615,11 @@ var _ = Describe("Route Actions", func() {
 			})
 
 			It("calls the cloud controller client with the right arguments", func() {
-				actualRouteGUID, actualAppGUID, actualDestinationProtocol := fakeCloudControllerClient.MapRouteArgsForCall(0)
+				actualRouteGUID, actualAppGUID, actualDestinationProtocol, actualDestinationPort := fakeCloudControllerClient.MapRouteArgsForCall(0)
 				Expect(actualRouteGUID).To(Equal("route-guid"))
 				Expect(actualAppGUID).To(Equal("app-guid"))
 				Expect(actualDestinationProtocol).To(Equal("http2"))
+				Expect(actualDestinationPort).To(Equal(8080))
 			})
 
 			It("returns the error and warnings", func() {

actor/v7action/v7actionfakes/fake_cloud_controller_client.go

@@ -25,7 +25,7 @@ type V7Actor interface {
 	GetDomain(domainGUID string) (resources.Domain, v7action.Warnings, error)
 	GetRouteByAttributes(domain resources.Domain, hostname, path string, port int) (resources.Route, v7action.Warnings, error)
 	GetRouteDestinationByAppGUID(route resources.Route, appGUID string) (resources.RouteDestination, error)
-	MapRoute(routeGUID string, appGUID string, destinationProtocol string) (v7action.Warnings, error)
+	MapRoute(routeGUID string, appGUID string, destinationProtocol string, destinationPort int) (v7action.Warnings, error)
 	PollBuild(buildGUID string, appName string) (resources.Droplet, v7action.Warnings, error)
 	PollPackage(pkg resources.Package) (resources.Package, v7action.Warnings, error)
 	PollStart(app resources.Application, noWait bool, handleProcessStats func(string)) (v7action.Warnings, error)

actor/v7pushaction/v7_actor.go

@@ -100,7 +100,7 @@ func (client Client) UpdateRoute(routeGUID string, options map[string]*string) (
 
 }
 
-func (client Client) MapRoute(routeGUID string, appGUID string, destinationProtocol string) (Warnings, error) {
+func (client Client) MapRoute(routeGUID string, appGUID string, destinationProtocol string, destinationPort int) (Warnings, error) {
 	type destinationProcess struct {
 		ProcessType string `json:"process_type"`
 	}
@@ -112,6 +112,7 @@ func (client Client) MapRoute(routeGUID string, appGUID string, destinationProto
 	type destination struct {
 		App      destinationApp `json:"app"`
 		Protocol string         `json:"protocol,omitempty"`
+		Port     int            `json:"port,omitempty"`
 	}
 
 	type body struct {
@@ -128,6 +129,9 @@ func (client Client) MapRoute(routeGUID string, appGUID string, destinationProto
 	if destinationProtocol != "" {
 		requestBody.Destinations[0].Protocol = destinationProtocol
 	}
+	if destinationPort != 0 {
+		requestBody.Destinations[0].Port = destinationPort
+	}
 
 	_, warnings, err := client.MakeRequest(RequestParams{
 		RequestName: internal.MapRouteRequest,

actor/v7pushaction/v7pushactionfakes/fake_v7actor.go

@@ -577,6 +577,7 @@ var _ = Describe("Route", func() {
 			routeGUID           = "route-guid"
 			appGUID             = "app-guid"
 			destinationProtocol string
+			destinationPort     int
 			expectedBody        string
 			warnings            Warnings
 			executeErr          error
@@ -591,24 +592,26 @@ var _ = Describe("Route", func() {
 					RespondWith(http.StatusOK, response, http.Header{"X-Cf-Warnings": {"warning-1"}}),
 				),
 			)
-			warnings, executeErr = client.MapRoute(routeGUID, appGUID, destinationProtocol)
+			warnings, executeErr = client.MapRoute(routeGUID, appGUID, destinationProtocol, destinationPort)
 		})
 
 		When("the request is successful", func() {
 			BeforeEach(func() {
 				destinationProtocol = "http2"
+				destinationPort = 8080
 				expectedBody = fmt.Sprintf(`
-					{
-						"destinations": [
-						 {
-							"app": {
-								"guid": "%s"
-							},
-							"protocol": "%s"
-						 }
-						]
-					}
-				`, appGUID, destinationProtocol)
+                                        {
+                                                "destinations": [
+                                                 {
+                                                        "app": {
+                                                                "guid": "%s"
+                                                        },
+                                                        "protocol": "%s",
+                                                        "port": %d
+                                                 }
+                                                ]
+                                        }
+                                `, appGUID, destinationProtocol, destinationPort)
 			})
 
 			It("returns the warnings and no error", func() {
@@ -620,24 +623,48 @@ var _ = Describe("Route", func() {
 		Context("when destination protocol is not provided", func() {
 			BeforeEach(func() {
 				destinationProtocol = ""
+				destinationPort = 0
 				expectedBody = fmt.Sprintf(`
-					{
-						"destinations": [
-						 {
-							"app": {
-								"guid": "%s"
-							}
-						 }
-						]
-					}
-				`, appGUID)
+                                        {
+                                                "destinations": [
+                                                 {
+                                                        "app": {
+                                                                "guid": "%s"
+                                                        }
+                                                 }
+                                                ]
+                                        }
+                                `, appGUID)
 			})
 
 			It("does not include it in the request", func() {
 				Expect(executeErr).ToNot(HaveOccurred())
 			})
 		})
 
+		Context("when destination port is provided without protocol", func() {
+			BeforeEach(func() {
+				destinationProtocol = ""
+				destinationPort = 9090
+				expectedBody = fmt.Sprintf(`
+                                        {
+                                                "destinations": [
+                                                 {
+                                                        "app": {
+                                                                "guid": "%s"
+                                                        },
+                                                        "port": %d
+                                                 }
+                                                ]
+                                        }
+                                `, appGUID, destinationPort)
+			})
+
+			It("includes the port in the request", func() {
+				Expect(executeErr).ToNot(HaveOccurred())
+			})
+		})
+
 		When("the cloud controller returns errors and warnings", func() {
 			BeforeEach(func() {
 				response := `{

api/cloudcontroller/ccv3/route.go

@@ -187,7 +187,7 @@ type Actor interface {
 	GetUser(username, origin string) (resources.User, error)
 	ListServiceAppBindings(params v7action.ListServiceAppBindingParams) ([]resources.ServiceCredentialBinding, v7action.Warnings, error)
 	MakeCurlRequest(httpMethod string, path string, customHeaders []string, httpData string, failOnHTTPError bool) ([]byte, *http.Response, error)
-	MapRoute(routeGUID string, appGUID string, destinationProtocol string) (v7action.Warnings, error)
+	MapRoute(routeGUID string, appGUID string, destinationProtocol string, destinationPort int) (v7action.Warnings, error)
 	Marketplace(filter v7action.MarketplaceFilter) ([]v7action.ServiceOfferingWithPlans, v7action.Warnings, error)
 	MoveRoute(routeGUID string, spaceGUID string) (v7action.Warnings, error)
 	ParseAccessToken(accessToken string) (jwt.JWT, error)