JAL-2253 safer simpler resolution of identifiers using lookup endpoint;
[jalview.git] / test / jalview / ext / ensembl / EnsemblSeqProxyTest.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.ext.ensembl;
22
23 import static org.testng.AssertJUnit.assertEquals;
24 import static org.testng.AssertJUnit.assertFalse;
25 import static org.testng.AssertJUnit.assertTrue;
26 import static org.testng.internal.junit.ArrayAsserts.assertArrayEquals;
27
28 import jalview.datamodel.Alignment;
29 import jalview.datamodel.SequenceFeature;
30 import jalview.datamodel.SequenceI;
31 import jalview.io.AppletFormatAdapter;
32 import jalview.io.FastaFile;
33 import jalview.io.FileParse;
34 import jalview.io.gff.SequenceOntologyFactory;
35 import jalview.io.gff.SequenceOntologyLite;
36
37 import java.lang.reflect.Method;
38 import java.util.Arrays;
39
40 import org.testng.Assert;
41 import org.testng.annotations.AfterClass;
42 import org.testng.annotations.BeforeClass;
43 import org.testng.annotations.DataProvider;
44 import org.testng.annotations.Test;
45
46 public class EnsemblSeqProxyTest
47 {
48   private static final Object[][] allSeqs = new Object[][] {
49       {
50           new EnsemblProtein(),
51           "CCDS5863.1",
52           ">CCDS5863.1\n"
53                   + "MAALSGGGGGGAEPGQALFNGDMEPEAGAGAGAAASSAADPAIPEEVWNIKQMIKLTQEH\n"
54                   + "IEALLDKFGGEHNPPSIYLEAYEEYTSKLDALQQREQQLLESLGNGTDFSVSSSASMDTV\n"
55                   + "TSSSSSSLSVLPSSLSVFQNPTDVARSNPKSPQKPIVRVFLPNKQRTVVPARCGVTVRDS\n"
56                   + "LKKALMMRGLIPECCAVYRIQDGEKKPIGWDTDISWLTGEELHVEVLENVPLTTHNFVRK\n"
57                   + "TFFTLAFCDFCRKLLFQGFRCQTCGYKFHQRCSTEVPLMCVNYDQLDLLFVSKFFEHHPI\n"
58                   + "PQEEASLAETALTSGSSPSAPASDSIGPQILTSPSPSKSIPIPQPFRPADEDHRNQFGQR\n"
59                   + "DRSSSAPNVHINTIEPVNIDDLIRDQGFRGDGGSTTGLSATPPASLPGSLTNVKALQKSP\n"
60                   + "GPQRERKSSSSSEDRNRMKTLGRRDSSDDWEIPDGQITVGQRIGSGSFGTVYKGKWHGDV\n"
61                   + "AVKMLNVTAPTPQQLQAFKNEVGVLRKTRHVNILLFMGYSTKPQLAIVTQWCEGSSLYHH\n"
62                   + "LHIIETKFEMIKLIDIARQTAQGMDYLHAKSIIHRDLKSNNIFLHEDLTVKIGDFGLATV\n"
63                   + "KSRWSGSHQFEQLSGSILWMAPEVIRMQDKNPYSFQSDVYAFGIVLYELMTGQLPYSNIN\n"
64                   + "NRDQIIFMVGRGYLSPDLSKVRSNCPKAMKRLMAECLKKKRDERPLFPQILASIELLARS\n"
65                   + "LPKIHRSASEPSLNRAGFQTEDFSLYACASPKTPIQAGGYGAFPVH\n" },
66       {
67           new EnsemblCdna(),
68           "CCDS5863.1",
69           ">CCDS5863.1\n"
70                   + "ATGGCGGCGCTGAGCGGTGGCGGTGGTGGCGGCGCGGAGCCGGGCCAGGCTCTGTTCAAC\n"
71                   + "GGGGACATGGAGCCCGAGGCCGGCGCCGGCGCCGGCGCCGCGGCCTCTTCGGCTGCGGAC\n"
72                   + "CCTGCCATTCCGGAGGAGGTGTGGAATATCAAACAAATGATTAAGTTGACACAGGAACAT\n"
73                   + "ATAGAGGCCCTATTGGACAAATTTGGTGGGGAGCATAATCCACCATCAATATATCTGGAG\n"
74                   + "GCCTATGAAGAATACACCAGCAAGCTAGATGCACTCCAACAAAGAGAACAACAGTTATTG\n"
75                   + "GAATCTCTGGGGAACGGAACTGATTTTTCTGTTTCTAGCTCTGCATCAATGGATACCGTT\n"
76                   + "ACATCTTCTTCCTCTTCTAGCCTTTCAGTGCTACCTTCATCTCTTTCAGTTTTTCAAAAT\n"
77                   + "CCCACAGATGTGGCACGGAGCAACCCCAAGTCACCACAAAAACCTATCGTTAGAGTCTTC\n"
78                   + "CTGCCCAACAAACAGAGGACAGTGGTACCTGCAAGGTGTGGAGTTACAGTCCGAGACAGT\n"
79                   + "CTAAAGAAAGCACTGATGATGAGAGGTCTAATCCCAGAGTGCTGTGCTGTTTACAGAATT\n"
80                   + "CAGGATGGAGAGAAGAAACCAATTGGTTGGGACACTGATATTTCCTGGCTTACTGGAGAA\n"
81                   + "GAATTGCATGTGGAAGTGTTGGAGAATGTTCCACTTACAACACACAACTTTGTACGAAAA\n"
82                   + "ACGTTTTTCACCTTAGCATTTTGTGACTTTTGTCGAAAGCTGCTTTTCCAGGGTTTCCGC\n"
83                   + "TGTCAAACATGTGGTTATAAATTTCACCAGCGTTGTAGTACAGAAGTTCCACTGATGTGT\n"
84                   + "GTTAATTATGACCAACTTGATTTGCTGTTTGTCTCCAAGTTCTTTGAACACCACCCAATA\n"
85                   + "CCACAGGAAGAGGCGTCCTTAGCAGAGACTGCCCTAACATCTGGATCATCCCCTTCCGCA\n"
86                   + "CCCGCCTCGGACTCTATTGGGCCCCAAATTCTCACCAGTCCGTCTCCTTCAAAATCCATT\n"
87                   + "CCAATTCCACAGCCCTTCCGACCAGCAGATGAAGATCATCGAAATCAATTTGGGCAACGA\n"
88                   + "GACCGATCCTCATCAGCTCCCAATGTGCATATAAACACAATAGAACCTGTCAATATTGAT\n"
89                   + "GACTTGATTAGAGACCAAGGATTTCGTGGTGATGGAGGATCAACCACAGGTTTGTCTGCT\n"
90                   + "ACCCCCCCTGCCTCATTACCTGGCTCACTAACTAACGTGAAAGCCTTACAGAAATCTCCA\n"
91                   + "GGACCTCAGCGAGAAAGGAAGTCATCTTCATCCTCAGAAGACAGGAATCGAATGAAAACA\n"
92                   + "CTTGGTAGACGGGACTCGAGTGATGATTGGGAGATTCCTGATGGGCAGATTACAGTGGGA\n"
93                   + "CAAAGAATTGGATCTGGATCATTTGGAACAGTCTACAAGGGAAAGTGGCATGGTGATGTG\n"
94                   + "GCAGTGAAAATGTTGAATGTGACAGCACCTACACCTCAGCAGTTACAAGCCTTCAAAAAT\n"
95                   + "GAAGTAGGAGTACTCAGGAAAACACGACATGTGAATATCCTACTCTTCATGGGCTATTCC\n"
96                   + "ACAAAGCCACAACTGGCTATTGTTACCCAGTGGTGTGAGGGCTCCAGCTTGTATCACCAT\n"
97                   + "CTCCATATCATTGAGACCAAATTTGAGATGATCAAACTTATAGATATTGCACGACAGACT\n"
98                   + "GCACAGGGCATGGATTACTTACACGCCAAGTCAATCATCCACAGAGACCTCAAGAGTAAT\n"
99                   + "AATATATTTCTTCATGAAGACCTCACAGTAAAAATAGGTGATTTTGGTCTAGCTACAGTG\n"
100                   + "AAATCTCGATGGAGTGGGTCCCATCAGTTTGAACAGTTGTCTGGATCCATTTTGTGGATG\n"
101                   + "GCACCAGAAGTCATCAGAATGCAAGATAAAAATCCATACAGCTTTCAGTCAGATGTATAT\n"
102                   + "GCATTTGGAATTGTTCTGTATGAATTGATGACTGGACAGTTACCTTATTCAAACATCAAC\n"
103                   + "AACAGGGACCAGATAATTTTTATGGTGGGACGAGGATACCTGTCTCCAGATCTCAGTAAG\n"
104                   + "GTACGGAGTAACTGTCCAAAAGCCATGAAGAGATTAATGGCAGAGTGCCTCAAAAAGAAA\n"
105                   + "AGAGATGAGAGACCACTCTTTCCCCAAATTCTCGCCTCTATTGAGCTGCTGGCCCGCTCA\n"
106                   + "TTGCCAAAAATTCACCGCAGTGCATCAGAACCCTCCTTGAATCGGGCTGGTTTCCAAACA\n"
107                   + "GAGGATTTTAGTCTATATGCTTGTGCTTCTCCAAAAACACCCATCCAGGCAGGGGGATAT\n"
108                   + "GGTGCGTTTCCTGTCCACTGA\n" },
109       {
110           new EnsemblProtein(),
111           "ENSP00000288602",
112           ">ENSP00000288602\n"
113                   + "MAALSGGGGGGAEPGQALFNGDMEPEAGAGAGAAASSAADPAIPEEVWNIKQMIKLTQEH\n"
114                   + "IEALLDKFGGEHNPPSIYLEAYEEYTSKLDALQQREQQLLESLGNGTDFSVSSSASMDTV\n"
115                   + "TSSSSSSLSVLPSSLSVFQNPTDVARSNPKSPQKPIVRVFLPNKQRTVVPARCGVTVRDS\n"
116                   + "LKKALMMRGLIPECCAVYRIQDGEKKPIGWDTDISWLTGEELHVEVLENVPLTTHNFVRK\n"
117                   + "TFFTLAFCDFCRKLLFQGFRCQTCGYKFHQRCSTEVPLMCVNYDQLDLLFVSKFFEHHPI\n"
118                   + "PQEEASLAETALTSGSSPSAPASDSIGPQILTSPSPSKSIPIPQPFRPADEDHRNQFGQR\n"
119                   + "DRSSSAPNVHINTIEPVNIDDLIRDQGFRGDGGSTTGLSATPPASLPGSLTNVKALQKSP\n"
120                   + "GPQRERKSSSSSEDRNRMKTLGRRDSSDDWEIPDGQITVGQRIGSGSFGTVYKGKWHGDV\n"
121                   + "AVKMLNVTAPTPQQLQAFKNEVGVLRKTRHVNILLFMGYSTKPQLAIVTQWCEGSSLYHH\n"
122                   + "LHIIETKFEMIKLIDIARQTAQGMDYLHAKSIIHRDLKSNNIFLHEDLTVKIGDFGLATV\n"
123                   + "KSRWSGSHQFEQLSGSILWMAPEVIRMQDKNPYSFQSDVYAFGIVLYELMTGQLPYSNIN\n"
124                   + "NRDQIIFMVGRGYLSPDLSKVRSNCPKAMKRLMAECLKKKRDERPLFPQILASIELLARS\n"
125                   + "LPKIHRSASEPSLNRAGFQTEDFSLYACASPKTPIQAGGYGAFPVH" } };
126
127   @BeforeClass(alwaysRun = true)
128   public void setUp()
129   {
130     SequenceOntologyFactory.setInstance(new SequenceOntologyLite());
131   }
132
133   @AfterClass(alwaysRun = true)
134   public void tearDown()
135   {
136     SequenceOntologyFactory.setInstance(null);
137   }
138
139   @DataProvider(name = "ens_seqs")
140   public Object[][] createData(Method m)
141   {
142     System.out.println(m.getName());
143     return allSeqs;
144   }
145
146   @Test(dataProvider = "ens_seqs", suiteName = "live")
147   public void testGetOneSeqs(EnsemblRestClient proxy, String sq,
148           String fastasq) throws Exception
149   {
150     FileParse fp = proxy.getSequenceReader(Arrays
151             .asList(new String[] { sq }));
152     SequenceI[] sqs = new FastaFile(fp).getSeqsAsArray();
153     FastaFile trueRes = new FastaFile(fastasq, AppletFormatAdapter.PASTE);
154     SequenceI[] trueSqs = trueRes.getSeqsAsArray();
155     Assert.assertEquals(sqs.length, trueSqs.length,
156             "Different number of sequences retrieved for query " + sq);
157     Alignment ral = new Alignment(sqs);
158     for (SequenceI tr : trueSqs)
159     {
160       SequenceI[] rseq;
161       Assert.assertNotNull(
162               rseq = ral.findSequenceMatch(tr.getName()),
163               "Couldn't find sequences matching expected sequence "
164                       + tr.getName());
165       Assert.assertEquals(rseq.length, 1,
166               "Expected only one sequence for sequence ID " + tr.getName());
167       Assert.assertEquals(
168               rseq[0].getSequenceAsString(),
169               tr.getSequenceAsString(),
170               "Sequences differ for " + tr.getName() + "\n" + "Exp:"
171                       + tr.getSequenceAsString() + "\n" + "Got:"
172                       + rseq[0].getSequenceAsString());
173
174     }
175   }
176
177   @Test(groups = "Functional")
178   public void getGenomicRangesFromFeatures()
179   {
180
181   }
182
183   /**
184    * Test the method that appends a single allele's reverse complement to a
185    * string buffer
186    */
187   @Test(groups = "Functional")
188   public void testReverseComplementAllele()
189   {
190     StringBuilder sb = new StringBuilder();
191     EnsemblSeqProxy.reverseComplementAllele(sb, "G"); // comp=C
192     EnsemblSeqProxy.reverseComplementAllele(sb, "g"); // comp=c
193     EnsemblSeqProxy.reverseComplementAllele(sb, "C"); // comp=G
194     EnsemblSeqProxy.reverseComplementAllele(sb, "T"); // comp=A
195     EnsemblSeqProxy.reverseComplementAllele(sb, "A"); // comp=T
196     assertEquals("C,c,G,A,T", sb.toString());
197
198     sb = new StringBuilder();
199     EnsemblSeqProxy.reverseComplementAllele(sb, "-GATt"); // revcomp=aATC-
200     EnsemblSeqProxy.reverseComplementAllele(sb, "hgmd_mutation");
201     EnsemblSeqProxy.reverseComplementAllele(sb, "PhenCode_variation");
202     assertEquals("aATC-,hgmd_mutation,PhenCode_variation", sb.toString());
203   }
204
205   /**
206    * Test the method that computes the reverse complement of the alleles in a
207    * sequence_variant feature
208    */
209   @Test(groups = "Functional")
210   public void testReverseComplementAlleles()
211   {
212     String alleles = "C,G,-TAC,HGMD_MUTATION,gac";
213     SequenceFeature sf = new SequenceFeature("sequence_variant", alleles,
214             1, 2, 0f, null);
215     sf.setValue("alleles", alleles);
216     sf.setAttributes("x=y,z;alleles=" + alleles + ";a=b,c");
217
218     EnsemblSeqProxy.reverseComplementAlleles(sf);
219     String revcomp = "G,C,GTA-,HGMD_MUTATION,gtc";
220     // verify description is updated with reverse complement
221     assertEquals(revcomp, sf.getDescription());
222     // verify alleles attribute is updated with reverse complement
223     assertEquals(revcomp, sf.getValue("alleles"));
224     // verify attributes string is updated with reverse complement
225     assertEquals("x=y,z;alleles=" + revcomp + ";a=b,c", sf.getAttributes());
226   }
227
228   @Test(groups = "Functional")
229   public void testSortFeatures()
230   {
231     SequenceFeature sf1 = new SequenceFeature("", "", 10, 15, 0f, null);
232     SequenceFeature sf2 = new SequenceFeature("", "", 8, 12, 0f, null);
233     SequenceFeature sf3 = new SequenceFeature("", "", 8, 13, 0f, null);
234     SequenceFeature sf4 = new SequenceFeature("", "", 11, 11, 0f, null);
235     SequenceFeature[] sfs = new SequenceFeature[] { sf1, sf2, sf3, sf4 };
236
237     // sort by start position ascending (forward strand)
238     // sf2 and sf3 tie and should not be reordered by sorting
239     EnsemblSeqProxy.sortFeatures(sfs, true);
240     assertArrayEquals(new SequenceFeature[] { sf2, sf3, sf1, sf4 }, sfs);
241
242     // sort by end position descending (reverse strand)
243     EnsemblSeqProxy.sortFeatures(sfs, false);
244     assertArrayEquals(new SequenceFeature[] { sf1, sf3, sf2, sf4 }, sfs);
245   }
246 }