besapi 3.9.4__tar.gz → 3.9.6__tar.gz

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

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

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

@@ -4,6 +4,7 @@ This module besapi provides a simple interface to the BigFix REST API.
 
 MIT License
 Copyright (c) 2014 Matt Hansen
+Copyright (c) 2021 James Stewart
 Maintained by James Stewart since 2021
 
 Library for communicating with the BES (BigFix) REST API.
@@ -25,7 +26,7 @@ import lxml.etree
 import lxml.objectify
 import requests
 
-__version__ = "3.9.4"
+__version__ = "3.9.6"
 
 besapi_logger = logging.getLogger("besapi")
 

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

@@ -14,6 +14,9 @@ from typing import Union
 
 import besapi
 
+if os.name == "nt":
+    import besapi.plugin_utilities_win
+
 
 # NOTE: This does not work as expected when run from plugin_utilities
 def get_invoke_folder(verbose=0):
@@ -92,6 +95,13 @@ def setup_plugin_argparse(plugin_args_required=False):
     return arg_parser
 
 
+def get_plugin_args(plugin_args_required=False):
+    """Get basic args for plugin use."""
+    arg_parser = setup_plugin_argparse(plugin_args_required)
+    args, _unknown = arg_parser.parse_known_args()
+    return args
+
+
 def get_plugin_logging_config(log_file_path="", verbose=0, console=True):
     """Get config for logging for plugin use.
 
@@ -208,7 +218,7 @@ def get_besapi_connection_args(
                     "attempts to connect to BigFix using rest_url and besserver both failed"
                 )
                 return None
-            except BaseException as err:
+            except BaseException as err:  # pylint: disable=broad-exception-caught
                 # always log error
                 logging.exception("ERROR: %s", err)
                 logging.exception(

{besapi-3.9.4 → besapi-3.9.6}/src/besapi/plugin_utilities_win.py

@@ -23,7 +23,7 @@ except (ImportError, ModuleNotFoundError) as e:
         raise e
 
 try:
-    import win32crypt
+    import win32crypt  # type: ignore[import]
 except (ImportError, ModuleNotFoundError) as e:
     if not sys.platform.startswith("win"):
         raise RuntimeError("This script only works on Windows systems") from e
@@ -141,7 +141,7 @@ def win_registry_value_read(hive, subkey, value_name):
     except FileNotFoundError:
         logger.debug("Registry key or value '%s\\%s' not found.", subkey, value_name)
         return None
-    except Exception as e:
+    except Exception as e:  # pylint: disable=broad-exception-caught
         logger.error("An error occurred: %s", e)
         return None
 
@@ -203,14 +203,11 @@ def get_besconn_root_windows_registry() -> Union[besapi.besapi.BESConnection, No
         return None
 
     # normalize url to https://HostOrIP:52311
-    if rest_url and rest_url.endswith("/api"):
+    if rest_url.endswith("/api"):
         rest_url = rest_url.replace("/api", "")
 
-    if user and password and rest_url:
-        try:
-            return besapi.besapi.BESConnection(user, password, rest_url)
-        except Exception as e:
-            logger.error("Failed to create BESConnection from registry values: %s", e)
-            return None
-
-    return None
+    try:
+        return besapi.besapi.BESConnection(user, password, rest_url)
+    except Exception as e:  # pylint: disable=broad-exception-caught
+        logger.error("Failed to create BESConnection from registry values: %s", e)
+        return None

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

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

{besapi-3.9.4 → besapi-3.9.6}/src/besapi.egg-info/SOURCES.txt

@@ -21,4 +21,6 @@ src/bescli/__init__.py
 src/bescli/__main__.py
 src/bescli/bescli.py
 tests/test_besapi.py
+tests/test_plugin_utilities.py
+tests/test_plugin_utilities_logging.py
 tests/tests.py

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

@@ -500,7 +500,7 @@ class BESCLInterface(Cmd):
     def do_update_item(self, file_path):
         """Update bigfix content item from bes file."""
         if not os.access(file_path, os.R_OK):
-            self.poutput(file_path, "is not a readable file")
+            self.poutput(file_path, " is not a readable file")
         else:
             self.poutput(self.bes_conn.update_item_from_file(file_path))
 

besapi-3.9.6/tests/test_plugin_utilities.py

@@ -0,0 +1,60 @@
+import os
+import sys
+
+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
+
+
+def test_setup_plugin_argparse_defaults():
+    """Test that default args are set correctly."""
+    parser = plugin_utilities.setup_plugin_argparse(plugin_args_required=False)
+    # ensure parser returns expected arguments when not required
+    args = parser.parse_args([])
+    assert args.verbose == 0
+    assert args.console is False
+    assert args.besserver is None
+    assert args.rest_url is None
+    assert args.user is None
+    assert args.password is None
+
+
+def test_setup_plugin_argparse_required_flags():
+    """Test that required args cause SystemExit when missing."""
+    parser = plugin_utilities.setup_plugin_argparse(plugin_args_required=True)
+    # when required, missing required args should cause SystemExit
+    with pytest.raises(SystemExit):
+        parser.parse_args([])
+
+
+def test_get_plugin_args_parses_known_args(monkeypatch):
+    """Test that known command line args are parsed correctly."""
+    # simulate command line args
+    monkeypatch.setattr(
+        sys,
+        "argv",
+        [
+            "prog",
+            "-v",
+            "-c",
+            "--rest-url",
+            "https://example:52311",
+            "--user",
+            "me",
+            "--password",
+            "pw",
+        ],
+    )
+    args = plugin_utilities.get_plugin_args(plugin_args_required=False)
+    assert args.verbose == 1
+    assert args.console is True
+    assert args.rest_url == "https://example:52311"
+    assert args.user == "me"
+    assert args.password == "pw"
+    assert args.besserver is None

besapi-3.9.6/tests/test_plugin_utilities_logging.py

@@ -0,0 +1,61 @@
+import logging
+import os
+import tempfile
+
+import pytest
+
+from besapi import plugin_utilities
+
+
+def test_get_plugin_logging_config_default(tmp_path, capsys):
+    """Test default logging config with no verbosity and no console."""
+    # Use an explicit log file path in a temp dir to avoid touching real files
+    log_file = tmp_path / "test.log"
+
+    cfg = plugin_utilities.get_plugin_logging_config(
+        str(log_file), verbose=0, console=False
+    )
+
+    # handlers should include a RotatingFileHandler only
+    handlers = cfg.get("handlers")
+    assert handlers, "handlers should be present"
+    assert len(handlers) == 1
+    assert isinstance(handlers[0], logging.handlers.RotatingFileHandler)
+
+    # level should be WARNING when verbose=0
+    assert cfg.get("level") == logging.WARNING
+
+
+def test_get_plugin_logging_config_verbose_and_console(tmp_path, capsys):
+    """Test logging config with verbosity and console logging."""
+    # ensure the function prints info when verbose and console True
+    log_file = tmp_path / "test2.log"
+
+    cfg = plugin_utilities.get_plugin_logging_config(
+        str(log_file), verbose=1, console=True
+    )
+
+    handlers = cfg.get("handlers")
+    # should have file handler + stream handler
+    assert any(isinstance(h, logging.handlers.RotatingFileHandler) for h in handlers)
+    assert any(isinstance(h, logging.StreamHandler) for h in handlers)
+
+    # verbose=1 -> INFO
+    assert cfg.get("level") == logging.INFO
+
+    # get printed output
+    captured = capsys.readouterr()
+    assert "INFO: Log File Path:" in captured.out
+    assert "INFO: also logging to console" in captured.out
+
+
+def test_get_plugin_logging_config_debug_level(tmp_path):
+    """Test logging config with debug level verbosity."""
+    log_file = tmp_path / "test3.log"
+
+    cfg = plugin_utilities.get_plugin_logging_config(
+        str(log_file), verbose=2, console=False
+    )
+
+    # verbose>1 -> DEBUG
+    assert cfg.get("level") == logging.DEBUG