Skip to content

[v8] Add examples for hash-based routing #3746

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
b1tamara wants to merge 2 commits into
base: v8
Choose a base branch
from
Open

[v8] Add examples for hash-based routing #3746

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bda4351
Add examples for hash-based routing
b1tamara Mar 25, 2026
09f2c74
Implement tests
b1tamara Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions command/v7/map_route_command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ package v7

import (
"code.cloudfoundry.org/cli/v8/actor/actionerror"
"code.cloudfoundry.org/cli/v8/api/cloudcontroller/ccversion"
"code.cloudfoundry.org/cli/v8/command"
"code.cloudfoundry.org/cli/v8/api/cloudcontroller/ccversion"
"code.cloudfoundry.org/cli/v8/command"
"code.cloudfoundry.org/cli/v8/command/flag"
"code.cloudfoundry.org/cli/v8/resources"
)
Expand Down Expand Up @@ -34,10 +34,11 @@ func (cmd MapRouteCommand) Examples() string {
return `
CF_NAME map-route my-app example.com # example.com
CF_NAME map-route my-app example.com --hostname myhost # myhost.example.com
CF_NAME map-route my-app example.com --hostname myhost -o loadbalancing=least-connection # myhost.example.com with a per-route option
CF_NAME map-route my-app example.com --hostname myhost --path foo # myhost.example.com/foo
CF_NAME map-route my-app example.com --hostname myhost --app-protocol http2 # myhost.example.com
CF_NAME map-route my-app example.com --hostname myhost --app-port 8090 # myhost.example.com
CF_NAME map-route my-app example.com --hostname myhost -o loadbalancing=least-connection # myhost.example.com with a per-route option
CF_NAME map-route my-app example.com -o loadbalancing=hash -o hash_header=My-Hash-Header # use hash-based routing for example.com
CF_NAME map-route my-app example.com --port 5000 # example.com:5000`
}

Expand Down
11 changes: 7 additions & 4 deletions command/v7/update_route_command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,13 @@ Update an existing HTTP route:

func (cmd UpdateRouteCommand) Examples() string {
return `
CF_NAME update-route example.com -o loadbalancing=round-robin,
CF_NAME update-route example.com -o loadbalancing=least-connection,
CF_NAME update-route example.com -r loadbalancing,
CF_NAME update-route example.com --hostname myhost --path foo -o loadbalancing=round-robin`
CF_NAME update-route example.com -o loadbalancing=round-robin # use round-robin load balancing for route
CF_NAME update-route example.com -o loadbalancing=least-connection # use least-connection load balancing for route
CF_NAME update-route example.com -o loadbalancing=hash -o hash_header=My-Hash-Header # use hash-based load balancing for route
CF_NAME update-route example.com -o loadbalancing=hash -o hash_header=My-Hash-Header -o hash_balance=1.3 # use hash-based load balancing with balance factor
CF_NAME update-route example.com -r loadbalancing # remove load balancing option
CF_NAME update-route example.com --hostname myhost --path foo -o loadbalancing=round-robin # update route myhost.example.com/foo
`
}
func (cmd UpdateRouteCommand) Execute(args []string) error {
err := cmd.SharedActor.CheckTarget(true, true)
Expand Down
18 changes: 17 additions & 1 deletion integration/v7/isolated/map_route_command_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,11 @@ var _ = Describe("map-route command", func() {
Eventually(session).Should(Say(`EXAMPLES:`))
Eventually(session).Should(Say(`cf map-route my-app example.com # example.com`))
Eventually(session).Should(Say(`cf map-route my-app example.com --hostname myhost # myhost.example.com`))
Eventually(session).Should(Say(`cf map-route my-app example.com --hostname myhost -o loadbalancing=least-connection # myhost.example.com with a per-route option`))
Eventually(session).Should(Say(`cf map-route my-app example.com --hostname myhost --path foo # myhost.example.com/foo`))
Eventually(session).Should(Say(`cf map-route my-app example.com --hostname myhost --app-protocol http2 # myhost.example.com`))
Eventually(session).Should(Say(`cf map-route my-app example.com --hostname myhost --app-port 8090 # myhost.example.com`))
Eventually(session).Should(Say(`cf map-route my-app example.com --hostname myhost -o loadbalancing=least-connection # myhost.example.com with a per-route option`))
Eventually(session).Should(Say(`cf map-route my-app example.com -o loadbalancing=hash -o hash_header=My-Hash-Header # use hash-based routing for example.com`))
Eventually(session).Should(Say(`cf map-route my-app example.com --port 5000 # example.com:5000`))
Eventually(session).Should(Say(`\n`))

Expand Down Expand Up @@ -241,6 +242,21 @@ var _ = Describe("map-route command", func() {
Eventually(session).Should(Exit(0))
})
})
Context("when per-route options are provided", func() {
It("creates the route and maps it to an app", func() {
optionLBAlgo := "loadbalancing=hash"
optionHashHeader := "hash_header=X-Header"
optionHashBalance := "hash_balance=1.3"

session := helpers.CF("map-route", appName, domainName, "--hostname", hostName, "--path", path, "--option", optionLBAlgo, "--option", optionHashHeader, "--option", optionHashBalance)
Eventually(session).Should(Say(`Creating route %s.%s%s for org %s / space %s as %s\.\.\.`, hostName, domainName, path, orgName, spaceName, userName))
Eventually(session).Should(Say(`OK`))
Eventually(session).Should(Say(`Mapping route %s.%s%s to app %s in org %s / space %s as %s\.\.\.`, hostName, domainName, path, appName, orgName, spaceName, userName))
Eventually(session).Should(Say(`OK`))
Eventually(session).Should(Exit(0))
})
})

})

