JAL-2744 refactor PopupMenu constructor to enable adding feature details
[jalview.git] / test / jalview / gui / PopupMenuTest.java
index 82fcbc8..40e624d 100644 (file)
@@ -1,20 +1,51 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
 package jalview.gui;
 
+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.assertTrue;
 
+import jalview.bin.Cache;
 import jalview.datamodel.AlignmentAnnotation;
 import jalview.datamodel.AlignmentI;
 import jalview.datamodel.Annotation;
+import jalview.datamodel.DBRefEntry;
+import jalview.datamodel.DBRefSource;
+import jalview.datamodel.SequenceFeature;
 import jalview.datamodel.SequenceI;
-import jalview.io.AppletFormatAdapter;
+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;
 
 import java.awt.Component;
 import java.io.IOException;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 
 import javax.swing.JMenu;
@@ -22,11 +53,20 @@ import javax.swing.JMenuItem;
 import javax.swing.JPopupMenu;
 import javax.swing.JSeparator;
 
+import org.testng.annotations.BeforeClass;
 import org.testng.annotations.BeforeMethod;
 import org.testng.annotations.Test;
 
 public class PopupMenuTest
 {
+
+  @BeforeClass(alwaysRun = true)
+  public void setUpJvOptionPane()
+  {
+    JvOptionPane.setInteractiveMode(false);
+    JvOptionPane.setMockResponse(JvOptionPane.CANCEL_OPTION);
+  }
+
   // 4 sequences x 13 positions
   final static String TEST_DATA = ">FER_CAPAA Ferredoxin\n"
           + "TIETHKEAELVG-\n"
@@ -42,26 +82,45 @@ public class PopupMenuTest
 
   PopupMenu testee = null;
 
- @BeforeMethod(alwaysRun = true)
+  @BeforeMethod(alwaysRun = true)
   public void setUp() throws IOException
   {
+    Cache.loadProperties("test/jalview/io/testProps.jvprops");
+    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,
-            AppletFormatAdapter.PASTE, "FASTA");
+            DataSourceType.PASTE, FileFormat.Fasta);
     AlignFrame af = new AlignFrame(alignment, 700, 500);
     parentPanel = new AlignmentPanel(af, af.getViewport());
     testee = new PopupMenu(parentPanel, null, null);
     int i = 0;
     for (SequenceI seq : alignment.getSequences())
     {
-      final AlignmentAnnotation annotation = new AlignmentAnnotation("label" + i,
-              "desc" + i, i);
+      final AlignmentAnnotation annotation = new AlignmentAnnotation(
+              "label" + i, "desc" + i, i);
       annotation.setCalcId("calcId" + i);
       seq.addAlignmentAnnotation(annotation);
       annotation.setSequenceRef(seq);
     }
   }
 
