Coverage for tests / test_connectionString.py: 47%

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 

30import glob 

31import os 

32import os.path 

33import shutil 

34import tempfile 

35import unittest 

36 

37from lsst.daf.butler.registry import RegistryConfig 

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

39from lsst.utils.db_auth import DbAuthError 

40 

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

42 

43 

44class ConnectionStringBuilderTestCase(unittest.TestCase): 

45 """Tests for ConnectionStringBuilder.""" 

46 

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

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

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

50 

51 def setUp(self): 

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

53 shutil.copyfile(self.credentialsFile, temporaryCredentialsFile) 

54 os.chmod(temporaryCredentialsFile, 0o600) 

55 self.db_auth_path = temporaryCredentialsFile 

56 

57 def testBuilder(self): 

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

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

60 

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

62 conStr = ConnectionStringFactory.fromConfig(regConf, db_auth_path=self.db_auth_path) 

63 with self.subTest(confFile=fileName): 

64 self.assertEqual( 

65 conStr.render_as_string(hide_password=False), 

66 regConf["expected"], 

67 "test connection string built from config", 

68 ) 

69 

70 def testRelVsAbsPath(self): 

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

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

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

74 conStr = ConnectionStringFactory.fromConfig(regConf, db_auth_path=self.db_auth_path) 

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

76 

77 def testRaises(self): 

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

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

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

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

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

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

84 with self.assertRaises(DbAuthError): 

85 ConnectionStringFactory.fromConfig(regConf, db_auth_path=temp_config.name) 

86 

87 

88if __name__ == "__main__": 

89 unittest.main()