besapi 4.0.2__tar.gz → 4.1.4__tar.gz

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

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

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

@@ -29,7 +29,7 @@ import lxml.objectify
 import requests
 import urllib3.poolmanager
 
-__version__ = "4.0.2"
+__version__ = "4.1.4"
 
 besapi_logger = logging.getLogger("besapi")
 
@@ -249,6 +249,96 @@ def validate_xml_bes_file(file_path):
     return validate_xsd(file_data)
 
 
+def action_xml_from_bes_file(file_path, targets="<AllComputers>"):
+    """Create action XML from bes file with fixlet or task or singleaction."""
+    # default to empty string:
+    custom_relevance_xml = ""
+
+    if not validate_xml_bes_file(file_path):
+        err_msg = "bes file is not valid according to XML Schema!"
+        logging.error(err_msg)
+        raise ValueError(err_msg)
+
+    tree = lxml.etree.parse(file_path)
+
+    # //BES/*[self::Task or self::Fixlet]/*[@id='elid']/name()
+    bes_type = str(
+        tree.xpath("//BES/*[self::Task or self::Fixlet or self::SingleAction]")[0].tag
+    )
+
+    logging.debug("BES Type: %s", bes_type)
+
+    title = tree.xpath(f"//BES/{bes_type}/Title/text()")[0]
+
+    logging.debug("Title: %s", title)
+
+    try:
+        actionscript = tree.xpath(
+            f"//BES/{bes_type}/DefaultAction/ActionScript/text()"
+        )[0]
+    except IndexError:
+        # handle SingleAction case:
+        actionscript = tree.xpath(f"//BES/{bes_type}/ActionScript/text()")[0]
+
+    logging.debug("ActionScript: %s", actionscript)
+
+    try:
+        if bes_type != "SingleAction":
+            success_criteria = tree.xpath(
+                f"//BES/{bes_type}/DefaultAction/SuccessCriteria/@Option"
+            )[0]
+        else:
+            success_criteria = tree.xpath(f"//BES/{bes_type}/SuccessCriteria/@Option")[
+                0
+            ]
+    except IndexError:
+        # set success criteria if missing: (default)
+        success_criteria = "RunToCompletion"
+        if bes_type == "Fixlet":
+            # set success criteria if missing: (Fixlet)
+            success_criteria = "OriginalRelevance"
+
+    if success_criteria == "CustomRelevance":
+        if bes_type != "SingleAction":
+            custom_relevance = tree.xpath(
+                f"//BES/{bes_type}/DefaultAction/SuccessCriteria/text()"
+            )[0]
+        else:
+            custom_relevance = tree.xpath(f"//BES/{bes_type}/SuccessCriteria/text()")[0]
+
+        custom_relevance_xml = f"<![CDATA[{custom_relevance}]]>"
+
+    logging.debug("success_criteria: %s", success_criteria)
+
+    relevance_clauses = tree.xpath(f"//BES/{bes_type}/Relevance/text()")
+
+    logging.debug("Relevances: %s", relevance_clauses)
+
+    relevance_clauses_combined = get_action_combined_relevance(relevance_clauses)
+
+    logging.debug("Relevance Combined: %s", relevance_clauses_combined)
+
+    action_xml = f"""<?xml version="1.0" encoding="UTF-8"?>
+<BES xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="BES.xsd">
+	<SingleAction>
+		<Title>{title}</Title>
+		<Relevance><![CDATA[{relevance_clauses_combined}]]></Relevance>
+		<ActionScript MIMEType="application/x-Fixlet-Windows-Shell"><![CDATA[// Start:
+{actionscript}
+// End]]></ActionScript>
+		<SuccessCriteria Option="{success_criteria}">{custom_relevance_xml}</SuccessCriteria>
+		<Target>
+            {get_target_xml(targets)}
+        </Target>
+	</SingleAction>
+</BES>
+"""
+
+    logging.debug("Action XML:\n%s", action_xml)
+
+    return action_xml
+
+
 def get_bes_conn_using_env():
     """Get BESConnection using environment variables."""
     username = os.getenv("BES_USER_NAME")
@@ -357,14 +447,17 @@ def get_bes_conn_interactive(
     try:
         return BESConnection(user, password, root_server)
     except requests.exceptions.HTTPError as err:
-        print("Bad Password, Try again!")
+        print("Bad Username or Bad Password, Try again!")
         logging.debug(err)
+        print("    BES_ROOT_SERVER: ", root_server)
         return get_bes_conn_interactive(
-            user=user, password=None, root_server=root_server, force_prompt=force_prompt
+            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
         )
@@ -612,7 +705,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.2 → besapi-4.1.4/src/besapi.egg-info}/PKG-INFO

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

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

@@ -312,6 +312,58 @@ 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.")