Feat/copy assets

flexmeasures/api/common/utils/api_utils.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import json
 from timely_beliefs.beliefs.classes import BeliefsDataFrame
 from typing import Sequence
 from datetime import timedelta
@@ -14,6 +15,7 @@
 
 from flexmeasures.data import db
 from flexmeasures.data.models.user import Account
+from flexmeasures.data.models.generic_assets import GenericAsset
 from flexmeasures.data.utils import save_to_db
 from flexmeasures.auth.policy import check_access
 from flexmeasures.api.common.responses import (
@@ -22,6 +24,7 @@
     request_processed,
     already_received_and_successfully_processed,
 )
+from flexmeasures.data.schemas.generic_assets import GenericAssetSchema as AssetSchema
 from flexmeasures.utils.error_utils import error_handling_router
 from flexmeasures.utils.flexmeasures_inflection import capitalize
 
@@ -182,3 +185,83 @@ def get_accessible_accounts() -> list[Account]:
             pass
 
     return accounts
+
+
+def convert_asset_json_fields(asset_kwargs):
+    """
+    Convert string fields in asset_kwargs to JSON where needed.
+    """
+    if "attributes" in asset_kwargs and isinstance(asset_kwargs["attributes"], str):
+        asset_kwargs["attributes"] = json.loads(asset_kwargs["attributes"])
+    if "sensors_to_show" in asset_kwargs and isinstance(
+        asset_kwargs["sensors_to_show"], str
+    ):
+        asset_kwargs["sensors_to_show"] = json.loads(asset_kwargs["sensors_to_show"])
+    if "flex_context" in asset_kwargs and isinstance(asset_kwargs["flex_context"], str):
+        asset_kwargs["flex_context"] = json.loads(asset_kwargs["flex_context"])
+    if "flex_model" in asset_kwargs and isinstance(asset_kwargs["flex_model"], str):
+        asset_kwargs["flex_model"] = json.loads(asset_kwargs["flex_model"])
+    if "sensors_to_show_as_kpis" in asset_kwargs and isinstance(
+        asset_kwargs["sensors_to_show_as_kpis"], str
+    ):
+        asset_kwargs["sensors_to_show_as_kpis"] = json.loads(
+            asset_kwargs["sensors_to_show_as_kpis"]
+        )
+    return asset_kwargs
+
+
+def fetch_and_copy_all_assets_in_account(
+    account_id: int, target_account_id: int
+) -> list[GenericAsset]:
+    try:
+        asset_schema = AssetSchema()
+
+        # order from oldest to newest to help with parent/child dependencies
+        assets = db.session.scalars(
+            select(GenericAsset)
+            .filter(GenericAsset.account_id == account_id)
+            .order_by(GenericAsset.id)
+        ).all()
+
+        if len(assets) == 0:
+            raise ValueError(f"No assets found for account {account_id}.")
+
+        asset_mapping = {}
+        parent_mapping = {}
+        new_assets = []
+
+        for old_asset in assets:
+            asset_kwargs = asset_schema.dump(old_asset)
+
+            # Remove dump_only and read-only fields
+            for key in ["id", "owner", "generic_asset_type", "child_assets", "sensors"]:
+                asset_kwargs.pop(key, None)
+
+            # Avoid name collisions
+            asset_kwargs["name"] = f"{asset_kwargs['name']} (Copy)"
+            # Assign to the target account
+            asset_kwargs["account_id"] = target_account_id
+            asset_kwargs = convert_asset_json_fields(asset_kwargs)
+
+            # Keep track of parent_asset_id to reconnect later
+            if asset_kwargs.get("parent_asset_id"):
+                parent_mapping[old_asset.id] = asset_kwargs["parent_asset_id"]
+            asset_kwargs["parent_asset_id"] = None
+
+            new_asset = GenericAsset(**asset_kwargs)
+            db.session.add(new_asset)
+            db.session.flush()
+
+            asset_mapping[old_asset.id] = new_asset
+            new_assets.append(new_asset)
+
+        # Second loop to set the proper parent
+        for old_id, old_parent_id in parent_mapping.items():
+            if old_parent_id in asset_mapping:
+                asset_mapping[old_id].parent_asset_id = asset_mapping[old_parent_id].id
+
+        db.session.commit()
+        return new_assets
+    except Exception as e:
+        db.session.rollback()
+        raise e

flexmeasures/api/v3_0/assets.py

