Skip to content

Commit 703a1e3

Browse files
Rename database functions to cloud_databases (#2969)
* Refresh secrets (#2966) * Refresh Vuforia secrets and simplify admin script Replace suspended license credentials with 100 fresh cloud database credentials. Simplify the secrets creation script to reuse existing VuMark and inactive database credentials from the existing secrets file instead of creating new ones each run. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Revert simplification of admin script to restore VuMark creation logic Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> * Fix docs endpoint reference after rename to create_cloud_database Update the autoflask directive in docker.rst to reference the renamed endpoint create_cloud_database instead of create_database. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 1bb88c7 commit 703a1e3

7 files changed

Lines changed: 43 additions & 41 deletions

File tree

docs/source/docker.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ To mimic this functionality, this mock provides a target manager container which
5454
To add a database, make a request to the following endpoint against the target manager container:
5555

5656
.. autoflask:: mock_vws._flask_server.target_manager:TARGET_MANAGER_FLASK_APP
57-
:endpoints: create_database
57+
:endpoints: create_cloud_database
5858

5959
For example, with the containers set up as in :ref:`creating-containers`, use ``curl``:
6060

src/mock_vws/_flask_server/target_manager.py

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ def delete_database(database_name: str) -> Response:
7070
try:
7171
(matching_database,) = {
7272
database
73-
for database in TARGET_MANAGER.databases
73+
for database in TARGET_MANAGER.cloud_databases
7474
if database_name == database.database_name
7575
}
7676
except ValueError:
@@ -82,9 +82,11 @@ def delete_database(database_name: str) -> Response:
8282

8383
@TARGET_MANAGER_FLASK_APP.route(rule="/databases", methods=[HTTPMethod.GET])
8484
@beartype
85-
def get_databases() -> Response:
85+
def get_cloud_databases() -> Response:
8686
"""Return a list of all databases."""
87-
databases = [database.to_dict() for database in TARGET_MANAGER.databases]
87+
databases = [
88+
database.to_dict() for database in TARGET_MANAGER.cloud_databases
89+
]
8890
return Response(
8991
response=json.dumps(obj=databases),
9092
status=HTTPStatus.OK,
@@ -93,7 +95,7 @@ def get_databases() -> Response:
9395

9496
@TARGET_MANAGER_FLASK_APP.route(rule="/databases", methods=[HTTPMethod.POST])
9597
@beartype
96-
def create_database() -> Response:
98+
def create_cloud_database() -> Response:
9799
"""Create a new database.
98100
99101
:reqheader Content-Type: application/json
@@ -193,7 +195,7 @@ def create_target(database_name: str) -> Response:
193195
"""Create a new target in a given database."""
194196
(database,) = (
195197
database
196-
for database in TARGET_MANAGER.databases
198+
for database in TARGET_MANAGER.cloud_databases
197199
if database.database_name == database_name
198200
)
199201
request_json = json.loads(s=request.data)
@@ -229,7 +231,7 @@ def delete_target(database_name: str, target_id: str) -> Response:
229231
"""Delete a target."""
230232
(database,) = (
231233
database
232-
for database in TARGET_MANAGER.databases
234+
for database in TARGET_MANAGER.cloud_databases
233235
if database.database_name == database_name
234236
)
235237
target = database.get_target(target_id=target_id)
@@ -255,7 +257,7 @@ def update_target(database_name: str, target_id: str) -> Response:
255257
"""Update a target."""
256258
(database,) = (
257259
database
258-
for database in TARGET_MANAGER.databases
260+
for database in TARGET_MANAGER.cloud_databases
259261
if database.database_name == database_name
260262
)
261263
target = database.get_target(target_id=target_id)

src/mock_vws/_flask_server/vwq.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ class VWQSettings(BaseSettings):
6363

6464

6565
@beartype
66-
def get_all_databases() -> set[CloudDatabase]:
66+
def get_all_cloud_databases() -> set[CloudDatabase]:
6767
"""Get all database objects from the target manager back-end."""
6868
settings = VWQSettings.model_validate(obj={})
6969
response = requests.get(
@@ -132,7 +132,7 @@ def query() -> Response:
132132
settings = VWQSettings.model_validate(obj={})
133133
query_match_checker = settings.query_image_matcher.to_image_matcher()
134134

135-
databases = get_all_databases()
135+
databases = get_all_cloud_databases()
136136
request_body = request.stream.read()
137137
run_query_validators(
138138
request_headers=dict(request.headers),

src/mock_vws/_flask_server/vws.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ class VWSSettings(BaseSettings):
8686

8787

8888
@beartype
89-
def get_all_databases() -> set[CloudDatabase]:
89+
def get_all_cloud_databases() -> set[CloudDatabase]:
9090
"""Get all database objects from the task manager back-end."""
9191
settings = VWSSettings.model_validate(obj={})
9292
timeout_seconds = 30
@@ -130,7 +130,7 @@ def set_terminate_wsgi_input() -> None:
130130
@beartype
131131
def validate_request() -> None:
132132
"""Run validators on the request."""
133-
databases = get_all_databases()
133+
databases = get_all_cloud_databases()
134134
run_services_validators(
135135
request_headers=dict(request.headers),
136136
request_body=request.data,
@@ -172,7 +172,7 @@ def add_target() -> Response:
172172
https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#add
173173
"""
174174
settings = VWSSettings.model_validate(obj={})
175-
databases = get_all_databases()
175+
databases = get_all_cloud_databases()
176176
database = get_database_matching_server_keys(
177177
request_headers=dict(request.headers),
178178
request_body=request.data,
@@ -245,7 +245,7 @@ def get_target(target_id: str) -> Response:
245245
Fake implementation of
246246
https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#target-record
247247
"""
248-
databases = get_all_databases()
248+
databases = get_all_cloud_databases()
249249
database = get_database_matching_server_keys(
250250
request_headers=dict(request.headers),
251251
request_body=request.data,
@@ -302,7 +302,7 @@ def delete_target(target_id: str) -> Response:
302302
https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#delete
303303
"""
304304
settings = VWSSettings.model_validate(obj={})
305-
databases = get_all_databases()
305+
databases = get_all_cloud_databases()
306306
database = get_database_matching_server_keys(
307307
request_headers=dict(request.headers),
308308
request_body=request.data,
@@ -402,7 +402,7 @@ def database_summary() -> Response:
402402
Fake implementation of
403403
https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#summary-report
404404
"""
405-
databases = get_all_databases()
405+
databases = get_all_cloud_databases()
406406
database = get_database_matching_server_keys(
407407
request_headers=dict(request.headers),
408408
request_body=request.data,
@@ -457,7 +457,7 @@ def target_summary(target_id: str) -> Response:
457457
Fake implementation of
458458
https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#retrieve-report
459459
"""
460-
databases = get_all_databases()
460+
databases = get_all_cloud_databases()
461461
database = get_database_matching_server_keys(
462462
request_headers=dict(request.headers),
463463
request_body=request.data,
@@ -511,7 +511,7 @@ def get_duplicates(target_id: str) -> Response:
511511
Fake implementation of
512512
https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#check
513513
"""
514-
databases = get_all_databases()
514+
databases = get_all_cloud_databases()
515515
settings = VWSSettings.model_validate(obj={})
516516
database = get_database_matching_server_keys(
517517
request_headers=dict(request.headers),
@@ -570,7 +570,7 @@ def target_list() -> Response:
570570
Fake implementation of
571571
https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#details-list
572572
"""
573-
databases = get_all_databases()
573+
databases = get_all_cloud_databases()
574574
database = get_database_matching_server_keys(
575575
request_headers=dict(request.headers),
576576
request_body=request.data,
@@ -616,7 +616,7 @@ def update_target(target_id: str) -> Response:
616616
# We do not use ``request.get_json(force=True)`` because this only works
617617
# when the content type is given as ``application/json``.
618618
request_json = json.loads(s=request.data)
619-
databases = get_all_databases()
619+
databases = get_all_cloud_databases()
620620
database = get_database_matching_server_keys(
621621
request_headers=dict(request.headers),
622622
request_body=request.data,

src/mock_vws/_requests_mock_server/mock_web_query_api.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ def query(self, request: PreparedRequest) -> _ResponseType:
122122
request_headers=request.headers,
123123
request_body=_body_bytes(request=request),
124124
request_method=request.method or "",
125-
databases=self._target_manager.databases,
125+
databases=self._target_manager.cloud_databases,
126126
)
127127
except ValidatorError as exc:
128128
return exc.status_code, exc.headers, exc.response_text
@@ -132,7 +132,7 @@ def query(self, request: PreparedRequest) -> _ResponseType:
132132
request_body=_body_bytes(request=request),
133133
request_method=request.method or "",
134134
request_path=request.path_url,
135-
databases=self._target_manager.databases,
135+
databases=self._target_manager.cloud_databases,
136136
query_match_checker=self._query_match_checker,
137137
)
138138

src/mock_vws/_requests_mock_server/mock_web_services_api.py

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ def add_target(self, request: PreparedRequest) -> _ResponseType:
164164
request_body=_body_bytes(request=request),
165165
request_method=request.method or "",
166166
request_path=request.path_url,
167-
databases=self._target_manager.databases,
167+
databases=self._target_manager.cloud_databases,
168168
)
169169
except ValidatorError as exc:
170170
return exc.status_code, exc.headers, exc.response_text
@@ -174,7 +174,7 @@ def add_target(self, request: PreparedRequest) -> _ResponseType:
174174
request_body=_body_bytes(request=request),
175175
request_method=request.method or "",
176176
request_path=request.path_url,
177-
databases=self._target_manager.databases,
177+
databases=self._target_manager.cloud_databases,
178178
)
179179

180180
request_json: dict[str, Any] = json.loads(s=request.body or b"")
@@ -239,7 +239,7 @@ def delete_target(self, request: PreparedRequest) -> _ResponseType:
239239
request_body=_body_bytes(request=request),
240240
request_method=request.method or "",
241241
request_path=request.path_url,
242-
databases=self._target_manager.databases,
242+
databases=self._target_manager.cloud_databases,
243243
)
244244
except ValidatorError as exc:
245245
return exc.status_code, exc.headers, exc.response_text
@@ -249,7 +249,7 @@ def delete_target(self, request: PreparedRequest) -> _ResponseType:
249249
request_body=_body_bytes(request=request),
250250
request_method=request.method or "",
251251
request_path=request.path_url,
252-
databases=self._target_manager.databases,
252+
databases=self._target_manager.cloud_databases,
253253
)
254254

255255
target_id = request.path_url.split(sep="/")[-1]
@@ -314,7 +314,7 @@ def generate_vumark_instance(
314314
request_body=_body_bytes(request=request),
315315
request_method=request.method or "",
316316
request_path=request.path_url,
317-
databases=self._target_manager.databases,
317+
databases=self._target_manager.cloud_databases,
318318
)
319319

320320
accept = dict(request.headers).get("Accept", "")
@@ -360,7 +360,7 @@ def database_summary(self, request: PreparedRequest) -> _ResponseType:
360360
request_body=_body_bytes(request=request),
361361
request_method=request.method or "",
362362
request_path=request.path_url,
363-
databases=self._target_manager.databases,
363+
databases=self._target_manager.cloud_databases,
364364
)
365365
except ValidatorError as exc:
366366
return exc.status_code, exc.headers, exc.response_text
@@ -370,7 +370,7 @@ def database_summary(self, request: PreparedRequest) -> _ResponseType:
370370
request_body=_body_bytes(request=request),
371371
request_method=request.method or "",
372372
request_path=request.path_url,
373-
databases=self._target_manager.databases,
373+
databases=self._target_manager.cloud_databases,
374374
)
375375

