Dev/jgough/8310 consistent error code (#80)

Make run responsible for return error codes consistently

Also make main responsible for actually sys exiting

AB#8310

Author: honourfish

archivist_samples/c2pa/main.py

@@ -3,6 +3,8 @@
 # pylint:  disable=missing-docstring
 
 import logging
+from sys import exit as sys_exit
+from sys import stdout as sys_stdout
 
 from ..testing.archivist_parser import common_parser
 from ..testing.parser import common_endpoint
@@ -27,4 +29,8 @@ def main():
 
     poc = common_endpoint("document", args)
 
-    run(poc, args)
+    err_code = run(poc, args)
+
+    if err_code != 0:
+        parser.print_help(sys_stdout)
+        sys_exit(err_code)

archivist_samples/c2pa/run.py

@@ -5,7 +5,6 @@
 
 import logging
 
-from sys import exit as sys_exit
 from archivist import about
 
 from .c2pa import C2PADocument, upload_attachment
@@ -15,6 +14,9 @@
 
 
 def run(arch, args):
+    """
+    runs the sample and returns the system error code.
+    """
     LOGGER.info("Using version %s of rkvst-archivist", about.__version__)
     LOGGER.info("Fetching use case test assets namespace %s", args.namespace)
 
@@ -56,7 +58,7 @@ def run(arch, args):
             "C2PA Image",
             c2pa_document.asset["identity"],
         )
-        sys_exit(0)
+        return 0
 
     LOGGER.info("C2PA Document Created (Identity=%s)", c2pa_document.asset["identity"])
 
@@ -179,4 +181,4 @@ def run(arch, args):
         },
     )
     LOGGER.info("V1.3.ME published")
-    sys_exit(0)
+    return 0

archivist_samples/document/main.py

@@ -3,6 +3,8 @@
 # pylint:  disable=missing-docstring
 
 import logging
+from sys import exit as sys_exit
+from sys import stdout as sys_stdout
 
 from ..testing.archivist_parser import common_parser
 from ..testing.parser import common_endpoint
@@ -27,4 +29,8 @@ def main():
 
     poc = common_endpoint("document", args)
 
-    run(poc, args)
+    err_code = run(poc, args)
+
+    if err_code != 0:
+        parser.print_help(sys_stdout)
+        sys_exit(err_code)

archivist_samples/document/run.py

@@ -5,7 +5,6 @@
 
 import logging
 
-from sys import exit as sys_exit
 from archivist import about
 
 from .document import Document, upload_attachment
@@ -15,6 +14,9 @@
 
 
 def run(arch, args):
+    """
+    runs the sample and returns the system error code.
+    """
     LOGGER.info("Using version %s of rkvst-archivist", about.__version__)
     LOGGER.info("Fetching use case test assets namespace %s", args.namespace)
 
@@ -55,11 +57,8 @@ def run(arch, args):
             "Asteroid Mining Inc Invoice",
             document.asset["identity"],
         )
-        LOGGER.info(
-            "Public URL: %s/archivist/public%s", args.url, document.asset["identity"]
-        )
 
-        sys_exit(0)
+        return 0
 
     LOGGER.info("Invoice Asset Created (Identity=%s)", document.asset["identity"])
 
@@ -104,4 +103,4 @@ def run(arch, args):
     )
     LOGGER.info("V3 published, with discount applied")
 
-    sys_exit(0)
+    return 0

archivist_samples/door_entry/main.py

@@ -69,7 +69,8 @@ def main():
 
     arch = common_endpoint("door_entry", args)
 
-    run(arch, args)
+    err_code = run(arch, args)
 
-    parser.print_help(sys_stdout)
-    sys_exit(1)
+    if err_code != 0:
+        parser.print_help(sys_stdout)
+        sys_exit(err_code)

archivist_samples/door_entry/run.py

@@ -8,7 +8,6 @@
 from copy import copy
 import logging
 from tempfile import TemporaryFile
-from sys import exit as sys_exit
 import uuid
 
 from archivist import about
@@ -573,6 +572,9 @@ def open_door(doors, doorid, cards, cardid):
 
 
 def run(arch, args):
+    """
+    runs the sample and returns the system error code.
+    """
     LOGGER.info("Using version %s of rkvst-archivist", about.__version__)
     LOGGER.info("Fetching use case test assets namespace %s", args.namespace)
 
@@ -606,15 +608,15 @@ def run(arch, args):
         if args.wait_for_confirmation:
             cards.assets.wait_for_confirmed()
 
-        sys_exit(0)
+        return 0
 
     if number_of_doors == 0:
         LOGGER.error("Could not find door entry assets. Please create them first.")
-        sys_exit(1)
+        return 1
 
     if number_of_cards == 0:
         LOGGER.error("Could not find card assets. Please create them first.")
-        sys_exit(1)
+        return 1
 
     # Show info about the system ?
     if args.listspec:
@@ -632,10 +634,12 @@ def run(arch, args):
             list_usage(doors, cards, spec)
 
         LOGGER.info("List %s FINISH", spec)
-        sys_exit(0)
+        return 0
 
     # Open a door using a specified card ?
     if args.doorid_cardid:
         doorid, cardid = args.doorid_cardid
         open_door(doors, doorid, cards, cardid)
