oscar-python 1.0.3__tar.gz → 1.1.0__tar.gz

{oscar_python-1.0.3 → oscar_python-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: oscar_python
-Version: 1.0.3
+Version: 1.1.0
 Summary: OSCAR API for python
 Home-page: https://github.com/grycap/oscar_python
 Author: GRyCAP - Universitat Politecnica de Valencia
@@ -11,18 +11,18 @@ Classifier: License :: OSI Approved :: Apache Software License
 Description-Content-Type: text/markdown
 License-File: LICENSE
 
-## Python OSCAR API
+## Python OSCAR client
 
 [![Build](https://github.com/grycap/oscar_python/actions/workflows/main.yaml/badge.svg)](https://github.com/grycap/oscar_python/actions/workflows/main.yaml)
 ![PyPI](https://img.shields.io/pypi/v/oscar_python)
 
-This package provides an API to interact with OSCAR (https://oscar.grycap.net) clusters and services. It is available on Pypi with the name [oscar-python](https://pypi.org/project/oscar-python/).
+This package provides a client to interact with OSCAR (https://oscar.grycap.net) clusters and services. It is available on Pypi with the name [oscar-python](https://pypi.org/project/oscar-python/).
 
 ### Contents
-- [Python OSCAR API](#python-oscar-api)
+- [Python OSCAR client](#python-oscar-client)
   - [Contents](#contents)
   - [Sample usage](#sample-usage)
-  - [API methods](#api-methods)
+  - [Client methods](#client-methods)
     - [Cluster methods](#cluster-methods)
     - [Service methods](#service-methods)
     - [Logs methods](#logs-methods)
@@ -54,14 +54,14 @@ client = Client("cluster-id","https://cluster-endpoint", "username", "password",
 
 try:
   client.create_service("/absolute_path/cowsay.yaml")
-  res = client.run_service("cowsay", '{"message": "Hi there"}')   
-  if res.status_code == 200:
-      print(res.text)
+  response = client.run_service("cowsay", input = '{"message": "Hi there"}')   
+  if response.status_code == 200:
+      print(response.text)
 except Exception as err:
   print("Failed with: ", err)
 ```
 
-### API methods
+### Client methods
 
 #### Cluster methods
 
@@ -113,12 +113,11 @@ response = client.remove_service("service_name") # returns an http response
 
 **run_service**
 
-The `input` parameter may not be passed if the function doesn't require input.
+ *`input`, `output` and `timeout` are optional parameters.*
 
 ``` python
 # make a synchronous execution 
-response = client.run_service("service_name", input="input") # returns an http response
-
+response = client.run_service("service_name", input="input", output="out.png", timeout=100) # returns an http response
 ```
 
 #### Logs methods
@@ -176,9 +175,3 @@ response = storage_service.upload_file("storage_provider", "local_path", "remote
 # download a file from a remote path to a local path 
 response = storage_service.download_file("storage_provider", "local_path", "remote_path")
 ```
-
-
-
-
-
-

{oscar_python-1.0.3 → oscar_python-1.1.0}/README.md

@@ -1,15 +1,15 @@
-## Python OSCAR API
+## Python OSCAR client
 
 [![Build](https://github.com/grycap/oscar_python/actions/workflows/main.yaml/badge.svg)](https://github.com/grycap/oscar_python/actions/workflows/main.yaml)
 ![PyPI](https://img.shields.io/pypi/v/oscar_python)
 
-This package provides an API to interact with OSCAR (https://oscar.grycap.net) clusters and services. It is available on Pypi with the name [oscar-python](https://pypi.org/project/oscar-python/).
+This package provides a client to interact with OSCAR (https://oscar.grycap.net) clusters and services. It is available on Pypi with the name [oscar-python](https://pypi.org/project/oscar-python/).
 
 ### Contents
-- [Python OSCAR API](#python-oscar-api)
+- [Python OSCAR client](#python-oscar-client)
   - [Contents](#contents)
   - [Sample usage](#sample-usage)
-  - [API methods](#api-methods)
+  - [Client methods](#client-methods)
     - [Cluster methods](#cluster-methods)
     - [Service methods](#service-methods)
     - [Logs methods](#logs-methods)
@@ -41,14 +41,14 @@ client = Client("cluster-id","https://cluster-endpoint", "username", "password",
 
 try:
   client.create_service("/absolute_path/cowsay.yaml")
-  res = client.run_service("cowsay", '{"message": "Hi there"}')   
-  if res.status_code == 200:
-      print(res.text)
+  response = client.run_service("cowsay", input = '{"message": "Hi there"}')   
+  if response.status_code == 200:
+      print(response.text)
 except Exception as err:
   print("Failed with: ", err)
 ```
 
-### API methods
+### Client methods
 
 #### Cluster methods
 
@@ -100,12 +100,11 @@ response = client.remove_service("service_name") # returns an http response
 
 **run_service**
 
-The `input` parameter may not be passed if the function doesn't require input.
+ *`input`, `output` and `timeout` are optional parameters.*
 
 ``` python
 # make a synchronous execution 
-response = client.run_service("service_name", input="input") # returns an http response
-
+response = client.run_service("service_name", input="input", output="out.png", timeout=100) # returns an http response
 ```
 
 #### Logs methods
@@ -163,9 +162,3 @@ response = storage_service.upload_file("storage_provider", "local_path", "remote
 # download a file from a remote path to a local path 
 response = storage_service.download_file("storage_provider", "local_path", "remote_path")
 ```
-
-
-
-
-
-

oscar_python-1.1.0/oscar_python/_utils.py

@@ -0,0 +1,112 @@
+# Copyright (C) GRyCAP - I3M - UPV
+
+# 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. 
+
+import base64
+import os
+import requests
+import liboidcagent as agent
+_DEFAULT_TIMEOUT = 60
+
+""" Generic http request """
+def make_request(c , path, method, **kwargs):
+
+    if "timeout" in kwargs.keys() and kwargs["timeout"]: 
+        timeout = kwargs["timeout"]
+    else: 
+        timeout = _DEFAULT_TIMEOUT
+
+    url = c.endpoint+path
+    headers = get_headers(c)  
+    if method in ["post", "put"]:
+        if "token" in kwargs.keys() and kwargs["token"]: 
+            headers = get_headers_with_token(kwargs["token"])
+        if "data" in kwargs.keys() and kwargs["data"]:
+            result = requests.request(method, url, headers=headers, verify=c.ssl, data=kwargs["data"], timeout=timeout)
+    else:
+        result = requests.request(method, url, headers=headers, verify=c.ssl, timeout=timeout)
+
+    if "handle" in kwargs.keys() and kwargs["handle"] == False:
+        return result
+    
+    result.raise_for_status()
+    return result
+
+""" Function to generate headers with basic authentication or OIDC """
+def get_headers(c):
+    if c._AUTH_TYPE == "basicauth":
+        usr_pass_as_bytes = bytes(c.user+":"+c.password,"utf-8")
+        usr_pass_base_64 = base64.b64encode(usr_pass_as_bytes).decode("utf-8")
+        return {"Authorization": "Basic "+ usr_pass_base_64}
+    if c._AUTH_TYPE == "oidc-agent":
+        token = agent.get_access_token(c.shortname)
+        return get_headers_with_token(token)
+    if c._AUTH_TYPE == "oidc":
+        return get_headers_with_token(c.oidc_token)
+
+""" Function to generate headers with token auth """
+def get_headers_with_token(token):
+    return {"Authorization": "Bearer "+ str(token)}
+
+def write_text_file(content, file_path):
+    with open(file_path, 'w') as f:
+        f.write(content)
+
+def isBase64(st):
+    try:
+        base64.b64decode(st)
+        return True
+    except:
+        return False
+
+def decode_b64(b64_str, file_out):
+    file_extension = os.path.splitext(file_out)[1]
+    try:
+        decoded_data = base64.b64decode(b64_str)
+
+        if file_extension in [".txt", ".json"]:
+            decode = 'w'
+            decoded_data = decoded_data.decode("utf-8")
+        else:
+            decode = 'wb' 
+
+        with open(file_out, decode) as f:
+            f.write(decoded_data)
+
+    except ValueError:
+        print('Error decoding output: Invalid base64 string.')
+    except OSError:
+        print('Error decoding output: Failed to write decoded data to file.')   
+
+def encode_input(data):
+    if os.path.isfile(data):
+        try:
+            with open(data, 'rb') as file:
+                return base64.b64encode(file.read())
+        except FileNotFoundError:
+            print('Error encoding input: File {0} not found.'.format(data))
+        except OSError:
+            print('Error encoding input: Failed to read file.')
+    else:
+        message_bytes = data.encode('ascii')
+        return base64.b64encode(message_bytes)
+
+def decode_output(output, file_path):
+    if(isBase64(output)):
+        decode_b64(output, file_path)
+        return
+    if(isinstance(output,str)):
+        write_text_file(output,file_path)
+        return
+
+ 

{oscar_python-1.0.3 → oscar_python-1.1.0}/oscar_python/client.py

@@ -15,6 +15,7 @@
 
 import json
 import yaml
+import liboidcagent as agent
 import oscar_python._utils as utils
 from oscar_python.storage import Storage
 
@@ -25,10 +26,6 @@ _LOGS_PATH = "/system/logs"
 _RUN_PATH = "/run"
 #_JOB_PATH = "/job"
 
-_MINIO = "minio"
-_S3 = "s3"
-_ONE_DATA = "onedata"
-_WEBDAV = "webdav"
 
 _GET = "get"
 _POST = "post"
@@ -37,12 +34,47 @@ _DELETE = "delete"
 
 class Client:
     #Cluster info 
-    def __init__(self, id, endpoint, user, password, ssl) -> None:
-        self.id = id
-        self.endpoint = endpoint
-        self.user = user
-        self.password = password
-        self.ssl = ssl
+    def __init__(self, options) -> None:
+        self.set_auth_type(options)
+        if self._AUTH_TYPE == 'basicauth':
+            self.basic_auth_client(options)
+        if self._AUTH_TYPE == 'oidc-agent':
+            self.oidc_agent_client(options)
+        if self._AUTH_TYPE == 'oidc':
+            self.oidc_client(options)
+
+    def basic_auth_client(self, options):
+        self.id = options['cluster_id']
+        self.endpoint = options['endpoint']
+        self.user = options['user']
+        self.password = options['password']
+        self.ssl = bool(options['ssl'])
+
+    def oidc_agent_client(self, options):
+        self.id = options['cluster_id']
+        self.endpoint = options['endpoint']
+        self.shortname = options['shortname']
+        self.ssl = bool(options['ssl'])
+    
+    def oidc_client(self, options):
+        self.id = options['cluster_id']
+        self.endpoint = options['endpoint']
+        self.oidc_token = options['oidc_token']
+        self.ssl = bool(options['ssl'])
+
+    def set_auth_type(self, options):
+        if 'user' in options:
+            self._AUTH_TYPE = "basicauth"
+        elif 'shortname' in options:
+            self._AUTH_TYPE = "oidc-agent"
+            try:
+                agent.get_access_token(options['shortname'])
+            except agent.OidcAgentError as e:
+                print("ERROR oidc-agent: {}".format(e))
+        elif 'oidc_token' in options:
+            self._AUTH_TYPE = "oidc"
+        else:
+            raise ValueError("Unrecognized authentication credentials in options")
 
     """ Creates a generic storage client to interact with the storage providers 
     defined on a specific service of the refered OSCAR cluster """
@@ -86,7 +118,7 @@ class Client:
                     with open(svc["script"]) as s:
                         svc["script"] = s.read()
                 except IOError as err:
-                    raise("Bouldn't read script")
+                    raise("Couldn't read script")
 
                 # cpu parameter has to be string on the request
                 if type(svc["cpu"]) is int or type(svc["cpu"]) is float: svc["cpu"]= str(svc["cpu"])
@@ -110,13 +142,28 @@ class Client:
     def remove_service(self, name):
         return utils.make_request(self, _SVC_PATH+"/"+name, _DELETE)
 
-    """ Run a synchronous execution """
-    def run_service(self, name, input=""):
-        token = self._get_token(name)
-        if input: return utils.make_request(self, _RUN_PATH+"/"+name, _POST, data=input, token=token)
+    """ Run a synchronous execution. 
+        If an output is provided the result is decoded onto the file.
+        In both cases the function returns the HTTP response."""
+    def run_service(self, name, **kwargs):
+        if "input" in kwargs.keys() and kwargs["input"]:
+            exec_input = kwargs["input"]
+            token = self._get_token(name) 
+            
+            send_data = utils.encode_input(exec_input)
+
+            if "timeout" in kwargs.keys() and kwargs["timeout"]:
+                response = utils._make_request(self, _RUN_PATH+"/"+name, _POST, data=send_data, token=token, timeout=kwargs["timeout"])
+            else:
+                response = utils.make_request(self, _RUN_PATH+"/"+name, _POST, data=send_data, token=token)
+            
+            if "output" in kwargs.keys() and kwargs["output"]:
+                utils.decode_output(response.text, kwargs["output"])
+            return response
+        
         return utils.make_request(self, _RUN_PATH+"/"+name, _POST, token=token)
     
-    """ Run an asynchronous execution (not usable at the moment). """
+    """ Run an asynchronous execution (unable at the moment). """
     #TODO
     """ def _run_job(self, name, input_path =""):
             pass 

{oscar_python-1.0.3 → oscar_python-1.1.0}/oscar_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: oscar-python
-Version: 1.0.3
+Version: 1.1.0
 Summary: OSCAR API for python
 Home-page: https://github.com/grycap/oscar_python
 Author: GRyCAP - Universitat Politecnica de Valencia
@@ -11,18 +11,18 @@ Classifier: License :: OSI Approved :: Apache Software License
 Description-Content-Type: text/markdown
 License-File: LICENSE
 
-## Python OSCAR API
+## Python OSCAR client
 
 [![Build](https://github.com/grycap/oscar_python/actions/workflows/main.yaml/badge.svg)](https://github.com/grycap/oscar_python/actions/workflows/main.yaml)
 ![PyPI](https://img.shields.io/pypi/v/oscar_python)
 
-This package provides an API to interact with OSCAR (https://oscar.grycap.net) clusters and services. It is available on Pypi with the name [oscar-python](https://pypi.org/project/oscar-python/).
+This package provides a client to interact with OSCAR (https://oscar.grycap.net) clusters and services. It is available on Pypi with the name [oscar-python](https://pypi.org/project/oscar-python/).
 
 ### Contents
-- [Python OSCAR API](#python-oscar-api)
+- [Python OSCAR client](#python-oscar-client)
   - [Contents](#contents)
   - [Sample usage](#sample-usage)
-  - [API methods](#api-methods)
+  - [Client methods](#client-methods)
     - [Cluster methods](#cluster-methods)
     - [Service methods](#service-methods)
     - [Logs methods](#logs-methods)
@@ -54,14 +54,14 @@ client = Client("cluster-id","https://cluster-endpoint", "username", "password",
 
 try:
   client.create_service("/absolute_path/cowsay.yaml")
-  res = client.run_service("cowsay", '{"message": "Hi there"}')   
-  if res.status_code == 200:
-      print(res.text)
+  response = client.run_service("cowsay", input = '{"message": "Hi there"}')   
+  if response.status_code == 200:
+      print(response.text)
 except Exception as err:
   print("Failed with: ", err)
 ```
 
-### API methods
+### Client methods
 
 #### Cluster methods
 
@@ -113,12 +113,11 @@ response = client.remove_service("service_name") # returns an http response
 
 **run_service**
 
-The `input` parameter may not be passed if the function doesn't require input.
+ *`input`, `output` and `timeout` are optional parameters.*
 
 ``` python
 # make a synchronous execution 
-response = client.run_service("service_name", input="input") # returns an http response
-
+response = client.run_service("service_name", input="input", output="out.png", timeout=100) # returns an http response
 ```
 
 #### Logs methods
@@ -176,9 +175,3 @@ response = storage_service.upload_file("storage_provider", "local_path", "remote
 # download a file from a remote path to a local path 
 response = storage_service.download_file("storage_provider", "local_path", "remote_path")
 ```
-
-
-
-
-
-

oscar_python-1.0.3/oscar_python/_utils.py

@@ -1,47 +0,0 @@
-# Copyright (C) GRyCAP - I3M - UPV
-
-# 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. 
-
-import base64
-import requests
-
-""" Generic http request """
-def make_request(c , path, method, **kwargs):
-    url = c.endpoint+path
-    headers = get_headers(c)
-    if method in ["post", "put"]:
-        if "token" in kwargs.keys() and kwargs["token"]: 
-            headers = get_headers_with_token(kwargs["token"])
-        if "data" in kwargs.keys() and kwargs["data"]:
-            result = requests.request(method, url, headers=headers, verify=c.ssl, data=kwargs["data"])
-    else:
-        result = requests.request(method, url, headers=headers, verify=c.ssl)
-
-    if "handle" in kwargs.keys() and kwargs["handle"] == False:
-        return result
-
-    result.raise_for_status()
-    return result
-
-""" Function to generate headers with basic authentication """
-def get_headers(c):
-    usr_pass_as_bytes = bytes(c.user+":"+c.password,"utf-8")
-    usr_pass_base_64 = base64.b64encode(usr_pass_as_bytes).decode("utf-8")
-    return {"Authorization": "Basic "+ usr_pass_base_64}
-
-""" Function to generate headers with token auth """
-def get_headers_with_token(token):
-    return {"Authorization": "Bearer "+ str(token)}
-
-def raise_http_errors(response):
-    response.raise_for_status()