JAL-3438 spotless for 2.11.2.0
[jalview.git] / test / jalview / gui / PopupMenuTest.java
index 8f60021..7636bda 100644 (file)
@@ -24,26 +24,15 @@ import static jalview.util.UrlConstants.DB_ACCESSION;
 import static jalview.util.UrlConstants.SEQUENCE_ID;
 import static org.testng.AssertJUnit.assertEquals;
 import static org.testng.AssertJUnit.assertFalse;
+import static org.testng.AssertJUnit.assertNotNull;
+import static org.testng.AssertJUnit.assertNull;
 import static org.testng.AssertJUnit.assertTrue;
 
-import jalview.datamodel.AlignmentAnnotation;
-import jalview.datamodel.AlignmentI;
-import jalview.datamodel.Annotation;
-import jalview.datamodel.ColumnSelection;
-import jalview.datamodel.DBRefEntry;
-import jalview.datamodel.DBRefSource;
-import jalview.datamodel.HiddenColumns;
-import jalview.datamodel.Sequence;
-import jalview.datamodel.SequenceGroup;
-import jalview.datamodel.SequenceI;
-import jalview.io.DataSourceType;
-import jalview.io.FileFormat;
-import jalview.io.FormatAdapter;
-import jalview.util.MessageManager;
-
 import java.awt.Component;
+import java.awt.Container;
 import java.io.IOException;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.Iterator;
 import java.util.List;
 
@@ -56,6 +45,27 @@ import org.testng.annotations.BeforeClass;
 import org.testng.annotations.BeforeMethod;
 import org.testng.annotations.Test;
 
+import jalview.bin.Cache;
+import jalview.bin.Console;
+import jalview.datamodel.AlignmentAnnotation;
+import jalview.datamodel.AlignmentI;
+import jalview.datamodel.Annotation;
+import jalview.datamodel.ColumnSelection;
+import jalview.datamodel.DBRefEntry;
+import jalview.datamodel.DBRefSource;
+import jalview.datamodel.HiddenColumns;
+import jalview.datamodel.Sequence;
+import jalview.datamodel.SequenceFeature;
+import jalview.datamodel.SequenceGroup;
+import jalview.datamodel.SequenceI;
+import jalview.io.DataSourceType;
+import jalview.io.FileFormat;
+import jalview.io.FormatAdapter;
+import jalview.urls.api.UrlProviderFactoryI;
+import jalview.urls.desktop.DesktopUrlProviderFactory;
+import jalview.util.MessageManager;
+import jalview.util.UrlConstants;
+
 public class PopupMenuTest
 {
 
@@ -84,11 +94,29 @@ public class PopupMenuTest
   @BeforeMethod(alwaysRun = true)
   public void setUp() throws IOException
   {
+    Cache.loadProperties("test/jalview/io/testProps.jvprops");
+    Console.initLogger();
+
+    String inMenuString = ("EMBL-EBI Search | http://www.ebi.ac.uk/ebisearch/search.ebi?db=allebi&query=$"
+            + SEQUENCE_ID + "$" + "|"
+            + "UNIPROT | http://www.uniprot.org/uniprot/$" + DB_ACCESSION
+            + "$") + "|"
+            + ("INTERPRO | http://www.ebi.ac.uk/interpro/entry/$"
+                    + DB_ACCESSION + "$")
+            + "|" +
+            // Gene3D entry tests for case (in)sensitivity
+            ("Gene3D | http://gene3d.biochem.ucl.ac.uk/Gene3D/search?sterm=$"
+                    + DB_ACCESSION + "$&mode=protein");
+
+    UrlProviderFactoryI factory = new DesktopUrlProviderFactory(
+            UrlConstants.DEFAULT_LABEL, inMenuString, "");
+    Preferences.sequenceUrlLinks = factory.createUrlProvider();
+
     alignment = new FormatAdapter().readFile(TEST_DATA,
             DataSourceType.PASTE, FileFormat.Fasta);
     AlignFrame af = new AlignFrame(alignment, 700, 500);
     parentPanel = new AlignmentPanel(af, af.getViewport());
-    testee = new PopupMenu(parentPanel, null, null);
+    testee = new PopupMenu(parentPanel, alignment.getSequenceAt(0), null);
     int i = 0;
     for (SequenceI seq : alignment.getSequences())
     {
@@ -171,8 +199,9 @@ public class PopupMenuTest
     testee.configureReferenceAnnotationsMenu(menu, seqs);
     assertTrue(menu.isEnabled());
     String s = MessageManager.getString("label.add_annotations_for");
-    String expected = "<html><style> p.ttip {width: 350; text-align: justify; word-wrap: break-word;}</style><p class=\"ttip\">"
-            + s + "<br/>Jmol/secondary structure<br/>PDB/Temp</p></html>";
+    String expected = "<html><style> div.ttip {width:350px;white-space:pre-wrap;padding:2px;overflow-wrap:break-word;}</style>"
+            + "<div class=\"ttip\">" + s
+            + "<br/>Jmol/secondary structure<br/>PDB/Temp </div></html>";
     assertEquals(expected, menu.getToolTipText());
   }
 
@@ -194,8 +223,9 @@ public class PopupMenuTest
     testee.configureReferenceAnnotationsMenu(menu, seqs);
     assertTrue(menu.isEnabled());
     String s = MessageManager.getString("label.add_annotations_for");
-    String expected = "<html><style> p.ttip {width: 350; text-align: justify; word-wrap: break-word;}</style><p class=\"ttip\">"
-            + s + "<br/>Jmol/secondary structure<br/>PDB/Temp</p></html>";
+    String expected = "<html><style> div.ttip {width:350px;white-space:pre-wrap;padding:2px;overflow-wrap:break-word;}</style>"
+            + "<div class=\"ttip\">" + s
+            + "<br/>Jmol/secondary structure<br/>PDB/Temp </div></html>";
     assertEquals(expected, menu.getToolTipText());
   }
 
@@ -464,115 +494,102 @@ public class PopupMenuTest
   }
 
   /**
-   * Test for adding feature links
+   * Test for adding sequence id, dbref and feature links
    */
   @Test(groups = { "Functional" })
