/
util.py
203 lines (183 loc) · 9.38 KB
/
util.py
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
# 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.
"""DB Utility methods for placement."""
from oslo_log import log as logging
import webob
from placement import errors
from placement import exception
from placement.objects import consumer as consumer_obj
from placement.objects import consumer_type as consumer_type_obj
from placement.objects import project as project_obj
from placement.objects import user as user_obj
LOG = logging.getLogger(__name__)
def fetch_consumer_type_id(ctx, name):
"""Tries to fetch the provided consumer_type and creates a new one if it
does not exist.
:param ctx: The request context.
:param name: The name of the consumer type.
:returns: The id of the ConsumerType object.
"""
try:
return ctx.ct_cache.id_from_string(name)
except exception.ConsumerTypeNotFound:
cons_type = consumer_type_obj.ConsumerType(ctx, name=name)
try:
cons_type.create()
return cons_type.id
except exception.ConsumerTypeExists:
# another thread created concurrently, so try again
return fetch_consumer_type_id(ctx, name)
def _get_or_create_project(ctx, project_id):
try:
proj = project_obj.Project.get_by_external_id(ctx, project_id)
except exception.NotFound:
# Auto-create the project if we found no record of it...
try:
proj = project_obj.Project(ctx, external_id=project_id)
proj.create()
except exception.ProjectExists:
# No worries, another thread created this project already
proj = project_obj.Project.get_by_external_id(ctx, project_id)
return proj
def _get_or_create_user(ctx, user_id):
try:
user = user_obj.User.get_by_external_id(ctx, user_id)
except exception.NotFound:
# Auto-create the user if we found no record of it...
try:
user = user_obj.User(ctx, external_id=user_id)
user.create()
except exception.UserExists:
# No worries, another thread created this user already
user = user_obj.User.get_by_external_id(ctx, user_id)
return user
def _create_consumer(ctx, consumer_uuid, project, user, consumer_type_id):
created_new_consumer = False
try:
consumer = consumer_obj.Consumer(
ctx, uuid=consumer_uuid, project=project, user=user,
consumer_type_id=consumer_type_id)
consumer.create()
created_new_consumer = True
except exception.ConsumerExists:
# Another thread created this consumer already, verify whether
# the consumer type matches
consumer = consumer_obj.Consumer.get_by_uuid(ctx, consumer_uuid)
# If the types don't match, update the consumer record
if consumer_type_id != consumer.consumer_type_id:
LOG.debug("Supplied consumer type for consumer %s was "
"different than existing record. Updating "
"consumer record.", consumer_uuid)
consumer.consumer_type_id = consumer_type_id
consumer.update()
return consumer, created_new_consumer
def ensure_consumer(ctx, consumer_uuid, project_id, user_id,
consumer_generation, consumer_type, want_version):
"""Ensures there are records in the consumers, projects and users table for
the supplied external identifiers.
Returns a tuple containing the populated Consumer object containing Project
and User sub-objects and a boolean indicating whether a new Consumer object
was created (as opposed to an existing consumer record retrieved)
:note: If the supplied project or user external identifiers do not match an
existing consumer's project and user identifiers, the existing
consumer's project and user IDs are updated to reflect the supplied
ones.
:param ctx: The request context.
:param consumer_uuid: The uuid of the consumer of the resources.
:param project_id: The external ID of the project consuming the resources.
:param user_id: The external ID of the user consuming the resources.
:param consumer_generation: The generation provided by the user for this
consumer.
:param consumer_type: The type of consumer provided by the user.
:param want_version: the microversion matcher.
:raises webob.exc.HTTPConflict if consumer generation is required and there
was a mismatch
"""
created_new_consumer = False
requires_consumer_generation = want_version.matches((1, 28))
requires_consumer_type = want_version.matches((1, 38))
if project_id is None:
project_id = ctx.config.placement.incomplete_consumer_project_id
user_id = ctx.config.placement.incomplete_consumer_user_id
proj = _get_or_create_project(ctx, project_id)
user = _get_or_create_user(ctx, user_id)
try:
consumer = consumer_obj.Consumer.get_by_uuid(ctx, consumer_uuid)
if requires_consumer_generation:
if consumer.generation != consumer_generation:
raise webob.exc.HTTPConflict(
'consumer generation conflict - '
'expected %(expected_gen)s but got %(got_gen)s' %
{
'expected_gen': consumer.generation,
'got_gen': consumer_generation,
},
comment=errors.CONCURRENT_UPDATE)
# NOTE(jaypipes): The user may have specified a different project and
# user external ID than the one that we had for the consumer. If this
# is the case, go ahead and modify the consumer record with the
# newly-supplied project/user information, but do not bump the consumer
# generation (since it will be bumped in the
# AllocationList.replace_all() method).
#
# TODO(jaypipes): This means that there may be a partial update.
# Imagine a scenario where a user calls POST /allocations, and the
# payload references two consumers. The first consumer is a new
# consumer and is auto-created. The second consumer is an existing
# consumer, but contains a different project or user ID than the
# existing consumer's record. If the eventual call to
# AllocationList.replace_all() fails for whatever reason (say, a
# resource provider generation conflict or out of resources failure),
# we will end up deleting the auto-created consumer and we will undo
# the changes to the second consumer's project and user ID.
# NOTE(melwitt): The aforementioned rollback of changes is predicated
# on the fact that the same transaction context is used for both
# util.ensure_consumer() and AllocationList.replace_all() within the
# same HTTP request. The @db_api.placement_context_manager.writer
# decorator on the outermost method will nest to methods called within
# the outermost method.
if (project_id != consumer.project.external_id or
user_id != consumer.user.external_id):
LOG.debug("Supplied project or user ID for consumer %s was "
"different than existing record. Updating consumer "
"record.", consumer_uuid)
consumer.project = proj
consumer.user = user
consumer.update()
# Update the consumer type if it's different than the existing one.
if requires_consumer_type:
cons_type_id = fetch_consumer_type_id(ctx, consumer_type)
if cons_type_id != consumer.consumer_type_id:
LOG.debug("Supplied consumer type for consumer %s was "
"different than existing record. Updating "
"consumer record.", consumer_uuid)
consumer.consumer_type_id = cons_type_id
consumer.update()
except exception.NotFound:
# If we are attempting to modify or create allocations after 1.26, we
# need a consumer generation specified. The user must have specified
# None for the consumer generation if we get here, since there was no
# existing consumer with this UUID and therefore the user should be
# indicating that they expect the consumer did not exist.
if requires_consumer_generation:
if consumer_generation is not None:
raise webob.exc.HTTPConflict(
'consumer generation conflict - '
'expected null but got %s' % consumer_generation,
comment=errors.CONCURRENT_UPDATE)
cons_type_id = (fetch_consumer_type_id(ctx, consumer_type)
if requires_consumer_type else None)
# No such consumer. This is common for new allocations. Create the
# consumer record
consumer, created_new_consumer = _create_consumer(
ctx, consumer_uuid, proj, user, cons_type_id)
return consumer, created_new_consumer