Merge pull request #87 from fermitools/output_logic

Issue # 83 (output files)

Author: shreyb

ferry_cli/__main__.py

@@ -5,7 +5,7 @@
 import pathlib
 import sys
 import textwrap
-from typing import Any, Dict, Optional, List
+from typing import Any, Dict, Optional, List, Type
 from urllib.parse import urlsplit, urlunsplit, SplitResult
 
 import validators  # pylint: disable=import-error
@@ -49,7 +49,6 @@ def __init__(self: "FerryCLI", config_path: Optional[pathlib.Path]) -> None:
         self.authorizer: Optional["Auth"] = None
         self.ferry_api: Optional["FerryAPI"] = None
         self.parser: Optional["FerryParser"] = None
-
         if config_path is None:
             print(
                 'A configuration file is required to run the Ferry CLI. Please run "ferry-cli" to generate one interactively if one does not already exist.'
@@ -66,10 +65,9 @@ def get_arg_parser(self: "FerryCLI") -> FerryParser:
             description="CLI for Ferry API endpoints", parents=[get_auth_parser()]
         )
         parser.add_argument(
-            "--dryrun",
-            action="store_true",
-            default=False,
-            help="Populate the API call(s) but don't actually run them",
+            "--output",
+            default=None,
+            help="(string) Specifies the path to a file where the output will be stored in JSON format. If a file already exists in the specified path, it will be overritten.",
         )
         parser.add_argument(
             "--filter",
@@ -290,7 +288,9 @@ def parse_description(
             endpoint_description += f"{'':<50} | {line}\n"
         return endpoint_description
 
-    def run(self: "FerryCLI", debug: bool, quiet: bool, extra_args: Any) -> None:
+    def run(
+        self: "FerryCLI", debug: bool, quiet: bool, dryrun: bool, extra_args: Any
+    ) -> None:
         self.parser = self.get_arg_parser()
         args, endpoint_args = self.parser.parse_known_args(extra_args)
 
@@ -300,7 +300,7 @@ def run(self: "FerryCLI", debug: bool, quiet: bool, extra_args: Any) -> None:
 
         if not self.ferry_api:
             self.ferry_api = FerryAPI(
-                base_url=self.base_url, authorizer=self.authorizer, quiet=quiet, dryrun=args.dryrun  # type: ignore
+                base_url=self.base_url, authorizer=self.authorizer, quiet=quiet, dryrun=dryrun  # type: ignore
             )
 
         if args.endpoint:
@@ -310,8 +310,10 @@ def run(self: "FerryCLI", debug: bool, quiet: bool, extra_args: Any) -> None:
                 json_result = self.execute_endpoint(args.endpoint, endpoint_args)
             except Exception as e:
                 raise Exception(f"{e}")
-            if (not quiet) and (not args.dryrun):
-                self.handle_output(json.dumps(json_result, indent=4))
+            if not dryrun:
+                self.handle_output(
+                    json.dumps(json_result, indent=4), args.output, quiet
+                )
 
         elif args.workflow:
             try:
@@ -320,25 +322,59 @@ def run(self: "FerryCLI", debug: bool, quiet: bool, extra_args: Any) -> None:
                 workflow.init_parser()
                 workflow_params, _ = workflow.parser.parse_known_args(endpoint_args)
                 json_result = workflow.run(self.ferry_api, vars(workflow_params))  # type: ignore
-                if (not quiet) and (not args.dryrun):
-                    self.handle_output(json.dumps(json_result, indent=4))
+                if not dryrun:
+                    self.handle_output(
+                        json.dumps(json_result, indent=4), args.output, quiet
+                    )
             except KeyError:
                 raise KeyError(f"Error: '{args.workflow}' is not a supported workflow.")
 
         else:
             self.parser.print_help()
 
-    # TBD if we will use this at all
-    def handle_output(self: "FerryCLI", output: str) -> None:
-        # Don't print excessively long responses - just store them in the result.json file and point to it.
-        if len(output) < 1000:
-            print(f"Response: {output}")
-        else:
-            with open("result.json", "w") as file:
+    def handle_output(
+        self: "FerryCLI", output: str, output_file: str = "", quiet: bool = False
+    ) -> None:
+        def error_raised(
+            exception_type: Type[BaseException],
+            message: str,
+        ) -> None:
+            message = f"{exception_type.__name__}\n" f"{message}"
+            if not quiet:
+                message += f"\nPrinting response instead: {output}"
+            raise exception_type(message)
+
+        if not output_file:
+            if not quiet:
+                print(f"Response: {output}")
+            return
+
+        directory = os.path.dirname(output_file)
+        if directory:
+            try:
+                os.makedirs(directory, exist_ok=True)
+            except PermissionError:
+                error_raised(
+                    PermissionError,
+                    f"Permission denied: Unable to create directory: {directory}",
+                )
+            except OSError as e:
+                error_raised(OSError, f"Error creating directory: {e}")
+        try:
+            with open(output_file, "w") as file:
                 file.write(output)
-            print(
-                f"\nResponse in file: {os.path.abspath(os.environ.get('PWD', ''))}/result.json"
+            if not quiet:
+                print(f"Output file: {output_file}")
+            return
+        except PermissionError:
+            error_raised(
+                PermissionError,
+                f"Permission denied: Unable to write to file: {output_file}",
             )
+        except IOError as e:
+            error_raised(IOError, f"Error writing to file: {e}")
+        except Exception as e:  # pylint: disable=broad-except
+            error_raised(Exception, f"Error: {e}")
 
     @staticmethod
     def _sanitize_base_url(raw_base_url: str) -> str:
@@ -529,19 +565,21 @@ def main() -> None:
             sys.exit(0)
         ferry_cli.authorizer = set_auth_from_args(auth_args)
         if auth_args.update or not os.path.exists(f"{CONFIG_DIR}/swagger.json"):
-            print("Fetching latest swagger file...")
+            if not auth_args.quiet:
+                print("Fetching latest swagger file...")
             ferry_cli.ferry_api = FerryAPI(
                 ferry_cli.base_url, ferry_cli.authorizer, auth_args.quiet
             )
             ferry_cli.ferry_api.get_latest_swagger_file()
-            print("Successfully stored latest swagger file.\n")
+            if not auth_args.quiet:
+                print("Successfully stored latest swagger file.\n")
 
         ferry_cli.endpoints = ferry_cli.generate_endpoints()
-        ferry_cli.run(auth_args.debug, auth_args.quiet, other_args)
+        ferry_cli.run(auth_args.debug, auth_args.quiet, auth_args.dryrun, other_args)
     except (
         Exception  # pylint: disable=broad-except
     ) as e:  # TODO Eventually we want to handle a certain set of exceptions, but this will do for now # pylint: disable=fixme
-        print(f"There was an error querying the FERRY API: {e}")
+        print(f"An error occurred while using the FERRY CLI: {e}")
         sys.exit(1)
 
 

ferry_cli/helpers/auth.py

@@ -179,7 +179,14 @@ def get_auth_parser() -> "FerryParser":
         default=False,
         help="Turn on debugging",
     )
-    auth_parser.add_argument(
+    output_group = auth_parser.add_mutually_exclusive_group(required=False)
+    output_group.add_argument(
+        "--dryrun",
+        action="store_true",
+        default=False,
+        help="Populate the API call(s) but don't actually run them",
+    )
+    output_group.add_argument(
         "-q", "--quiet", action="store_true", default=False, help="Hide output"
     )
     auth_parser.add_argument(
@@ -207,10 +214,12 @@ def get_auth_parser() -> "FerryParser":
 def set_auth_from_args(args: Namespace) -> Auth:
     """Set the auth class based on the given arguments"""
     if args.auth_method == "token":
-        print("\nUsing token auth")
+        if not args.quiet:
+            print("\nUsing token auth")
         return AuthToken(args.token_path, args.debug)
     elif args.auth_method in ["cert", "certificate"]:
-        print("\nUsing cert auth")
+        if not args.quiet:
+            print("\nUsing cert auth")
         return AuthCert(args.cert_path, args.ca_path, args.debug)
     else:
         raise ValueError(

ferry_cli/helpers/supported_workflows/CloneResource.py

@@ -103,19 +103,22 @@ def run(self: "CloneResource", api: "FerryAPI", args: Any) -> Any:  # type: igno
                     "Dryrun: Since no API was actually run, we cannot simulate adding users from the cloned resource to the new resource"
                 )
             else:
-                print(f"Received response, searching for resource: {args['clone']}")
+                if not api.quiet:
+                    print(f"Received response, searching for resource: {args['clone']}")
             resources = [resource for resource in group_json if resource.get("resourcename", "") == args["clone"]]  # type: ignore
             if resources:
                 # Add each user from the original resource into the new resource with the same configurations
                 for resource in resources:
-                    print("Found Resources")
-                    print(resource)
+                    if not api.quiet:
+                        print("Found Resources")
+                        print(resource)
                     for user in resource.get("users", []):
                         user_access_data = dict(user)
                         user_access_data["resourcename"] = args["new_resource"]
-                        print(
-                            f"Updating user access to {args['new_resource']} for {user['username']}"
-                        )
+                        if not api.quiet:
+                            print(
+                                f"Updating user access to {args['new_resource']} for {user['username']}"
+                            )
                         if "status" in user_access_data:
                             del user_access_data["status"]
                         self.verify_output(
@@ -126,10 +129,10 @@ def run(self: "CloneResource", api: "FerryAPI", args: Any) -> Any:  # type: igno
                                 params=user_access_data,
                             ),
                         )
-
-            print(
-                f"Resource '{args['clone']}' has been successful cloned as '{args['new_resource']}'"
-            )
+            if not api.quiet:
+                print(
+                    f"Resource '{args['clone']}' has been successful cloned as '{args['new_resource']}'"
+                )
             sys.exit(0)
         except Exception as e:
             raise e

ferry_cli/helpers/supported_workflows/GetFilteredGroupInfo.py

@@ -26,8 +26,9 @@ def run(self, api, args):  # type: ignore # pylint: disable=arguments-differ
         group_json = self.verify_output(api, api.call_endpoint("getAllGroups"))
         if api.dryrun:
             return []
-        print("Received successful response")
-        print(f"Filtering by groupname: '{args['groupname']}'")
+        if not api.quiet:
+            print("Received successful response")
+            print(f"Filtering by groupname: '{args['groupname']}'")
         group_info = [
             entry for entry in group_json if entry["groupname"] == args["groupname"]
         ]