Coverage for tests/test_logFormatter.py: 30%

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 ButlerLogRecordsFormatter.""" 

29 

30import logging 

31import os 

32import tempfile 

33import unittest 

34from logging import FileHandler 

35 

36from lsst.daf.butler import Butler, DatasetRef, DatasetType, FileDataset 

37from lsst.daf.butler.logging import ButlerLogRecordHandler, JsonLogFormatter 

38from lsst.daf.butler.tests.utils import makeTestTempDir, removeTestTempDir 

39 

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

41 

42 

43class ButlerLogRecordsFormatterTestCase(unittest.TestCase): 

44 """Test for ButlerLogRecords put/get.""" 

45 

46 def setUp(self): 

47 self.root = makeTestTempDir(TESTDIR) 

48 Butler.makeRepo(self.root) 

49 

50 self.run = "testrun" 

51 self.butler = Butler.from_config(self.root, run=self.run) 

52 self.datasetType = DatasetType("test_logs", [], "ButlerLogRecords", universe=self.butler.dimensions) 

53 

54 self.butler.registry.registerDatasetType(self.datasetType) 

55 

56 def tearDown(self): 

57 removeTestTempDir(self.root) 

58 

59 def testButlerLogRecordsFormatter(self): 

60 handler = ButlerLogRecordHandler() 

61 

62 log = logging.getLogger(self.id()) 

63 log.setLevel(logging.INFO) 

64 log.addHandler(handler) 

65 

66 log.info("An INFO message") 

67 log.debug("A DEBUG message") 

68 log.warning("A WARNING message") 

69 

70 ref = self.butler.put(handler.records, self.datasetType) 

71 records = self.butler.get(ref) 

72 

73 self.assertEqual(records, handler.records) 

74 self.assertEqual(len(records), 2) 

75 

76 def testJsonLogRecordsFormatter(self): 

77 """Test that externally created JSON format stream files work.""" 

78 log = logging.getLogger(self.id()) 

79 log.setLevel(logging.INFO) 

80 

81 tmp = tempfile.NamedTemporaryFile(mode="w", suffix=".json", prefix="butler-log-", delete=False) 

82 

83 handler = FileHandler(tmp.name) 

84 handler.setFormatter(JsonLogFormatter()) 

85 log.addHandler(handler) 

86 

87 log.info("An INFO message") 

88 log.debug("A DEBUG message") 

89 log.warning("A WARNING message") 

90 

91 handler.close() 

92 

93 # Now ingest the file. 

94 ref = DatasetRef(self.datasetType, dataId={}, run=self.run) 

95 dataset = FileDataset(path=tmp.name, refs=ref) 

96 self.butler.ingest(dataset, transfer="move") 

97 

98 records = self.butler.get(ref) 

99 self.assertEqual(len(records), 2) 

100 

101 

102if __name__ == "__main__": 

103 unittest.main()