feat: Use of client Environment

Used client 1.13.3

Author: Alan Christie

README.md

@@ -13,27 +13,28 @@ set of examples so that users can create their own utilities.
 >   Most tools need to be executed by a user with admin privileges.
 
 ## Usage
-You need to create a number of environment variables that
-control authentication and destination hosts. The template shell-script
-`setenv-template.sh` is a guide to what you need. Copy this to `setenv.sh`,
-edit it, and use that to conveniently set many of the variables for the tools: -
+The tools utilise the Pyhon client's `Environment` module, which expects
+you to create an `Envrionments` file - a YAML file that defines the
+variables used to connect to the corresponding installation. The environments
+file (typically `~/.squonk2/environmemnts`) allows you to creat variables
+for multiple installations identified by name.
 
-    source setenv.sh
+See the **Environment module** section of the [Squonk2 Python Client].
 
 Using a python 3 virtual environment install the project requirements
 and then run the appropriate tool: -
 
     pip install --upgrade pip
     pip install -r requirements.txt
 
-    ./tools/delete-test-projects.py
+    ./tools/delete-test-projects.py dls-test
 
 As a general style any tools that have destructive actions rely on the use of
 a `--do-it` option to prevent any accidental damage. Therefore, to _actually_
 delete Data Manager projects add `--do-it` to the `delete-test-projects`
 command: -
 
-    ./tools/delete-test-projects.py --do-it
+    ./tools/delete-test-projects.py dls-test --do-it
 
 All test tools use `argparse` so adding `--help` to the command will
 display the tool's help.
@@ -45,6 +46,8 @@ You should find the following tools in this repository: -
 - `delete-all-instances`
 - `delete-old-instances`
 - `delete-test-projects`
+- `load-er`
+- `save-er`
 
 ---
 

requirements.txt

@@ -1,4 +1,4 @@
-im-squonk2-client >= 1.9.3, < 2.0.0
+im-squonk2-client >= 1.13.3, < 2.0.0
 python-dateutil == 2.8.2
 rich == 12.5.1
 pyyaml == 6.0

tools/coins.py

@@ -12,8 +12,7 @@
 from rich.console import Console
 from squonk2.auth import Auth
 from squonk2.as_api import AsApi, AsApiRv
-
-from common import Env, get_env
+from squonk2.environment import Environment
 
 urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
 
@@ -26,16 +25,16 @@ def main(c_args: argparse.Namespace) -> None:
 
     console = Console()
 
-    env: Optional[Env] = get_env()
-    if not env:
-        return
+    _ = Environment.load()
+    env: Environment = Environment(c_args.environment)
+    AsApi.set_api_url(env.as_api)
 
     token: str = Auth.get_access_token(
         keycloak_url=env.keycloak_url,
         keycloak_realm=env.keycloak_realm,
         keycloak_client_id=env.keycloak_as_client_id,
-        username=env.keycloak_user,
-        password=env.keycloak_user_password,
+        username=env.admin_user,
+        password=env.admin_password,
     )
 
     # Get the product details.
@@ -187,6 +186,7 @@ def _calculate_adjusted_coins(total_coins: Decimal,
         prog="coins",
         description="Calculates a Product's Coin Charges (actual and predicted)"
     )
+    parser.add_argument('environment', type=str, help='The environment name')
     parser.add_argument('product', type=str, help='The Product UUID')
     parser.add_argument(
         '--verbose',

tools/common.py

@@ -15,48 +15,3 @@
     "dmit-user-d",
     "dmit-user-admin",
 ]