-  public void testAddFeatureLinks()
+  public void testBuildLinkMenu()
   {
-    // sequences from the alignment
     List<SequenceI> seqs = parentPanel.getAlignment().getSequences();
+    final SequenceI seq0 = seqs.get(0);
+    final SequenceI seq1 = seqs.get(1);
+    final List<SequenceFeature> noFeatures = Collections
+            .<SequenceFeature> emptyList();
+    final String linkText = MessageManager.getString("action.link");
+
+    seq0.addDBRef(new DBRefEntry(DBRefSource.UNIPROT, "1", "P83527"));
+    seq0.addDBRef(new DBRefEntry("INTERPRO", "1", "IPR001041"));
+    seq0.addDBRef(new DBRefEntry("INTERPRO", "1", "IPR012675"));
+    seq0.addDBRef(new DBRefEntry("INTERPRO", "1", "IPR006058"));
+    seq1.addDBRef(new DBRefEntry(DBRefSource.UNIPROT, "1", "Q9ZTS2"));
+    seq1.addDBRef(new DBRefEntry("GENE3D", "1", "3.10.20.30"));
 
-    // create list of links and list of DBRefs
-    List<String> links = new ArrayList<>();
-    List<DBRefEntry> refs = new ArrayList<>();
-
-    // links as might be added into Preferences | Connections dialog
-    links.add("EMBL-EBI Search | http://www.ebi.ac.uk/ebisearch/search.ebi?db=allebi&query=$"
-            + SEQUENCE_ID + "$");
-    links.add("UNIPROT | http://www.uniprot.org/uniprot/$" + DB_ACCESSION
-            + "$");
-    links.add("INTERPRO | http://www.ebi.ac.uk/interpro/entry/$"
-            + DB_ACCESSION + "$");
-    // Gene3D entry tests for case (in)sensitivity
-    links.add("Gene3D | http://gene3d.biochem.ucl.ac.uk/Gene3D/search?sterm=$"
-            + DB_ACCESSION + "$&mode=protein");
-
-    // make seq0 dbrefs
-    refs.add(new DBRefEntry(DBRefSource.UNIPROT, "1", "P83527"));
-    refs.add(new DBRefEntry("INTERPRO", "1", "IPR001041"));
-    refs.add(new DBRefEntry("INTERPRO", "1", "IPR006058"));
-    refs.add(new DBRefEntry("INTERPRO", "1", "IPR012675"));
-    
-    // make seq1 dbrefs
-    refs.add(new DBRefEntry(DBRefSource.UNIPROT, "1", "Q9ZTS2"));
-    refs.add(new DBRefEntry("GENE3D", "1", "3.10.20.30"));
-
-    // add all the dbrefs to the sequences: Uniprot 1 each, Interpro all 3 to
-    // seq0, Gene3D to seq1
-    seqs.get(0).addDBRef(refs.get(0));
-
-    seqs.get(0).addDBRef(refs.get(1));
-    seqs.get(0).addDBRef(refs.get(2));
-    seqs.get(0).addDBRef(refs.get(3));
-    
-    seqs.get(1).addDBRef(refs.get(4));
-    seqs.get(1).addDBRef(refs.get(5));
-    
-    // get the Popup Menu for first sequence
-    testee = new PopupMenu(parentPanel, (Sequence) seqs.get(0), links);
-    Component[] seqItems = testee.sequenceMenu.getMenuComponents();
-    JMenu linkMenu = (JMenu) seqItems[6];
+    /*
+     * check the Link Menu for the first sequence
+     */
+    JMenu linkMenu = PopupMenu.buildLinkMenu(seq0, noFeatures);
+    assertEquals(linkText, linkMenu.getText());
     Component[] linkItems = linkMenu.getMenuComponents();
-    
-    // check the number of links are the expected number
-    assertEquals(5, linkItems.length);
 
-    // first entry is EMBL-EBI which just uses sequence id not accession id?
+    /*
+     * menu items are ordered: SEQUENCE_ID search first, then dbrefs in order
+     * of database name (and within that by order of dbref addition)
+     */
+    assertEquals(5, linkItems.length);
     assertEquals("EMBL-EBI Search", ((JMenuItem) linkItems[0]).getText());
+    assertEquals("INTERPRO|IPR001041",
+            ((JMenuItem) linkItems[1]).getText());
+    assertEquals("INTERPRO|IPR012675",
+            ((JMenuItem) linkItems[2]).getText());
+    assertEquals("INTERPRO|IPR006058",
+            ((JMenuItem) linkItems[3]).getText());
+    assertEquals("UNIPROT|P83527", ((JMenuItem) linkItems[4]).getText());
 
-    // sequence id for each link should match corresponding DB accession id
-    for (int i = 1; i < 4; i++)
-    {
-      assertEquals(refs.get(i - 1).getSource(), ((JMenuItem) linkItems[i])
-              .getText().split("\\|")[0]);
-      assertEquals(refs.get(i - 1).getAccessionId(),
-              ((JMenuItem) linkItems[i])
-              .getText().split("\\|")[1]);
-    }
-
-    // get the Popup Menu for second sequence
-    testee = new PopupMenu(parentPanel, (Sequence) seqs.get(1), links);
-    seqItems = testee.sequenceMenu.getMenuComponents();
-    linkMenu = (JMenu) seqItems[6];
+    /*
+     * check the Link Menu for the second sequence
+     * note dbref GENE3D is matched to link Gene3D, the latter is displayed
+     */
+    linkMenu = PopupMenu.buildLinkMenu(seq1, noFeatures);
     linkItems = linkMenu.getMenuComponents();
-    
-    // check the number of links are the expected number
     assertEquals(3, linkItems.length);
-
-    // first entry is EMBL-EBI which just uses sequence id not accession id?
     assertEquals("EMBL-EBI Search", ((JMenuItem) linkItems[0]).getText());
+    assertEquals("Gene3D|3.10.20.30", ((JMenuItem) linkItems[1]).getText());
+    assertEquals("UNIPROT|Q9ZTS2", ((JMenuItem) linkItems[2]).getText());
 
-    // sequence id for each link should match corresponding DB accession id
-    for (int i = 1; i < 3; i++)
-    {
-      assertEquals(refs.get(i + 3).getSource(), ((JMenuItem) linkItems[i])
-              .getText().split("\\|")[0].toUpperCase());
-      assertEquals(refs.get(i + 3).getAccessionId(),
-              ((JMenuItem) linkItems[i]).getText().split("\\|")[1]);
-    }
+    /*
+     * if there are no valid links the Links submenu is still shown, but
+     * reduced to the EMBL-EBI lookup only (inserted by 
+     * CustomUrlProvider.choosePrimaryUrl())
+     */
+    String unmatched = "NOMATCH|http://www.uniprot.org/uniprot/$"
+            + DB_ACCESSION + "$";
+    UrlProviderFactoryI factory = new DesktopUrlProviderFactory(null,
+            unmatched, "");
+    Preferences.sequenceUrlLinks = factory.createUrlProvider();
 
-    // if there are no valid links the Links submenu is disabled
-    List<String> nomatchlinks = new ArrayList<>();
-    nomatchlinks.add("NOMATCH | http://www.uniprot.org/uniprot/$"
-            + DB_ACCESSION + "$");
+    linkMenu = PopupMenu.buildLinkMenu(seq1, noFeatures);
+    linkItems = linkMenu.getMenuComponents();
+    assertEquals(1, linkItems.length);
+    assertEquals("EMBL-EBI Search", ((JMenuItem) linkItems[0]).getText());
 
-    testee = new PopupMenu(parentPanel, (Sequence) seqs.get(0),
-            nomatchlinks);
-    seqItems = testee.sequenceMenu.getMenuComponents();
-    linkMenu = (JMenu) seqItems[6];
-    assertFalse(linkMenu.isEnabled());
+    /*
+     * if sequence is null, only feature links are shown (alignment popup submenu)
+     */
+    linkMenu = PopupMenu.buildLinkMenu(null, noFeatures);
+    linkItems = linkMenu.getMenuComponents();
+    assertEquals(0, linkItems.length);
 
+    List<SequenceFeature> features = new ArrayList<>();
+    SequenceFeature sf = new SequenceFeature("type", "desc", 1, 20, null);
+    features.add(sf);
+    linkMenu = PopupMenu.buildLinkMenu(null, features);
+    linkItems = linkMenu.getMenuComponents();
+    assertEquals(0, linkItems.length); // feature has no links
+
+    sf.addLink("Pfam family|http://pfam.xfam.org/family/PF00111");
+    linkMenu = PopupMenu.buildLinkMenu(null, features);
+    linkItems = linkMenu.getMenuComponents();
+    assertEquals(1, linkItems.length);
+    JMenuItem item = (JMenuItem) linkItems[0];
+    assertEquals("Pfam family", item.getText());
+    // ? no way to verify URL, compiled into link's actionListener
   }
 
