WIP BCF 2.2

.github/workflows/tests.yml

@@ -11,6 +11,7 @@ jobs:
   test:
     env:
       HTSJDK_SAMTOOLS_BIN: /usr/bin/samtools
+      HTSJDK_BCFTOOLS_BIN: /usr/bin/bcftools
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -36,6 +37,8 @@ jobs:
         run: ./gradlew compileJava
       - name: Install Samtools
         run: scripts/install-samtools.sh
+      - name: Install Bcftools
+        run: scripts/install-bcftools.sh
       - name: Start the htsget server
         run: scripts/htsget-scripts/start-htsget-test-server.sh
       - name: Run tests

.travis.yml

@@ -13,6 +13,7 @@ cache:
 env:
   global:
     - HTSJDK_SAMTOOLS_BIN=/usr/bin/samtools
+    - HTSJDK_BCFTOOLS_BIN=/usr/bin/bcftools
 jdk:
   - oraclejdk8
   - openjdk8
@@ -32,6 +33,7 @@ matrix:
 
 before_install:
   - scripts/install-samtools.sh
+  - scripts/install-bcftools.sh
   - scripts/htsget-scripts/start-htsget-test-server.sh
 
 script:

scripts/install-bcftools.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+set -ex
+wget https://github.com/samtools/bcftools/releases/download/1.14/bcftools-1.14.tar.bz2
+tar -xjvf bcftools-1.14.tar.bz2
+cd bcftools-1.14 && ./configure --prefix=/usr && make && sudo make install

src/main/java/htsjdk/samtools/Defaults.java

@@ -1,6 +1,7 @@
 package htsjdk.samtools;
 
 import htsjdk.samtools.util.Log;
+import htsjdk.variant.variantcontext.writer.VCFVersionUpgradePolicy;
 
 import java.io.File;
 import java.util.Collections;
@@ -110,6 +111,16 @@ public class Defaults {
      */
     public static final boolean DISABLE_SNAPPY_COMPRESSOR;
 
+    /**
+     * Strict VCF version validation.  Default = true.
+     */
+    public static final boolean STRICT_VCF_VERSION_VALIDATION;
+
+    /**
+     * How to treat files from VCF versions older than the current version. Default = UPGRADE_OR_FALLBACK
+     */
+    public static final VCFVersionUpgradePolicy VCF_VERSION_TRANSITION_POLICY;
+
 
     public static final String SAMJDK_PREFIX = "samjdk.";
     static {
@@ -134,6 +145,11 @@ public class Defaults {
         SAM_FLAG_FIELD_FORMAT = SamFlagField.valueOf(getStringProperty("sam_flag_field_format", SamFlagField.DECIMAL.name()));
         SRA_LIBRARIES_DOWNLOAD = getBooleanProperty("sra_libraries_download", false);
         DISABLE_SNAPPY_COMPRESSOR = getBooleanProperty(DISABLE_SNAPPY_PROPERTY_NAME, false);
+        STRICT_VCF_VERSION_VALIDATION = getBooleanProperty("strict_version_validation", true);
+        VCF_VERSION_TRANSITION_POLICY = VCFVersionUpgradePolicy.valueOf(getStringProperty(
+            "vcf_version_transition_policy",
+            VCFVersionUpgradePolicy.UPGRADE_OR_FALLBACK.name()
+        ));
     }
 
     /**
@@ -157,6 +173,7 @@ public static SortedMap<String, Object> allDefaults(){
         result.put("CUSTOM_READER_FACTORY", CUSTOM_READER_FACTORY);
         result.put("SAM_FLAG_FIELD_FORMAT", SAM_FLAG_FIELD_FORMAT);
         result.put("DISABLE_SNAPPY_COMPRESSOR", DISABLE_SNAPPY_COMPRESSOR);
+        result.put("VCF_VERSION_TRANSITION_POLICY", VCF_VERSION_TRANSITION_POLICY);
         return Collections.unmodifiableSortedMap(result);
     }
 

src/main/java/htsjdk/samtools/SAMSequenceDictionary.java

@@ -53,6 +53,13 @@ public SAMSequenceDictionary(final List<SAMSequenceRecord> list) {
         setSequences(list);
     }
 
+    //TODO: this returns sequences in the internal list order instead of
+    // honoring each sequence's contigIndex
+    /**
+     * Get a list of sequences for this dictionary.
+     * @return the list of sequences for this dictionary in internal order (the order in which the sequences
+     * were added to this dictionary)
+     */
     public List<SAMSequenceRecord> getSequences() {
         return Collections.unmodifiableList(mSequences);
     }
@@ -75,6 +82,14 @@ public void setSequences(final List<SAMSequenceRecord> list) {
         list.forEach(this::addSequence);
     }
 
+    /**
+     * Add a sequence to the dictionary.
+     * @param sequenceRecord the sequence record to add - note that this method mutates the contig
+     *                       index of the sequenceRecord to match the newly added record's relative
+     *                       order in the list
+     */
+    //TODO: this method ignores (and actually mutates) the sequenceRecord's contig index to make it match
+    // the record's relative placement in the dictionary's internal list
     public void addSequence(final SAMSequenceRecord sequenceRecord) {
         if (mSequenceMap.containsKey(sequenceRecord.getSequenceName())) {
             throw new IllegalArgumentException("Cannot add sequence that already exists in SAMSequenceDictionary: " +