besapi 3.3.2__tar.gz → 3.4.1__tar.gz

{besapi-3.3.2/src/besapi.egg-info → besapi-3.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: besapi
-Version: 3.3.2
+Version: 3.4.1
 Summary: Library for working with the BigFix REST API
 Home-page: https://github.com/jgstew/besapi
 Author: Matt Hansen, James Stewart

{besapi-3.3.2 → besapi-3.4.1}/src/besapi/besapi.py

@@ -29,7 +29,7 @@ import requests
 from lxml import etree, objectify
 from pkg_resources import resource_filename
 
-__version__ = "3.3.2"
+__version__ = "3.4.1"
 
 besapi_logger = logging.getLogger("besapi")
 

{besapi-3.3.2 → besapi-3.4.1}/src/besapi/plugin_utilities.py

@@ -1,12 +1,15 @@
 """This is a set of utility functions for use in multiple plugins"""
 
 import argparse
+import getpass
 import logging
 import logging.handlers
 import ntpath
 import os
 import sys
 
+import besapi
+
 
 def get_invoke_folder(verbose=0):
     """Get the folder the script was invoked from"""
@@ -83,27 +86,25 @@ def setup_plugin_argparse(plugin_args_required=False):
     return arg_parser
 
 
-def setup_plugin_logging(log_file_name="", verbose=0, console=True):
+def setup_plugin_logging(log_file_path="", verbose=0, console=True):
     """setup logging for plugin use"""
-    # get folder the script was invoked from:
-    invoke_folder = get_invoke_folder(verbose)
 
-    if not log_file_name or log_file_name == "":
-        log_file_name = get_invoke_file_name() + ".log"
+    if not log_file_path or log_file_path == "":
+        log_file_path = os.path.join(
+            get_invoke_folder(verbose), get_invoke_file_name(verbose) + ".log"
+        )
 
     # set different log levels:
     log_level = logging.WARNING
     if verbose:
         log_level = logging.INFO
+        print("INFO: Log File Path: %s", log_file_path)
     if verbose > 1:
         log_level = logging.DEBUG
 
-    # get path to put log file in:
-    log_filename = os.path.join(invoke_folder, log_file_name)
-
     handlers = [
         logging.handlers.RotatingFileHandler(
-            log_filename, maxBytes=5 * 1024 * 1024, backupCount=1
+            log_file_path, maxBytes=5 * 1024 * 1024, backupCount=1
         )
     ]
 
@@ -120,13 +121,65 @@ def setup_plugin_logging(log_file_name="", verbose=0, console=True):
     )
 
 
-# if __name__ == "__main__":
-#     print(get_invoke_folder())
-#     print(get_invoke_file_name())
-#     setup_plugin_logging(console=True)
-#     logging.error("test logging")
-#     parser = setup_plugin_argparse()
-#     # allow unknown args to be parsed instead of throwing an error:
-#     args, _unknown = parser.parse_known_args()
+def get_besapi_connection(args):
+    """get connection to besapi using either args or config file if args not provided"""
+
+    password = args.password
+
+    # if user was provided as arg but password was not:
+    if args.user and not password:
+        logging.warning("Password was not provided, provide REST API password.")
+        print("Password was not provided, provide REST API password:")
+        password = getpass.getpass()
+
+    if args.user:
+        logging.debug("REST API Password Length: %s", len(password))
+
+    # process args, setup connection:
+    rest_url = args.rest_url
+
+    # normalize url to https://HostOrIP:52311
+    if rest_url and rest_url.endswith("/api"):
+        rest_url = rest_url.replace("/api", "")
+
+    # attempt bigfix connection with provided args:
+    if args.user and password:
+        try:
+            bes_conn = besapi.besapi.BESConnection(args.user, password, rest_url)
+        except (
+            AttributeError,
+            ConnectionRefusedError,
+            besapi.besapi.requests.exceptions.ConnectionError,
+        ):
+            logging.exception(
+                "connection to `%s` failed, attempting `%s` instead",
+                rest_url,
+                args.besserver,
+            )
+            try:
+                # print(args.besserver)
+                bes_conn = besapi.besapi.BESConnection(
+                    args.user, password, args.besserver
+                )
+            # handle case where args.besserver is None
+            # AttributeError: 'NoneType' object has no attribute 'startswith'
+            except AttributeError:
+                logging.exception("----- ERROR: BigFix Connection Failed ------")
+                logging.exception(
+                    "attempts to connect to BigFix using rest_url and besserver both failed"
+                )
+                return None
+            except BaseException as err:
+                # always log error and stop the current process
+                logging.exception("ERROR: %s", err)
+                logging.exception(
+                    "----- ERROR: BigFix Connection Failed! Unknown reason ------"
+                )
+                return None
+    else:
+        logging.info(
+            "attempting connection to BigFix using config file method as user command arg was not provided"
+        )
+        bes_conn = besapi.besapi.get_bes_conn_using_config_file()
 
-#     logging.error(args)
+    return bes_conn

{besapi-3.3.2 → besapi-3.4.1/src/besapi.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: besapi
-Version: 3.3.2
+Version: 3.4.1
 Summary: Library for working with the BigFix REST API
 Home-page: https://github.com/jgstew/besapi
 Author: Matt Hansen, James Stewart

{besapi-3.3.2 → besapi-3.4.1}/tests/tests.py

@@ -25,6 +25,7 @@ if not args.test_pip:
     sys.path.reverse()
 
 import besapi
+import besapi.plugin_utilities
 
 print("besapi version: " + str(besapi.besapi.__version__))
 
@@ -151,4 +152,13 @@ if bigfix_cli.bes_conn:
         bes_conn = besapi.besapi.get_bes_conn_using_config_file()
         print("login succeeded:", bes_conn.login())
 
+# test plugin_utilities:
+print(besapi.plugin_utilities.get_invoke_folder())
+print(besapi.plugin_utilities.get_invoke_file_name())
+# the following doesn't seem to work in python 3.7:
+# besapi.plugin_utilities.setup_plugin_logging(console=True)
+parser = besapi.plugin_utilities.setup_plugin_argparse(plugin_args_required=False)
+# allow unknown args to be parsed instead of throwing an error:
+args, _unknown = parser.parse_known_args()
+
 sys.exit(0)