bfabric-web-apps 0.1.6__py3-none-any.whl → 0.1.7__py3-none-any.whl

bfabric_web_apps/__init__.py

@@ -25,7 +25,7 @@ from .utils.callbacks import (
 
 from .utils.config import settings as config
 
-from. utils.run_main_pipeline import run_main_job
+from. utils.run_main_pipeline import run_main_job, read_file_as_bytes
 
 from .utils.resource_utilities import (
     create_workunit, 
@@ -34,6 +34,7 @@ from .utils.resource_utilities import (
     create_resources
 )
 
+from .utils.charging import create_charge
 from .utils.redis_worker_init import run_worker, test_job
 from .utils.redis_queue import q
 
@@ -54,4 +55,6 @@ GSTORE_REMOTE_PATH = config.GSTORE_REMOTE_PATH
 SCRATCH_PATH = config.SCRATCH_PATH
 TRX_LOGIN = config.TRX_LOGIN
 TRX_SSH_KEY = config.TRX_SSH_KEY
-URL = config.URL
+URL = config.URL
+
+SERVICE_ID = config.SERVICE_ID

bfabric_web_apps/objects/BfabricInterface.py

@@ -67,7 +67,7 @@ class BfabricInterface( Bfabric ):
 
         validation_url = VALIDATION_URL + token
         res = requests.get(validation_url, headers={"Host": HOST})
-        
+
         if res.status_code != 200:
             res = requests.get(validation_url)
         

bfabric_web_apps/utils/callbacks.py

@@ -335,4 +335,4 @@ def get_redis_queue_layout():
 
     container_children = dbc.Row(queue_cards)
 
-    return dbc.Container(container_children, className="mt-4")
+    return dbc.Container(container_children, className="mt-4")

bfabric_web_apps/utils/charging.py

@@ -0,0 +1,40 @@
+
+from bfabric_web_apps.utils.get_logger import get_logger
+from bfabric_web_apps.utils.get_power_user_wrapper import get_power_user_wrapper
+
+def create_charge(token_data, container_id, service_id):
+    """
+    Create a charge in B-Fabric.
+    
+    Args:
+        token_data (dict): Authentication token data.
+        container_id (int): Container ID (Order ID).
+        service_id (int): Service ID.
+    
+    Returns:
+        list[dict]: List of charge data.
+    """
+    
+    # Get a logger and an api wrapper
+    L = get_logger(token_data)
+    wrapper = get_power_user_wrapper(token_data)
+
+    # Get the user ID from the token data to assign a charger
+    usr_id = wrapper.read("user", {"login": token_data.get("user_data")})[0]['id']
+
+    charge_data = {
+        "serviceid": service_id,
+        "containerid": container_id,
+        "chargerid": usr_id
+    }
+
+    # Create and log the charge
+    charge = L.logthis(
+        api_call=wrapper.save,
+        endpoint="charge",
+        obj=charge_data,
+        params=None,
+        flush_logs=True
+    )
+
+    return charge

bfabric_web_apps/utils/components.py

@@ -1,4 +1,5 @@
 from dash import html
+import dash_daq as daq
 
 DEVELOPER_EMAIL = "gwhite@fgcz.ethz.ch"
 
@@ -19,4 +20,9 @@ auth = [html.Div(id="auth-div")]
 no_auth = [
     html.P("You are not currently logged into an active session. Please log into bfabric to continue:"),
     html.A('Login to Bfabric', href='https://fgcz-bfabric.uzh.ch/bfabric/')
-]
+]
+
+charge_switch = [
+    daq.BooleanSwitch(id='charge_run', on=True, label="Charge project for run"),
+    html.Br()
+]

bfabric_web_apps/utils/config.py

@@ -24,6 +24,9 @@ class Settings(BaseSettings):
     TRX_SSH_KEY: str = "/home/user/.ssh/your_ssh_key"
     URL: str = "https:/fgcz/dummy/url"
 
+    # Which service id to use for the charge 
+    SERVICE_ID: int = 0
+
     class Config:
 
         env_file = ".env"  

bfabric_web_apps/utils/run_main_pipeline.py

@@ -16,6 +16,8 @@ from .resource_utilities import (
     create_resources
 )
 
+from .charging import create_charge
+
 from .config import settings as config
 from datetime import datetime as dt
 
@@ -25,11 +27,15 @@ TRX_LOGIN = config.TRX_LOGIN
 TRX_SSH_KEY = config.TRX_SSH_KEY
 URL = config.URL
 
-def run_main_job(files_as_byte_strings: dict, 
-                 bash_commands: list[str], 
-                 resource_paths: dict,
-                 attachment_paths: list[dict], 
-                 token: str):
+def run_main_job(
+    files_as_byte_strings: dict, 
+    bash_commands: list[str], 
+    resource_paths: dict,
+    attachment_paths: list[dict], 
+    token: str,
+    service_id: int = 0,
+    charge: bool = False,
+):
     """
     Main function to handle:
       1) Save Files on Server
@@ -37,6 +43,7 @@ def run_main_job(files_as_byte_strings: dict,
       3) Create workunits in B-Fabric
       4) Register resources in B-Fabric
       5) Attach additional gstore files (logs/reports/etc.) to entities in B-Fabric
+      6) Automatically charge the relevant container for the service
 
     :param files_as_byte_strings: {destination_path: file as byte strings}
     :param bash_commands: List of bash commands to execute
@@ -44,6 +51,8 @@ def run_main_job(files_as_byte_strings: dict,
     :param attachment_paths: Dictionary mapping source file paths to their corresponding file names ({"path/test.txt": "name.txt"})
                              for attachment to a B-Fabric entity (e.g., logs, final reports, etc.)
     :param token: Authentication token
+    :param service_id: ID of the service to charge
+    :param charge: Boolean indicating whether to charge the container for the service
 
     
 Dev Notes:
@@ -75,6 +84,7 @@ Dev Notes:
         summary = save_files_from_bytes(files_as_byte_strings, L)
         L.log_operation("Success", f"File copy summary: {summary}", params=None, flush_logs=True)
         print("Summary:", summary)
+        
     except Exception as e:
         # If something unexpected blows up the entire process
         L.log_operation("Error", f"Failed to copy files: {e}", params=None, flush_logs=True)
@@ -117,6 +127,27 @@ Dev Notes:
         print("Error attaching extra files:", e)
 
 
+    # STEP 6: Charge the container for the service
+    if charge: 
+        
+        if service_id == 0:
+            print("Service ID not provided. Skipping charge creation.")
+            L.log_operation("Info", "Service ID not provided. Skipping charge creation.", params=None, flush_logs=True)
+        else:
+            container_ids = list(set(list(resource_paths.values())))
+            if not container_ids:
+                L.log_operation("Error", "No container IDs found for charging.", params=None, flush_logs=True)
+                print("Error: No container IDs found for charging.")
+                return
+            for container_id in container_ids:
+                charges = create_charge(token_data, container_id, service_id)
+                charge_id = charges[0].get("id")
+                L.log_operation("Success", f"Charge created for container {container_id} with service ID {service_id} and charge id {charge_id}", params=None, flush_logs=False)
+                print(f"Charge created with id {charge_id} for container {container_id} with service ID {service_id}")
+            L.flush_logs()
+    else:
+        L.log_operation("Info", "Charge creation skipped.", params=None, flush_logs=True)
+        print("Charge creation skipped.")
 
 #---------------------------------------------------------------------------------------------------------------------
 #---------------------------------------------------------------------------------------------------------------------
@@ -138,23 +169,23 @@ def save_files_from_bytes(files_as_byte_strings: dict, logger):
     """
     results = {}  # Store results: (destination) -> True (if success) or error message (if failure)
 
+    message = "All files saved successfully."
+
     # First pass: attempt to write all files
     for destination, file_bytes in files_as_byte_strings.items():
         try:
-            # Ensure the directory exists
-            os.makedirs(os.path.dirname(destination), exist_ok=True)
-
             # Write file from byte string
-            with open(destination, "wb") as f:
+            with open(destination, "+wb") as f:
                 f.write(file_bytes)
-            logger.log_operation("Files saved", "All files saved successfully.", params=None, flush_logs=True)
-            return "All files saved successfully."
+            logger.log_operation(f"File saved", f"File {destination} saved successfully.", params=None, flush_logs=True)
         
         except Exception as e:
             error_msg = f"Error saving file: {destination}, Error: {str(e)}"
             logger.log_operation("Error", error_msg, params=None, flush_logs=True)
             print(error_msg)
-            raise RuntimeError(error_msg)
+            message = f"Error saving some files." 
+
+    return message
 
 
 # -----------------------------------------------------------------------------
@@ -412,3 +443,14 @@ def create_api_link(token_data, logger, entity_class, entity_id, file_name, fold
         logger.log_operation("Error", error_msg, params=None, flush_logs=True)
         print(error_msg)
 
+
+def read_file_as_bytes(file_path, max_size_mb=400):
+    """Reads any file type and stores it as a byte string in a dictionary."""
+    file_size_mb = os.path.getsize(file_path) / (1024 * 1024)  # Convert bytes to MB
+    if file_size_mb > max_size_mb:
+        raise ValueError(f"File {file_path} exceeds {max_size_mb}MB limit ({file_size_mb:.2f}MB).")
+
+    with open(file_path, "rb") as f:  # Read as bytes
+        file_as_bytes = f.read()
+
+    return file_as_bytes

{bfabric_web_apps-0.1.6.dist-info → bfabric_web_apps-0.1.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bfabric-web-apps
-Version: 0.1.6
+Version: 0.1.7
 Summary: A package containing handy boilerplate utilities for developing bfabric web-applications
 Author: Marc Zuber, Griffin White, GWC GmbH
 Requires-Python: >=3.10,<4.0
@@ -10,6 +10,7 @@ Classifier: Programming Language :: Python :: 3.11
 Requires-Dist: bfabric (>=1.13.23,<2.0.0)
 Requires-Dist: dash (>=3.0.2,<4.0.0)
 Requires-Dist: dash-bootstrap-components (>=2.0.0,<3.0.0)
+Requires-Dist: dash-daq (>=0.6.0,<0.7.0)
 Requires-Dist: pydantic-settings (>=2.8.1,<3.0.0)
 Requires-Dist: pydantic[email] (>=2.10.6,<3.0.0)
 Requires-Dist: rq (==1.15.1)

{bfabric_web_apps-0.1.6.dist-info → bfabric_web_apps-0.1.7.dist-info}/RECORD

@@ -1,11 +1,12 @@
-bfabric_web_apps/__init__.py,sha256=D2jTCEYedVnp6yQxNGLRsjihupDTQxNkPVFQAUYXQys,1409
+bfabric_web_apps/__init__.py,sha256=9OSketawJ_bkCbCN0Q3KaM6_u1_zyE74oC7jtrznFP8,1503
 bfabric_web_apps/layouts/layouts.py,sha256=z8gL4n4wwLdpLGomO9CftBLnGpc3r6OpmUc2-wBg8uo,14661
-bfabric_web_apps/objects/BfabricInterface.py,sha256=wmcL9JuSC0QEopgImvkZxmtCIS7izt6bwb6y_ch0zus,10178
+bfabric_web_apps/objects/BfabricInterface.py,sha256=2BNskMzV5K1a-tXFHQubcBk7Rt-8g9du7mNAJrGohMY,10170
 bfabric_web_apps/objects/Logger.py,sha256=62LC94xhm7YG5LUw3yH46NqvJQsAX7wnc9D4zbY16rA,5224
 bfabric_web_apps/utils/app_init.py,sha256=RCdpCXp19cF74bouYJLPe-KSETZ0Vwqtd02Ta2VXEF8,428
-bfabric_web_apps/utils/callbacks.py,sha256=m5d6IPiYX77-kJN8I2OptZN-GPxZgrI76o1DGFxjpPU,12686
-bfabric_web_apps/utils/components.py,sha256=V7ECGmF2XYy5O9ciDJVH1nofJYP2a_ELQF3z3X_ADbo,844
-bfabric_web_apps/utils/config.py,sha256=i93fe49Ak4Z7cm_G80m2cBCPp-5qCYLAJEtEr-mYSwQ,1044
+bfabric_web_apps/utils/callbacks.py,sha256=tB1xtHl_ePY6KJWNz3erkrZw3HFhRneewGqZm9xIYtI,12687
+bfabric_web_apps/utils/charging.py,sha256=oNNazH59SFkbxJKPvCel0IxdsRHC8xpJ0AXCLvI88FI,1069
+bfabric_web_apps/utils/components.py,sha256=X3NRnv--LsHWMtWL83Pzr2whOZLSEJIwXTklQdAQpZE,984
+bfabric_web_apps/utils/config.py,sha256=vJzhmc6ooFb46MM1Eg3m8gNrM4fJa-l5Tao2Py-SF_I,1115
 bfabric_web_apps/utils/create_app_in_bfabric.py,sha256=eVk3cQDXxW-yo9b9n_zzGO6kLg_SLxYbIDECyvEPJXU,2752
 bfabric_web_apps/utils/get_logger.py,sha256=0Y3SrXW93--eglS0_ZOc34NOriAt6buFPik5n0ltzRA,434
 bfabric_web_apps/utils/get_power_user_wrapper.py,sha256=T33z64XjmJ0KSlmfEmrEP8eYpbpINCVD6Xld_V7PR2g,1027
@@ -13,8 +14,8 @@ bfabric_web_apps/utils/redis_connection.py,sha256=qXSPxW6m55Ogv44BhmPCl9ACuvzmpf
 bfabric_web_apps/utils/redis_queue.py,sha256=MCx7z_I2NusJ4P42mcLvV7STtXBFMIIvun83fM8zOGI,168
 bfabric_web_apps/utils/redis_worker_init.py,sha256=9SUc9bbgBeMbUdqJD9EkWPA4wcJjvyX6Tzanv5JfqEg,691
 bfabric_web_apps/utils/resource_utilities.py,sha256=4LnV_eQjKkcpZJBsWFx--dmASyE7jfJfktk2hdHn5Fk,5856
-bfabric_web_apps/utils/run_main_pipeline.py,sha256=1YSbk3uP_T3tL6mZZXGv7a7FJc8exro_Eb49gnJjdrs,16864
-bfabric_web_apps-0.1.6.dist-info/LICENSE,sha256=k0O_i2k13i9e35aO-j7FerJafAqzzu8x0kkBs0OWF3c,1065
-bfabric_web_apps-0.1.6.dist-info/METADATA,sha256=bFw2hFwCuonWxGFxyCSj6y_l2rIjKfxbzXCAGK3O0Ek,646
-bfabric_web_apps-0.1.6.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
-bfabric_web_apps-0.1.6.dist-info/RECORD,,
+bfabric_web_apps/utils/run_main_pipeline.py,sha256=RG-Jb3-O1Ok8L0i1gddWVeAEqJT6REITtcD9XDoC_Dc,18766
+bfabric_web_apps-0.1.7.dist-info/LICENSE,sha256=k0O_i2k13i9e35aO-j7FerJafAqzzu8x0kkBs0OWF3c,1065
+bfabric_web_apps-0.1.7.dist-info/METADATA,sha256=Jf3A0eVEOXvoMzFJCmxpWnoGvKNnHd2ckHg4o9w6nm0,687
+bfabric_web_apps-0.1.7.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
+bfabric_web_apps-0.1.7.dist-info/RECORD,,