besapi 4.0.1__tar.gz → 4.1.2__tar.gz

{besapi-4.0.1/src/besapi.egg-info → besapi-4.1.2}/PKG-INFO

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

{besapi-4.0.1 → besapi-4.1.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,6 +21,7 @@ import os
 import random
 import site
 import string
+import sys
 import urllib.parse
 
 import lxml.etree
@@ -27,7 +29,7 @@ import lxml.objectify
 import requests
 import urllib3.poolmanager
 
-__version__ = "4.0.1"
+__version__ = "4.1.2"
 
 besapi_logger = logging.getLogger("besapi")
 
@@ -304,6 +306,76 @@ 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 Username or Bad Password, Try again!")
+        logging.debug(err)
+        print("    BES_ROOT_SERVER: ", root_server)
+        return get_bes_conn_interactive(
+            user=None, 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)
+        print("      BES_USER_NAME: ", user)
+        print("BES_PASSWORD length: ", len(password))
+        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
@@ -543,7 +615,7 @@ class BESConnection:
         return RESTResult(
             self.session.post(
                 self.url("query"),
-                data=f"relevance={urllib.parse.quote(relevance, safe=':+')}",
+                data=f"relevance={urllib.parse.quote(relevance, safe=':')}",
                 verify=self.verify,
                 **kwargs,
             )

{besapi-4.0.1 → besapi-4.1.2/src/besapi.egg-info}/PKG-INFO

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

{besapi-4.0.1 → besapi-4.1.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)

{besapi-4.0.1 → besapi-4.1.2}/tests/test_besapi.py

@@ -312,10 +312,86 @@ def test_bes_conn_json():
         assert result is not None
         assert "TestString" in result
         assert "BES Support" in result
+        print("testing session relevance with + in relevance")
+        str_relevance_plus = 'lengths of first matches (regex " +") of "        "'
+        result = bes_conn.session_relevance_xml(str_relevance_plus)
+        print(result)
+        assert result is not None
     else:
         pytest.skip("Skipping BESConnection test, no config file or login failed.")
 
 
+def test_bes_conn_session_relevance_with_plus():
+    """Test the BESConnection class with JSON output."""
+
+    bes_conn = besapi.plugin_utilities.get_besapi_connection(None)
+
+    if bes_conn and bes_conn.login():
+        print("testing session relevance with + in relevance")
+        str_relevance_plus = 'lengths of first matches (regex " +") of "        "'
+        str_relevance_answer = "8"
+        result = bes_conn.session_relevance_xml(str_relevance_plus)
+        print(result)
+        assert result is not None
+        print(result.request.request.body)
+        assert f'<Answer type="integer">{str_relevance_answer}</Answer>' in str(result)
+        result = bes_conn.session_relevance_json_string(str_relevance_plus)
+        print(result)
+        assert result is not None
+        assert str_relevance_answer in str(result)
+        result = bes_conn.session_relevance_json(str_relevance_plus)
+        print(result)
+        assert result is not None
+        assert f"[{str_relevance_answer}]" in str(result["result"])
+        result = bes_conn.session_relevance_string(str_relevance_plus)
+        print(result)
+        assert result is not None
+        assert str_relevance_answer in str(result)
+        result = bes_conn.session_relevance_array(str_relevance_plus)
+        print(result)
+        assert result is not None
+        assert f"['{str_relevance_answer}']" in str(result)
+        result = bes_conn.session_relevance_json_array(str_relevance_plus)
+        print(result)
+        assert result is not None
+        assert f"[{str_relevance_answer}]" in str(result)
+
+        # test already escaped +
+        str_relevance_plus = r'lengths of first matches (regex " %2b") of "        "'
+        print(str_relevance_plus)
+        result = bes_conn.session_relevance_xml(str_relevance_plus)
+        print(result)
+        assert result is not None
+        print(result.request.request.body)
+        assert f'<Answer type="integer">{str_relevance_answer}</Answer>' in str(result)
+    else:
+        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())