-
Notifications
You must be signed in to change notification settings - Fork 343
/
manager.py
274 lines (225 loc) · 12.9 KB
/
manager.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
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
#
# Copyright 2018-2021 Elyra Authors
#
# 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 os
import re
from typing import Any
from typing import List
from jsonschema import draft7_format_checker
from jsonschema import validate
from jsonschema import ValidationError
from traitlets import Type # noqa H306
from traitlets.config import LoggingConfigurable # noqa H306
from elyra.metadata.error import SchemaNotFoundError
from elyra.metadata.metadata import Metadata
from elyra.metadata.schema import SchemaManager
from elyra.metadata.storage import FileMetadataStore
from elyra.metadata.storage import MetadataStore
class MetadataManager(LoggingConfigurable):
"""Manages the persistence and retrieval of metadata instances"""
metadata_store_class = Type(default_value=FileMetadataStore, config=True,
klass=MetadataStore,
help="""The metadata store class. This is configurable to allow subclassing of
the MetadataStore for customized behavior.""")
def __init__(self, schemaspace: str, **kwargs: Any):
"""
Generic object to manage metadata instances.
:param schemaspace (str): the partition where metadata instances are stored
:param kwargs: additional arguments to be used to instantiate a metadata manager
Keyword Args:
metadata_store_class (str): the name of the MetadataStore subclass to use for storing managed instances
"""
super().__init__(**kwargs)
self.schema_mgr = SchemaManager.instance()
schemaspace_instance = self.schema_mgr.get_schemaspace(schemaspace)
self.schemaspace = schemaspace_instance.name
self.metadata_store = self.metadata_store_class(self.schemaspace, **kwargs)
def schemaspace_exists(self) -> bool:
"""Returns True if the schemaspace for this instance exists"""
return self.metadata_store.schemaspace_exists()
def get_all(self, include_invalid: bool = False) -> List[Metadata]:
"""Returns all metadata instances in summary form (name, display_name, location)"""
instances = []
instance_list = self.metadata_store.fetch_instances(include_invalid=include_invalid)
for metadata_dict in instance_list:
# validate the instance prior to return, include invalid instances as appropriate
try:
metadata = Metadata.from_dict(self.schemaspace, metadata_dict)
metadata.post_load() # Allow class instances to handle loads
# if we're including invalid and there was an issue on retrieval, add it to the list
if include_invalid and metadata.reason:
# If no schema-name is present, set to '{unknown}' since we can't make that determination.
if not metadata.schema_name:
metadata.schema_name = '{unknown}'
else: # go ahead and validate against the schema
self.validate(metadata.name, metadata)
instances.append(metadata)
except Exception as ex: # Ignore ValidationError and others when fetching all instances
# Since we may not have a metadata instance due to a failure during `from_dict()`,
# instantiate a bad instance directly to use in the message and invalid result.
invalid_instance = Metadata(**metadata_dict)
self.log.debug("Fetch of instance '{}' of schemaspace '{}' encountered an exception: {}".
format(invalid_instance.name, self.schemaspace, ex))
if include_invalid:
invalid_instance.reason = ex.__class__.__name__
instances.append(invalid_instance)
return instances
def get(self, name: str) -> Metadata:
"""Returns the metadata instance corresponding to the given name"""
if name is None:
raise ValueError("The 'name' parameter requires a value.")
instance_list = self.metadata_store.fetch_instances(name=name)
metadata_dict = instance_list[0]
metadata = Metadata.from_dict(self.schemaspace, metadata_dict)
# Validate the instance on load
self.validate(name, metadata)
# Allow class instances to alter instance
metadata.post_load()
return metadata
def create(self, name: str, metadata: Metadata) -> Metadata:
"""Creates the given metadata, returning the created instance"""
return self._save(name, metadata)
def update(self, name: str, metadata: Metadata) -> Metadata:
"""Updates the given metadata, returning the updated instance"""
return self._save(name, metadata, for_update=True)
def remove(self, name: str) -> None:
"""Removes the metadata instance corresponding to the given name"""
instance_list = self.metadata_store.fetch_instances(name=name)
metadata_dict = instance_list[0]
self.log.debug("Removing metadata resource '{}' from schemaspace '{}'.".format(name, self.schemaspace))
metadata = Metadata.from_dict(self.schemaspace, metadata_dict)
metadata.pre_delete() # Allow class instances to handle delete
self.metadata_store.delete_instance(metadata_dict)
try:
metadata.post_delete() # Allow class instances to handle post-delete tasks (e.g., cache updates, etc.)
except Exception as ex:
self._rollback(name, metadata, "delete", ex)
raise ex
def validate(self, name: str, metadata: Metadata) -> None:
"""Validate metadata against its schema.
Ensure metadata is valid based on its schema. If invalid or schema
is not found, ValidationError will be raised.
"""
metadata_dict = metadata.to_dict()
schema_name = metadata_dict.get('schema_name')
if not schema_name:
raise ValueError("Instance '{}' in the {} schemaspace is missing a 'schema_name' field!".
format(name, self.schemaspace))
schema = self._get_schema(schema_name) # returns a value or throws
try:
validate(instance=metadata_dict, schema=schema, format_checker=draft7_format_checker)
except ValidationError as ve:
# Because validation errors are so verbose, only provide the first line.
first_line = str(ve).partition('\n')[0]
msg = "Validation failed for instance '{}' using the {} schema with error: {}.".\
format(name, schema_name, first_line)
self.log.error(msg)
raise ValidationError(msg) from ve
@staticmethod
def _get_normalized_name(name: str) -> str:
# lowercase and replaces spaces with underscore
name = re.sub('\\s+', '_', name.lower())
# remove all invalid characters
name = re.sub('[^a-z0-9-_]+', '', name)
# begin with alpha
if not name[0].isalpha():
name = 'a_' + name
# end with alpha numeric
if not name[-1].isalnum():
name = name + '_0'
return name
def _get_schema(self, schema_name: str) -> dict:
"""Loads the schema based on the schema_name and returns the loaded schema json.
Throws ValidationError if schema file is not present.
"""
schema_json = self.schema_mgr.get_schema(self.schemaspace, schema_name)
if schema_json is None:
schema_file = os.path.join(os.path.dirname(__file__), 'schemas', schema_name + '.json')
if not os.path.exists(schema_file):
self.log.error("The file for schema '{}' is missing from its expected location: '{}'".
format(schema_name, schema_file))
raise SchemaNotFoundError("The file for schema '{}' is missing!".format(schema_name))
return schema_json
def _save(self, name: str, metadata: Metadata, for_update: bool = False) -> Metadata:
if not metadata:
raise ValueError("An instance of class 'Metadata' was not provided.")
if not isinstance(metadata, Metadata):
raise TypeError("'metadata' is not an instance of class 'Metadata'.")
if not name and not for_update: # name is derived from display_name only on creates
if metadata.display_name:
name = self._get_normalized_name(metadata.display_name)
metadata.name = name
if not name: # At this point, name must be set
raise ValueError('Name of metadata was not provided.')
match = re.search("^[a-z]([a-z0-9-_]*[a-z,0-9])?$", name)
if match is None:
raise ValueError("Name of metadata must be lowercase alphanumeric, beginning with alpha and can include "
"embedded hyphens ('-') and underscores ('_').")
orig_value = None
if for_update:
orig_value = self.get(name)
# Allow class instances to handle pre-save tasks
metadata.pre_save(for_update=for_update)
self._apply_defaults(metadata)
# Validate the metadata prior to storage then store the instance.
self.validate(name, metadata)
metadata_dict = self.metadata_store.store_instance(name, metadata.prepare_write(), for_update=for_update)
metadata_post_op = Metadata.from_dict(self.schemaspace, metadata_dict)
# Allow class instances to handle post-save tasks (e.g., cache updates, etc.)
# Note that this is a _different_ instance from pre-save call
try:
metadata_post_op.post_save(for_update=for_update)
except Exception as ex:
if for_update:
self._rollback(name, orig_value, "update", ex)
else: # Use the metadata instance prior to post op
self._rollback(name, Metadata.from_dict(self.schemaspace, metadata_dict), "create", ex)
raise ex
return metadata_post_op
def _rollback(self, name: str, orig_value: Metadata, operation: str, exception: Exception):
"""Rolls back the original value depending on the operation.
For rolled back creation attempts, we must remove the created instance. For rolled back
update or deletion attempts, we must restore the original value. Note that these operations
must call the metadata store directly so that class hooks are not called.
"""
self.log.debug(f"Rolling back metadata operation '{operation}' for instance '{name}' due to: {exception}")
if operation == "create": # remove the instance, orig_value is the newly-created instance.
self.metadata_store.delete_instance(orig_value.to_dict())
elif operation == "update": # restore original as an update
self.metadata_store.store_instance(name, orig_value.prepare_write(), for_update=True)
elif operation == "delete": # restore original as a create
self.metadata_store.store_instance(name, orig_value.prepare_write(), for_update=False)
self.log.warning(f"Rolled back metadata operation '{operation}' for instance '{name}' due to "
f"failure in post-processing method: {exception}")
def _apply_defaults(self, metadata: Metadata) -> None:
"""If a given property has a default value defined, and that property is not currently represented,
assign it the default value.
"""
# Get the schema and build a dict consisting of properties and their default values (for those
# properties that have defaults). Then walk the metadata instance looking for missing properties
# and assign the corresponding default value. Note that we do not consider existing properties with
# values of None for default replacement since that may be intentional (although those values will
# likely fail subsequent validation).
schema = self.schema_mgr.get_schema(self.schemaspace, metadata.schema_name)
meta_properties = schema['properties']['metadata']['properties']
property_defaults = {}
for name, property in meta_properties.items():
if 'default' in property:
property_defaults[name] = property['default']
if property_defaults: # schema defines defaulted properties
instance_properties = metadata.metadata
for name, default in property_defaults.items():
if name not in instance_properties:
instance_properties[name] = default