Coverage for tests / test_interface.py: 32%
138 statements
« prev ^ index » next coverage.py v7.14.0, created at 2026-05-27 01:07 -0700
1# This file is part of rucio_register
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# This program is free software: you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation, either version 3 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program. If not, see <https://www.gnu.org/licenses/>.
23import os
24import shutil
25import tempfile
26from unittest.mock import MagicMock, patch
28from rucio.client.didclient import DIDClient
29from rucio.client.replicaclient import ReplicaClient
30from rucio.common.exception import (
31 DataIdentifierAlreadyExists,
32 DataIdentifierNotFound,
33 FileAlreadyExists,
34 RucioException,
35)
37import lsst.utils.tests
38from lsst.daf.butler import Butler, DatasetRef, DimensionUniverse
40# from lsst.daf.butler.registry import DatasetTypeError, MissingCollectionError
41from lsst.resources import ResourceInfo, ResourcePath
42from lsst.resources.file import FileResourcePath
43from lsst.rucio.register.data_type import DataType
44from lsst.rucio.register.rucio_interface import RucioInterface
47class InterfaceTestCase(lsst.utils.tests.TestCase):
48 maxDiff = None
50 def setUp(self):
51 self.butler_repo = tempfile.mkdtemp(dir="/tmp")
52 test_dir = os.path.abspath(os.path.dirname(__file__))
54 self.dataset_ref_file = os.path.join(test_dir, "data", "dataset_ref.json")
56 Butler.makeRepo(self.butler_repo)
58 data_name = "visitSummary_HSC_y_HSC-Y_318_HSC_runs_RC2_w_2023_32_DM-40356_20230814T170253Z.fits"
59 json_name = "visitSummary_HSC_y_HSC-Y_318_HSC_runs_RC2_w_2023_32_DM-40356_20230814T170253Z.json"
61 self.data_file = os.path.join(test_dir, "data", data_name)
62 self.json_file = os.path.join(test_dir, "data", json_name)
64 self.butler = Butler(self.butler_repo, writeable=True)
65 self.butler.getURI = MagicMock(return_value=ResourcePath(f"file://{self.data_file}"))
67 self.rse_root = tempfile.mkdtemp(dir="/tmp")
69 # patch __init__ methods
70 self.rc_init = patch.object(ReplicaClient, "__init__", return_value=None)
71 self.dc_init = patch.object(DIDClient, "__init__", return_value=None)
72 self.rc_add_replicas = patch.object(ReplicaClient, "add_replicas", return_value=None)
73 self.dc_attach_dids = patch.object(DIDClient, "attach_dids", return_value=None)
74 self.rand = patch("random.randint", return_value=1)
76 self.mock_rc_init = self.rc_init.start()
77 self.mock_dc_init = self.dc_init.start()
78 self.mock_rc_add_replicas = self.rc_add_replicas.start()
79 self.mock_dc_attach_dids = self.dc_attach_dids.start()
80 self.mock_rand = self.rand.start()
82 rucio_rse = "DRR1"
83 scope = "test"
84 dtn_url = "root://xrd1:1094//rucio"
85 self.ri = RucioInterface(self.butler, rucio_rse, scope, self.rse_root, dtn_url, DataType.DATA_PRODUCT)
87 def testChecksumsCase(self):
88 fake_info = MagicMock(spec=ResourceInfo)
89 fake_info.checksums = {"adler32": "abcd1234"}
90 fake_info.size = 1234
91 fake_info.is_file = True
92 fake_info.last_modified = None
93 fake_info.uri = f"file://{self.data_file}"
95 patcher = patch.object(FileResourcePath, "get_info", return_value=fake_info)
96 patcher.start()
97 self.addCleanup(patcher.stop)
99 with open(self.dataset_ref_file) as f:
100 json_ref = f.readline()
102 ref = DatasetRef.from_json(json_ref, DimensionUniverse())
104 self.butler.registry.registerDatasetType(ref.datasetType)
105 cnt = self.ri.register_as_replicas("mydataset", [ref])
106 self.assertEqual(cnt, 1)
108 rb = self.ri._make_dataset_ref_bundle("mydataset", ref)
109 self.assertEqual(rb.dataset_id, "mydataset")
111 did = rb.did.model_dump()
113 self.assertEqual(did["adler32"], "abcd1234")
115 def testInterfaceTestCase(self):
116 dtn_url = "root://xrd1:1094//rucio"
118 json_ref = None
119 with open(self.dataset_ref_file) as f:
120 json_ref = f.readline()
122 ref = DatasetRef.from_json(json_ref, DimensionUniverse())
124 self.butler.registry.registerDatasetType(ref.datasetType)
125 cnt = self.ri.register_as_replicas("mydataset", [ref])
126 self.assertEqual(cnt, 1)
128 rb = self.ri._make_dataset_ref_bundle("mydataset", ref)
129 self.assertEqual(rb.dataset_id, "mydataset")
131 did = rb.did.model_dump()
132 self.assertEqual(did["pfn"], f"{dtn_url}{self.data_file}")
133 self.assertEqual(did["bytes"], 1365120)
134 self.assertEqual(did["adler32"], "480be4de")
135 self.assertEqual(did["name"], self.data_file)
136 self.assertEqual(did["scope"], "test")
138 meta = did["meta"]
139 self.assertEqual(meta["rubin_butler"], DataType.DATA_PRODUCT)
141 def common(self):
142 json_ref = None
143 with open(self.dataset_ref_file) as f:
144 json_ref = f.readline()
146 ref = DatasetRef.from_json(json_ref, DimensionUniverse())
148 self.butler.registry.registerDatasetType(ref.datasetType)
149 self.ri.register_as_replicas("mydataset", [ref])
151 @patch.object(ReplicaClient, "add_replicas", side_effect=RucioException("failed"))
152 def testException1TestCase(self, MC1):
153 self.ri.register_to_dataset = MagicMock(name="register_to_dataset")
154 with self.assertRaises(Exception):
155 self.common()
157 @patch.object(DIDClient, "add_files_to_dataset", side_effect=RucioException("failed"))
158 def testException2TestCase(self, MC1):
159 with self.assertRaises(Exception):
160 self.common()
162 @patch.object(DIDClient, "add_files_to_dataset", side_effect=FileAlreadyExists("failed"))
163 def testException3TestCase(self, MC1):
164 self.common()
166 @patch.object(DIDClient, "add_dataset", return_value=None)
167 @patch.object(DIDClient, "add_files_to_dataset", side_effect=DataIdentifierNotFound("failed"))
168 def testException4TestCase(self, MC1, MC2):
169 with self.assertRaises(Exception):
170 self.common()
172 @patch.object(DIDClient, "add_files_to_dataset", side_effect=RucioException("failed"))
173 def testException5TestCase(self, MC1):
174 with self.assertRaises(Exception):
175 self.common()
177 @patch.object(DIDClient, "add_dataset", side_effect=DataIdentifierAlreadyExists("failed"))
178 @patch.object(DIDClient, "add_files_to_dataset", side_effect=DataIdentifierNotFound("failed"))
179 def testException6TestCase(self, MC1, MC2):
180 with self.assertRaises(Exception):
181 self.common()
183 @patch.object(DIDClient, "add_files_to_dataset", side_effect=RucioException("failed"))
184 def testException7TestCase(self, MC1):
185 with self.assertRaises(Exception):
186 self.common()
188 @patch.object(DIDClient, "add_dataset", side_effect=RucioException("failed"))
189 @patch.object(DIDClient, "add_files_to_dataset", side_effect=DataIdentifierNotFound("failed"))
190 def testException8TestCase(self, MC1, MC2):
191 with self.assertRaises(Exception):
192 self.common()
194 @patch.object(DIDClient, "add_files_to_dataset", side_effect=RucioException("failed"))
195 def testException9Case(self, MC1):
196 rucio_rse = "DRR1"
197 scope = "test"
198 dtn_url = "root://xrd1:1094//rucio"
200 ri = RucioInterface(self.butler, rucio_rse, scope, self.rse_root, dtn_url, DataType.DATA_PRODUCT)
201 with self.assertRaises(Exception):
202 ri._add_file_to_dataset_with_retries(None, None)
204 def tearDown(self):
205 patch.stopall()
206 shutil.rmtree(self.butler_repo, ignore_errors=True)
207 shutil.rmtree(self.rse_root, ignore_errors=True)
210class MemoryTester(lsst.utils.tests.MemoryTestCase):
211 pass
214def setup_module(module):
215 lsst.utils.tests.init()