-        sys_exit(0)
+        return 0
+
+    return 1

archivist_samples/estate_info/main.py

@@ -22,13 +22,15 @@
 
 
 def run(poc, args):
-    """logic goes here"""
+    """
+    runs the sample and returns the system error code.
+    """
     LOGGER.info("Using version %s of rkvst-archivist", about.__version__)
     if args.quick_count:
         LOGGER.info("Number of events is %d", poc.events.count())
         LOGGER.info("Number of assets is %d", poc.assets.count())
         LOGGER.info("Number of locations is %d", poc.locations.count())
-        sys_exit(0)
+        return 0
 
     if args.double_check:
         # for around 550 events and 250 assets this can take about a 90s...
@@ -72,7 +74,9 @@ def run(poc, args):
         )
 
         LOGGER.info("Performing double-check... FINISH")
-        sys_exit(0)
+        return 0
+
+    return 1
 
 
 def main():
@@ -101,7 +105,8 @@ def main():
 
     poc = common_endpoint("estate_info", args)
 
-    run(poc, args)
+    err_code = run(poc, args)
 
-    parser.print_help(sys_stdout)
-    sys_exit(1)
+    if err_code != 0:
+        parser.print_help(sys_stdout)
+        sys_exit(err_code)

archivist_samples/sbom_document/main.py

@@ -3,6 +3,8 @@
 # pylint:  disable=missing-docstring
 
 import logging
+from sys import exit as sys_exit
+from sys import stdout as sys_stdout
 
 from ..testing.archivist_parser import common_parser
 from ..testing.parser import common_endpoint
@@ -29,4 +31,8 @@ def main():
 
     arch = common_endpoint("sbom", args)
 
-    run(arch, args)
+    err_code = run(arch, args)
+
+    if err_code != 0:
+        parser.print_help(sys_stdout)
+        sys_exit(err_code)

archivist_samples/sbom_document/run.py

@@ -3,7 +3,6 @@
 # pylint:  disable=missing-docstring
 
 import logging
-from sys import exit as sys_exit
 
 from archivist import about
 
@@ -14,6 +13,9 @@
 
 
 def run(arch, args):
+    """
+    runs the sample and returns the system error code.
+    """
     LOGGER.info("Using version %s of rkvst-archivist", about.__version__)
     LOGGER.info("Fetching use case test assets namespace %s", args.namespace)
 
@@ -44,7 +46,7 @@ def run(arch, args):
 
     if package.existed:
         LOGGER.info("Software Package already Created: %s", package_name)
-        sys_exit(0)
+        return 0
 
     LOGGER.info("Software Package Created (Identity=%s)", package.asset["identity"])
 
@@ -127,4 +129,4 @@ def run(arch, args):
         },
     )
     LOGGER.info("Release registered.")
-    sys_exit(0)
+    return 0

archivist_samples/signed_records/main.py

@@ -307,7 +307,13 @@ def print_history(archivist, asset_name):
 
 # Main app loop
 ###############
+
+
+# pylint: disable=too-many-return-statements
 def run(arch, args):
+    """
+    runs the sample and returns the system error code.
+    """
     LOGGER.info("Using version %s of rkvst-archivist", about.__version__)
     if args.namespace:
         asset_name = "-".join(["signed-records", args.namespace])
@@ -328,11 +334,11 @@ def run(arch, args):
                 " Please choose a different name to create.",
                 asset_name,
             )
-            sys_exit(1)
+            return 1
 
         LOGGER.info("Generate crypto asset '%s'", asset_name)
         generate_crypto_asset(arch, asset_name)
-        sys_exit(0)
+        return 0
 
     if args.sign_message:
         if not asset_exists(arch, asset_name):
@@ -341,11 +347,11 @@ def run(arch, args):
                 " Please choose a different name to create.",
                 asset_name,
             )
-            sys_exit(1)
+            return 1
 
         LOGGER.info("Submit signed evidence '%s'", asset_name)
         submit_signed_evidence(arch, asset_name, args.sign_message, False)
-        sys_exit(0)
+        return 0
 
     if args.bad_sign_message:
         if not asset_exists(arch, asset_name):
@@ -354,11 +360,11 @@ def run(arch, args):
                 "Please choose the correct name or create it first.",
                 asset_name,
             )
-            sys_exit(1)
+            return 1
 
         LOGGER.info("Submit badly signed evidence %s", asset_name)
         submit_signed_evidence(arch, asset_name, args.bad_sign_message, True)
-        sys_exit(0)
+        return 0
 
     if args.check_sigs:
         if not asset_exists(arch, asset_name):
@@ -367,11 +373,11 @@ def run(arch, args):
                 "Please choose the correct name or create it first.",
                 asset_name,
             )
-            sys_exit(1)
+            return 1
 
     LOGGER.info("Check %s", asset_name)
     print_history(arch, asset_name)
-    sys_exit(0)
+    return 0
 
 
 def main():
@@ -427,7 +433,8 @@ def main():
 
     arch = common_endpoint("signed_records", args)
 
-    run(arch, args)
+    err_code = run(arch, args)
 
-    parser.print_help(sys_stdout)
-    sys_exit(1)
+    if err_code != 0:
+        parser.print_help(sys_stdout)
+        sys_exit(err_code)