Coverage for tests/test_interface.py: 100%
127 statements
« prev ^ index » next coverage.py v7.15.2, created at 2026-07-25 08:38 +0000
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
28import urllib3
29from rucio.client.didclient import DIDClient
30from rucio.client.replicaclient import ReplicaClient
31from rucio.common.exception import (
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.dc_attach_dids_to_dids = patch.object(DIDClient, "attach_dids_to_dids", return_value=None)
75 self.rand = patch("random.randint", return_value=1)
77 self.mock_rc_init = self.rc_init.start()
78 self.mock_dc_init = self.dc_init.start()
79 self.mock_rc_add_replicas = self.rc_add_replicas.start()
80 self.mock_dc_attach_dids = self.dc_attach_dids.start()
81 self.mock_dc_attach_dids_to_dids = self.dc_attach_dids_to_dids.start()
82 self.mock_rand = self.rand.start()
84 rucio_rse = "DRR1"
85 scope = "test"
86 dtn_url = "root://xrd1:1094//rucio"
87 self.ri = RucioInterface(self.butler, rucio_rse, scope, self.rse_root, dtn_url, DataType.DATA_PRODUCT)
89 def testChecksumsCase(self):
90 fake_info = MagicMock(spec=ResourceInfo)
91 fake_info.checksums = {"adler32": "abcd1234"}
92 fake_info.size = 1234
93 fake_info.is_file = True
94 fake_info.last_modified = None
95 fake_info.uri = f"file://{self.data_file}"
97 patcher = patch.object(FileResourcePath, "get_info", return_value=fake_info)
98 patcher.start()
99 self.addCleanup(patcher.stop)
101 with open(self.dataset_ref_file) as f:
102 json_ref = f.readline()
104 ref = DatasetRef.from_json(json_ref, DimensionUniverse())
106 self.butler.registry.registerDatasetType(ref.datasetType)
107 cnt = self.ri.register_as_replicas("mydataset", [ref])
108 self.assertEqual(cnt, 1)
110 rb = self.ri._make_dataset_ref_bundle("mydataset", ref)
111 self.assertEqual(rb.dataset_id, "mydataset")
113 did = rb.did.model_dump()
115 self.assertEqual(did["adler32"], "abcd1234")
117 def testInterfaceTestCase(self):
118 dtn_url = "root://xrd1:1094//rucio"
120 json_ref = None
121 with open(self.dataset_ref_file) as f:
122 json_ref = f.readline()
124 ref = DatasetRef.from_json(json_ref, DimensionUniverse())
126 self.butler.registry.registerDatasetType(ref.datasetType)
127 cnt = self.ri.register_as_replicas("mydataset", [ref])
128 self.assertEqual(cnt, 1)
130 rb = self.ri._make_dataset_ref_bundle("mydataset", ref)
131 self.assertEqual(rb.dataset_id, "mydataset")
133 did = rb.did.model_dump()
134 self.assertEqual(did["pfn"], f"{dtn_url}{self.data_file}")
135 self.assertEqual(did["bytes"], 1365120)
136 self.assertEqual(did["adler32"], "480be4de")
137 self.assertEqual(did["name"], self.data_file)
138 self.assertEqual(did["scope"], "test")
140 meta = did["meta"]
141 self.assertEqual(meta["rubin_butler"], DataType.DATA_PRODUCT)
143 def common(self):
144 json_ref = None
145 with open(self.dataset_ref_file) as f:
146 json_ref = f.readline()
148 ref = DatasetRef.from_json(json_ref, DimensionUniverse())
150 self.butler.registry.registerDatasetType(ref.datasetType)
151 self.ri.register_as_replicas("mydataset", [ref])
153 @patch.object(ReplicaClient, "add_replicas", side_effect=RucioException("failed"))
154 def testException1TestCase(self, MC1):
155 self.ri.register_to_dataset = MagicMock(name="register_to_dataset")
156 with self.assertRaises(Exception):
157 self.common()
159 @patch.object(DIDClient, "add_files_to_dataset", side_effect=FileAlreadyExists("failed"))
160 def testException2TestCase(self, MC1):
161 self.common()
163 @patch.dict("lsst.rucio.register.rucio_interface._BACKOFF", {"factor": 0.5, "max_tries": 3})
164 @patch.object(
165 ReplicaClient,
166 "add_replicas",
167 side_effect=urllib3.exceptions.ReadTimeoutError(pool=None, url="http://127.0.0.1/", message="failed"),
168 )
169 def testException3TestCase(self, MC3):
170 self.ri.register_to_dataset = MagicMock(name="register_to_dataset")
171 with self.assertRaises(Exception):
172 self.common()
174 @patch.dict("lsst.rucio.register.rucio_interface._BACKOFF", {"factor": 0.5, "max_tries": 3})
175 @patch.object(
176 DIDClient,
177 "add_files_to_datasets",
178 side_effect=urllib3.exceptions.ReadTimeoutError(pool=None, url="http://127.0.0.1/", message="failed"),
179 )
180 def testException4TestCase(self, MC4):
181 with self.assertRaises(Exception):
182 self.common()
184 @patch.object(DIDClient, "add_files_to_datasets", side_effect=DataIdentifierNotFound("failed"))
185 def testException5TestCase(self, MC5):
186 with self.assertRaises(Exception):
187 self.common()
189 @patch.dict("lsst.rucio.register.rucio_interface._BACKOFF", {"factor": 0.5, "max_tries": 3})
190 @patch.object(DIDClient, "add_files_to_datasets", side_effect=DataIdentifierNotFound("failed"))
191 @patch.object(
192 DIDClient,
193 "add_dataset",
194 side_effect=urllib3.exceptions.ReadTimeoutError(pool=None, url="http://127.0.0.1/", message="failed"),
195 )
196 def testException6TestCase(self, MC6a, MC6b):
197 with self.assertRaises(Exception):
198 self.common()
200 def tearDown(self):
201 patch.stopall()
202 shutil.rmtree(self.butler_repo, ignore_errors=True)
203 shutil.rmtree(self.rse_root, ignore_errors=True)
206class MemoryTester(lsst.utils.tests.MemoryTestCase):
207 pass
210def setup_module(module):
211 lsst.utils.tests.init()