sumo-wrapper-python 1.0.7__py3-none-any.whl → 1.0.9__py3-none-any.whl

sumo/wrapper/_auth_provider.py

@@ -1,3 +1,5 @@
+import platform
+from pathlib import Path
 import msal
 import os
 from datetime import datetime, timedelta
@@ -7,9 +9,13 @@ import json
 import jwt
 import time
 from azure.identity import ManagedIdentityCredential
+import tenacity as tn
+from ._retry_strategy import _log_retry_info, _return_last_value
 
 from msal_extensions.persistence import FilePersistence
 from msal_extensions.token_cache import PersistedTokenCache
+import errno
+
 
 if not sys.platform.startswith("linux"):
     from msal_extensions import build_encrypted_persistence
@@ -19,13 +25,32 @@ def scope_for_resource(resource_id):
     return f"{resource_id}/.default"
 
 
+def _maybe_nfs_exception(exception):
+    return isinstance(exception, OSError) and (
+        exception.errno in (errno.EAGAIN, errno.ESTALE)
+    )
+
+
 class AuthProvider:
     def __init__(self, resource_id):
         self._resource_id = resource_id
         self._scope = scope_for_resource(resource_id)
         self._app = None
+        self._login_timeout_minutes = 5
+        os.system("")  # Ensure color init on all platforms (win10)
+
         return
 
+    @tn.retry(
+        retry=tn.retry_if_exception(_maybe_nfs_exception),
+        stop=tn.stop_after_attempt(6),
+        wait=(
+            tn.wait_exponential(multiplier=0.5, exp_base=2)
+            + tn.wait_random_exponential(multiplier=0.5, exp_base=2)
+        ),
+        retry_error_callback=_return_last_value,
+        before_sleep=_log_retry_info,
+    )
     def get_token(self):
         accounts = self._app.get_accounts()
         if len(accounts) == 0:
@@ -37,7 +62,11 @@ class AuthProvider:
         return result["access_token"]
 
     def get_authorization(self):
-        return {"Authorization": "Bearer " + self.get_token()}
+        token = self.get_token()
+        if token is None:
+            return ""
+
+        return {"Authorization": "Bearer " + token}
 
     pass
 
@@ -77,6 +106,16 @@ def get_token_path(resource_id, suffix):
     )
 
 
+@tn.retry(
+    retry=tn.retry_if_exception(_maybe_nfs_exception),
+    stop=tn.stop_after_attempt(6),
+    wait=(
+        tn.wait_exponential(multiplier=0.5, exp_base=2)
+        + tn.wait_random_exponential(multiplier=0.5, exp_base=2)
+    ),
+    retry_error_callback=_return_last_value,
+    before_sleep=_log_retry_info,
+)
 def get_token_cache(resource_id, suffix):
     # https://github.com/AzureAD/microsoft-authentication-extensions-\
     # for-python
@@ -110,6 +149,16 @@ def get_token_cache(resource_id, suffix):
     return cache
 
 
+@tn.retry(
+    retry=tn.retry_if_exception(_maybe_nfs_exception),
+    stop=tn.stop_after_attempt(6),
+    wait=(
+        tn.wait_exponential(multiplier=0.5, exp_base=2)
+        + tn.wait_random_exponential(multiplier=0.5, exp_base=2)
+    ),
+    retry_error_callback=_return_last_value,
+    before_sleep=_log_retry_info,
+)
 def protect_token_cache(resource_id, suffix):
     token_path = get_token_path(resource_id, suffix)
 
@@ -143,27 +192,36 @@ class AuthProviderInteractive(AuthProvider):
             pass
         return
 
+    @tn.retry(
+        retry=tn.retry_if_exception(_maybe_nfs_exception),
+        stop=tn.stop_after_attempt(6),
+        wait=(
+            tn.wait_exponential(multiplier=0.5, exp_base=2)
+            + tn.wait_random_exponential(multiplier=0.5, exp_base=2)
+        ),
+        retry_error_callback=_return_last_value,
+        before_sleep=_log_retry_info,
+    )
     def login(self):
         scopes = [self._scope + " offline_access"]
