GEOPY-2702: Validate "geoh5" for existing path

[benk-mira]

GEOPY-2702 - Validate "geoh5" for existing path

[Copilot]

Pull request overview

This PR tightens validation for the geoh5 path in BaseUIJson by enforcing a .geoh5 file extension and adds a regression test to ensure invalid extensions are rejected.

Changes:

• Added a geoh5 extension validator to require .geoh5.
• Switched geoh5 field validation to run in mode="before".
• Added a unit test expecting a ValidationError when geoh5 has the wrong extension.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
geoh5py/ui_json/ui_json.py	Adds .geoh5 extension validation and changes validator execution mode for geoh5.
tests/ui_json/uijson_test.py	Adds a test asserting invalid geoh5 extensions raise a Pydantic ValidationError.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

[Copilot]

geoh5 is frequently passed as a string (e.g., other tests call geoh5=str(...)). With mode="before", Pydantic validators receive the raw input, so path can be a str here and path.exists() will raise an AttributeError rather than producing the intended validation error. Consider switching this validator back to mode="after" (so the value is parsed into a Path first) or explicitly coercing path = Path(path) when a string is provided.

Suggested change

	@field_validator("geoh5", mode="before")
	@classmethod
	def workspace_path_exists(cls, path: Path):
	if not path.exists():
	raise FileNotFoundError(f"geoh5 path {path} does not exist.")
	return path
	@field_validator("geoh5", mode="before")
	@classmethod
	def valid_geoh5_extension(cls, path: Path):
	@field_validator("geoh5", mode="after")
	@classmethod
	def workspace_path_exists(cls, path: Path | None):
	if path is None:
	return path
	if not path.exists():
	raise FileNotFoundError(f"geoh5 path {path} does not exist.")
	return path
	@field_validator("geoh5", mode="after")
	@classmethod
	def valid_geoh5_extension(cls, path: Path | None):
	if path is None:
	return path

[domfournier]

I think Copilot is right. Why before?

[benk-mira]

Can't recall the reason. Makes sense to keep as after. Fixed.

[domfournier]

I think Copilot is right. Why before?

[domfournier]

Similar to comment above, input would be a str from file. So test with that.

[benk-mira]

done

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.18%. Comparing base (7e3b1de) to head (49934ef).
⚠️ Report is 18 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #857      +/-   ##
===========================================
- Coverage    91.18%   91.18%   -0.01%     
===========================================
  Files          115      115              
  Lines        10272    10298      +26     
  Branches      1898     1901       +3     
===========================================
+ Hits          9367     9390      +23     
- Misses         483      485       +2     
- Partials       422      423       +1     

Files with missing lines	Coverage Δ
geoh5py/ui_json/ui_json.py	89.44% <100.00%> (+0.40%)	⬆️

... and 3 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.