1 #include <boost/test/auto_unit_test.hpp>
2 #include <boost/filesystem/path.hpp>
3 #include <boost/filesystem/operations.hpp>
4 namespace fs=boost::filesystem;
10 #include <boost/archive/text_oarchive.hpp>
11 #include <boost/archive/text_iarchive.hpp>
12 #include <boost/archive/xml_oarchive.hpp>
13 #include <boost/archive/xml_iarchive.hpp>
15 #include "alg/sequence.hpp"
16 #include "mussa_exceptions.hpp"
20 //! when we try to load a missing file, do we get an error?
21 BOOST_AUTO_TEST_CASE( sequence_load_exception )
24 // there should be errors when we try to load something that doesn't exist
25 BOOST_CHECK_THROW( s.load_fasta("alkejralk", 1, 0, 0), mussa_load_error);
26 BOOST_CHECK_THROW( s.load_annot("alkejralk", 0, 0), mussa_load_error);
29 BOOST_AUTO_TEST_CASE( sequence_eol_conventions )
31 string header(">Header");
32 string line1("AAAAGGGGCCCCTTTTT");
33 string line2("AAAAGGGGCCCCTTTTT");
34 int seq_len = line1.size() + line2.size();
37 cr << header << "\015" << line1 << "\015" << line2 << "\015";
39 seq_cr.load_fasta(cr);
42 crlf << header << "\015\012" << line1 << "\015\012" << line2 << "\015\012";
44 seq_crlf.load_fasta(crlf);
47 lf << header << "\012" << line1 << "\012" << line2 << "\012";
49 seq_lf.load_fasta(lf);
51 BOOST_CHECK_EQUAL(seq_cr.size(), seq_len);
52 BOOST_CHECK_EQUAL(seq_crlf.size(), seq_len);
53 BOOST_CHECK_EQUAL(seq_cr.size(), seq_len);
57 //! Do simple operations work correctly?
58 BOOST_AUTO_TEST_CASE( sequence_filter )
60 const char *core_seq = "AATTGGCC";
61 Sequence s1(core_seq);
62 BOOST_CHECK_EQUAL(s1, core_seq);
64 Sequence s2("aattggcc");
65 BOOST_CHECK_EQUAL(s2, "AATTGGCC");
66 BOOST_CHECK_EQUAL(s2.rev_comp(), "GGCCAATT");
67 BOOST_CHECK_EQUAL(s2.size(), s2.size());
68 BOOST_CHECK_EQUAL(s2.get_sequence(), core_seq);
71 BOOST_CHECK_EQUAL(s3, "ANNNG");
72 BOOST_CHECK_EQUAL(s3.subseq(0,2), "AN");
74 s3.set_filtered_sequence("AAGGCCTT", 0, 2);
75 BOOST_CHECK_EQUAL(s3, "AA");
76 s3.set_filtered_sequence("AAGGCCTT", 2, 2);
77 BOOST_CHECK_EQUAL( s3, "GG");
78 s3.set_filtered_sequence("AAGGCCTT", 4);
79 BOOST_CHECK_EQUAL( s3, "CCTT");
82 BOOST_CHECK_EQUAL(s3, "AAGGNN");
85 BOOST_AUTO_TEST_CASE( subseq_names )
87 Sequence s1("AAGGCCTT");
88 s1.set_species("species");
89 s1.set_fasta_header("a fasta header");
90 Sequence s2 = s1.subseq(2,2);
91 BOOST_CHECK_EQUAL(s2, "GG");
92 BOOST_CHECK_EQUAL(s2.get_species(), s1.get_species());
93 BOOST_CHECK_EQUAL(s2.get_fasta_header(), s1.get_fasta_header());
96 BOOST_AUTO_TEST_CASE( sequence_start_stop )
99 BOOST_CHECK_EQUAL( s1.start(), 0 );
100 BOOST_CHECK_EQUAL( s1.stop(), 0 );
102 std::string seq_string("AAGGCCTT");
103 Sequence s2(seq_string);
104 BOOST_CHECK_EQUAL( s2.start(), 0 );
105 BOOST_CHECK_EQUAL( s2.stop(), seq_string.size() );
107 std::string s3seq_string = seq_string.substr(2,3);
108 Sequence s3 = s2.subseq(2,3);
109 BOOST_CHECK_EQUAL( s3.start(), 2);
110 BOOST_CHECK_EQUAL( s3.stop(), 2+3);
111 BOOST_CHECK_EQUAL( s3.size(), 3);
112 BOOST_CHECK_EQUAL( s3, s3seq_string);
114 std::string s4seq_string = s3seq_string.substr(1,1);
115 Sequence s4 = s3.subseq(1,1);
116 BOOST_CHECK_EQUAL( s4.start(), 1 );
117 BOOST_CHECK_EQUAL( s4.stop(), 1+1);
118 BOOST_CHECK_EQUAL( s4.size(), 1);
119 BOOST_CHECK_EQUAL( s4, s4seq_string);
122 //! Can we load data from a file
123 BOOST_AUTO_TEST_CASE( sequence_load )
125 fs::path seq_path(fs::path(EXAMPLE_DIR, fs::native)/ "seq");
126 seq_path /= "human_mck_pro.fa";
128 s.load_fasta(seq_path);
129 BOOST_CHECK_EQUAL(s.subseq(0, 5), "GGATC"); // first few chars of fasta file
130 BOOST_CHECK_EQUAL(s.subseq(2, 3), "ATC");
131 BOOST_CHECK_EQUAL(s.get_fasta_header(), "gi|180579|gb|M21487.1|HUMCKMM1 Human "
132 "muscle creatine kinase gene (CKMM), "
136 BOOST_AUTO_TEST_CASE( annotation_load )
138 string annot_data = "human\n"
142 "50\t55 anothername\n"
147 "75\t90\tname2\ttype2\n"
148 "100 120 name-asdf type!@#$%\n"
154 //istringstream annot_stream(annot_data);
155 seq.parse_annot(annot_data, 0, 0);
156 std::list<annot> annots_list = seq.annotations();
157 std::vector<annot> annots(annots_list.begin(), annots_list.end());
158 BOOST_REQUIRE_EQUAL( annots.size(), 8);
159 BOOST_CHECK_EQUAL( annots[0].begin, 0 );
160 BOOST_CHECK_EQUAL( annots[0].end, 10 );
161 BOOST_CHECK_EQUAL( annots[0].type, "type");
162 BOOST_CHECK_EQUAL( annots[0].name, "name");
163 BOOST_CHECK_EQUAL( annots[1].name, "myf7");
164 BOOST_CHECK_EQUAL( annots[2].name, "myod");
165 BOOST_CHECK_EQUAL( annots[3].name, "anothername");
166 BOOST_CHECK_EQUAL( annots[4].name, "backward");
167 BOOST_CHECK_EQUAL( annots[5].name, "name2");
168 BOOST_CHECK_EQUAL( annots[5].end, 90);
169 BOOST_CHECK_EQUAL( annots[6].begin, 100);
170 BOOST_CHECK_EQUAL( annots[6].end, 120);
171 BOOST_CHECK_EQUAL( annots[6].name, "name-asdf");
172 BOOST_CHECK_EQUAL( annots[6].type, "type!@#$%");
173 // sequence defined annotations will always be after the
174 // absolute positions
175 BOOST_CHECK_EQUAL( annots[7].name, "ident3 asdf");
176 BOOST_CHECK_EQUAL( annots[7].begin, 100);
178 //BOOST_CHECK_EQUAL( annots
182 BOOST_AUTO_TEST_CASE(annotation_ucsc_html_load)
184 // this actually is basically what's returned by UCSC
185 // (well actually with some of the sequence and copies of fasta blocks
186 // removed to make the example shorter
187 string annot_data = "\n"
189 ">hg17_knownGene_NM_001824_0 range=chr19:50517919-50517974 5'pad=0 3'pad=0 revComp=TRUE strand=- repeatMasking=none\n"
190 "GGGTCAGTGTCACCTCCAGGATACAGACAG\n"
191 ">hg17_knownGene_NM_001824_3 range=chr19:50510563-50510695 5'pad=0 3'pad=0 revComp=TRUE strand=- repeatMasking=none\n"
192 "GGTGGAGACGACCTGGACCCTAACTACGT\n"
200 "TGGGTCAGTGTCACCTCCAGGATACAGACAGCCCCCCTTCAGCCCAGCCCAGCCAG"
202 "GGTGGAGACGACCTGGACCCTAACTACGTGCTCAGCAGCCGCGTCCGCAC";
204 seq.parse_annot(annot_data);
205 std::list<annot> annots = seq.annotations();
206 BOOST_CHECK_EQUAL( annots.size(), 2);
209 BOOST_AUTO_TEST_CASE( annotation_load_no_species_name )
211 string annot_data = "0 10 name type\n"
214 "50\t55 anothername\n"
219 "75\t90\tname2\ttype2\n"
220 "100 120 name-asdf type!@#$%\n"
226 //istringstream annot_stream(annot_data);
227 seq.parse_annot(annot_data, 0, 0);
228 std::list<annot> annots_list = seq.annotations();
229 std::vector<annot> annots(annots_list.begin(), annots_list.end());
230 BOOST_REQUIRE_EQUAL( annots.size(), 8);
231 BOOST_CHECK_EQUAL( annots[0].begin, 0 );
232 BOOST_CHECK_EQUAL( annots[0].end, 10 );
233 BOOST_CHECK_EQUAL( annots[0].type, "type");
236 // ticket:83 when you try to load a sequence from a file that doesn't
237 // have fasta headers it crashes.
238 BOOST_AUTO_TEST_CASE( sequence_past_end )
240 fs::path seq_path(fs::path(EXAMPLE_DIR, fs::native)/ "seq" );
241 seq_path /= "misformated_seq.fa";
243 BOOST_CHECK_THROW( s.load_fasta(seq_path), mussa_load_error );
246 BOOST_AUTO_TEST_CASE ( sequence_empty )
250 BOOST_CHECK_EQUAL( s.empty(), true );
252 BOOST_CHECK_EQUAL( s.empty(), false );
254 BOOST_CHECK_EQUAL( s.empty(), true);
256 BOOST_CHECK_EQUAL( s.empty(), true);
259 BOOST_AUTO_TEST_CASE ( sequence_size )
263 BOOST_CHECK_EQUAL( s.size(), 0);
264 std::string seq_string("AAAGGG");
266 BOOST_CHECK_EQUAL( s.size(), seq_string.size() );
268 BOOST_CHECK_EQUAL( s.size(), 0);
270 BOOST_CHECK_EQUAL( s.size(), 0);
273 BOOST_AUTO_TEST_CASE( sequence_empty_equality )
276 BOOST_CHECK_EQUAL(szero.empty(), true);
277 BOOST_CHECK_EQUAL(szero, szero);
278 BOOST_CHECK_EQUAL(szero, "");
280 Sequence sclear("AGCT");
282 BOOST_CHECK_EQUAL(sclear.empty(), true);
283 BOOST_CHECK_EQUAL(sclear, sclear);
284 BOOST_CHECK_EQUAL(sclear, szero);
285 BOOST_CHECK_EQUAL(sclear, "");
288 BOOST_AUTO_TEST_CASE ( sequence_iterators )
290 std::string seq_string = "AAGGCCTTNNTATA";
291 Sequence s(seq_string);
292 const Sequence cs(s);
293 std::string::size_type count = 0;
295 std::string::iterator str_itor;
296 Sequence::const_iterator s_itor;
297 Sequence::const_iterator cs_itor;
299 for( str_itor = seq_string.begin(),
301 cs_itor = cs.begin();
302 str_itor != seq_string.end() and
303 s_itor != s.end() and
305 ++str_itor, ++s_itor, ++cs_itor, ++count)
307 BOOST_CHECK_EQUAL ( *str_itor, *s_itor );
308 BOOST_CHECK_EQUAL ( *s_itor, *cs_itor );
309 BOOST_CHECK_EQUAL ( *cs_itor, *str_itor );
311 BOOST_CHECK_EQUAL( seq_string.size(), count );
312 BOOST_CHECK_EQUAL( s.size(), count );
313 BOOST_CHECK_EQUAL( cs.size(), count );
316 BOOST_AUTO_TEST_CASE( sequence_motifs )
319 string bogus("AATTGGAA");
320 Sequence s1("AAAAGGGGCCCCTTTT");
322 list<motif>::const_iterator motif_i = s1.motifs().begin();
323 list<motif>::const_iterator motif_end = s1.motifs().end();
325 // do our iterators work?
326 BOOST_CHECK( motif_i == s1.motifs().begin() );
327 BOOST_CHECK( motif_end == s1.motifs().end() );
328 BOOST_CHECK( motif_i == motif_end );
330 // this shouldn't show up
332 BOOST_CHECK( s1.motifs().begin() == s1.motifs().end() );
333 BOOST_CHECK_EQUAL( s1.motifs().size(), 0 );
336 BOOST_CHECK( s1.motifs().begin() != s1.motifs().end() );
337 BOOST_CHECK_EQUAL( s1.motifs().size(), 2 );
339 for(motif_i = s1.motifs().begin();
340 motif_i != s1.motifs().end();
343 BOOST_CHECK_EQUAL( motif_i->type, "motif" );
344 BOOST_CHECK_EQUAL( motif_i->name, m);
345 BOOST_CHECK_EQUAL( motif_i->sequence, m);
349 BOOST_CHECK( s1.motifs().begin() == s1.motifs().end() );
351 /* FIXME: enable this when i find a way of passing storing the motif name
352 // does our annotation travel?
353 Sequence motif_seq(m);
354 motif_seq.set_fasta_header("hi");
355 s1.add_motif(motif_seq);
357 BOOST_CHECK_EQUAL(s1.motifs().size(), 2);
358 for(motif_i = s1.motifs().begin();
359 motif_i != s1.motifs().end();
362 BOOST_CHECK_EQUAL( motif_i->type, "motif" );
363 BOOST_CHECK_EQUAL( motif_i->name, "hi");
364 BOOST_CHECK_EQUAL( motif_i->sequence, m);
369 BOOST_AUTO_TEST_CASE( annot_test )
371 annot a(0, 10, "test", "thing");
373 BOOST_CHECK_EQUAL( a.begin, 0 );
374 BOOST_CHECK_EQUAL( a.end, 10 );
375 BOOST_CHECK_EQUAL( a.type, "test" );
376 BOOST_CHECK_EQUAL( a.name, "thing" );
378 motif m(10, "AAGGCC");
379 BOOST_CHECK_EQUAL( m.begin, 10 );
380 BOOST_CHECK_EQUAL( m.type, "motif" );
381 BOOST_CHECK_EQUAL( m.name, "AAGGCC" );
382 BOOST_CHECK_EQUAL( m.end, 10+6 );
385 BOOST_AUTO_TEST_CASE( annotate_from_sequence )
387 string s("CCGCCCCCCATCATCGCGGCTCTCCGAGAGTCCCGCGCCCCACTCCCGGC"
388 "ACCCACCTGACCGCGGGCGGCTCCGGCCCCGCTTCGCCCCACTGCGATCA"
389 "GTCGCGTCCCGCAGGCCAGGCACGCCCCGCCGCTCCCGCTGCGCCGGGCG"
390 "TCTGGGACCTCGGGCGGCTCCTCCGAGGGGCGGGGCAGCCGGGAGCCACG"
391 "CCCCCGCAGGTGAGCCGGCCACGCCCACCGCCCGTGGGAAGTTCAGCCTC"
392 "GGGGCTCCAGCCCCGCGGGAATGGCAGAACTTCGCACGCGGAACTGGTAA"
393 "CCTCCAGGACACCTCGAATCAGGGTGATTGTAGCGCAGGGGCCTTGGCCA"
394 "AGCTAAAACTTTGGAAACTTTAGATCCCAGACAGGTGGCTTTCTTGCAGT");
396 string gga("GGACACCTC");
399 std::list<Sequence> query_list;
400 std::list<string> string_list;
401 query_list.push_back(Sequence(gc));
402 string_list.push_back(gc);
403 query_list.push_back(Sequence(gga));
404 string_list.push_back(gga);
406 BOOST_CHECK_EQUAL( seq.annotations().size(), 0 );
407 seq.find_sequences(query_list.begin(), query_list.end());
410 for(list<string>::iterator string_i = string_list.begin();
411 string_i != string_list.end();
414 string::size_type pos=0;
415 while(pos != string::npos) {
416 pos = s.find(*string_i, pos);
417 if (pos != string::npos) {
423 BOOST_CHECK_EQUAL(seq.annotations().size(), count);
426 BOOST_AUTO_TEST_CASE( subseq_annotation_test )
428 string s("CCGCCCCCCATCATCGCGGCTCTCCGAGAGTCCCGCGCCCCACTCCCGGC"
429 "ACCCACCTGACCGCGGGCGGCTCCGGCCCCGCTTCGCCCCACTGCGATCA"
430 "GTCGCGTCCCGCAGGCCAGGCACGCCCCGCCGCTCCCGCTGCGCCGGGCG"
431 "TCTGGGACCTCGGGCGGCTCCTCCGAGGGGCGGGGCAGCCGGGAGCCACG"
432 "CCCCCGCAGGTGAGCCGGCCACGCCCACCGCCCGTGGGAAGTTCAGCCTC"
433 "GGGGCTCCAGCCCCGCGGGAATGGCAGAACTTCGCACGCGGAACTGGTAA"
434 "CCTCCAGGACACCTCGAATCAGGGTGATTGTAGCGCAGGGGCCTTGGCCA"
435 "AGCTAAAACTTTGGAAACTTTAGATCCCAGACAGGTGGCTTTCTTGCAGT");
439 seq.add_annotation(annot(0, 10, "0-10", "0-10"));
440 seq.add_annotation(annot(10, 20, "10-20", "10-20"));
441 seq.add_annotation(annot(0, 20, "0-20", "0-20"));
442 seq.add_annotation(annot(8, 12, "8-12", "8-12"));
443 seq.add_annotation(annot(100, 5000, "100-5000", "100-5000"));
445 Sequence subseq = seq.subseq(5, 10);
446 const list<annot> annots = subseq.annotations();
447 // generate some ground truth
449 correct.push_back(annot(0, 5, "0-10", "0-10"));
450 correct.push_back(annot(5,10, "10-20", "10-20"));
451 correct.push_back(annot(0,10, "0-20", "0-20"));
452 correct.push_back(annot(3, 7, "8-12", "8-12"));
453 BOOST_REQUIRE_EQUAL( annots.size(), correct.size() );
455 list<annot>::iterator correct_i = correct.begin();
456 list<annot>::const_iterator annot_i = annots.begin();
457 for(; annot_i != annots.end(); ++annot_i, ++correct_i)
459 BOOST_CHECK( *annot_i == *correct_i );
463 BOOST_AUTO_TEST_CASE( motif_annotation_update )
465 string s("CCGTCCCCCATCATCGCGGCTCTCCGAGAGTCCCGCGCCCCACTCCCGGC"
466 "ACCCACCTGACCGCGGGCGGCTCCGGCCCCGCTTCGCCCCACTGCGATCA"
467 "GTCGCGTCCCGCAGGCCAGGCACGCCCCGCCGCTCCCGCTGCGCCGGGCG"
468 "TCTGGGACCTCGGGCGGCTCCTCCGAGGGGCGGGGCAGCCGGGAGCCACG"
469 "CCCCCGCAGGTGAGCCGGCCACGCCCACCGCCCGTGGGAAGTTCAGCCTC"
470 "GGGGCTCCAGCCCCGCGGGAATGGCAGAACTTCGCACGCGGAACTGGTAA"
471 "CCTCCAGGACACCTCGAATCAGGGTGATTGTAGCGCAGGGGCCTTGGCCA"
472 "AGCTAAAACTTTGGAAACTTTAGATCCCAGACAGGTGGCTTTCTTGCAGT");
475 // starting conditions
476 BOOST_CHECK_EQUAL(seq.annotations().size(), 0);
477 BOOST_CHECK_EQUAL(seq.motifs().size(), 0);
478 seq.add_annotation(annot(0, 10, "0-10", "0-10"));
479 seq.add_annotation(annot(10, 20, "10-20", "10-20"));
480 seq.add_annotation(annot(0, 20, "0-20", "0-20"));
481 BOOST_CHECK_EQUAL(seq.annotations().size(), 3);
482 BOOST_CHECK_EQUAL(seq.motifs().size(), 0);
483 seq.add_motif("CCGTCCC");
484 BOOST_CHECK_EQUAL(seq.annotations().size(), 3);
485 BOOST_CHECK_EQUAL(seq.motifs().size(), 1);
487 BOOST_CHECK_EQUAL(seq.annotations().size(), 3);
488 BOOST_CHECK_EQUAL(seq.motifs().size(), 0);
491 BOOST_AUTO_TEST_CASE( out_operator )
493 string s("AAGGCCTT");
498 BOOST_CHECK_EQUAL( s, buf.str() );
501 BOOST_AUTO_TEST_CASE( get_name )
503 Sequence seq("AAGGCCTT");
505 BOOST_CHECK_EQUAL( seq.get_name(), "" );
506 seq.set_species("hooman"); // anyone remember tradewars?
507 BOOST_CHECK_EQUAL( seq.get_name(), "hooman");
508 seq.set_fasta_header("fasta human");
509 BOOST_CHECK_EQUAL( seq.get_name(), "fasta human");
512 BOOST_AUTO_TEST_CASE( serialize_simple )
514 std::string seq_string = "AAGGCCTT";
515 Sequence seq(seq_string);
516 seq.set_species("ribbet");
517 std::ostringstream oss;
518 // allocate/deallocate serialization components
520 boost::archive::text_oarchive oarchive(oss);
521 const Sequence& const_seq(seq);
522 BOOST_CHECK_EQUAL(seq, const_seq);
523 oarchive << const_seq;
527 std::istringstream iss(oss.str());
528 boost::archive::text_iarchive iarchive(iss);
529 iarchive >> seq_loaded;
531 BOOST_CHECK_EQUAL(seq_loaded, seq);
532 BOOST_CHECK_EQUAL(seq.get_species(), "ribbet");
535 BOOST_AUTO_TEST_CASE( serialize_tree )
537 std::string seq_string = "AAGGCCTT";
538 Sequence seq(seq_string);
539 seq.set_species("ribbet");
542 annot a1(6,7,"t","t");
543 seq.add_annotation(a1);
545 std::ostringstream oss;
546 // allocate/deallocate serialization components
548 boost::archive::text_oarchive oarchive(oss);
549 const Sequence& const_seq(seq);
550 BOOST_CHECK_EQUAL(seq, const_seq);
551 oarchive << const_seq;
556 std::istringstream iss(oss.str());
557 boost::archive::text_iarchive iarchive(iss);
558 iarchive >> seq_loaded;
560 BOOST_CHECK_EQUAL(seq_loaded, seq);
563 // this writes out an "old" style annotated sequence
564 // with annotations attached as "motifs" and "annots"
565 BOOST_AUTO_TEST_CASE( serialize_xml_sequence )
567 std::string seq_string = "AAGGCCTT";
568 Sequence seq(seq_string);
569 seq.set_species("ribbet");
572 annot a1(6,7,"t","t");
573 seq.add_annotation(a1);
575 std::ostringstream oss;
576 // allocate/deallocate serialization components
578 boost::archive::xml_oarchive oarchive(oss);
579 const Sequence& const_seq(seq);
580 BOOST_CHECK_EQUAL(seq, const_seq);
581 oarchive << boost::serialization::make_nvp("root", const_seq);
585 std::istringstream iss(oss.str());
586 boost::archive::xml_iarchive iarchive(iss);
587 iarchive >> boost::serialization::make_nvp("root", seq_loaded);
589 BOOST_CHECK_EQUAL(seq_loaded, seq);
592 BOOST_AUTO_TEST_CASE( serialize_xml_two )
594 std::string seq_string = "AAGGCCTT";
595 Sequence seq1(seq_string);
598 std::ostringstream oss;
599 // allocate/deallocate serialization components
601 boost::archive::xml_oarchive oarchive(oss);
602 const Sequence& const_seq1(seq1);
603 const Sequence& const_seq2(seq2);
604 oarchive << boost::serialization::make_nvp("seq1", const_seq1);
605 oarchive << boost::serialization::make_nvp("seq2", const_seq2);
607 //std::cout << "xml: " << oss.str() << std::endl;
608 Sequence seq1_loaded;
609 Sequence seq2_loaded;
611 std::istringstream iss(oss.str());
612 boost::archive::xml_iarchive iarchive(iss);
613 iarchive >> boost::serialization::make_nvp("seq1", seq1_loaded);
614 iarchive >> boost::serialization::make_nvp("seq2", seq2_loaded);
616 BOOST_CHECK_EQUAL(seq1_loaded, seq1);
617 BOOST_CHECK_EQUAL(seq2_loaded, seq2);
618 // test if our pointers are the same
619 BOOST_CHECK_EQUAL(seq1_loaded.c_str(), seq2_loaded.c_str());