test/jalview/ext/htsjdk/TestHtsContigDb.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.htsjdk;
  22
  23 import static org.testng.Assert.assertEquals;
  24 import static org.testng.Assert.assertFalse;
  25 import static org.testng.Assert.assertNotNull;
  26 import static org.testng.Assert.assertTrue;
  27 import static org.testng.Assert.fail;
  28
  29 import jalview.datamodel.SequenceI;
  30
  31 import java.io.File;
  32 import java.io.IOException;
  33 import java.nio.file.Files;
  34 import java.nio.file.StandardCopyOption;
  35
  36 import org.testng.annotations.Test;
  37
  38 /**
  39  * @author jprocter
  40  *
  41  */
  42 public class TestHtsContigDb
  43 {
  44   @Test(groups = "Functional")
  45   public final void testGetSequenceProxy() throws Exception
  46   {
  47     String pathname = "test/jalview/ext/htsjdk/pgmb.fasta";
  48     HtsContigDb db = new HtsContigDb("ADB", new File(pathname));
  49
  50     assertTrue(db.isValid());
  51     assertTrue(db.isIndexed()); // htsjdk opens the .fai file
  52
  53     SequenceI sq = db.getSequenceProxy("Deminut");
  54     assertNotNull(sq);
  55     assertEquals(sq.getLength(), 606);
  56
  57     /*
  58      * read a sequence earlier in the file
  59      */
  60     sq = db.getSequenceProxy("PPL_06716");
  61     assertNotNull(sq);
  62     assertEquals(sq.getLength(), 602);
  63
  64     // dict = db.getDictionary(f, truncate))
  65   }
  66
  67   /**
  68    * Trying to open a .fai file directly results in IllegalArgumentException -
  69    * have to provide the unindexed file name instead
  70    */
  71   @Test(
  72     groups = "Functional",
  73     expectedExceptions = java.lang.IllegalArgumentException.class)
  74   public final void testGetSequenceProxy_indexed()
  75   {
  76     String pathname = "test/jalview/ext/htsjdk/pgmb.fasta.fai";
  77     new HtsContigDb("ADB", new File(pathname));
  78     fail("Expected exception opening .fai file");
  79   }
  80
  81   @Test(groups = "Functional")
  82   public void testCreateFastaSequenceIndex() throws IOException
  83   {
  84     File fasta = new File("test/jalview/ext/htsjdk/pgmb.fasta");
  85
  86     /*
  87      * create .fai with no overwrite fails if it exists
  88      */
  89     try {
  90       HtsContigDb.createFastaSequenceIndex(fasta.toPath(), false);
  91       fail("Expected exception");
  92     } catch (IOException e)
  93     {
  94       // expected
  95     }
  96
  97     /*
  98      * create a copy of the .fasta (as a temp file)
  99      */
 100     File copyFasta = File.createTempFile("copyFasta", ".fasta");
 101     copyFasta.deleteOnExit();
 102     assertTrue(copyFasta.exists());
 103     Files.copy(fasta.toPath(), copyFasta.toPath(),
 104             StandardCopyOption.REPLACE_EXISTING);
 105
 106     /*
 107      * open the Fasta file - not indexed, as no .fai file yet exists
 108      */
 109     HtsContigDb db = new HtsContigDb("ADB", copyFasta);
 110     assertTrue(db.isValid());
 111     assertFalse(db.isIndexed());
 112     db.close();
 113
 114     /*
 115      * create the .fai index, re-open the .fasta file - now indexed
 116      */
 117     HtsContigDb.createFastaSequenceIndex(copyFasta.toPath(), true);
 118     db = new HtsContigDb("ADB", copyFasta);
 119     assertTrue(db.isValid());
 120     assertTrue(db.isIndexed());
 121     db.close();
 122   }
 123 }