Add legend to spectrum plot and automation coverage. (#1012)

Author: labkey-klum

signalData/resources/web/signaldata/QCView/SpectrumPlot.js

@@ -51,8 +51,8 @@ Ext4.define('LABKEY.SignalData.SpectrumPlot', {
         }
 
         var layers = [];
+        var legendData = [];
         var colors = this.colors;
-
         var xleft = this.leftRight[0], xright = this.leftRight[1],
                 low = this.lowHigh[0], high = this.lowHigh[1];
 
@@ -84,6 +84,10 @@ Ext4.define('LABKEY.SignalData.SpectrumPlot', {
             c++;
 
             layers.push(pointLayer);
+            legendData.push({
+                text: contents[i].runName,
+                color: color
+            });
         }
 
         this.update('');
@@ -101,7 +105,11 @@ Ext4.define('LABKEY.SignalData.SpectrumPlot', {
             width: width,
             height: height,
             layers: layers,
-            legendPos: 'none',
+            legendPos: 'right',
+            legendData: legendData,
+            margins: {
+                right: 200
+            },
             labels: {
                 x: {value: this.xLabel},
                 y: {value: this.yLabel}

signalData/test/src/org/labkey/test/tests/signaldata/SignalDataRawTest.java

@@ -25,14 +25,14 @@
 import org.labkey.test.BaseWebDriverTest;
 import org.labkey.test.Locator;
 import org.labkey.test.categories.Daily;
+import org.labkey.test.components.ext4.Window;
 import org.labkey.test.pages.ReactAssayDesignerPage;
 import org.labkey.test.pages.signaldata.SignalDataAssayBeginPage;
 import org.labkey.test.pages.signaldata.SignalDataRunViewerPage;
 import org.labkey.test.pages.signaldata.SignalDataUploadPage;
 import org.labkey.test.params.FieldDefinition;
 import org.labkey.test.util.DataRegionTable;
 import org.labkey.test.util.Ext4Helper;
-import org.labkey.test.components.ext4.Window;
 import org.labkey.test.util.PostgresOnlyTest;
 import org.labkey.test.util.data.TestDataUtils;
 import org.labkey.test.util.signaldata.SignalDataInitializer;
@@ -47,6 +47,7 @@
 
 import static org.junit.Assert.assertArrayEquals;
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
 
 @Category({Daily.class})
 public class SignalDataRawTest extends BaseWebDriverTest implements PostgresOnlyTest
@@ -128,6 +129,40 @@ public void testRunViewer()
         assertEquals("Wrong number of lines in plot", 2, plotLines.size());
     }
 
+    @Test
+    public void testSpectrumPlotLegend()
+    {
+        List<String> filenames = List.of(RESULT_FILENAME_1, RESULT_FILENAME_2, RESULT_FILENAME_3);
+        List<String> expectedRunNames = filenames.stream().map(this::resultNameFromFilename).toList();
+
+        log("Select " + filenames.size() + " runs for the spectrum plot");
+        SignalDataAssayBeginPage beginPage = navigateToAssayLandingPage(SignalDataInitializer.RAW_SignalData_ASSAY);
+        for (String filename : filenames)
+            beginPage.selectData(filename, DEFAULT_RUN);
+
+        SignalDataRunViewerPage runsPage = beginPage.viewRuns();
+        for (String runName : expectedRunNames)
+            runsPage.checkRunViewerCheckbox(runName);
+
+        WebElement plotEl = runsPage.showPlot();
+
+        log("Verify one plotted line per run");
+        List<WebElement> plotLines = Locator.tagWithClass("path", "line").findElements(plotEl);
+        assertEquals("Wrong number of lines in spectrum plot", filenames.size(), plotLines.size());
+
+        log("Verify legend renders with one item per run");
+        List<WebElement> legendItems = Locator.tagWithClass("g", "legend-item").findElements(plotEl);
+        assertEquals("Wrong number of legend items in spectrum plot", filenames.size(), legendItems.size());
+
+        log("Verify legend labels match run names");
+        List<String> legendLabels = Locator.tag("tspan").findElements(plotEl).stream()
+                .map(WebElement::getText)
+                .filter(t -> !t.isBlank())
+                .toList();
+        assertTrue("Legend labels " + legendLabels + " do not contain all expected run names " + expectedRunNames,
+                legendLabels.containsAll(expectedRunNames));
+    }
+
     private String resultNameFromFilename(String filename)
     {
         //Trim extension