JAL-2316 Added jalview.urls.* packages
[jalview.git] / test / jalview / urls / DesktopUrlProviderFactoryTest.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
4  * 
5  * This file is part of Jalview.
6  * 
7  * Jalview is free software: you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License 
9  * as published by the Free Software Foundation, either version 3
10  * of the License, or (at your option) any later version.
11  *  
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
19  * The Jalview Authors are detailed in the 'AUTHORS' file.
20  */
21 package jalview.urls;
22
23 import jalview.urls.api.UrlProviderI;
24 import jalview.urls.desktop.DesktopUrlProviderFactory;
25
26 import java.io.BufferedWriter;
27 import java.io.File;
28 import java.io.FileWriter;
29 import java.io.IOException;
30 import java.util.List;
31 import java.util.Vector;
32
33 import org.testng.Assert;
34 import org.testng.annotations.BeforeMethod;
35 import org.testng.annotations.Test;
36
37 public class DesktopUrlProviderFactoryTest
38 {
39   // Test identifiers.org download file
40   private static final String testIdOrgString = "[{\"id\":\"MIR:00000002\",\"name\":\"ChEBI\",\"pattern\":\"^CHEBI:\\d+$\","
41           + "\"definition\":\"Chemical Entities of Biological Interest (ChEBI)\",\"prefix\":\"chebi\","
42           + "\"url\":\"http://identifiers.org/chebi\"},{\"id\":\"MIR:00000005\",\"name\":\"UniProt Knowledgebase\","
43           + "\"pattern\":\"^([A-N,R-Z][0-9]([A-Z][A-Z, 0-9][A-Z, 0-9][0-9]){1,2})|([O,P,Q][0-9][A-Z, 0-9][A-Z, 0-9][A-Z, 0-9][0-9])(\\.\\d+)?$\","
44           + "\"definition\":\"The UniProt Knowledgebase (UniProtKB)\",\"prefix\":\"uniprot\",\"url\":\"http://identifiers.org/uniprot\"},"
45           + "{\"id\":\"MIR:00000011\",\"name\":\"InterPro\",\"pattern\":\"^IPR\\d{6}$\",\"definition\":\"InterPro\",\"prefix\":\"interpro\","
46           + "\"url\":\"http://identifiers.org/interpro\"},"
47           + "{\"id\":\"MIR:00000372\",\"name\":\"ENA\",\"pattern\":\"^[A-Z]+[0-9]+(\\.\\d+)?$\",\"definition\":\"The European Nucleotide Archive (ENA),\""
48           + "\"prefix\":\"ena.embl\",\"url\":\"http://identifiers.org/ena.embl\"}]";
49
50   @BeforeMethod(alwaysRun = true)
51   public void setup()
52   {
53     // make a dummy identifiers.org download file
54     File temp = null;
55
56     try
57     {
58       temp = File.createTempFile("tempfile", ".tmp");
59       temp.deleteOnExit();
60       BufferedWriter bw = new BufferedWriter(new FileWriter(temp));
61       bw.write(testIdOrgString);
62       bw.close();
63     } catch (IOException e)
64     {
65       System.out
66               .println("Error initialising DesktopUrlProviderFactoryTest test: "
67                       + e.getMessage());
68     }
69
70     IdOrgSettings.setDownloadLocation(temp.getPath());
71   }
72
73   @Test(groups = { "Functional" })
74   public void testCreateUrlProvider()
75   {
76     String defaultUrlString = "Test1";
77     String defaultUrl = "http://blah.blah/$SEQUENCE_ID$";
78     String cachedUrlList = "MIR:00000005|MIR:00000011|Test1|http://blah.blah/$SEQUENCE_ID$|"
79             + "Test2|http://test2/$DB_ACCESSION$|Test3|http://test3/$SEQUENCE_ID$";
80     String userUrlList = "MIR:00000372|Test4|httpL//another.url/$SEQUENCE_ID$";
81
82     DesktopUrlProviderFactory factory = new DesktopUrlProviderFactory(
83             defaultUrlString, cachedUrlList, userUrlList);
84     UrlProviderI prov = factory.createUrlProvider();
85
86     // default url correctly set
87     Assert.assertEquals(prov.getDefaultUrlId(), "Test1");
88     Assert.assertEquals(prov.getDefaultUrl("FER_CAPAN"),
89             defaultUrl.replace("$SEQUENCE_ID$", "FER_CAPAN"));
90
91     Vector<String> menulinks = prov.getLinksForMenu();
92     List<UrlLinkDisplay> allLinks = prov.getLinksForTable();
93
94     // 8 links in provider - 4 from id file, 4 custom links
95     Assert.assertEquals(allLinks.size(), 8);
96
97     // 5 links in menu (cachedUrlList)
98     Assert.assertEquals(menulinks.size(), 5);
99
100     Assert.assertTrue(menulinks
101             .contains("Test1|http://blah.blah/$SEQUENCE_ID$"));
102     Assert.assertTrue(menulinks
103             .contains("Test2|http://test2/$DB_ACCESSION$"));
104     Assert.assertTrue(menulinks
105             .contains("Test3|http://test3/$SEQUENCE_ID$"));
106     Assert.assertTrue(menulinks
107             .contains("UniProt Knowledgebase|http://identifiers.org/uniprot/$DB_ACCESSION$"));
108     Assert.assertTrue(menulinks
109             .contains("InterPro|http://identifiers.org/interpro/$DB_ACCESSION$"));
110   }
111 }