Skip to content

Commit c5ab0f0

Browse files
antechrestosantechrestos
committed
feature(routes) add route manager v3
See #280
1 parent e1f1805 commit c5ab0f0

7 files changed

Lines changed: 515 additions & 2 deletions

File tree

‎cloudfoundry_client/client.py‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
from cloudfoundry_client.v2.events import EventManager
1919
from cloudfoundry_client.v2.jobs import JobManager as JobManagerV2
2020
from cloudfoundry_client.v2.resources import ResourceManager
21-
from cloudfoundry_client.v2.routes import RouteManager
21+
from cloudfoundry_client.v2.routes import RouteManager as RouteManagerV2
2222
from cloudfoundry_client.v2.service_bindings import ServiceBindingManager
2323
from cloudfoundry_client.v2.service_brokers import ServiceBrokerManager as ServiceBrokerManagerV2
2424
from cloudfoundry_client.v2.service_instances import ServiceInstanceManager as ServiceInstanceManagerV2
@@ -36,6 +36,7 @@
3636
from cloudfoundry_client.v3.processes import ProcessManager
3737
from cloudfoundry_client.v3.organizations import OrganizationManager
3838
from cloudfoundry_client.v3.roles import RoleManager
39+
from cloudfoundry_client.v3.routes import RouteManager
3940
from cloudfoundry_client.v3.security_groups import SecurityGroupManager
4041
from cloudfoundry_client.v3.service_brokers import ServiceBrokerManager
4142
from cloudfoundry_client.v3.service_credential_bindings import ServiceCredentialBindingManager
@@ -97,7 +98,7 @@ def __init__(self, cloud_controller_v2_url: str, credential_manager: "CloudFound
9798
self.event = EventManager(target_endpoint, credential_manager)
9899
self.organizations = EntityManagerV2(target_endpoint, credential_manager, "/v2/organizations")
99100
self.private_domains = EntityManagerV2(target_endpoint, credential_manager, "/v2/private_domains")
100-
self.routes = RouteManager(target_endpoint, credential_manager)
101+
self.routes = RouteManagerV2(target_endpoint, credential_manager)
101102
self.services = EntityManagerV2(target_endpoint, credential_manager, "/v2/services")
102103
self.shared_domains = EntityManagerV2(target_endpoint, credential_manager, "/v2/shared_domains")
103104
self.spaces = SpaceManagerV2(target_endpoint, credential_manager)
@@ -124,6 +125,7 @@ def __init__(self, cloud_controller_v3_url: str, credential_manager: "CloudFound
124125
self.organization_quotas = OrganizationQuotaManager(target_endpoint, credential_manager)
125126
self.processes = ProcessManager(target_endpoint, credential_manager)
126127
self.roles = RoleManager(target_endpoint, credential_manager)
128+
self.routes = RouteManager(target_endpoint, credential_manager)
127129
self.security_groups = SecurityGroupManager(target_endpoint, credential_manager)
128130
self.service_brokers = ServiceBrokerManager(target_endpoint, credential_manager)
129131
self.service_credential_bindings = ServiceCredentialBindingManager(target_endpoint, credential_manager)

‎cloudfoundry_client/v3/routes.py‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
from enum import StrEnum
2+
from typing import TYPE_CHECKING, Any
3+
4+
from cloudfoundry_client.v3.entities import EntityManager, Entity, ToOneRelationship
5+
6+
if TYPE_CHECKING:
7+
from cloudfoundry_client.client import CloudFoundryClient
8+
9+
10+
class LoadBalancing(StrEnum):
11+
ROUND_ROBIN = 'round-robin'
12+
LEAST_CONNECTION = 'least-connection'
13+
14+
15+
class RouteManager(EntityManager[Entity]):
16+
def __init__(self, target_endpoint: str, client: "CloudFoundryClient"):
17+
super(RouteManager, self).__init__(target_endpoint, client, "/v3/routes")
18+
19+
def create(self,
20+
space_guid: str,
21+
domain_guid: str,
22+
host: str | None = None,
23+
path: str | None = None,
24+
port: int | None = None,
25+
load_balancing: LoadBalancing | None = None,
26+
meta_labels: dict | None = None,
27+
meta_annotations: dict | None = None,
28+
) -> Entity:
29+
data: dict[str, Any] = {
30+
"relationships": {
31+
"space": ToOneRelationship(space_guid), "domain": ToOneRelationship(domain_guid)
32+
},
33+
}
34+
if host is not None:
35+
data["host"] = host
36+
if port is not None:
37+
data["port"] = port
38+
if path is not None:
39+
data["path"] = path
40+
if load_balancing is not None:
41+
data["options"] = {"loadbalancing": load_balancing.value}
42+
self._metadata(data, meta_labels, meta_annotations)
43+
return super(RouteManager, self)._create(data)
44+
45+
def update(self,
46+
route_gid: str,
47+
load_balancing: LoadBalancing | None = None,
48+
meta_labels: dict | None = None,
49+
meta_annotations: dict | None = None,
50+
) -> Entity:
51+
data: dict[str, Any] = {}
52+
if load_balancing is not None:
53+
data["options"] = {"loadbalancing": load_balancing.value}
54+
self._metadata(data, meta_labels, meta_annotations)
55+
return super(RouteManager, self)._update(route_gid, data)
56+
57+
def remove(self, route_gid: str):
58+
return super(RouteManager, self)._remove(route_gid)

‎tests/fixtures/v3/routes/GET_response.json‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
{
2+
"pagination": {
3+
"total_results": 1,
4+
"total_pages": 1,
5+
"first": {
6+
"href": "https://api.example.org/v3/routes?page=1&per_page=2"
7+
},
8+
"last": {
9+
"href": "https://api.example.org/v3/routes?page=1&per_page=2"
10+
},
11+
"next": null,
12+
"previous": null
13+
},
14+
"resources": [
15+
{
16+
"guid": "cbad697f-cac1-48f4-9017-ac08f39dfb31",
17+
"protocol": "http",
18+
"created_at": "2019-05-10T17:17:48Z",
19+
"updated_at": "2019-05-10T17:17:48Z",
20+
"host": "a-hostname",
21+
"path": "/some_path",
22+
"url": "a-hostname.a-domain.com/some_path",
23+
"destinations": [
24+
{
25+
"guid": "385bf117-17f5-4689-8c5c-08c6cc821fed",
26+
"app": {
27+
"guid": "0a6636b5-7fc4-44d8-8752-0db3e40b35a5",
28+
"process": {
29+
"type": "web"
30+
}
31+
},
32+
"weight": null,
33+
"port": 8080,
34+
"protocol": "http1",
35+
"created_at": "2019-05-10T17:17:48Z",
36+
"updated_at": "2019-05-10T17:17:48Z"
37+
},
38+
{
39+
"guid": "27e96a3b-5bcf-49ed-8048-351e0be23e6f",
40+
"app": {
41+
"guid": "f61e59fa-2121-4217-8c7b-15bfd75baf25",
42+
"process": {
43+
"type": "web"
44+
}
45+
},
46+
"weight": null,
47+
"port": 8080,
48+
"protocol": "http1",
49+
"created_at": "2019-05-10T17:17:48Z",
50+
"updated_at": "2019-05-10T17:17:48Z"
51+
}
52+
],
53+
"options": {
54+
"loadbalancing": "round-robin"
55+
},
56+
"metadata": {
57+
"labels": {},
58+
"annotations": {}
59+
},
60+
"relationships": {
61+
"space": {
62+
"data": {
63+
"guid": "885a8cb3-c07b-4856-b448-eeb10bf36236"
64+
}
65+
},
66+
"domain": {
67+
"data": {
68+
"guid": "0b5f3633-194c-42d2-9408-972366617e0e"
69+
}
70+
}
71+
},
72+
"links": {
73+
"self": {
74+
"href": "https://api.example.org/v3/routes/cbad697f-cac1-48f4-9017-ac08f39dfb31"
75+
},
76+
"space": {
77+
"href": "https://api.example.org/v3/spaces/885a8cb3-c07b-4856-b448-eeb10bf36236"
78+
},
79+
"domain": {
80+
"href": "https://api.example.org/v3/domains/0b5f3633-194c-42d2-9408-972366617e0e"
81+
},
82+
"destinations": {
83+
"href": "https://api.example.org/v3/routes/cbad697f-cac1-48f4-9017-ac08f39dfb31/destinations"
84+
}
85+
}
86+
}
87+
]
88+
}

‎tests/fixtures/v3/routes/GET_{id}_response.json‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
{
2+
"guid": "cbad697f-cac1-48f4-9017-ac08f39dfb31",
3+
"protocol": "tcp",
4+
"port": 6666,
5+
"created_at": "2019-05-10T17:17:48Z",
6+
"updated_at": "2019-05-10T17:17:48Z",
7+
"host": "a-hostname",
8+
"path": "/some_path",
9+
"url": "a-hostname.a-domain.com/some_path",
10+
"destinations": [
11+
{
12+
"guid": "385bf117-17f5-4689-8c5c-08c6cc821fed",
13+
"app": {
14+
"guid": "0a6636b5-7fc4-44d8-8752-0db3e40b35a5",
15+
"process": {
16+
"type": "web"
17+
}
18+
},
19+
"weight": null,
20+
"port": 8080,
21+
"protocol": "tcp",
22+
"created_at": "2019-05-10T17:17:48Z",
23+
"updated_at": "2019-05-10T17:17:48Z"
24+
},
25+
{
26+
"guid": "27e96a3b-5bcf-49ed-8048-351e0be23e6f",
27+
"app": {
28+
"guid": "f61e59fa-2121-4217-8c7b-15bfd75baf25",
29+
"process": {
30+
"type": "web"
31+
}
32+
},
33+
"weight": null,
34+
"port": 8080,
35+
"protocol": "tcp",
36+
"created_at": "2019-05-10T17:17:48Z",
37+
"updated_at": "2019-05-10T17:17:48Z"
38+
}
39+
],
40+
"options": {
41+
"loadbalancing": "round-robin"
42+
},
43+
"metadata": {
44+
"labels": {},
45+
"annotations": {}
46+
},
47+
"relationships": {
48+
"space": {
49+
"data": {
50+
"guid": "885a8cb3-c07b-4856-b448-eeb10bf36236"
51+
}
52+
},
53+
"domain": {
54+
"data": {
55+
"guid": "0b5f3633-194c-42d2-9408-972366617e0e"
56+
}
57+
}
58+
},
59+
"links": {
60+
"self": {
61+
"href": "https://api.example.org/v3/routes/cbad697f-cac1-48f4-9017-ac08f39dfb31"
62+
},
63+
"space": {
64+
"href": "https://api.example.org/v3/spaces/885a8cb3-c07b-4856-b448-eeb10bf36236"
65+
},
66+
"domain": {
67+
"href": "https://api.example.org/v3/domains/0b5f3633-194c-42d2-9408-972366617e0e"
68+
},
69+
"destinations": {
70+
"href": "https://api.example.org/v3/routes/cbad697f-cac1-48f4-9017-ac08f39dfb31/destinations"
71+
}
72+
}
73+
}

‎tests/fixtures/v3/routes/PATCH_{id}_response.json‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
{
2+
"guid": "cbad697f-cac1-48f4-9017-ac08f39dfb31",
3+
"protocol": "tcp",
4+
"port": 6666,
5+
"created_at": "2019-05-10T17:17:48Z",
6+
"updated_at": "2019-05-10T17:17:48Z",
7+
"host": "a-hostname",
8+
"path": "/some_path",
9+
"url": "a-hostname.a-domain.com/some_path",
10+
"destinations": [
11+
{
12+
"guid": "385bf117-17f5-4689-8c5c-08c6cc821fed",
13+
"app": {
14+
"guid": "0a6636b5-7fc4-44d8-8752-0db3e40b35a5",
15+
"process": {
16+
"type": "web"
17+
}
18+
},
19+
"weight": null,
20+
"port": 8080,
21+
"protocol": "tcp",
22+
"created_at": "2019-05-10T17:17:48Z",
23+
"updated_at": "2019-05-10T17:17:48Z"
24+
},
25+
{
26+
"guid": "27e96a3b-5bcf-49ed-8048-351e0be23e6f",
27+
"app": {
28+
"guid": "f61e59fa-2121-4217-8c7b-15bfd75baf25",
29+
"process": {
30+
"type": "web"
31+
}
32+
},
33+
"weight": null,
34+
"port": 8080,
35+
"protocol": "tcp",
36+
"created_at": "2019-05-10T17:17:48Z",
37+
"updated_at": "2019-05-10T17:17:48Z"
38+
}
39+
],
40+
"options": {
41+
"loadbalancing": "round-robin"
42+
},
43+
"metadata": {
44+
"labels": {
45+
"key": "value"
46+
},
47+
"annotations": {
48+
"note": "detailed information"
49+
}
50+
},
51+
"relationships": {
52+
"space": {
53+
"data": {
54+
"guid": "885a8cb3-c07b-4856-b448-eeb10bf36236"
55+
}
56+
},
57+
"domain": {
58+
"data": {
59+
"guid": "0b5f3633-194c-42d2-9408-972366617e0e"
60+
}
61+
}
62+
},
63+
"links": {
64+
"self": {
65+
"href": "https://api.example.org/v3/routes/cbad697f-cac1-48f4-9017-ac08f39dfb31"
66+
},
67+
"space": {
68+
"href": "https://api.example.org/v3/spaces/885a8cb3-c07b-4856-b448-eeb10bf36236"
69+
},
70+
"domain": {
71+
"href": "https://api.example.org/v3/domains/0b5f3633-194c-42d2-9408-972366617e0e"
72+
},
73+
"destinations": {
74+
"href": "https://api.example.org/v3/routes/cbad697f-cac1-48f4-9017-ac08f39dfb31/destinations"
75+
}
76+
}
77+
}

0 commit comments

Comments
 (0)