besapi 3.7.8__tar.gz → 3.8.2__tar.gz

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: besapi
-Version: 3.7.8
+Version: 3.8.2
 Summary: Library for working with the BigFix REST API
 Home-page: https://github.com/jgstew/besapi
 Author: Matt Hansen, James Stewart
@@ -8,14 +8,27 @@ Author-email: hansen.m@psu.edu, james@jgstew.com
 License: MIT
 Keywords: bigfix iem tem rest api
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
 Classifier: Operating System :: OS Independent
 Classifier: License :: OSI Approved :: MIT License
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Systems Administration
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: requests
 Requires-Dist: lxml
 Requires-Dist: cmd2
+Requires-Dist: setuptools
+Dynamic: author
+Dynamic: author-email
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
 
 # besapi
 

{besapi-3.7.8 → besapi-3.8.2}/setup.cfg

@@ -4,8 +4,13 @@ long_description = file: README.md
 long_description_content_type = text/markdown
 classifiers = 
 	Programming Language :: Python :: 3
+	Programming Language :: Python :: 3.9
 	Operating System :: OS Independent
 	License :: OSI Approved :: MIT License
+	Development Status :: 5 - Production/Stable
+	Intended Audience :: Developers
+	Topic :: Software Development :: Libraries :: Python Modules
+	Topic :: System :: Systems Administration
 
 [options]
 python_requires = >=3.7

{besapi-3.7.8 → besapi-3.8.2}/setup.py

@@ -1,14 +1,9 @@
 #!/usr/bin/env python
-"""
-file to configure python build and packaging for pip
-"""
+"""File to configure python build and packaging for pip."""
 
-try:
-    from setuptools import setup
-except (ImportError, ModuleNotFoundError):
-    from distutils.core import setup
+import setuptools
 
