Coverage for tests / test_matplotlibFormatter.py: 42%

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

29 

30import os 

31import tempfile 

32import unittest 

33from random import Random 

34 

35try: 

36 import matplotlib 

37 

38 matplotlib.use("Agg") 

39 from matplotlib import pyplot 

40except ImportError: 

41 pyplot = None 

42 

43import filecmp 

44 

45from lsst.daf.butler import Butler, DatasetType 

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

47 

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

49 

50 

51@unittest.skipIf(pyplot is None, "skipping test because matplotlib import failed") 

52class MatplotlibFormatterTestCase(unittest.TestCase): 

53 """Test for MatplotlibFormatter.""" 

54 

55 RANDOM_SEED = 10 

56 

57 def setUp(self): 

58 self.root = makeTestTempDir(TESTDIR) 

59 Butler.makeRepo(self.root) 

60 # Create a random image for testing 

61 self.rng = Random(self.RANDOM_SEED) 

62 

63 def tearDown(self): 

64 removeTestTempDir(self.root) 

65 

66 def testMatplotlibFormatter(self): 

67 self.doMatplotlibTest() 

68 

69 def testMatplotlibFormatterWithMetadata(self): 

70 self.doMatplotlibTest(metadata={"test": "123"}) 

71 

72 def doMatplotlibTest(self, metadata=None): 

73 butler = Butler.from_config(self.root, run="testrun") 

74 self.enterContext(butler) 

75 datasetType = DatasetType("test_plot", [], "Plot", universe=butler.dimensions) 

76 butler.registry.registerDatasetType(datasetType) 

77 # Does not have to be a random image 

78 pyplot.imshow( 

79 [ 

80 self.rng.sample(range(50), 10), 

81 self.rng.sample(range(50), 10), 

82 self.rng.sample(range(50), 10), 

83 ] 

84 ) 

85 plot_figure = pyplot.gcf() 

86 

87 if metadata: 

88 plot_figure.metadata = metadata 

89 ref = butler.put(plot_figure, datasetType) 

90 uri = butler.getURI(ref) 

91 

92 # Following test needs a local file 

93 with uri.as_local() as local, tempfile.NamedTemporaryFile(suffix=".png") as file: 

94 pyplot.gcf().savefig(file.name, metadata=metadata) 

95 self.assertTrue(filecmp.cmp(local.ospath, file.name, shallow=True)) 

96 self.assertTrue(butler.exists(ref)) 

97 with self.assertRaises(ValueError): 

98 butler.get(ref) 

99 butler.pruneDatasets([ref], unstore=True, purge=True) 

100 self.assertFalse(butler.exists(ref)) 

101 

102 

103if __name__ == "__main__": 

104 unittest.main()