376376
date = email.utils.formatdate(
@@ -421,7 +421,7 @@ def target_list(self, request: PreparedRequest) -> _ResponseType:
421421
request_body=_body_bytes(request=request),
422422
request_method=request.method or "",
423423
request_path=request.path_url,
424-
databases=self._target_manager.databases,
424+
databases=self._target_manager.cloud_databases,
425425
)
426426
except ValidatorError as exc:
427427
return exc.status_code, exc.headers, exc.response_text
@@ -431,7 +431,7 @@ def target_list(self, request: PreparedRequest) -> _ResponseType:
431431
request_body=_body_bytes(request=request),
432432
request_method=request.method or "",
433433
request_path=request.path_url,
434-
databases=self._target_manager.databases,
434+
databases=self._target_manager.cloud_databases,
435435
)
436436

437437
date = email.utils.formatdate(
@@ -478,7 +478,7 @@ def get_target(self, request: PreparedRequest) -> _ResponseType:
478478
request_body=_body_bytes(request=request),
479479
request_method=request.method or "",
480480
request_path=request.path_url,
481-
databases=self._target_manager.databases,
481+
databases=self._target_manager.cloud_databases,
482482
)
483483
except ValidatorError as exc:
484484
return exc.status_code, exc.headers, exc.response_text
@@ -488,7 +488,7 @@ def get_target(self, request: PreparedRequest) -> _ResponseType:
488488
request_body=_body_bytes(request=request),
489489
request_method=request.method or "",
490490
request_path=request.path_url,
491-
databases=self._target_manager.databases,
491+
databases=self._target_manager.cloud_databases,
492492
)
493493
target_id = request.path_url.split(sep="/")[-1]
494494
target = database.get_target(target_id=target_id)
@@ -544,7 +544,7 @@ def get_duplicates(self, request: PreparedRequest) -> _ResponseType:
544544
request_body=_body_bytes(request=request),
545545
request_method=request.method or "",
546546
request_path=request.path_url,
547-
databases=self._target_manager.databases,
547+
databases=self._target_manager.cloud_databases,
548548
)
549549
except ValidatorError as exc:
550550
return exc.status_code, exc.headers, exc.response_text
@@ -554,7 +554,7 @@ def get_duplicates(self, request: PreparedRequest) -> _ResponseType:
554554
request_body=_body_bytes(request=request),
555555
request_method=request.method or "",
556556
request_path=request.path_url,
557-
databases=self._target_manager.databases,
557+
databases=self._target_manager.cloud_databases,
558558
)
559559
target_id = request.path_url.split(sep="/")[-1]
560560
target = database.get_target(target_id=target_id)
@@ -615,7 +615,7 @@ def update_target(self, request: PreparedRequest) -> _ResponseType:
615615
request_body=_body_bytes(request=request),
616616
request_method=request.method or "",
617617
request_path=request.path_url,
618-
databases=self._target_manager.databases,
618+
databases=self._target_manager.cloud_databases,
619619
)
620620
except ValidatorError as exc:
621621
return exc.status_code, exc.headers, exc.response_text
@@ -625,7 +625,7 @@ def update_target(self, request: PreparedRequest) -> _ResponseType:
625625
request_body=_body_bytes(request=request),
626626
request_method=request.method or "",
627627
request_path=request.path_url,
628-
databases=self._target_manager.databases,
628+
databases=self._target_manager.cloud_databases,
629629
)
630630

