From e88d4ee29607232d7cf1aa7b8a709f26c105e818 Mon Sep 17 00:00:00 2001
From: Laurent LAPORTE <43534797+laurent-laporte-pro@users.noreply.github.com>
Date: Tue, 18 Jul 2023 14:59:14 +0200
Subject: [PATCH] feat(commands): add ST-Storage commands (#1630)
---
.../rawstudy/model/filesystem/config/files.py | 48 +-
.../rawstudy/model/filesystem/config/model.py | 33 +-
.../model/filesystem/config/st_storage.py | 115 ++++
.../series/area/st_storage/st_storage.py | 8 +-
.../variantstudy/business/command_reverter.py | 31 +
.../business/matrix_constants/__init__.py | 2 +-
.../matrix_constants/st_storage/__init__.py | 1 +
.../business/matrix_constants_generator.py | 50 +-
.../storage/variantstudy/command_factory.py | 10 +-
.../variantstudy/model/command/common.py | 2 +
.../model/command/create_cluster.py | 2 +
.../command/create_renewables_cluster.py | 2 +
.../model/command/create_st_storage.py | 381 +++++++++++++
.../model/command/remove_st_storage.py | 169 ++++++
docs/user-guide/2-variant_manager.md | 315 ++++++++++-
.../integration/variant_blueprint/__init__.py | 0
.../variant_blueprint/test_st_storage.py | 240 ++++++++
.../filesystem/config/test_config_files.py | 75 ++-
tests/study/storage/variantstudy/__init__.py | 0
.../storage/variantstudy/business/__init__.py | 0
.../test_matrix_constants_generator.py | 54 ++
.../model/command/test_create_st_storage.py | 534 ++++++++++++++++++
.../model/command/test_remove_st_storage.py | 259 +++++++++
tests/variantstudy/test_command_factory.py | 109 +++-
24 files changed, 2327 insertions(+), 113 deletions(-)
create mode 100644 antarest/study/storage/rawstudy/model/filesystem/config/st_storage.py
create mode 100644 antarest/study/storage/variantstudy/model/command/create_st_storage.py
create mode 100644 antarest/study/storage/variantstudy/model/command/remove_st_storage.py
create mode 100644 tests/integration/variant_blueprint/__init__.py
create mode 100644 tests/integration/variant_blueprint/test_st_storage.py
create mode 100644 tests/study/storage/variantstudy/__init__.py
create mode 100644 tests/study/storage/variantstudy/business/__init__.py
create mode 100644 tests/study/storage/variantstudy/business/test_matrix_constants_generator.py
create mode 100644 tests/variantstudy/model/command/test_create_st_storage.py
create mode 100644 tests/variantstudy/model/command/test_remove_st_storage.py
diff --git a/antarest/study/storage/rawstudy/model/filesystem/config/files.py b/antarest/study/storage/rawstudy/model/filesystem/config/files.py
index 789b23a3bb..d21862be34 100644
--- a/antarest/study/storage/rawstudy/model/filesystem/config/files.py
+++ b/antarest/study/storage/rawstudy/model/filesystem/config/files.py
@@ -26,7 +26,9 @@
Link,
Simulation,
transform_name_to_id,
- Storage,
+)
+from antarest.study.storage.rawstudy.model.filesystem.config.st_storage import (
+ STStorageConfig,
)
from antarest.study.storage.rawstudy.model.filesystem.root.settings.generaldata import (
DUPLICATE_KEYS,
@@ -49,35 +51,38 @@ def build(
study_path: Path, study_id: str, output_path: Optional[Path] = None
) -> "FileStudyTreeConfig":
"""
- Extract data from filesystem to build config study.
- Args:
- study_path: study_path with files inside.
- study_id: uuid of the study
- output_path: output_path if not in study_path/output
+ Extracts data from the filesystem to build a study config.
- Returns: study config fill with data
+ Args:
+ study_path: Path to the study directory or ZIP file containing the study.
+ study_id: UUID of the study.
+ output_path: Optional path for the output directory.
+ If not provided, it will be set to `{study_path}/output`.
+ Returns:
+ An instance of `FileStudyTreeConfig` filled with the study data.
"""
- (sns, asi, enr_modelling) = _parse_parameters(study_path)
+ is_zip_file = study_path.suffix.lower() == ".zip"
- study_path_without_zip_extension = study_path.parent / (
- study_path.stem if study_path.suffix == ".zip" else study_path.name
- )
+ # Study directory to use if the study is compressed
+ study_dir = study_path.with_suffix("") if is_zip_file else study_path
+ (sns, asi, enr_modelling) = _parse_parameters(study_path)
+ outputs_dir: Path = output_path or study_path / "output"
return FileStudyTreeConfig(
study_path=study_path,
- output_path=output_path or study_path / "output",
- path=study_path_without_zip_extension,
+ output_path=outputs_dir,
+ path=study_dir,
study_id=study_id,
version=_parse_version(study_path),
areas=_parse_areas(study_path),
sets=_parse_sets(study_path),
- outputs=_parse_outputs(output_path or study_path / "output"),
+ outputs=_parse_outputs(outputs_dir),
bindings=_parse_bindings(study_path),
store_new_set=sns,
archive_input_series=asi,
enr_modelling=enr_modelling,
- zip_path=study_path if study_path.suffix == ".zip" else None,
+ zip_path=study_path if is_zip_file else None,
)
@@ -359,7 +364,7 @@ def parse_area(root: Path, area: str) -> "Area":
renewables=_parse_renewables(root, area_id),
filters_synthesis=_parse_filters_synthesis(root, area_id),
filters_year=_parse_filters_year(root, area_id),
- st_storage=_parse_st_storage(root, area_id),
+ st_storages=_parse_st_storage(root, area_id),
)
@@ -379,21 +384,18 @@ def _parse_thermal(root: Path, area: str) -> List[Cluster]:
]
-def _parse_st_storage(root: Path, area: str) -> List[Storage]:
+def _parse_st_storage(root: Path, area: str) -> List[STStorageConfig]:
"""
Parse the short-term storage INI file, return an empty list if missing.
"""
- list_ini: Dict[str, Any] = _extract_data_from_file(
+ config_dict: Dict[str, Any] = _extract_data_from_file(
root=root,
inside_root_path=Path(f"input/st-storage/clusters/{area}/list.ini"),
file_type=FileType.SIMPLE_INI,
)
return [
- Storage(
- id=transform_name_to_id(key),
- name=values.get("name", key),
- )
- for key, values in list_ini.items()
+ STStorageConfig(**dict(values, id=storage_id))
+ for storage_id, values in config_dict.items()
]
diff --git a/antarest/study/storage/rawstudy/model/filesystem/config/model.py b/antarest/study/storage/rawstudy/model/filesystem/config/model.py
index 507f884c50..31374e44ee 100644
--- a/antarest/study/storage/rawstudy/model/filesystem/config/model.py
+++ b/antarest/study/storage/rawstudy/model/filesystem/config/model.py
@@ -3,10 +3,14 @@
from pathlib import Path
from typing import Dict, List, Optional, Set
+from pydantic import Extra
+
from antarest.core.model import JSON
from antarest.core.utils.utils import DTO
from pydantic.main import BaseModel
+from .st_storage import STStorageConfig
+
class ENR_MODELLING(Enum):
AGGREGATED = "aggregated"
@@ -23,15 +27,6 @@ class Cluster(BaseModel):
enabled: bool = True
-class Storage(BaseModel):
- """
- Short-term storage model used in Area creation
- """
-
- id: str
- name: str
-
-
class Link(BaseModel):
"""
Object linked to /input/links/{ | Update arbitrary config |
-| replace_matrix | { | Replace arbitrary matrix |
-| create_area | { | Create a new area |
-| remove_area | { | Remove an existing area |
-| create_cluster | { | Create a new thermal cluster |
-| remove_cluster | { | Remove an existing thermal cluster |
-| create_renewables_cluster | { | Create a new renewable cluster |
-| remove_renewables_cluster | { | Remove an existing renewable cluster |
-| create_link | { | Create a new link |
-| remove_link | { | Remove an existing link |
-| create_district | {"remove-all" | Create a new district (set of areas) |
-| remove_district | { | Remove an existing district |
-| create_binding_constraint | { { | Create a new binding constraint |
-| update_binding_constraint | { | Update an existing binding constraint |
-| remove_binding_constraint | { | Remove an existing binding constraint |
-| update_playlist | { | Update the playlist with provided active (or inactive) years (starting from year 1) |
-| update_scenario_builder | { | Update scenario builder with partial configuration |
-| update_district | {"remove-all" | Update a district (set of areas) |
-| update_raw_file | { | Replace arbitrary data file (must not be a matrix or ini target) with a base64 encoded data |
-
-#### Base types
+### Base types
+
+The following table describes the data types used in the commands:
| Type | Description |
|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -89,11 +67,288 @@ The example provided bellow demonstrates the creation of two areas and a link be
| RULESETS_MODEL | like `INI_MODEL` with some specifications: an empty string allows to remove a key (ruleset or cell value) and a ruleset "A" with for value the name of an another ruleset "B" allows to clone the content of "B" in "A" |
| INPUT_RAW_FILE_TARGET | a valid antares raw data file relative path (without extension). The path can be found when browsing the study in detailed view |
| INPUT_SERIES_MATRIX_TARGET | a valid antares matrix data file relative path (without extension). The path can be found when browsing the study in detailed view |
-| MATRIX | a matrix id or a list of list of values (eg. [[0,1,2],[4,5,6]] where each sub list is a row of the matrix). Matrix id can be found in the Matrix Data manager tab. |
-| AREA_ID | the id of an area (same as name, but lower cased and only with the following characters: [a-z],[0-9]_,(,),-,&,",". Other characters will be transformed into a single space.) |
-| CLUSTER_ID | the id of a cluster (same as name, but lower cased and only with the following characters: [a-z],[0-9]_,(,),-,&,",". Other characters will be transformed into a single space.) |
-| DISTRICT_ID | the id of a district (same as name, but lower cased and only with the following characters: [a-z],[0-9]_,(,),-,&,",". Other characters will be transformed into a single space.) |
-| BINDING_CONSTRAINT_ID | the id of a binding constraint (same as name, but lower cased and only with the following characters: [a-z],[0-9]_,(,),-,&,",". Other characters will be transformed into a single space.) |
+| MATRIX | a matrix id or a list of list of values (eg. [[0,1,2],[4,5,6]] where each sub list is a row of the matrix). Matrix ID can be found in the Matrix Data manager tab. |
+| AREA_ID | the ID of an area (same as name, but lower cased and only with the following characters: [a-z],[0-9]_,(,),-,&,",". Other characters will be transformed into a single space.) |
+| CLUSTER_ID | the ID of a cluster (same as name, but lower cased and only with the following characters: [a-z],[0-9]_,(,),-,&,",". Other characters will be transformed into a single space.) |
+| STORAGE_ID | the ID of a short-term storage (same as name, but lower cased and only with the following characters: [a-z],[0-9]_,(,),-,&,",". Other characters will be transformed into a single space.) |
+| DISTRICT_ID | the ID of a district (same as name, but lower cased and only with the following characters: [a-z],[0-9]_,(,),-,&,",". Other characters will be transformed into a single space.) |
+| BINDING_CONSTRAINT_ID | the ID of a binding constraint (same as name, but lower cased and only with the following characters: [a-z],[0-9]_,(,),-,&,",". Other characters will be transformed into a single space.) |
+
+### `update_config`
+
+Update arbitrary config
+
+```json
+{
+ "target": "",
+ "data": ""
+}
+```
+
+### `replace_matrix`
+
+Replace arbitrary matrix
+
+```json
+{
+ "target": "",
+ "matrix": ""
+}
+```
+
+### `create_area`
+
+Create a new area
+
+```json
+{
+ "area_name": ""
+}
+```
+
+### `remove_area`
+
+Remove an existing area
+
+```json
+{
+ "id": ""
+}
+```
+
+### `create_cluster`
+
+Create a new thermal cluster
+
+```json
+{
+ "area_id": "",
+ "cluster_name": "",
+ "parameters": "",
+ "prepro?": "",
+ "modulation?": ""
+}
+```
+
+### `remove_cluster`
+
+Remove an existing thermal cluster
+
+```json
+{
+ "area_id": "",
+ "cluster_id": ""
+}
+```
+
+### `create_renewables_cluster`
+
+Create a new renewable cluster
+
+```json
+{
+ "area_id": "",
+ "cluster_name": "",
+ "parameters": ""
+}
+```
+
+### `remove_renewables_cluster`
+
+Remove an existing renewable cluster
+
+```json
+{
+ "area_id": "",
+ "cluster_id": ""
+}
+```
+
+### `create_link`
+
+Create a new link
+
+```json
+{
+ "area1": "",
+ "area2": "",
+ "parameters": "",
+ "series?": ""
+}
+```
+
+### `remove_link`
+
+Remove an existing link
+
+```json
+{
+ "area1": "",
+ "area2": ""
+}
+```
+
+### `create_district`
+
+Create a new district (set of areas)
+
+```json
+{
+ "name": "",
+ "base_filter?": "'add-all' | 'remove-all'",
+ "filter_items?": "",
+ "output?": " (default: True)",
+ "comments?": ""
+}
+```
+
+### `remove_district`
+
+Remove an existing district
+
+```json
+{
+ "id": ""
+}
+```
+
+### `create_binding_constraint`
+
+Create a new binding constraint
+
+```json
+{
+ "name": "",
+ "enabled?": " (default: True)",
+ "time_step": "'hourly' | 'weekly' | 'daily'",
+ "operator": "'equal' | 'both' | 'greater' | 'less'",
+ "coeffs": "",
+ "values?": "",
+ "comments?": ""
+}
+```
+
+Where cluster `CONSTRAINT_COEFF` is:
+
+```json
+{
+ "type": "cluster",
+ "cluster": ".",
+ "coeff": "",
+ "offset?": ""
+}
+```
+
+Or link `CONSTRAINT_COEFF` is:
+
+```json
+{
+ "type": "link",
+ "link": "%",
+ "coeff": "",
+ "offset?": ""
+}
+```
+
+### `update_binding_constraint`
+
+Update an existing binding constraint
+
+```json
+{
+ "id": "",
+ "enabled?": " (default: True)",
+ "time_step": "'hourly' | 'weekly' | 'daily'",
+ "operator": "'equal' | 'both' | 'greater' | 'less'",
+ "coeffs": "",
+ "values?": "",
+ "comments?": ""
+}
+```
+
+### `remove_binding_constraint`
+
+Remove an existing binding constraint
+
+```json
+{
+ "id": ""
+}
+```
+
+### `update_playlist`
+
+Update the playlist with provided active (or inactive) years (starting from year 1)
+
+```json
+{
+ "active": " (default: True)",
+ "reverse": " (default: False)",
+ "items": " (default: None)"
+}
+```
+
+### `update_scenario_builder`
+
+Update scenario builder with partial configuration
+
+```json
+{
+ "data": ""
+}
+```
+
+### `update_district`
+
+Update a district (set of areas)
+
+```json
+{
+ "id": "",
+ "base_filter?": "'add-all' | 'remove-all'",
+ "filter_items?": "",
+ "output?": " (default: True)",
+ "comments?": ""
+}
+```
+
+### `update_raw_file`
+
+Replace arbitrary data file (must not be a matrix or ini target) with a base64 encoded data
+
+```json
+{
+ "target": "",
+ "b64Data": ""
+}
+```
+
+### `create_st_storage`
+
+Create a new short-term storage
+
+```json
+{
+ "area_id": "",
+ "parameters": "",
+ "pmax_injection?": "",
+ "pmax_withdrawal?": "",
+ "lower_rule_curve?": "",
+ "upper_rule_curve?": "",
+ "inflows?": ""
+}
+```
+
+### `remove_st_storage`
+
+Remove an existing short-term storage
+
+```json
+{
+ "area_id": "",
+ "storage_id": ""
+}
+```
### Specialized commands
diff --git a/tests/integration/variant_blueprint/__init__.py b/tests/integration/variant_blueprint/__init__.py
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/tests/integration/variant_blueprint/test_st_storage.py b/tests/integration/variant_blueprint/test_st_storage.py
new file mode 100644
index 0000000000..611817da48
--- /dev/null
+++ b/tests/integration/variant_blueprint/test_st_storage.py
@@ -0,0 +1,240 @@
+import http
+from unittest.mock import ANY
+
+import numpy as np
+import pytest
+from starlette.testclient import TestClient
+
+from antarest.core.tasks.model import TaskStatus
+from antarest.study.storage.rawstudy.model.filesystem.config.model import (
+ transform_name_to_id,
+)
+from tests.integration.utils import wait_task_completion
+
+
+@pytest.mark.integration_test
+class TestSTStorage:
+ """
+ This unit test is designed to demonstrate the creation, modification of properties and
+ updating of matrices, and the deletion of one or more short-term storages.
+ """
+
+ # noinspection SpellCheckingInspection
+ def test_lifecycle(
+ self,
+ client: TestClient,
+ user_access_token: str,
+ study_id: str,
+ ):
+ # =======================
+ # Study version upgrade
+ # =======================
+
+ # We have an "old" study that we need to upgrade to version 860
+ min_study_version = 860
+ res = client.put(
+ f"/v1/studies/{study_id}/upgrade",
+ headers={"Authorization": f"Bearer {user_access_token}"},
+ params={"target_version": min_study_version},
+ )
+ res.raise_for_status()
+ task_id = res.json()
+ task = wait_task_completion(client, user_access_token, task_id)
+ assert task.status == TaskStatus.COMPLETED, task
+
+ # We can check that the study is upgraded to the required version
+ res = client.get(
+ f"/v1/studies/{study_id}",
+ headers={"Authorization": f"Bearer {user_access_token}"},
+ )
+ res.raise_for_status()
+ assert res.json() == {
+ "id": study_id,
+ "name": "STA-mini",
+ "version": min_study_version,
+ "created": ANY, # ISO8601 Date/time
+ "updated": ANY, # ISO8601 Date/time
+ "type": "rawstudy",
+ "owner": {"id": None, "name": ANY},
+ "groups": [],
+ "public_mode": "FULL",
+ "workspace": "ext",
+ "managed": False,
+ "archived": False,
+ "horizon": "2030",
+ "scenario": None,
+ "status": None,
+ "doc": None,
+ "folder": "STA-mini",
+ "tags": [],
+ }
+
+ # Here is the list of available areas
+ res = client.get(
+ f"/v1/studies/{study_id}/areas",
+ headers={"Authorization": f"Bearer {user_access_token}"},
+ )
+ res.raise_for_status()
+ areas = res.json()
+ area_ids = {a["id"] for a in areas if a["type"] == "AREA"}
+ assert area_ids == {"es", "it", "de", "fr"}
+
+ # =============================================
+ # Short-Term Storage Creation w/o Time Series
+ # =============================================
+
+ # First, we will define a short-term storage in the geographical
+ # area "FR" called "Siemens Battery" with the bellow arguments.
+ # We will use the default values for the time series:
+ # - `pmax_injection`: Charge capacity,
+ # - `pmax_withdrawal`: Discharge capacity,
+ # - `lower_rule_curve`: Lower rule curve,
+ # - `upper_rule_curve`: Upper rule curve,
+ # - `inflows`: Inflows
+ area_id = transform_name_to_id("FR")
+ siemens_battery = "Siemens Battery"
+ args = {
+ "area_id": area_id,
+ "parameters": {
+ "name": siemens_battery,
+ "group": "Battery",
+ "injection_nominal_capacity": 150,
+ "withdrawal_nominal_capacity": 150,
+ "reservoir_capacity": 600,
+ "efficiency": 0.94,
+ "initial_level_optim": True,
+ },
+ }
+ res = client.post(
+ f"/v1/studies/{study_id}/commands",
+ headers={"Authorization": f"Bearer {user_access_token}"},
+ json=[{"action": "create_st_storage", "args": args}],
+ )
+ res.raise_for_status()
+
+ # =======================================
+ # Short-Term Storage Time Series Update
+ # =======================================
+
+ # Then, it is possible to update a time series.
+ # For instance, we want to initialize the `inflows` time series
+ # with random values (for this demo).
+ # To do that, we can use the `replace_matrix` command like bellow:
+ siemens_battery_id = transform_name_to_id(siemens_battery)
+ inflows = np.random.randint(0, 1001, size=(8760, 1))
+ args1 = {
+ "target": f"input/st-storage/series/{area_id}/{siemens_battery_id}/inflows",
+ "matrix": inflows.tolist(),
+ }
+ pmax_injection = np.random.rand(8760, 1)
+ args2 = {
+ "target": f"input/st-storage/series/{area_id}/{siemens_battery_id}/pmax_injection",
+ "matrix": pmax_injection.tolist(),
+ }
+ res = client.post(
+ f"/v1/studies/{study_id}/commands",
+ headers={"Authorization": f"Bearer {user_access_token}"},
+ json=[
+ {"action": "replace_matrix", "args": args1},
+ {"action": "replace_matrix", "args": args2},
+ ],
+ )
+ res.raise_for_status()
+
+ # ==============================================
+ # Short-Term Storage Creation with Time Series
+ # ==============================================
+
+ # Another way to create a Short-Term Storage is by providing
+ # both the parameters and the time series arrays.
+ # Here is an example where we populate some arrays with random values.
+ pmax_injection = np.random.rand(8760, 1)
+ pmax_withdrawal = np.random.rand(8760, 1)
+ inflows = np.random.randint(0, 1001, size=(8760, 1))
+ grand_maison = "Grand'Maison"
+ args = {
+ "area_id": area_id,
+ "parameters": {
+ "name": grand_maison,
+ "group": "PSP_closed",
+ "injectionnominalcapacity": 1500,
+ "withdrawalnominalcapacity": 1800,
+ "reservoircapacity": 20000,
+ "efficiency": 0.78,
+ "initiallevel": 10000,
+ },
+ "pmax_injection": pmax_injection.tolist(),
+ "pmax_withdrawal": pmax_withdrawal.tolist(),
+ "inflows": inflows.tolist(),
+ }
+ res = client.post(
+ f"/v1/studies/{study_id}/commands",
+ headers={"Authorization": f"Bearer {user_access_token}"},
+ json=[{"action": "create_st_storage", "args": args}],
+ )
+ res.raise_for_status()
+
+ # ============================
+ # Short-Term Storage Removal
+ # ============================
+
+ # The `remove_st_storage` command allows you to delete a Short-Term Storage.
+ args = {"area_id": area_id, "storage_id": siemens_battery_id}
+ res = client.post(
+ f"/v1/studies/{study_id}/commands",
+ headers={"Authorization": f"Bearer {user_access_token}"},
+ json=[{"action": "remove_st_storage", "args": args}],
+ )
+ res.raise_for_status()
+
+ # =======================================
+ # Parameters and Time Series Validation
+ # =======================================
+
+ # When creating a Short-Term Storage, both the validity of the parameters
+ # (value type and valid range) and the validity of the time series
+ # (value range) are checked.
+ # In the example below, multiple parameters are invalid, and one matrix contains
+ # values outside the valid range. Upon executing the request, an HTTP 422
+ # error occurs, and a response specifies the invalid values.
+ pmax_injection = np.random.rand(8760, 1)
+ pmax_withdrawal = np.random.rand(8760, 1) * 10 # Oops!
+ inflows = np.random.randint(0, 1001, size=(8760, 1))
+ args = {
+ "area_id": area_id,
+ "parameters": {
+ "name": "Bad Storage",
+ "group": "Wonderland", # Oops!
+ "injection_nominal_capacity": -2000, # Oops!
+ "withdrawal_nominal_capacity": 1500,
+ "reservoir_capacity": 20000,
+ "efficiency": 0.78,
+ "initial_level": 10000,
+ "initial_level_optim": "BlurBool", # Oops!
+ },
+ "pmax_injection": pmax_injection.tolist(),
+ "pmax_withdrawal": pmax_withdrawal.tolist(),
+ "inflows": inflows.tolist(),
+ }
+ res = client.post(
+ f"/v1/studies/{study_id}/commands",
+ headers={"Authorization": f"Bearer {user_access_token}"},
+ json=[{"action": "create_st_storage", "args": args}],
+ )
+ assert res.status_code == http.HTTPStatus.UNPROCESSABLE_ENTITY
+ description = res.json()["description"]
+ """
+ 4 validation errors for CreateSTStorage
+ parameters -> group
+ value is not a valid enumeration member […]
+ parameters -> injectionnominalcapacity
+ ensure this value is greater than or equal to 0 (type=value_error.number.not_ge; limit_value=0)
+ parameters -> initialleveloptim
+ value could not be parsed to a boolean (type=type_error.bool)
+ pmax_withdrawal
+ Matrix values should be between 0 and 1 (type=value_error)
+ """
+ assert "parameters -> group" in description
+ assert "parameters -> injectionnominalcapacity" in description
+ assert "parameters -> initialleveloptim" in description
+ assert "pmax_withdrawal" in description
diff --git a/tests/storage/repository/filesystem/config/test_config_files.py b/tests/storage/repository/filesystem/config/test_config_files.py
index 7de2c166bf..dd67da3c86 100644
--- a/tests/storage/repository/filesystem/config/test_config_files.py
+++ b/tests/storage/repository/filesystem/config/test_config_files.py
@@ -20,7 +20,10 @@
DistrictSet,
Cluster,
BindingConstraintDTO,
- Storage,
+)
+from antarest.study.storage.rawstudy.model.filesystem.config.st_storage import (
+ STStorageConfig,
+ STStorageGroup,
)
from tests.storage.business.assets import ASSETS_DIR
@@ -283,29 +286,59 @@ def test_parse_thermal(tmp_path: Path) -> None:
]
-def test_parse_st_storage(tmp_path: Path) -> None:
- study_path = build_empty_files(tmp_path)
- study_path.joinpath("input", "st-storage", "clusters", "fr").mkdir(
- parents=True
- )
- content = """
- [t1]
- name = t1
-
- [t2]
- name = t2
+# noinspection SpellCheckingInspection
+ST_STORAGE_LIST_INI = """\
+[siemens battery]
+name = Siemens Battery
+group = Battery
+injectionnominalcapacity = 150.0
+withdrawalnominalcapacity = 150.0
+reservoircapacity = 600.0
+efficiency = 0.94
+initiallevel = 0
+initialleveloptim = True
+
+[grand maison]
+name = Grand'Maison
+group = PSP_closed
+injectionnominalcapacity = 1500.0
+withdrawalnominalcapacity = 1800.0
+reservoircapacity = 20000.0
+efficiency = 0.78
+initiallevel = 10000.0
+initialleveloptim = False
+"""
- [t3]
- name = t3
- """
- study_path.joinpath(
- "input", "st-storage", "clusters", "fr", "list.ini"
- ).write_text(content)
+def test_parse_st_storage(tmp_path: Path) -> None:
+ study_path = build_empty_files(tmp_path)
+ config_dir = study_path.joinpath("input", "st-storage", "clusters", "fr")
+ config_dir.mkdir(parents=True)
+ config_dir.joinpath("list.ini").write_text(ST_STORAGE_LIST_INI)
+ # noinspection SpellCheckingInspection
assert _parse_st_storage(study_path, "fr") == [
- Storage(id="t1", name="t1"),
- Storage(id="t2", name="t2"),
- Storage(id="t3", name="t3"),
+ STStorageConfig(
+ id="siemens battery",
+ name="Siemens Battery",
+ group=STStorageGroup.BATTERY,
+ injection_nominal_capacity=150.0,
+ withdrawal_nominal_capacity=150.0,
+ reservoir_capacity=600.0,
+ efficiency=0.94,
+ initial_level=0.0,
+ initial_level_optim=True,
+ ),
+ STStorageConfig(
+ id="grand maison",
+ name="Grand'Maison",
+ group=STStorageGroup.PSP_CLOSED,
+ injection_nominal_capacity=1500.0,
+ withdrawal_nominal_capacity=1800.0,
+ reservoir_capacity=20000.0,
+ efficiency=0.78,
+ initial_level=10000.0,
+ initial_level_optim=False,
+ ),
]
diff --git a/tests/study/storage/variantstudy/__init__.py b/tests/study/storage/variantstudy/__init__.py
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/tests/study/storage/variantstudy/business/__init__.py b/tests/study/storage/variantstudy/business/__init__.py
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/tests/study/storage/variantstudy/business/test_matrix_constants_generator.py b/tests/study/storage/variantstudy/business/test_matrix_constants_generator.py
new file mode 100644
index 0000000000..af4754c2fc
--- /dev/null
+++ b/tests/study/storage/variantstudy/business/test_matrix_constants_generator.py
@@ -0,0 +1,54 @@
+import numpy as np
+from antarest.matrixstore.service import SimpleMatrixService
+from antarest.study.storage.variantstudy.business import matrix_constants
+from antarest.study.storage.variantstudy.business.matrix_constants_generator import (
+ MATRIX_PROTOCOL_PREFIX,
+ GeneratorMatrixConstants,
+)
+
+
+class TestGeneratorMatrixConstants:
+ def test_get_st_storage(self, tmp_path):
+ generator = GeneratorMatrixConstants(
+ matrix_service=SimpleMatrixService(bucket_dir=tmp_path)
+ )
+
+ ref1 = generator.get_st_storage_pmax_injection()
+ matrix_id1 = ref1.split(MATRIX_PROTOCOL_PREFIX)[1]
+ matrix_dto1 = generator.matrix_service.get(matrix_id1)
+ assert (
+ np.array(matrix_dto1.data).all()
+ == matrix_constants.st_storage.series.pmax_injection.all()
+ )
+
+ ref2 = generator.get_st_storage_pmax_withdrawal()
+ matrix_id2 = ref2.split(MATRIX_PROTOCOL_PREFIX)[1]
+ matrix_dto2 = generator.matrix_service.get(matrix_id2)
+ assert (
+ np.array(matrix_dto2.data).all()
+ == matrix_constants.st_storage.series.pmax_withdrawal.all()
+ )
+
+ ref3 = generator.get_st_storage_lower_rule_curve()
+ matrix_id3 = ref3.split(MATRIX_PROTOCOL_PREFIX)[1]
+ matrix_dto3 = generator.matrix_service.get(matrix_id3)
+ assert (
+ np.array(matrix_dto3.data).all()
+ == matrix_constants.st_storage.series.lower_rule_curve.all()
+ )
+
+ ref4 = generator.get_st_storage_upper_rule_curve()
+ matrix_id4 = ref4.split(MATRIX_PROTOCOL_PREFIX)[1]
+ matrix_dto4 = generator.matrix_service.get(matrix_id4)
+ assert (
+ np.array(matrix_dto4.data).all()
+ == matrix_constants.st_storage.series.upper_rule_curve.all()
+ )
+
+ ref5 = generator.get_st_storage_inflows()
+ matrix_id5 = ref5.split(MATRIX_PROTOCOL_PREFIX)[1]
+ matrix_dto5 = generator.matrix_service.get(matrix_id5)
+ assert (
+ np.array(matrix_dto5.data).all()
+ == matrix_constants.st_storage.series.inflows.all()
+ )
diff --git a/tests/variantstudy/model/command/test_create_st_storage.py b/tests/variantstudy/model/command/test_create_st_storage.py
new file mode 100644
index 0000000000..8386a39062
--- /dev/null
+++ b/tests/variantstudy/model/command/test_create_st_storage.py
@@ -0,0 +1,534 @@
+import re
+
+import numpy as np
+import pytest
+from pydantic import ValidationError
+
+from antarest.study.storage.rawstudy.model.filesystem.config.model import (
+ transform_name_to_id,
+)
+from antarest.study.storage.rawstudy.model.filesystem.factory import FileStudy
+from antarest.study.storage.study_upgrader import upgrade_study
+from antarest.study.storage.variantstudy.business.utils import (
+ strip_matrix_protocol,
+)
+from antarest.study.storage.variantstudy.model.command.common import (
+ CommandName,
+)
+from antarest.study.storage.variantstudy.model.command.create_area import (
+ CreateArea,
+)
+from antarest.study.storage.variantstudy.model.command.create_st_storage import (
+ REQUIRED_VERSION,
+ CreateSTStorage,
+ STStorageConfig,
+)
+from antarest.study.storage.variantstudy.model.command.replace_matrix import (
+ ReplaceMatrix,
+)
+from antarest.study.storage.variantstudy.model.command.update_config import (
+ UpdateConfig,
+)
+from antarest.study.storage.variantstudy.model.command_context import (
+ CommandContext,
+)
+from antarest.study.storage.variantstudy.model.model import CommandDTO
+
+
+@pytest.fixture(name="recent_study")
+def recent_study_fixture(empty_study: FileStudy) -> FileStudy:
+ """
+ Fixture for creating a recent version of the FileStudy object.
+
+ Args:
+ empty_study: The empty FileStudy object used as model.
+
+ Returns:
+ FileStudy: The FileStudy object upgraded to the required version.
+ """
+ upgrade_study(empty_study.config.study_path, str(REQUIRED_VERSION))
+ empty_study.config.version = REQUIRED_VERSION
+ return empty_study
+
+
+# The parameter names to be used are those in the INI file.
+# Non-string values are automatically converted into strings.
+# noinspection SpellCheckingInspection
+PARAMETERS = {
+ "name": "Storage1",
+ "group": "Battery",
+ "injectionnominalcapacity": 1500,
+ "withdrawalnominalcapacity": 1500,
+ "reservoircapacity": 20000,
+ "efficiency": 0.94,
+ "initialleveloptim": True,
+}
+
+# noinspection SpellCheckingInspection
+OTHER_PARAMETERS = {
+ "name": "Storage1",
+ "group": "Battery",
+ "injectionnominalcapacity": 1200,
+ "withdrawalnominalcapacity": 1300,
+ "reservoircapacity": 20500,
+ "efficiency": 0.92,
+ "initiallevel": 0,
+ "initialleveloptim": True,
+}
+
+
+class TestCreateSTStorage:
+ # noinspection SpellCheckingInspection
+ def test_init(self, command_context: CommandContext):
+ pmax_injection = np.random.rand(8760, 1)
+ inflows = np.random.uniform(0, 1000, size=(8760, 1))
+ cmd = CreateSTStorage(
+ command_context=command_context,
+ area_id="area_fr",
+ parameters=STStorageConfig(**PARAMETERS),
+ pmax_injection=pmax_injection.tolist(), # type: ignore
+ inflows=inflows.tolist(), # type: ignore
+ )
+
+ # Check the attribues
+ assert cmd.command_name == CommandName.CREATE_ST_STORAGE
+ assert cmd.version == 1
+ assert cmd.command_context == command_context
+ assert cmd.area_id == "area_fr"
+ expected_parameters = {k: str(v) for k, v in PARAMETERS.items()}
+ assert cmd.parameters == STStorageConfig(**expected_parameters)
+
+ # check the matrices links
+ # fmt: off
+ constants = command_context.generator_matrix_constants
+ assert cmd.pmax_injection != constants.get_st_storage_pmax_injection()
+ assert cmd.pmax_withdrawal == constants.get_st_storage_pmax_withdrawal()
+ assert cmd.lower_rule_curve == constants.get_st_storage_lower_rule_curve()
+ assert cmd.upper_rule_curve == constants.get_st_storage_upper_rule_curve()
+ assert cmd.inflows != constants.get_st_storage_inflows()
+ # fmt: on
+
+ def test_init__invalid_storage_name(
+ self, recent_study: FileStudy, command_context: CommandContext
+ ):
+ # When we apply the config for a new ST Storage with a bad name
+ with pytest.raises(ValidationError) as ctx:
+ parameters = {**PARAMETERS, "name": "?%$$"} # bad name
+ CreateSTStorage(
+ command_context=command_context,
+ area_id="dummy",
+ parameters=STStorageConfig(**parameters),
+ )
+ # We get 2 errors because the `storage_name` is duplicated in the `parameters`:
+ assert ctx.value.errors() == [
+ {
+ "loc": ("__root__",),
+ "msg": "Invalid short term storage name '?%$$'.",
+ "type": "value_error",
+ }
+ ]
+
+ # noinspection SpellCheckingInspection
+ def test_init__invalid_matrix_values(
+ self, command_context: CommandContext
+ ):
+ array = np.random.rand(8760, 1) # OK
+ array[10] = 25 # BAD
+ with pytest.raises(ValidationError) as ctx:
+ CreateSTStorage(
+ command_context=command_context,
+ area_id="area_fr",
+ parameters=STStorageConfig(**PARAMETERS),
+ pmax_injection=array.tolist(), # type: ignore
+ )
+ assert ctx.value.errors() == [
+ {
+ "loc": ("pmax_injection",),
+ "msg": "Matrix values should be between 0 and 1",
+ "type": "value_error",
+ }
+ ]
+
+ # noinspection SpellCheckingInspection
+ def test_init__invalid_matrix_shape(self, command_context: CommandContext):
+ array = np.random.rand(24, 1) # BAD SHAPE
+ with pytest.raises(ValidationError) as ctx:
+ CreateSTStorage(
+ command_context=command_context,
+ area_id="area_fr",
+ parameters=STStorageConfig(**PARAMETERS),
+ pmax_injection=array.tolist(), # type: ignore
+ )
+ assert ctx.value.errors() == [
+ {
+ "loc": ("pmax_injection",),
+ "msg": "Invalid matrix shape (24, 1), expected (8760, 1)",
+ "type": "value_error",
+ }
+ ]
+
+ # noinspection SpellCheckingInspection
+
+ def test_init__invalid_nan_value(self, command_context: CommandContext):
+ array = np.random.rand(8760, 1) # OK
+ array[20] = np.nan # BAD
+ with pytest.raises(ValidationError) as ctx:
+ CreateSTStorage(
+ command_context=command_context,
+ area_id="area_fr",
+ parameters=STStorageConfig(**PARAMETERS),
+ pmax_injection=array.tolist(), # type: ignore
+ )
+ assert ctx.value.errors() == [
+ {
+ "loc": ("pmax_injection",),
+ "msg": "Matrix values cannot contain NaN",
+ "type": "value_error",
+ }
+ ]
+
+ # noinspection SpellCheckingInspection
+
+ def test_init__invalid_matrix_type(self, command_context: CommandContext):
+ array = {"data": [1, 2, 3]}
+ with pytest.raises(ValidationError) as ctx:
+ CreateSTStorage(
+ command_context=command_context,
+ area_id="area_fr",
+ parameters=STStorageConfig(**PARAMETERS),
+ pmax_injection=array, # type: ignore
+ )
+ assert ctx.value.errors() == [
+ {
+ "loc": ("pmax_injection",),
+ "msg": "value is not a valid list",
+ "type": "type_error.list",
+ },
+ {
+ "loc": ("pmax_injection",),
+ "msg": "str type expected",
+ "type": "type_error.str",
+ },
+ ]
+
+ def test_apply_config__invalid_version(
+ self, empty_study: FileStudy, command_context: CommandContext
+ ):
+ # Given an old study in version 720
+ # When we apply the config to add a new ST Storage
+ create_st_storage = CreateSTStorage(
+ command_context=command_context,
+ area_id="foo",
+ parameters=STStorageConfig(**PARAMETERS),
+ )
+ command_output = create_st_storage.apply_config(empty_study.config)
+
+ # Then, the output should be an error
+ assert command_output.status is False
+ assert re.search(
+ rf"Invalid.*version {empty_study.config.version}",
+ command_output.message,
+ flags=re.IGNORECASE,
+ )
+
+ def test_apply_config__missing_area(
+ self, recent_study: FileStudy, command_context: CommandContext
+ ):
+ # Given a study without "unknown area" area
+ # When we apply the config to add a new ST Storage
+ create_st_storage = CreateSTStorage(
+ command_context=command_context,
+ area_id="unknown area", # bad ID
+ parameters=STStorageConfig(**PARAMETERS),
+ )
+ command_output = create_st_storage.apply_config(recent_study.config)
+
+ # Then, the output should be an error
+ assert command_output.status is False
+ assert re.search(
+ rf"'{re.escape(create_st_storage.area_id)}'.*does not exist",
+ command_output.message,
+ flags=re.IGNORECASE,
+ )
+
+ def test_apply_config__duplicate_storage(
+ self, recent_study: FileStudy, command_context: CommandContext
+ ):
+ # First, prepare a new Area
+ create_area = CreateArea(
+ area_name="Area FR",
+ command_context=command_context,
+ )
+ create_area.apply(recent_study)
+
+ # Then, apply the config for a new ST Storage
+ create_st_storage = CreateSTStorage(
+ command_context=command_context,
+ area_id=transform_name_to_id(create_area.area_name),
+ parameters=STStorageConfig(**PARAMETERS),
+ )
+ command_output = create_st_storage.apply_config(recent_study.config)
+ assert command_output.status is True
+
+ # Then, apply the config a second time
+ parameters = {**PARAMETERS, "name": "STORAGE1"} # different case
+ create_st_storage = CreateSTStorage(
+ command_context=command_context,
+ area_id=transform_name_to_id(create_area.area_name),
+ parameters=STStorageConfig(**parameters),
+ )
+ command_output = create_st_storage.apply_config(recent_study.config)
+
+ # Then, the output should be an error
+ assert command_output.status is False
+ assert re.search(
+ rf"'{re.escape(create_st_storage.storage_name)}'.*already exists",
+ command_output.message,
+ flags=re.IGNORECASE,
+ )
+
+ def test_apply_config__nominal_case(
+ self, recent_study: FileStudy, command_context: CommandContext
+ ):
+ # First, prepare a new Area
+ create_area = CreateArea(
+ area_name="Area FR",
+ command_context=command_context,
+ )
+ create_area.apply(recent_study)
+
+ # Then, apply the config for a new ST Storage
+ create_st_storage = CreateSTStorage(
+ command_context=command_context,
+ area_id=transform_name_to_id(create_area.area_name),
+ parameters=STStorageConfig(**PARAMETERS),
+ )
+ command_output = create_st_storage.apply_config(recent_study.config)
+
+ # Check the command output and extra dict
+ assert command_output.status is True
+ assert re.search(
+ rf"'{re.escape(create_st_storage.storage_name)}'.*added",
+ command_output.message,
+ flags=re.IGNORECASE,
+ )
+
+ # noinspection SpellCheckingInspection
+ def test_apply__nominal_case(
+ self, recent_study: FileStudy, command_context: CommandContext
+ ):
+ # First, prepare a new Area
+ create_area = CreateArea(
+ area_name="Area FR",
+ command_context=command_context,
+ )
+ create_area.apply(recent_study)
+
+ # Then, apply the command to create a new ST Storage
+ pmax_injection = np.random.rand(8760, 1)
+ inflows = np.random.uniform(0, 1000, size=(8760, 1))
+ cmd = CreateSTStorage(
+ command_context=command_context,
+ area_id=transform_name_to_id(create_area.area_name),
+ parameters=STStorageConfig(**PARAMETERS),
+ pmax_injection=pmax_injection.tolist(), # type: ignore
+ inflows=inflows.tolist(), # type: ignore
+ )
+ command_output = cmd.apply(recent_study)
+ assert command_output.status
+
+ # check the config
+ config = recent_study.tree.get(
+ ["input", "st-storage", "clusters", cmd.area_id, "list"]
+ )
+ expected = {
+ "storage1": {
+ "efficiency": 0.94,
+ "group": "Battery",
+ "initiallevel": 0,
+ "initialleveloptim": True,
+ "injectionnominalcapacity": 1500,
+ "name": "Storage1",
+ "reservoircapacity": 20000,
+ "withdrawalnominalcapacity": 1500,
+ }
+ }
+ assert config == expected
+
+ # check the matrices references
+ config = recent_study.tree.get(
+ ["input", "st-storage", "series", cmd.area_id]
+ )
+ constants = command_context.generator_matrix_constants
+ service = command_context.matrix_service
+ pmax_injection_id = service.create(pmax_injection)
+ inflows_id = service.create(inflows)
+ expected = {
+ "storage1": {
+ "pmax_injection": f"matrix://{pmax_injection_id}",
+ "pmax_withdrawal": constants.get_st_storage_pmax_withdrawal(),
+ "lower_rule_curve": constants.get_st_storage_lower_rule_curve(),
+ "upper_rule_curve": constants.get_st_storage_upper_rule_curve(),
+ "inflows": f"matrix://{inflows_id}",
+ }
+ }
+ assert config == expected
+
+ def test_apply__invalid_apply_config(
+ self, empty_study: FileStudy, command_context: CommandContext
+ ):
+ # First, prepare a new Area
+ create_area = CreateArea(
+ area_name="Area FR", command_context=command_context
+ )
+ create_area.apply(empty_study)
+
+ # Then, apply the command to create a new ST Storage
+ cmd = CreateSTStorage(
+ command_context=command_context,
+ area_id=transform_name_to_id(create_area.area_name),
+ parameters=STStorageConfig(**PARAMETERS),
+ )
+ command_output = cmd.apply(empty_study)
+ assert not command_output.status # invalid study (too old)
+
+ # noinspection SpellCheckingInspection
+ def test_to_dto(self, command_context: CommandContext):
+ cmd = CreateSTStorage(
+ command_context=command_context,
+ area_id="area_fr",
+ parameters=STStorageConfig(**PARAMETERS),
+ )
+
+ actual = cmd.to_dto()
+
+ expected_parameters = PARAMETERS.copy()
+ # `initiallevel` = 0 because `initialleveloptim` is True
+ expected_parameters["initiallevel"] = 0
+ constants = command_context.generator_matrix_constants
+
+ assert actual == CommandDTO(
+ action=CommandName.CREATE_ST_STORAGE.value,
+ args={
+ "area_id": "area_fr",
+ "parameters": expected_parameters,
+ "pmax_injection": strip_matrix_protocol(
+ constants.get_st_storage_pmax_withdrawal()
+ ),
+ "pmax_withdrawal": strip_matrix_protocol(
+ constants.get_st_storage_pmax_withdrawal()
+ ),
+ "lower_rule_curve": strip_matrix_protocol(
+ constants.get_st_storage_lower_rule_curve()
+ ),
+ "upper_rule_curve": strip_matrix_protocol(
+ constants.get_st_storage_upper_rule_curve()
+ ),
+ "inflows": strip_matrix_protocol(
+ constants.get_st_storage_inflows()
+ ),
+ },
+ )
+
+ def test_match_signature(self, command_context: CommandContext):
+ cmd = CreateSTStorage(
+ command_context=command_context,
+ area_id="area_fr",
+ parameters=STStorageConfig(**PARAMETERS),
+ )
+ assert cmd.match_signature() == "create_st_storage%area_fr%storage1"
+
+ @pytest.mark.parametrize("area_id", ["area_fr", "area_en"])
+ @pytest.mark.parametrize("parameters", [PARAMETERS, OTHER_PARAMETERS])
+ def test_match(
+ self,
+ command_context: CommandContext,
+ area_id,
+ parameters,
+ ):
+ cmd1 = CreateSTStorage(
+ command_context=command_context,
+ area_id="area_fr",
+ parameters=STStorageConfig(**PARAMETERS),
+ )
+ cmd2 = CreateSTStorage(
+ command_context=command_context,
+ area_id=area_id,
+ parameters=STStorageConfig(**parameters),
+ )
+ light_equal = (
+ area_id == cmd1.area_id and parameters["name"] == cmd1.storage_name
+ )
+ assert cmd1.match(cmd2, equal=False) == light_equal
+ deep_equal = area_id == cmd1.area_id and parameters == PARAMETERS
+ assert cmd1.match(cmd2, equal=True) == deep_equal
+
+ def test_match__unknown_type(self, command_context: CommandContext):
+ cmd1 = CreateSTStorage(
+ command_context=command_context,
+ area_id="area_fr",
+ parameters=STStorageConfig(**PARAMETERS),
+ )
+ # Always `False` when compared to another object type
+ assert cmd1.match(..., equal=False) is False
+ assert cmd1.match(..., equal=True) is False
+
+ def test_create_diff__not_equals(self, command_context: CommandContext):
+ cmd = CreateSTStorage(
+ command_context=command_context,
+ area_id="area_fr",
+ parameters=STStorageConfig(**PARAMETERS),
+ )
+ upper_rule_curve = np.random.rand(8760, 1)
+ inflows = np.random.uniform(0, 1000, size=(8760, 1))
+ other = CreateSTStorage(
+ command_context=command_context,
+ area_id=cmd.area_id,
+ parameters=STStorageConfig(**OTHER_PARAMETERS),
+ upper_rule_curve=upper_rule_curve.tolist(), # type: ignore
+ inflows=inflows.tolist(), # type: ignore
+ )
+ actual = cmd.create_diff(other)
+ expected = [
+ ReplaceMatrix(
+ command_context=command_context,
+ target="input/st-storage/series/area_fr/storage1/upper_rule_curve",
+ matrix=strip_matrix_protocol(other.upper_rule_curve),
+ ),
+ ReplaceMatrix(
+ command_context=command_context,
+ target="input/st-storage/series/area_fr/storage1/inflows",
+ matrix=strip_matrix_protocol(other.inflows),
+ ),
+ UpdateConfig(
+ command_context=command_context,
+ target="input/st-storage/clusters/area_fr/list/storage1",
+ data=OTHER_PARAMETERS,
+ ),
+ ]
+ assert actual == expected
+
+ def test_create_diff__equals(self, command_context: CommandContext):
+ cmd = CreateSTStorage(
+ command_context=command_context,
+ area_id="area_fr",
+ parameters=STStorageConfig(**PARAMETERS),
+ )
+ actual = cmd.create_diff(cmd)
+ assert not actual
+
+ def test_get_inner_matrices(self, command_context: CommandContext):
+ cmd = CreateSTStorage(
+ command_context=command_context,
+ area_id="area_fr",
+ parameters=STStorageConfig(**PARAMETERS),
+ )
+ actual = cmd.get_inner_matrices()
+ constants = command_context.generator_matrix_constants
+ assert actual == [
+ strip_matrix_protocol(constants.get_st_storage_pmax_injection()),
+ strip_matrix_protocol(constants.get_st_storage_pmax_withdrawal()),
+ strip_matrix_protocol(constants.get_st_storage_lower_rule_curve()),
+ strip_matrix_protocol(constants.get_st_storage_upper_rule_curve()),
+ strip_matrix_protocol(constants.get_st_storage_inflows()),
+ ]
diff --git a/tests/variantstudy/model/command/test_remove_st_storage.py b/tests/variantstudy/model/command/test_remove_st_storage.py
new file mode 100644
index 0000000000..8660a3c968
--- /dev/null
+++ b/tests/variantstudy/model/command/test_remove_st_storage.py
@@ -0,0 +1,259 @@
+import re
+
+import pytest
+from antarest.study.storage.rawstudy.model.filesystem.config.model import (
+ transform_name_to_id,
+)
+from antarest.study.storage.rawstudy.model.filesystem.factory import FileStudy
+from antarest.study.storage.study_upgrader import upgrade_study
+from antarest.study.storage.variantstudy.model.command.common import (
+ CommandName,
+)
+from antarest.study.storage.variantstudy.model.command.create_area import (
+ CreateArea,
+)
+from antarest.study.storage.variantstudy.model.command.create_st_storage import (
+ CreateSTStorage,
+)
+from antarest.study.storage.variantstudy.model.command.remove_st_storage import (
+ REQUIRED_VERSION,
+ RemoveSTStorage,
+)
+from antarest.study.storage.variantstudy.model.command_context import (
+ CommandContext,
+)
+from antarest.study.storage.variantstudy.model.model import CommandDTO
+from pydantic import ValidationError
+
+
+@pytest.fixture(name="recent_study")
+def recent_study_fixture(empty_study: FileStudy) -> FileStudy:
+ """
+ Fixture for creating a recent version of the FileStudy object.
+
+ Args:
+ empty_study: The empty FileStudy object used as model.
+
+ Returns:
+ FileStudy: The FileStudy object upgraded to the required version.
+ """
+ upgrade_study(empty_study.config.study_path, str(REQUIRED_VERSION))
+ empty_study.config.version = REQUIRED_VERSION
+ return empty_study
+
+
+# The parameter names to be used are those in the INI file.
+# Non-string values are automatically converted into strings.
+# noinspection SpellCheckingInspection
+PARAMETERS = {
+ "name": "Storage1",
+ "group": "Battery",
+ "injectionnominalcapacity": 1500,
+ "withdrawalnominalcapacity": 1500,
+ "reservoircapacity": 20000,
+ "efficiency": 0.94,
+ "initialleveloptim": True,
+}
+
+
+class TestRemoveSTStorage:
+ # noinspection SpellCheckingInspection
+ def test_init(self, command_context: CommandContext):
+ cmd = RemoveSTStorage(
+ command_context=command_context,
+ area_id="area_fr",
+ storage_id="storage_1",
+ )
+
+ # Check the attribues
+ assert cmd.command_name == CommandName.REMOVE_ST_STORAGE
+ assert cmd.version == 1
+ assert cmd.command_context == command_context
+ assert cmd.area_id == "area_fr"
+ assert cmd.storage_id == "storage_1"
+
+ def test_init__invalid_storage_id(
+ self, recent_study: FileStudy, command_context: CommandContext
+ ):
+ # When we apply the config for a new ST Storage with a bad name
+ with pytest.raises(ValidationError) as ctx:
+ RemoveSTStorage(
+ command_context=command_context,
+ area_id="dummy",
+ storage_id="?%$$", # bad name
+ )
+ assert ctx.value.errors() == [
+ {
+ "ctx": {"pattern": "[a-z0-9_(),& -]+"},
+ "loc": ("storage_id",),
+ "msg": 'string does not match regex "[a-z0-9_(),& -]+"',
+ "type": "value_error.str.regex",
+ }
+ ]
+
+ def test_apply_config__invalid_version(
+ self, empty_study: FileStudy, command_context: CommandContext
+ ):
+ # Given an old study in version 720
+ # When we apply the config to add a new ST Storage
+ remove_st_storage = RemoveSTStorage(
+ command_context=command_context,
+ area_id="foo",
+ storage_id="bar",
+ )
+ command_output = remove_st_storage.apply_config(empty_study.config)
+
+ # Then, the output should be an error
+ assert command_output.status is False
+ assert re.search(
+ rf"Invalid.*version {empty_study.config.version}",
+ command_output.message,
+ flags=re.IGNORECASE,
+ )
+
+ def test_apply_config__missing_area(
+ self, recent_study: FileStudy, command_context: CommandContext
+ ):
+ # Given a study without "unknown area" area
+ # When we apply the config to add a new ST Storage
+ remove_st_storage = RemoveSTStorage(
+ command_context=command_context,
+ area_id="unknown area", # bad ID
+ storage_id="storage_1",
+ )
+ command_output = remove_st_storage.apply_config(recent_study.config)
+
+ # Then, the output should be an error
+ assert command_output.status is False
+ assert re.search(
+ rf"'{re.escape(remove_st_storage.area_id)}'.*does not exist",
+ command_output.message,
+ flags=re.IGNORECASE,
+ )
+
+ def test_apply_config__missing_storage(
+ self, recent_study: FileStudy, command_context: CommandContext
+ ):
+ # First, prepare a new Area
+ create_area = CreateArea(
+ command_context=command_context,
+ area_name="Area FR",
+ )
+ create_area.apply(recent_study)
+
+ # Then, apply the config for a new ST Storage
+ remove_st_storage = RemoveSTStorage(
+ command_context=command_context,
+ area_id=transform_name_to_id(create_area.area_name),
+ storage_id="storage 1",
+ )
+ command_output = remove_st_storage.apply_config(recent_study.config)
+
+ # Then, the output should be an error
+ assert command_output.status is False
+ assert re.search(
+ rf"'{re.escape(remove_st_storage.storage_id)}'.*does not exist",
+ command_output.message,
+ flags=re.IGNORECASE,
+ )
+
+ def test_apply_config__nominal_case(
+ self, recent_study: FileStudy, command_context: CommandContext
+ ):
+ # First, prepare a new Area
+ create_area = CreateArea(
+ area_name="Area FR",
+ command_context=command_context,
+ )
+ create_area.apply(recent_study)
+
+ # Then, prepare a new Storage
+ create_st_storage = CreateSTStorage(
+ command_context=command_context,
+ area_id=transform_name_to_id(create_area.area_name),
+ parameters=PARAMETERS, # type: ignore
+ )
+ create_st_storage.apply(recent_study)
+
+ # Then, apply the config for a new ST Storage
+ remove_st_storage = RemoveSTStorage(
+ command_context=command_context,
+ area_id=transform_name_to_id(create_area.area_name),
+ storage_id=create_st_storage.storage_id,
+ )
+ command_output = remove_st_storage.apply_config(recent_study.config)
+
+ # Check the command output and extra dict
+ assert command_output.status is True
+ assert re.search(
+ rf"'{re.escape(remove_st_storage.storage_id)}'.*removed",
+ command_output.message,
+ flags=re.IGNORECASE,
+ )
+
+ def test_to_dto(self, command_context: CommandContext):
+ cmd = RemoveSTStorage(
+ command_context=command_context,
+ area_id="area_fr",
+ storage_id="storage_1",
+ )
+ actual = cmd.to_dto()
+
+ # noinspection SpellCheckingInspection
+ assert actual == CommandDTO(
+ action=CommandName.REMOVE_ST_STORAGE.value,
+ args={"area_id": "area_fr", "storage_id": "storage_1"},
+ )
+
+ def test_match_signature(self, command_context: CommandContext):
+ cmd = RemoveSTStorage(
+ command_context=command_context,
+ area_id="area_fr",
+ storage_id="storage_1",
+ )
+ assert cmd.match_signature() == "remove_st_storage%area_fr%storage_1"
+
+ @pytest.mark.parametrize("area_id", ["area_fr", "area_en"])
+ @pytest.mark.parametrize("storage_id", ["storage_1", "storage_2"])
+ def test_match(
+ self,
+ command_context: CommandContext,
+ area_id,
+ storage_id,
+ ):
+ cmd1 = RemoveSTStorage(
+ command_context=command_context,
+ area_id="area_fr",
+ storage_id="storage_1",
+ )
+ cmd2 = RemoveSTStorage(
+ command_context=command_context,
+ area_id=area_id,
+ storage_id=storage_id,
+ )
+ is_equal = area_id == cmd1.area_id and storage_id == cmd1.storage_id
+ assert cmd1.match(cmd2, equal=False) == is_equal
+ assert cmd1.match(cmd2, equal=True) == is_equal
+
+ def test_create_diff(self, command_context: CommandContext):
+ cmd = RemoveSTStorage(
+ command_context=command_context,
+ area_id="area_fr",
+ storage_id="storage_1",
+ )
+ other = RemoveSTStorage(
+ command_context=command_context,
+ area_id=cmd.area_id,
+ storage_id=cmd.storage_id,
+ )
+ actual = cmd.create_diff(other)
+ assert not actual
+
+ def test_get_inner_matrices(self, command_context: CommandContext):
+ cmd = RemoveSTStorage(
+ command_context=command_context,
+ area_id="area_fr",
+ storage_id="storage_1",
+ )
+ actual = cmd.get_inner_matrices()
+ assert actual == []
diff --git a/tests/variantstudy/test_command_factory.py b/tests/variantstudy/test_command_factory.py
index 0df1a4aa12..c18621c84d 100644
--- a/tests/variantstudy/test_command_factory.py
+++ b/tests/variantstudy/test_command_factory.py
@@ -1,4 +1,5 @@
import importlib
+import itertools
import pkgutil
from unittest.mock import Mock
@@ -8,7 +9,6 @@
from antarest.study.storage.variantstudy.business.matrix_constants_generator import (
GeneratorMatrixConstants,
)
-from antarest.study.storage.variantstudy.business.utils import remove_none_args
from antarest.study.storage.variantstudy.command_factory import CommandFactory
from antarest.study.storage.variantstudy.model.command.common import (
CommandName,
@@ -320,6 +320,88 @@ def setup_class(self):
}
},
),
+ CommandDTO(
+ action=CommandName.CREATE_ST_STORAGE.value,
+ args={
+ "area_id": "area 1",
+ "parameters": {
+ "name": "Storage 1",
+ "group": "Battery",
+ "injectionnominalcapacity": 0,
+ "withdrawalnominalcapacity": 0,
+ "reservoircapacity": 0,
+ "efficiency": 1,
+ "initiallevel": 0,
+ "initialleveloptim": False,
+ },
+ "pmax_injection": "matrix://59ea6c83-6348-466d-9530-c35c51ca4c37",
+ "pmax_withdrawal": "matrix://5f988548-dadc-4bbb-8ce8-87a544dbf756",
+ "lower_rule_curve": "matrix://8ce4fcea-cc97-4d2c-b641-a27a53454612",
+ "upper_rule_curve": "matrix://8ce614c8-c687-41af-8b24-df8a49cc52af",
+ "inflows": "matrix://df9b25e1-e3f7-4a57-8182-0ff9791439e5",
+ },
+ ),
+ CommandDTO(
+ action=CommandName.CREATE_ST_STORAGE.value,
+ args=[
+ {
+ "area_id": "area 1",
+ "parameters": {
+ "efficiency": 1,
+ "group": "Battery",
+ "initiallevel": 0,
+ "initialleveloptim": False,
+ "injectionnominalcapacity": 0,
+ "name": "Storage 1",
+ "reservoircapacity": 0,
+ "withdrawalnominalcapacity": 0,
+ },
+ "pmax_injection": "matrix://59ea6c83-6348-466d-9530-c35c51ca4c37",
+ "pmax_withdrawal": "matrix://5f988548-dadc-4bbb-8ce8-87a544dbf756",
+ "lower_rule_curve": "matrix://8ce4fcea-cc97-4d2c-b641-a27a53454612",
+ "upper_rule_curve": "matrix://8ce614c8-c687-41af-8b24-df8a49cc52af",
+ "inflows": "matrix://df9b25e1-e3f7-4a57-8182-0ff9791439e5",
+ },
+ {
+ "area_id": "area 1",
+ "parameters": {
+ "efficiency": 0.94,
+ "group": "Battery",
+ "initiallevel": 0,
+ "initialleveloptim": False,
+ "injectionnominalcapacity": 0,
+ "name": "Storage 2",
+ "reservoircapacity": 0,
+ "withdrawalnominalcapacity": 0,
+ },
+ "pmax_injection": "matrix://3f5b3746-3995-49b7-a6da-622633472e05",
+ "pmax_withdrawal": "matrix://4b64a31f-927b-4887-b4cd-adcddd39bdcd",
+ "lower_rule_curve": "matrix://16c7c3ae-9824-4ef2-aa68-51145884b025",
+ "upper_rule_curve": "matrix://9a6104e9-990a-415f-a6e2-57507e13b58c",
+ "inflows": "matrix://e8923768-9bdd-40c2-a6ea-2da2523be727",
+ },
+ ],
+ ),
+ CommandDTO(
+ action=CommandName.REMOVE_ST_STORAGE.value,
+ args={
+ "area_id": "area 1",
+ "storage_id": "storage 1",
+ },
+ ),
+ CommandDTO(
+ action=CommandName.REMOVE_ST_STORAGE.value,
+ args=[
+ {
+ "area_id": "area 1",
+ "storage_id": "storage 1",
+ },
+ {
+ "area_id": "area 1",
+ "storage_id": "storage 2",
+ },
+ ],
+ ),
],
)
@pytest.mark.unit_test
@@ -329,17 +411,28 @@ def test_command_factory(self, command_dto: CommandDTO):
matrix_service=Mock(spec=MatrixService),
patch_service=Mock(spec=PatchService),
)
- command_list = command_factory.to_command(command_dto=command_dto)
+ commands = command_factory.to_command(command_dto=command_dto)
+
+ # fmt: off
if isinstance(args := command_dto.args, dict):
- assert len(command_list) == 1
- assert remove_none_args(command_list[0].to_dto()) == command_dto
+ exp_action_args_list = [(command_dto.action, command_dto.args)]
else:
- assert len(command_list) == len(args)
+ exp_action_args_list = [(command_dto.action, args) for args in command_dto.args]
+ # fmt: on
- for command in command_list:
- assert command.command_name.value == command_dto.action
+ # fmt: off
+ actual_cmd: ICommand
+ for actual_cmd, exp_action_args in itertools.zip_longest(commands, exp_action_args_list):
+ assert actual_cmd is not None, f"Missing action/args for {exp_action_args=}"
+ assert exp_action_args is not None, f"Missing command for {actual_cmd=}"
+ expected_action, expected_args = exp_action_args
+ actual_dto = actual_cmd.to_dto()
+ actual_args = {k:v for k,v in actual_dto.args.items() if v is not None}
+ assert actual_dto.action == expected_action
+ assert actual_args == expected_args
+ # fmt: on
- self.command_class_set.discard(type(command_list[0]).__name__)
+ self.command_class_set.discard(type(commands[0]).__name__)
def teardown_class(self):
# Check that all command classes have been tested