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.

Sign up for GitHub

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

Implement safeguard against problematic meta keys #131

Merged
merged 5 commits into from
Nov 22, 2024
Merged

Implement safeguard against problematic meta keys #131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5b2945d
Implement safeguard against problematic meta keys
danielhuppmann Nov 20, 2024
6b139de
Add check for illegal meta-keys to `bulk_upsert()`
danielhuppmann Nov 22, 2024
f0a74d9
Make ruff
danielhuppmann Nov 22, 2024
e83b008
Make mypy, simplify check
danielhuppmann Nov 22, 2024
4be6149
Make ruff again
danielhuppmann Nov 22, 2024
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
8 changes: 8 additions & 0 deletions ixmp4/data/db/meta/repository.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

from ixmp4 import db
from ixmp4.core.decorators import check_types
from ixmp4.core.exceptions import InvalidRunMeta
from ixmp4.data import abstract
from ixmp4.data.auth.decorators import guard
from ixmp4.data.db.model import Model
Expand All @@ -16,6 +17,8 @@
from .. import base
from .model import RunMetaEntry

ILLEGAL_META_KEYS = {"model", "scenario", "id", "version", "is_default"}


class RemoveRunMetaEntryFrameSchema(pa.DataFrameModel):
key: Series[pa.String] = pa.Field(coerce=True)
Expand Down Expand Up @@ -60,6 +63,8 @@ def add(
default_only=False,
)

if key in ILLEGAL_META_KEYS:
raise InvalidRunMeta("Illegal meta key: " + key)
entry = RunMetaEntry(run__id=run__id, key=key, value=value)
self.session.add(entry)
return entry
Expand Down Expand Up @@ -205,6 +210,9 @@ def map_value_column(df: pd.DataFrame):
@check_types
@guard("edit")
def bulk_upsert(self, df: DataFrame[AddRunMetaEntryFrameSchema]) -> None:
if illegal_keys := (set(df.key.values) & ILLEGAL_META_KEYS):
raise InvalidRunMeta("Illegal meta key(s): " + ", ".join(illegal_keys))

self.check_df_access(df)
df["type"] = df["value"].map(type).map(RunMetaEntry.Type.from_pytype)

Expand Down
16 changes: 15 additions & 1 deletion tests/data/test_meta.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
import pytest

import ixmp4
from ixmp4.core.exceptions import SchemaError
from ixmp4.core.exceptions import InvalidRunMeta, SchemaError
from ixmp4.data.abstract.meta import RunMetaEntry

from ..utils import assert_unordered_equality
Expand All @@ -19,6 +19,8 @@
columns=["id", "key", "type", "value"],
)

TEST_ILLEGAL_META_KEYS = {"model", "scenario", "id", "version", "is_default"}


class TestDataMeta:
def test_create_get_entry(self, platform: ixmp4.Platform):
Expand All @@ -37,6 +39,18 @@ def test_create_get_entry(self, platform: ixmp4.Platform):
assert entry.value == value
assert entry.type == type

def test_illegal_key(self, platform: ixmp4.Platform):
run = platform.runs.create("Model", "Scenario")
for key in TEST_ILLEGAL_META_KEYS:
with pytest.raises(InvalidRunMeta, match="Illegal meta key: " + key):
platform.backend.meta.create(run.id, key, "foo")

df = pd.DataFrame(
{"run__id": [run.id] * 2, "key": [key, "foo"], "value": ["bar", "baz"]},
)
with pytest.raises(InvalidRunMeta, match=r"Illegal meta key\(s\): " + key):
platform.backend.meta.bulk_upsert(df)

def test_entry_unique(self, platform: ixmp4.Platform):
run = platform.runs.create("Model", "Scenario")
platform.backend.meta.create(run.id, "Key", "Value")
Expand Down
Loading