631631
target_id = request.path_url.split(sep="/")[-1]
@@ -728,7 +728,7 @@ def target_summary(self, request: PreparedRequest) -> _ResponseType:
728728
request_body=_body_bytes(request=request),
729729
request_method=request.method or "",
730730
request_path=request.path_url,
731-
databases=self._target_manager.databases,
731+
databases=self._target_manager.cloud_databases,
732732
)
733733
except ValidatorError as exc:
734734
return exc.status_code, exc.headers, exc.response_text
@@ -738,7 +738,7 @@ def target_summary(self, request: PreparedRequest) -> _ResponseType:
738738
request_body=_body_bytes(request=request),
739739
request_method=request.method or "",
740740
request_path=request.path_url,
741-
databases=self._target_manager.databases,
741+
databases=self._target_manager.cloud_databases,
742742
)
743743
target_id = request.path_url.split(sep="/")[-1]
744744
target = database.get_target(target_id=target_id)

src/mock_vws/target_manager.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ def add_database(self, database: CloudDatabase) -> None:
4747
"All {key_name}s must be unique. "
4848
'There is already a database with the {key_name} "{value}".'
4949
)
50-
for existing_db in self.databases:
50+
for existing_db in self.cloud_databases:
5151
for existing, new, key_name in (
5252
(
5353
existing_db.server_access_key,
@@ -82,6 +82,6 @@ def add_database(self, database: CloudDatabase) -> None:
8282
self._databases = {*self._databases, database}
8383

8484
@property
85-
def databases(self) -> set[CloudDatabase]:
85+
def cloud_databases(self) -> set[CloudDatabase]:
8686
"""All cloud databases."""
8787
return set(self._databases)

0 commit comments

Comments
 (0)