-
-# A namedtuple for the environment.
-# It contains vales, extracted from the following variables: -
-# - SQUONK2_DMAPI_URL
-# - SQUONK2_ASAPI_URL
-# - SQUONK2_KEYCLOAK_URL
-# - SQUONK2_KEYCLOAK_REALM
-# - SQUONK2_KEYCLOAK_AS_CLIENT_ID
-# - SQUONK2_KEYCLOAK_DM_CLIENT_ID
-# - SQUONK2_KEYCLOAK_USER
-# - SQUONK2_KEYCLOAK_USER_PASSWORD
-Env: namedtuple = namedtuple(
-    "Env",
-    [
-        "dmapi_url",
-        "asapi_url",
-        "keycloak_url",
-        "keycloak_realm",
-        "keycloak_as_client_id",
-        "keycloak_dm_client_id",
-        "keycloak_user",
-        "keycloak_user_password",
-    ],
-)
-
-
-def get_env() -> Optional[Env]:
-    """Get the environment variables.
-    All must be defined.
-    """
-    env: Optional[Env] = None
-    try:
-        env: Env = Env(
-            dmapi_url=os.environ["SQUONK2_DMAPI_URL"],
-            asapi_url=os.environ["SQUONK2_ASAPI_URL"],
-            keycloak_url=os.environ["SQUONK2_KEYCLOAK_URL"],
-            keycloak_realm=os.environ["SQUONK2_KEYCLOAK_REALM"],
-            keycloak_as_client_id=os.environ["SQUONK2_KEYCLOAK_AS_CLIENT_ID"],
-            keycloak_dm_client_id=os.environ["SQUONK2_KEYCLOAK_DM_CLIENT_ID"],
-            keycloak_user=os.environ["SQUONK2_KEYCLOAK_USER"],
-            keycloak_user_password=os.environ["SQUONK2_KEYCLOAK_USER_PASSWORD"],
-        )
-    except KeyError as e:
-        print(f"ERROR: You need to define {e}")
-    return env

tools/delete-all-instances.py

@@ -14,26 +14,25 @@
 from typing import Dict, List, Optional, Tuple
 import urllib3
 
-from common import Env, get_env
-
 from squonk2.auth import Auth
 from squonk2.dm_api import DmApi, DmApiRv
+from squonk2.environment import Environment
 
 urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
 
 
 def main(c_args: argparse.Namespace) -> None:
 
-    env: Optional[Env] = get_env()
-    if not env:
-        return
+    _ = Environment.load()
+    env: Environment = Environment(c_args.environment)
+    DmApi.set_api_url(env.dm_api)
 
     token: str = Auth.get_access_token(
         keycloak_url=env.keycloak_url,
         keycloak_realm=env.keycloak_realm,
         keycloak_client_id=env.keycloak_dm_client_id,
-        username=env.keycloak_user,
-        password=env.keycloak_user_password,
+        username=env.admin_user,
+        password=env.admin_password,
     )
 
     # The collection of instances
@@ -94,6 +93,7 @@ def main(c_args: argparse.Namespace) -> None:
     # Build a command-line parser and parse it...
     parser = argparse.ArgumentParser(
         description='Delete All DM Project Instances')
