besapi 3.7.8__tar.gz → 3.8.1__tar.gz

{besapi-3.7.8/src/besapi.egg-info → besapi-3.8.1}/PKG-INFO

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

{besapi-3.7.8 → besapi-3.8.1}/src/besapi/besapi.py

@@ -12,13 +12,13 @@ Library for communicating with the BES (BigFix) REST API.
 import configparser
 import datetime
 import hashlib
-import io
 import json
 import logging
 import os
 import random
 import site
 import string
+import typing
 
 try:
     from urllib import parse
@@ -29,7 +29,7 @@ import requests
 from lxml import etree, objectify
 from pkg_resources import resource_filename
 
-__version__ = "3.7.8"
+__version__ = "3.8.1"
 
 besapi_logger = logging.getLogger("besapi")
 
@@ -94,7 +94,7 @@ def elem2dict(node):
 def replace_text_between(
     original_text, first_delimiter, second_delimiter, replacement_text
 ):
-    """Replace text between delimeters. Each delimiter should only appear once."""
+    """Replace text between delimiters. Each delimiter should only appear once."""
     leading_text = original_text.split(first_delimiter)[0]
     trailing_text = original_text.split(second_delimiter)[1]
 
@@ -120,7 +120,7 @@ def parse_bes_modtime(string_datetime):
 #     """custom HTTPAdapter for requests to override blocksize
 #     for Uploading or Downloading large files"""
 
-#     # override inti_poolmanager from regular HTTPAdapter
+#     # 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.
@@ -152,6 +152,92 @@ def parse_bes_modtime(string_datetime):
 #         )
 
 
+def get_action_combined_relevance(relevances: typing.List[str]):
+    """take array of ordered relevance clauses and return relevance string for action"""
+
+    relevance_combined = ""
+
+    if not relevances:
+        return "False"
+    if len(relevances) == 0:
+        return "False"
+    if len(relevances) == 1:
+        return relevances[0]
+    if len(relevances) > 0:
+        for clause in relevances:
+            if len(relevance_combined) == 0:
+                relevance_combined = clause
+            else:
+                relevance_combined = (
+                    "( " + relevance_combined + " ) AND ( " + clause + " )"
+                )
+
+    return relevance_combined
+
+
+def get_target_xml(targets=None):
+    """get target xml based upon input
+
+    Input can be a single string:
+        - starts with "<AllComputers>" if all computers should be targeted
+        - Otherwise will be interpreted as custom relevance
+
+    Input can be a single int:
+        - Single Computer ID Target
+
+    Input can be an array:
+        - Array of Strings: ComputerName
+        - Array of Integers: ComputerID
+    """
+    if targets is None or not targets:
+        logging.warning("No valid targeting found, will target no computers.")
+        # default if invalid:
+        return "<CustomRelevance>False</CustomRelevance>"
+
+    # if targets is int:
+    if isinstance(targets, int):
+        if targets == 0:
+            raise ValueError(
+                "Int 0 is not valid Computer ID, set targets to an array of strings of computer names or an array of ints of computer ids or custom relevance string or <AllComputers>"
+            )
+        return f"<ComputerID>{targets}</ComputerID>"
+
+    # if targets is str:
+    if isinstance(targets, str):
+        # if targets string starts with "<AllComputers>":
+        if targets.startswith("<AllComputers>"):
+            if "false" in targets.lower():
+                # In my testing, <AllComputers>false</AllComputers> does not work correctly
+                return "<CustomRelevance>False</CustomRelevance>"
+                # return "<AllComputers>false</AllComputers>"
+            return "<AllComputers>true</AllComputers>"
+        # treat as custom relevance:
+        return f"<CustomRelevance><![CDATA[{targets}]]></CustomRelevance>"
+
+    # if targets is array:
+    if isinstance(targets, list):
+        element_type = type(targets[0])
+        if element_type is int:
+            # array of computer ids
+            return (
+                "<ComputerID>"
+                + "</ComputerID><ComputerID>".join(map(str, targets))
+                + "</ComputerID>"
+            )
+        if element_type is str:
+            # array of computer names
+            return (
+                "<ComputerName>"
+                + "</ComputerName><ComputerName>".join(targets)
+                + "</ComputerName>"
+            )
+
+    logging.warning("No valid targeting found, will target no computers.")
+
+    # default if invalid:
+    return "<CustomRelevance>False</CustomRelevance>"
+
+
 def validate_xsd(doc):
     """validate results using XML XSDs"""
     try:
