skyramp 0.4.30__tar.gz

skyramp-0.4.30/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.1
+Name: skyramp
+Version: 0.4.30
+Summary: module for leveraging skyramp cli functionality
+Requires-Python: >=3.0
+Description-Content-Type: text/markdown
+Classifier: License :: OSI Approved :: MIT License
+
+# Skyramp
+Skyramp is a pip module that provides utility functions for leveraging [skyramp CLI](https://skyramp.dev/docs/commands/skyramp/) commands.
+
+## Installation
+To install Skyramp, simply run the following command in your terminal:
+```
+pip install skyramp
+```
+
+## Usage
+Once you've installed Skyramp, you can import it into your project like this:
+```
+import skyramp
+```
+

skyramp-0.4.30/README.md

@@ -0,0 +1,14 @@
+# Skyramp
+Skyramp is a pip module that provides utility functions for leveraging [skyramp CLI](https://skyramp.dev/docs/commands/skyramp/) commands.
+
+## Installation
+To install Skyramp, simply run the following command in your terminal:
+```
+pip install skyramp
+```
+
+## Usage
+Once you've installed Skyramp, you can import it into your project like this:
+```
+import skyramp
+```

skyramp-0.4.30/pyproject.toml

@@ -0,0 +1,13 @@
+[build-system]
+requires = ["flit_core >=3.2,<4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "skyramp"
+version = "0.4.30"
+description = "module for leveraging skyramp cli functionality"
+readme = "README.md"
+requires-python = ">=3.0"
+classifiers = [
+    "License :: OSI Approved :: MIT License"
+]

skyramp-0.4.30/src/skyramp/__init__.py

@@ -0,0 +1,7 @@
+"""
+Provides utility functions and classes for leveraging Skyramp functionality.
+"""
+
+from skyramp.client import _Client as Client
+from skyramp.endpoint import _RestEndpoint as RestEndpoint
+from skyramp.endpoint import _GrpcEndpoint as GrpcEndpoint

skyramp-0.4.30/src/skyramp/client.py

@@ -0,0 +1,183 @@
+"""
+Defines a Skyramp client, which can be used to interact with a cluster.
+"""
+
+import ctypes
+import yaml
+
+from skyramp.utils import _library, _call_function
+
+
+class _Client:
+    """
+    Skyramp client object which can be used to interact with a cluster.
+    """
+
+    def __init__(
+        self,
+        kubeconfig_path: str = "",
+        cluster_name: str = "",
+        context: str = "",
+    ) -> None:
+        """
+        Initializes a Skyramp Client.
+
+        kubeconfig_path: The filesystem path of a kubeconfig
+        cluster_name: The name of the cluster.
+        context: The Kubernetes context within a kubeconfig
+        """
+        self.kubeconfig_path = kubeconfig_path
+        self.cluster_name = cluster_name
+        self.context = context
+
+        self._namespace_set = set()
+
+    def apply_local(self) -> None:
+        """
+        Creates a local cluster.
+        """
+        apply_local_function = _library.applyLocalWrapper
+        argtypes = []
+        restype = ctypes.c_char_p
+
+        _call_function(apply_local_function, argtypes, restype, [])
+
+        self.kubeconfig_path = self._get_kubeconfig_path()
+        if not self.kubeconfig_path:
+            raise Exception("no kubeconfig found")
+
+    def remove_local(self) -> None:
+        """
+        Removes a local cluster.
+        """
+        func = _library.removeLocalWrapper
+        argtypes = []
+        restype = ctypes.c_char_p
+
+        _call_function(func, argtypes, restype, [])
+
+    def add_kubeconfig(
+        self,
+        context: str,
+        cluster_name: str,
+        kubeconfig_path: str,
+    ) -> None:
+        """
+        Adds a preexisting Kubeconfig file to Skyramp.
+
+        context: The kubeconfig context to use
+        cluster_name: Name of the cluster
+        kubeconfig_path: filepath of the kubeconfig
+        """
+        func = _library.addKubeconfigWrapper
+        argtypes = [ctypes.c_char_p, ctypes.c_bool, ctypes.c_char_p, ctypes.c_char_p]
+        restype = ctypes.c_char_p
+
+        _call_function(
+            func,
+            argtypes,
+            restype,
+            [
+                context.encode(),
+                cluster_name.encode(),
+                kubeconfig_path.encode(),
+            ],
+        )
+
+        self.kubeconfig_path = kubeconfig_path
+
+    def remove_cluster(self, cluster_name: str) -> None:
+        """
+        Removes a cluster, corresponding to the name, from Skyramp
+        """
+        func = _library.removeClusterFromConfigWrapper
+        argtypes = [ctypes.c_char_p]
+        restype = ctypes.c_char_p
+
+        _call_function(func, argtypes, restype, [cluster_name.encode()])
+
+    def deploy_skyramp_worker(
+        self, namespace: str, worker_image: str, local_image: bool
+    ) -> None:
+        """
+        Installs a Skyramp worker onto a cluster if one is registered with Skyramp
+        """
+        if not self.kubeconfig_path:
+            raise Exception("no cluster to deploy worker to")
+
+        func = _library.deploySkyrampWorkerWrapper
+        argtypes = [ctypes.c_char_p, ctypes.c_char_p, ctypes.c_bool]
+        restype = ctypes.c_char_p
+
+        _call_function(
+            func,
+            argtypes,
+            restype,
+            [namespace.encode(), worker_image.encode(), local_image],
+        )
+
+        self._namespace_set.add(namespace)
+
+    def delete_skyramp_worker(self, namespace: str) -> None:
+        """
+        Removes the Skyramp worker, if a Skyramp worker is installed on a registered Skyramp cluster
+        """
+        if not self.kubeconfig_path:
+            raise Exception("no cluster to delete worker from")
+
+        if namespace not in self._namespace_set:
+            raise Exception(f"no worker to delete from {namespace} namespace")
+
+        func = _library.deleteSkyrampWorkerWrapper
+        argtypes = [ctypes.c_char_p]
+        restype = ctypes.c_char_p
+
+        _call_function(func, argtypes, restype, [namespace.encode()])
+
+        self._namespace_set.remove(namespace)
+
+    def mocker_apply(self, namespace: str, endpoint: str) -> None:
+        """
+        Applies a configuration to mocker.
+        namespace: The namespace where mocker resides
+        endpoint: The Skyramp enpdoint object
+        """
+        yaml_string = yaml.dump(endpoint.mock_description)
+
+        func = _library.applyMockDescriptionWrapper
+        argtypes = [
+            ctypes.c_char_p,
+            ctypes.c_char_p,
+        ]
+        restype = ctypes.c_char_p  # pylint: disable=duplicate-code
+
+        _call_function(
+            func,
+            argtypes,
+            restype,
+            [
+                namespace.encode(),
+                yaml_string.encode(),
+            ],
+        )
+
+    # This will be implemented when scenarios are added.
+    # def tester_start(self, namespace: str, scenario: str) -> str:
+    #     """
+    #     Runs tester at the given namespace and test name
+    #     namespace: The namespace where mocker resides
+    #     """
+    #     func = _library.runTesterStartWrapper
+    #     argtypes = [ctypes.c_char_p, ctypes.c_char_p]
+    #     restype = ctypes.c_char_p
+
+    #     _call_function(
+    #         func, argtypes, restype, [namespace.encode(), test_description.encode()]
+    #     )
+
+    def _get_kubeconfig_path(self) -> str:
+        func = _library.getKubeConfigPath
+        argtypes = []
+        restype = ctypes.c_char_p
+
+        return _call_function(func, argtypes, restype, [], True)

skyramp-0.4.30/src/skyramp/endpoint.py

@@ -0,0 +1,166 @@
+"""
+Contains helpers for interacting with Skyramp endpoints.
+"""
+
+from abc import ABC, abstractmethod
+
+import os
+import ctypes
+import json
+import yaml
+
+from skyramp.utils import _library, _call_function
+
+class _Endpoint(ABC):
+    """
+    Base class for endpoints. This should not be used for instantiation.
+    """
+
+    @abstractmethod
+    def __init__(self, endpoint_data: str) -> None:
+        try:
+            endpoint = json.loads(endpoint_data)
+            self.services = endpoint["services"]
+            self.endpoint = endpoint["endpoints"][0]
+
+            for method in self.endpoint["methods"]:
+                method["proxy"] = True
+
+            self.response_values = endpoint["responseValues"]
+
+            self.mock_description = {
+                "services": self.services,
+                "endpoints": [self.endpoint],
+                "responseValues": self.response_values
+            }
+        except:
+            raise Exception("failed to parse endpoint data")
+
+    def mock_method(self, method_name: str, mock_object: str, dynamic: bool = False) -> None:
+        """
+        Adds the given mock_data blob to the method name for this endpoint.
+        """
+        for method in self.endpoint["methods"]:
+            if method_name not in [method.get("name"), method.get("type")]:
+                continue
+
+            response_name = method["responseValue"]
+            method.pop("proxy", None)
+
+            for response_value in self.response_values:
+                if response_value["name"] != response_name:
+                    continue
+
+                if dynamic:
+                    response_value["javascriptPath"] = mock_object
+                    response_value.pop("blob", None)
+                else:
+                    response_value["blob"] = mock_object["responseValue"]["blob"]
+                    response_value.pop("javascriptPath", None)
+                return
+
+        raise Exception(f"method {method_name} not found")
+
+    def mock_method_from_file(self, method_name: str, file_name: str) -> None:
+        """
+        Uses the given mock data from a provided file, and associates it with the
+        corresponding method_name for this endpoint.
+        """
+        _, file_ext = os.path.splitext(file_name)
+
+        try:
+            with open(file_name) as file:
+                file_contents = file.read()
+        except:
+            raise Exception(f"failed to open file: {file_name}")
+
+        dynamic = False
+
+        if file_ext == ".json":
+            data = json.loads(file_contents)
+        elif file_ext in [".yaml", ".yml"]:
+            data = yaml.safe_load(file_contents)
+        elif file_ext == ".js":
+            dynamic = True
+            data = file_name
+        else:
+            raise Exception(
+                f"unsupported file format: {file_ext}. Only JSON and YAML are supported"
+            )
+
+        return self.mock_method(method_name=method_name, mock_object=data, dynamic=dynamic)
+
+    def write_mock_configuration_to_file(self, alias: str) -> None:
+        """
+        Persists (as a file to be used by Skyramp) all of the mock configurations
+        for this endpoint.
+
+        alias: The name of the networking alias that will be used to reach this endpoint. 
+        For example, it can be the Kubernetes service name or the Docker alias name.
+        """
+        try:
+            yaml_content = yaml.dump(self.mock_description)
+        except:
+            raise Exception("failed to convert mock description to YAML")
+
+        func = _library.writeMockDescriptionWrapper
+        argtypes = [ctypes.c_char_p, ctypes.c_char_p]
+        restype = ctypes.c_char_p
+
+        _call_function(func, argtypes, restype, [yaml_content.encode(), alias.encode()])
+
+
+class _GrpcEndpoint(_Endpoint):
+    """
+    Represents an endpoint of a gRPC based service.
+    """
+
+    def __init__(self, name: str, service: str, port: int, pb_file: str) -> None:
+        """
+        name: Name of the endpoint
+        service: The service name to associate with this endpoint
+        port: Port number where the endpoint will be reached
+        pb_file: Protobuf file with definitions corresponding to this endpoint
+        """
+        func = _library.newGrpcEndpointWrapper
+        argtypes = [ctypes.c_char_p, ctypes.c_char_p, ctypes.c_int, ctypes.c_char_p]
+        restype = ctypes.c_char_p
+
+        output = _call_function(
+            func,
+            argtypes,
+            restype,
+            [name.encode(), service.encode(), port, pb_file.encode()],
+            True,
+        )
+
+        super().__init__(output)
+
+
+class _RestEndpoint(_Endpoint):
+    """
+    Represents an endpoint of a REST based service.
+    """
+
+    def __init__(
+        self, name: str, openapi_tag: str, port: int, openapi_file: str
+    ) -> None:
+        """
+        name: name of the endpoint
+        openapi_tag: (optional) tag to filter an OpenAPI file
+        port: Port number where the endpoint will be reached
+        openapi_file: (optional) OpenAPI file with definitions corresponding to this endpoint
+        """
+        func = _library.newRestEndpointWrapper
+        argtypes = [ctypes.c_char_p, ctypes.c_char_p, ctypes.c_int, ctypes.c_char_p]
+        restype = ctypes.c_char_p
+
+        output = _call_function(
+            func,
+            argtypes,
+            restype,
+            [name.encode(), openapi_tag.encode(), port, openapi_file.encode()],
+            True,
+        )
+
+        super().__init__(output)

skyramp-0.4.30/src/skyramp/utils.py

@@ -0,0 +1,53 @@
+"""
+Contains internal utilities
+"""
+
+import platform
+import os
+import ctypes
+
+def _get_c_library():
+    system = platform.system()
+    processor = platform.processor()
+
+    lib_dir = os.path.join(os.path.dirname(__file__), "lib")
+    lib_file = ""
+
+    if system == "Darwin":
+        if processor == "arm":
+            lib_file = "dev-darwin-arm64.dylib"
+
+    if lib_file == "":
+        raise Exception(
+            f"unsupported system and architecture. System: {system}, Architecture: {processor}"
+        )
+
+    lib_path = os.path.join(lib_dir, lib_file)
+
+    return ctypes.cdll.LoadLibrary(lib_path)
+
+def _call_function(func, argtypes, restype, args, return_output=False):
+    func.argtypes = argtypes
+    func.restype = restype
+
+    output = func(*args)
+    if not output:
+        return None
+
+    output_bytes = ctypes.string_at(output)
+    output = output_bytes.decode()
+
+    if return_output:
+        return output
+
+    # If output is not expected, the result output is parsed as an exception
+    if len(output) > 0:
+        raise Exception(output)
+
+    return None
+
+
+_library = _get_c_library()
+
+if _library is None:
+    raise Exception("failed to load Skyramp C library")