krkn-lib 0.0.0b0__tar.gz

krkn_lib-0.0.0b0/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

krkn_lib-0.0.0b0/PKG-INFO

@@ -0,0 +1,68 @@
+Metadata-Version: 2.3
+Name: krkn-lib
+Version: 0.0.0b0
+Summary: Foundation library for Kraken
+License: Apache-2.0
+Author: Red Hat Chaos Team
+Requires-Python: >=3.9,<4.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: PyYAML (==6.0.1)
+Requires-Dist: base64io (>=1.0.3,<2.0.0)
+Requires-Dist: coverage (>=7.6.12,<8.0.0)
+Requires-Dist: cython (==3.0)
+Requires-Dist: deprecation (==2.1.0)
+Requires-Dist: elasticsearch (==7.13.4)
+Requires-Dist: elasticsearch-dsl (==7.4.1)
+Requires-Dist: kubeconfig (>=1.1.1,<2.0.0)
+Requires-Dist: kubernetes (==28.1.0)
+Requires-Dist: numpy (==1.26.4)
+Requires-Dist: prometheus-api-client (>=0.5.4,<0.6.0)
+Requires-Dist: pytz (>=2023.3,<2024.0)
+Requires-Dist: requests (>=2.29.0,<3.0.0)
+Requires-Dist: sphinx-rtd-theme (>=1.2.2,<2.0.0)
+Requires-Dist: sphinxnotes-markdown-builder (>=0.5.6,<0.6.0)
+Requires-Dist: tzlocal (==5.1)
+Requires-Dist: wheel (>=0.42.0,<0.43.0)
+Project-URL: Homepage, https://github.com/redhat-chaos/krkn
+Description-Content-Type: text/markdown
+
+![action](https://github.com/krkn-chaos/krkn-lib/actions/workflows/build.yaml/badge.svg)
+![coverage](https://krkn-chaos.github.io/krkn-lib-docs/coverage_badge.svg)
+![PyPI](https://img.shields.io/pypi/v/krkn-lib?label=PyPi)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/krkn-lib)
+# krkn-lib
+## Krkn Chaos and resiliency testing tool Foundation Library
+
+### Contents
+The Library contains Classes, Models and helper functions used in [Kraken](https://github.com/krkn-chaos/krkn) to interact with
+Kubernetes, Openshift and other external APIS.
+The goal of this library is to give to developers the building blocks to realize new Chaos 
+Scenarios and to increase the testability and the modularity of the Krkn codebase.
+
+### Packages
+
+The library is subdivided in several Packages
+
+- **ocp:** Openshift Integration
+- **k8s:** Kubernetes Integration
+- **telemetry:** 
+- - **k8s:** Kubernetes Telemetry collection and distribution
+- - **ocp:** Openshift Telemetry collection and distribution
+- **models:** Krkn shared data models
+- **utils:** common functions
+
+### Documentation
+
+The Library documentation is available [here](https://krkn-chaos.github.io/krkn-lib-docs/).
+The documentation is automatically generated by [Sphinx](https://www.sphinx-doc.org/en/master/) on top
+of the [reStructuredText Docstring Format](https://peps.python.org/pep-0287/) comments present in the code.
+
+
+
+

krkn_lib-0.0.0b0/README.md

@@ -0,0 +1,33 @@
+![action](https://github.com/krkn-chaos/krkn-lib/actions/workflows/build.yaml/badge.svg)
+![coverage](https://krkn-chaos.github.io/krkn-lib-docs/coverage_badge.svg)
+![PyPI](https://img.shields.io/pypi/v/krkn-lib?label=PyPi)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/krkn-lib)
+# krkn-lib
+## Krkn Chaos and resiliency testing tool Foundation Library
+
+### Contents
+The Library contains Classes, Models and helper functions used in [Kraken](https://github.com/krkn-chaos/krkn) to interact with
+Kubernetes, Openshift and other external APIS.
+The goal of this library is to give to developers the building blocks to realize new Chaos 
+Scenarios and to increase the testability and the modularity of the Krkn codebase.
+
+### Packages
+
+The library is subdivided in several Packages
+
+- **ocp:** Openshift Integration
+- **k8s:** Kubernetes Integration
+- **telemetry:** 
+- - **k8s:** Kubernetes Telemetry collection and distribution
+- - **ocp:** Openshift Telemetry collection and distribution
+- **models:** Krkn shared data models
+- **utils:** common functions
+
+### Documentation
+
+The Library documentation is available [here](https://krkn-chaos.github.io/krkn-lib-docs/).
+The documentation is automatically generated by [Sphinx](https://www.sphinx-doc.org/en/master/) on top
+of the [reStructuredText Docstring Format](https://peps.python.org/pep-0287/) comments present in the code.
+
+
+

krkn_lib-0.0.0b0/pyproject.toml

@@ -0,0 +1,61 @@
+[tool.poetry]
+name = "krkn-lib"
+version = "0.0.0-beta"
+description = "Foundation library for Kraken"
+authors = ["Red Hat Chaos Team"]
+license = "Apache-2.0"
+readme = "README.md"
+homepage = "https://github.com/redhat-chaos/krkn"
+#packages = [{include= "src/krkn_lib"}]
+
+[tool.poetry.dependencies]
+python = "^3.9"
+kubernetes ="28.1.0"
+sphinxnotes-markdown-builder="^0.5.6"
+requests="^2.29.0"
+kubeconfig = "^1.1.1"
+base64io = "^1.0.3"
+sphinx-rtd-theme = "^1.2.2"
+tzlocal = "5.1"
+pytz = "^2023.3"
+PyYAML = "6.0.1"
+prometheus-api-client = "^0.5.4"
+elasticsearch = "7.13.4"
+elasticsearch-dsl = "7.4.1"
+wheel = "^0.42.0"
+cython = "3.0"
+numpy= "1.26.4"
+deprecation="2.1.0"
+coverage="^7.6.12"
+
+[tool.poetry.group.test.dependencies]
+jinja2 = "^3.1.2"
+boto3 = "^1.28.12"
+
+[tool.black]
+line-length = 79
+target-version = ['py37', 'py38']
+include = '\.pyi?$'
+exclude = '''
+/(
+    \.eggs
+  | \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build
+  | buck-out
+  | build
+  | dist
+
+  # The following are specific to Black, you probably don't want those.
+  | blib2to3
+  | tests/data
+  | profiling
+)/
+'''
+
+[build-system]
+requires = ["poetry-core>=1.1.0"]
+build-backend = "poetry.core.masonry.api"

krkn_lib-0.0.0b0/src/krkn_lib/elastic/__init__.py

@@ -0,0 +1 @@
+from .krkn_elastic import *  # NOQA

krkn_lib-0.0.0b0/src/krkn_lib/elastic/krkn_elastic.py

@@ -0,0 +1,246 @@
+from __future__ import annotations
+
+import logging
+import math
+import time
+
+import urllib3
+from elasticsearch import Elasticsearch, NotFoundError
+from elasticsearch_dsl import Search
+
+from krkn_lib.models.elastic.models import (
+    ElasticAlert,
+    ElasticChaosRunTelemetry,
+    ElasticMetric,
+)
+from krkn_lib.models.telemetry import ChaosRunTelemetry
+from krkn_lib.utils.safe_logger import SafeLogger
+
+
+class KrknElastic:
+    es = None
+
+    def __init__(
+        self,
+        safe_logger: SafeLogger,
+        elastic_url: str,
+        elastic_port: int = 443,
+        verify_certs: bool = False,
+        username: str = None,
+        password: str = None,
+    ):
+        es_logger = logging.getLogger("elasticsearch")
+        es_logger.setLevel(logging.WARNING)
+        urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
+        urllib3.disable_warnings(DeprecationWarning)
+        es_transport_logger = logging.getLogger("elastic_transport.transport")
+        es_transport_logger.setLevel(logging.CRITICAL)
+        self.safe_logger = safe_logger
+        try:
+            if not elastic_url:
+                raise Exception("elastic search url is not valid")
+            if not elastic_port:
+                raise Exception("elastic port is not valid")
+            # create Elasticsearch object
+
+            credentials = (
+                (username, password) if username and password else None
+            )
+            self.es = Elasticsearch(
+                f"{elastic_url}:{elastic_port}",
+                http_auth=credentials,
+                verify_certs=verify_certs,
+                ssl_show_warn=False,
+            )
+        except Exception as e:
+            self.safe_logger.error("Failed to initalize elasticsearch: %s" % e)
+            raise e
+
+    def upload_data_to_elasticsearch(self, item: dict, index: str = "") -> int:
+        """uploads captured data in item dictionary to Elasticsearch
+
+
+        :param item: the data to post to elastic search
+        :param index: the elastic search index pattern to post to
+
+        :return: the time taken to post the result,
+                will be 0 if index and es are blank
+        """
+
+        if self.es and index != "":
+            # Attach to elastic search and attempt index creation
+            start = time.time()
+            self.safe_logger.info(
+                f"Uploading item {item} to index {index} in Elasticsearch"
+            )
+            try:
+                response = self.es.index(index=index, body=item)
+                self.safe_logger.info(f"Response back was {response}")
+                if response["result"] != "created":
+                    self.safe_logger.error(
+                        f"Error trying to create new item in {index}"
+                    )
+                    return -1
+            except Exception as e:
+                self.safe_logger.error(f"Error trying to create new item: {e}")
+                return -1
+            end = time.time()
+            elapsed_time = end - start
+
+            # return elapsed time for upload if no issues
+            return math.ceil(elapsed_time)
+        return 0
+
+    def upload_metrics_to_elasticsearch(
+        self,
+        run_uuid: str,
+        raw_data: list[dict[str, str | int | float]],
+        index: str,
+    ) -> int:
+        """
+        Saves raw data returned from the Krkn prometheus
+        client to elastic search as a ElasticMetric object
+        raw data will be a mixed types dictionary in the format
+        {"name":"str", "values":[(10, '3.14'), (11,'3.15').....]
+
+        :param run_uuid: the krkn run id
+        :param raw_data: the mixed type dictionary (will be validated
+            checking the attributes types )
+        :param index: the elasticsearch index where
+            the object will be stored
+        :return: the time needed to save if succeeded -1 if failed
+        """
+        if not index:
+            raise Exception("index cannot be None or empty")
+        if not run_uuid:
+            raise Exception("run uuid cannot be None or empty")
+        time_start = time.time()
+        try:
+            for metric in raw_data:
+                result = self.push_metric(
+                    ElasticMetric(run_uuid=run_uuid, **metric),
+                    index,
+                )
+                if result == -1:
+                    self.safe_logger.error(
+                        f"failed to save metric "
+                        f"to elasticsearch : {metric}"
+                    )
+
+            return int(time.time() - time_start)
+        except Exception as e:
+            self.safe_logger.error(f"Upload metric exception: {e}")
+            return -1
+
+    def push_alert(self, alert: ElasticAlert, index: str) -> int:
+        """
+        Pushes an ElasticAlert object to elastic
+
+        :param alert: the populated ElasticAlert object
+        :param index: the index where the ElasticAlert Object
+            is pushed
+        :return: the time needed to save if succeeded -1 if failed
+        """
+        if not index:
+            raise Exception("index cannot be None or empty")
+        try:
+            time_start = time.time()
+            alert.save(using=self.es, index=index)
+            return int(time.time() - time_start)
+        except Exception as e:
+            self.safe_logger.error(f"Push alert exception: {e}")
+            return -1
+
+    def push_metric(self, metric: ElasticMetric, index: str) -> int:
+        """
+        Pushes an ElasticMetric object to elastic
+
+        :param metric: the populated ElasticMetric object
+        :param index: the index where the ElasticMetric Object
+            is pushed
+        :return: the time needed to save if succeeded -1 if failed
+        """
+        if not index:
+            raise Exception("index cannot be None or empty")
+        try:
+            time_start = time.time()
+            metric.save(using=self.es, index=index)
+            return int(time.time() - time_start)
+        except Exception as e:
+            print("error" + str(e))
+            self.safe_logger.error(f"Exception pushing metric: {e}")
+            return -1
+
+    def push_telemetry(self, telemetry: ChaosRunTelemetry, index: str):
+        if not index:
+            raise Exception("index cannot be None or empty")
+        try:
+            elastic_chaos = ElasticChaosRunTelemetry(telemetry)
+            time_start = time.time()
+            elastic_chaos.save(using=self.es, index=index)
+            return int(time.time() - time_start)
+        except Exception as e:
+            self.safe_logger.info(f"Elastic push telemetry error: {e}")
+            return -1
+
+    def search_telemetry(self, run_uuid: str, index: str):
+        """
+        Searches ElasticChaosRunTelemetry by run_uuid
+        :param run_uuid: the Krkn run id to search
+        :param index: the index where the ElasticChaosRunTelemetry
+            should have been saved
+        :return: the list of objects retrieved (Empty if nothing
+            has been found)
+        """
+        try:
+            search = Search(using=self.es, index=index).filter(
+                "match", run_uuid=run_uuid
+            )
+            result = search.execute()
+            documents = [
+                ElasticChaosRunTelemetry(**hit.to_dict()) for hit in result
+            ]
+        except NotFoundError:
+            self.safe_logger.error("Search telemetry not found")
+            return []
+        return documents
+
+    def search_alert(self, run_uuid: str, index: str) -> list[ElasticAlert]:
+        """
+        Searches ElasticAlerts by run_uuid
+        :param run_uuid: the Krkn run id to search
+        :param index: the index where the ElasticAlert
+            should have been saved
+        :return: the list of objects retrieved (Empty if nothing
+            has been found)
+        """
+        try:
+            search = Search(using=self.es, index=index).filter(
+                "match", run_uuid=run_uuid
+            )
+            result = search.execute()
+            documents = [ElasticAlert(**hit.to_dict()) for hit in result]
+        except NotFoundError:
+            self.safe_logger.error("Search alert not found")
+            return []
+        return documents
+
+    def search_metric(self, run_uuid: str, index: str) -> list[ElasticMetric]:
+        """
+        Searches ElasticMetric by run_uuid
+        :param run_uuid: the Krkn run id to search
+        :param index: the index where the ElasticAlert
+            should have been saved
+        :return: the list of objects retrieved (Empty if nothing
+            has been found)
+        """
+        try:
+            search = Search(using=self.es, index=index).filter(
+                "match", run_uuid=run_uuid
+            )
+            result = search.execute()
+            documents = [ElasticMetric(**hit.to_dict()) for hit in result]
+        except NotFoundError:
+            self.safe_logger.error("Search metric not found")
+            return []
+        return documents

krkn_lib-0.0.0b0/src/krkn_lib/k8s/__init__.py

@@ -0,0 +1 @@
+from .krkn_kubernetes import *  # NOQA