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
|
# Copyright 2018 Huawei Technologies Co.,LTD.
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import pecan
from pecan import rest
from six.moves import http_client
import wsme
from wsme import types as wtypes
from cyborg.api.controllers import base
from cyborg.api.controllers import link
from cyborg.api.controllers.v1 import types
from cyborg.api.controllers.v1 import utils as api_utils
from cyborg.api import expose
from cyborg.common import exception
from cyborg.common import policy
from cyborg import objects
class Deployable(base.APIBase):
"""API representation of a deployable.
This class enforces type checking and value constraints, and converts
between the internal object model and the API representation of
a deployable.
"""
uuid = types.uuid
"""The UUID of the deployable"""
name = wtypes.text
"""The name of the deployable"""
parent_uuid = types.uuid
"""The parent UUID of the deployable"""
root_uuid = types.uuid
"""The root UUID of the deployable"""
pcie_address = wtypes.text
"""The pcie address of the deployable"""
host = wtypes.text
"""The host on which the deployable is located"""
board = wtypes.text
"""The board of the deployable"""
vendor = wtypes.text
"""The vendor of the deployable"""
version = wtypes.text
"""The version of the deployable"""
type = wtypes.text
"""The type of the deployable"""
assignable = types.boolean
"""Whether the deployable is assignable"""
instance_uuid = types.uuid
"""The UUID of the instance which deployable is assigned to"""
availability = wtypes.text
"""The availability of the deployable"""
links = wsme.wsattr([link.Link], readonly=True)
"""A list containing a self link"""
def __init__(self, **kwargs):
super(Deployable, self).__init__(**kwargs)
self.fields = []
for field in objects.Deployable.fields:
self.fields.append(field)
setattr(self, field, kwargs.get(field, wtypes.Unset))
@classmethod
def convert_with_links(cls, obj_dep):
api_dep = cls(**obj_dep.as_dict())
url = pecan.request.public_url
api_dep.links = [
link.Link.make_link('self', url, 'deployables', api_dep.uuid),
link.Link.make_link('bookmark', url, 'deployables', api_dep.uuid,
bookmark=True)
]
return api_dep
class DeployableCollection(base.APIBase):
"""API representation of a collection of deployables."""
deployables = [Deployable]
"""A list containing deployable objects"""
@classmethod
def convert_with_links(cls, obj_deps):
collection = cls()
collection.deployables = [Deployable.convert_with_links(obj_dep)
for obj_dep in obj_deps]
return collection
class DeployablePatchType(types.JsonPatchType):
_api_base = Deployable
@staticmethod
def internal_attrs():
defaults = types.JsonPatchType.internal_attrs()
return defaults + ['/pcie_address', '/host', '/type']
class DeployablesController(rest.RestController):
"""REST controller for Deployables."""
@policy.authorize_wsgi("cyborg:deployable", "create", False)
@expose.expose(Deployable, body=types.jsontype,
status_code=http_client.CREATED)
def post(self, dep):
"""Create a new deployable.
:param dep: a deployable within the request body.
"""
context = pecan.request.context
obj_dep = objects.Deployable(context, **dep)
new_dep = pecan.request.conductor_api.deployable_create(context,
obj_dep)
# Set the HTTP Location Header
pecan.response.location = link.build_url('deployables', new_dep.uuid)
return Deployable.convert_with_links(new_dep)
@policy.authorize_wsgi("cyborg:deployable", "get_one")
@expose.expose(Deployable, types.uuid)
def get_one(self, uuid):
"""Retrieve information about the given deployable.
:param uuid: UUID of a deployable.
"""
obj_dep = objects.Deployable.get(pecan.request.context, uuid)
return Deployable.convert_with_links(obj_dep)
@policy.authorize_wsgi("cyborg:deployable", "get_all")
@expose.expose(DeployableCollection, types.uuid, wtypes.text,
wtypes.text, types.boolean)
def get_all(self, root_uuid=None, host=None, type=None, assignable=None):
"""Retrieve a list of deployables."""
filters = {}
if root_uuid:
filters["root_uuid"] = root_uuid
if host:
filters["host"] = host
if type:
filters["type"] = type
if assignable:
filters["assignable"] = assignable
obj_deps = objects.Deployable.get_by_filter(pecan.request.context,
filters=filters)
return DeployableCollection.convert_with_links(obj_deps)
@policy.authorize_wsgi("cyborg:deployable", "update")
@expose.expose(Deployable, types.uuid, body=[DeployablePatchType])
def patch(self, uuid, patch):
"""Update a deployable.
:param uuid: UUID of a deployable.
:param patch: a json PATCH document to apply to this deployable.
"""
context = pecan.request.context
obj_dep = objects.Deployable.get(context, uuid)
try:
api_dep = Deployable(
**api_utils.apply_jsonpatch(obj_dep.as_dict(), patch))
except api_utils.JSONPATCH_EXCEPTIONS as e:
raise exception.PatchError(patch=patch, reason=e)
# Update only the fields that have changed
for field in objects.Deployable.fields:
try:
patch_val = getattr(api_dep, field)
except AttributeError:
# Ignore fields that aren't exposed in the API
continue
if patch_val == wtypes.Unset:
patch_val = None
if obj_dep[field] != patch_val:
obj_dep[field] = patch_val
new_dep = pecan.request.conductor_api.deployable_update(context,
obj_dep)
return Deployable.convert_with_links(new_dep)
@policy.authorize_wsgi("cyborg:deployable", "delete")
@expose.expose(None, types.uuid, status_code=http_client.NO_CONTENT)
def delete(self, uuid):
"""Delete a deployable.
:param uuid: UUID of a deployable.
"""
context = pecan.request.context
obj_dep = objects.Deployable.get(context, uuid)
pecan.request.conductor_api.deployable_delete(context, obj_dep)
|