When("it is an TCP domain", func() {
Expand Down
36 changes: 35 additions & 1 deletion integration/v7/isolated/update_route_command_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ var _ = Describe("update-route command", func() {
Eventually(session).Should(Say(`EXAMPLES:`))
Eventually(session).Should(Say(`cf update-route example.com -o loadbalancing=round-robin`))
Eventually(session).Should(Say(`cf update-route example.com -o loadbalancing=least-connection`))
Eventually(session).Should(Say(`cf update-route example.com -o loadbalancing=hash -o hash_header=My-Hash-Header`))
Eventually(session).Should(Say(`cf update-route example.com -o loadbalancing=hash -o hash_header=My-Hash-Header -o hash_balance=1.3`))
Eventually(session).Should(Say(`cf update-route example.com -r loadbalancing`))
Eventually(session).Should(Say(`cf update-route example.com --hostname myhost --path foo -o loadbalancing=round-robin`))
Eventually(session).Should(Say(`\n`))
Expand Down Expand Up @@ -102,7 +104,7 @@ var _ = Describe("update-route command", func() {
AfterEach(func() {
domain.Delete()
})
When("a route option is specified", func() {
When("a loadbalancing route option is specified", func() {
It("updates the route and runs to completion without failing", func() {
option = "loadbalancing=round-robin"
session := helpers.CF("update-route", domainName, "--hostname", hostname, "--path", path, "--option", option)
Expand All @@ -113,6 +115,38 @@ var _ = Describe("update-route command", func() {
})
})

When("a hash-based routing options are specified", func() {
It("updates the route and runs to completion without failing", func() {
optionLBAlgo := "loadbalancing=hash"
optionHashHeader := "hash_header=X-Header"
optionHashBalance := "hash_balance=1.3"
session := helpers.CF("update-route", domainName, "--hostname", hostname, "--path", path, "--option", optionLBAlgo, "--option", optionHashHeader, "--option", optionHashBalance)
Eventually(session).Should(Say(`Updating route %s\.%s%s for org %s / space %s as %s\.\.\.`, hostname, domainName, path, orgName, spaceName, userName))
Eventually(session).Should(Say(`Route %s\.%s%s has been updated`, hostname, domainName, path))
Eventually(session).Should(Say(`OK`))
Eventually(session).Should(Exit(0))
})
Context("missing required options for hash-based routing", func() {
It("update fails", func() {
optionLBAlgo := "loadbalancing=hash"
session := helpers.CF("update-route", domainName, "--hostname", hostname, "--path", path, "--option", optionLBAlgo)
Eventually(session.Err).Should(Say(`Hash header must be present when loadbalancing is set to hash`))
Eventually(session).Should(Exit(1))
})
})
Context("with wrong loadbalancing option", func() {
It("update fails", func() {
optionLBAlgo := "loadbalancing=round-robin"
optionHashHeader := "hash_header=X-Header"
optionHashBalance := "hash_balance=1.3"
session := helpers.CF("update-route", domainName, "--hostname", hostname, "--path", path, "--option", optionLBAlgo, "--option", optionHashHeader, "--option", optionHashBalance)
Eventually(session.Err).Should(Say(`Options Hash header can only be set when loadbalancing is hash`))
Eventually(session.Err).Should(Say(`Options Hash balance can only be set when loadbalancing is hash`))
Eventually(session).Should(Exit(1))
})
})
})

When("route options are not specified", func() {
It("gives an error message and fails", func() {
session := helpers.CF("update-route", domainName, "--hostname", hostname, "--path", path)
Expand Down
Loading