@@ -257,7 +343,7 @@ class BESConnection:
     def __repr__(self):
         """object representation"""
         # https://stackoverflow.com/a/2626364/861745
-        return f"Object: besapi.BESConnction( username={self.username}, rootserver={self.rootserver} )"
+        return f"Object: besapi.BESConnection( username={self.username}, rootserver={self.rootserver} )"
 
     def __eq__(self, other):
         if (
@@ -669,7 +755,7 @@ class BESConnection:
         file_url = str(result_upload.besobj.FileUpload.URL)
         if use_https:
             file_url = file_url.replace("http://", "https://")
-        # there are 3 different posibilities for the server FQDN
+        # there are 3 different possibilities for the server FQDN
         # localhost
         # self.rootserver (without port number)
         # the returned value from the upload result
@@ -927,7 +1013,7 @@ class RESTResult:
                     f"\n - HTTP Response Status Code: `403` Forbidden\n - ERROR: `{self.text}`\n - URL: `{self.request.url}`"
                 )
 
-            besapi_logger.info(
+            besapi_logger.debug(
                 "HTTP Request Status Code `%d` from URL `%s`",
                 self.request.status_code,
                 self.request.url,

{besapi-3.7.8 → besapi-3.8.1}/src/besapi/plugin_utilities.py

@@ -58,7 +58,7 @@ def get_invoke_file_name(verbose=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"
+        description="Provide command line arguments for REST URL, username, and password"
     )
     arg_parser.add_argument(
         "-v",

{besapi-3.7.8 → besapi-3.8.1/src/besapi.egg-info}/PKG-INFO

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

{besapi-3.7.8 → besapi-3.8.1}/tests/tests.py

@@ -91,6 +91,37 @@ assert b"<BES>Example</BES>" in rest_result.xmlparse_text("<BES>Example</BES>")
 
 assert rest_result.text == "this is just a test"
 
+# test date parsing function:
+assert 2017 == besapi.besapi.parse_bes_modtime("Tue, 05 Sep 2017 23:31:48 +0000").year
+
+# test action combined relevance
+assert (
+    "( ( True ) AND ( windows of operating system ) ) AND ( False )"
+    == besapi.besapi.get_action_combined_relevance(
+        ["True", "windows of operating system", "False"]
+    )
+)
+
+# test target xml
+assert "<CustomRelevance>False</CustomRelevance>" == besapi.besapi.get_target_xml()
+assert "<AllComputers>true</AllComputers>" == besapi.besapi.get_target_xml(
+    "<AllComputers>"
+)
+assert "<ComputerID>1</ComputerID>" == besapi.besapi.get_target_xml(1)
+assert (
+    "<CustomRelevance><![CDATA[not windows of operating system]]></CustomRelevance>"
+    == besapi.besapi.get_target_xml("not windows of operating system")
+)
+assert (
+    "<ComputerID>1</ComputerID><ComputerID>2</ComputerID>"
+    == besapi.besapi.get_target_xml([1, 2])
+)
+assert (
+    "<ComputerName>Computer 1</ComputerName><ComputerName>Another Computer</ComputerName>"
+    == besapi.besapi.get_target_xml(["Computer 1", "Another Computer"])
+)
+
+# test bescli:
 import bescli
 
 bigfix_cli = bescli.bescli.BESCLInterface()
@@ -151,8 +182,10 @@ if bigfix_cli.bes_conn:
             'CMD /C python -m besapi ls clear ls conf "query number of bes computers" version error_count exit',
             check=True,
         )
-        bes_conn = besapi.besapi.get_bes_conn_using_config_file()
-        print("login succeeded:", bes_conn.login())
+
+    bes_conn = besapi.besapi.get_bes_conn_using_config_file()
+    print("login succeeded:", bes_conn.login())
+    assert bes_conn.login()
 
 # test plugin_utilities:
 print(besapi.plugin_utilities.get_invoke_folder())