@@ -56,7 +56,10 @@
     create_sequential_scheduling_job,
     create_simultaneous_scheduling_job,
 )
-from flexmeasures.api.common.utils.api_utils import get_accessible_accounts
+from flexmeasures.api.common.utils.api_utils import (
+    get_accessible_accounts,
+    fetch_and_copy_all_assets_in_account,
+)
 from flexmeasures.api.common.responses import (
     unprocessable_entity,
     request_processed,
@@ -1542,3 +1545,26 @@ def get_kpis(self, id: int, asset: GenericAsset, start, end):
             }
             kpis.append(kpi_dict)
         return dict(data=kpis), 200
+
+    @route("/copy", methods=["POST"])
+    @use_kwargs(
+        {
+            "account_id": fields.Int(required=True),
+            "target_account_id": fields.Int(required=True),
+        },
+        location="query",
+    )
+    @as_json
+    def copy_assets(self, account_id: int, target_account_id: int):
+        """
+        .. :quickref: Assets; Copy all assets from one account to another.
+        """
+
+        # Ensure the user has administrative privileges or access to both accounts, if needed,
+        # but for now we just call the function as requested.
+        new_assets = fetch_and_copy_all_assets_in_account(account_id, target_account_id)
+
+        return {
+            "message": f"Successfully copied {len(new_assets)} assets to account {target_account_id}.",
+            "assets": [a.id for a in new_assets],
+        }, 200

flexmeasures/api/v3_0/tests/test_assets_api.py

@@ -9,6 +9,7 @@
 from flexmeasures.data.services.users import find_user_by_email
 from flexmeasures.api.tests.utils import get_auth_token, UserContext, AccountContext
 from flexmeasures.api.v3_0.tests.utils import get_asset_post_data, check_audit_log_event
+from flexmeasures.api.common.utils.api_utils import fetch_and_copy_all_assets_in_account
 from flexmeasures.utils.unit_utils import is_valid_unit
 
 
@@ -685,3 +686,45 @@ def test_consultant_get_asset(
     print("Server responded with:\n%s" % get_asset_response.json)
     assert get_asset_response.status_code == 200
     assert get_asset_response.json["name"] == "Test ConsultancyClient Asset"
+
+
+def test_fetch_and_copy_all_assets_in_account(setup_api_test_data, setup_accounts, db):
+
+    base_account = setup_accounts["Prosumer"]
+    target_account = setup_accounts["Empty"]
+
+    # Get the original assets in the base account
+    original_assets = db.session.scalars(
+        select(GenericAsset).filter_by(account_id=base_account.id)
+    ).all()
+    original_asset_count = len(original_assets)
+
+    assert (
+        original_asset_count > 0
+    ), "Base account should have at least one asset to test properly"
+
+    # Count assets in the target account before the operation
+    target_assets_before = db.session.scalars(
+        select(GenericAsset).filter_by(account_id=target_account.id)
+    ).all()
+    target_asset_count_before = len(target_assets_before)
+
+    # Call the copy function
+    new_assets = fetch_and_copy_all_assets_in_account(
+        base_account.id, target_account.id
+    )
+
+    # 1. Check if the amount of assets copied are complete
+    target_assets_after = db.session.scalars(
+        select(GenericAsset).filter_by(account_id=target_account.id)
+    ).all()
+
+    assert len(target_assets_after) == target_asset_count_before + original_asset_count
+    assert len(new_assets) == original_asset_count
+
+    # 2. Using the name of the original asset, search if it exists in the new account
+    new_asset_names = [a.name for a in target_assets_after]
+
+    for old_asset in original_assets:
+        expected_new_name = f"{old_asset.name} (Copy)"
+        assert expected_new_name in new_asset_names

flexmeasures/ui/static/openapi-specs.json

@@ -2648,6 +2648,7 @@
         ]
       }
     },
+    "/api/v3_0/assets/copy": {},
     "/api/v3_0/assets/{id}": {
       "delete": {
         "summary": "Delete an asset.",
@@ -3898,14 +3899,7 @@
     "schemas": {
       "Quantity": {
         "type": "string",
-        "description": "Quantity string describing a fixed quantity.",
-        "examples": [
-          "130 EUR/MWh",
-          "12 V",
-          "4.5 m/s",
-          "20 \u00b0C",
-          "3 * 230V * 16A"
-        ]
+        "description": "Quantity string describing a fixed quantity."
       },
       "SensorReference": {
         "type": "object",