test: Updated doc and wait for uf method

Author: rajkarkar-crest

docs/release_history.rst

@@ -8,7 +8,18 @@ Release History
 
 The best way to track the development of pytest-splunk-addon is through `the GitHub Repo <https://github.com/splunk/pytest-splunk-addon/>`_.
 
-1.4.0
+1.5.0
+"""""""""""""""""""""""""
+    **Changes:**
+ 
+    * Added support for ingestion of data via pytest-splunk-addon with a user-defined index ``index = <index_name>``.
+
+    **Known Issues:**
+
+    * Event ingestion through SC4S via UDP port
+    * Fields for modular regular expressions are not extracted in the plugin.
+
+1.4.0 (2021-01-05)
 """"""""""""""""""""""""""
     **Changes:**
 
@@ -20,7 +31,7 @@ The best way to track the development of pytest-splunk-addon is through `the Git
     * Fields for modular regular expressions are not extracted in the plugin.
 
 
-1.3.15
+1.3.15 (2020-12-16)
 """"""""""""""""""""""""""
     **Changes:**
 

pytest_splunk_addon/splunk.py

@@ -429,7 +429,7 @@ def uf(request):
     uf["uf_username"] = request.config.getoption("splunk_uf_user")
     uf["uf_password"] = request.config.getoption("splunk_uf_password")
     for _ in range(RESPONSIVE_SPLUNK_TIMEOUT):
-        if is_responsive_splunk(uf):
+        if is_responsive_uf(uf):
             break
         sleep(1)
     yield uf
@@ -708,6 +708,35 @@ def file_system_prerequisite():
         shutil.rmtree(UF_FILE_MONTOR_DIR, ignore_errors=True)
     os.mkdir(monitor_dir)
 
+def is_responsive_uf(uf):
+    """
+    Verify if the management port of Universal Forwarder is responsive or not
+
+    Args:
+        uf (dict): details of the Universal Forwarder instance
+
+    Returns:
+        bool: True if Universal Forwarder is responsive. False otherwise
+    """
+    try:
+        LOGGER.info(
+            "Trying to connect Universal Forwarder instance...  splunk=%s", json.dumps(uf),
+        )
+        client.connect(
+            username=uf["uf_username"],
+            password=uf["uf_password"],
+            host=uf["uf_host"],
+            port=uf["uf_port"],
+        )
+        LOGGER.info("Connected to Universal Forwarder instance.")
+
+        return True
+    except Exception as e:
+        LOGGER.warning(
+            "Could not connect to Universal Forwarder Instance. Will try again. exception=%s", str(e),
+        )
+        return False
+
 def is_responsive_splunk(splunk):
     """
     Verify if the management port of Splunk is responsive or not