-  /**
-   * Test for adding feature links
-   */
   @Test(groups = { "Functional" })
   public void testHideInsertions()
   {
     // get sequences from the alignment
     List<SequenceI> seqs = parentPanel.getAlignment().getSequences();
-    
+
     // add our own seqs to avoid problems with changes to existing sequences
     // (gap at end of sequences varies depending on how tests are run!)
     Sequence seqGap1 = new Sequence("GappySeq",
@@ -597,15 +614,15 @@ public class PopupMenuTest
             .revealAllHiddenColumns(sel);
 
     // get the Popup Menu for 7th sequence - no insertions
-    testee = new PopupMenu(parentPanel, (Sequence) seqs.get(7), null);
+    testee = new PopupMenu(parentPanel, seqs.get(7), null);
     testee.hideInsertions_actionPerformed(null);
-    
+
     HiddenColumns hidden = parentPanel.av.getAlignment().getHiddenColumns();
     Iterator<int[]> it = hidden.iterator();
     assertFalse(it.hasNext());
 
     // get the Popup Menu for GappySeq - this time we have insertions
-    testee = new PopupMenu(parentPanel, (Sequence) seqs.get(4), null);
+    testee = new PopupMenu(parentPanel, seqs.get(4), null);
     testee.hideInsertions_actionPerformed(null);
     hidden = parentPanel.av.getAlignment().getHiddenColumns();
     it = hidden.iterator();
@@ -655,7 +672,7 @@ public class PopupMenuTest
     hidden.hideColumns(31, 40);
 
     // get the Popup Menu for LessGappySeq in the sequence group
-    testee = new PopupMenu(parentPanel, (Sequence) seqs.get(5), null);
+    testee = new PopupMenu(parentPanel, seqs.get(5), null);
     testee.hideInsertions_actionPerformed(null);
     hidden = parentPanel.av.getAlignment().getHiddenColumns();
     it = hidden.iterator();
@@ -676,4 +693,74 @@ public class PopupMenuTest
     assertEquals(region[1], 34);
   }
 
+  @Test(groups = { "Functional" })
+  public void testAddFeatureDetails()
+  {
+    String menuText = MessageManager.getString("label.feature_details");
+
+    /*
+     * with no features, sub-menu should not be created
+     */
+    List<SequenceFeature> features = new ArrayList<>();
+    SequenceI seq = this.alignment.getSequenceAt(0); // FER_CAPAA/1-12
+    testee.addFeatureDetails(features, seq, 10);
+    JMenu menu = findMenu(testee, menuText);
+    assertNull(menu);
+
+    /*
+     * add some features; the menu item text is wrapped in html, and includes
+     * feature type, position, description, group (if not null)
+     */
+    SequenceFeature sf1 = new SequenceFeature("helix", "curly", 2, 6, null);
+    SequenceFeature sf2 = new SequenceFeature("chain", "straight", 1, 1,
+            "uniprot");
+    features.add(sf1);
+    features.add(sf2);
+    testee.addFeatureDetails(features, seq, 10);
+    menu = findMenu(testee, menuText);
+    assertNotNull(menu);
+    assertEquals(2, menu.getItemCount());
+    JMenuItem item = menu.getItem(0);
+    assertEquals("<html>helix 2-6 curly</html>", item.getText());
+    item = menu.getItem(1);
+    assertEquals("<html>chain 1 straight (uniprot)</html>", item.getText());
+
+    /*
+     * long feature descriptions are truncated to 40 characters
+     */
+    sf1.setDescription("this is a quite extraordinarily long description");
+    testee.remove(menu); // don't create the sub-menu twice
+    testee.addFeatureDetails(features, seq, 10);
+    menu = findMenu(testee, menuText);
+    item = menu.getItem(0);
+    assertEquals(
+            "<html>helix 2-6 this is a quite extraordinarily long des...</html>",
+            item.getText());
+  }
+
+  /**
+   * Returns the first component which is a JMenu with the given text
+   * 
+   * @param c
+   * @param text
+   * @return
+   */
+  private JMenu findMenu(Container c, String text)
+  {
+    for (int i = 0; i < c.getComponentCount(); i++)
+    {
+      Component comp = c.getComponent(i);
+      if ((comp instanceof JMenu) && ((JMenu) comp).getText().equals(text))
+      {
+        return (JMenu) comp;
+      }
+    }
+    return null;
+  }
+
+  @Test(groups = { "Functional" })
+  public void testAddFeatureDetails_linkedFeatures()
+  {
+    // todo tests that verify menu items for complement features
+  }
 }