chore: changes after review

Author: sgoral-splunk

solnlib/splunkenv.py

@@ -63,24 +63,12 @@ def msp(*args, **kwargs):
     "get_conf_key_value",
     "get_conf_stanza",
     "get_conf_stanzas",
-    "_get_conf_stanzas_from_splunk_api",
 ]
 
 ETC_LEAF = "etc"
 APP_SYSTEM = "system"
 APP_HEC = "splunk_httpinput"
 
-# See validateSearchHeadPooling() in src/libbundle/ConfSettings.cpp
-on_shared_storage = [
-    os.path.join(ETC_LEAF, "apps"),
-    os.path.join(ETC_LEAF, "users"),
-    os.path.join("var", "run", "splunk", "dispatch"),
-    os.path.join("var", "run", "splunk", "srtemp"),
-    os.path.join("var", "run", "splunk", "rss"),
-    os.path.join("var", "run", "splunk", "scheduler"),
-    os.path.join("var", "run", "splunk", "lookup_tmp"),
-]
-
 
 class SessionKeyNotFound(Exception):
     pass
@@ -409,7 +397,11 @@ def _get_conf_stanzas_from_splunk_api(
         session_key = getattr(__main__, "___sessionKey")
 
     if not session_key:
-        raise SessionKeyNotFound()
+        raise SessionKeyNotFound(
+            "Session key is missing. If you are using 'splunkenv' module in your TA, please ensure you are "
+            "providing session_key to it's functions. For more information "
+            "please see: https://splunk.github.io/addonfactory-solutions-library-python/release_7_0_0/"
+        )
 
     server_response, server_content = simpleRequest(
         url,

tests/integration/test_splunkenv.py

@@ -13,19 +13,23 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+import pytest
 
 import context
 import conftest
 import os
 import os.path as op
 import sys
 from solnlib import splunkenv
+from unittest import mock
 
 sys.path.insert(0, op.dirname(op.dirname(op.abspath(__file__))))
 
 
-def test_splunkenv(monkeypatch):
+@mock.patch("solnlib.splunkenv.getSessionKey")
+def test_splunkenv(mock_get_session_key, monkeypatch):
     conftest.mock_splunk(monkeypatch)
+    mock_get_session_key.return_value = None
 
     assert "SPLUNK_HOME" in os.environ
 
@@ -51,3 +55,13 @@ def test_splunkenv(monkeypatch):
 
     uri = splunkenv.get_splunkd_uri(sk)
     assert uri == f"{scheme}://{host}:{port}"
+
+    exp_msg = (
+            "Session key is missing. If you are using 'splunkenv' module in your TA, please ensure you are "
+            "providing session_key to it's functions. For more information "
+            "please see: https://splunk.github.io/addonfactory-solutions-library-python/release_7_0_0/"
+        )
+
+    with pytest.raises(splunkenv.SessionKeyNotFound) as e:
+        splunkenv.get_splunk_host_info()
+    assert e.value.args[0] == exp_msg