besapi 3.9.6__tar.gz → 3.9.8__tar.gz

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

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

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

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

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

@@ -26,7 +26,7 @@ import lxml.etree
 import lxml.objectify
 import requests
 
-__version__ = "3.9.6"
+__version__ = "3.9.8"
 
 besapi_logger = logging.getLogger("besapi")
 
@@ -195,7 +195,7 @@ def get_target_xml(targets=None):
         - Array of Integers: ComputerID
     """
     if targets is None or not targets:
-        logging.warning("No valid targeting found, will target no computers.")
+        besapi_logger.warning("No valid targeting found, will target no computers.")
         # default if invalid:
         return "<CustomRelevance>False</CustomRelevance>"
 
@@ -237,7 +237,7 @@ def get_target_xml(targets=None):
                 + "</ComputerName>"
             )
 
-    logging.warning("No valid targeting found, will target no computers.")
+    besapi_logger.warning("No valid targeting found, will target no computers.")
 
     # default if invalid:
     return "<CustomRelevance>False</CustomRelevance>"
@@ -354,8 +354,11 @@ class BESConnection:
         self.username = username
         self.session = requests.Session()
         self.session.auth = (username, password)
-        # store info on operator used to login
-        # self.operator_info = {}
+
+        # store if connection user is main operator
+        self.is_main_operator = None
+
+        self.webreports_info_xml = None
 
         # use a sitepath context if none specified when required.
         self.site_path = "master"
@@ -425,11 +428,11 @@ class BESConnection:
             if not validate_xsd(data):
                 err_msg = "data being posted did not validate to XML schema. If expected, consider setting validate_xml to false."
                 if validate_xml:
-                    logging.error(err_msg)
+                    besapi_logger.error(err_msg)
                     raise ValueError(err_msg)
 
                 # this is intended it validate_xml is None, but not used currently
-                logging.warning(err_msg)
+                besapi_logger.warning(err_msg)
 
         self.last_connected = datetime.datetime.now()
         return RESTResult(
@@ -446,11 +449,11 @@ class BESConnection:
             if not validate_xsd(data):
                 err_msg = "data being put did not validate to XML schema. If expected, consider setting validate_xml to false."
                 if validate_xml:
-                    logging.error(err_msg)
+                    besapi_logger.error(err_msg)
                     raise ValueError(err_msg)
 
                 # this is intended it validate_xml is None, but not used currently
-                logging.warning(err_msg)
+                besapi_logger.warning(err_msg)
 
         return RESTResult(
             self.session.put(self.url(path), data=data, verify=self.verify, **kwargs)
@@ -463,6 +466,21 @@ class BESConnection:
             self.session.delete(self.url(path), verify=self.verify, **kwargs)
         )
 
+    def am_i_main_operator(self):
+        """Check if the current user is the main operator user."""
+        if self.is_main_operator is None:
+            try:
+                self.webreports_info_xml = self.get("webreports")
+                self.is_main_operator = True
+            except PermissionError:
+                self.is_main_operator = False
+            except Exception as err:  # pylint: disable=broad-except
+                besapi_logger.error("Error checking if main operator: %s", err)
+                self.is_main_operator = None
+
+        if self.is_main_operator is not None:
+            return self.is_main_operator
+
     def session_relevance_json(self, relevance, **kwargs):
         """Get Session Relevance Results in JSON.
 
@@ -738,8 +756,9 @@ class BESConnection:
             besapi_logger.warning("User `%s` Already Exists!", new_user_name)
             return result_user
         besapi_logger.info("Creating User `%s`", new_user_name)
-        _ = self.post("operators", lxml.etree.tostring(xml_parsed))
-        # print(user_result)
+        user_result = self.post("operators", lxml.etree.tostring(xml_parsed))
+        besapi_logger.debug("user creation result:\n%s", user_result)
+
         return self.get_user(new_user_name)
 
     def get_computergroup(self, group_name, site_path=None):
