Coverage for tests/test_ndf_format_version.py: 90%

1# This file is part of lsst-images. 

2# 

3# Developed for the LSST Data Management System. 

4# This product includes software developed by the LSST Project 

5# (https://www.lsst.org). 

6# See the COPYRIGHT file at the top-level directory of this distribution 

7# for details of code ownership. 

8# 

9# Use of this source code is governed by a 3-clause BSD-style 

10# license that can be found in the LICENSE file. 

11 

12from __future__ import annotations 

13 

14from pathlib import Path 

15 

16import numpy as np 

17import pytest 

18 

19from lsst.images import Image 

20from lsst.images.serialization import ArchiveReadError 

21 

22try: 

23 import h5py 

24 

25 from lsst.images.ndf import write as ndf_write 

26 

27 HAVE_H5PY = True 

28except ImportError: 

29 HAVE_H5PY = False 

30 

31 

32def _write_simple_image_ndf(path: Path | str) -> None: 

33 """Write a tiny Image to ``path`` as an NDF.""" 

34 image = Image(0.0, shape=(4, 4), dtype="float32") 

35 ndf_write(image, path) 

36 

37 

38skip_no_h5py = pytest.mark.skipif(not HAVE_H5PY, reason="NDF backend requires h5py") 

39 

40 

41@skip_no_h5py 

42def test_write_emits_data_model_and_format_version(tmp_path: Path) -> None: 

43 """Verify a freshly-written NDF carries DATA_MODEL and FORMAT_VERSION.""" 

44 path = tmp_path / "x.sdf" 

45 _write_simple_image_ndf(path) 

46 with h5py.File(path, "r") as f: 

47 assert "FORMAT_VERSION" in f["/MORE/LSST"] 

48 assert "DATA_MODEL" in f["/MORE/LSST"] 

49 

50 

51@skip_no_h5py 

52def test_read_succeeds_when_format_version_matches(tmp_path: Path) -> None: 

53 """Verify a freshly-written NDF reads successfully.""" 

54 from lsst.images.ndf import NdfInputArchive 

55 

56 path = tmp_path / "x.sdf" 

57 _write_simple_image_ndf(path) 

58 with NdfInputArchive.open(path): 

59 pass 

60 

61 

62@skip_no_h5py 

63def test_read_fails_when_format_version_too_high(tmp_path: Path) -> None: 

64 """Verify a file with a newer FORMAT_VERSION raises ArchiveReadError.""" 

65 from lsst.images.ndf import NdfInputArchive 

66 

67 path = tmp_path / "x.sdf" 

68 _write_simple_image_ndf(path) 

69 with h5py.File(path, "r+") as f: 

70 if "FORMAT_VERSION" in f["/MORE/LSST"]: 70 ↛ 72line 70 didn't jump to line 72 because the condition on line 70 was always true

71 del f["/MORE/LSST/FORMAT_VERSION"] 

72 f["/MORE/LSST"].create_dataset("FORMAT_VERSION", data=np.int32(2)) 

73 with pytest.raises(ArchiveReadError): 

74 with NdfInputArchive.open(path): 

75 pass 

76 

77 

78@skip_no_h5py 

79def test_read_succeeds_when_format_version_absent(tmp_path: Path) -> None: 

80 """Verify a legacy file lacking FORMAT_VERSION reads successfully. 

81 

82 The reader should default to format version 1 when FORMAT_VERSION is 

83 absent. 

84 """ 

85 from lsst.images.ndf import NdfInputArchive 

86 

87 path = tmp_path / "x.sdf" 

88 _write_simple_image_ndf(path) 

89 with h5py.File(path, "r+") as f: 

90 if "FORMAT_VERSION" in f["/MORE/LSST"]: 90 ↛ 92line 90 didn't jump to line 92 because the condition on line 90 was always true

91 del f["/MORE/LSST/FORMAT_VERSION"] 

92 if "DATA_MODEL" in f["/MORE/LSST"]: 92 ↛ 94line 92 didn't jump to line 94

93 del f["/MORE/LSST/DATA_MODEL"] 

94 with NdfInputArchive.open(path): 

95 pass