-setup(
+setuptools.setup(
     name="besapi",
     # version= moved to setup.cfg
     author="Matt Hansen, James Stewart",
@@ -20,7 +15,7 @@ setup(
     # long_description= moved to setup.cfg
     packages=["besapi", "bescli"],
     package_data={"besapi": ["schemas/*.xsd"]},
-    install_requires=["requests", "lxml", "cmd2"],
+    install_requires=["requests", "lxml", "cmd2", "setuptools"],
     include_package_data=True,
     package_dir={"": "src"},
 )

{besapi-3.7.8 → besapi-3.8.2}/src/besapi/__init__.py

@@ -1,6 +1,4 @@
-"""
-besapi is a python module for interacting with the BigFix REST API
-"""
+"""Besapi is a python module for interacting with the BigFix REST API."""
 
 # https://stackoverflow.com/questions/279237/import-a-module-from-a-relative-path/4397291
 

{besapi-3.7.8 → besapi-3.8.2}/src/besapi/__main__.py

@@ -1,6 +1,4 @@
-"""
-To run this module directly
-"""
+"""To run this module directly."""
 
 import logging
 

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

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 """
-besapi.py
+This module besapi provides a simple interface to the BigFix REST API.
 
 MIT License
 Copyright (c) 2014 Matt Hansen
@@ -12,30 +12,32 @@ 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
 except ImportError:
-    from urlparse import parse_qs as parse
+    from urlparse import parse_qs as parse  # type: ignore[no-redef,import-not-found]
 
 import requests
 from lxml import etree, objectify
 from pkg_resources import resource_filename
 
-__version__ = "3.7.8"
+__version__ = "3.8.2"
 
 besapi_logger = logging.getLogger("besapi")
 
+# pylint: disable=consider-using-f-string
+
 
 def rand_password(length=20):
-    """get a random password"""
+    """Get a random password."""
 
     all_safe_chars = string.ascii_letters + string.digits + "!#()*+,-.:;<=>?[]^_|~"
 
@@ -66,6 +68,7 @@ def sanitize_txt(*args):
 def elem2dict(node):
     """
     Convert an lxml.etree node tree into a dict.
+
     https://gist.github.com/jacobian/795571?permalink_comment_id=2981870#gistcomment-2981870
     """
     result = {}
@@ -94,7 +97,10 @@ 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]
 
@@ -109,7 +115,7 @@ def replace_text_between(
 
 # https://github.com/jgstew/generate_bes_from_template/blob/bcc6c79632dd375c2861608ded3ae5872801a669/src/generate_bes_from_template/generate_bes_from_template.py#L87-L92
 def parse_bes_modtime(string_datetime):
-    """parse datetime string to object"""
+    """Parse datetime string to object."""
     # ("%a, %d %b %Y %H:%M:%S %z")
     return datetime.datetime.strptime(string_datetime, "%a, %d %b %Y %H:%M:%S %z")
 
@@ -120,7 +126,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,8 +158,96 @@ 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"""
+    """Validate results using XML XSDs."""
     try:
         xmldoc = etree.fromstring(doc)
     except BaseException:  # pylint: disable=broad-except
@@ -176,9 +270,25 @@ def validate_xsd(doc):
     return False
 
 
+def validate_xml_bes_file(file_path):
+    """Take a file path as input,
+    read as binary data,.
+
+    validate against xml schema
+
+    returns True for valid xml
+    returns False for invalid xml (or if file is not xml)
+    """
+    with open(file_path, "rb") as file:
+        file_data = file.read()
+
+    return validate_xsd(file_data)
+
+
 def get_bes_conn_using_config_file(conf_file=None):
     """
-    read connection values from config file
+    Read connection values from config file.
+
     return besapi connection
     """
     config_paths = [
@@ -219,7 +329,7 @@ def get_bes_conn_using_config_file(conf_file=None):
 
 
 class BESConnection:
-    """BigFix RESTAPI connection abstraction class"""
+    """BigFix RESTAPI connection abstraction class."""
 
     def __init__(self, username, password, rootserver, verify=False):
         if not verify:
@@ -255,9 +365,9 @@ class BESConnection:
         self.login()
 
     def __repr__(self):
-        """object representation"""
+        """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 (
@@ -269,16 +379,16 @@ class BESConnection:
         return False
 
     def __del__(self):
-        """cleanup on deletion of instance"""
+        """Cleanup on deletion of instance."""
         self.logout()
         self.session.auth = None
 
     def __bool__(self):
-        """get true or false"""
+        """Get true or false."""
         return self.login()
 
     def url(self, path):
-        """get absolute url"""
+        """Get absolute url."""
         if path.startswith(self.rootserver):
             url = path
         else:
@@ -287,35 +397,61 @@ class BESConnection:
         return url
 
     def get(self, path="help", **kwargs):
-        """HTTP GET request"""
+        """HTTP GET request."""
         self.last_connected = datetime.datetime.now()
         return RESTResult(
             self.session.get(self.url(path), verify=self.verify, **kwargs)
         )
 
-    def post(self, path, data, **kwargs):
-        """HTTP POST request"""
+    def post(self, path, data, validate_xml=None, **kwargs):
+        """HTTP POST request."""
+
+        # if validate_xml is true, data must validate to xml schema
+        # if validate_xml is false, no schema check will be made
+        if validate_xml:
+            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)
+                    raise ValueError(err_msg)
+                else:
+                    # this is intended it validate_xml is None, but not used currently
+                    logging.warning(err_msg)
+
         self.last_connected = datetime.datetime.now()
         return RESTResult(
             self.session.post(self.url(path), data=data, verify=self.verify, **kwargs)
         )
 
-    def put(self, path, data, **kwargs):
-        """HTTP PUT request"""
+    def put(self, path, data, validate_xml=None, **kwargs):
+        """HTTP PUT request."""
         self.last_connected = datetime.datetime.now()
+
+        # if validate_xml is true, data must validate to xml schema
+        # if validate_xml is false, no schema check will be made
+        if validate_xml:
+            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)
+                    raise ValueError(err_msg)
+                else:
+                    # this is intended it validate_xml is None, but not used currently
+                    logging.warning(err_msg)
+
         return RESTResult(
             self.session.put(self.url(path), data=data, verify=self.verify, **kwargs)
         )
 
     def delete(self, path, **kwargs):
-        """HTTP DELETE request"""
+        """HTTP DELETE request."""
         self.last_connected = datetime.datetime.now()
         return RESTResult(
             self.session.delete(self.url(path), verify=self.verify, **kwargs)
         )
 
     def session_relevance_xml(self, relevance, **kwargs):
-        """Get Session Relevance Results XML"""
+        """Get Session Relevance Results XML."""
         self.last_connected = datetime.datetime.now()
         return RESTResult(
             self.session.post(
@@ -327,7 +463,7 @@ class BESConnection:
         )
 
     def session_relevance_array(self, relevance, **kwargs):
-        """Get Session Relevance Results array"""
+        """Get Session Relevance Results array."""
         rel_result = self.session_relevance_xml(relevance, **kwargs)
         # print(rel_result)
         result = []
@@ -354,14 +490,14 @@ class BESConnection:
         return result
 
     def session_relevance_string(self, relevance, **kwargs):
-        """Get Session Relevance Results string"""
+        """Get Session Relevance Results string."""
         rel_result_array = self.session_relevance_array(
             "(it as string) of ( " + relevance + " )", **kwargs
         )
         return "\n".join(rel_result_array)
 
     def login(self):
-        """do login"""
+        """Do login."""
         if bool(self.last_connected):
             duration_obj = datetime.datetime.now() - self.last_connected
             duration_minutes = duration_obj / datetime.timedelta(minutes=1)
@@ -392,14 +528,14 @@ class BESConnection:
         return bool(self.last_connected)
 
     def logout(self):
-        """clear session and close it"""
+        """Clear session and close it."""
         self.session.cookies.clear()
         self.session.close()
 
     def set_dashboard_variable_value(
         self, dashboard_name, var_name, var_value, private=False
     ):
-        """set the variable value from a dashboard datastore"""
+        """Set the variable value from a dashboard datastore."""
 
         dash_var_xml = f"""<BESAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="BESAPI.xsd">
             <DashboardData>
@@ -416,7 +552,7 @@ class BESConnection:
         )
 
     def get_dashboard_variable_value(self, dashboard_name, var_name):
-        """get the variable value from a dashboard datastore"""
+        """Get the variable value from a dashboard datastore."""
 
         return str(
             self.get(
@@ -425,7 +561,7 @@ class BESConnection:
         )
 
     def validate_site_path(self, site_path, check_site_exists=True, raise_error=False):
-        """make sure site_path is valid"""
+        """Make sure site_path is valid."""
 
         if site_path is None:
             if not raise_error:
@@ -468,8 +604,9 @@ class BESConnection:
         )
 
     def get_current_site_path(self, site_path=None):
-        """if site_path is none, get current instance site_path,
-        otherwise validate and return provided site_path"""
+        """If site_path is none, get current instance site_path,
+        otherwise validate and return provided site_path.
+        """
 
         # use instance site_path context if none provided:
         if site_path is None or str(site_path).strip() == "":
@@ -483,14 +620,14 @@ class BESConnection:
         return self.validate_site_path(site_path, check_site_exists=False)
 
     def set_current_site_path(self, site_path):
-        """set current site path context"""
+        """Set current site path context."""
 
         if self.validate_site_path(site_path):
             self.site_path = site_path
             return self.site_path
 
     def import_bes_to_site(self, bes_file_path, site_path=None):
-        """import bes file to site"""
+        """Import bes file to site."""
 
         if not os.access(bes_file_path, os.R_OK):
             besapi_logger.error("%s is not readable", bes_file_path)
@@ -513,7 +650,7 @@ class BESConnection:
             return result
 
     def create_site_from_file(self, bes_file_path, site_type="custom"):
-        """create new site"""
+        """Create new site."""
         xml_parsed = etree.parse(bes_file_path)
         new_site_name = xml_parsed.xpath("/BES/CustomSite/Name/text()")[0]
 
@@ -530,7 +667,7 @@ class BESConnection:
         return result_site
 
     def get_user(self, user_name):
-        """get a user"""
+        """Get a user."""
 
         result_users = self.get(f"operator/{user_name}")
 
@@ -540,7 +677,7 @@ class BESConnection:
         besapi_logger.info("User `%s` Not Found!", user_name)
 
     def create_user_from_file(self, bes_file_path):
-        """create user from xml"""
+        """Create user from xml."""
         xml_parsed = etree.parse(bes_file_path)
         new_user_name = xml_parsed.xpath("/BESAPI/Operator/Name/text()")[0]
         result_user = self.get_user(new_user_name)
@@ -554,7 +691,7 @@ class BESConnection:
         return self.get_user(new_user_name)
 
     def get_computergroup(self, group_name, site_path=None):
-        """get computer group resource URI"""
+        """Get computer group resource URI."""
 
         site_path = self.get_current_site_path(site_path)
         result_groups = self.get(f"computergroups/{site_path}")
@@ -569,7 +706,7 @@ class BESConnection:
         besapi_logger.info("Group `%s` Not Found!", group_name)
 
     def create_group_from_file(self, bes_file_path, site_path=None):
-        """create a new group"""
+        """Create a new group."""
         site_path = self.get_current_site_path(site_path)
         xml_parsed = etree.parse(bes_file_path)
         new_group_name = xml_parsed.xpath("/BES/ComputerGroup/Title/text()")[0]
@@ -588,7 +725,7 @@ class BESConnection:
 
     def get_upload(self, file_name, file_hash):
         """
-        check for a specific file upload reference
+        Check for a specific file upload reference.
 
         each upload is uniquely identified by sha1 and filename
 
@@ -614,7 +751,8 @@ class BESConnection:
 
     def upload(self, file_path, file_name=None, file_hash=None):
         """
-        upload a single file
+        Upload a single file.
+
         https://developer.bigfix.com/rest-api/api/upload.html
         """
         if not os.access(file_path, os.R_OK):
@@ -665,11 +803,11 @@ class BESConnection:
     def parse_upload_result_to_prefetch(
         self, result_upload, use_localhost=True, use_https=True
     ):
-        """take a rest response from an upload and parse into prefetch"""
+        """Take a rest response from an upload and parse into prefetch."""
         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
@@ -686,7 +824,7 @@ class BESConnection:
         return f"prefetch {file_name} sha1:{file_sha1} size:{file_size} {file_url} sha256:{file_sha256}"
 
     def get_content_by_resource(self, resource_url):
-        """get a single content item by resource"""
+        """Get a single content item by resource."""
         # Get Specific Content
         content = None
         try:
@@ -704,7 +842,7 @@ class BESConnection:
         return content
 
     def update_item_from_file(self, file_path, site_path=None):
-        """update an item by name and last modified"""
+        """Update an item by name and last modified."""
         site_path = self.get_current_site_path(site_path)
         bes_tree = etree.parse(file_path)
 
@@ -737,7 +875,7 @@ class BESConnection:
         export_folder="./",
         name_trim=100,
     ):
-        """save an xml string to bes file"""
+        """Save an xml string to bes file."""
         item_folder = export_folder
         if not os.path.exists(item_folder):
             os.makedirs(item_folder)
@@ -765,8 +903,10 @@ class BESConnection:
         include_item_type_folder=False,
         include_item_id=False,
     ):
-        """export a single item by resource
+        """Export a single item by resource.
+
         example resources:
+
          - content_type/site_type/site/id
          - https://localhost:52311/api/content_type/site_type/site/id
         """
@@ -813,8 +953,10 @@ class BESConnection:
         include_site_folder=True,
         include_item_ids=True,
     ):
-        """export contents of site
+        """Export contents of site.
+
         Originally here:
+
         - https://gist.github.com/jgstew/1b2da12af59b71c9f88a
         - https://bigfix.me/fixlet/details/21282
         """
@@ -890,7 +1032,7 @@ class BESConnection:
     def export_all_sites(
         self, include_external=False, export_folder="./", name_trim=70, verbose=False
     ):
-        """export all bigfix sites to a folder"""
+        """Export all bigfix sites to a folder."""
         results_sites = self.get("sites")
         if verbose:
             print(results_sites)
@@ -909,11 +1051,12 @@ class BESConnection:
 
 
 class RESTResult:
-    """BigFix REST API Result Abstraction Class"""
+    """BigFix REST API Result Abstraction Class."""
 
     def __init__(self, request):
         self.request = request
         self.text = request.text
+        self.valid = None
         self._besxml = None
         self._besobj = None
         self._besdict = None
@@ -927,7 +1070,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,
@@ -948,7 +1091,9 @@ class RESTResult:
             if self.validate_xsd(request.text):
                 self.valid = True
             else:
-                # print("WARNING: response appears invalid")
+                logging.debug(
+                    "INFO: REST API Result does not appear to be XML, this could be expected."
+                )
                 self.valid = False
 
     def __str__(self):
@@ -966,7 +1111,7 @@ class RESTResult:
 
     @property
     def besxml(self):
-        """property for parsed xml representation"""
+        """Property for parsed xml representation."""
         if self.valid and self._besxml is None:
             self._besxml = self.xmlparse_text(self.text)
 
@@ -974,7 +1119,7 @@ class RESTResult:
 
     @property
     def besobj(self):
-        """property for xml object representation"""
+        """Property for xml object representation."""
         if self.valid and self._besobj is None:
             self._besobj = self.objectify_text(self.text)
 
@@ -982,7 +1127,7 @@ class RESTResult:
 
     @property
     def besdict(self):
-        """property for python dict representation"""
+        """Property for python dict representation."""
         if self._besdict is None:
             if self.valid:
                 self._besdict = elem2dict(etree.fromstring(self.besxml))
@@ -993,18 +1138,21 @@ class RESTResult:
 
     @property
     def besjson(self):
-        """property for json representation"""
+        """Property for json representation."""
         if self._besjson is None:
             self._besjson = json.dumps(self.besdict, indent=2)
 
         return self._besjson
 
     def validate_xsd(self, doc):
-        """validate results using XML XSDs"""
+        """Validate results using XML XSDs."""
+        # return self.valid if already set
+        if self.valid is not None and isinstance(self.valid, bool):
+            return self.valid
         return validate_xsd(doc)
 
     def xmlparse_text(self, text):
-        """parse response text as xml"""
+        """Parse response text as xml."""
         if type(text) is str:
             root_xml = etree.fromstring(text.encode("utf-8"))
         else:
@@ -1013,7 +1161,7 @@ class RESTResult:
         return etree.tostring(root_xml, encoding="utf-8", xml_declaration=True)
 
     def objectify_text(self, text):
-        """parse response text as objectified xml"""
+        """Parse response text as objectified xml."""
         if type(text) is str:
             root_xml = text.encode("utf-8")
         else:
@@ -1023,7 +1171,7 @@ class RESTResult:
 
 
 def main():
-    """if invoked directly, run bescli command loop"""
+    """If invoked directly, run bescli command loop."""
     # pylint: disable=import-outside-toplevel
     try:
         from bescli import bescli

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

@@ -1,4 +1,4 @@
-"""This is a set of utility functions for use in multiple plugins
+"""This is a set of utility functions for use in multiple plugins.
 
 see example here: https://github.com/jgstew/besapi/blob/master/examples/export_all_sites.py
 """
@@ -16,7 +16,7 @@ import besapi
 
 # NOTE: This does not work as expected when run from plugin_utilities
 def get_invoke_folder(verbose=0):
-    """Get the folder the script was invoked from"""
+    """Get the folder the script was invoked from."""
     # using logging here won't actually log it to the file:
 
     if getattr(sys, "frozen", False) and hasattr(sys, "_MEIPASS"):
@@ -36,7 +36,7 @@ def get_invoke_folder(verbose=0):
 
 # NOTE: This does not work as expected when run from plugin_utilities
 def get_invoke_file_name(verbose=0):
-    """Get the filename the script was invoked from"""
+    """Get the filename the script was invoked from."""
     # using logging here won't actually log it to the file:
 
     if getattr(sys, "frozen", False) and hasattr(sys, "_MEIPASS"):
@@ -56,9 +56,9 @@ def get_invoke_file_name(verbose=0):
 
 
 def setup_plugin_argparse(plugin_args_required=False):
-    """setup argparse for plugin use"""
+    """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",
@@ -92,9 +92,10 @@ def setup_plugin_argparse(plugin_args_required=False):
 
 
 def get_plugin_logging_config(log_file_path="", verbose=0, console=True):
-    """get config for logging for plugin use
+    """Get config for logging for plugin use.
 
-    use this like: logging.basicConfig(**logging_config)"""
+    use this like: logging.basicConfig(**logging_config)
+    """
 
     if not log_file_path or log_file_path == "":
         log_file_path = os.path.join(
@@ -131,7 +132,9 @@ def get_plugin_logging_config(log_file_path="", verbose=0, console=True):
 
 
 def get_besapi_connection(args):
-    """get connection to besapi using either args or config file if args not provided"""
+    """Get connection to besapi using either args or config file if args not
+    provided.
+    """
 
     password = args.password
 

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: besapi
-Version: 3.7.8
+Version: 3.8.2
 Summary: Library for working with the BigFix REST API
 Home-page: https://github.com/jgstew/besapi
 Author: Matt Hansen, James Stewart
@@ -8,14 +8,27 @@ Author-email: hansen.m@psu.edu, james@jgstew.com
 License: MIT
 Keywords: bigfix iem tem rest api
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
 Classifier: Operating System :: OS Independent
 Classifier: License :: OSI Approved :: MIT License
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Systems Administration
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: requests
 Requires-Dist: lxml
 Requires-Dist: cmd2
+Requires-Dist: setuptools
+Dynamic: author
+Dynamic: author-email
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
 
 # besapi
 

{besapi-3.7.8 → besapi-3.8.2}/src/besapi.egg-info/requires.txt

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

{besapi-3.7.8 → besapi-3.8.2}/src/bescli/__init__.py

@@ -1,6 +1,4 @@
-"""
-bescli provides a command line interface to interact with besapi
-"""
+"""This bescli provides a command line interface to interact with besapi."""
 
 # https://stackoverflow.com/questions/279237/import-a-module-from-a-relative-path/4397291
 

{besapi-3.7.8 → besapi-3.8.2}/src/bescli/__main__.py

@@ -1,6 +1,4 @@
-"""
-To run this module directly
-"""
+"""To run this module directly."""
 
 import logging
 

{besapi-3.7.8 → besapi-3.8.2}/src/bescli/bescli.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 """
-bescli.py
+This bescli module provides a command line interface to interact with besapi.
 
 MIT License
 Copyright (c) 2014 Matt Hansen
@@ -27,12 +27,12 @@ except ModuleNotFoundError:
     from besapi import besapi
 except ImportError:
     # this is for the case in which we are calling bescli from besapi
-    import besapi
+    import besapi  # type: ignore[no-redef]
 
 try:
     from besapi.besapi import __version__
 except ImportError:
-    from besapi import __version__
+    from besapi import __version__  # type: ignore
 
 
 class BESCLInterface(Cmd):
@@ -62,7 +62,7 @@ class BESCLInterface(Cmd):
         self.do_conf()
 
     def parse_help_resources(self):
-        """get api resources from help"""
+        """Get api resources from help."""
         if self.bes_conn:
             help_result = self.bes_conn.get("help")
             help_result = help_result.text.split("\n")
@@ -89,7 +89,7 @@ class BESCLInterface(Cmd):
             ]
 
     def complete_api_resources(self, text, line, begidx, endidx):