+    parser.add_argument('environment', type=str, help='The environment name')
     parser.add_argument(
         '--do-it',
         help='Set to actually delete, if not set the instances are listed',

tools/delete-old-instances.py

@@ -15,24 +15,23 @@
 from dateutil.parser import parse
 from squonk2.auth import Auth
 from squonk2.dm_api import DmApi, DmApiRv
-
-from common import Env, get_env
+from squonk2.environment import Environment
 
 urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
 
 
 def main(c_args: argparse.Namespace) -> None:
 
-    env: Optional[Env] = get_env()
-    if not env:
-        return
+    _ = Environment.load()
+    env: Environment = Environment(c_args.environment)
+    DmApi.set_api_url(env.dm_api)
 
     token: str = Auth.get_access_token(
         keycloak_url=env.keycloak_url,
         keycloak_realm=env.keycloak_realm,
         keycloak_client_id=env.keycloak_dm_client_id,
-        username=env.keycloak_user,
-        password=env.keycloak_user_password,
+        username=env.admin_user,
+        password=env.admin_password,
     )
 
     # To see everything we need to become admin...
@@ -88,6 +87,7 @@ def main(c_args: argparse.Namespace) -> None:
     # Build a command-line parser and parse it...
     parser = argparse.ArgumentParser(
         description='Delete All Old DM Project Instances')
+    parser.add_argument('environment', type=str, help='The environment name')
     parser.add_argument(
         '--age',
         nargs='?',

tools/delete-test-projects.py

@@ -7,26 +7,27 @@
 from typing import Any, Dict, List, Optional
 import urllib3
 
-from common import Env, get_env, TEST_UNIT, TEST_USER_NAMES
-
 from squonk2.auth import Auth
 from squonk2.dm_api import DmApi, DmApiRv
+from squonk2.environment import Environment
+
+from common import TEST_UNIT, TEST_USER_NAMES
 
 urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
 
 
 def main(c_args: argparse.Namespace) -> None:
-    """Main function."""
-    env: Optional[Env] = get_env()
-    if not env:
-        return
+
+    _ = Environment.load()
+    env: Environment = Environment(c_args.environment)
+    DmApi.set_api_url(env.dm_api)
 
     token: str = Auth.get_access_token(
         keycloak_url=env.keycloak_url,
         keycloak_realm=env.keycloak_realm,
         keycloak_client_id=env.keycloak_dm_client_id,
-        username=env.keycloak_user,
-        password=env.keycloak_user_password,
+        username=env.admin_user,
+        password=env.admin_password,
     )
 
     ret_val: DmApiRv = DmApi.get_available_projects(token)
@@ -85,6 +86,7 @@ def main(c_args: argparse.Namespace) -> None:
     parser = argparse.ArgumentParser(
         description="Delete all Projects owned by test users"
     )
+    parser.add_argument('environment', type=str, help='The environment name')
     parser.add_argument(
         "--do-it",
         help="Set to actually delete, if not set the projects are listed",

tools/load-er.py

@@ -10,10 +10,9 @@
 from rich.console import Console
 from squonk2.auth import Auth
 from squonk2.dm_api import DmApi, DmApiRv
+from squonk2.environment import Environment
 import yaml
 
-from common import Env, get_env
-
 urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
 
 
@@ -22,16 +21,16 @@ def main(c_args: argparse.Namespace) -> None:
 
     console = Console()
 
-    env: Optional[Env] = get_env()
-    if not env:
-        return
+    _ = Environment.load()
+    env: Environment = Environment(c_args.environment)
+    DmApi.set_api_url(env.dm_api)
 
     token: str = Auth.get_access_token(
         keycloak_url=env.keycloak_url,
         keycloak_realm=env.keycloak_realm,
         keycloak_client_id=env.keycloak_dm_client_id,
-        username=env.keycloak_user,
-        password=env.keycloak_user_password,
+        username=env.admin_user,
+        password=env.admin_password,
     )
 
     # Just read the list from the chosen file
@@ -56,6 +55,7 @@ def main(c_args: argparse.Namespace) -> None:
         prog="load-er",
         description="Loads exchange rates (from a YAML file)"
     )
+    parser.add_argument('environment', type=str, help='The environment name')
     parser.add_argument('file', type=str, help='The source file')
     args: argparse.Namespace = parser.parse_args()
 

tools/save-er.py

@@ -5,35 +5,34 @@
 import argparse
 from pathlib import Path
 import sys
-from typing import Optional
 import urllib3
 
 from rich.console import Console
 from squonk2.auth import Auth
 from squonk2.dm_api import DmApi, DmApiRv
+from squonk2.environment import Environment
 import yaml
 
-from common import Env, get_env
-
 urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
 
 
 def main(c_args: argparse.Namespace) -> None:
     """Main function."""
 
-    env: Optional[Env] = get_env()
-    if not env:
-        return
-
     console = Console()
 
+    _ = Environment.load()
+    env: Environment = Environment(c_args.environment)
+    DmApi.set_api_url(env.dm_api)
+
     token: str = Auth.get_access_token(
         keycloak_url=env.keycloak_url,
         keycloak_realm=env.keycloak_realm,
         keycloak_client_id=env.keycloak_dm_client_id,
-        username=env.keycloak_user,
-        password=env.keycloak_user_password,
+        username=env.admin_user,
+        password=env.admin_password,
     )
+    console.log(token)
 
     er_rv: DmApiRv = DmApi.get_job_exchange_rates(token)
     if not er_rv.success:
@@ -75,6 +74,7 @@ def main(c_args: argparse.Namespace) -> None:
         prog="save-er",
         description="Saves existing exchange rates (to a YAML file)"
     )
+    parser.add_argument('environment', type=str, help='The environment name')
     parser.add_argument('file', type=str, help='The destination file')
     args: argparse.Namespace = parser.parse_args()