fix: Better load-cr utility

Now reports progress and Jobs that have no rates
More 'visual'
Needs requirement update

Author: Alan Christie

requirements.txt

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

tools/load-er.py

@@ -16,7 +16,7 @@
 urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
 
 
-def main(c_args: argparse.Namespace) -> None:
+def main(c_args: argparse.Namespace, filename: StopIteration) -> None:
     """Main function."""
 
     console = Console()
@@ -33,23 +33,65 @@ def main(c_args: argparse.Namespace) -> None:
         password=env.admin_password,
     )
 
-    filename: str = c_args.file
-    if not filename.endswith('.yaml'):
-        filename += '.yaml'
-
     # Just read the list from the chosen file
     file_content: str = Path(filename).read_text(encoding='utf8')
     rates: List[Dict[str, Any]] = yaml.load(file_content, Loader=yaml.FullLoader)
-    er_rv: DmApiRv = DmApi.set_job_exchange_rates(token, rates=rates)
-    if not er_rv.success:
-        console.log(f'[bold red]ERROR[/bold red] {er_rv.msg["error"]}')
-        sys.exit(1)
+    # Load the rates one at a time (to handle any errors gracefully)
+    num_rates: int = 0
+    num_rates_failed: int = 0
+    for rate in rates:
+        # A rate must have a collection, job and version
+        collection: str = rate.get('collection')
+        if not collection:
+            console.log(':boom: File has a rate without a collection')
+            sys.exit(1)
+        job: str = rate.get('job')
+        if not job:
+            console.log(':boom:  File has a rate without a job')
+            sys.exit(1)
+        version: str = rate.get('version')
+        if not version:
+            console.log(':boom: File has a rate without a version')
+            sys.exit(1)
+        rate_value: str = rate.get('rate')
+        if not rate_value:
+            console.log(':boom: File has a rate without a rate value')
+            sys.exit(1)
+        # Now try and set the rate...
+        er_rv: DmApiRv = DmApi.set_job_exchange_rates(token, rates=rate)
+        if er_rv.success:
+            num_rates += 1
+            emoji = ':white_check_mark:'
+        else:
+            num_rates_failed += 1
+            emoji = ':cross_mark:'
+        # Log
+        console.log(f'{emoji} {collection}/{job}/{version}'
+                    f' :moneybag:[gold3]{rate_value}[/gold3]')
+
+    # Now report all the Jobs that still have no rates
+    er_rv: DmApiRv = DmApi.get_job_exchange_rates(token, only_undefined=True)
+    num_jobs_without_rate: int = 0
+    for job in er_rv.msg['exchange_rates']:
+        if num_jobs_without_rate == 0:
+            console.log('[bold dark_orange]WARNING Some Jobs have no rates...[/bold dark_orange]')
+        num_jobs_without_rate += 1
+        console.log(f':orange_circle: {job["collection"]}/{job["job"]}/{job["version"]}')
 
-    num_rates: int = len(rates)
+    # Summary
     if num_rates:
-        console.log(f'Loaded {num_rates}')
-    else:
-        console.log('Loaded [bold red]nothing[/bold red]')
+        console.log(f'Job rates loaded {num_rates}')
+    # Error states
+    if num_rates_failed:
+        console.log(f'Job rate failures {num_rates_failed}')
+    if num_jobs_without_rate:
+        console.log(f'Jobs without rates {num_jobs_without_rate}')
+    if not num_rates and not num_rates_failed:
+        console.log('Loaded [bold red1]nothing[/bold red1]')
+
+    # Error states
+    if num_rates_failed or not num_rates and not num_rates_failed:
+        sys.exit(1)
 
 
 if __name__ == "__main__":
@@ -63,8 +105,12 @@ def main(c_args: argparse.Namespace) -> None:
     parser.add_argument('file', type=str, help='The source file')
     args: argparse.Namespace = parser.parse_args()
 
+    filename: str = args.file
+    if not filename.endswith('.yaml'):
+        filename += '.yaml'
+
     # File must exist
-    if not Path(args.file).is_file():
-        parser.error("File does not exist")
+    if not Path(filename).is_file():
+        parser.error(f"File '{filename}' does not exist")
 
-    main(args)
+    main(args, filename)