@@ -771,7 +790,11 @@ class BESConnection:
 
         # print(lxml.etree.tostring(xml_parsed))
 
-        _ = self.post(f"computergroups/{site_path}", lxml.etree.tostring(xml_parsed))
+        create_group_result = self.post(
+            f"computergroups/{site_path}", lxml.etree.tostring(xml_parsed)
+        )
+
+        besapi_logger.debug("group creation result:\n%s", create_group_result)
 
         return self.get_computergroup(site_path, new_group_name)
 
@@ -796,7 +819,7 @@ class BESConnection:
             raise ValueError("No file_name specified. Must be at least one character.")
 
         if "Upload not found" in result.text:
-            # print("WARNING: Upload not found!")
+            besapi_logger.debug("WARNING: Upload not found!")
             return None
 
         return result
@@ -882,8 +905,8 @@ class BESConnection:
         try:
             content = self.get(resource_url.replace("http://", "https://"))
         except PermissionError as err:
-            logging.error("Could not export item:")
-            logging.error(err)
+            besapi_logger.error("Could not export item:")
+            besapi_logger.error(err)
 
         # item_id = int(resource_url.split("/")[-1])
         # site_name = resource_url.split("/")[-2]
@@ -1143,7 +1166,7 @@ class RESTResult:
             if self.validate_xsd(request.text):
                 self.valid = True
             else:
-                logging.debug(
+                besapi_logger.debug(
                     "INFO: REST API Result does not appear to be XML, this could be expected."
                 )
                 self.valid = False

{besapi-3.9.6 → besapi-3.9.8}/src/besapi/plugin_utilities.py

@@ -127,6 +127,8 @@ def get_plugin_logging_config(log_file_path="", verbose=0, console=True):
         )
     ]
 
+    logging.addLevelName(99, "SESSION")
+
     # log output to console if arg provided:
     if console:
         handlers.append(logging.StreamHandler())

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

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

besapi-3.9.8/src/besapi.egg-info/requires.txt

@@ -0,0 +1,7 @@
+cmd2
+lxml
+requests
+setuptools
+
+[:platform_system == "Windows"]
+pywin32

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

@@ -385,6 +385,15 @@ class BESCLInterface(Cmd):
         # no matter what I try I can't get anything but exit code 0 on windows
         return self.do_quit("")
 
+    def do_am_i_main_operator(self, _=None):
+        """Check if the connection user is a main operator user."""
+        if not self.bes_conn:
+            self.do_login()
+        if not self.bes_conn:
+            self.poutput("ERROR: can't check without login")
+        else:
+            self.poutput(f"Am I Main Operator? {self.bes_conn.am_i_main_operator()}")
+
     def do_query(self, statement):
         """Get Session Relevance Results."""
         if not self.bes_conn:

{besapi-3.9.6 → besapi-3.9.8}/tests/test_plugin_utilities_logging.py

@@ -1,9 +1,16 @@
 import logging
 import os
+import sys
 import tempfile
 
 import pytest
 
+# Ensure the local `src/` is first on sys.path so tests import the workspace package
+ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))
+SRC = os.path.join(ROOT, "src")
+if SRC not in sys.path:
+    sys.path.insert(0, SRC)
+
 from besapi import plugin_utilities
 
 
@@ -59,3 +66,13 @@ def test_get_plugin_logging_config_debug_level(tmp_path):
 
     # verbose>1 -> DEBUG
     assert cfg.get("level") == logging.DEBUG
+
+
+def test_plugin_logging_config_registers_session_level(tmp_path):
+    """Test that get_plugin_logging_config registers the custom SESSION log level
+    (99).
+    """
+    log_file = tmp_path / "test_session.log"
+    plugin_utilities.get_plugin_logging_config(str(log_file), verbose=0, console=False)
+    # After calling, the level name for 99 should be 'SESSION'
+    assert logging.getLevelName(99) == "SESSION"

besapi-3.9.6/src/besapi.egg-info/requires.txt

@@ -1,4 +0,0 @@
-cmd2
-lxml
-requests
-setuptools