t/SeqIO/seqxml.t

   1 #-*-perl-*-
   2 # $Id$
   3
   4 use strict;
   5
   6 BEGIN {
   7     use Bio::Root::Test;
   8     test_begin(
   9         -tests            => 61,
  10         -requires_modules => [qw(XML::LibXML XML::LibXML::Reader XML::Writer)]
  11     );
  12
  13     use_ok('Bio::SeqIO');
  14 }
  15 use_ok('Bio::PrimarySeq');
  16
  17 my $verbose = test_debug();
  18
  19 SKIP: {
  20
  21     # XML library version checks
  22     if ( 1000 * $] < 5008 ) {
  23         skip( "Reader interface only supported in Perl >= 5.8", 96 );
  24     }
  25     elsif ( XML::LibXML::LIBXML_VERSION() <= 20620 ) {
  26         skip( "Reader not supported for libxml2 <= 2.6.20", 96 );
  27     }
  28
  29     if ($verbose) {
  30         diag( "libxml version: ", XML::LibXML::LIBXML_VERSION() );
  31     }
  32
  33     # checks that your module is there and loads ok
  34     use_ok('Bio::SeqIO::seqxml');
  35
  36     # read data
  37     ok(
  38         my $seq_stream = Bio::SeqIO->new(
  39             -file    => test_input_file("seqxml.xml"),
  40             -format  => 'seqxml',
  41             -verbose => $verbose,
  42         ),
  43         'stream ok',
  44     );
  45
  46     # check metadata
  47     is( $seq_stream->seqXMLversion, '0.3',     'seqXML version' );
  48     is( $seq_stream->source,        'Ensembl', 'source' );
  49     is( $seq_stream->sourceVersion, '56',      'source version' );
  50
  51     # now get and check the sequence entry itself
  52     my $seq_obj = $seq_stream->next_seq;
  53     isa_ok( $seq_obj, 'Bio::Seq' );
  54     is( $seq_obj->display_id, 'ENST00000308775',           'display id' );
  55     is( $seq_obj->primary_id, 'ENST00000308775',           'primary id' );
  56     is( $seq_obj->desc,       'dystroglycan 1',            'description' );
  57     is( $seq_obj->seq,        'AAGGC----UGAUGUC.....ACAU', 'sequence' );
  58     is( $seq_obj->length,     25,                          'length' );
  59
  60     my ($source) = $seq_obj->get_Annotations('source');
  61     if ($source) { is($source->value, 'Ensembl', 'entry source'); }
  62
  63     # species
  64     isa_ok( $seq_obj->species, 'Bio::Species', 'species' );
  65     is( $seq_obj->species->node_name,    'Homo sapiens', 'species name' );
  66     is( $seq_obj->species->ncbi_taxid, '9606',         'NCBI tax id' );
  67
  68     # alternative IDs
  69     my @dblinks = $seq_obj->get_Annotations('dblink');
  70     my $dblink  = shift @dblinks;
  71     isa_ok( $dblink, 'Bio::Annotation::DBLink' );
  72     is( $dblink->database,   'RefSeq',   'dblink source' );
  73     is( $dblink->primary_id, 'NM_004393', 'dblink ID' );
  74
  75     # properties
  76     my @annotations = $seq_obj->get_Annotations();
  77     foreach my $annot_obj (@annotations) {
  78         next if ( $annot_obj->tagname eq 'dblink' );
  79         next if ( $annot_obj->tagname eq 'source' );
  80         isa_ok( $annot_obj, 'Bio::Annotation::SimpleValue' );
  81         if ( $annot_obj->tagname eq 'has_splice_variants' ) {
  82             is( $annot_obj->value, undef, 'boolean property' );
  83         }
  84         elsif ( $annot_obj->tagname eq 'prediction_method' ) {
  85             is( $annot_obj->value, 'manual curation', 'property with value' );
  86         }
  87     }
  88
  89     # write data
  90     my $outfile = test_output_file();
  91     ok(
  92         my $seq_writer = Bio::SeqIO->new(
  93             -file          => ">$outfile",
  94             -format        => 'seqxml',
  95             -verbose       => $verbose,
  96             -source        => 'Ensembl',
  97             -sourceVersion => '56',
  98             -seqXMLversion => '0.3',
  99         ),
 100         'writer ok',
 101     );
 102     $seq_writer->flush;    # to make sure output is written to file
 103     ok( -s $outfile, 'outfile is created' );
 104
 105     # check metadata
 106     is( $seq_writer->seqXMLversion, '0.3',     'seqXML version' );
 107     is( $seq_writer->source,        'Ensembl', 'source' );
 108     is( $seq_writer->sourceVersion, '56',      'source version' );
 109     is( $seq_writer->schemaLocation, 'http://www.seqxml.org/0.3/seqxml.xsd', 'schemaLocation' );
 110
 111     # write one sequence entry to file
 112     $seq_writer->write_seq($seq_obj);
 113     $seq_writer->close;
 114     if ( $verbose > 0 ) {
 115         diag("writing first seqXML outfile");
 116         diag(`cat $outfile`);
 117     }
 118
 119     # verify written data by roundtripping it
 120     {
 121         my $new_in = Bio::SeqIO->new(
 122             -file   => $outfile,
 123             -format => 'seqxml'
 124         );
 125
 126         my $new_seqobj = $new_in->next_seq;
 127         isa_ok( $new_seqobj, 'Bio::Seq' );
 128         is( $new_seqobj->display_id, 'ENST00000308775', 'display id' );
 129         is( $new_seqobj->primary_id, 'ENST00000308775', 'primary id' );
 130         is( $new_seqobj->desc,       'dystroglycan 1',  'description' );
 131         is( $new_seqobj->seq, 'AAGGC----UGAUGUC.....ACAU', 'sequence' );
 132         is( $new_seqobj->length, 25, 'length' );
 133
 134         my ($new_source) = $new_seqobj->get_Annotations('source');
 135         if ($new_source) { is($new_source->value, 'Ensembl', 'entry source'); }
 136
 137
 138         # species
 139         isa_ok( $new_seqobj->species, 'Bio::Species', 'species' );
 140         is( $new_seqobj->species->node_name,    'Homo sapiens', 'species name' );
 141         is( $new_seqobj->species->ncbi_taxid, '9606',         'NCBI tax id' );
 142
 143         # alternative IDs
 144         my @dblinks = $new_seqobj->get_Annotations('dblink');
 145         my $dblink  = shift @dblinks;
 146         isa_ok( $dblink, 'Bio::Annotation::DBLink' );
 147         is( $dblink->database,   'RefSeq',   'dblink source' );
 148         is( $dblink->primary_id, 'NM_004393', 'dblink ID' );
 149
 150         # properties
 151         my @annotations = $new_seqobj->get_Annotations();
 152         foreach my $annot_obj (@annotations) {
 153             next if ( $annot_obj->tagname eq 'dblink' );
 154             next if ( $annot_obj->tagname eq 'source' );
 155             isa_ok( $annot_obj, 'Bio::Annotation::SimpleValue' );
 156             if ( $annot_obj->tagname eq 'has_splice_variants' ) {
 157                 is( $annot_obj->value, undef, 'boolean property' );
 158             }
 159             elsif ( $annot_obj->tagname eq 'prediction_method' ) {
 160                 is(
 161                     $annot_obj->value,
 162                     'manual curation',
 163                     'property with value'
 164                 );
 165             }
 166         }
 167     }
 168
 169     # write data from a Seq object created from a fasta file
 170     {
 171         # forcing a Bio::Seq to be created
 172         # due to SeqIO::fasta creating a PrimarySeq by default
 173         # as of r16838
 174         my $factory = Bio::Seq::SeqFactory->new(-type => 'Bio::Seq');
 175
 176         my $seq_stream = Bio::SeqIO->new(
 177             -file   => test_input_file("test.fasta"),
 178             -format => 'fasta',
 179             -seqfactory => $factory,
 180         );
 181
 182         my $outfile = test_output_file();
 183         my $writer  = Bio::SeqIO->new(
 184             -file   => ">$outfile",
 185             -format => 'seqxml'
 186         );
 187         $writer->flush;
 188         ok( -s $outfile, 'outfile is created' );
 189
 190         while ( my $seq_obj = $seq_stream->next_seq ) {
 191             $writer->write_seq($seq_obj);
 192         }
 193         $writer->close;
 194         if ( $verbose > 0 ) {
 195             diag(`cat $outfile`);
 196         }
 197
 198         # now read that newly made seqxml back in
 199         my $in = Bio::SeqIO->new(
 200             -file   => $outfile,
 201             -format => 'seqxml'
 202         );
 203
 204         # check header
 205         is( $in->seqXMLversion, '0.3', 'seqXML version' );
 206         is( $in->source,        undef, 'source' );
 207         is( $in->sourceVersion, undef, 'source version' );
 208
 209         # check first sequence entry
 210         my $seqxml_obj = $in->next_seq;
 211         is( $seqxml_obj->display_id, 'roa1_drome', 'display id' );
 212         is( $seqxml_obj->primary_id, 'roa1_drome', 'primary id' );
 213         is( $seqxml_obj->desc, 'Rea guano receptor type III >> 0.1',
 214             'description' );
 215         is(
 216             $seqxml_obj->seq,
 217 'MVNSNQNQNGNSNGHDDDFPQDSITEPEHMRKLFIGGLDYRTTDENLKAHEKWGNIVDVVVMKDPRTKRSRGFGFITYSHSSMIDEAQKSRPHKIDGRVEPKRAVPRQDIDSPNAGATVKKLFVGALKDDHDEQSIRDYFQHFGNIVDNIVIDKETGKKRGFAFVEFDDYDPVDKVVLQKQHQLNGKMVDVKKALPKNDQQGGGGGRGGPGGRAGGNRGNMGGGNYGNQNGGGNWNNGGNNWGNNRGNDNWGNNSFGGGGGGGGGYGGGNNSWGNNNPWDNGNGGGNFGGGGNNWNGGNDFGGYQQNYGGGPQRGGGNFNNNRMQPYQGGGGFKAGGGNQGNYGNNQGFNNGGNNRRY',
 218             'sequence'
 219         );
 220         is( $seqxml_obj->length, 358, 'length' );
 221
 222         # check second sequence entry
 223         my $seqxml_obj2 = $in->next_seq;
 224         is( $seqxml_obj2->display_id, 'roa2_drome',       'display id' );
 225         is( $seqxml_obj2->primary_id, 'roa2_drome',       'primary id' );
 226         is( $seqxml_obj2->desc,       'Rea guano ligand', 'description' );
 227         is(
 228             $seqxml_obj2->seq,
 229 'MVNSNQNQNGNSNGHDDDFPQDSITEPEHMRKLFIGGLDYRTTDENLKAHEKWGNIVDVVVMKDPTSTSTSTSTSTSTSTSTMIDEAQKSRPHKIDGRVEPKRAVPRQDIDSPNAGATVKKLFVGALKDDHDEQSIRDYFQHLLLLLLLDLLLLDLLLLDLLLFVEFDDYDPVDKVVLQKQHQLNGKMVDVKKALPKNDQQGGGGGRGGPGGRAGGNRGNMGGGNYGNQNGGGNWNNGGNNWGNNRGNDNWGNNSFGGGGGGGGGYGGGNNSWGNNNPWDNGNGGGNFGGGGNNWNGGNDFGGYQQNYGGGPQRGGGNFNNNRMQPYQGGGGFKAGGGNQGNYGNNQGFNNGGNNRRY',
 230             'sequence'
 231         );
 232         is( $seqxml_obj2->length, 358, 'length' );
 233
 234     }
 235
 236 }