added "test_messages_contain_object_names()" to "test_simulation.py"

Author: jewettaijfc

tests/test_components/test_simulation.py

@@ -3648,3 +3648,69 @@ def test_create_sim_multiphysics_with_incompatibilities():
                 ),
             ],
         )
+
+
+def test_messages_contain_object_names():
+    """Make sure that errors and warnings contain the name of the object."""
+    # Note: This function currently tests for out-of-bounds errors and warnings.
+    sim_args = {
+        "size": (1, 1, 1),
+        "grid_spec": td.GridSpec.auto(wavelength=4),
+        "boundary_spec": td.BoundarySpec(
+            x=td.Boundary.periodic(),
+            y=td.Boundary.periodic(),
+            z=td.Boundary.periodic(),
+        ),
+        "run_time": 1e-12,
+    }
+
+    # Test 1) Create a structure lying partially outside the simulation boundary.
+    # Check that a warning message is generated containing the structure's `name`.
+    structure_args = {
+        "geometry": td.Box(center=(1.0, 1.0, 0.0), size=(0.5, 0.5, 0.5)),
+        "medium": td.Medium(permittivity=2.0),
+    }
+    td.log.set_capture(True)
+    # Create a simulation with this structure.
+    _ = td.Simulation(
+        structures=[td.Structure(name="structure_123", **structure_args)],
+        **sim_args,
+    )
+    warning_list = td.log.captured_warnings()
+    assert len(warning_list) >= 1
+    assert "structure_123" in warning_list[0]["msg"]
+    td.log.set_capture(False)
+
+    # Test 2) Create a source lying partially outside the simulation boundary.
+    # Check that an error message is generated containing the source's `name`.
+    source_args = {
+        "center": (0, -1.0, 0),
+        "size": (1, 0, 0.5),
+        "polarization": "Ex",
+        "source_time": td.GaussianPulse(
+            freq0=100e14,
+            fwidth=10e14,
+        ),
+    }
+    try:
+        # Create a simulation with this source.
+        _ = td.Simulation(
+            sources=[td.UniformCurrentSource(name="source_123", **source_args)],
+            **sim_args,
+        )
+        raise AssertionError  # The previous line should raise an exception.
+    except pydantic.ValidationError as e:
+        assert "source_123" in str(e)
+
+    # Test 3) Create a monitor lying partially outside the simulation boundary.
+    # Check that an error message is generated containing the monitor's `name`.
+    monitor_args = {"center": (-1.0, 0, 0), "size": (0.5, 0, 1), "freqs": [100e14]}
+    try:
+        # Create a simulation with this monitor.
+        _ = td.Simulation(
+            monitors=[td.FieldMonitor(name="monitor_123", **monitor_args)],
+            **sim_args,
+        )
+        raise AssertionError  # The previous line should raise an exception.
+    except pydantic.ValidationError as e:
+        assert "monitor_123" in str(e)