Coverage for tests / test__file__.py: 23%

1# This file is part of pex_config. 

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 

28import os 

29import unittest 

30 

31import lsst.pex.config as pexConf 

32from lsst.resources import ResourcePath 

33 

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

35 

36 

37class FileConfig(pexConf.Config): 

38 """Config used for testing __file__.""" 

39 

40 number = pexConf.Field("FileConfig.number", int, default=0) 

41 filename = pexConf.Field("FileConfig.filename", str, default=None) 

42 

43 

44class FilenameTestCase(unittest.TestCase): 

45 """Check that __file__ can be used in a config file.""" 

46 

47 def test__file(self): 

48 fileUri = ResourcePath(f"{TESTDIR}/config/filename.py", forceAbsolute=True, forceDirectory=False) 

49 for confFile in (os.path.join(TESTDIR, "config", "filename.py"), fileUri, str(fileUri)): 

50 c = FileConfig() 

51 c.load(confFile) 

52 # The __file__ is always the ospath form. 

53 self.assertEqual(c.filename, os.path.join(TESTDIR, "config", "filename.py")) 

54 self.assertEqual(c.number, 5) 

55 

56 c = FileConfig() 

57 with fileUri.open("r") as fh: 

58 c.loadFromStream(fh) 

59 self.assertEqual(c.filename, os.path.join(TESTDIR, "config", "filename.py")) 

60 self.assertEqual(c.number, 5) 

61 

62 c = FileConfig() 

63 data = fileUri.read() 

64 c.loadFromString(data) 

65 self.assertEqual(c.filename, "<unknown>") 

66 

67 c.loadFromString(data, filename=fileUri.ospath) 

68 self.assertEqual(c.filename, fileUri.ospath) 

69 

70 c = FileConfig() 

71 with self.assertRaises(ValueError): 

72 # Use mem scheme because we do not support it for config 

73 # loading and it does not require additional dependencies 

74 # such as requests or boto3 to be available. 

75 c.load("mem://not_there.py") 

76 

77 def test_relative(self): 

78 fileUri = ResourcePath(f"{TESTDIR}/config/relfilename.py", forceAbsolute=True, forceDirectory=False) 

79 for confFile in (os.path.join(TESTDIR, "config", "relfilename.py"), fileUri, str(fileUri)): 

80 c = FileConfig() 

81 c.load(confFile) 

82 # The __file__ is always the ospath form and should be the file 

83 # loaded by the config. 

84 self.assertEqual(c.filename, os.path.join(TESTDIR, "config", "filename.py")) 

85 self.assertEqual(c.number, 5) 

86 

87 c = FileConfig() 

88 with fileUri.open("r") as fh: 

89 c.loadFromStream(fh) 

90 self.assertEqual(c.filename, os.path.join(TESTDIR, "config", "filename.py")) 

91 self.assertEqual(c.number, 5) 

92 

93 c = FileConfig() 

94 data = fileUri.read() 

95 with self.assertRaises(FileNotFoundError): 

96 c.loadFromString(data) 

97 

98 c.loadFromString(data, filename=fileUri.ospath) 

99 self.assertEqual(c.filename, os.path.join(TESTDIR, "config", "filename.py")) 

100 

101 

102if __name__ == "__main__": 102 ↛ 103line 102 didn't jump to line 103 because the condition on line 102 was never true

103 unittest.main()