-        login_timeout_minutes = 7
-        os.system("")  # Ensure color init on all platforms (win10)
         print(
             "\n\n \033[31m NOTE! \033[0m"
             + " Please login to Equinor Azure to enable Sumo access: "
-            + "we opened a login web-page for you in your browser."
+            + "we are opening a login web-page for you in your browser."
             + "\nYou should complete your login within "
-            + str(login_timeout_minutes)
+            + str(self._login_timeout_minutes)
             + " minutes, "
             + "that is before "
             + str(
                 (
-                    datetime.now() + timedelta(minutes=login_timeout_minutes)
+                    datetime.now()
+                    + timedelta(minutes=self._login_timeout_minutes)
                 ).strftime("%H:%M:%S")
             )
         )
         try:
             result = self._app.acquire_token_interactive(
-                scopes, timeout=(login_timeout_minutes * 60)
+                scopes, timeout=(self._login_timeout_minutes * 60)
             )
             if "error" in result:
                 print(
@@ -180,7 +238,9 @@ class AuthProviderInteractive(AuthProvider):
             return
 
         protect_token_cache(self._resource_id, ".token")
-        print("Equinor Azure login for Sumo access was successful")
+        print(
+            "Equinor Azure login for Sumo access was successful (interactive)"
+        )
         return
 
     pass
@@ -200,25 +260,58 @@ class AuthProviderDeviceCode(AuthProvider):
             pass
         return
 
+    @tn.retry(
+        retry=tn.retry_if_exception(_maybe_nfs_exception),
+        stop=tn.stop_after_attempt(6),
+        wait=(
+            tn.wait_exponential(multiplier=0.5, exp_base=2)
+            + tn.wait_random_exponential(multiplier=0.5, exp_base=2)
+        ),
+        retry_error_callback=_return_last_value,
+        before_sleep=_log_retry_info,
+    )
     def login(self):
-        flow = self._app.initiate_device_flow([self._scope])
-
-        if "error" in flow:
-            raise ValueError(
-                "Failed to create device flow. Err: %s"
-                % json.dumps(flow, indent=4)
+        try:
+            scopes = [self._scope + " offline_access"]
+            flow = self._app.initiate_device_flow(scopes)
+            if "error" in flow:
+                print(
+                    "\n\n \033[31m"
+                    + "Failed to initiate device-code login. Err: %s"
+                    + "\033[0m" % json.dumps(flow, indent=4)
+                )
+                return
+            flow["expires_at"] = (
+                int(time.time()) + self._login_timeout_minutes * 60
             )
 
-        print(flow["message"])
-        result = self._app.acquire_token_by_device_flow(flow)
+            print(
+                "\033[31m"
+                + " NOTE! Please login to Equinor Azure to enable Sumo access:"
+                + flow["message"]
+                + " \033[0m"
+                + "\nYou should complete your login within a few minutes"
+            )
+            result = self._app.acquire_token_by_device_flow(flow)
 
-        if "error" in result:
-            raise ValueError(
-                "Failed to acquire token by device flow. Err: %s"
-                % json.dumps(result, indent=4)
+            if "error" in result:
+                print(
+                    "\n\n \033[31m Error during Equinor Azure login "
+                    "for Sumo access: \033[0m"
+                )
+                print("Err: ", json.dumps(result, indent=4))
+                return
+        except Exception:
+            print(
+                "\n\n \033[31m Failed Equinor Azure login for Sumo access, "
+                "one possible reason is timeout \033[0m"
             )
+            return
 
         protect_token_cache(self._resource_id, ".token")
+        print(
+            "Equinor Azure login for Sumo access was successful (device-code)"
+        )
 
         return
 
@@ -232,6 +325,16 @@ class AuthProviderManaged(AuthProvider):
         self._scope = scope_for_resource(resource_id)
         return
 
+    @tn.retry(
+        retry=tn.retry_if_exception(_maybe_nfs_exception),
+        stop=tn.stop_after_attempt(6),
+        wait=(
+            tn.wait_exponential(multiplier=0.5, exp_base=2)
+            + tn.wait_random_exponential(multiplier=0.5, exp_base=2)
+        ),
+        retry_error_callback=_return_last_value,
+        before_sleep=_log_retry_info,
+    )
     def get_token(self):
         return self._app.get_token(self._scope).token
 
@@ -239,6 +342,16 @@ class AuthProviderManaged(AuthProvider):
 
 
 class AuthProviderSumoToken(AuthProvider):
+    @tn.retry(
+        retry=tn.retry_if_exception(_maybe_nfs_exception),
+        stop=tn.stop_after_attempt(6),
+        wait=(
+            tn.wait_exponential(multiplier=0.5, exp_base=2)
+            + tn.wait_random_exponential(multiplier=0.5, exp_base=2)
+        ),
+        retry_error_callback=_return_last_value,
+        before_sleep=_log_retry_info,
+    )
     def __init__(self, resource_id):
         protect_token_cache(resource_id, ".sharedkey")
         token_path = get_token_path(resource_id, ".sharedkey")
@@ -253,6 +366,16 @@ class AuthProviderSumoToken(AuthProvider):
         return {"X-SUMO-Token": self._token}
 
 
+@tn.retry(
+    retry=tn.retry_if_exception(_maybe_nfs_exception),
+    stop=tn.stop_after_attempt(6),
+    wait=(
+        tn.wait_exponential(multiplier=0.5, exp_base=2)
+        + tn.wait_random_exponential(multiplier=0.5, exp_base=2)
+    ),
+    retry_error_callback=_return_last_value,
+    before_sleep=_log_retry_info,
+)
 def get_auth_provider(
     client_id,
     authority,
@@ -294,4 +417,11 @@ def get_auth_provider(
     ):
         return AuthProviderManaged(resource_id)
     # ELSE
+    lockfile_path = Path.home() / ".config/chromium/SingletonLock"
+    if Path(lockfile_path).is_symlink() and not str(
+        Path(lockfile_path).resolve()
+    ).__contains__(platform.node()):
+        # https://github.com/equinor/sumo-wrapper-python/issues/193
+        return AuthProviderDeviceCode(client_id, authority, resource_id)
+    # ELSE
     return AuthProviderInteractive(client_id, authority, resource_id)

sumo/wrapper/_decorators.py

@@ -1,4 +1,9 @@
+# For sphinx:
+from functools import wraps
+
+
 def raise_for_status(func):
+    @wraps(func)
     def wrapper(*args, **kwargs):
         # FIXME: in newer versions of httpx, raise_for_status() is chainable,
         # so we could simply write
@@ -11,6 +16,7 @@ def raise_for_status(func):
 
 
 def raise_for_status_async(func):
+    @wraps(func)
     async def wrapper(*args, **kwargs):
         # FIXME: in newer versions of httpx, raise_for_status() is chainable,
         # so we could simply write

sumo/wrapper/_logging.py

@@ -20,6 +20,9 @@ class LogHandlerSumo(logging.Handler):
                 "funcname": record.funcName,
                 "linenumber": record.lineno,
             }
+            if "objectUuid" in record.__dict__.keys():
+                json["objectUuid"] = record.__dict__.get("objectUuid")
+
             self._sumoClient.post("/message-log/new", json=json)
         except Exception:
             # Never fail on logging

sumo/wrapper/_retry_strategy.py

@@ -17,7 +17,10 @@ def _log_retry_info(retry_state):
 
 # Define the conditions for retrying based on exception types
 def _is_retryable_exception(exception):
-    return isinstance(exception, (httpx.TimeoutException, httpx.ConnectError))
+    return isinstance(
+        exception,
+        (httpx.TimeoutException, httpx.NetworkError, httpx.ProxyError),
+    )
 
 
 # Define the conditions for retrying based on HTTP status codes

sumo/wrapper/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.0.7'
-__version_tuple__ = version_tuple = (1, 0, 7)
+__version__ = version = '1.0.9'
+__version_tuple__ = version_tuple = (1, 0, 9)

sumo/wrapper/login.py

@@ -74,6 +74,11 @@ def main():
     if args.print_token:
         print(f"TOKEN: {token}")
 
+    if token is not None:
+        print("Successfully logged in to Sumo environment: " + env)
+    else:
+        print("Failed login to Sumo environment: " + env)
+
 
 if __name__ == "__main__":
     main()

sumo/wrapper/sumo_client.py

@@ -84,6 +84,27 @@ class SumoClient:
             access_token=access_token,
             devicecode=devicecode,
         )
+        if (
+            self.auth.get_token() is None
+            and refresh_token is None
+            and access_token is None
+        ):
+            print("\n \033[31m !!! Falling back to device-code login:\033[0m")
+            self.auth = get_auth_provider(
+                client_id=APP_REGISTRATION[env]["CLIENT_ID"],
+                authority=f"{AUTHORITY_HOST_URI}/{TENANT_ID}",
+                resource_id=APP_REGISTRATION[env]["RESOURCE_ID"],
+                interactive=False,
+                refresh_token=None,
+                access_token=None,
+                devicecode=True,
+            )
+        if self.auth.get_token() is None:
+            print(
+                "\n\n \033[31m "
+                + "NOTE! Login failed/timed out. Giving up."
+                + "\033[0m"
+            )
 
         if env == "localhost":
             self.base_url = "http://localhost:8084/api/v1"

{sumo_wrapper_python-1.0.7.dist-info → sumo_wrapper_python-1.0.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sumo-wrapper-python
-Version: 1.0.7
+Version: 1.0.9
 Summary: Python wrapper for the Sumo API
 Author: Equinor
 License: Apache License
@@ -220,165 +220,20 @@ Requires-Dist: azure-identity >=1.13.0
 Provides-Extra: docs
 Requires-Dist: sphinx ; extra == 'docs'
 Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
+Requires-Dist: autoapi ; extra == 'docs'
+Requires-Dist: sphinx-autodoc-typehints ; extra == 'docs'
+Requires-Dist: sphinxcontrib-apidoc ; extra == 'docs'
 Provides-Extra: test
 Requires-Dist: pytest ; extra == 'test'
 Requires-Dist: PyYAML ; extra == 'test'
 
 # sumo-wrapper-python
 
-Python wrappers for Sumo APIs
+[![Documentation Status](https://readthedocs.org/projects/sumo-wrapper-python/badge/?version=latest)](https://sumo-wrapper-python.readthedocs.io/en/latest/?badge=latest)
 
-Want to contribute? Read our [contributing](./CONTRIBUTING.md) guidelines
+## Documentation and guidelines
+[sumo-wrapper-python documentation](https://sumo-wrapper-python.readthedocs.io/en/latest/)
 
-## Install:
+## Contribute
+[Contribution guidelines](./CONTRIBUTING.md)
 
-    pip install sumo-wrapper-python
-
-For internal Equinor users, this package is available through the Komodo
-distribution.
-
-# Table of contents
-
-- [sumo-wrapper-python](#sumo-wrapper-python)
-  - [Install:](#install)
-- [Table of contents](#table-of-contents)
-- [SumoClient](#sumoclient)
-    - [Initialization](#initialization)
-    - [Parameters](#parameters)
-          - [`token` logic](#token-logic)
-  - [Methods](#methods)
-    - [get(path, \*\*params)](#getpath-params)
-    - [post(path, json, blob, params)](#postpath-json-blob-params)
-    - [put(path, json, blob)](#putpath-json-blob)
-    - [delete(path)](#deletepath)
-  - [Async methods](#async-methods)
-
-# SumoClient
-
-A thin wrapper class for the Sumo API.
-
-### Initialization
-
-```python
-from sumo.wrapper import SumoClient
-
-sumo = SumoClient(env="dev")
-```
-
-### Parameters
-
-```python
-class SumoClient:
-    def __init__(
-        self,
-        env:str,
-        token:str=None,
-        interactive:bool=False,
-        verbosity:str="CRITICAL"
-    ):
-```
-
-- `env`: sumo environment
-- `token`: bearer token or refresh token
-- `interactive`: use interactive flow when authenticating
-- `verbosity`: "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"
-
-###### `token` logic
-
-If an access token is provided in the `token` parameter, it will be used as long
-as it's valid. An error will be raised when it expires.
-
-If we are unable to decode the provided `token` as a JWT, we treat it as a
-refresh token and attempt to use it to retrieve an access token.
-
-If no `token` is provided, an authentication code flow/interactive flow is
-triggered to retrieve a token.
-
-## Methods
-
-`SumoClient` has one method for each HTTP-method that is used in the sumo-core
-API. See examples of how to use these methods below.
-
-All methods accepts a path argument. Path parameters can be interpolated into
-the path string. Example:
-
-```python
-object_id = "1234"
-
-# GET/objects('{obejctid}')
-sumo.get(f"/objects('{object_id}')")
-```
-
-### get(path, \*\*params)
-
-Performs a GET-request to sumo-core. Accepts query parameters as keyword
-arguments.
-
-```python
-# Retrieve userdata
-user_data = sumo.get("/userdata")
-
-# Search for objects
-results = sumo.get("/search",
-    query="class:surface",
-    size:3,
-    select=["_id"]
-)
-
-# Get object by id
-object_id = "159405ba-0046-b321-55ce-542f383ba5c7"
-
-obj = sumo.get(f"/objects('{object_id}')")
-```
-
-### post(path, json, blob, params)
-
-Performs a POST-request to sumo-core. Accepts json and blob, but not both at the
-same time.
-
-```python
-# Upload new parent object
-parent_object = sumo.post("/objects", json=parent_meta_data)
-
-# Upload child object
-parent_id = parent_object["_id"]
-
-child_object = sumo.post(f"/objects('{parent_id}')", json=child_meta_data)
-```
-
-### put(path, json, blob)
-
-Performs a PUT-request to sumo-core. Accepts json and blob, but not both at the
-same time.
-
-```python
-# Upload blob to child object
-child_id = child_object["_id"]
-
-sumo.put(f"/objects('{child_id}')/blob", blob=blob)
-```
-
-### delete(path)
-
-Performs a DELETE-request to sumo-core.
-
-```python
-# Delete blob
-sumo.delete(f"/objects('{child_id}')/blob")
-
-# Delete child object
-sumo.delete(f"/objects('{child_id}')")
-
-# Delete parent object
-sumo.delete(f"/objects('{parent_id}')")
-```
-
-## Async methods
-
-`SumoClient` also has *async* alternatives `get_async`, `post_async`, `put_async` and `delete_async`.
-These accept the same parameters as their synchronous counterparts, but have to be *awaited*.
-
-```python
-# Retrieve userdata
-user_data = await sumo.get_async("/userdata")
-```

sumo_wrapper_python-1.0.9.dist-info/RECORD

@@ -0,0 +1,17 @@
+sumo/__init__.py,sha256=ftS-xRPSH-vU7fIHlnZQaCTWbNvs4owJivNW65kzsIM,85
+sumo/wrapper/__init__.py,sha256=wW7Bjl0btCgK9_exGVrfJsnFmTOybIdyeCudz0LueQM,235
+sumo/wrapper/_auth_provider.py,sha256=HieseMcqT9lMBqgyzwL5Pr6CCyk-eFjKyYhJQx8UKRw,13494
+sumo/wrapper/_blob_client.py,sha256=y15_TThJ4ENFtEAF37mgju6Htc8D3ZyzcYCqsYQZo7Y,1495
+sumo/wrapper/_decorators.py,sha256=3IEi6GXVkkDACHoo8dOeDoBtZh5TlJ6Tw0qlpOVHqLQ,806
+sumo/wrapper/_logging.py,sha256=lnhjn6oQna33jZpzeZ7IeBya2uKNfrzXr_C3nw7txo0,965
+sumo/wrapper/_retry_strategy.py,sha256=9PjOT0hOhLbCHrJu02thUkGdY39NpB2rqa_XUODoguw,2415
+sumo/wrapper/_version.py,sha256=29gfaFnVGHlO4YwJu6vgvQjCQwPqDmuCvkEOYMZyflo,411
+sumo/wrapper/config.py,sha256=6t7qqjrrmd11m4VMlRryiMYw2JDU_R51305woAP1TAs,865
+sumo/wrapper/login.py,sha256=HY3CLu3u0RZtgSbitpdyk2T0P-M9ttZ6LRDsGO4BwRM,1773
+sumo/wrapper/sumo_client.py,sha256=Mjco-nFF28GgmjXgDmGmXmFXr7LJI50M54zL0zt3CJs,15545
+sumo_wrapper_python-1.0.9.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+sumo_wrapper_python-1.0.9.dist-info/METADATA,sha256=pmewZzDIe8sALypH6d9EVNxBr5qiuoCFlW5MfBjytSg,14267
+sumo_wrapper_python-1.0.9.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+sumo_wrapper_python-1.0.9.dist-info/entry_points.txt,sha256=V_vGky2C3He5vohJAxnBdvpt_fqfUDFj5irUm9HtoFc,55
+sumo_wrapper_python-1.0.9.dist-info/top_level.txt,sha256=rLbKyH9rWgCj3PoLeR7fvC5X8vCaUc5LF8-Y_GBWZL0,5
+sumo_wrapper_python-1.0.9.dist-info/RECORD,,

{sumo_wrapper_python-1.0.7.dist-info → sumo_wrapper_python-1.0.9.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

sumo_wrapper_python-1.0.7.dist-info/RECORD

@@ -1,17 +0,0 @@
-sumo/__init__.py,sha256=ftS-xRPSH-vU7fIHlnZQaCTWbNvs4owJivNW65kzsIM,85
-sumo/wrapper/__init__.py,sha256=wW7Bjl0btCgK9_exGVrfJsnFmTOybIdyeCudz0LueQM,235
-sumo/wrapper/_auth_provider.py,sha256=rfTgOwmfOyg7DJwUoejCINfrzhi1lWIx-UH0Pir-8XM,9005
-sumo/wrapper/_blob_client.py,sha256=y15_TThJ4ENFtEAF37mgju6Htc8D3ZyzcYCqsYQZo7Y,1495
-sumo/wrapper/_decorators.py,sha256=FSorPaTEBpq2N0qrqfdTt0jMToe_0PpOYlsL6vZSbIg,728
-sumo/wrapper/_logging.py,sha256=XgXcOAEoVw0aqij7V7EPTiP3ALqa8xNDgJgKyWOxeok,838
-sumo/wrapper/_retry_strategy.py,sha256=sata8h2tXWQIm9GQYWJCmzNBLm9Jy_odGYkaOH27j3o,2374
-sumo/wrapper/_version.py,sha256=B_2jTRPLk-a7dhEz8Rto7VRGwxfpXrqO4mYrudjn7bw,411
-sumo/wrapper/config.py,sha256=6t7qqjrrmd11m4VMlRryiMYw2JDU_R51305woAP1TAs,865
-sumo/wrapper/login.py,sha256=HB_USKw6pR4j5EyNevaFVJGQjQ3t_8F__ZBaR29XLf4,1610
-sumo/wrapper/sumo_client.py,sha256=q5k6qP_oSgzmfFf1Bc2zw8L2KK85GFXg99Ro8GT3GZA,14741
-sumo_wrapper_python-1.0.7.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-sumo_wrapper_python-1.0.7.dist-info/METADATA,sha256=7qpWbfF_muUNT0kIfYzzK_YUeqZOraqlpWWS1eAQVKQ,17407
-sumo_wrapper_python-1.0.7.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-sumo_wrapper_python-1.0.7.dist-info/entry_points.txt,sha256=V_vGky2C3He5vohJAxnBdvpt_fqfUDFj5irUm9HtoFc,55
-sumo_wrapper_python-1.0.7.dist-info/top_level.txt,sha256=rLbKyH9rWgCj3PoLeR7fvC5X8vCaUc5LF8-Y_GBWZL0,5
-sumo_wrapper_python-1.0.7.dist-info/RECORD,,