Coverage for tests / test_butler_factory.py: 32%

1# This file is part of daf_butler. 

2# 

3# Developed for the LSST Data Management System. 

4# This product includes software developed by the LSST Project 

5# (http://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 software is dual licensed under the GNU General Public License and also 

10# under a 3-clause BSD license. Recipients may choose which of these licenses 

11# to use; please see the files gpl-3.0.txt and/or bsd_license.txt, 

12# respectively. If you choose the GPL option then the following text applies 

13# (but note that there is still no warranty even if you opt for BSD instead): 

14# 

15# This program is free software: you can redistribute it and/or modify 

16# it under the terms of the GNU General Public License as published by 

17# the Free Software Foundation, either version 3 of the License, or 

18# (at your option) any later version. 

19# 

20# This program is distributed in the hope that it will be useful, 

21# but WITHOUT ANY WARRANTY; without even the implied warranty of 

22# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

23# GNU General Public License for more details. 

24# 

25# You should have received a copy of the GNU General Public License 

26# along with this program. If not, see <http://www.gnu.org/licenses/>. 

27 

28import tempfile 

29import unittest 

30 

31from lsst.daf.butler import LabeledButlerFactory 

32from lsst.daf.butler.direct_butler import DirectButler 

33from lsst.daf.butler.tests import makeTestRepo 

34from lsst.daf.butler.tests.utils import mock_env 

35 

36 

37class ButlerFactoryTestCase(unittest.TestCase): 

38 """Test LabeledButlerFactory.""" 

39 

40 # RemoteButler cases aren't tested in this file because RemoteButler's 

41 # dependencies aren't available in rubin-env. RemoteButler gets covered in 

42 # test_server.py. 

43 

44 @classmethod 

45 def setUpClass(cls): 

46 repo_dir = cls.enterClassContext(tempfile.TemporaryDirectory()) 

47 butler = makeTestRepo(repo_dir) 

48 butler.close() 

49 cls.config_file_uri = f"file://{repo_dir}" 

50 

51 def test_factory_via_global_repository_index(self): 

52 with tempfile.NamedTemporaryFile(suffix=".yaml") as index_file: 

53 index_file.write(f"test_repo: {self.config_file_uri}\n".encode()) 

54 index_file.flush() 

55 with mock_env({"DAF_BUTLER_REPOSITORY_INDEX": index_file.name}): 

56 with LabeledButlerFactory() as factory: 

57 self._test_factory(factory) 

58 

59 def test_factory_via_custom_index(self): 

60 with LabeledButlerFactory({"test_repo": self.config_file_uri}) as factory: 

61 self._test_factory(factory) 

62 

63 with LabeledButlerFactory({"test_repo": self.config_file_uri}, writeable=True) as writeable_factory: 

64 self._test_factory(writeable_factory) 

65 with writeable_factory.create_butler(label="test_repo", access_token=None) as butler: 

66 butler.collections.register("new_run") 

67 self.assertIsNotNone(butler.collections.get_info("new_run")) 

68 

69 def _test_factory(self, factory: LabeledButlerFactory) -> None: 

70 butler = factory.create_butler("test_repo") 

71 self.assertIsInstance(butler, DirectButler) 

72 # This identical second call covers a read from the cache. 

73 butler2 = factory.create_butler(label="test_repo", access_token=None) 

74 self.assertIsInstance(butler2, DirectButler) 

75 with self.assertRaises(KeyError): 

76 factory.create_butler(label="unknown", access_token=None) 

77 

78 

79if __name__ == "__main__": 

80 unittest.main()