BREAKING CHANGE: remove btool and replace it with splunk.rest (#441)

**Issue number:
[ADDON-79884](https://splunk.atlassian.net/browse/ADDON-79884)**

### PR Type

**What kind of change does this PR introduce?**
* [ ] Feature
* [x] Bug Fix
* [ ] Refactoring (no functional or API changes)
* [ ] Documentation Update
* [ ] Maintenance (dependency updates, CI, etc.)

## Summary

### Changes

`solnlib` will no longer use Splunk's `btool`. `btool` was replaced with
configuration endpoint from Splunk `splunk.rest` module. Since
`session_key` is required for an authorization, `solnlib` no longer
supports `get_session_key()` function. Also function
`make_splunkhome_path` will now use native Splunk's implementation from
`splunk.clilib.bundle_paths`

### User experience

It's a breaking change for the user as functions related to getting
stanza from config files will now required `app_name` and `session_key`
to work properly.

If users uses `get_session_key()` from `solnlib` they will need to
replace it with their own implementation.

## Checklist

introduced new method `_get_conf_stanzas_from_splunk_api`
Following functions will now require app_name and/or session_key as a
arguments to work:
* get_conf_stanza
* get_conf_key_value
* get_splunkd_uri
* get_scheme_from_hec_settings
* get_splunkd_access_info
* get_splunk_host_info

make_splunkhome_path() now uses
`splunk.clilib.bundle_paths.make_splunkhome_path`

### Review

* [x] self-review - I have performed a self-review of this change
according to the [development
guidelines](https://splunk.github.io/addonfactory-ucc-generator/contributing/#development-guidelines)
* [ ] Changes are documented. The documentation is understandable,
examples work [(more
info)](https://splunk.github.io/addonfactory-ucc-generator/contributing/#documentation-guidelines)
* [x] PR title and description follows the [contributing
principles](https://splunk.github.io/addonfactory-ucc-generator/contributing/#pull-requests)
* [ ] meeting - I have scheduled a meeting or recorded a demo to explain
these changes (if there is a video, put a link below and in the ticket)

### Tests

See [the testing
doc](https://splunk.github.io/addonfactory-ucc-generator/contributing/#build-and-test).

* [ ] Unit - tests have been added/modified to cover the changes
* [ ] Smoke - tests have been added/modified to cover the changes
* [ ] UI - tests have been added/modified to cover the changes
* [x] coverage - I have checked the code coverage of my changes [(see
more)](https://splunk.github.io/addonfactory-ucc-generator/contributing/#checking-the-code-coverage)

**Demo/meeting:**

*Reviewers are encouraged to request meetings or demos if any part of
the change is unclear*

Author: hetangmodi-crest

docs/release_7_0_0.md

@@ -0,0 +1,46 @@
+# Removed usage of btool command from solnlib
+
+As of version 7.0.0, the `btool` command has been removed from solnlib. Configuration stanzas and keys should now be accessed via the REST API. 
+Additionally, the `splunkenv` module can only be used in environments where Splunk is installed, as it relies on Splunk-specific methods for making internal calls.
+
+## Session key is now mandatory in some of the functions
+
+The affected functions now require a valid `session_key` to operate correctly. While solnlib attempts to retrieve the `session_key` automatically, 
+there are scenarios—such as within a modular input script—where this is not possible. In such cases, you must explicitly provide the `session_key` 
+to ensure proper authorization. Affected functions are:
+
+* `get_splunk_host_info`
+* `get_splunkd_access_info`
+* `get_scheme_from_hec_settings`
+* `get_splunkd_uri`
+* `get_conf_key_value`
+* `get_conf_stanza`
+
+## Changed arguments in `get_conf_key_value` and `get_conf_stanza`
+
+As of version 7.0.0, the following changes have been made to the function:
+
+`get_conf_key_value` now requires 4 mandatory arguments:
+
+* `conf_name`
+* `stanza`
+* `key`
+* `app_name` (new)
+
+`get_conf_stanza` now requires 3 mandatory arguments:
+
+* `conf_name`
+* `stanza`
+* `app_name` (new)
+
+Both functions also accept the following optional arguments:
+
+* `session_key` - Used for authentication. If not provided, a 401 Unauthorized error may occur depending on the context.
+* `users` - Limits results returned by the configuration endpoint. Defaults to `nobody`.
+* `raw_output` - If set to `True`, the full decoded JSON response is returned. 
+This should be enabled when `app_name` is set to the global context `(/-/)`, as the Splunk REST API may return multiple entries in that case.
+
+## The `get_session_key` function has been removed from solnlib
+
+This function relied on reading the `scheme`, `host` and `port` using the deprecated btool utility, which is no longer supported.
+

mkdocs.yml

@@ -31,6 +31,7 @@ plugins:
 nav:
   - Home: index.md
   - Release 6.0.0: release_6_0_0.md
+  - Release 7.0.0: release_7_0_0.md
   - References:
       - modular_input:
           - "checkpointer.py": modular_input/checkpointer.md

solnlib/_settings.py

@@ -0,0 +1,18 @@
+#
+# Copyright 2025 Splunk Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+"""This module provide settings that can be used to disable/switch features."""
+
+use_btool = False

solnlib/credentials.py

@@ -16,23 +16,19 @@
 
 """This module contains Splunk credential related interfaces."""
 
-import json
 import re
 import warnings
 from typing import Dict, List
 
 from splunklib import binding, client
 
 from . import splunk_rest_client as rest_client
-from .net_utils import validate_scheme_host_port
-from .splunkenv import get_splunkd_access_info
 from .utils import retry
 
 __all__ = [
     "CredentialException",
     "CredentialNotExistException",
     "CredentialManager",
-    "get_session_key",
 ]
 
 
@@ -339,56 +335,3 @@ def _get_all_passwords(self) -> List[Dict[str, str]]:
         )
         passwords = self._storage_passwords.list(count=-1)
         return self._get_clear_passwords(passwords)
-
-
-@retry(exceptions=[binding.HTTPError])
-def get_session_key(
-    username: str,
-    password: str,
-    scheme: str = None,
-    host: str = None,
-    port: int = None,
-    **context: dict,
-) -> str:
-    """Get splunkd access token.
-
-    Arguments:
-        username: The Splunk account username, which is used to authenticate the Splunk instance.
-        password: The Splunk account password.
-        scheme: (optional) The access scheme, default is None.
-        host: (optional) The host name, default is None.
-        port: (optional) The port number, default is None.
-        context: Other configurations for Splunk rest client.
-
-    Returns:
-        Splunk session key.
-
-    Raises:
-        CredentialException: If username/password are invalid.
-        ValueError: if scheme, host or port are invalid.
-
-    Examples:
-       >>> get_session_key('user', 'password')
-    """
-    validate_scheme_host_port(scheme, host, port)
-
-    if any([scheme is None, host is None, port is None]):
-        scheme, host, port = get_splunkd_access_info()
-
-    uri = "{scheme}://{host}:{port}/{endpoint}".format(
-        scheme=scheme, host=host, port=port, endpoint="services/auth/login"
-    )
-    _rest_client = rest_client.SplunkRestClient(
-        None, "-", "nobody", scheme, host, port, **context
-    )
-    try:
-        response = _rest_client.http.post(
-            uri, username=username, password=password, output_mode="json"
-        )
-    except binding.HTTPError as e:
-        if e.status != 401:
-            raise
-
-        raise CredentialException("Invalid username/password.")
-
-    return json.loads(response.body.read())["sessionKey"]

solnlib/modular_input/event_writer.py

@@ -23,6 +23,7 @@
 import threading
 import time
 import traceback
+import warnings
 from abc import ABCMeta, abstractmethod
 from random import randint
 from typing import List, Union
@@ -39,6 +40,16 @@
 __all__ = ["ClassicEventWriter", "HECEventWriter"]
 
 
+deprecation_msg = (
+    "Function 'create_from_token' is deprecated and incompatible with 'global_settings_schema=True'. "
+    "Use 'create_from_token_with_session_key' instead."
+)
+
+
+class FunctionDeprecated(Exception):
+    pass
+
+
 class EventWriter(metaclass=ABCMeta):
     """Base class of event writer."""
 
@@ -233,13 +244,13 @@ def __init__(
             scheme, host, hec_port = utils.extract_http_scheme_host_port(hec_uri)
         else:
             if not all([scheme, host, port]):
-                scheme, host, port = get_splunkd_access_info()
+                scheme, host, port = get_splunkd_access_info(self._session_key)
             hec_port, hec_token = self._get_hec_config(
                 hec_input_name, session_key, scheme, host, port, **context
             )
 
         if global_settings_schema:
-            scheme = get_scheme_from_hec_settings()
+            scheme = get_scheme_from_hec_settings(self._session_key)
 
         if not context.get("pool_connections"):
             context["pool_connections"] = 10
@@ -272,6 +283,11 @@ def create_from_token(
             Created HECEventWriter.
         """
 
+        warnings.warn(deprecation_msg, DeprecationWarning, stacklevel=2)
+
+        if global_settings_schema:
+            raise FunctionDeprecated(deprecation_msg)
+
         return HECEventWriter(
             None,
             None,

solnlib/server_info.py

@@ -78,7 +78,7 @@ def __init__(
         """
         is_localhost = False
         if not all([scheme, host, port]) and os.environ.get("SPLUNK_HOME"):
-            scheme, host, port = get_splunkd_access_info()
+            scheme, host, port = get_splunkd_access_info(session_key)
             is_localhost = (
                 host == "localhost" or host == "127.0.0.1" or host in ("::1", "[::1]")
             )

solnlib/splunk_rest_client.py

@@ -221,7 +221,7 @@ def __init__(
         """
         # Only do splunkd URI discovery in SPLUNK env (SPLUNK_HOME is set).
         if not all([scheme, host, port]) and os.environ.get("SPLUNK_HOME"):
-            scheme, host, port = get_splunkd_access_info()
+            scheme, host, port = get_splunkd_access_info(session_key)
         if os.environ.get("SPLUNK_HOME") is None:
             if not all([scheme, host, port]):
                 raise ValueError(