2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
23 import static org.testng.AssertJUnit.assertNotNull;
25 import jalview.api.AlignExportSettingI;
26 import jalview.datamodel.Alignment;
27 import jalview.datamodel.AlignmentAnnotation;
28 import jalview.datamodel.AlignmentI;
29 import jalview.datamodel.Annotation;
30 import jalview.datamodel.HiddenColumns;
31 import jalview.datamodel.Sequence;
32 import jalview.datamodel.SequenceFeature;
33 import jalview.datamodel.SequenceGroup;
34 import jalview.datamodel.SequenceI;
35 import jalview.datamodel.features.SequenceFeatures;
36 import jalview.gui.AlignFrame;
37 import jalview.gui.JvOptionPane;
38 import jalview.json.binding.biojson.v1.ColourSchemeMapper;
39 import jalview.schemes.ColourSchemeI;
40 import jalview.schemes.ResidueColourScheme;
42 import java.io.IOException;
43 import java.util.ArrayList;
44 import java.util.HashMap;
45 import java.util.Iterator;
46 import java.util.List;
49 import org.testng.Assert;
50 import org.testng.AssertJUnit;
51 import org.testng.annotations.AfterTest;
52 import org.testng.annotations.BeforeClass;
53 import org.testng.annotations.BeforeMethod;
54 import org.testng.annotations.BeforeTest;
55 import org.testng.annotations.Test;
57 public class JSONFileTest
60 @BeforeClass(alwaysRun = true)
61 public void setUpJvOptionPane()
63 JvOptionPane.setInteractiveMode(false);
64 JvOptionPane.setMockResponse(JvOptionPane.CANCEL_OPTION);
67 private int TEST_SEQ_HEIGHT = 0;
69 private int TEST_GRP_HEIGHT = 0;
71 private int TEST_ANOT_HEIGHT = 0;
73 private int TEST_CS_HEIGHT = 0;
75 private String TEST_JSON_FILE = "examples/example.json";
77 private Alignment alignment;
79 private HashMap<String, SequenceI> expectedSeqs = new HashMap<>();
81 private HashMap<String, AlignmentAnnotation> expectedAnnots = new HashMap<>();
83 private HashMap<String, SequenceGroup> expectedGrps = new HashMap<>();
85 private HiddenColumns expectedColSel = new HiddenColumns();
87 private SequenceI[] expectedHiddenSeqs = new SequenceI[1];
89 private AlignmentI testAlignment;
91 private int passedCount;
93 private JSONFile testJsonFile;
97 private AlignExportSettingI exportSettings;
99 @BeforeTest(alwaysRun = true)
100 public void setup() throws Exception
103 * construct expected values
104 * nb this have to match the data in examples/example.json
106 // create and add sequences
107 Sequence[] seqs = new Sequence[5];
108 seqs[0] = new Sequence("FER_CAPAN",
109 "SVSATMISTSFMPRKPAVTSL-KPIPNVGE--ALF", 3, 34);
110 seqs[1] = new Sequence("FER1_SOLLC",
111 "SISGTMISTSFLPRKPAVTSL-KAISNVGE--ALF", 3, 34);
112 seqs[2] = new Sequence("Q93XJ9_SOLTU",
113 "SISGTMISTSFLPRKPVVTSL-KAISNVGE--ALF", 3, 34);
114 seqs[3] = new Sequence("FER1_PEA",
115 "ALYGTAVSTSFLRTQPMPMSV-TTTKAFSN--GFL", 6, 37);
116 seqs[4] = new Sequence("Q7XA98_TRIPR",
117 "ALYGTAVSTSFMRRQPVPMSV-ATTTTTKAFPSGF", 6, 39);
119 SequenceI hiddenSeq = new Sequence("FER_TOCH",
120 "FILGTMISKSFLFRKPAVTSL-KAISNVGE--ALF", 3, 34);
121 expectedHiddenSeqs[0] = hiddenSeq;
123 // create and add sequence features
124 SequenceFeature seqFeature2 = new SequenceFeature("feature_x",
125 "theDesc", 6, 15, "Jalview");
126 SequenceFeature seqFeature3 = new SequenceFeature("feature_x",
127 "theDesc", 9, 18, "Jalview");
128 SequenceFeature seqFeature4 = new SequenceFeature("feature_x",
129 "theDesc", 9, 18, "Jalview");
130 // non-positional feature:
131 SequenceFeature seqFeature5 = new SequenceFeature("Domain",
132 "My description", 0, 0, "Pfam");
133 seqs[2].addSequenceFeature(seqFeature2);
134 seqs[3].addSequenceFeature(seqFeature3);
135 seqs[4].addSequenceFeature(seqFeature4);
136 seqs[2].addSequenceFeature(seqFeature5);
138 for (Sequence seq : seqs)
140 seq.createDatasetSequence();
141 expectedSeqs.put(seq.getName(), seq);
144 // create and add a sequence group
145 List<SequenceI> grpSeqs = new ArrayList<>();
146 grpSeqs.add(seqs[1]);
147 grpSeqs.add(seqs[2]);
148 grpSeqs.add(seqs[3]);
149 grpSeqs.add(seqs[4]);
150 SequenceGroup seqGrp = new SequenceGroup(grpSeqs,
152 null, true, true, false, 21, 29);
153 ColourSchemeI scheme = ColourSchemeMapper.getJalviewColourScheme(
155 seqGrp.cs.setColourScheme(scheme);
156 seqGrp.setShowNonconserved(false);
157 seqGrp.setDescription(null);
159 expectedGrps.put(seqGrp.getName(), seqGrp);
161 // create and add annotation
162 Annotation[] annot = new Annotation[35];
163 annot[0] = new Annotation("", "", '\u0000', 0);
164 annot[1] = new Annotation("", "", '\u0000', 0);
165 annot[2] = new Annotation("α", "", 'H', 0);
166 annot[3] = new Annotation("α", "", 'H', 0);
167 annot[4] = new Annotation("α", "", 'H', 0);
168 annot[5] = new Annotation("", "", '\u0000', 0);
169 annot[6] = new Annotation("", "", '\u0000', 0);
170 annot[7] = new Annotation("", "", '\u0000', 0);
171 annot[8] = new Annotation("β", "", 'E', 0);
172 annot[9] = new Annotation("β", "", 'E', 0);
173 annot[10] = new Annotation("β", "", 'E', 0);
174 annot[11] = new Annotation("β", "", 'E', 0);
175 annot[12] = new Annotation("β", "", 'E', 0);
176 annot[13] = new Annotation("β", "", 'E', 0);
177 annot[14] = new Annotation("β", "", 'E', 0);
178 annot[15] = new Annotation("β", "", 'E', 0);
179 annot[16] = new Annotation("", "", '\u0000', 0);
180 annot[17] = new Annotation("", "", '\u0000', 0);
181 annot[18] = new Annotation("", "", '\u0000', 0);
182 annot[19] = new Annotation("", "", '\u0000', 0);
183 annot[20] = new Annotation("", "", '\u0000', 0);
184 annot[21] = new Annotation("", "", '\u0000', 0);
185 annot[22] = new Annotation("", "", '\u0000', 0);
186 annot[23] = new Annotation("", "", '\u0000', 0);
187 annot[24] = new Annotation("", "", '\u0000', 0);
188 annot[25] = new Annotation("", "", '\u0000', 0);
189 annot[26] = new Annotation("α", "", 'H', 0);
190 annot[27] = new Annotation("α", "", 'H', 0);
191 annot[28] = new Annotation("α", "", 'H', 0);
192 annot[29] = new Annotation("α", "", 'H', 0);
193 annot[30] = new Annotation("α", "", 'H', 0);
194 annot[31] = new Annotation("", "", '\u0000', 0);
195 annot[32] = new Annotation("", "", '\u0000', 0);
196 annot[33] = new Annotation("", "", '\u0000', 0);
197 annot[34] = new Annotation("", "", '\u0000', 0);
199 AlignmentAnnotation alignAnnot = new AlignmentAnnotation(
200 "Secondary Structure", "New description", annot);
201 expectedAnnots.put(alignAnnot.label, alignAnnot);
203 expectedColSel.hideColumns(32, 33);
204 expectedColSel.hideColumns(34, 34);
206 TEST_SEQ_HEIGHT = expectedSeqs.size();
207 TEST_GRP_HEIGHT = expectedGrps.size();
208 TEST_ANOT_HEIGHT = expectedAnnots.size();
209 TEST_CS_HEIGHT = expectedColSel.getNumberOfRegions();
211 exportSettings = new AlignExportSettingI()
214 public boolean isExportHiddenSequences()
220 public boolean isExportHiddenColumns()
226 public boolean isExportGroups()
232 public boolean isExportFeatures()
238 public boolean isExportAnnotations()
244 public boolean isCancelled()
250 AppletFormatAdapter formatAdapter = new AppletFormatAdapter();
253 alignment = (Alignment) formatAdapter.readFile(TEST_JSON_FILE,
254 DataSourceType.FILE, FileFormat.Json);
255 jf = (JSONFile) formatAdapter.getAlignFile();
257 AlignFrame af = new AlignFrame(alignment, jf.getHiddenSequences(),
258 jf.getHiddenColumns(), AlignFrame.DEFAULT_WIDTH,
259 AlignFrame.DEFAULT_HEIGHT);
260 af.getViewport().setShowSequenceFeatures(jf.isShowSeqFeatures());
261 String colourSchemeName = jf.getGlobalColourScheme();
262 ColourSchemeI cs = ColourSchemeMapper.getJalviewColourScheme(
263 colourSchemeName, alignment);
265 af.getViewport().setFeaturesDisplayed(jf.getDisplayedFeatures());
267 formatAdapter = new AppletFormatAdapter(af.alignPanel, exportSettings);
268 String jsonOutput = formatAdapter.formatSequences(FileFormat.Json,
269 af.alignPanel.getAlignment(), false);
271 formatAdapter = new AppletFormatAdapter();
272 testAlignment = formatAdapter.readFile(jsonOutput,
273 DataSourceType.PASTE, FileFormat.Json);
274 testJsonFile = (JSONFile) formatAdapter.getAlignFile();
275 // System.out.println(jsonOutput);
276 } catch (IOException e)
283 @BeforeMethod(alwaysRun = true)
284 public void methodSetup()
289 @AfterTest(alwaysRun = true)
290 public void tearDown() throws Exception
295 expectedAnnots = null;
297 testAlignment = null;
301 @Test(groups = { "Functional" })
302 public void roundTripTest()
304 assertNotNull("JSON roundtrip test failed!", testJsonFile);
307 @Test(groups = { "Functional" })
308 public void testSeqParsed()
310 assertNotNull("Couldn't read supplied alignment data.", testAlignment);
311 Assert.assertNotNull(testAlignment.getSequences());
312 for (SequenceI seq : testAlignment.getSequences())
314 SequenceI expectedSeq = expectedSeqs.get(seq.getName());
315 AssertJUnit.assertTrue(
316 "Failed Sequence Test for >>> " + seq.getName(),
317 isSeqMatched(expectedSeq, seq));
320 AssertJUnit.assertEquals("Some Sequences did not pass the test",
321 TEST_SEQ_HEIGHT, passedCount);
324 @Test(groups = { "Functional" })
325 public void hiddenColsTest()
327 HiddenColumns cs = testJsonFile.getHiddenColumns();
328 Assert.assertNotNull(cs);
330 Iterator<int[]> it = cs.iterator();
331 Iterator<int[]> colselit = expectedColSel.iterator();
332 Assert.assertTrue(it.hasNext());
333 Assert.assertEquals(cs.getNumberOfRegions(), TEST_CS_HEIGHT);
334 Assert.assertEquals(it.next(), colselit.next(),
335 "Mismatched hidden columns!");
338 @Test(groups = { "Functional" })
339 public void hiddenSeqsTest()
341 Assert.assertNotNull(testJsonFile.getHiddenSequences(),
342 "Hidden sequence Expected but found Null");
343 Assert.assertEquals(jf.getHiddenSequences().length, 1,
347 @Test(groups = { "Functional" })
348 public void colorSchemeTest()
350 Assert.assertNotNull(testJsonFile.getGlobalColourScheme(),
351 "Colourscheme is null, parsing failed!");
352 Assert.assertEquals(testJsonFile.getGlobalColourScheme(), "Zappo",
353 "Zappo colour scheme expected!");
357 * Test for bug JAL-2489, NPE when exporting BioJSON with global colour
358 * scheme, and a group colour scheme, set as 'None'
360 @Test(groups = { "Functional" })
361 public void testBioJSONRoundTripWithColourSchemeNone()
363 AppletFormatAdapter formatAdapter = new AppletFormatAdapter();
365 Alignment _alignment;
368 // load example BioJSON file
369 _alignment = (Alignment) formatAdapter.readFile(TEST_JSON_FILE,
370 DataSourceType.FILE, FileFormat.Json);
371 JSONFile bioJsonFile = (JSONFile) formatAdapter.getAlignFile();
372 AlignFrame alignFrame = new AlignFrame(_alignment,
373 bioJsonFile.getHiddenSequences(),
374 bioJsonFile.getHiddenColumns(), AlignFrame.DEFAULT_WIDTH,
375 AlignFrame.DEFAULT_HEIGHT);
378 * Create a group on the alignment;
379 * Change global and group colour scheme to 'None' and perform round trip
381 SequenceGroup sg = new SequenceGroup();
382 sg.addSequence(_alignment.getSequenceAt(0), false);
383 sg.setColourScheme(null);
384 ColourSchemeI cs = ColourSchemeMapper.getJalviewColourScheme(
385 ResidueColourScheme.NONE, _alignment);
386 alignFrame.changeColour(cs);
387 alignFrame.getViewport().setFeaturesDisplayed(
388 bioJsonFile.getDisplayedFeatures());
389 formatAdapter = new AppletFormatAdapter(alignFrame.alignPanel,
391 // export BioJSON string
392 String jsonOutput = formatAdapter.formatSequences(FileFormat.Json,
393 alignFrame.alignPanel.getAlignment(), false);
394 // read back Alignment from BioJSON string
395 formatAdapter = new AppletFormatAdapter();
396 formatAdapter.readFile(jsonOutput, DataSourceType.PASTE,
398 // assert 'None' colour scheme is retained after round trip
399 JSONFile _bioJsonFile = (JSONFile) formatAdapter.getAlignFile();
400 Assert.assertEquals(_bioJsonFile.getGlobalColourScheme(),
401 ResidueColourScheme.NONE);
402 } catch (IOException e)
408 @Test(groups = { "Functional" })
409 public void isShowSeqFeaturesSet()
411 Assert.assertTrue(testJsonFile.isShowSeqFeatures(),
412 "Sequence feature isDisplayed setting expected to be true");
415 @Test(groups = { "Functional" })
416 public void testGrpParsed()
418 Assert.assertNotNull(testAlignment.getGroups());
419 for (SequenceGroup seqGrp : testAlignment.getGroups())
421 SequenceGroup expectedGrp = expectedGrps.get(seqGrp.getName());
422 AssertJUnit.assertTrue(
423 "Failed SequenceGroup Test for >>> " + seqGrp.getName(),
424 isGroupMatched(expectedGrp, seqGrp));
427 AssertJUnit.assertEquals("Some SequenceGroups did not pass the test",
428 TEST_GRP_HEIGHT, passedCount);
431 @Test(groups = { "Functional" })
432 public void testAnnotationParsed()
434 Assert.assertNotNull(testAlignment.getAlignmentAnnotation());
435 for (AlignmentAnnotation annot : testAlignment.getAlignmentAnnotation())
437 AlignmentAnnotation expectedAnnot = expectedAnnots.get(annot.label);
438 AssertJUnit.assertTrue("Failed AlignmentAnnotation Test for >>> "
439 + annot.label, isAnnotationMatched(expectedAnnot, annot));
442 AssertJUnit.assertEquals("Some Sequences did not pass the test",
443 TEST_ANOT_HEIGHT, passedCount);
446 public boolean isAnnotationMatched(AlignmentAnnotation eAnnot,
447 AlignmentAnnotation annot)
449 if (!eAnnot.label.equals(annot.label)
450 || !eAnnot.description.equals(annot.description)
451 || eAnnot.annotations.length != annot.annotations.length)
456 for (int x = 0; x < annot.annotations.length; x++)
458 Annotation y = annot.annotations[x];
459 Annotation z = annot.annotations[x];
461 if (!y.displayCharacter.equals(z.displayCharacter)
462 || y.value != z.value
463 || y.secondaryStructure != z.secondaryStructure)
471 boolean isSeqMatched(SequenceI expectedSeq, SequenceI actualSeq)
473 System.out.println("Testing >>> " + actualSeq.getName());
475 if (expectedSeq.getName().equals(actualSeq.getName())
476 && expectedSeq.getSequenceAsString().equals(
477 actualSeq.getSequenceAsString())
478 && expectedSeq.getStart() == actualSeq.getStart()
479 && expectedSeq.getEnd() == actualSeq.getEnd()
480 && featuresMatched(expectedSeq, actualSeq))
487 public boolean isGroupMatched(SequenceGroup expectedGrp,
488 SequenceGroup actualGrp)
491 System.out.println("Testing >>> " + actualGrp.getName());
492 System.out.println(expectedGrp.getName() + " | " + actualGrp.getName());
493 System.out.println(expectedGrp.getColourText() + " | "
494 + actualGrp.getColourText());
495 System.out.println(expectedGrp.getDisplayBoxes() + " | "
496 + actualGrp.getDisplayBoxes());
497 System.out.println(expectedGrp.getIgnoreGapsConsensus() + " | "
498 + actualGrp.getIgnoreGapsConsensus());
499 System.out.println(expectedGrp.getSequences().size() + " | "
500 + actualGrp.getSequences().size());
501 System.out.println(expectedGrp.getStartRes() + " | "
502 + actualGrp.getStartRes());
503 System.out.println(expectedGrp.getEndRes() + " | "
504 + actualGrp.getEndRes());
505 System.out.println(expectedGrp.cs.getColourScheme() + " | "
506 + actualGrp.cs.getColourScheme());
508 boolean colourSchemeMatches = (expectedGrp.cs.getColourScheme() == null && actualGrp.cs
509 .getColourScheme() == null)
510 || expectedGrp.cs.getColourScheme().getClass()
511 .equals(actualGrp.cs.getColourScheme().getClass());
512 if (expectedGrp.getName().equals(actualGrp.getName())
513 && expectedGrp.getColourText() == actualGrp.getColourText()
514 && expectedGrp.getDisplayBoxes() == actualGrp.getDisplayBoxes()
515 && expectedGrp.getIgnoreGapsConsensus() == actualGrp
516 .getIgnoreGapsConsensus()
517 && colourSchemeMatches
518 && expectedGrp.getSequences().size() == actualGrp
519 .getSequences().size()
520 && expectedGrp.getStartRes() == actualGrp.getStartRes()
521 && expectedGrp.getEndRes() == actualGrp.getEndRes())
528 private boolean featuresMatched(SequenceI seq1, SequenceI seq2)
532 if (seq1 == null && seq2 == null)
537 List<SequenceFeature> inFeature = seq1.getFeatures().getAllFeatures();
538 List<SequenceFeature> outFeature = seq2.getFeatures()
541 if (inFeature.size() != outFeature.size())
543 System.err.println("Feature count in: " + inFeature.size()
544 + ", out: " + outFeature.size());
548 SequenceFeatures.sortFeatures(inFeature, true);
549 SequenceFeatures.sortFeatures(outFeature, true);
551 for (SequenceFeature in : inFeature)
553 SequenceFeature out = outFeature.get(i);
555 System.out.println(out.getType() + " | " + in.getType());
556 System.out.println(out.getBegin() + " | " + in.getBegin());
557 System.out.println(out.getEnd() + " | " + in.getEnd());
561 System.err.println("Mismatch of " + in.toString() + " "
566 if (in.getBegin() == out.getBegin() && in.getEnd() == out.getEnd()
567 && in.getScore() == out.getScore()
568 && in.getFeatureGroup().equals(out.getFeatureGroup())
569 && in.getType().equals(out.getType())
570 && mapsMatch(in.otherDetails, out.otherDetails))
575 System.err.println("Feature[" + i + "] mismatch, in: "
576 + in.toString() + ", out: "
577 + outFeature.get(i).toString());
583 } catch (Exception e)
587 // System.out.println(">>>>>>>>>>>>>> features matched : " + matched);
591 boolean mapsMatch(Map<String, Object> m1, Map<String, Object> m2)
593 if (m1 == null || m2 == null)
595 if (m1 != null || m2 != null)
598 .println("only one SequenceFeature.otherDetails is not null");
606 if (m1.size() != m2.size())
608 System.err.println("otherDetails map different sizes");
611 for (String key : m1.keySet())
613 if (!m2.containsKey(key))
615 System.err.println(key + " in only one otherDetails");
618 if (m1.get(key) == null && m2.get(key) != null || m1.get(key) != null
619 && m2.get(key) == null || !m1.get(key).equals(m2.get(key)))
621 System.err.println(key + " values in otherDetails don't match");
629 * Test group roundtrip with null (None) group colour scheme
631 * @throws IOException
633 @Test(groups = { "Functional" })
634 public void testGrpParsed_colourNone() throws IOException
636 AlignmentI copy = new Alignment(testAlignment);
637 SequenceGroup sg = testAlignment.getGroups().get(0);
638 SequenceGroup copySg = new SequenceGroup(new ArrayList<SequenceI>(),
640 null, sg.getDisplayBoxes(), sg.getDisplayText(),
641 sg.getColourText(), sg.getStartRes(), sg.getEndRes());
642 for (SequenceI seq : sg.getSequences())
644 int seqIndex = testAlignment.findIndex(seq);
645 copySg.addSequence(copy.getSequenceAt(seqIndex), false);
647 copy.addGroup(copySg);
649 AlignFrame af = new AlignFrame(copy, copy.getWidth(), copy.getHeight());
650 AppletFormatAdapter formatAdapter = new AppletFormatAdapter(
652 String jsonOutput = formatAdapter.formatSequences(FileFormat.Json,
654 formatAdapter = new AppletFormatAdapter();
655 AlignmentI newAlignment = formatAdapter.readFile(jsonOutput,
656 DataSourceType.PASTE, FileFormat.Json);
658 Assert.assertNotNull(newAlignment.getGroups());
659 for (SequenceGroup seqGrp : newAlignment.getGroups())
661 SequenceGroup expectedGrp = copySg;
662 AssertJUnit.assertTrue(
663 "Failed SequenceGroup Test for >>> " + seqGrp.getName(),
664 isGroupMatched(expectedGrp, seqGrp));
667 AssertJUnit.assertEquals("Some SequenceGroups did not pass the test",
668 TEST_GRP_HEIGHT, passedCount);