test/jalview/io/SequenceAnnotationReportTest.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.io;
  22
  23 import static org.testng.AssertJUnit.assertEquals;
  24 import static org.testng.AssertJUnit.assertTrue;
  25
  26 import java.awt.Color;
  27 import java.util.ArrayList;
  28 import java.util.List;
  29 import java.util.Map;
  30
  31 import org.testng.annotations.BeforeClass;
  32 import org.testng.annotations.Test;
  33
  34 import jalview.api.FeatureColourI;
  35 import jalview.datamodel.DBRefEntry;
  36 import jalview.datamodel.MappedFeatures;
  37 import jalview.datamodel.Mapping;
  38 import jalview.datamodel.Sequence;
  39 import jalview.datamodel.SequenceFeature;
  40 import jalview.datamodel.SequenceI;
  41 import jalview.gui.JvOptionPane;
  42 import jalview.io.gff.GffConstants;
  43 import jalview.renderer.seqfeatures.FeatureRenderer;
  44 import jalview.schemes.FeatureColour;
  45 import jalview.util.MapList;
  46 import jalview.viewmodel.seqfeatures.FeatureRendererModel;
  47 import junit.extensions.PA;
  48
  49 public class SequenceAnnotationReportTest
  50 {
  51
  52   @BeforeClass(alwaysRun = true)
  53   public void setUpJvOptionPane()
  54   {
  55     JvOptionPane.setInteractiveMode(false);
  56     JvOptionPane.setMockResponse(JvOptionPane.CANCEL_OPTION);
  57   }
  58
  59   @Test(groups = "Functional")
  60   public void testAppendFeature_disulfideBond()
  61   {
  62     SequenceAnnotationReport sar = new SequenceAnnotationReport(false);
  63     StringBuilder sb = new StringBuilder();
  64     sb.append("123456");
  65     SequenceFeature sf = new SequenceFeature("disulfide bond", "desc", 1,
  66             3, 1.2f, "group");
  67
  68     // residuePos == 2 does not match start or end of feature, nothing done:
  69     sar.appendFeature(sb, 2, null, sf, null, 0);
  70     assertEquals("123456", sb.toString());
  71
  72     // residuePos == 1 matches start of feature, text appended (but no <br>)
  73     // feature score is not included
  74     sar.appendFeature(sb, 1, null, sf, null, 0);
  75     assertEquals("123456disulfide bond 1:3", sb.toString());
  76
  77     // residuePos == 3 matches end of feature, text appended
  78     // <br> is prefixed once sb.length() > 6
  79     sar.appendFeature(sb, 3, null, sf, null, 0);
  80     assertEquals("123456disulfide bond 1:3<br>disulfide bond 1:3",
  81             sb.toString());
  82   }
  83
  84   @Test(groups = "Functional")
  85   public void testAppendFeatures_longText()
  86   {
  87     SequenceAnnotationReport sar = new SequenceAnnotationReport(false);
  88     StringBuilder sb = new StringBuilder();
  89     String longString = "Abcd".repeat(50);
  90     SequenceFeature sf = new SequenceFeature("sequence", longString, 1, 3,
  91             "group");
  92
  93     sar.appendFeature(sb, 1, null, sf, null, 0);
  94     assertTrue(sb.length() < 100);
  95
  96     List<SequenceFeature> sfl = new ArrayList<>();
  97     sb.setLength(0);
  98     sfl.add(sf);
  99     sfl.add(sf);
 100     sfl.add(sf);
 101     sfl.add(sf);
 102     sfl.add(sf);
 103     sfl.add(sf);
 104     sfl.add(sf);
 105     sfl.add(sf);
 106     sfl.add(sf);
 107     sfl.add(sf);
 108     int n = sar.appendFeatures(sb, 1, sfl,
 109             new FeatureRenderer(null), 200); // text should terminate before 200 characters
 110     String s = sb.toString();
 111     assertTrue(s.length() < 200);
 112     assertEquals(n, 7); // should be 7 features left over
 113
 114   }
 115
 116   @Test(groups = "Functional")
 117   public void testAppendFeature_status()
 118   {
 119     SequenceAnnotationReport sar = new SequenceAnnotationReport(false);
 120     StringBuilder sb = new StringBuilder();
 121     SequenceFeature sf = new SequenceFeature("METAL", "Fe2-S", 1, 3,
 122             Float.NaN, "group");
 123     sf.setStatus("Confirmed");
 124
 125     sar.appendFeature(sb, 1, null, sf, null, 0);
 126     assertEquals("METAL 1 3; Fe2-S; (Confirmed)", sb.toString());
 127   }
 128
 129   @Test(groups = "Functional")
 130   public void testAppendFeature_withScore()
 131   {
 132     SequenceAnnotationReport sar = new SequenceAnnotationReport(false);
 133     StringBuilder sb = new StringBuilder();
 134     SequenceFeature sf = new SequenceFeature("METAL", "Fe2-S", 1, 3, 1.3f,
 135             "group");
 136
 137     FeatureRendererModel fr = new FeatureRenderer(null);
 138     Map<String, float[][]> minmax = fr.getMinMax();
 139     sar.appendFeature(sb, 1, fr, sf, null, 0);
 140     /*
 141      * map has no entry for this feature type - score is not shown:
 142      */
 143     assertEquals("METAL 1 3; Fe2-S", sb.toString());
 144
 145     /*
 146      * map has entry for this feature type - score is shown:
 147      */
 148     minmax.put("METAL", new float[][] { { 0f, 1f }, null });
 149     sar.appendFeature(sb, 1, fr, sf, null, 0);
 150     // <br> is appended to a buffer > 6 in length
 151     assertEquals("METAL 1 3; Fe2-S<br>METAL 1 3; Fe2-S Score=1.3",
 152             sb.toString());
 153
 154     /*
 155      * map has min == max for this feature type - score is not shown:
 156      */
 157     minmax.put("METAL", new float[][] { { 2f, 2f }, null });
 158     sb.setLength(0);
 159     sar.appendFeature(sb, 1, fr, sf, null, 0);
 160     assertEquals("METAL 1 3; Fe2-S", sb.toString());
 161   }
 162
 163   @Test(groups = "Functional")
 164   public void testAppendFeature_noScore()
 165   {
 166     SequenceAnnotationReport sar = new SequenceAnnotationReport(false);
 167     StringBuilder sb = new StringBuilder();
 168     SequenceFeature sf = new SequenceFeature("METAL", "Fe2-S", 1, 3,
 169             Float.NaN, "group");
 170
 171     sar.appendFeature(sb, 1, null, sf, null, 0);
 172     assertEquals("METAL 1 3; Fe2-S", sb.toString());
 173   }
 174
 175   /**
 176    * A specific attribute value is included if it is used to colour the feature
 177    */
 178   @Test(groups = "Functional")
 179   public void testAppendFeature_colouredByAttribute()
 180   {
 181     SequenceAnnotationReport sar = new SequenceAnnotationReport(false);
 182     StringBuilder sb = new StringBuilder();
 183     SequenceFeature sf = new SequenceFeature("METAL", "Fe2-S", 1, 3,
 184             Float.NaN, "group");
 185     sf.setValue("clinical_significance", "Benign");
 186
 187     /*
 188      * first with no colour by attribute
 189      */
 190     FeatureRendererModel fr = new FeatureRenderer(null);
 191     sar.appendFeature(sb, 1, fr, sf, null, 0);
 192     assertEquals("METAL 1 3; Fe2-S", sb.toString());
 193
 194     /*
 195      * then with colour by an attribute the feature lacks
 196      */
 197     FeatureColourI fc = new FeatureColour(null, Color.white, Color.black,
 198             null, 5, 10);
 199     fc.setAttributeName("Pfam");
 200     fr.setColour("METAL", fc);
 201     sb.setLength(0);
 202     sar.appendFeature(sb, 1, fr, sf, null, 0);
 203     assertEquals("METAL 1 3; Fe2-S", sb.toString()); // no change
 204
 205     /*
 206      * then with colour by an attribute the feature has
 207      */
 208     fc.setAttributeName("clinical_significance");
 209     sb.setLength(0);
 210     sar.appendFeature(sb, 1, fr, sf, null, 0);
 211     assertEquals("METAL 1 3; Fe2-S; clinical_significance=Benign",
 212             sb.toString());
 213   }
 214
 215   @Test(groups = "Functional")
 216   public void testAppendFeature_withScoreStatusAttribute()
 217   {
 218     SequenceAnnotationReport sar = new SequenceAnnotationReport(false);
 219     StringBuilder sb = new StringBuilder();
 220     SequenceFeature sf = new SequenceFeature("METAL", "Fe2-S", 1, 3, 1.3f,
 221             "group");
 222     sf.setStatus("Confirmed");
 223     sf.setValue("clinical_significance", "Benign");
 224
 225     FeatureRendererModel fr = new FeatureRenderer(null);
 226     Map<String, float[][]> minmax = fr.getMinMax();
 227     FeatureColourI fc = new FeatureColour(null, Color.white, Color.blue,
 228             null, 12, 22);
 229     fc.setAttributeName("clinical_significance");
 230     fr.setColour("METAL", fc);
 231     minmax.put("METAL", new float[][] { { 0f, 1f }, null });
 232     sar.appendFeature(sb, 1, fr, sf, null, 0);
 233
 234     assertEquals(
 235             "METAL 1 3; Fe2-S Score=1.3; (Confirmed); clinical_significance=Benign",
 236             sb.toString());
 237   }
 238
 239   @Test(groups = "Functional")
 240   public void testAppendFeature_DescEqualsType()
 241   {
 242     SequenceAnnotationReport sar = new SequenceAnnotationReport(false);
 243     StringBuilder sb = new StringBuilder();
 244     SequenceFeature sf = new SequenceFeature("METAL", "METAL", 1, 3,
 245             Float.NaN, "group");
 246
 247     // description is not included if it duplicates type:
 248     sar.appendFeature(sb, 1, null, sf, null, 0);
 249     assertEquals("METAL 1 3", sb.toString());
 250
 251     sb.setLength(0);
 252     sf.setDescription("Metal");
 253     // test is case-sensitive:
 254     sar.appendFeature(sb, 1, null, sf, null, 0);
 255     assertEquals("METAL 1 3; Metal", sb.toString());
 256   }
 257
 258   @Test(groups = "Functional")
 259   public void testAppendFeature_stripHtml()
 260   {
 261     SequenceAnnotationReport sar = new SequenceAnnotationReport(false);
 262     StringBuilder sb = new StringBuilder();
 263     SequenceFeature sf = new SequenceFeature("METAL",
 264             "<html><body>hello<em>world</em></body></html>", 1, 3,
 265             Float.NaN, "group");
 266
 267     sar.appendFeature(sb, 1, null, sf, null, 0);
 268     // !! strips off </body> but not <body> ??
 269     assertEquals("METAL 1 3; <body>hello<em>world</em>", sb.toString());
 270
 271     sb.setLength(0);
 272     sf.setDescription("<br>&kHD>6");
 273     sar.appendFeature(sb, 1, null, sf, null, 0);
 274     // if no <html> tag, html-encodes > and < (only):
 275     assertEquals("METAL 1 3; &lt;br&gt;&kHD&gt;6", sb.toString());
 276   }
 277
 278   @Test(groups = "Functional")
 279   public void testCreateSequenceAnnotationReport()
 280   {
 281     SequenceAnnotationReport sar = new SequenceAnnotationReport(false);
 282     StringBuilder sb = new StringBuilder();
 283
 284     SequenceI seq = new Sequence("s1", "MAKLKRFQSSTLL");
 285     seq.setDescription("SeqDesc");
 286
 287     /*
 288      * positional features are ignored
 289      */
 290     seq.addSequenceFeature(
 291             new SequenceFeature("Domain", "Ferredoxin", 5, 10, 1f, null));
 292     sar.createSequenceAnnotationReport(sb, seq, true, true, null);
 293     assertEquals("<i>SeqDesc\n" + "\n" + "</i>", sb.toString());
 294
 295     /*
 296      * non-positional feature
 297      */
 298     seq.addSequenceFeature(
 299             new SequenceFeature("Type1", "Nonpos", 0, 0, 1f, null));
 300     sb.setLength(0);
 301     sar.createSequenceAnnotationReport(sb, seq, true, true, null);
 302     String expected = "<i>SeqDesc\n" + "\n"
 303             + "<br/>Type1 ; Nonpos Score=1.0</i>";
 304     assertEquals(expected, sb.toString());
 305
 306     /*
 307      * non-positional features not wanted
 308      */
 309     sb.setLength(0);
 310     sar.createSequenceAnnotationReport(sb, seq, true, false, null);
 311     assertEquals("<i>SeqDesc\n\n</i>", sb.toString());
 312
 313     /*
 314      * add non-pos feature with score inside min-max range for feature type
 315      * minmax holds { [positionalMin, positionalMax], [nonPosMin, nonPosMax] }
 316      * score is only appended for positional features so ignored here!
 317      * minMax are not recorded for non-positional features
 318      */
 319     seq.addSequenceFeature(
 320             new SequenceFeature("Metal", "Desc", 0, 0, 5f, null));
 321
 322     FeatureRendererModel fr = new FeatureRenderer(null);
 323     Map<String, float[][]> minmax = fr.getMinMax();
 324     minmax.put("Metal", new float[][] { null, new float[] { 2f, 5f } });
 325
 326     sb.setLength(0);
 327     sar.createSequenceAnnotationReport(sb, seq, true, true, fr);
 328     expected = "<i>SeqDesc\n" + "\n"
 329             + "<br/>Metal ; Desc<br/>Type1 ; Nonpos</i>";
 330     assertEquals(expected, sb.toString());
 331
 332     /*
 333      * 'linkonly' features are ignored; this is obsolete, as linkonly
 334      * is only set by DasSequenceFetcher, and DAS is history
 335      */
 336     SequenceFeature sf = new SequenceFeature("Metal", "Desc", 0, 0, 5f,
 337             null);
 338     sf.setValue("linkonly", Boolean.TRUE);
 339     seq.addSequenceFeature(sf);
 340     sb.setLength(0);
 341     sar.createSequenceAnnotationReport(sb, seq, true, true, fr);
 342     assertEquals(expected, sb.toString()); // unchanged!
 343
 344     /*
 345      * 'clinical_significance' attribute is only included in description
 346      * when used for feature colouring
 347      */
 348     SequenceFeature sf2 = new SequenceFeature("Variant", "Havana", 0, 0, 5f,
 349             null);
 350     sf2.setValue(GffConstants.CLINICAL_SIGNIFICANCE, "benign");
 351     seq.addSequenceFeature(sf2);
 352     sb.setLength(0);
 353     sar.createSequenceAnnotationReport(sb, seq, true, true, fr);
 354     expected = "<i>SeqDesc\n" + "\n"
 355             + "<br/>Metal ; Desc<br/>Type1 ; Nonpos<br/>Variant ; Havana</i>";
 356     assertEquals(expected, sb.toString());
 357
 358     /*
 359      * add dbrefs
 360      */
 361     seq.addDBRef(new DBRefEntry("PDB", "0", "3iu1"));
 362     seq.addDBRef(new DBRefEntry("Uniprot", "1", "P30419"));
 363
 364     // with showDbRefs = false
 365     sb.setLength(0);
 366     sar.createSequenceAnnotationReport(sb, seq, false, true, fr);
 367     assertEquals(expected, sb.toString()); // unchanged
 368
 369     // with showDbRefs = true, colour Variant features by clinical_significance
 370     sb.setLength(0);
 371     FeatureColourI fc = new FeatureColour(null, Color.green, Color.pink,
 372             null, 2, 3);
 373     fc.setAttributeName("clinical_significance");
 374     fr.setColour("Variant", fc);
 375     sar.createSequenceAnnotationReport(sb, seq, true, true, fr);
 376     expected = "<i>SeqDesc\n" + "<br/>\n" + "UNIPROT P30419<br/>\n"
 377             + "PDB 3iu1\n"
 378             + "<br/>Metal ; Desc<br/>Type1 ; Nonpos<br/>Variant ; Havana; clinical_significance=benign</i>";
 379     assertEquals(expected, sb.toString());
 380     // with showNonPositionalFeatures = false
 381     sb.setLength(0);
 382     sar.createSequenceAnnotationReport(sb, seq, true, false, fr);
 383     expected = "<i>SeqDesc\n" + "<br/>\n" + "UNIPROT P30419<br/>\n"
 384             + "PDB 3iu1\n" + "</i>";
 385     assertEquals(expected, sb.toString());
 386
 387     /*
 388      * long feature description is truncated with ellipsis
 389      */
 390     sb.setLength(0);
 391     sf2.setDescription(
 392             "This is a very long description which should be truncated");
 393     sar.createSequenceAnnotationReport(sb, seq, false, true, fr);
 394     expected = "<i>SeqDesc\n" + "\n"
 395             + "<br/>Metal ; Desc<br/>Type1 ; Nonpos<br/>Variant ; This is a very long description which sh...; clinical_significance=benign</i>";
 396     assertEquals(expected, sb.toString());
 397
 398     // see other tests for treatment of status and html
 399   }
 400
 401   /**
 402    * Test that exercises an abbreviated sequence details report, with ellipsis
 403    * where there are more than 40 different sources, or more than 4 dbrefs for a
 404    * single source
 405    */
 406   @Test(groups = "Functional")
 407   public void testCreateSequenceAnnotationReport_withEllipsis()
 408   {
 409     SequenceAnnotationReport sar = new SequenceAnnotationReport(false);
 410     StringBuilder sb = new StringBuilder();
 411
 412     SequenceI seq = new Sequence("s1", "ABC");
 413
 414     int maxSources = (int) PA.getValue(sar, "MAX_SOURCES");
 415     for (int i = 0; i <= maxSources; i++)
 416     {
 417       seq.addDBRef(new DBRefEntry("PDB" + i, "0", "3iu1"));
 418     }
 419
 420     int maxRefs = (int) PA.getValue(sar, "MAX_REFS_PER_SOURCE");
 421     for (int i = 0; i <= maxRefs; i++)
 422     {
 423       seq.addDBRef(new DBRefEntry("Uniprot", "0", "P3041" + i));
 424     }
 425
 426     sar.createSequenceAnnotationReport(sb, seq, true, true, null, true);
 427     String report = sb.toString();
 428     assertTrue(report.startsWith("<i>\n" + "<br/>\n" + "UNIPROT P30410,\n"
 429             + " P30411,\n" + " P30412,\n" + " P30413,...<br/>\n"
 430             + "PDB0 3iu1<br/>\n" + "PDB1 3iu1<br/>"));
 431     assertTrue(report.endsWith("PDB5 3iu1<br/>\n" + "PDB6 3iu1<br/>\n"
 432             + "PDB7 3iu1<br/>\n" + "PDB8,...<br/>\n"
 433             + "(Output Sequence Details to list all database references)\n"
 434             + "</i>"));
 435   }
 436
 437   /**
 438    * Test adding a linked feature to the tooltip
 439    */
 440   @Test(groups = "Functional")
 441   public void testAppendFeature_virtualFeature()
 442   {
 443     /*
 444      * map CDS to peptide sequence
 445      */
 446     SequenceI cds = new Sequence("Cds/101-121", "CCTttgAGAtttCAAatgGAT");
 447     SequenceI peptide = new Sequence("Peptide/8-14", "PLRFQMD");
 448     MapList map = new MapList(new int[] { 101, 118 }, new int[] { 8, 13 },
 449             3, 1);
 450     Mapping mapping = new Mapping(peptide, map);
 451
 452     /*
 453      * assume variant feature found at CDS position 106 G>C
 454      */
 455     List<SequenceFeature> features = new ArrayList<>();
 456     // vary ttg (Leu) to ttc (Phe)
 457     SequenceFeature sf = new SequenceFeature("variant", "G,C", 106, 106,
 458             Float.NaN, null);
 459     features.add(sf);
 460     MappedFeatures mf = new MappedFeatures(mapping, cds, 9, 'L', features);
 461
 462     StringBuilder sb = new StringBuilder();
 463     SequenceAnnotationReport sar = new SequenceAnnotationReport(false);
 464     sar.appendFeature(sb, 1, null, sf, mf, 0);
 465
 466     /*
 467      * linked feature shown in tooltip in protein coordinates
 468      */
 469     assertEquals("variant 9; G,C", sb.toString());
 470
 471     /*
 472      * adding "alleles" attribute to variant allows peptide consequence
 473      * to be calculated and added to the tooltip
 474      */
 475     sf.setValue("alleles", "G,C");
 476     sb = new StringBuilder();
 477     sar.appendFeature(sb, 1, null, sf, mf, 0);
 478     assertEquals("variant 9; G,C p.Leu9Phe", sb.toString());
 479
 480     /*
 481      * now a virtual peptide feature on CDS
 482      * feature at 11-12 on peptide maps to 110-115 on CDS
 483      * here we test for tooltip at 113 (t)
 484      */
 485     SequenceFeature sf2 = new SequenceFeature("metal", "Fe", 11, 12, 2.3f,
 486             "Uniprot");
 487     features.clear();
 488     features.add(sf2);
 489     mapping = new Mapping(peptide, map);
 490     mf = new MappedFeatures(mapping, peptide, 113, 't', features);
 491     sb = new StringBuilder();
 492     sar.appendFeature(sb, 1, null, sf2, mf, 0);
 493     assertEquals("metal 110 115; Fe Score=2.3", sb.toString());
 494   }
 495 }