Coverage for tests/test_matplotlibFormatter.py: 47%
39 statements
« prev ^ index » next coverage.py v7.4.4, created at 2024-04-05 02:53 -0700
« prev ^ index » next coverage.py v7.4.4, created at 2024-04-05 02:53 -0700
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 MatplotlibFormatter.
29"""
31import os
32import tempfile
33import unittest
34from random import Random
36try:
37 import matplotlib
39 matplotlib.use("Agg")
40 from matplotlib import pyplot
41except ImportError:
42 pyplot = None
44import filecmp
46from lsst.daf.butler import Butler, DatasetType
47from lsst.daf.butler.tests.utils import makeTestTempDir, removeTestTempDir
49TESTDIR = os.path.abspath(os.path.dirname(__file__))
52@unittest.skipIf(pyplot is None, "skipping test because matplotlib import failed")
53class MatplotlibFormatterTestCase(unittest.TestCase):
54 """Test for MatplotlibFormatter."""
56 RANDOM_SEED = 10
58 def setUp(self):
59 self.root = makeTestTempDir(TESTDIR)
60 Butler.makeRepo(self.root)
61 # Create a random image for testing
62 self.rng = Random(self.RANDOM_SEED)
64 def tearDown(self):
65 removeTestTempDir(self.root)
67 def testMatplotlibFormatter(self):
68 butler = Butler.from_config(self.root, run="testrun")
69 datasetType = DatasetType("test_plot", [], "Plot", universe=butler.dimensions)
70 butler.registry.registerDatasetType(datasetType)
71 # Does not have to be a random image
72 pyplot.imshow(
73 [
74 self.rng.sample(range(50), 10),
75 self.rng.sample(range(50), 10),
76 self.rng.sample(range(50), 10),
77 ]
78 )
79 ref = butler.put(pyplot.gcf(), datasetType)
80 uri = butler.getURI(ref)
82 # Following test needs a local file
83 with uri.as_local() as local, tempfile.NamedTemporaryFile(suffix=".png") as file:
84 pyplot.gcf().savefig(file.name)
85 self.assertTrue(filecmp.cmp(local.ospath, file.name, shallow=True))
86 self.assertTrue(butler.exists(ref))
87 with self.assertRaises(ValueError):
88 butler.get(ref)
89 butler.pruneDatasets([ref], unstore=True, purge=True)
90 self.assertFalse(butler.exists(ref))
93if __name__ == "__main__":
94 unittest.main()