Coverage for tests/test_connectionString.py: 38%

45 statements  

« prev     ^ index     » next       coverage.py v7.4.4, created at 2024-04-15 02:03 -0700

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 shutil 

35import tempfile 

36import unittest 

37 

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

39from lsst.daf.butler.registry import RegistryConfig 

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

41from lsst.utils.db_auth import DbAuthError 

42 

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

44 

45 

46class ConnectionStringBuilderTestCase(unittest.TestCase): 

47 """Tests for ConnectionStringBuilder.""" 

48 

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

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

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

52 

53 def setUp(self): 

54 self.resetDbAuthPathValue = ConnectionStringModule.DB_AUTH_PATH 

55 temporaryCredentialsFile = self.enterContext(tempfile.NamedTemporaryFile()).name 

56 shutil.copyfile(self.credentialsFile, temporaryCredentialsFile) 

57 os.chmod(temporaryCredentialsFile, 0o600) 

58 ConnectionStringModule.DB_AUTH_PATH = temporaryCredentialsFile 

59 

60 def tearDown(self): 

61 ConnectionStringModule.DB_AUTH_PATH = self.resetDbAuthPathValue 

62 

63 def testBuilder(self): 

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

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

66 

67 conStrFactory = ConnectionStringFactory() 

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

69 conStr = conStrFactory.fromConfig(regConf) 

70 with self.subTest(confFile=fileName): 

71 self.assertEqual( 

72 conStr.render_as_string(hide_password=False), 

73 regConf["expected"], 

74 "test connection string built from config", 

75 ) 

76 

77 def testRelVsAbsPath(self): 

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

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

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

81 conStrFactory = ConnectionStringFactory() 

82 conStr = conStrFactory.fromConfig(regConf) 

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

84 

85 def testRaises(self): 

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

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

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

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

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

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

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

93 conStrFactory = ConnectionStringFactory() 

94 with self.assertRaises(DbAuthError): 

95 conStrFactory.fromConfig(regConf) 

96 

97 

98if __name__ == "__main__": 

99 unittest.main()