-        """define completion for apis"""
+        """Define completion for apis."""
 
         # only initialize once
         if not self.api_resources:
@@ -102,7 +102,9 @@ class BESCLInterface(Cmd):
     complete_get = complete_api_resources
 
     def do_get(self, line):
-        """Perform get request to BigFix server using provided api endpoint argument"""
+        """Perform get request to BigFix server using provided api endpoint
+        argument.
+        """
 
         # remove any extra whitespace
         line = line.strip()
@@ -136,7 +138,9 @@ class BESCLInterface(Cmd):
     complete_delete = complete_api_resources
 
     def do_delete(self, line):
-        """Perform delete request to BigFix server using provided api endpoint argument"""
+        """Perform delete request to BigFix server using provided api endpoint
+        argument.
+        """
 
         # remove any extra whitespace
         line = line.strip()
@@ -158,20 +162,20 @@ class BESCLInterface(Cmd):
     complete_post = complete_api_resources
 
     def do_post(self, statement):
-        """post file as data to path"""
+        """Post file as data to path."""
         self.poutput(statement)
         self.poutput("not yet implemented")
 
     def do_config(self, conf_file=None):
-        """Attempt to load config info from file and login"""
+        """Attempt to load config info from file and login."""
         self.do_conf(conf_file)
 
     def do_loadconfig(self, conf_file=None):
