Coverage for tests/test_connectionString.py: 100%

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 sqlalchemy.engine import make_url 

38 

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 temporaryCredentialsFile = self.enterContext(tempfile.NamedTemporaryFile()).name 

55 shutil.copyfile(self.credentialsFile, temporaryCredentialsFile) 

56 os.chmod(temporaryCredentialsFile, 0o600) 

57 self.db_auth_path = temporaryCredentialsFile 

58 

59 def testBuilder(self): 

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

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

62 

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

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

65 with self.subTest(confFile=fileName): 

66 self.assertEqual( 

67 conStr, 

68 make_url(regConf["expected"]), 

69 "test connection string built from config", 

70 ) 

71 

72 def testRelVsAbsPath(self): 

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

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

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

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

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

78 

79 def testRaises(self): 

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

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

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

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

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

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

86 with self.assertRaises(DbAuthError): 

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

88 

89 

90if __name__ == "__main__": 

91 unittest.main()