code_ruby/test/maasha/test_sam.rb

   1 #!/usr/bin/env ruby
   2
   3 # Copyright (C) 2011 Martin A. Hansen.
   4
   5 # This program is free software; you can redistribute it and/or
   6 # modify it under the terms of the GNU General Public License
   7 # as published by the Free Software Foundation; either version 2
   8 # of the License, or (at your option) any later version.
   9
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program; if not, write to the Free Software
  17 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18
  19 # http://www.gnu.org/copyleft/gpl.html
  20
  21 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  22
  23 # This software is part of the Biopieces framework (www.biopieces.org).
  24
  25 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  26
  27 require 'test/unit'
  28 require 'maasha/sam'
  29 require 'pp'
  30 require 'stringio'
  31
  32 SAM_TEST =
  33 %{@HD\tVN:1.3\tSO:coordinate
  34 @SQ\tSN:ref\tLN:45
  35 @CO\tMyComment
  36 r001\t163\tref\t7\t30\t8M2I4M1D3M\t=\t37\t39\tTTAGATAAAGGATACTG\t*
  37 r002\t0\tref\t9\t30\t3S6M1P1I4M\t*\t0\t0\tAAAAGATAAGGATA\t*
  38 r003\t0\tref\t9\t30\t5H6M\t*\t0\t0\tAGCTAA\t*\tNM:i:1
  39 r004\t0\tref\t16\t30\t6M14N5M\t*\t0\t0\tATAGCTTCAGC\t*
  40 r003\t16\tref\t29\t30\t6H5M\t*\t0\t0\tTAGGC\t*\tNM:i:0
  41 r001\t83\tref\t37\t30\t9M\t=\t7\t-39\tCAGCGCCAT\t*
  42 }
  43
  44 class SamTest < Test::Unit::TestCase
  45   def setup
  46     @sam = Sam.new(StringIO.new(SAM_TEST))
  47   end
  48
  49 #  def test_Sam_header_without_entry_returns_nil
  50 #    @sam.io = StringIO.new
  51 #    assert_nil(@sam.header)
  52 #  end
  53
  54   def test_Sam_header_parse_with_missing_version_number_raises
  55     sam = Sam.new(StringIO.new("@HD"))
  56     assert_raise(SamError) { sam.header }
  57   end
  58
  59   def test_Sam_header_parse_with_bad_version_number_raises
  60     sam = Sam.new(StringIO.new("@HD\tXN:1.3"))
  61     assert_raise(SamError) { sam.header }
  62   end
  63
  64   def test_Sam_header_parse_with_ok_version_number_returns_correctly
  65     sam = Sam.new(StringIO.new("@HD\tVN:1.3"))
  66     assert_equal(1.3, sam.header[:HD][:VN])
  67   end
  68
  69   def test_Sam_header_parse_with_bad_sort_order_raises
  70     sam = Sam.new(StringIO.new("@HD\tVN:1.3\tSO:fish"))
  71     assert_raise(SamError) { sam.header }
  72   end
  73
  74   def test_Sam_header_parse_with_ok_sort_order_returns_correctly
  75     %w{unknown unsorted queryname coordinate}.each do |order|
  76       sam = Sam.new(StringIO.new("@HD\tVN:1.3\tSO:#{order}"))
  77       assert_equal(order, sam.header[:HD][:SO])
  78     end
  79   end
  80
  81   def test_Sam_header_parse_with_missing_sequence_name_raises
  82     sam = Sam.new(StringIO.new("@SQ"))
  83     assert_raise(SamError) { sam.header }
  84   end
  85
  86   def test_Sam_header_parse_with_bad_sequence_name_raises
  87     sam = Sam.new(StringIO.new("@SQ\tSN:"))
  88     assert_raise(SamError) { sam.header }
  89   end
  90
  91   def test_Sam_header_parse_with_ok_sequence_name_returns_correctly
  92     sam = Sam.new(StringIO.new("@SQ\tSN:ref\tLN:45"))
  93     assert_equal({:LN=>45}, sam.header[:SQ][:SN][:ref])
  94   end
  95
  96   def test_Sam_header_parse_with_duplicate_sequence_name_raises
  97     sam = Sam.new(StringIO.new("@SQ\tSN:ref\n@SQ\tSN:ref"))
  98     assert_raise(SamError) { sam.header[:SQ][:SN][:ref] }
  99   end
 100
 101   def test_Sam_header_parse_with_missing_sequence_length_raises
 102     sam = Sam.new(StringIO.new("@SQ\tSN:ref"))
 103     assert_raise(SamError) { sam.header }
 104   end
 105
 106   def test_Sam_header_parse_with_bad_sequence_length_raises
 107     sam = Sam.new(StringIO.new("@SQ\tSN:scaffold17_1_MH0083\tLN:x"))
 108     assert_raise(SamError) { sam.header }
 109   end
 110
 111   def test_Sam_header_parse_with_ok_sequence_length_returns_correctly
 112     sam = Sam.new(StringIO.new("@SQ\tSN:scaffold17_1_MH0083\tLN:995"))
 113     assert_equal(995, sam.header[:SQ][:SN][:scaffold17_1_MH0083][:LN])
 114   end
 115
 116   def test_Sam_header_parse_with_full_SQ_dont_raise
 117     sam = Sam.new("@SQ\tSN:ref\tLN:45\tAS:ident\tM5:87e6b2aedf51b1f9c89becfab9267f41\tSP:E.coli\tUR:http://www.biopieces.org")
 118     assert_nothing_raised { sam.header }
 119   end
 120
 121   def test_Sam_header_parse_with_bad_read_group_identifier_raises
 122     sam = Sam.new(StringIO.new("@RG\tID:"))
 123     assert_raise(SamError) { sam.header }
 124   end
 125
 126   def test_Sam_header_parse_with_missing_read_group_identifier_raises
 127     sam = Sam.new(StringIO.new("@RG"))
 128     assert_raise(SamError) { sam.header }
 129   end
 130
 131   def test_Sam_header_parse_with_duplicate_read_group_identifier_raises
 132     sam = Sam.new(StringIO.new("@RG\tID:123\n@RG\tID:123"))
 133     assert_raise(SamError) { sam.header }
 134   end
 135
 136   def test_Sam_header_parse_with_ok_read_group_identifier_dont_raise
 137     sam = Sam.new(StringIO.new("@RG\tID:123\n@RG\tID:124"))
 138     assert_nothing_raised { sam.header }
 139   end
 140
 141   def test_Sam_header_parse_with_bad_flow_order_raises
 142     sam = Sam.new(StringIO.new("@RG\tID:123\tFO:3"))
 143     assert_raise(SamError) { sam.header }
 144   end
 145
 146   def test_Sam_header_parse_with_ok_flow_order_dont_raise
 147     sam = Sam.new(StringIO.new("@RG\tID:123\tFO:*"))
 148     assert_nothing_raised { sam.header }
 149     sam = Sam.new(StringIO.new("@RG\tID:123\tFO:ACMGRSVTWYHKDBN"))
 150     assert_nothing_raised { sam.header }
 151   end
 152
 153   def test_Sam_header_parse_with_bad_platform_raises
 154     sam = Sam.new(StringIO.new("@RG\tID:123\tPL:maersk"))
 155     assert_raise(SamError) { sam.header }
 156   end
 157
 158   def test_Sam_header_parse_with_ok_platform_dont_raise
 159     sam = Sam.new(StringIO.new("@RG\tID:123\tPL:ILLUMINA"))
 160     assert_nothing_raised { sam.header }
 161   end
 162
 163   def test_Sam_header_parse_with_bad_program_identifier_raises
 164     sam = Sam.new(StringIO.new("@PG\tID:"))
 165     assert_raise(SamError) { sam.header }
 166   end
 167
 168   def test_Sam_header_parse_with_missing_program_identifier_raises
 169     sam = Sam.new(StringIO.new("@PG"))
 170     assert_raise(SamError) { sam.header }
 171   end
 172
 173   def test_Sam_header_parse_with_duplicate_program_identifier_raises
 174     sam = Sam.new(StringIO.new("@PG\tID:123\n@PG\tID:123"))
 175     assert_raise(SamError) { sam.header }
 176   end
 177
 178   def test_Sam_header_parse_with_bad_comment_raises
 179     sam = Sam.new(StringIO.new("@CO\t"))
 180     assert_raise(SamError) { sam.header }
 181   end
 182
 183   def test_Sam_header_parse_with_ok_comment_dont_raise
 184     sam = Sam.new(StringIO.new("@CO\tfubar"))
 185     assert_nothing_raised { sam.header }
 186   end
 187
 188   def test_Sam_each_with_bad_field_count_raises
 189     fields = []
 190
 191     (0 ... 11).each do |i|
 192       sam = Sam.new(StringIO.new(fields.join("\t") + $/))
 193       assert_raise(SamError) { sam.each }
 194       fields << "*"
 195     end
 196   end
 197
 198   def test_Sam_each_with_ok_field_count_dont_raise
 199     sam = Sam.new(SAM_TEST)
 200     assert_nothing_raised { sam.each }
 201   end
 202
 203   def test_Sam_each_with_bad_qname_raises
 204     sam = Sam.new(" \t*\t*\t*\t*\t*\t*\t*\t*\t*\t*\n")
 205     assert_raise(SamError) { sam.each }
 206   end
 207
 208   def test_Sam_each_with_ok_qname_dont_raise
 209     sam = Sam.new("*\t*\t*\t*\t*\t*\t*\t*\t*\t*\t*\n")
 210     assert_nothing_raised(SamError) { sam.each }
 211   end
 212
 213   def test_Sam_each_with_bad_flag_raises
 214     sam = Sam.new("*\t-1\t*\t*\t*\t*\t*\t*\t*\t*\t*\n")
 215     assert_raise(SamError) { sam.each }
 216
 217     sam = Sam.new("*\t65536\t*\t*\t*\t*\t*\t*\t*\t*\t*\n")
 218     assert_raise(SamError) { sam.each }
 219   end
 220
 221   def test_Sam_each_with_ok_flag_dont_raise
 222     sam = Sam.new("*\t0\t*\t*\t*\t*\t*\t*\t*\t*\t*\n")
 223     assert_nothing_raised { sam.each }
 224
 225     sam = Sam.new("*\t65535\t*\t*\t*\t*\t*\t*\t*\t*\t*\n")
 226     assert_nothing_raised { sam.each }
 227   end
 228
 229   def test_Sam_each_with_bad_rname_raises
 230     sam = Sam.new("*\t*\t \t*\t*\t*\t*\t*\t*\t*\t*\n")
 231     assert_raise(SamError) { sam.each }
 232   end
 233
 234   def test_Sam_each_with_ok_rname_dont_raise
 235     sam = Sam.new("*\t*\t*\t*\t*\t*\t*\t*\t*\t*\t*\n")
 236     assert_nothing_raised { sam.each }
 237   end
 238
 239   def test_Sam_each_with_bad_pos_raises
 240     sam = Sam.new("*\t*\t*\t-1\t*\t*\t*\t*\t*\t*\t*\n")
 241     assert_raise(SamError) { sam.each }
 242
 243     sam = Sam.new("*\t*\t*\t536870912\t*\t*\t*\t*\t*\t*\t*\n")
 244     assert_raise(SamError) { sam.each }
 245   end
 246
 247   def test_Sam_each_with_ok_pos_dont_raise
 248     sam = Sam.new("*\t*\t*\t0\t*\t*\t*\t*\t*\t*\t*\n")
 249     assert_nothing_raised { sam.each }
 250
 251     sam = Sam.new("*\t*\t*\t536870911\t*\t*\t*\t*\t*\t*\t*\n")
 252     assert_nothing_raised { sam.each }
 253   end
 254
 255   def test_Sam_each_with_bad_mapq_raises
 256     sam = Sam.new("*\t*\t*\t*\t-1\t*\t*\t*\t*\t*\t*\n")
 257     assert_raise(SamError) { sam.each }
 258
 259     sam = Sam.new("*\t*\t*\t*\t256\t*\t*\t*\t*\t*\t*\n")
 260     assert_raise(SamError) { sam.each }
 261   end
 262
 263   def test_Sam_each_with_ok_mapq_dont_raise
 264     sam = Sam.new("*\t*\t*\t*\t0\t*\t*\t*\t*\t*\t*\n")
 265     assert_nothing_raised { sam.each }
 266
 267     sam = Sam.new("*\t*\t*\t*\t255\t*\t*\t*\t*\t*\t*\n")
 268     assert_nothing_raised { sam.each }
 269   end
 270
 271   def test_Sam_each_with_bad_cigar_raises
 272     sam = Sam.new("*\t*\t*\t*\t*\t24\t*\t*\t*\t*\t*\n")
 273     assert_raise(SamError) { sam.each }
 274   end
 275
 276   def test_Sam_each_with_ok_cigar_dont_raise
 277     sam = Sam.new("*\t*\t*\t*\t*\t24M2I3D\t*\t*\t*\t*\t*\n")
 278     assert_nothing_raised { sam.each }
 279
 280     sam = Sam.new("*\t*\t*\t*\t*\t*\t*\t*\t*\t*\t*\n")
 281     assert_nothing_raised { sam.each }
 282   end
 283
 284   def test_Sam_each_with_bad_rnext_raises
 285     sam = Sam.new("*\t*\t*\t*\t*\t*\t \t*\t*\t*\t*\n")
 286     assert_raise(SamError) { sam.each }
 287   end
 288
 289   def test_Sam_each_with_ok_rnext_dont_raise
 290     sam = Sam.new("*\t*\t*\t*\t*\t*\t*\t*\t*\t*\t*\n")
 291     assert_nothing_raised { sam.each }
 292
 293     sam = Sam.new("*\t*\t*\t*\t*\t*\t=\t*\t*\t*\t*\n")
 294     assert_nothing_raised { sam.each }
 295
 296     sam = Sam.new("*\t*\t*\t*\t*\t*\t!\t*\t*\t*\t*\n")
 297     assert_nothing_raised { sam.each }
 298   end
 299
 300   def test_Sam_each_with_bad_pnext_raises
 301     sam = Sam.new("*\t*\t*\t*\t*\t*\t*\t-1\t*\t*\t*\n")
 302     assert_raise(SamError) { sam.each }
 303
 304     sam = Sam.new("*\t*\t*\t*\t*\t*\t*\t536870912\t*\t*\t*\n")
 305     assert_raise(SamError) { sam.each }
 306   end
 307
 308   def test_Sam_each_with_ok_pnext_dont_raise
 309     sam = Sam.new("*\t*\t*\t*\t*\t*\t*\t0\t*\t*\t*\n")
 310     assert_nothing_raised { sam.each }
 311
 312     sam = Sam.new("*\t*\t*\t*\t*\t*\t536870911\t*\t*\t*\t*\n")
 313     assert_nothing_raised { sam.each }
 314   end
 315
 316   def test_Sam_each_with_bad_tlen_raises
 317     sam = Sam.new("*\t*\t*\t*\t*\t*\t*\t*\t-536870912\t*\t*\n")
 318     assert_raise(SamError) { sam.each }
 319
 320     sam = Sam.new("*\t*\t*\t*\t*\t*\t*\t*\t536870912\t*\t*\n")
 321     assert_raise(SamError) { sam.each }
 322   end
 323
 324   def test_Sam_each_with_ok_tlen_dont_raise
 325     sam = Sam.new("*\t*\t*\t*\t*\t*\t*\t*\t-536870911\t*\t*\n")
 326     assert_nothing_raised { sam.each }
 327
 328     sam = Sam.new("*\t*\t*\t*\t*\t*\t*\t*\t536870911\t*\t*\n")
 329     assert_nothing_raised { sam.each }
 330   end
 331
 332   def test_Sam_each_with_bad_seq_raises
 333     sam = Sam.new("*\t*\t*\t*\t*\t*\t*\t*\t\*\t \t*\n")
 334     assert_raise(SamError) { sam.each }
 335   end
 336
 337   def test_Sam_each_with_ok_seq_dont_raise
 338     sam = Sam.new("*\t*\t*\t*\t*\t*\t*\t*\t\*\t*\t*\n")
 339     assert_nothing_raised { sam.each }
 340
 341     sam = Sam.new("*\t*\t*\t*\t*\t*\t*\t*\t\*\tATCGatcg=.\t*\n")
 342     assert_nothing_raised { sam.each }
 343   end
 344
 345   def test_Sam_each_with_bad_qual_raises
 346     sam = Sam.new("*\t*\t*\t*\t*\t*\t*\t*\t\*\t*\t \n")
 347     assert_raise(SamError) { sam.each }
 348   end
 349
 350   def test_Sam_each_with_ok_qual_dont_raise
 351     sam = Sam.new("*\t*\t*\t*\t*\t*\t*\t*\t\*\t*\t@\n")
 352     assert_nothing_raised(SamError) { sam.each }
 353   end
 354 end
 355