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 jalview.api.FeatureColourI;
  27 import jalview.datamodel.DBRefEntry;
  28 import jalview.datamodel.Sequence;
  29 import jalview.datamodel.SequenceFeature;
  30 import jalview.datamodel.SequenceI;
  31 import jalview.gui.JvOptionPane;
  32 import jalview.io.gff.GffConstants;
  33 import jalview.renderer.seqfeatures.FeatureRenderer;
  34 import jalview.schemes.FeatureColour;
  35 import jalview.viewmodel.seqfeatures.FeatureRendererModel;
  36
  37 import java.awt.Color;
  38 import java.util.Map;
  39
  40 import org.testng.annotations.BeforeClass;
  41 import org.testng.annotations.Test;
  42
  43 import junit.extensions.PA;
  44
  45 public class SequenceAnnotationReportTest
  46 {
  47
  48   @BeforeClass(alwaysRun = true)
  49   public void setUpJvOptionPane()
  50   {
  51     JvOptionPane.setInteractiveMode(false);
  52     JvOptionPane.setMockResponse(JvOptionPane.CANCEL_OPTION);
  53   }
  54
  55   @Test(groups = "Functional")
  56   public void testAppendFeature_disulfideBond()
  57   {
  58     SequenceAnnotationReport sar = new SequenceAnnotationReport(null);
  59     StringBuilder sb = new StringBuilder();
  60     sb.append("123456");
  61     SequenceFeature sf = new SequenceFeature("disulfide bond", "desc", 1,
  62             3, 1.2f, "group");
  63
  64     // residuePos == 2 does not match start or end of feature, nothing done:
  65     sar.appendFeature(sb, 2, null, sf, null);
  66     assertEquals("123456", sb.toString());
  67
  68     // residuePos == 1 matches start of feature, text appended (but no <br>)
  69     // feature score is not included
  70     sar.appendFeature(sb, 1, null, sf, null);
  71     assertEquals("123456disulfide bond 1:3", sb.toString());
  72
  73     // residuePos == 3 matches end of feature, text appended
  74     // <br> is prefixed once sb.length() > 6
  75     sar.appendFeature(sb, 3, null, sf, null);
  76     assertEquals("123456disulfide bond 1:3<br>disulfide bond 1:3",
  77             sb.toString());
  78   }
  79
  80   @Test(groups = "Functional")
  81   public void testAppendFeature_status()
  82   {
  83     SequenceAnnotationReport sar = new SequenceAnnotationReport(null);
  84     StringBuilder sb = new StringBuilder();
  85     SequenceFeature sf = new SequenceFeature("METAL", "Fe2-S", 1, 3,
  86             Float.NaN, "group");
  87     sf.setStatus("Confirmed");
  88
  89     sar.appendFeature(sb, 1, null, sf, null);
  90     assertEquals("METAL 1 3; Fe2-S; (Confirmed)", sb.toString());
  91   }
  92
  93   @Test(groups = "Functional")
  94   public void testAppendFeature_withScore()
  95   {
  96     SequenceAnnotationReport sar = new SequenceAnnotationReport(null);
  97     StringBuilder sb = new StringBuilder();
  98     SequenceFeature sf = new SequenceFeature("METAL", "Fe2-S", 1, 3, 1.3f,
  99             "group");
 100
 101     FeatureRendererModel fr = new FeatureRenderer(null);
 102     Map<String, float[][]> minmax = fr.getMinMax();
 103     sar.appendFeature(sb, 1, fr, sf, null);
 104     /*
 105      * map has no entry for this feature type - score is not shown:
 106      */
 107     assertEquals("METAL 1 3; Fe2-S", sb.toString());
 108
 109     /*
 110      * map has entry for this feature type - score is shown:
 111      */
 112     minmax.put("METAL", new float[][] { { 0f, 1f }, null });
 113     sar.appendFeature(sb, 1, fr, sf, null);
 114     // <br> is appended to a buffer > 6 in length
 115     assertEquals("METAL 1 3; Fe2-S<br>METAL 1 3; Fe2-S Score=1.3",
 116             sb.toString());
 117
 118     /*
 119      * map has min == max for this feature type - score is not shown:
 120      */
 121     minmax.put("METAL", new float[][] { { 2f, 2f }, null });
 122     sb.setLength(0);
 123     sar.appendFeature(sb, 1, fr, sf, null);
 124     assertEquals("METAL 1 3; Fe2-S", sb.toString());
 125   }
 126
 127   @Test(groups = "Functional")
 128   public void testAppendFeature_noScore()
 129   {
 130     SequenceAnnotationReport sar = new SequenceAnnotationReport(null);
 131     StringBuilder sb = new StringBuilder();
 132     SequenceFeature sf = new SequenceFeature("METAL", "Fe2-S", 1, 3,
 133             Float.NaN, "group");
 134
 135     sar.appendFeature(sb, 1, null, sf, null);
 136     assertEquals("METAL 1 3; Fe2-S", sb.toString());
 137   }
 138
 139   /**
 140    * A specific attribute value is included if it is used to colour the feature
 141    */
 142   @Test(groups = "Functional")
 143   public void testAppendFeature_colouredByAttribute()
 144   {
 145     SequenceAnnotationReport sar = new SequenceAnnotationReport(null);
 146     StringBuilder sb = new StringBuilder();
 147     SequenceFeature sf = new SequenceFeature("METAL", "Fe2-S", 1, 3,
 148             Float.NaN, "group");
 149     sf.setValue("clinical_significance", "Benign");
 150
 151     /*
 152      * first with no colour by attribute
 153      */
 154     FeatureRendererModel fr = new FeatureRenderer(null);
 155     sar.appendFeature(sb, 1, fr, sf, null);
 156     assertEquals("METAL 1 3; Fe2-S", sb.toString());
 157
 158     /*
 159      * then with colour by an attribute the feature lacks
 160      */
 161     FeatureColourI fc = new FeatureColour(null, Color.white, Color.black,
 162             null, 5, 10);
 163     fc.setAttributeName("Pfam");
 164     fr.setColour("METAL", fc);
 165     sb.setLength(0);
 166     sar.appendFeature(sb, 1, fr, sf, null);
 167     assertEquals("METAL 1 3; Fe2-S", sb.toString()); // no change
 168
 169     /*
 170      * then with colour by an attribute the feature has
 171      */
 172     fc.setAttributeName("clinical_significance");
 173     sb.setLength(0);
 174     sar.appendFeature(sb, 1, fr, sf, null);
 175     assertEquals("METAL 1 3; Fe2-S; clinical_significance=Benign",
 176             sb.toString());
 177   }
 178
 179   @Test(groups = "Functional")
 180   public void testAppendFeature_withScoreStatusAttribute()
 181   {
 182     SequenceAnnotationReport sar = new SequenceAnnotationReport(null);
 183     StringBuilder sb = new StringBuilder();
 184     SequenceFeature sf = new SequenceFeature("METAL", "Fe2-S", 1, 3, 1.3f,
 185             "group");
 186     sf.setStatus("Confirmed");
 187     sf.setValue("clinical_significance", "Benign");
 188
 189     FeatureRendererModel fr = new FeatureRenderer(null);
 190     Map<String, float[][]> minmax = fr.getMinMax();
 191     FeatureColourI fc = new FeatureColour(null, Color.white, Color.blue,
 192             null, 12, 22);
 193     fc.setAttributeName("clinical_significance");
 194     fr.setColour("METAL", fc);
 195     minmax.put("METAL", new float[][] { { 0f, 1f }, null });
 196     sar.appendFeature(sb, 1, fr, sf, null);
 197
 198     assertEquals(
 199             "METAL 1 3; Fe2-S Score=1.3; (Confirmed); clinical_significance=Benign",
 200             sb.toString());
 201   }
 202
 203   @Test(groups = "Functional")
 204   public void testAppendFeature_DescEqualsType()
 205   {
 206     SequenceAnnotationReport sar = new SequenceAnnotationReport(null);
 207     StringBuilder sb = new StringBuilder();
 208     SequenceFeature sf = new SequenceFeature("METAL", "METAL", 1, 3,
 209             Float.NaN, "group");
 210
 211     // description is not included if it duplicates type:
 212     sar.appendFeature(sb, 1, null, sf, null);
 213     assertEquals("METAL 1 3", sb.toString());
 214
 215     sb.setLength(0);
 216     sf.setDescription("Metal");
 217     // test is case-sensitive:
 218     sar.appendFeature(sb, 1, null, sf, null);
 219     assertEquals("METAL 1 3; Metal", sb.toString());
 220   }
 221
 222   @Test(groups = "Functional")
 223   public void testAppendFeature_stripHtml()
 224   {
 225     SequenceAnnotationReport sar = new SequenceAnnotationReport(null);
 226     StringBuilder sb = new StringBuilder();
 227     SequenceFeature sf = new SequenceFeature("METAL",
 228             "<html><body>hello<em>world</em></body></html>", 1, 3,
 229             Float.NaN, "group");
 230
 231     sar.appendFeature(sb, 1, null, sf, null);
 232     // !! strips off </body> but not <body> ??
 233     assertEquals("METAL 1 3; <body>hello<em>world</em>", sb.toString());
 234
 235     sb.setLength(0);
 236     sf.setDescription("<br>&kHD>6");
 237     sar.appendFeature(sb, 1, null, sf, null);
 238     // if no <html> tag, html-encodes > and < (only):
 239     assertEquals("METAL 1 3; &lt;br&gt;&kHD&gt;6", sb.toString());
 240   }
 241
 242   @Test(groups = "Functional")
 243   public void testCreateSequenceAnnotationReport()
 244   {
 245     SequenceAnnotationReport sar = new SequenceAnnotationReport(null);
 246     StringBuilder sb = new StringBuilder();
 247
 248     SequenceI seq = new Sequence("s1", "MAKLKRFQSSTLL");
 249     seq.setDescription("SeqDesc");
 250
 251     sar.createSequenceAnnotationReport(sb, seq, true, true, null);
 252
 253     /*
 254      * positional features are ignored
 255      */
 256     seq.addSequenceFeature(new SequenceFeature("Domain", "Ferredoxin", 5,
 257             10, 1f, null));
 258     assertEquals("<i><br>SeqDesc</i>", sb.toString());
 259
 260     /*
 261      * non-positional feature
 262      */
 263     seq.addSequenceFeature(new SequenceFeature("Type1", "Nonpos", 0, 0, 1f,
 264             null));
 265     sb.setLength(0);
 266     sar.createSequenceAnnotationReport(sb, seq, true, true, null);
 267     String expected = "<i><br>SeqDesc<br>Type1 ; Nonpos Score=1.0</i>";
 268     assertEquals(expected, sb.toString());
 269
 270     /*
 271      * non-positional features not wanted
 272      */
 273     sb.setLength(0);
 274     sar.createSequenceAnnotationReport(sb, seq, true, false, null);
 275     assertEquals("<i><br>SeqDesc</i>", sb.toString());
 276
 277     /*
 278      * add non-pos feature with score inside min-max range for feature type
 279      * minmax holds { [positionalMin, positionalMax], [nonPosMin, nonPosMax] }
 280      * score is only appended for positional features so ignored here!
 281      * minMax are not recorded for non-positional features
 282      */
 283     seq.addSequenceFeature(new SequenceFeature("Metal", "Desc", 0, 0, 5f,
 284             null));
 285
 286     FeatureRendererModel fr = new FeatureRenderer(null);
 287     Map<String, float[][]> minmax = fr.getMinMax();
 288     minmax.put("Metal", new float[][] { null, new float[] { 2f, 5f } });
 289
 290     sb.setLength(0);
 291     sar.createSequenceAnnotationReport(sb, seq, true, true, fr);
 292     expected = "<i><br>SeqDesc<br>Metal ; Desc<br>Type1 ; Nonpos</i>";
 293     assertEquals(expected, sb.toString());
 294
 295     /*
 296      * 'linkonly' features are ignored; this is obsolete, as linkonly
 297      * is only set by DasSequenceFetcher, and DAS is history
 298      */
 299     SequenceFeature sf = new SequenceFeature("Metal", "Desc", 0, 0, 5f,
 300             null);
 301     sf.setValue("linkonly", Boolean.TRUE);
 302     seq.addSequenceFeature(sf);
 303     sb.setLength(0);
 304     sar.createSequenceAnnotationReport(sb, seq, true, true, fr);
 305     assertEquals(expected, sb.toString()); // unchanged!
 306
 307     /*
 308      * 'clinical_significance' attribute only included when
 309      * used for feature colouring
 310      */
 311     SequenceFeature sf2 = new SequenceFeature("Variant", "Havana", 0, 0,
 312             5f, null);
 313     sf2.setValue(GffConstants.CLINICAL_SIGNIFICANCE, "benign");
 314     seq.addSequenceFeature(sf2);
 315     sb.setLength(0);
 316     sar.createSequenceAnnotationReport(sb, seq, true, true, fr);
 317     expected = "<i><br>SeqDesc<br>Metal ; Desc<br>Type1 ; Nonpos<br>Variant ; Havana</i>";
 318     assertEquals(expected, sb.toString());
 319
 320     /*
 321      * add dbrefs
 322      */
 323     seq.addDBRef(new DBRefEntry("PDB", "0", "3iu1"));
 324     seq.addDBRef(new DBRefEntry("Uniprot", "1", "P30419"));
 325
 326     // with showDbRefs = false
 327     sb.setLength(0);
 328     sar.createSequenceAnnotationReport(sb, seq, false, true, fr);
 329     assertEquals(expected, sb.toString()); // unchanged
 330
 331     // with showDbRefs = true, colour Variant features by clinical_significance
 332     sb.setLength(0);
 333     FeatureColourI fc = new FeatureColour(null, Color.green, Color.pink,
 334             null, 2, 3);
 335     fc.setAttributeName("clinical_significance");
 336     fr.setColour("Variant", fc);
 337     sar.createSequenceAnnotationReport(sb, seq, true, true, fr);
 338     expected = "<i><br>SeqDesc<br>UNIPROT P30419<br>PDB 3iu1<br>Metal ; Desc<br>"
 339             + "Type1 ; Nonpos<br>Variant ; Havana; clinical_significance=benign</i>";
 340     assertEquals(expected, sb.toString());
 341     // with showNonPositionalFeatures = false
 342     sb.setLength(0);
 343     sar.createSequenceAnnotationReport(sb, seq, true, false, fr);
 344     expected = "<i><br>SeqDesc<br>UNIPROT P30419<br>PDB 3iu1</i>";
 345     assertEquals(expected, sb.toString());
 346
 347     // see other tests for treatment of status and html
 348   }
 349
 350   /**
 351    * Test that exercises an abbreviated sequence details report, with ellipsis
 352    * where there are more than 40 different sources, or more than 4 dbrefs for a
 353    * single source
 354    */
 355   @Test(groups = "Functional")
 356   public void testCreateSequenceAnnotationReport_withEllipsis()
 357   {
 358     SequenceAnnotationReport sar = new SequenceAnnotationReport(null);
 359     StringBuilder sb = new StringBuilder();
 360
 361     SequenceI seq = new Sequence("s1", "ABC");
 362
 363     int maxSources = (int) PA.getValue(sar, "MAX_SOURCES");
 364     for (int i = 0; i <= maxSources; i++)
 365     {
 366       seq.addDBRef(new DBRefEntry("PDB" + i, "0", "3iu1"));
 367     }
 368
 369     int maxRefs = (int) PA.getValue(sar, "MAX_REFS_PER_SOURCE");
 370     for (int i = 0; i <= maxRefs; i++)
 371     {
 372       seq.addDBRef(new DBRefEntry("Uniprot", "0", "P3041" + i));
 373     }
 374
 375     sar.createSequenceAnnotationReport(sb, seq, true, true, null, true);
 376     String report = sb.toString();
 377     assertTrue(report
 378             .startsWith("<i><br>UNIPROT P30410, P30411, P30412, P30413,...<br>PDB0 3iu1"));
 379     assertTrue(report
 380             .endsWith("<br>PDB7 3iu1<br>PDB8,...<br>(Output Sequence Details to list all database references)</i>"));
 381   }
 382 }