-  @Test(groups ={ "Functional" })
+  @Test(groups = { "Functional" })
   public void testConfigureReferenceAnnotationsMenu_noSequenceSelected()
   {
     JMenuItem menu = new JMenuItem();
@@ -79,7 +138,7 @@ public class PopupMenuTest
    * are no reference annotations to add to the alignment. The menu item should
    * be disabled.
    */
-  @Test(groups ={ "Functional" })
+  @Test(groups = { "Functional" })
   public void testConfigureReferenceAnnotationsMenu_noReferenceAnnotations()
   {
     JMenuItem menu = new JMenuItem();
@@ -100,7 +159,7 @@ public class PopupMenuTest
    * reference annotations are already on the alignment. The menu item should be
    * disabled.
    */
-  @Test(groups ={ "Functional" })
+  @Test(groups = { "Functional" })
   public void testConfigureReferenceAnnotationsMenu_alreadyAdded()
   {
     JMenuItem menu = new JMenuItem();
@@ -120,7 +179,7 @@ public class PopupMenuTest
    * The menu item should be enabled, and acquire a tooltip which lists the
    * annotation sources (calcIds) and type (labels).
    */
-  @Test(groups ={ "Functional" })
+  @Test(groups = { "Functional" })
   public void testConfigureReferenceAnnotationsMenu()
   {
     JMenuItem menu = new JMenuItem();
@@ -143,7 +202,7 @@ public class PopupMenuTest
    * on the alignment. The menu item should be enabled, and acquire a tooltip
    * which lists the annotation sources (calcIds) and type (labels).
    */
-  @Test(groups ={ "Functional" })
+  @Test(groups = { "Functional" })
   public void testConfigureReferenceAnnotationsMenu_notOnAlignment()
   {
     JMenuItem menu = new JMenuItem();
@@ -224,7 +283,7 @@ public class PopupMenuTest
    * The menu item should be enabled, and acquire a tooltip which lists the
    * annotation sources (calcIds) and type (labels).
    */
-  @Test(groups ={ "Functional" })
+  @Test(groups = { "Functional" })
   public void testConfigureReferenceAnnotationsMenu_twoViews()
   {
   }
@@ -233,7 +292,7 @@ public class PopupMenuTest
    * Test for building menu options including 'show' and 'hide' annotation
    * types.
    */
-  @Test(groups ={ "Functional" })
+  @Test(groups = { "Functional" })
   public void testBuildAnnotationTypesMenus()
   {
     JMenu showMenu = new JMenu();
@@ -244,32 +303,29 @@ public class PopupMenuTest
 
     // PDB.secondary structure on Sequence0
     AlignmentAnnotation annotation = new AlignmentAnnotation(
-            "secondary structure", "", new Annotation[]
-                    {});
+            "secondary structure", "", new Annotation[] {});
     annotation.setCalcId("PDB");
     annotation.visible = true;
     seqs.get(0).addAlignmentAnnotation(annotation);
     parentPanel.getAlignment().addAnnotation(annotation);
 
     // JMOL.secondary structure on Sequence0 - hidden
-    annotation = new AlignmentAnnotation("secondary structure", "", new Annotation[]
-            {});
+    annotation = new AlignmentAnnotation("secondary structure", "",
+            new Annotation[] {});
     annotation.setCalcId("JMOL");
     annotation.visible = false;
     seqs.get(0).addAlignmentAnnotation(annotation);
     parentPanel.getAlignment().addAnnotation(annotation);
 
     // Jpred.SSP on Sequence0 - hidden
-    annotation = new AlignmentAnnotation("SSP", "", new Annotation[]
-            {});
+    annotation = new AlignmentAnnotation("SSP", "", new Annotation[] {});
     annotation.setCalcId("JPred");
     annotation.visible = false;
     seqs.get(0).addAlignmentAnnotation(annotation);
     parentPanel.getAlignment().addAnnotation(annotation);
 
     // PDB.Temp on Sequence1
-    annotation = new AlignmentAnnotation("Temp", "", new Annotation[]
-            {});
+    annotation = new AlignmentAnnotation("Temp", "", new Annotation[] {});
     annotation.setCalcId("PDB");
     annotation.visible = true;
     seqs.get(1).addAlignmentAnnotation(annotation);
@@ -289,8 +345,8 @@ public class PopupMenuTest
 
     assertEquals(4, showOptions.length); // includes 'All' and separator
     assertEquals(4, hideOptions.length);
-    assertEquals("All",
-            ((JMenuItem) showOptions[0]).getText());
+    String all = MessageManager.getString("label.all");
+    assertEquals(all, ((JMenuItem) showOptions[0]).getText());
     assertTrue(showOptions[1] instanceof JPopupMenu.Separator);
     assertEquals(JSeparator.HORIZONTAL,
             ((JSeparator) showOptions[1]).getOrientation());
@@ -300,8 +356,7 @@ public class PopupMenuTest
     assertEquals("SSP", ((JMenuItem) showOptions[3]).getText());
     assertEquals("JPred", ((JMenuItem) showOptions[3]).getToolTipText());
 
-    assertEquals("All",
-            ((JMenuItem) hideOptions[0]).getText());
+    assertEquals(all, ((JMenuItem) hideOptions[0]).getText());
     assertTrue(hideOptions[1] instanceof JPopupMenu.Separator);
     assertEquals(JSeparator.HORIZONTAL,
             ((JSeparator) hideOptions[1]).getOrientation());
@@ -315,7 +370,7 @@ public class PopupMenuTest
   /**
    * Test for building menu options with only 'hide' annotation types enabled.
    */
-  @Test(groups ={ "Functional" })
+  @Test(groups = { "Functional" })
   public void testBuildAnnotationTypesMenus_showDisabled()
   {
     JMenu showMenu = new JMenu();
@@ -326,16 +381,14 @@ public class PopupMenuTest
 
     // PDB.secondary structure on Sequence0
     AlignmentAnnotation annotation = new AlignmentAnnotation(
-            "secondary structure", "", new Annotation[]
-            {});
+            "secondary structure", "", new Annotation[] {});
     annotation.setCalcId("PDB");
     annotation.visible = true;
     seqs.get(0).addAlignmentAnnotation(annotation);
     parentPanel.getAlignment().addAnnotation(annotation);
 
     // PDB.Temp on Sequence1
-    annotation = new AlignmentAnnotation("Temp", "", new Annotation[]
-    {});
+    annotation = new AlignmentAnnotation("Temp", "", new Annotation[] {});
     annotation.setCalcId("PDB");
     annotation.visible = true;
     seqs.get(1).addAlignmentAnnotation(annotation);
@@ -355,12 +408,13 @@ public class PopupMenuTest
 
     assertEquals(2, showOptions.length); // includes 'All' and separator
     assertEquals(4, hideOptions.length);
-    assertEquals("All", ((JMenuItem) showOptions[0]).getText());
+    String all = MessageManager.getString("label.all");
+    assertEquals(all, ((JMenuItem) showOptions[0]).getText());
     assertTrue(showOptions[1] instanceof JPopupMenu.Separator);
     assertEquals(JSeparator.HORIZONTAL,
             ((JSeparator) showOptions[1]).getOrientation());
 
-    assertEquals("All", ((JMenuItem) hideOptions[0]).getText());
+    assertEquals(all, ((JMenuItem) hideOptions[0]).getText());
     assertTrue(hideOptions[1] instanceof JPopupMenu.Separator);
     assertEquals(JSeparator.HORIZONTAL,
             ((JSeparator) hideOptions[1]).getOrientation());
@@ -374,7 +428,7 @@ public class PopupMenuTest
   /**
    * Test for building menu options with only 'show' annotation types enabled.
    */
-  @Test(groups ={ "Functional" })
+  @Test(groups = { "Functional" })
   public void testBuildAnnotationTypesMenus_hideDisabled()
   {
     JMenu showMenu = new JMenu();
@@ -385,16 +439,14 @@ public class PopupMenuTest
 
     // PDB.secondary structure on Sequence0
     AlignmentAnnotation annotation = new AlignmentAnnotation(
-            "secondary structure", "", new Annotation[]
-            {});
+            "secondary structure", "", new Annotation[] {});
     annotation.setCalcId("PDB");
     annotation.visible = false;
     seqs.get(0).addAlignmentAnnotation(annotation);
     parentPanel.getAlignment().addAnnotation(annotation);
 
     // PDB.Temp on Sequence1
-    annotation = new AlignmentAnnotation("Temp", "", new Annotation[]
-    {});
+    annotation = new AlignmentAnnotation("Temp", "", new Annotation[] {});
     annotation.setCalcId("PDB2");
     annotation.visible = false;
     seqs.get(1).addAlignmentAnnotation(annotation);
@@ -414,7 +466,8 @@ public class PopupMenuTest
 
     assertEquals(4, showOptions.length); // includes 'All' and separator
     assertEquals(2, hideOptions.length);
-    assertEquals("All", ((JMenuItem) showOptions[0]).getText());
+    String all = MessageManager.getString("label.all");
+    assertEquals(all, ((JMenuItem) showOptions[0]).getText());
     assertTrue(showOptions[1] instanceof JPopupMenu.Separator);
     assertEquals(JSeparator.HORIZONTAL,
             ((JSeparator) showOptions[1]).getOrientation());
@@ -424,9 +477,116 @@ public class PopupMenuTest
     assertEquals("Temp", ((JMenuItem) showOptions[3]).getText());
     assertEquals("PDB2", ((JMenuItem) showOptions[3]).getToolTipText());
 
-    assertEquals("All", ((JMenuItem) hideOptions[0]).getText());
+    assertEquals(all, ((JMenuItem) hideOptions[0]).getText());
     assertTrue(hideOptions[1] instanceof JPopupMenu.Separator);
     assertEquals(JSeparator.HORIZONTAL,
             ((JSeparator) hideOptions[1]).getOrientation());
   }
+
+  /**
+   * Test for adding feature links
+   */
+  @Test(groups = { "Functional" })
+  public void testAddFeatureLinks()
+  {
+    // sequences from the alignment
+    List<SequenceI> seqs = parentPanel.getAlignment().getSequences();
+
+    // create list of links and list of DBRefs
+    List<String> links = new ArrayList<String>();
+    List<DBRefEntry> refs = new ArrayList<DBRefEntry>();
+
+    // 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
+    SequenceI seq = seqs.get(0);
+    seq.addDBRef(refs.get(0));
+
+    seq.addDBRef(refs.get(1));
+    seq.addDBRef(refs.get(2));
+    seq.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
+    List<SequenceFeature> noFeatures = Collections.<SequenceFeature> emptyList();
+    testee = new PopupMenu(parentPanel, seq, noFeatures);
+    Component[] seqItems = testee.sequenceMenu.getMenuComponents();
+    JMenu linkMenu = (JMenu) seqItems[6];
+    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?
+    assertEquals("EMBL-EBI Search", ((JMenuItem) linkItems[0]).getText());
+
+    // sequence id for each link should match corresponding DB accession id
+    for (int i = 1; i < 4; i++)
+    {
+      String msg = seq.getName() + " link[" + i + "]";
+      assertEquals(msg, refs.get(i - 1).getSource(),
+              ((JMenuItem) linkItems[i])
+              .getText().split("\\|")[0]);
+      assertEquals(msg, refs.get(i - 1).getAccessionId(),
+              ((JMenuItem) linkItems[i])
+              .getText().split("\\|")[1]);
+    }
+
+    // get the Popup Menu for second sequence
+    seq = seqs.get(1);
+    testee = new PopupMenu(parentPanel, seq, noFeatures);
+    seqItems = testee.sequenceMenu.getMenuComponents();
+    linkMenu = (JMenu) seqItems[6];
+    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());
+
+    // sequence id for each link should match corresponding DB accession id
+    for (int i = 1; i < 3; i++)
+    {
+      String msg = seq.getName() + " link[" + i + "]";
+      assertEquals(msg, refs.get(i + 3).getSource(),
+              ((JMenuItem) linkItems[i])
+              .getText().split("\\|")[0].toUpperCase());
+      assertEquals(msg, refs.get(i + 3).getAccessionId(),
+              ((JMenuItem) linkItems[i]).getText().split("\\|")[1]);
+    }
+
+    // if there are no valid links the Links submenu is disabled
+    List<String> nomatchlinks = new ArrayList<String>();
+    nomatchlinks.add("NOMATCH | http://www.uniprot.org/uniprot/$"
+            + DB_ACCESSION + "$");
+
+    testee = new PopupMenu(parentPanel, seq, noFeatures);
+    seqItems = testee.sequenceMenu.getMenuComponents();
+    linkMenu = (JMenu) seqItems[6];
+    assertFalse(linkMenu.isEnabled());
+
+  }
 }