Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Powerops 1438 investigate missing resources #119

Merged
merged 2 commits into from
Aug 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@ Changes are grouped as follows
- `Fixed` for any bug fixes.
- `Security` in case of vulnerabilities.

## [0.34.1] - 2023-08-11

### Fixed
* Mapping of models names accepted by the CLI and the models names' in `resync`.


## [0.34.0] - 2023-08-03

### Added
Expand Down
2 changes: 1 addition & 1 deletion cognite/powerops/_models.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ class _ExtraTypes:
MODEL_BY_NAME: dict[str, PowerOpsModel] = {
"production": PowerOpsModel(
name="Production",
description="The production model descripbes the physical assets such as watercourses, "
description="The production model describes the physical assets such as watercourses, "
"plants, and generators located in a price area.",
graphql_file=GRAPHQL_SCHEMAS / "production.graphql",
id_=DataModelId(_SPACE, "production", "1"),
Expand Down
2 changes: 1 addition & 1 deletion cognite/powerops/_version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.34.0"
__version__ = "0.34.1"
3 changes: 3 additions & 0 deletions cognite/powerops/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,9 @@ def plan(
),
):
log.info(f"Running plan on configuration files located in {path}")
if len(models) == 1 and models[0].lower() == "all":
models = list(MODEL_BY_NAME.keys())

resync.plan(path, market, echo=log.info, model_names=models)


Expand Down
48 changes: 32 additions & 16 deletions cognite/powerops/resync/_main.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from __future__ import annotations

from datetime import datetime
from datetime import datetime, timezone
from pathlib import Path
from typing import Optional, Callable, overload, Any
from uuid import uuid4
Expand Down Expand Up @@ -31,17 +31,16 @@ def plan(
path: Path, market: str, echo: Optional[Callable[[str], None]] = None, model_names: Optional[str | list[str]] = None
) -> None:
echo = echo or print
model_names = [model_names] if isinstance(model_names, str) else model_names or AVAILABLE_MODELS
model_names = _cli_names_to_resync_names(model_names)
client = get_powerops_client()
bootstrap_resources, config, models = _load_transform(market, path, client.cdf.config.project, echo, model_names)

_remove_non_existing_relationship_time_series_targets(client.cdf, models, bootstrap_resources, echo)

# 2.b - preview diff
cdf_bootstrap_resources = bootstrap_resources.from_cdf(
# ResourceCollection currently collects all resources, not dependent on the local model
cdf_bootstrap_resources = ResourceCollection.from_cdf(
po_client=client, data_set_external_id=config.settings.data_set_external_id
)

# 2.b - preview diff
echo(ResourceCollection.prettify_differences(bootstrap_resources.difference(cdf_bootstrap_resources)))


Expand Down Expand Up @@ -79,7 +78,7 @@ def apply(
) -> Model | list[Model]:
echo = echo or print
echo_pretty = echo_pretty or echo
model_names = [model_names] if isinstance(model_names, str) else model_names or AVAILABLE_MODELS
model_names = _cli_names_to_resync_names(model_names)
client = get_powerops_client()
collection, config, models = _load_transform(market, path, client.cdf.config.project, echo, model_names)

Expand All @@ -93,11 +92,7 @@ def apply(

echo("Models About to be uploaded")
echo_pretty(summaries)
if not auto_yes:
ans = input("Continue? (y/n)")
else:
ans = "y"

ans = "y" if auto_yes else input("Continue? (y/n)")
if ans.lower() == "y":
# Step 3 - write bootstrap resources from diffs to CDF
collection.write_to_cdf(
Expand All @@ -108,9 +103,8 @@ def apply(
echo("Resync written to CDF")
else:
echo("Aborting")
if len(model_names) == 1:
return models[0]
return models

return models[0] if len(model_names) == 1 else models


def _load_transform(
Expand All @@ -130,7 +124,7 @@ def _load_transform(

def _create_bootstrap_finished_event(echo: Callable[[str], None]) -> Event:
"""Creating a POWEROPS_BOOTSTRAP_FINISHED Event in CDF to signal that bootstrap scripts have been ran"""
current_time = int(datetime.utcnow().timestamp() * 1000) # in milliseconds
current_time = int(datetime.now(timezone.utc).timestamp() * 1000) # in milliseconds
event = Event(
start_time=current_time,
end_time=current_time,
Expand All @@ -148,10 +142,15 @@ def _remove_non_existing_relationship_time_series_targets(
client: CogniteClient, models: list[Model], collection: ResourceCollection, echo: Callable[[str], None]
) -> None:
"""Validates that all relationships in the collection have targets that exist in CDF"""
to_delete = set()
for model in models:
if not isinstance(model, AssetModel):
continue
time_series = model.time_series()
# retrieve_multiple fails if no time series are provided
if not time_series:
continue

existing_time_series = client.time_series.retrieve_multiple(
external_ids=list({t.external_id for t in time_series if t.external_id}), ignore_unknown_ids=True
)
Expand All @@ -175,6 +174,23 @@ def _remove_non_existing_relationship_time_series_targets(
collection.relationships.pop(external_id, None)


# Only needed while we support both asset models and data models
def _cli_names_to_resync_names(model_names: Optional[str | list[str]]) -> list[str]:
"""Map model names as accepted by cli to available models in resync"""
if not model_names:
return AVAILABLE_MODELS
cli_names = {model_names} if isinstance(model_names, str) else set(model_names)

res: list[str] = []
for m in AVAILABLE_MODELS:
res.extend(m for c in cli_names if c.casefold() in m.casefold())

# If any of the market models are present, add the MarketAsset
if {"dayahead", "rkom", "benchmark"}.intersection(cli_names):
res.append("MarketAsset")
return res


if __name__ == "__main__":
demo_data = Path(__file__).parent.parent.parent.parent / "tests" / "test_unit" / "test_bootstrap" / "data" / "demo"

Expand Down
5 changes: 5 additions & 0 deletions cognite/powerops/resync/config/resource_collection.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ class Config:
arbitrary_types_allowed = True
extra = Extra.forbid

def __len__(self):
return len(self.all_cdf_resources)

@property
def all_cdf_resources(self) -> list[Asset | Relationship | LabelDefinition | Event | CDFSequence]:
"""Not including DM."""
Expand Down Expand Up @@ -245,6 +248,8 @@ def from_cdf(
file_meta = po_client.cdf.files.list(data_set_ids=[data_set_id], limit=None) # type: ignore[arg-type]
shop_files = []
for f in file_meta:
if not f.metadata:
f.metadata = {} # Prevent NoneType error
if f.metadata.get("md5_hash") is None:
file_content = po_client.cdf.files.download_bytes(external_id=f.external_id)
md5_hash = hashlib.md5(file_content.replace(b"\r\n", b"\n")).hexdigest()
Expand Down
8 changes: 2 additions & 6 deletions cognite/powerops/resync/models/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,7 @@ class AssetType(ResourceType, ABC):

@property
def external_id(self) -> str:
if self._external_id:
return self._external_id
return f"{self.type_}_{self.name}"
return self._external_id or f"{self.type_}_{self.name}"

@external_id.setter
def external_id(self, value: str) -> None:
Expand All @@ -87,9 +85,7 @@ def external_id(self, value: str) -> None:

@property
def type_(self) -> str:
if self._type:
return self._type
return self.parent_external_id.removesuffix("s")
return self._type or self.parent_external_id.removesuffix("s")

@type_.setter
def type_(self, value: str) -> None:
Expand Down
5 changes: 5 additions & 0 deletions cognite/powerops/resync/models/cogshop.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,8 @@ class CogShopAsset(CogShopCore, AssetModel):
root_asset: ClassVar[Optional[Asset]] = None
base_mappings: list[CDFSequence] = Field(default_factory=list)
output_definitions: list[CDFSequence] = Field(default_factory=list)

@classmethod
def from_cdf(cls, client) -> "CogShopAsset":
# TODO: undetermined how to handle
raise NotImplementedError()
9 changes: 7 additions & 2 deletions cognite/powerops/resync/models/market/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
from typing import ClassVar, Optional

from cognite.client import CogniteClient
from cognite.client.data_classes import Asset
from pydantic.dataclasses import Field

Expand Down Expand Up @@ -40,10 +41,14 @@ def set_root_asset(
)

@classmethod
def from_cdf(cls, client) -> "MarketModel":
def from_cdf(
cls,
client: CogniteClient,
fetch_metadata: bool = True,
fetch_content: bool = False,
) -> "MarketModel":
# TODO:
# * Missing a from `from_asset` method on each AssetType
# * Handle the rewrite from `type_` to `parent_external_id` on AssetType
raise NotImplementedError()


Expand Down
1 change: 0 additions & 1 deletion cognite/powerops/resync/to_models/to_production_model.py
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,6 @@ def to_production_model(config: ProductionConfig) -> production.ProductionModel:
price_area.watercourses.append(watercourse)

model.plants.extend(plants)

return model


Expand Down
2 changes: 0 additions & 2 deletions cognite/powerops/resync/to_models/transform.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@ def transform(
if has_asset_model:
labels = AssetLabel.as_label_definitions() + RelationshipLabel.as_label_definitions()
collection.add(labels)

all_models: list[Model] = cast(list[Model], asset_models) + cast(list[Model], data_models)
for model in all_models:
collection.add(model.sequences())
Expand All @@ -82,5 +81,4 @@ def transform(
collection.add(asset_model.relationships())
for data_model in data_models:
collection.add(data_model.instances())

return collection, all_models
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "cognite-power-ops"
version = "0.34.0"
version = "0.34.1"
description = "SDK for power markets operations on Cognite Data Fusion"
readme = "README.md"
authors = ["Cognite <[email protected]>"]
Expand Down