-
Notifications
You must be signed in to change notification settings - Fork 0
/
route.go
378 lines (322 loc) · 12 KB
/
route.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
package v2action
import (
"fmt"
"path"
"strings"
"code.cloudfoundry.org/cli/actor/actionerror"
"code.cloudfoundry.org/cli/api/cloudcontroller/ccerror"
"code.cloudfoundry.org/cli/api/cloudcontroller/ccv2"
"code.cloudfoundry.org/cli/api/cloudcontroller/ccv2/constant"
"code.cloudfoundry.org/cli/types"
log "github.com/sirupsen/logrus"
)
type Routes []Route
// Summary converts routes into a comma separated string.
func (rs Routes) Summary() string {
formattedRoutes := []string{}
for _, route := range rs {
formattedRoutes = append(formattedRoutes, route.String())
}
return strings.Join(formattedRoutes, ", ")
}
// Route represents a CLI Route.
type Route struct {
Domain Domain
GUID string
Host string
Path string
Port types.NullInt
SpaceGUID string
}
func (r Route) RandomTCPPort() bool {
return r.Domain.IsTCP() && !r.Port.IsSet
}
// Validate will return an error if there are invalid HTTP or TCP settings for
// it's given domain.
func (r Route) Validate() error {
if r.Domain.IsHTTP() {
if r.Port.IsSet {
return actionerror.InvalidHTTPRouteSettings{Domain: r.Domain.Name}
}
if r.Domain.IsShared() && r.Host == "" {
return actionerror.NoHostnameAndSharedDomainError{}
}
} else { // Is TCP Domain
if r.Host != "" || r.Path != "" {
return actionerror.InvalidTCPRouteSettings{Domain: r.Domain.Name}
}
}
return nil
}
// ValidateWithRandomPort will return an error if a random port is requested
// for an HTTP route, or if the route is TCP, a random port wasn't requested,
// and the route has no port set.
func (r Route) ValidateWithRandomPort(randomPort bool) error {
if r.Domain.IsHTTP() && randomPort {
return actionerror.InvalidHTTPRouteSettings{Domain: r.Domain.Name}
}
if r.Domain.IsTCP() && !r.Port.IsSet && !randomPort {
return actionerror.TCPRouteOptionsNotProvidedError{}
}
return r.Validate()
}
// String formats the route in a human readable format.
func (r Route) String() string {
routeString := r.Domain.Name
if r.Port.IsSet {
routeString = fmt.Sprintf("%s:%d", routeString, r.Port.Value)
} else if r.RandomTCPPort() {
routeString = fmt.Sprintf("%s:????", routeString)
}
if r.Host != "" {
routeString = fmt.Sprintf("%s.%s", r.Host, routeString)
}
if r.Path != "" {
routeString = path.Join(routeString, r.Path)
}
return routeString
}
func (actor Actor) MapRouteToApplication(routeGUID string, appGUID string) (Warnings, error) {
_, warnings, err := actor.CloudControllerClient.UpdateRouteApplication(routeGUID, appGUID)
if _, ok := err.(ccerror.InvalidRelationError); ok {
return Warnings(warnings), actionerror.RouteInDifferentSpaceError{}
}
return Warnings(warnings), err
}
func (actor Actor) UnmapRouteFromApplication(routeGUID string, appGUID string) (Warnings, error) {
warnings, err := actor.CloudControllerClient.DeleteRouteApplication(routeGUID, appGUID)
return Warnings(warnings), err
}
func (actor Actor) CreateRoute(route Route, generatePort bool) (Route, Warnings, error) {
if route.Path != "" && !strings.HasPrefix(route.Path, "/") {
route.Path = fmt.Sprintf("/%s", route.Path)
}
returnedRoute, warnings, err := actor.CloudControllerClient.CreateRoute(ActorToCCRoute(route), generatePort)
return CCToActorRoute(returnedRoute, route.Domain), Warnings(warnings), err
}
func (actor Actor) CreateRouteWithExistenceCheck(orgGUID string, spaceName string, route Route, generatePort bool) (Route, Warnings, error) {
space, warnings, spaceErr := actor.GetSpaceByOrganizationAndName(orgGUID, spaceName)
if spaceErr != nil {
return Route{}, Warnings(warnings), spaceErr
}
route.SpaceGUID = space.GUID
if route.Domain.GUID == "" {
domains, orgDomainWarnings, getDomainErr := actor.GetDomainsByNameAndOrganization([]string{route.Domain.Name}, orgGUID)
warnings = append(warnings, orgDomainWarnings...)
if getDomainErr != nil {
return Route{}, warnings, getDomainErr
} else if len(domains) == 0 {
return Route{}, warnings, actionerror.DomainNotFoundError{Name: route.Domain.Name}
}
route.Domain.GUID = domains[0].GUID
route.Domain.RouterGroupType = domains[0].RouterGroupType
}
validateErr := route.ValidateWithRandomPort(generatePort)
if validateErr != nil {
return Route{}, Warnings(warnings), validateErr
}
if !generatePort {
foundRoute, spaceRouteWarnings, findErr := actor.FindRouteBoundToSpaceWithSettings(route)
warnings = append(warnings, spaceRouteWarnings...)
routeAlreadyExists := true
if _, ok := findErr.(actionerror.RouteNotFoundError); ok {
routeAlreadyExists = false
} else if findErr != nil {
return Route{}, Warnings(warnings), findErr
}
if routeAlreadyExists {
return Route{}, Warnings(warnings), actionerror.RouteAlreadyExistsError{Route: foundRoute.String()}
}
}
createdRoute, createRouteWarnings, createErr := actor.CreateRoute(route, generatePort)
warnings = append(warnings, createRouteWarnings...)
if createErr != nil {
return Route{}, Warnings(warnings), createErr
}
return createdRoute, Warnings(warnings), nil
}
// GetOrphanedRoutesBySpace returns a list of orphaned routes associated with
// the provided Space GUID.
func (actor Actor) GetOrphanedRoutesBySpace(spaceGUID string) ([]Route, Warnings, error) {
var (
orphanedRoutes []Route
allWarnings Warnings
)
routes, warnings, err := actor.GetSpaceRoutes(spaceGUID)
allWarnings = append(allWarnings, warnings...)
if err != nil {
return nil, allWarnings, err
}
for _, route := range routes {
apps, warnings, err := actor.GetRouteApplications(route.GUID)
allWarnings = append(allWarnings, warnings...)
if err != nil {
return nil, allWarnings, err
}
if len(apps) == 0 {
orphanedRoutes = append(orphanedRoutes, route)
}
}
if len(orphanedRoutes) == 0 {
return nil, allWarnings, actionerror.OrphanedRoutesNotFoundError{}
}
return orphanedRoutes, allWarnings, nil
}
// GetApplicationRoutes returns a list of routes associated with the provided
// Application GUID.
func (actor Actor) GetApplicationRoutes(applicationGUID string) (Routes, Warnings, error) {
var allWarnings Warnings
ccv2Routes, warnings, err := actor.CloudControllerClient.GetApplicationRoutes(applicationGUID)
allWarnings = append(allWarnings, warnings...)
if err != nil {
return nil, allWarnings, err
}
routes, domainWarnings, err := actor.applyDomain(ccv2Routes)
return routes, append(allWarnings, domainWarnings...), err
}
// GetSpaceRoutes returns a list of routes associated with the provided Space
// GUID.
func (actor Actor) GetSpaceRoutes(spaceGUID string) ([]Route, Warnings, error) {
var allWarnings Warnings
ccv2Routes, warnings, err := actor.CloudControllerClient.GetSpaceRoutes(spaceGUID)
allWarnings = append(allWarnings, warnings...)
if err != nil {
return nil, allWarnings, err
}
routes, domainWarnings, err := actor.applyDomain(ccv2Routes)
return routes, append(allWarnings, domainWarnings...), err
}
// DeleteUnmappedRoutes deletes the unmapped routes associated with the provided Space GUID.
func (actor Actor) DeleteUnmappedRoutes(spaceGUID string) (Warnings, error) {
warnings, err := actor.CloudControllerClient.DeleteSpaceUnmappedRoutes(spaceGUID)
return Warnings(warnings), err
}
// DeleteRoute deletes the Route associated with the provided Route GUID.
func (actor Actor) DeleteRoute(routeGUID string) (Warnings, error) {
warnings, err := actor.CloudControllerClient.DeleteRoute(routeGUID)
return Warnings(warnings), err
}
func (actor Actor) CheckRoute(route Route) (bool, Warnings, error) {
exists, warnings, err := actor.CloudControllerClient.CheckRoute(ActorToCCRoute(route))
return exists, Warnings(warnings), err
}
// FindRouteBoundToSpaceWithSettings finds the route with the given host,
// domain and space. If it is unable to find the route, it will check if it
// exists anywhere in the system. When the route exists in another space,
// RouteInDifferentSpaceError is returned. Use this when you know the space
// GUID.
func (actor Actor) FindRouteBoundToSpaceWithSettings(route Route) (Route, Warnings, error) {
existingRoute, warnings, err := actor.GetRouteByComponents(route)
if routeNotFoundErr, ok := err.(actionerror.RouteNotFoundError); ok {
// This check only works for API versions 2.55 or higher. It will return
// false for anything below that.
log.Infof("checking route existence for: %s\n", route)
exists, checkRouteWarnings, chkErr := actor.CheckRoute(route)
if chkErr != nil {
log.Errorln("check route:", err)
return Route{}, append(Warnings(warnings), checkRouteWarnings...), chkErr
}
// This will happen if the route exists in a space to which the user does
// not have access.
if exists {
log.Errorf("unable to find route %s in current space", route.String())
return Route{}, append(Warnings(warnings), checkRouteWarnings...), actionerror.RouteInDifferentSpaceError{Route: route.String()}
}
log.Warnf("negative existence check for route %s - returning partial route", route.String())
log.Debugf("partialRoute: %#v", route)
return Route{}, append(Warnings(warnings), checkRouteWarnings...), routeNotFoundErr
} else if err != nil {
log.Errorln("finding route:", err)
return Route{}, Warnings(warnings), err
}
if existingRoute.SpaceGUID != route.SpaceGUID {
log.WithFields(log.Fields{
"targeted_space_guid": route.SpaceGUID,
"existing_space_guid": existingRoute.SpaceGUID,
}).Errorf("route exists in different space the user has access to")
return Route{}, Warnings(warnings), actionerror.RouteInDifferentSpaceError{Route: route.String()}
}
log.Debugf("found route: %#v", existingRoute)
return existingRoute, Warnings(warnings), err
}
// GetRouteByComponents returns the route with the matching host, domain, path,
// and port. Use this when you don't know the space GUID.
// TCP routes require a port to be uniquely identified
// HTTP routes using shared domains require a hostname or path to be uniquely identified
func (actor Actor) GetRouteByComponents(route Route) (Route, Warnings, error) {
// TODO: validation should probably be done separately (?)
if route.Domain.IsTCP() && !route.Port.IsSet {
return Route{}, nil, actionerror.PortNotProvidedForQueryError{}
}
if route.Domain.IsShared() && route.Domain.IsHTTP() && route.Host == "" {
return Route{}, nil, actionerror.NoHostnameAndSharedDomainError{}
}
queries := []ccv2.Filter{
{
Type: constant.DomainGUIDFilter,
Operator: constant.EqualOperator,
Values: []string{route.Domain.GUID},
}, {
Type: constant.HostFilter,
Operator: constant.EqualOperator,
Values: []string{route.Host},
}, {
Type: constant.PathFilter,
Operator: constant.EqualOperator,
Values: []string{route.Path},
},
}
if route.Port.IsSet {
queries = append(queries, ccv2.Filter{
Type: constant.PortFilter,
Operator: constant.EqualOperator,
Values: []string{fmt.Sprint(route.Port.Value)},
})
}
ccv2Routes, warnings, err := actor.CloudControllerClient.GetRoutes(queries...)
if err != nil {
return Route{}, Warnings(warnings), err
}
if len(ccv2Routes) == 0 {
return Route{}, Warnings(warnings), actionerror.RouteNotFoundError{
Host: route.Host,
DomainGUID: route.Domain.GUID,
Path: route.Path,
Port: route.Port.Value,
}
}
return CCToActorRoute(ccv2Routes[0], route.Domain), Warnings(warnings), err
}
func ActorToCCRoute(route Route) ccv2.Route {
return ccv2.Route{
DomainGUID: route.Domain.GUID,
GUID: route.GUID,
Host: route.Host,
Path: route.Path,
Port: route.Port,
SpaceGUID: route.SpaceGUID,
}
}
func CCToActorRoute(ccv2Route ccv2.Route, domain Domain) Route {
return Route{
Domain: domain,
GUID: ccv2Route.GUID,
Host: ccv2Route.Host,
Path: ccv2Route.Path,
Port: ccv2Route.Port,
SpaceGUID: ccv2Route.SpaceGUID,
}
}
func (actor Actor) applyDomain(ccv2Routes []ccv2.Route) (Routes, Warnings, error) {
var routes Routes
var allWarnings Warnings
for _, ccv2Route := range ccv2Routes {
domain, warnings, err := actor.GetDomain(ccv2Route.DomainGUID)
allWarnings = append(allWarnings, warnings...)
if err != nil {
return nil, allWarnings, err
}
routes = append(routes, CCToActorRoute(ccv2Route, domain))
}
return routes, allWarnings, nil
}