besapi 3.2.6__tar.gz → 3.3.3__tar.gz

{besapi-3.2.6/src/besapi.egg-info → besapi-3.3.3}/PKG-INFO

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

{besapi-3.2.6 → besapi-3.3.3}/src/besapi/besapi.py

@@ -29,7 +29,7 @@ import requests
 from lxml import etree, objectify
 from pkg_resources import resource_filename
 
-__version__ = "3.2.6"
+__version__ = "3.3.3"
 
 besapi_logger = logging.getLogger("besapi")
 
@@ -353,7 +353,7 @@ class BESConnection:
     def session_relevance_string(self, relevance, **kwargs):
         """Get Session Relevance Results string"""
         rel_result_array = self.session_relevance_array(
-            "(it as string) of " + relevance, **kwargs
+            "(it as string) of ( " + relevance + " )", **kwargs
         )
         return "\n".join(rel_result_array)
 

besapi-3.3.3/src/besapi/plugin_utilities.py

@@ -0,0 +1,166 @@
+"""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"""
+    # using logging here won't actually log it to the file:
+
+    if getattr(sys, "frozen", False) and hasattr(sys, "_MEIPASS"):
+        if verbose:
+            print("running in a PyInstaller bundle")
+        invoke_folder = os.path.abspath(os.path.dirname(sys.executable))
+    else:
+        if verbose:
+            print("running in a normal Python process")
+        invoke_folder = os.path.abspath(os.path.dirname(__file__))
+
+    if verbose:
+        print(f"invoke_folder = {invoke_folder}")
+
+    return invoke_folder
+
+
+def get_invoke_file_name(verbose=0):
+    """Get the filename the script was invoked from"""
+    # using logging here won't actually log it to the file:
+
+    if getattr(sys, "frozen", False) and hasattr(sys, "_MEIPASS"):
+        if verbose:
+            print("running in a PyInstaller bundle")
+        invoke_file_path = sys.executable
+    else:
+        if verbose:
+            print("running in a normal Python process")
+        invoke_file_path = __file__
+
+    if verbose:
+        print(f"invoke_file_path = {invoke_file_path}")
+
+    # get just the file name, return without file extension:
+    return os.path.splitext(ntpath.basename(invoke_file_path))[0]
+
+
+def setup_plugin_argparse(plugin_args_required=False):
+    """setup argparse for plugin use"""
+    arg_parser = argparse.ArgumentParser(
+        description="Provde command line arguments for REST URL, username, and password"
+    )
+    arg_parser.add_argument(
+        "-v",
+        "--verbose",
+        help="Set verbose output",
+        required=False,
+        action="count",
+        default=0,
+    )
+    arg_parser.add_argument(
+        "-c",
+        "--console",
+        help="log output to console",
+        required=False,
+        action="store_true",
+    )
+    arg_parser.add_argument(
+        "-besserver", "--besserver", help="Specify the BES URL", required=False
+    )
+    arg_parser.add_argument(
+        "-r", "--rest-url", help="Specify the REST URL", required=plugin_args_required
+    )
+    arg_parser.add_argument(
+        "-u", "--user", help="Specify the username", required=plugin_args_required
+    )
+    arg_parser.add_argument(
+        "-p", "--password", help="Specify the password", required=False
+    )
+
+    return arg_parser
+
+
+def setup_plugin_logging(log_file_name="", 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"
+
+    # set different log levels:
+    log_level = logging.WARNING
+    if verbose:
+        log_level = logging.INFO
+    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 output to console if arg provided:
+    if console:
+        handlers.append(logging.StreamHandler())
+
+    # setup logging:
+    logging.basicConfig(
+        encoding="utf-8",
+        level=log_level,
+        format="%(asctime)s %(levelname)s:%(message)s",
+        handlers=handlers,
+    )
+
+
+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()
+
+    # 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)
+            # bes_conn.login()
+        except (
+            AttributeError,
+            ConnectionRefusedError,
+            besapi.besapi.requests.exceptions.ConnectionError,
+        ):
+            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:
+                bes_conn = besapi.besapi.get_bes_conn_using_config_file()
+    else:
+        bes_conn = besapi.besapi.get_bes_conn_using_config_file()
+
+    return bes_conn

{besapi-3.2.6 → besapi-3.3.3/src/besapi.egg-info}/PKG-INFO

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

{besapi-3.2.6 → besapi-3.3.3}/src/besapi.egg-info/SOURCES.txt

@@ -7,6 +7,7 @@ setup.py
 src/besapi/__init__.py
 src/besapi/__main__.py
 src/besapi/besapi.py
+src/besapi/plugin_utilities.py
 src/besapi.egg-info/PKG-INFO
 src/besapi.egg-info/SOURCES.txt
 src/besapi.egg-info/dependency_links.txt

{besapi-3.2.6 → besapi-3.3.3}/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)