Merge pull request #502 from VWS-Python/env-var-format

Add option to format database details as env vars, for use with VWS-P…

Author: adamtheturtle

admin/update_cli_tests.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+# There are CLI tests which check that --help output for various commands is
+# as expected.
+#
+# Expected output is stored in files.
+# This script updates those files.
+#
+# The expected use of this script:
+#  * Make a change which changes expected help text for CLI commands
+#  * Run this script
+#  * Inspect the diff to check that changes are as expected
+#  * Commit and push
+
+set -euxo pipefail
+
+export FIX_CLI_TESTS=1
+
+mkdir -p tests/help_outputs
+git rm -f tests/help_outputs/*.txt || true
+pytest tests/test_help.py || true
+git add tests/help_outputs/*.txt

pyproject.toml

@@ -107,6 +107,8 @@ ignore_path = [
 
 ignore = [
     "*.enc",
+    "admin",
+    "admin/**",
     "readthedocs.yaml",
     "CHANGELOG.rst",
     "CODE_OF_CONDUCT.rst",

src/vws_web_tools/__init__.py

@@ -309,10 +309,13 @@ def create_vws_database(
 @click.option("--database-name", required=True)
 @click.option("--email-address", envvar="VWS_EMAIL_ADDRESS", required=True)
 @click.option("--password", envvar="VWS_PASSWORD", required=True)
+@click.option("--env-var-format", is_flag=True)
 def show_database_details(
     database_name: str,
     email_address: str,
     password: str,
+    *,
+    env_var_format: bool,
 ) -> None:  # pragma: no cover
     """
     Show the details of a database.
@@ -322,7 +325,19 @@ def show_database_details(
     wait_for_logged_in(driver=driver)
     details = get_database_details(driver=driver, database_name=database_name)
     driver.close()
-    click.echo(yaml.dump(details), nl=False)
+    if env_var_format:
+        env_var_format_details = {
+            "VUFORIA_TARGET_MANAGER_DATABASE_NAME": details["database_name"],
+            "VUFORIA_SERVER_ACCESS_KEY": details["server_access_key"],
+            "VUFORIA_SERVER_SECRET_KEY": details["server_secret_key"],
+            "VUFORIA_CLIENT_ACCESS_KEY": details["client_access_key"],
+            "VUFORIA_CLIENT_SECRET_KEY": details["client_secret_key"],
+        }
+
+        for key, value in env_var_format_details.items():
+            click.echo(f"{key}={value}")
+    else:
+        click.echo(yaml.dump(details), nl=False)
 
 
 vws_web_tools_group.add_command(create_vws_database)

tests/help_outputs/vws-show-database-details.txt

@@ -6,4 +6,5 @@ Options:
   --database-name TEXT  [required]
   --email-address TEXT  [required]
   --password TEXT       [required]
+  --env-var-format
   --help                Show this message and exit.