-        """Attempt to load config info from file and login"""
+        """Attempt to load config info from file and login."""
         self.do_conf(conf_file)
 
     def do_conf(self, conf_file=None):
-        """Attempt to load config info from file and login"""
+        """Attempt to load config info from file and login."""
         config_path = [
             "/etc/besapi.conf",
             os.path.expanduser("~/besapi.conf"),
@@ -213,7 +217,7 @@ class BESCLInterface(Cmd):
             self.do_login()
 
     def do_login(self, user=None):
-        """Login to BigFix Server"""
+        """Login to BigFix Server."""
 
         if not user:
             if self.BES_USER_NAME:
@@ -292,7 +296,7 @@ class BESCLInterface(Cmd):
             self.perror("Login Error!")
 
     def do_logout(self, _=None):
-        """Logout and clear session"""
+        """Logout and clear session."""
         if self.bes_conn:
             self.bes_conn.logout()
             # del self.bes_conn
@@ -300,7 +304,7 @@ class BESCLInterface(Cmd):
         self.pfeedback("Logout Complete!")
 
     def do_debug(self, setting):
-        """Enable or Disable Debug Mode"""
+        """Enable or Disable Debug Mode."""
         self.poutput(bool(setting))
         self.debug = bool(setting)
         self.echo = bool(setting)
@@ -312,7 +316,7 @@ class BESCLInterface(Cmd):
             logging.getLogger("besapi").setLevel(logging.WARNING)
 
     def do_clear(self, arg=None):
-        """clear current config and logout"""
+        """Clear current config and logout."""
         if self.bes_conn:
             self.bes_conn.logout()
             # self.bes_conn = None
@@ -332,11 +336,11 @@ class BESCLInterface(Cmd):
             self.BES_PASSWORD = None
 
     def do_saveconfig(self, arg=None):
-        """save current config to file"""
+        """Save current config to file."""
         self.do_saveconf(arg)
 
     def do_saveconf(self, _=None):
-        """save current config to file"""
+        """Save current config to file."""
         if not self.bes_conn:
             self.do_login()
         if not self.bes_conn:
@@ -348,11 +352,11 @@ class BESCLInterface(Cmd):
                 self.CONFPARSER.write(configfile)
 
     def do_showconfig(self, arg=None):
-        """List the current settings and connection status"""
+        """List the current settings and connection status."""
         self.do_ls(arg)
 
     def do_ls(self, _=None):
-        """List the current settings and connection status"""
+        """List the current settings and connection status."""
         self.poutput("        Connected: " + str(bool(self.bes_conn)))
         self.poutput(
             "  BES_ROOT_SERVER: "
@@ -372,17 +376,17 @@ class BESCLInterface(Cmd):
             )
 
     def do_error_count(self, _=None):
-        """Output the number of errors"""
+        """Output the number of errors."""
         self.poutput(f"Error Count: {self.num_errors}")
 
     def do_exit(self, _=None):
-        """Exit this application"""
+        """Exit this application."""
         self.exit_code = self.num_errors
         # no matter what I try I can't get anything but exit code 0 on windows
         return self.do_quit("")
 
     def do_query(self, statement):
-        """Get Session Relevance Results"""
+        """Get Session Relevance Results."""
         if not self.bes_conn:
             self.do_login()
         if not self.bes_conn:
@@ -397,53 +401,53 @@ class BESCLInterface(Cmd):
                 self.poutput(rel_result)
 
     def do_version(self, _=None):
-        """output version of besapi"""
+        """Output version of besapi."""
         self.poutput(f"besapi version: {__version__}")
 
     def do_get_action(self, statement=None):
-        """usage: get_action 123"""
+        """Usage: get_action 123."""
         result_op = self.bes_conn.get(f"action/{statement}")
         self.poutput(result_op)
 
     def do_get_operator(self, statement=None):
-        """usage: get_operator ExampleOperatorName"""
+        """Usage: get_operator ExampleOperatorName."""
         result_op = self.bes_conn.get_user(statement)
         self.poutput(result_op)
 
     def do_get_current_site(self, _=None):
-        """output current site path context"""
+        """Output current site path context."""
         self.poutput(
-            f"Current Site Path: `{ self.bes_conn.get_current_site_path(None) }`"
+            f"Current Site Path: `{self.bes_conn.get_current_site_path(None)}`"
         )
 
     def do_set_current_site(self, statement=None):
-        """set current site path context"""
+        """Set current site path context."""
         self.poutput(
-            f"New Site Path: `{ self.bes_conn.set_current_site_path(statement) }`"
+            f"New Site Path: `{self.bes_conn.set_current_site_path(statement)}`"
         )
 
     def do_get_content(self, resource_url):
-        """get a specific item by resource url"""
+        """Get a specific item by resource url."""
         self.poutput(self.bes_conn.get_content_by_resource(resource_url))
 
     def do_export_item_by_resource(self, statement):
-        """export content itemb to current folder"""
+        """Export content itemb to current folder."""
         self.poutput(self.bes_conn.export_item_by_resource(statement))
 
     def do_export_site(self, site_path):
-        """export site contents to current folder"""
+        """Export site contents to current folder."""
         self.bes_conn.export_site_contents(
             site_path, verbose=True, include_site_folder=False, include_item_ids=False
         )
 
     def do_export_all_sites(self, _=None):
-        """export site contents to current folder"""
+        """Export site contents to current folder."""
         self.bes_conn.export_all_sites(verbose=False)
 
     complete_import_bes = Cmd.path_complete
 
     def do_import_bes(self, statement):
-        """import bes file"""
+        """Import bes file."""
 
         bes_file_path = str(statement.args).strip()
 
@@ -456,7 +460,7 @@ class BESCLInterface(Cmd):
     complete_upload = Cmd.path_complete
 
     def do_upload(self, file_path):
-        """upload file to root server"""
+        """Upload file to root server."""
         if not os.access(file_path, os.R_OK):
             self.poutput(file_path, "is not a readable file")
         else:
@@ -467,7 +471,7 @@ class BESCLInterface(Cmd):
     complete_create_group = Cmd.path_complete
 
     def do_create_group(self, file_path):
-        """create bigfix group from bes file"""
+        """Create bigfix group from bes file."""
         if not os.access(file_path, os.R_OK):
             self.poutput(file_path, "is not a readable file")
         else:
@@ -476,7 +480,7 @@ class BESCLInterface(Cmd):
     complete_create_user = Cmd.path_complete
 
     def do_create_user(self, file_path):
-        """create bigfix user from bes file"""
+        """Create bigfix user from bes file."""
         if not os.access(file_path, os.R_OK):
             self.poutput(file_path, "is not a readable file")
         else:
@@ -485,7 +489,7 @@ class BESCLInterface(Cmd):
     complete_create_site = Cmd.path_complete
 
     def do_create_site(self, file_path):
-        """create bigfix site from bes file"""
+        """Create bigfix site from bes file."""
         if not os.access(file_path, os.R_OK):
             self.poutput(file_path, "is not a readable file")
         else:
@@ -494,14 +498,14 @@ class BESCLInterface(Cmd):
     complete_update_item = Cmd.path_complete
 
     def do_update_item(self, file_path):
-        """update bigfix content item from bes file"""
+        """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")
         else:
             self.poutput(self.bes_conn.update_item_from_file(file_path))
 
     def do_serverinfo(self, _=None):
-        """get server info and return formatted"""
+        """Get server info and return formatted."""
 
         # not sure what the minimum version for this is:
         result = self.bes_conn.get("serverinfo")
@@ -513,7 +517,7 @@ class BESCLInterface(Cmd):
 
 
 def main():
-    """Run the command loop if invoked"""
+    """Run the command loop if invoked."""
     BESCLInterface().cmdloop()
 
 

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

@@ -1,7 +1,5 @@
 #!/usr/bin/env python
-"""
-Test besapi
-"""
+"""Test besapi."""
 
 import argparse
 import os
@@ -9,6 +7,8 @@ import random
 import subprocess
 import sys
 
+# mypy: disable-error-code="arg-type"
+
 # check for --test_pip arg
 parser = argparse.ArgumentParser()
 parser.add_argument(
@@ -79,7 +79,7 @@ assert raised_errors == 4
 
 class RequestResult(object):
     text = "this is just a test"
-    headers = []
+    headers = []  # type: ignore
 
 
 request_result = RequestResult()
@@ -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())