-
Notifications
You must be signed in to change notification settings - Fork 308
/
naming_convention.py
184 lines (152 loc) · 5.82 KB
/
naming_convention.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
# Copyright European Organization for Nuclear Research (CERN) since 2012
#
# 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.
from re import compile, error, match
from traceback import format_exc
from typing import TYPE_CHECKING, Any, Optional, cast
from dogpile.cache.api import NO_VALUE
from sqlalchemy.exc import IntegrityError
from rucio.common.cache import make_region_memcached
from rucio.common.exception import Duplicate, InvalidObject, RucioException
from rucio.db.sqla import models
from rucio.db.sqla.constants import KeyType
from rucio.db.sqla.session import read_session, transactional_session
if TYPE_CHECKING:
from typing import TypedDict
from sqlalchemy.orm import Session
from rucio.common.types import InternalScope
class NamingConventionDict(TypedDict):
scope: InternalScope
regexp: str
REGION = make_region_memcached(expiration_time=900)
@transactional_session
def add_naming_convention(
scope: "InternalScope",
regexp: str,
convention_type: KeyType,
*,
session: "Session"
) -> None:
"""
add a naming convention for a given scope
:param scope: the name for the scope.
:param regexp: the regular expression to validate the name.
:param convention_type: the did_type on which the regexp should apply.
:param session: The database session in use.
"""
# validate the regular expression
try:
compile(regexp)
except error:
raise RucioException('Invalid regular expression %s!' % regexp)
new_convention = models.NamingConvention(scope=scope,
regexp=regexp,
convention_type=convention_type)
try:
new_convention.save(session=session)
except IntegrityError:
raise Duplicate('Naming convention already exists!')
except:
raise RucioException(str(format_exc()))
@read_session
def get_naming_convention(
scope: "InternalScope",
convention_type: KeyType,
*,
session: "Session"
) -> Optional[str]:
"""
Get the naming convention for a given scope
:param scope: the name for the scope.
:param convention_type: the did_type on which the regexp should apply.
:param session: The database session in use.
:returns: the regular expression.
"""
query = session.query(models.NamingConvention.regexp).\
filter(models.NamingConvention.scope == scope).\
filter(models.NamingConvention.convention_type == convention_type)
for row in query:
return row[0]
@transactional_session
def delete_naming_convention(
scope: "InternalScope",
convention_type: KeyType,
*,
session: "Session"
) -> int:
"""
delete a naming convention for a given scope
:param scope: the name for the scope.
:param regexp: the regular expression to validate the name. (DEPRECATED)
:param convention_type: the did_type on which the regexp should apply.
:param session: The database session in use.
"""
if scope.internal is not None:
REGION.delete(scope.internal)
return session.query(models.NamingConvention) \
.filter_by(scope=scope, convention_type=convention_type) \
.delete()
@read_session
def list_naming_conventions(*, session: "Session") -> list["NamingConventionDict"]:
"""
List all naming conventions.
:param session: The database session in use.
:returns: a list of dictionaries.
"""
query = session.query(models.NamingConvention.scope,
models.NamingConvention.regexp)
return [cast("NamingConventionDict", row._asdict()) for row in query]
@read_session
def validate_name(
scope: "InternalScope",
name: str,
did_type: str,
*,
session: "Session"
) -> Optional[dict[str, Any]]:
"""
Validate a name according to a naming convention.
:param scope: the name for the scope.
:param name: the name.
:param did_type: the type of did.
:param session: The database session in use.
:returns: a dictionary with metadata.
"""
if scope.external.startswith('user'):
return {'project': 'user'}
elif scope.external.startswith('group'):
return {'project': 'group'}
# Check if naming convention can be found in cache region
regexp = REGION.get(scope.internal)
if regexp is NO_VALUE: # no cached entry found
regexp = get_naming_convention(scope=scope,
convention_type=KeyType.DATASET,
session=session)
regexp and REGION.set(scope.internal, regexp)
if not regexp:
return
# Validate with regexp
groups = match(regexp, str(name)) # type: ignore
if groups:
meta = groups.groupdict()
# Hack to get task_id from version
if 'version' in meta and meta['version']:
matched = match(r'(?P<version>\w+)_tid(?P<task_id>\d+)_\w+$', meta['version'])
if matched:
meta['version'] = matched.groupdict()['version']
meta['task_id'] = int(matched.groupdict()['task_id'])
if 'run_number' in meta and meta['run_number']:
meta['run_number'] = int(meta['run_number'])
return meta
print(f"Provided name {name} doesn't match the naming convention {regexp}")
raise InvalidObject(f"Provided name {name} doesn't match the naming convention {regexp}")