Skip to content

Commit 22973e8

Browse files
Refactor variable names to clarify cloud databases (#3004)
Rename variables and function names in admin/create_secrets_files.py to make it explicit which databases are cloud databases versus VuMark databases. Changes include: - _create_and_get_database_details -> _create_and_get_cloud_database_details - database_name/license_name -> cloud_database_name/cloud_license_name - database_details -> cloud_database_details - Generated resource names use "cloud" prefix for clarity This addresses the first item in issue #3002 to improve code clarity. Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 1d2cb59 commit 22973e8

File tree

1 file changed

+39
-33
lines changed

1 file changed

+39
-33
lines changed

admin/create_secrets_files.py

Lines changed: 39 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@
2323
)
2424

2525

26-
def _create_and_get_database_details(
26+
def _create_and_get_cloud_database_details(
2727
driver: "WebDriver",
2828
email_address: str,
2929
password: str,
30-
license_name: str,
31-
database_name: str,
30+
cloud_license_name: str,
31+
cloud_database_name: str,
3232
) -> "DatabaseDict":
3333
"""Create a cloud database and get its details.
3434
@@ -40,17 +40,19 @@ def _create_and_get_database_details(
4040
password=password,
4141
)
4242
vws_web_tools.wait_for_logged_in(driver=driver)
43-
vws_web_tools.create_license(driver=driver, license_name=license_name)
43+
vws_web_tools.create_license(
44+
driver=driver, license_name=cloud_license_name
45+
)
4446

4547
vws_web_tools.create_cloud_database(
4648
driver=driver,
47-
database_name=database_name,
48-
license_name=license_name,
49+
database_name=cloud_database_name,
50+
license_name=cloud_license_name,
4951
)
5052

5153
return vws_web_tools.get_database_details(
5254
driver=driver,
53-
database_name=database_name,
55+
database_name=cloud_database_name,
5456
)
5557

5658

@@ -74,19 +76,19 @@ def _create_and_get_vumark_details(
7476

7577

7678
def _generate_secrets_file_content(
77-
database_details: "DatabaseDict",
79+
cloud_database_details: "DatabaseDict",
7880
vumark_details: "VuMarkDatabaseDict",
7981
inactive_database_details: "DatabaseDict",
8082
vumark_target_id: str,
8183
) -> str:
8284
"""Generate the content of a secrets file."""
8385
return textwrap.dedent(
8486
text=f"""\
85-
VUFORIA_TARGET_MANAGER_DATABASE_NAME={database_details["database_name"]}
86-
VUFORIA_SERVER_ACCESS_KEY={database_details["server_access_key"]}
87-
VUFORIA_SERVER_SECRET_KEY={database_details["server_secret_key"]}
88-
VUFORIA_CLIENT_ACCESS_KEY={database_details["client_access_key"]}
89-
VUFORIA_CLIENT_SECRET_KEY={database_details["client_secret_key"]}
87+
VUFORIA_TARGET_MANAGER_DATABASE_NAME={cloud_database_details["database_name"]}
88+
VUFORIA_SERVER_ACCESS_KEY={cloud_database_details["server_access_key"]}
89+
VUFORIA_SERVER_SECRET_KEY={cloud_database_details["server_secret_key"]}
90+
VUFORIA_CLIENT_ACCESS_KEY={cloud_database_details["client_access_key"]}
91+
VUFORIA_CLIENT_SECRET_KEY={cloud_database_details["client_secret_key"]}
9092
9193
INACTIVE_VUFORIA_TARGET_MANAGER_DATABASE_NAME={inactive_database_details["database_name"]}
9294
INACTIVE_VUFORIA_SERVER_ACCESS_KEY={inactive_database_details["server_access_key"]}
@@ -126,8 +128,8 @@ def _create_and_get_inactive_database_details(
126128
driver: "WebDriver",
127129
email_address: str,
128130
password: str,
129-
license_name: str,
130-
database_name: str,
131+
cloud_license_name: str,
132+
cloud_database_name: str,
131133
) -> "DatabaseDict":
132134
"""Create a cloud database, get its details, then delete the license to
133135
make it inactive.
@@ -138,18 +140,22 @@ def _create_and_get_inactive_database_details(
138140
password=password,
139141
)
140142
vws_web_tools.wait_for_logged_in(driver=driver)
141-
vws_web_tools.create_license(driver=driver, license_name=license_name)
143+
vws_web_tools.create_license(
144+
driver=driver, license_name=cloud_license_name
145+
)
142146
vws_web_tools.create_cloud_database(
143147
driver=driver,
144-
database_name=database_name,
145-
license_name=license_name,
148+
database_name=cloud_database_name,
149+
license_name=cloud_license_name,
146150
)
147-
database_details = vws_web_tools.get_database_details(
151+
cloud_database_details = vws_web_tools.get_database_details(
148152
driver=driver,
149-
database_name=database_name,
153+
database_name=cloud_database_name,
154+
)
155+
vws_web_tools.delete_license(
156+
driver=driver, license_name=cloud_license_name
150157
)
151-
vws_web_tools.delete_license(driver=driver, license_name=license_name)
152-
return database_details
158+
return cloud_database_details
153159

154160

155161
def _create_vuforia_resource_names() -> tuple[str, str, str, str]:
@@ -158,8 +164,8 @@ def _create_vuforia_resource_names() -> tuple[str, str, str, str]:
158164
format="%Y-%m-%d-%H-%M-%S",
159165
)
160166
return (
161-
f"my-license-{time}",
162-
f"my-database-{time}",
167+
f"my-cloud-license-{time}",
168+
f"my-cloud-database-{time}",
163169
f"my-vumark-database-{time}",
164170
f"my-vumark-template-{time}",
165171
)
@@ -180,8 +186,8 @@ def main() -> None:
180186
driver=inactive_driver,
181187
email_address=email_address,
182188
password=password,
183-
license_name=f"my-inactive-license-{time}",
184-
database_name=f"my-inactive-database-{time}",
189+
cloud_license_name=f"my-inactive-cloud-license-{time}",
190+
cloud_database_name=f"my-inactive-cloud-database-{time}",
185191
)
186192
inactive_driver.quit()
187193

@@ -199,20 +205,20 @@ def main() -> None:
199205
file = files_to_create[-1]
200206
sys.stdout.write(f"Creating database {file.name}\n")
201207
(
202-
license_name,
203-
database_name,
208+
cloud_license_name,
209+
cloud_database_name,
204210
vumark_database_name,
205211
vumark_template_name,
206212
) = _create_vuforia_resource_names()
207213

208214
try:
209-
sys.stdout.write("Creating database details\n")
210-
database_details = _create_and_get_database_details(
215+
sys.stdout.write("Creating cloud database details\n")
216+
cloud_database_details = _create_and_get_cloud_database_details(
211217
driver=driver,
212218
email_address=email_address,
213219
password=password,
214-
license_name=license_name,
215-
database_name=database_name,
220+
cloud_license_name=cloud_license_name,
221+
cloud_database_name=cloud_database_name,
216222
)
217223
sys.stdout.write("Creating VuMark database details\n")
218224
vumark_details = _create_and_get_vumark_details(
@@ -235,7 +241,7 @@ def main() -> None:
235241
driver = None
236242

237243
file_contents = _generate_secrets_file_content(
238-
database_details=database_details,
244+
cloud_database_details=cloud_database_details,
239245
vumark_details=vumark_details,
240246
inactive_database_details=inactive_database_details,
241247
vumark_target_id=vumark_target_id,

0 commit comments

Comments
 (0)