besapi 3.9.8__tar.gz → 4.0.2__tar.gz

{besapi-3.9.8/src/besapi.egg-info → besapi-4.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: besapi
-Version: 3.9.8
+Version: 4.0.2
 Summary: Library for working with the BigFix REST API
 Home-page: https://github.com/jgstew/besapi
 Author: Matt Hansen, James Stewart
@@ -25,6 +25,7 @@ Requires-Dist: lxml
 Requires-Dist: requests
 Requires-Dist: setuptools
 Requires-Dist: pywin32; platform_system == "Windows"
+Requires-Dist: urllib3>=2.2.3
 Dynamic: license-file
 
 # besapi

{besapi-3.9.8 → besapi-4.0.2}/setup.cfg

@@ -34,6 +34,7 @@ install_requires =
 	requests
 	setuptools
 	pywin32; platform_system == "Windows"
+	urllib3 >= 2.2.3
 
 [options.package_data]
 besapi = schemas/*.xsd

{besapi-3.9.8 → besapi-4.0.2}/src/besapi/besapi.py

@@ -12,6 +12,7 @@ Library for communicating with the BES (BigFix) REST API.
 
 import configparser
 import datetime
+import getpass
 import hashlib
 import importlib.resources
 import json
@@ -20,13 +21,15 @@ import os
 import random
 import site
 import string
+import sys
 import urllib.parse
 
 import lxml.etree
 import lxml.objectify
 import requests
+import urllib3.poolmanager
 
-__version__ = "3.9.8"
+__version__ = "4.0.2"
 
 besapi_logger = logging.getLogger("besapi")
 
@@ -117,44 +120,6 @@ def parse_bes_modtime(string_datetime):
     return datetime.datetime.strptime(string_datetime, "%a, %d %b %Y %H:%M:%S %z")
 
 
-# import urllib3.poolmanager
-# # https://docs.python-requests.org/en/latest/user/advanced/#transport-adapters
-# class HTTPAdapterBiggerBlocksize(requests.adapters.HTTPAdapter):
-#     """custom HTTPAdapter for requests to override blocksize
-#     for Uploading or Downloading large files"""
-
-#     # override init_poolmanager from regular HTTPAdapter
-#     # https://stackoverflow.com/questions/22915295/python-requests-post-and-big-content/22915488#comment125583017_22915488
-#     def init_poolmanager(self, connections, maxsize, block=False, **pool_kwargs):
-#         """Initializes a urllib3 PoolManager.
-
-#         This method should not be called from user code, and is only
-#         exposed for use when subclassing the
-#         :class:`HTTPAdapter <requests.adapters.HTTPAdapter>`.
-
-#         :param connections: The number of urllib3 connection pools to cache.
-#         :param maxsize: The maximum number of connections to save in the pool.
-#         :param block: Block when no free connections are available.
-#         :param pool_kwargs: Extra keyword arguments used to initialize the Pool Manager.
-#         """
-#         # save these values for pickling
-#         self._pool_connections = connections
-#         self._pool_maxsize = maxsize
-#         self._pool_block = block
-
-#         # This doesn't work until urllib3 is updated to a future version:
-#         # updating blocksize to be larger:
-#         # pool_kwargs["blocksize"] = 8 * 1024 * 1024
-
-#         self.poolmanager = urllib3.poolmanager.PoolManager(
-#             num_pools=connections,
-#             maxsize=maxsize,
-#             block=block,
-#             strict=True,
-#             **pool_kwargs,
-#         )
-
-
 def get_action_combined_relevance(relevances: list[str]):
     """Take array of ordered relevance clauses and return relevance string for
     action.
@@ -341,6 +306,119 @@ def get_bes_conn_using_config_file(conf_file=None):
     return None
 
 
+def get_bes_conn_interactive(
+    user=None, password=None, root_server=None, force_prompt=False
+):
+    """Get BESConnection using interactive prompts."""
+
+    if not (force_prompt or sys.__stdin__.isatty()):
+        logging.error("No TTY available for interactive login!")
+        return None
+
+    print(
+        "Attempting BESAPI Connection using interactive prompts. Use Ctrl-C to cancel."
+    )
+    try:
+        if not user:
+            user = str(input("User [%s]: " % getpass.getuser())).strip()
+        if not user:
+            user = getpass.getuser()
+
+        if not root_server:
+            root_server = str(
+                input("Root Server (ex. %s): " % "https://localhost:52311")
+            ).strip()
+        if not root_server or root_server == "":
+            print("Root Server is required, try again!")
+            return get_bes_conn_interactive(
+                user=user,
+                password=password,
+                root_server=None,
+                force_prompt=force_prompt,
+            )
+
+        if not password:
+            password = str(
+                getpass.getpass(f"Password for {user}@{root_server}: ")
+            ).strip()
+
+        if not password or password == "":
+            print("Password is required, try again!")
+            return get_bes_conn_interactive(
+                user=user,
+                password=None,
+                root_server=root_server,
+                force_prompt=force_prompt,
+            )
+    except (KeyboardInterrupt, EOFError):
+        print("\nLogin cancelled.")
+        return None
+
+    try:
+        return BESConnection(user, password, root_server)
+    except requests.exceptions.HTTPError as err:
+        print("Bad Password, Try again!")
+        logging.debug(err)
+        return get_bes_conn_interactive(
+            user=user, password=None, root_server=root_server, force_prompt=force_prompt
+        )
+    except requests.exceptions.ConnectionError as err:
+        print("Bad Root Server Specified, Try again!")
+        logging.debug("Connection Error: %s", err)
+        return get_bes_conn_interactive(
+            user=user, password=password, root_server=None, force_prompt=force_prompt
+        )
+    except Exception as e:  # pylint: disable=broad-except
+        logging.error("Error occurred while establishing BESConnection: %s", e)
+        return None
+
+
+# https://docs.python-requests.org/en/latest/user/advanced/#transport-adapters
+class HTTPAdapterBlocksize(requests.adapters.HTTPAdapter):
+    """Custom HTTPAdapter for requests to override blocksize
+    for Uploading or Downloading large files.
+    """
+
+    def __init__(self, blocksize=1000000, **kwargs):
+        self.blocksize = blocksize
+        super().__init__(**kwargs)
+
+    # override init_poolmanager from regular HTTPAdapter
+    # https://stackoverflow.com/questions/22915295/python-requests-post-and-big-content/22915488#comment125583017_22915488
+    def init_poolmanager(self, connections, maxsize, block=False, **pool_kwargs):
+        """Initializes a urllib3 PoolManager.
+
+        This method should not be called from user code, and is only
+        exposed for use when subclassing the
+        :class:`HTTPAdapter <requests.adapters.HTTPAdapter>`.
+
+        :param connections: The number of urllib3 connection pools to cache.
+        :param maxsize: The maximum number of connections to save in the pool.
+        :param block: Block when no free connections are available.
+        :param pool_kwargs: Extra keyword arguments used to initialize the Pool Manager.
+        """
+        # save these values for pickling
+        self._pool_connections = connections
+        self._pool_maxsize = maxsize
+        self._pool_block = block
+
+        try:
+            self.poolmanager = urllib3.poolmanager.PoolManager(
+                num_pools=connections,
+                maxsize=maxsize,
+                block=block,
+                blocksize=self.blocksize,
+                **pool_kwargs,
+            )
+        except Exception:  # pylint: disable=broad-except
+            self.poolmanager = urllib3.poolmanager.PoolManager(
+                num_pools=connections,
+                maxsize=maxsize,
+                block=block,
+                **pool_kwargs,
+            )
+
+
 class BESConnection:
     """BigFix RESTAPI connection abstraction class."""
 
@@ -355,6 +433,16 @@ class BESConnection:
         self.session = requests.Session()
         self.session.auth = (username, password)
 
+        # # configure retries for requests
+        # retry = requests.adapters.Retry(
+        #     total=2,
+        #     backoff_factor=0.1,
+        #     # status_forcelist=[500, 502, 503, 504],
+        # )
+
+        # # mount the HTTPAdapter with the retry configuration
+        # self.session.mount("https://", requests.adapters.HTTPAdapter(max_retries=retry))
+
         # store if connection user is main operator
         self.is_main_operator = None
 
@@ -564,7 +652,7 @@ class BESConnection:
         )
         return "\n".join(rel_result_array)
 
-    def login(self):
+    def login(self, timeout=(3, 20)):
         """Do login."""
         if bool(self.last_connected):
             duration_obj = datetime.datetime.now() - self.last_connected
@@ -577,21 +665,24 @@ class BESConnection:
             # default timeout is 5 minutes
             # I'm not sure if this is required
             # or if 'requests' would handle this automatically anyway
-            if int(duration_minutes) > 3:
-                besapi_logger.info("Refreshing Login to prevent timeout.")
-                self.last_connected = None
+            # if int(duration_minutes) > 3:
+            #     besapi_logger.info("Refreshing Login to prevent timeout.")
+            #     self.last_connected = None
 
         if not bool(self.last_connected):
-            result_login = self.get("login")
+            result_login = self.get("login", timeout=timeout)
             if not result_login.request.status_code == 200:
                 result_login.request.raise_for_status()
             if result_login.request.status_code == 200:
                 # set time of connection
                 self.last_connected = datetime.datetime.now()
 
-        # This doesn't work until urllib3 is updated to a future version:
-        # if self.connected():
-        #     self.session.mount(self.url("upload"), HTTPAdapterBiggerBlocksize())
+        # This doesn't work until urllib3 is at least ~v2:
+        if self.last_connected:
+            try:
+                self.session.mount(self.url("upload"), HTTPAdapterBlocksize())
+            except Exception:  # pylint: disable=broad-except
+                pass
 
         return bool(self.last_connected)
 
@@ -872,6 +963,9 @@ class BESConnection:
 
         # Example Header::  Content-Disposition: attachment; filename="file.xml"
         headers = {"Content-Disposition": f'attachment; filename="{file_name}"'}
+        logging.warning(
+            "Uploading `%s` to BigFix Server, this could take a while.", file_name
+        )
         with open(file_path, "rb") as f:
             return self.post(self.url("upload"), data=f, headers=headers)
 

{besapi-3.9.8 → besapi-4.0.2/src/besapi.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: besapi
-Version: 3.9.8
+Version: 4.0.2
 Summary: Library for working with the BigFix REST API
 Home-page: https://github.com/jgstew/besapi
 Author: Matt Hansen, James Stewart
@@ -25,6 +25,7 @@ Requires-Dist: lxml
 Requires-Dist: requests
 Requires-Dist: setuptools
 Requires-Dist: pywin32; platform_system == "Windows"
+Requires-Dist: urllib3>=2.2.3
 Dynamic: license-file
 
 # besapi

{besapi-3.9.8 → besapi-4.0.2}/src/besapi.egg-info/requires.txt

@@ -2,6 +2,7 @@ cmd2
 lxml
 requests
 setuptools
+urllib3>=2.2.3
 
 [:platform_system == "Windows"]
 pywin32

{besapi-3.9.8 → besapi-4.0.2}/src/bescli/bescli.py

@@ -216,6 +216,20 @@ class BESCLInterface(Cmd):
             self.pfeedback(" - attempt login using config parameters - ")
             self.do_login()
 
+    def do_login_new(self, user=None):
+        """Login to BigFix Server."""
+        if not user or str(user).strip() == "":
+            user = self.BES_USER_NAME
+        self.bes_conn = besapi.get_bes_conn_interactive(
+            user=user,
+            password=self.BES_PASSWORD,
+            root_server=self.BES_ROOT_SERVER,
+        )
+        if self.bes_conn:
+            self.pfeedback("Login Successful!")
+            (self.BES_USER_NAME, self.BES_PASSWORD) = self.bes_conn.session.auth
+            self.BES_ROOT_SERVER = self.bes_conn.rootserver
+
     def do_login(self, user=None):
         """Login to BigFix Server."""
 
@@ -227,7 +241,7 @@ class BESCLInterface(Cmd):
                 if not user:
                     user = getpass.getuser()
 
-            self.BES_USER_NAME = user
+            self.BES_USER_NAME = user.strip()
             if not self.CONFPARSER.has_section("besapi"):
                 self.CONFPARSER.add_section("besapi")
             self.CONFPARSER.set("besapi", "BES_USER_NAME", user)
@@ -237,14 +251,14 @@ class BESCLInterface(Cmd):
             if not root_server:
                 root_server = str(input("Root Server [%s]: " % self.BES_ROOT_SERVER))
 
-            self.BES_ROOT_SERVER = root_server
+            self.BES_ROOT_SERVER = root_server.strip()
 
         else:
             root_server = str(
                 input("Root Server (ex. %s): " % "https://server.institution.edu:52311")
             )
             if root_server:
-                self.BES_ROOT_SERVER = root_server
+                self.BES_ROOT_SERVER = root_server.strip()
                 if not self.CONFPARSER.has_section("besapi"):
                     self.CONFPARSER.add_section("besapi")
                 self.CONFPARSER.set("besapi", "BES_ROOT_SERVER", root_server)
@@ -390,7 +404,7 @@ class BESCLInterface(Cmd):
         if not self.bes_conn:
             self.do_login()
         if not self.bes_conn:
-            self.poutput("ERROR: can't check without login")
+            self.perror("ERROR: can't check without login")
         else:
             self.poutput(f"Am I Main Operator? {self.bes_conn.am_i_main_operator()}")
 
@@ -399,7 +413,7 @@ class BESCLInterface(Cmd):
         if not self.bes_conn:
             self.do_login()
         if not self.bes_conn:
-            self.poutput("ERROR: can't query without login")
+            self.perror("ERROR: can't query without login")
         else:
             if statement.raw:
                 # get everything after `query `

{besapi-3.9.8 → besapi-4.0.2}/tests/test_besapi.py

@@ -316,6 +316,30 @@ def test_bes_conn_json():
         pytest.skip("Skipping BESConnection test, no config file or login failed.")
 
 
+def test_bes_conn_upload_always():
+    """Test the BESConnection class with JSON output."""
+    file_name = "LICENSE.txt"
+    file_path = "../" + file_name
+    if not os.path.isfile(os.path.abspath(file_path)):
+        # handle case where not running from src or tests folder.
+        file_path = "./" + file_name
+    assert os.path.isfile(os.path.abspath(file_path))
+
+    bes_conn = besapi.plugin_utilities.get_besapi_connection(None)
+    if bes_conn and bes_conn.login():
+        # test upload
+        # Example Header::  Content-Disposition: attachment; filename="file.xml"
+        headers = {"Content-Disposition": f'attachment; filename="{file_name}"'}
+        with open(file_path, "rb") as f:
+            result = bes_conn.post(bes_conn.url("upload"), data=f, headers=headers)
+        print(result)
+        assert result is not None
+        assert result.besobj.FileUpload.Available == 1
+        assert result.besdict["FileUpload"]["Available"] == "1"
+    else:
+        pytest.skip("Skipping BESConnection upload test, login failed.")
+
+
 def test_plugin_utilities_logging():
     """Test the plugin_utilities module."""
     print(besapi.plugin_utilities.get_invoke_folder())