Coverage for tests/test_connectionString.py: 38%

42 statements  

« prev     ^ index     » next       coverage.py v7.4.0, created at 2024-01-16 10:44 +0000

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 

28"""Tests for ConnectionStringBuilder. 

29""" 

30 

31import glob 

32import os 

33import os.path 

34import tempfile 

35import unittest 

36 

37import lsst.daf.butler.registry.connectionString as ConnectionStringModule 

38from lsst.daf.butler.registry import RegistryConfig 

39from lsst.daf.butler.registry.connectionString import ConnectionStringFactory 

40from lsst.utils.db_auth import DbAuthError 

41 

42TESTDIR = os.path.abspath(os.path.dirname(__file__)) 

43 

44 

45class ConnectionStringBuilderTestCase(unittest.TestCase): 

46 """Tests for ConnectionStringBuilder.""" 

47 

48 configDir = os.path.join(TESTDIR, "config", "dbAuth") 

49 configFiles = glob.glob(os.path.join(configDir, "registryConf*")) 

50 credentialsFile = os.path.join(configDir, "db-auth.yaml") 

51 

52 def setUp(self): 

53 self.resetDbAuthPathValue = ConnectionStringModule.DB_AUTH_PATH 

54 ConnectionStringModule.DB_AUTH_PATH = self.credentialsFile 

55 os.chmod(self.credentialsFile, 0o600) 

56 

57 def tearDown(self): 

58 ConnectionStringModule.DB_AUTH_PATH = self.resetDbAuthPathValue 

59 

60 def testBuilder(self): 

61 """Tests ConnectionStringFactory returns correct connection strings.""" 

62 regConfigs = [RegistryConfig(os.path.join(self.configDir, name)) for name in self.configFiles] 

63 

64 conStrFactory = ConnectionStringFactory() 

65 for regConf, fileName in zip(regConfigs, self.configFiles, strict=True): 

66 conStr = conStrFactory.fromConfig(regConf) 

67 with self.subTest(confFile=fileName): 

68 self.assertEqual( 

69 conStr.render_as_string(hide_password=False), 

70 regConf["expected"], 

71 "test connection string built from config", 

72 ) 

73 

74 def testRelVsAbsPath(self): 

75 """Tests that relative and absolute paths are preserved.""" 

76 regConf = RegistryConfig(os.path.join(self.configDir, "registryConf1.yaml")) 

77 regConf["db"] = "sqlite:///relative/path/conf1.sqlite3" 

78 conStrFactory = ConnectionStringFactory() 

79 conStr = conStrFactory.fromConfig(regConf) 

80 self.assertEqual(str(conStr), "sqlite:///relative/path/conf1.sqlite3") 

81 

82 def testRaises(self): 

83 """Test that DbAuthError propagates through the class.""" 

84 # Create a bad yaml file that triggers a parsing error. 

85 # It will be created with the correct 600 permissions. 

86 with tempfile.NamedTemporaryFile(suffix=".yaml", mode="w") as temp_config: 

87 print("[", file=temp_config, flush=True) 

88 ConnectionStringModule.DB_AUTH_PATH = os.path.join(temp_config.name) 

89 regConf = RegistryConfig(os.path.join(self.configDir, "registryConf2.yaml")) 

90 conStrFactory = ConnectionStringFactory() 

91 with self.assertRaises(DbAuthError): 

92 conStrFactory.fromConfig(regConf) 

93 

94 

95if __name__ == "__main__": 

96 unittest.main()