WebAgg: Add test for the toolbar

QuLogic · QuLogic · commit 361f9d6f5689 · 2024-05-17T17:18:26.000-04:00
diff --git a/lib/matplotlib/tests/test_backend_webagg.py b/lib/matplotlib/tests/test_backend_webagg.py
@@ -2,6 +2,7 @@
 import shutil
 import subprocess
 import sys
+import warnings
 
 import pytest
 
@@ -71,11 +72,6 @@ def test_webagg_general(page):
     # Check title.
     expect(page.locator('div.ui-dialog-title')).to_have_text('Figure 1')
 
-    # Check toolbar buttons.
-    assert page.locator('button.mpl-widget').count() == len([
-        name for name, *_ in fig.canvas.manager.ToolbarCls.toolitems
-        if name is not None])
-
     # Check canvas actually contains something.
     baseline_dir, result_dir = _image_directories(test_webagg_general)
     browser = page.context.browser.browser_type.name
@@ -89,3 +85,65 @@ def test_webagg_general(page):
     err = compare_images(expected, actual, tol=0)
     if err:
         raise ImageComparisonFailure(err)
+
+
+@pytest.mark.backend('webagg')
+@pytest.mark.parametrize('toolbar', ['toolbar2', 'toolmanager'])
+def test_webagg_toolbar(page, toolbar):
+    from playwright.sync_api import expect
+
+    # Listen for all console logs.
+    page.on('console', lambda msg: print(f'CONSOLE: {msg.text}'))
+
+    with warnings.catch_warnings():
+        warnings.filterwarnings('ignore', message='Treat the new Tool classes',
+                                category=UserWarning)
+        plt.rcParams['toolbar'] = toolbar
+
+    fig, ax = plt.subplots(facecolor='w')
+
+    # Don't start the Tornado event loop, but use the existing event loop
+    # started by the `page` fixture.
+    WebAggApplication.initialize()
+    WebAggApplication.started = True
+
+    page.goto(f'http://{WebAggApplication.address}:{WebAggApplication.port}/')
+
+    expect(page.locator('button.mpl-widget')).to_have_count(
+        len([
+            name for name, *_ in fig.canvas.manager.ToolbarCls.toolitems
+            if name is not None]))
+
+    home = page.locator('button.mpl-widget').nth(0)
+    expect(home).to_be_visible()
+
+    back = page.locator('button.mpl-widget').nth(1)
+    expect(back).to_be_visible()
+    forward = page.locator('button.mpl-widget').nth(2)
+    expect(forward).to_be_visible()
+    if toolbar == 'toolbar2':
+        # ToolManager doesn't implement history button disabling.
+        # https://github.com/matplotlib/matplotlib/issues/17979
+        expect(back).to_be_disabled()
+        expect(forward).to_be_disabled()
+
+    pan = page.locator('button.mpl-widget').nth(3)
+    expect(pan).to_be_visible()
+    zoom = page.locator('button.mpl-widget').nth(4)
+    expect(zoom).to_be_visible()
+
+    save = page.locator('button.mpl-widget').nth(5)
+    expect(save).to_be_visible()
+    format_dropdown = page.locator('select.mpl-widget')
+    expect(format_dropdown).to_be_visible()
+
+    if toolbar == 'toolmanager':
+        # Location in status bar is not supported by ToolManager.
+        return
+
+    ax.set_position([0, 0, 1, 1])
+    bbox = page.locator('canvas.mpl-canvas').bounding_box()
+    x, y = bbox['x'] + bbox['width'] / 2, bbox['y'] + bbox['height'] / 2
+    page.mouse.move(x, y, steps=2)
+    message = page.locator('span.mpl-message')
+    expect(message).to_have_text('x=0.500 y=0.500')
