Coverage for tests/test_connectionString.py: 40%
39 statements
« prev ^ index » next coverage.py v7.3.2, created at 2023-10-27 09:44 +0000
« prev ^ index » next coverage.py v7.3.2, created at 2023-10-27 09: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/>.
28"""Tests for ConnectionStringBuilder.
29"""
31import glob
32import os
33import os.path
34import unittest
36import lsst.daf.butler.registry.connectionString as ConnectionStringModule
37from lsst.daf.butler.registry import RegistryConfig
38from lsst.daf.butler.registry.connectionString import ConnectionStringFactory
39from lsst.utils.db_auth import DbAuthError
41TESTDIR = os.path.abspath(os.path.dirname(__file__))
44class ConnectionStringBuilderTestCase(unittest.TestCase):
45 """Tests for ConnectionStringBuilder."""
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")
51 def setUp(self):
52 self.resetDbAuthPathValue = ConnectionStringModule.DB_AUTH_PATH
53 ConnectionStringModule.DB_AUTH_PATH = self.credentialsFile
54 os.chmod(self.credentialsFile, 0o600)
56 def tearDown(self):
57 ConnectionStringModule.DB_AUTH_PATH = self.resetDbAuthPathValue
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]
63 conStrFactory = ConnectionStringFactory()
64 for regConf, fileName in zip(regConfigs, self.configFiles, strict=True):
65 conStr = conStrFactory.fromConfig(regConf)
66 with self.subTest(confFile=fileName):
67 self.assertEqual(
68 conStr.render_as_string(hide_password=False),
69 regConf["expected"],
70 "test connection string built from config",
71 )
73 def testRelVsAbsPath(self):
74 """Tests that relative and absolute paths are preserved."""
75 regConf = RegistryConfig(os.path.join(self.configDir, "registryConf1.yaml"))
76 regConf["db"] = "sqlite:///relative/path/conf1.sqlite3"
77 conStrFactory = ConnectionStringFactory()
78 conStr = conStrFactory.fromConfig(regConf)
79 self.assertEqual(str(conStr), "sqlite:///relative/path/conf1.sqlite3")
81 def testRaises(self):
82 """Test that DbAuthError propagates through the class."""
83 ConnectionStringModule.DB_AUTH_PATH = os.path.join(self.configDir, "badDbAuth2.yaml")
84 regConf = RegistryConfig(os.path.join(self.configDir, "registryConf2.yaml"))
85 conStrFactory = ConnectionStringFactory()
86 with self.assertRaises(DbAuthError):
87 conStrFactory.fromConfig(regConf)
90if __name__ == "__main__":
91 unittest.main()