test_plotting.py

import os
import unittest

import requests
from six.moves import range

from utilities.utilities import g, load_config_if_not_already_loaded, retry_on_failure

MAX_FIGURES = 3


class TestPlotting(unittest.TestCase):
    """
    It is very hard to write "comprehensive" unit tests for our integration layer with matplotlib

    Instead, we write a handful of "smoke tests" to check that it isn't throwing any hugely obvious exceptions
    """

    PYPLOT = None

    @classmethod
    def setUpClass(cls):
        """
        This sets up genie python start command as in the gui
        (uk.ac.stfc.isis.ibex.ui.scripting.Commands.GENIE_INITIALISATION)
        It must be done before the first call to matplotlib because once that is called the backend can not be changed

        THE ORDER OF THESE ITEMS IS IMPORTANT! matplotlib.use must be before matplotlib.pyplot
        (not applicable here but more generally before matplotlib.backends too)
        """
        g.set_instrument(os.getenv("MYPVPREFIX"))

        # all tests that interact with anything but genie should try to load a config to ensure that the configurations
        # in the tests are not broken, e.g. by a schema update
        load_config_if_not_already_loaded("empty_for_system_tests")

        import matplotlib

        matplotlib.use("module://genie_python.matplotlib_backend.ibex_websocket_backend")
        import matplotlib.pyplot as pyplot

        TestPlotting.PYPLOT = pyplot

    def setUp(self):
        TestPlotting.PYPLOT.close("all")

    def assert_webserver_up(self):
        web_response = requests.get("http://127.0.0.1:8988/")
        self.assertEqual(web_response.status_code, 200)

    @retry_on_failure(3)
    def test_GIVEN_spectra_plot_THEN_no_exceptions_thrown(self):
        g.begin()
        try:
            g.plot_spectrum(1)
            self.assert_webserver_up()
        finally:
            g.end()

    @retry_on_failure(3)
    def test_GIVEN_spectra_plot_WHEN_adding_more_traces_THEN_no_exceptions_thrown(self):
        g.begin()
        try:
            p = g.plot_spectrum(1)
            p.add_spectrum(2)
            p.add_spectrum(3, period=2)
            self.assert_webserver_up()
        finally:
            g.end()

    @retry_on_failure(3)
    def test_GIVEN_when_plot_exists_WHEN_connect_to_matplotlib_server_THEN_response_is_http_200_ok(
        self,
    ):
        TestPlotting.PYPLOT.plot(range(5))
        TestPlotting.PYPLOT.show()
        self.assert_webserver_up()

    @retry_on_failure(3)
    def test_WHEN_seven_spectra_added_THEN_six_figures_exist(self):
        g.begin()
        try:
            import matplotlib.pyplot as p

            for i in range(7):
                g.plot_spectrum(1)

            self.assertEqual(MAX_FIGURES, len(p.get_fignums()))
        finally:
            g.end()

    @retry_on_failure(3)
    def test_WHEN_seven_figures_added_THEN_six_figures_exist(self):
        g.begin()
        try:
            import matplotlib.pyplot as p

            for i in range(7):
                p.figure(i)

            self.assertEqual(MAX_FIGURES, len(p.get_fignums()))
        finally:
            g.end()

    @retry_on_failure(3)
    def test_WHEN_eight_reverse_numbered_figures_added_THEN_newest_six_exist(self):
        g.begin()
        try:
            import matplotlib.pyplot as p

            for i in range(8, 0, -1):
                p.figure(i)

            self.assertEqual([1, 2, 3], p.get_fignums())
        finally:
            g.end()