fix: revert helmut's library clean up

This reverts commit e947cb2.

Author: Artem Rys

poetry.lock

@@ -32,6 +32,7 @@ classifiers = [
 include = ["pytest_splunk_addon/**/*.json", "pytest_splunk_addon/**/*.txt"]
 
 [tool.poetry.dependencies]
+httplib2 = "*"
 python = "^3.7"
 pytest = ">5.4.0,<6.3"
 splunk-sdk = "^1.6"

pyproject.toml

@@ -0,0 +1,214 @@
+#
+# Copyright 2021 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.
+#
+"""
+Summary
+=======
+A module which deals with a Splunk app
+"""
+
+import logging
+import os
+from builtins import object
+
+from pytest_splunk_addon.helmut.manager.confs import Confs
+
+
+class App(object):
+    """
+    A representation of a Splunk Application
+
+    @ivar __logger: The logger we use
+    @ivar _required_indexes: Sub classes can indexes to this list and they will
+                             be added as part of the setup. The indexes must be
+                             know by the filegetter.py, the format of each
+                             entry is a dictionary with the same parameters as
+                             the filegetter.get_file method.
+    @ivar _required_configs: A list of paths to config files that should be
+                             copied to the app's local config directory as part
+                             of the setup
+    @ivar _required_lookups: A list of paths to lookup files that should be
+                             copied to the app's lookup directory as part of
+                             the setup
+    @ivar _name: The name of this app
+    @ivar _splunk: The splunk instance this app belongs to
+    @ivar _config_manager: The config manager for this app
+    @ivar _shared_service: The shared service for this app.
+    @ivar package: The package this app will be installed from or None if not
+                   package exists.
+    """
+
+    DEFAULT_NAMESPACE = "nobody:{app_name}"
+
+    def __init__(self, name, splunk, package=None):
+        """
+        Constructs this app
+
+        @param name: The name of the app, should be all lower case.
+        @type name: str
+
+        @param splunk: The splunk instance this app belongs to.
+        @type splunk: Splunk
+
+        @param package: An optional path to any package this app can be
+                        installed from
+        @type package: str
+        """
+        super(App, self).__init__()
+
+        self.__logger = logging.getLogger("App-{0}".format(name))
+
+        self._name = name
+        self._splunk = splunk
+        self._confs = None
+
+        self.package = package
+
+    @property
+    def confs(self):
+        """
+        The confs manager that is used for this app.
+
+        The manager will have a namespace that has the app portion set to this
+        app.
+
+        @rtype: L{Confs}
+        """
+        if self._confs is None:
+            self._confs = self._create_confs_manager()
+        return self._confs
+
+    def _create_confs_manager(self):
+        """
+        Creates a confs manager for this app.
+
+        It uses the same connector factory as the Splunk instance.
+
+        @return: The newly created confs manager.
+        @rtype: L{Confs}
+        """
+        return Confs(self.splunk.default_connector)
+
+    @property
+    def namespace(self):
+        """
+        The namespace for this app.
+
+        @rtype: str
+        """
+        return self.DEFAULT_NAMESPACE.format(app_name=self._name)
+
+    @confs.setter
+    def confs(self, value):
+        """
+        Updates the confs manager for this app.
+
+        @param value: The new manager.
+        @type value: L{Confs}
+        """
+        self._confs = value
+
+    @property
+    def installed(self):
+        """
+        Checks too see whether this app is already installed or not.
+
+        It does this by checking if the directory exists which means that there
+        is no guarantee that it was installed this session.
+
+        @rtype: bool
+        """
+        return self.splunk.has_app(self.name)
+
+    @property
+    def name(self):
+        """
+        The name for this app
+
+        @rtype: str
+        """
+        return self._name
+
+    @property
+    def splunk(self):
+        """
+        The Splunk instance this app belongs to
+
+        @rtype: L{Splunk}
+        """
+        return self._splunk
+
+    @property
+    def apps_dir(self):
+        """
+        The path to the directory that splunk stores it's apps
+
+        @rtype: str
+        """
+        return self.splunk.apps_dir
+
+    @property
+    def install_path(self):
+        """
+        The path to the directory where this app will be/is installed
+
+        @rtype: str
+        """
+        return os.path.join(self.apps_dir, self.name)
+
+    def can_install(self):
+        """
+        Checks if this app can be installed meaning if a package has been
+        supplied.
+
+        @rtype: bool
+        @return: True if this app can be installed
+        """
+        return self.package is not None
+
+    def install(self):
+        """
+        Installs this app.
+
+        @rtype: bool
+        @return: True if the app was installed and splunk needs to restart
+        """
+        self._verify_can_install()
+        return self.splunk.install_app(self.name, self.package)
+
+    def _verify_can_install(self):
+        """
+        Checks that this app can be installed and raising an exception if it
+        can't.
+
+        @raise AppHasNoPackage: If the app can't be installed.
+        """
+        if not self.package:
+            raise AppHasNoPackage(self.name)
+
+    def uninstall(self):
+        """
+        Uninstalls this app
+
+        @rtype: bool
+        @return: True if the app was installed and has now been removed
+        """
+        return self.splunk.uninstall_app(self.name)
+
+
+class AppHasNoPackage(RuntimeError):
+    def __init__(self, app_name):
+        msg = "The app {0} has no package to install from".format(app_name)
+        super(AppHasNoPackage, self).__init__(msg)

pytest_splunk_addon/helmut/app/__init__.py

@@ -21,6 +21,7 @@
 @since: 2011-11-21
 """
 
-__all__ = ["sdk"]
+__all__ = ["sdk", "rest"]
 
+from .rest import RESTConnector
 from .sdk import SDKConnector

pytest_splunk_addon/helmut/connector/__init__.py

@@ -22,6 +22,8 @@
 """
 
 from abc import ABCMeta
+from builtins import range
+from builtins import str
 
 from future.utils import with_metaclass
 

pytest_splunk_addon/helmut/connector/base.py

@@ -0,0 +1,82 @@
+#
+# Copyright 2021 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.
+#
+from future import standard_library
+
+standard_library.install_aliases()
+from builtins import range
+import httplib2
+import logging
+import time
+import random
+from io import BytesIO
+from http.client import ResponseNotReady
+
+RETRIES = 3
+
+
+def sdk_request_adapter(url, message, **kwargs):
+    """
+    :param url: the URL to make the request to (including any query and fragment sections)
+    :param message: a dictionary with the following keys:
+        - method: The method for the request, typically ``GET``, ``POST``, or ``DELETE``.
+        - headers: A list of pairs specifying the HTTP headers (for example: ``[('key': value), ...]``).
+        - body: A string containing the body to send with the request (this string
+          should default to '').
+    :param kwargs: not used
+    :return: response_dict, a dictionary with the following keys:
+        - status: An integer containing the HTTP status code (such as 200 or 404).
+        - reason: The reason phrase, if any, returned by the server.
+        - headers: A list of pairs containing the response headers (for example, ``[('key': value), ...]``).
+        - body: A stream-like object supporting ``read(size=None)`` and ``close()`` methods to get the body of the response.
+    """
+    method = message.get("method", "GET").upper()
+    body = message.get("body", "") if method == "POST" else None
+    headers = dict(message.get("headers", []))
+    h = httplib2.Http(disable_ssl_certificate_validation=True)
+    for i in range(RETRIES):
+        try:
+            resp, content = h.request(url, method=method, body=body, headers=headers)
+            break
+        except ResponseNotReady:
+            # splunk restart is still in progress
+            time.sleep(30)
+        except Exception as ex:  # noqa: E722
+            logging.getLogger("..connector").exception(
+                "request failed, url=%s, attempts=%s", url, i + 1
+            )
+            if i == RETRIES - 1 or not _is_retry_safe(method, url):
+                raise
+            else:
+                # intermediate network error
+                time.sleep(random.randint(5, 17))
+
+    return {
+        "status": resp.status,
+        "reason": resp.reason,
+        "headers": resp,
+        "body": BytesIO(content),
+    }
+
+
+def _is_retry_safe(method, url):
+    if method in ("GET", "HEAD", "DELETE", "PUT"):
+        # idempotent request
+        return True
+    elif method == "POST":
+        for rest_url in ["/auth/login"]:
+            if rest_url in url:
+                return True
+    return False