Transfer selected blocks from global_variables to case metadata

schema/definitions/0.8.0/examples/case.yml

@@ -34,6 +34,24 @@ fmu: # the fmu-block contains information directly related to the FMU context
 
   context:
     stage: case
+
+  config:
+    globals:  # transferred from global_variables.yml
+      REGIONS:
+        WestLowland:
+          NUM: 1
+          OWC: 1660.0
+          FWL: 1660.0
+          GOC: 1000.0
+          COL: (238, 221, 130)
+          EQT: 0
+        CentralSouth:
+          NUM: 2
+          OWC: 1677.0
+          FWL: 1677.0
+          GOC: 1000.0
+          EQT: 0
+          COL: (105, 89, 205)
 
 access:
   asset:

schema/definitions/0.8.0/schema/fmu_results.json

@@ -993,6 +993,10 @@
                     }
                 }
             },
+            "config": {
+                "type": "object",
+                "description": "Transferred elements from global config"
+            },
             "iteration": {
                 "type": "object",
                 "required": [
@@ -1226,6 +1230,9 @@
                         },
                         "case": {
                             "$ref": "#/definitions/fmu/case"
+                        },
+                        "config": {
+                            "$ref": "#/definitions/fmu/config"
                         }
                     }
                 },

src/fmu/dataio/_definitions.py

@@ -91,3 +91,12 @@ def __post_init__(self):
     "case_symlink_realization": "To case/share, with symlinks on realizations level",
     "preprocessed": "To share/preprocessed; from interactive runs but re-used later",
 }
+
+CONFIG_FIELDS_2_CASE_METADATA = {
+    "REGIONS": {
+        "type": dict,
+    },
+    "SEISMIC_DATES": {
+        "type": list,
+    },
+}

src/fmu/dataio/dataio.py

@@ -20,6 +20,7 @@
     ALLOWED_FMU_CONTEXTS,
     CONTENTS_REQUIRED,
     DEPRECATED_CONTENTS,
+    CONFIG_FIELDS_2_CASE_METADATA,
 )
 from ._utils import (
     create_symlink,
@@ -996,6 +997,28 @@ def _check_already_metadata_or_create_folder(self, force=False) -> bool:
 
         return False
 
+    def _get_globals_from_globalconfig(self):
+        cfg_global = dict()
+
+        for key in CONFIG_FIELDS_2_CASE_METADATA.keys():
+            expect_type = CONFIG_FIELDS_2_CASE_METADATA[key]["type"]
+            block = self.config["global"].get(key)
+
+            if block is None:
+                warn(f"{key} was not found in the global_config.")
+                continue
+
+            if isinstance(block, expect_type):
+                logger.info("Adding %s to case metadata", key)
+                cfg_global[key] = self.config["global"][key]
+            else:
+                warn(
+                    f"{key} was found in global_config but is not of type "
+                    f"{expect_type} and will be ignored."
+                )
+
+        return cfg_global
+
     # ==================================================================================
     # Public methods:
     # ==================================================================================
@@ -1043,6 +1066,8 @@ def generate_metadata(
 
         meta["fmu"] = dict()
         meta["fmu"]["model"] = self.config["model"]
+        meta["fmu"]["config"] = dict()
+        meta["fmu"]["config"]["global"] = self._get_globals_from_globalconfig()
 
         mcase = meta["fmu"]["case"] = dict()
         mcase["name"] = self.casename

tests/test_units/test_initialize_case.py

@@ -1,16 +1,18 @@
-"""Test the dataio running from within RMS interactive as context.
+"""Test the InitializeCase class.
 
-In this case a user sits in RMS, which is in folder rms/model and runs
-interactive. Hence the basepath will be ../../
+This class is used for creating the case metadata.
 """
+
 import logging
 import os
+from copy import deepcopy
 
 import pytest
 import yaml
 
 from fmu.dataio import InitializeCase
 from fmu.dataio._utils import prettyprint_dict
+from fmu.dataio._definitions import CONFIG_FIELDS_2_CASE_METADATA
 
 logger = logging.getLogger(__name__)
 
@@ -196,3 +198,55 @@ def test_inicase_deprecated_restart_from(fmurun_w_casemetadata, globalconfig2):
             rootfolder=fmurun_w_casemetadata.parent.parent,
             restart_from="Jurassic era",
         )
+
+
+def test_inicase_get_globals(globalconfig2):
+    """Test the _get_globals_from_globalconfig private method."""
+
+    # Verify that fmu-dataio is _told_ to get REGIONS (test assumption)
+    assert "REGIONS" in CONFIG_FIELDS_2_CASE_METADATA
+
+    # verify that fmu-dataio _gets_ REGIONS
+    icase = InitializeCase(globalconfig2)
+    global_ = icase._get_globals_from_globalconfig()
+    assert "REGIONS" in global_
+    assert isinstance(global_, dict)
+
+
+def test_inicase_get_globals_with_metadata_generation(globalconfig2, fmurun):
+    icase = InitializeCase(globalconfig2)
+    caseroot = fmurun.parent.parent
+    metadata = icase.generate_case_metadata(rootfolder=caseroot, force=True)
+
+    assert "fmu" in metadata
+    assert "config" in metadata["fmu"]
+    assert "global" in metadata["fmu"]["config"]
+
+    cfg_gl = metadata["fmu"]["config"]["global"]  # short form
+    assert "REGIONS" in cfg_gl
+    expected_type = CONFIG_FIELDS_2_CASE_METADATA["REGIONS"]["type"]
+    assert isinstance(cfg_gl["REGIONS"], expected_type)
+    assert "WestLowland" in cfg_gl["REGIONS"]
+
+
+def test_inicase_get_globals_missing_block(globalconfig2, fmurun):
+    """Test behavior when a wanted block is missing from global_variables."""
+
+    globalconfig2_copy = deepcopy(globalconfig2)
+    del globalconfig2_copy["global"]["REGIONS"]
+
+    icase = InitializeCase(globalconfig2_copy)
+    caseroot = fmurun.parent.parent
+    with pytest.warns(match="REGIONS was not found"):
+        metadata = icase.generate_case_metadata(rootfolder=caseroot, force=True)
+
+    assert "fmu" in metadata
+    assert "config" in metadata["fmu"]
+    assert "global" in metadata["fmu"]["config"]
+
+    cfg_gl = metadata["fmu"]["config"]["global"]  # short form
+    assert "REGIONS" not in cfg_gl
+    assert "SEISMIC_DATES" in cfg_gl
+
+    expected_type = CONFIG_FIELDS_2_CASE_METADATA["SEISMIC_DATES"]["type"]
+    assert isinstance(cfg_gl["SEISMIC_DATES"], expected_type)