#!/usr/bin/perl -w
#
# check-sparql - Run Rasqal against W3C SPARQL testsuites
#
# USAGE: check-sparql [options] [TEST]
# 
# Copyright (C) 2004-2012, David Beckett http://www.dajobe.org/
# Copyright (C) 2004-2005, University of Bristol, UK http://www.bristol.ac.uk/
# 
# This package is Free Software and part of Redland http://librdf.org/
# 
# It is licensed under the following three licenses as alternatives:
#   1. GNU Lesser General Public License (LGPL) V2.1 or any newer version
#   2. GNU General Public License (GPL) V2 or any newer version
#   3. Apache License, V2.0 or any newer version
# 
# You may not use this file except in compliance with at least one of
# the above three licenses.
# 
# See LICENSE.html or LICENSE.txt at the top of this package for the
# complete terms and further detail along with the license texts for
# the licenses in COPYING.LIB, COPYING and LICENSE-2.0.txt respectively.
# 
#
# Requires:
#   roqet (from rasqal) compiled in the parent directory
#   rapper (from raptor) in the PATH
#
# Depends on a variety of rasqal internal debug print formats
# 


use strict;
use File::Basename;
use XML::DOM;
use Getopt::Long;
use Pod::Usage;
use Cwd;

use POSIX qw(WIFSIGNALED WIFEXITED WTERMSIG WEXITSTATUS);
# We really want WCOREDUMP too
sub WCOREDUMP($) {
  return $_[0] & 0200;
}

my $roqet=$ENV{ROQET} || "roqet";
my $rasqal_url="http://librdf.org/rasqal/";
my $rapper=$ENV{RAPPER} || "rapper";
my $diff_cmd=$ENV{DIFF} || "diff";

my $rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#';
my $rs='http://www.w3.org/2001/sw/DataAccess/tests/result-set#';
my $resultVariable_predicate="<${rs}resultVariable>";
my $variable_predicate="<${rs}variable>";
my $value_predicate="<${rs}value>";
my $binding_predicate="<${rs}binding>";
my $solution_predicate="<${rs}solution>";
my $index_predicate="<${rs}index>";

my(@manifest_files)=qw(manifest.ttl manifest.n3);
my $mf='http://www.w3.org/2001/sw/DataAccess/tests/test-manifest#';
my $mfx='http://jena.hpl.hp.com/2005/05/test-manifest-extra#';
my $qt='http://www.w3.org/2001/sw/DataAccess/tests/test-query#';
my $dawgt='http://www.w3.org/2001/sw/DataAccess/tests/test-dawg#';
my $ut='http://www.w3.org/2009/sparql/tests/test-update#';

my $program=basename $0;
my $debug=0;
my $srcdir='.';

$debug=1 if defined $ENV{'RASQAL_DEBUG'};

# plural('result', 's', 2);
sub plural($$$) {
  my($word,$multiple,$count)=@_;
  return ($count == 1) ? $count." ".$word : $count." ".$word.$multiple;
}
  

sub toDebug($) {
  my $str=shift;

  return undef if !defined $str;

  return "NULL" if $str eq "<${rs}undefined>";

  return $str if $str =~ s/^("[^"]*")(@.*)(\^\^<.*>)$/string($1$2$3)/;

  return $str if $str =~ s/^("[^"]*"\^\^<.*>)$/string($1)/;

  return $str if $str =~ s/^("[^"]*"@.*)$/string($1)/;

  return $str if $str =~ s/^("[^"]*")$/string($1)/;

  return $str if $str =~ s/^(<.*>)$/uri$1/;

  #return $str if $str =~ s/^_:(.*)$/blank $1/;
  return $str if $str =~ s/^_:(.*)$/blank _/;

  return qq{string("$str")};
}

sub read_rdf_results_file($$) {
  my($result_file, $base_uri)=@_;
  my(@node_order);
  my(%nodes);
  my(%node_type);

  my $cmd="$rapper -q -g -o ntriples $result_file $base_uri";

  warn "$program: Opening pipe from '$cmd'\n"
    if $debug;
  open(PIPE, "$cmd 2>rapper.err |");
  while(<PIPE>) {
    chomp;
    s/\s+\.$//;

    my($subject, $predicate, $object)=split(/ /, $_, 3);
    push(@node_order, $subject)
	unless exists $nodes{$subject} || exists $node_type{$subject};

    if ($predicate eq "<${rdf}type>") {
	$node_type{$subject}=$object;
    } else {
	push(@{$nodes{$subject}->{$predicate}}, $object);
    }
  }
  close(PIPE);

  open(ERR, "<rapper.err") or die "$program: Cannot open rapper.err - $!\n";
  my(@errs)=();
  while(<ERR>) {
    chomp;
    push(@errs, "$result_file: $1") if m{rapper: Error - (.*)$};
  }
  close(ERR);
  if(@errs) {
    warn "$program: parsing '$result_file' FAILED - rapper returned errors:\n$program:   ".join("\n$program:   ",@errs)."\n";
    warn "Failing program was:\n";
    warn "  $cmd\n";
    my $curdir=getcwd;
    my $r=$cmd; $r =~ s,file:[^ ]+/,,g; $r =~ s,$curdir/,,g;
    warn "  OR $r\n";
    return undef;
  }

  unlink "rapper.err";

  my(%results)=(rows => []);

  # Find ResultSet node
  my $resultset_node=undef;
  for my $node (@node_order) {
    my $type=$node_type{$node};
    next if !$type || $type ne "<${rs}ResultSet>";
    $resultset_node=$node;
    last;
  }
  
  warn "$program: Resultset node $resultset_node\n"
    if $debug > 1;

  if(!defined $resultset_node) {
    # No result defined
    return {expect_empty => 1};
  }

  my(@variables);
  for my $vname (@{$nodes{$resultset_node}->{$resultVariable_predicate}}) {
    push(@variables, $vname);
  }

  for my $node (@{$nodes{$resultset_node}->{$solution_predicate}}) {
    warn "$program: Row node $node\n"
      if $debug > 1;

    # Get binding nodes
    my $row = { map { $_ => undef} @variables };
    for my $binding_node (@{$nodes{$node}->{$binding_predicate}}) {
      warn "Binding node $binding_node\n"
	if $debug > 1;

      my $variable=$nodes{$binding_node}->{$variable_predicate}->[0];
      $variable=~ s/^"(.*)"$/$1/;
      my $value=$nodes{$binding_node}->{$value_predicate}->[0];
      $row->{$variable}=toDebug($value);
      warn "variable $variable value $value\n"
	if $debug > 1;
    }

    my $row_index=$nodes{$node}->{$index_predicate};
    if(defined $row_index) {
      # Some - but not all - result sets use rs:index to order results
      my $ri=$row_index->[0]; $ri =~ s/^\"(\d+)\".*$/$1/;
      $results{rows}->[$ri-1]=$row;
    } else {
      push(@{$results{rows}}, $row);
    }
  }
  warn "$program: Found ".scalar(@{$results{rows}})." rows in results\n"
    if $debug > 0;
  return \%results;
}


sub read_srx_results_file($) {
  my($result_file)=@_;

  my(%results)=(rows => []);

  my $parser = new XML::DOM::Parser;
  my $doc = $parser->parsefile($result_file);

  my(@variables)=();
  for my $variable_el ($doc->getElementsByTagName("variable")) {
    next unless ref($variable_el) eq 'XML::DOM::Element';
    push(@variables, $variable_el->getAttribute('name'));
  }

  for my $result ($doc->getElementsByTagName("result")) {
    next unless ref($result) eq 'XML::DOM::Element';
    my($row)= { map { $_ => undef } @variables };

    warn "Result Element ".$result->getNodeName()."\n"
      if $debug > 1;

    for my $binding ($result->getChildNodes()) {
      next unless ref($binding) eq 'XML::DOM::Element';

      my $variable=$binding->getAttribute('name');

      warn "   Binding Element ".$binding->getNodeName()." name=$variable\n"
	if $debug > 1;

      for my $el ($binding->getChildNodes()) {
	next unless ref($el) eq 'XML::DOM::Element';
	my $el_name=$el->getTagName();

	warn "   Binding sub-element $el_name\n"
	  if $debug > 1;

	my $value;
	if($el_name eq 'uri') {
	  my $contents=$el->getFirstChild()->getNodeValue();
	  $value="uri<$contents>";
	} elsif($el_name eq 'literal') {
	  my $contents=$el->getFirstChild() ? ($el->getFirstChild()->getNodeValue()) : '';
	  if(my $datatype=$el->getAttribute('datatype')) {
	    $value="string(\"".$contents."\"^^<$datatype>)";
	  } elsif(my $language=$el->getAttribute('xml:lang')) {
	    $value="string(\"$contents\"\@$language)";
	  } else {
	    $value="string(\"$contents\")";
	  }
	} elsif($el_name eq 'bnode') {
	  $value="blank _";
	} else {
	  $value='';
	}
	warn "   Encoded value: $value\n"
	  if $debug > 1;
        $row->{$variable}=$value;
      }

    } # end for binding

    push(@{$results{rows}}, $row);

  } # end for my result

  return \%results;
}


sub read_sv_results_file($$) {
  my($result_file, $sv_type)=@_;
  my $sep = ($sv_type eq 'csv') ? ',' : '\t';

  my(%results)=(rows => []);

  if(!open(IN, "<$result_file")) {
    warn "$program: Failed to read result file $result_file - $!\n";
    return undef;
  }
  my $data=join('', <IN>);
  close(IN);

  warn "$program: Reading SV type $sv_type with sep '$sep'\n"
      if $debug;
  my(@vars);
  for my $line (split(/(?:\r\n|\r|\n)/, $data)) {
    # warn ">>$line<<\n";

    # Replace $sep in quotes with \001
    $line =~ s/("[^"]*")/$a = $1; $a =~ s%$sep%\001%g; $a/eg;
    my(@values)=split(/$sep/, $line);
    # Restore $sep
    @values = map { s/\001/$sep/g; $_ } @values;

    if(!@vars) {
      @vars = map { s/^\?//; $_ } @values;
      warn "$program: SV vars are @vars\n"
	  if $debug;
      next;
    }

    my($row) = {};
    for my $i (0..$#vars) {
      my($variable) = $vars[$i];
      my $value = $values[$i];
      if(defined $value) {
	if($value =~ /^http/) {
	  $value="uri<".$value.">";
	} elsif($value =~ /^_:/) {
	  $value = "blank _";
	} elsif($value =~ /^\d+\.\d+$/) {
	  $value="string(\"$value\"^^<http://www.w3.org/2001/XMLSchema#decimal>)";
	} elsif($value =~ /^\d+$/) {
	  $value="string(\"$value\"^^<http://www.w3.org/2001/XMLSchema#integer>)";
	} elsif($value =~ /^\d+\.\d+[eE]\d+$/) {
	  $value="string(\"$value\"^^<http://www.w3.org/2001/XMLSchema#double>)";
	} else {
	  $value = toDebug($value);
	}
      }
      $row->{$variable} = $value;
      warn "$variable : ".(defined $value ? $value : "(undefined)")."\n"
	  if $debug;
    }
    push(@{$results{rows}}, $row);
  }
  close(IN);

  return \%results;
}

sub read_rdf_graph_file($$) {
  my($result_file, $base_uri)=@_;

  my $cmd="$rapper -q -g -o ntriples $result_file $base_uri";

  warn "$program: (read_rdf_graph_file): Opening pipe from '$cmd'\n"
    if $debug;

  my $result_string='';
  open(PIPE, "$cmd 2>rapper.err |");
  while(<PIPE>) {
    $result_string .= $_;
  }
  close(PIPE);

  open(ERR, "<rapper.err") or die "$program: Cannot open rapper.err - $!\n";
  my(@errs)=();
  while(<ERR>) {
    chomp;
    push(@errs, "$result_file: $1") if m{rapper: Error - (.*)$};
  }
  close(ERR);
  if(@errs) {
    warn "$program: parsing RDF graph result file '$result_file' FAILED - rapper returned errors:\n  ".join("\n  ",@errs)."\n";
    warn "Failing program was:\n";
    warn "  $cmd\n";
    my $curdir=getcwd;
    my $r=$cmd; $r =~ s,file:[^ ]+/,,g; $r =~ s,$curdir/,,g;
    warn "  OR $r\n";
    return undef;
  }

  unlink "rapper.err";

  my(%results)=(graph_ntriples => $result_string);

  return \%results;
}


sub compare_rdf_graphs($$$) {
  my($file1, $file2, $out)=@_;
  my $cmd;
  my $rc;
  my $errors;
  if(defined $ENV{NTC}) {
    my $ntc = $ENV{NTC};
    $cmd="$ntc $file1 $file2 > $out 2>&1";
    $rc = system($cmd);
  } elsif(defined $ENV{JENAROOT}) {
    my $j = $ENV{JENAROOT};
    my $classpath=join(':',glob("$j/lib/*jar"));
    $cmd = qq{java -cp $classpath jena.rdfcompare $file1 $file2 N-TRIPLE N-TRIPLE > $out};
    $rc = system($cmd);
    if($rc) {
      $cmd = "$diff_cmd -u $file1 $file2 > $out";
      system($cmd);
    }
  } else {
    $cmd = "$diff_cmd -u $file1 $file2 > $out";
    $rc = system($cmd);
  }

  return $rc;
}


sub defined_or_NULL($) {
  return defined($_[0]) ? $_[0] : 'NULL';
}


sub run_test {
  my($config)=@_;
  my($name,$dir,$test_file,$result_file,$expect_fail,$language,
     $warning_level)
      =
    ($config->{name}, $config->{dir}, $config->{test_file}, 
     $config->{result_file}, $config->{expect_fail}, $config->{language},
     $config->{warning_level});
  my($test_uri)=$config->{test_uri};
  my(@data_files)=@{$config->{data_files}};
  my(@named_data_files)=@{$config->{named_data_files}};

  $language ||= 'sparql';

  my $test_result = {
    'name' => $name,
    'uri' => $test_uri,
  };

  $name ||= $test_uri;

  warn "run_test(\n  name       : $name\n  dir        : $dir\n  language   : $language\n  query      : $test_file\n  data       : ",join("; ",@data_files),"\n  named data : ",join("; ",@named_data_files),"\n  result     : ",($result_file||"none"),"\n  expect     : ",($expect_fail ? "failure":"success"),"\n)\n"
    if $debug;

  my(@args)=();
  push(@args, (map "-D $_", @data_files)) if @data_files;
  push(@args, (map "-G $_", @named_data_files)) if @named_data_files;

  push(@args, "-n")
    unless $config->{execute};

  my $args_s=join(" ",@args);
  my $roqet_tmp='roqet.tmp';
  my $roqet_err='roqet.err';
  my $roqet_cmd="$roqet -d debug -W $warning_level -i $language $args_s $test_file 2>$roqet_err > $roqet_tmp";
  my $sort="sort";

  warn "$program: Running '$roqet_cmd'\n"
    if $debug;
  my $start_time = time;
  system($roqet_cmd);
  my $end_time = time;
  my $rc = $?;
  
  my $core_dumped = WCOREDUMP($rc);
  $test_result->{'elapsed-time'}= $end_time - $start_time;
  $test_result->{'roqet-status-code'}= WIFEXITED($rc) ? WEXITSTATUS($rc) : undef;
  $test_result->{'stdout'}=`cat $roqet_tmp`; 
  $test_result->{'stderr'}=`cat $roqet_err`;

  unlink $roqet_tmp;

  $test_result->{'query'}=$roqet_cmd;
  my $curdir = getcwd;
  my $r=$roqet_cmd; $r =~ s,file:[^ ]+/,,g; $r =~ s,$curdir/,,g;
  $test_result->{'tidy-query'} = $r;


  if(WIFSIGNALED($rc)) {
    # exec()ed but died on a signal
    my $signal = WTERMSIG($rc);
    $rc = "died with signal $signal";
  } elsif(WIFEXITED($rc)) {
    $rc = WEXITSTATUS($rc);
    if($rc) {
      # exec()ed and exited with non-0
      $rc = "exited with status $rc";
    }
  } else {
    $rc = "system() returned unknown status code $rc";
  }
  $rc .=" with coredump" if $core_dumped;

  warn "$program: roqet returned code $rc\n"
      if $debug;
  if($rc) {
    $test_result->{'result'}='failure';

    if($expect_fail && !$core_dumped) {
      warn "$program: '$name' ok - got expected failure\n";
    } else {
      warn "$program: '$name' FAILED ($rc)\n";
      print STDERR "Failing program was:\n";
      my $tidy_query = $test_result->{'tidy-query'};
      print STDERR "  $roqet_cmd\n  OR $tidy_query\n";
      print STDERR $test_result->{'stderr'};
    }

    return $test_result;
  }

  my $sorted=0;
  my $first_result=1;
  my $roqet_results_count=0;
  my $result_type='bindings';
  my(@vars_order);
  my(%vars_seen);

  for (split(/\n/, $test_result->{'stdout'})) {
    if(/^projected variable names: (.*)$/) {
      for my $vname (split(/,\s*/, $1)) {
	unless($vars_seen{$vname}) {
	  push(@vars_order, $vname);
	  $vars_seen{$vname}=1;
	}
      }
      warn "$program: Set vars order to @vars_order\n"
	if $debug;
    }

    if(/^query verb:\s+(\S+)/) {
      my $verb = $1;
      $result_type='graph' if $verb eq 'CONSTRUCT';
      $result_type='boolean' if $verb eq 'ASK';
    }

    s/blank \w+/blank _/g;

    if (m/query order conditions:/) {
      $sorted=1;
      $sort=$sorted ? "cat " : "sort ";
    }

    if (m/^result: \[(.*)\]$/) {
      s/=INV:/=/g;
      s/=udt/=string/g;
      s%=xsdstring\((.*?)\)%=string("$1"^^<http://www.w3.org/2001/XMLSchema#string>)%g;
      my $line=$_;

      if($first_result) {
        open(OUT, "|$sort >roqet.out") or die "$program: Cannot create pipe to roqet.out - $!\n";
	$first_result=0;
      }

      print OUT "$line\n";
      $roqet_results_count++;
    }

    # RDF Graph result - seen N-Triple; sort -u to attempt to get canonical graph
    if(m/^[_<]/) {
      my $line = $_;
      if($first_result) {
        open(OUT, "|$sort -u >roqet.out") or die "$program: Cannot create pipe to roqet.out - $!\n";
        $first_result=0;
      }

      print OUT "$line\n";
    }

  }

  if($first_result) {
    open(OUT, ">roqet.out") or die "$program: Cannot create pipe to roqet.out - $!\n";
  }
  close(OUT);

  $test_result->{'result-type'} = $result_type;


  open(ERR, "<roqet.err") or die "$program: Cannot open roqet.err - $!\n";
  my(@errs)=();
  while(<ERR>) {
    chomp;
    push(@errs, "$test_file:$1: $2") if /(\d+) rasqal error - (.*)$/;
  }
  close(ERR);
  if(@errs) {
    warn "$program: '$name' FAILED (query returned errors)\n$program:   ".join("\n$program:   ",@errs)."\n";

    $test_result->{'errors'} = join("\n", @errs);
    print STDERR "Failing program was:\n";
    my $tidy_query = $test_result->{'tidy-query'};
    print STDERR "  $roqet_cmd\n  OR $tidy_query\n";
    print STDERR $test_result->{'stderr'};
    $test_result->{'result'}='failure';
    
    return $test_result;
  }

  my $cmd;

  my $results = {expect_empty => 1};

  if($result_type eq 'graph') {
    warn "$program: Reading RDF graph result file $result_file\n"
      if $debug;
    if(defined $result_file) {
      $results = read_rdf_graph_file($result_file, "file://$result_file");
    }
  } else {
    if(defined $result_file) {
      my $result_file_base_uri = $result_file;

      # File URI to filename
      $result_file =~ s%^file://%%;

      if($result_file =~ /\.srx$/) {
	warn "$program: Reading SPARQL XML bindings result file $result_file\n"
	  if $debug;
	$results = read_srx_results_file($result_file);
      } elsif($result_file =~ /\.srj$/) {
	warn "$program: '$name' FAILED (Cannot read SPARQL results in JSON)\n";
	$test_result->{'result'}='failure';
    
	return $test_result;
      } elsif($result_file =~ /\.(csv|tsv)$/) {
	my $sv_type = $1;
	warn "$program: Reading CSV/TSV bindings result file $result_file\n"
	    if $debug;
	$results = read_sv_results_file($result_file, $sv_type);
      } else {
	warn "$program: Reading RDF syntax encoding bindings result file $result_file\n"
	  if $debug;
	$results = read_rdf_results_file($result_file, $result_file_base_uri);
      }
    }
  }

  if(!defined $results) {
    $test_result->{'result'}='failure';
    
    return $test_result;
  }

  if(exists $results->{expect_empty}) {
    warn "$program: '$name' ok (no result)\n";
    $test_result->{'result'} = $expect_fail ? 'failure' : 'success';

    return $test_result;
  }

  my $count;
  if($result_type eq 'bindings') {
    open(OUT, "|$sort >result.out")
      or die "$program: Cannot create pipe to result.out - $!\n";

    $count=0;
    for my $row (@{$results->{rows}}) {
      my(@vals) = map { $_ . '=' . defined_or_NULL($row->{$_}) } @vars_order;
      print OUT "result: [", join(", ", @vals), "]\n";
      $count++;
    }
    close(OUT);

    $test_result->{'expected-results-count'} = $count;
    $test_result->{'actual-results-count'} = $roqet_results_count;
  } else {
    # graph: sort N-Triples in attempt to get canonical graph
    open(OUT, "| sort -u >result.out")
      or die "$program: Cannot create pipe to result.out - $!\n";
    print OUT $results->{graph_ntriples}
      if exists $results->{graph_ntriples};
    close(OUT);
  }   

  if($result_type eq 'graph') {
    $rc = compare_rdf_graphs('result.out', 'roqet.out', 'diff.out');
  } else {
    $cmd = "$diff_cmd -u result.out roqet.out > diff.out";
    $rc = system($cmd);
  }
  if($rc) {
    if($result_type eq 'bindings' && $count != $roqet_results_count) {
      warn "$program: '$name' FAILED (Expected ".plural("result","s",$count).", got $roqet_results_count)\n";
    } else {
      warn "$program: '$name' FAILED\n";
    }
    print STDERR "Failing program was:\n";
    my $tidy_query = $test_result->{'tidy-query'};
    print STDERR "  $roqet_cmd\n  OR $tidy_query\n";
    warn "Difference is:\n";
    system("cat diff.out");
    $test_result->{'result'}='failure';
    return $test_result;
  }

  warn "$program: '$name' ok\n";
  $test_result->{'result'}='success';
  return $test_result;
}

sub html_escape($) {
  my($str)=@_;
  return undef if !defined $str;

  $str =~ s/\&/\&amp;/gs;
  $str =~ s/</\&lt;/gs;
  $str =~ s/>/\&gt;/gs;

  return $str;
}



# Argument handling
my $usage=0;
my $manifest_file=undef;
my $earl_report_file=undef;
my $junit_report_file=undef;
my $suite_name=undef;
my $approved=0;
my $language='sparql';
my $warning_level=0;

GetOptions(
  'debug|d+'   => \$debug, # incremental
  'srcdir|s=s' => \$srcdir,
  'input|i=s' => \$language,
  'manifest|m=s' => \$manifest_file,
  'earl|e=s' => \$earl_report_file,
  'junit|j=s' => \$junit_report_file,
  'suite|u=s' => \$suite_name,
  'help|h|?' => \$usage,
  'approved|a' => \$approved,
  'warnings|W=i' => \$warning_level, # integer 0..100
) || pod2usage(2);

pod2usage(-verbose => 2) if $usage;
pod2usage("$0: Too many tests given.\n") if (@ARGV > 1);

my $unique_test=$ARGV[0];
$suite_name ||= 'testsuite';

$srcdir.="/" unless $srcdir =~ m%/$%;

if(!defined $manifest_file) {
  for my $file (@manifest_files) {
    next unless -r $srcdir.$file;
    $manifest_file=$file;
  }
}
die "$program: No manifest file found in $srcdir\n"
  unless defined $manifest_file;


my(%triples);
my $entries_node;
my $cmd="$rapper -q -i turtle -o ntriples $srcdir$manifest_file";
open(MF, "$cmd |") 
  or die "Cannot open pipe from '$cmd' - $!\n";
while(<MF>) {
  chomp;
  s/\s+\.$//;
  my($s,$p,$o)=split(/ /,$_,3);
  die "no p in '$_'\n" unless defined $p;
  die "no o in '$_'\n" unless defined $o;
  push(@{$triples{$s}->{$p}}, $o);
  $entries_node=$o if $p eq "<${mf}entries>";
}
close(MF);

warn "Entries node is '$entries_node'\n"
  if $debug > 1;
my $list_node=$entries_node;

my(@tests);
while($list_node) {
  warn "List node is '$list_node'\n"
    if $debug > 1;

  my $entry_node=$triples{$list_node}->{"<${rdf}first>"}->[0];

  warn "Entry node is '$entry_node'\n"
    if $debug > 1;

  if(!defined $triples{$entry_node}) {
    warn "$program: No triples in manifest for test URI $entry_node\n";
    goto next_list_node;
  }

  my $name=$triples{$entry_node}->{"<${mf}name>"}->[0];
  $name =~ s/^\"(.*)\"$/$1/
    if defined $name;

  warn "Entry name=$name\n"
    if $debug > 1;
  
  my $result_node=$triples{$entry_node}->{"<${mf}result>"}->[0];
  my $result_file=undef;
  if(defined $result_node) {
    $result_file=($result_node =~ /^<(.+)>$/, $1);
    $result_file =~ s,^file:([^/]+),$1,;
  }

  warn "Entry result_file=".($result_file || "NONE")."\n"
    if $debug > 1;

  my $action_node=$triples{$entry_node}->{"<${mf}action>"}->[0];

  warn "Entry action_node $action_node\n"
     if $debug > 1;
  
  my(@data_files)=();
  my(@named_data_files)=();
  for my $data_node (@{$triples{$action_node}->{"<${qt}data>"}}) { 
    warn "Entry graph data_node $data_node\n"
     if $debug > 1;
    my $data_file=($data_node =~ /^<(.+)>$/, $1);
    $data_file =~ s,^file:([^/]+),$1,;
    push(@data_files, $data_file);
  }
  for my $data_node (@{$triples{$action_node}->{"<${qt}graphData>"}}) { 
    warn "Entry named graph data_node $data_node\n"
     if $debug > 1;
    my $data_file=($data_node =~ /^<(.+)>$/, $1);
    $data_file =~ s,^file:([^/]+),$1,;
    push(@named_data_files, $data_file);
  }

  my $query_type=$triples{$entry_node}->{"<${rdf}type>"}->[0];
  warn "Query type is ".($query_type ? $query_type : "NONE")."\n"
    if $debug > 1;

  my $query_node;
  my $expect_fail=0;
  my $execute=1;

  if(defined $query_type &&
     ($query_type eq "<${ut}UpdateEvaluationTest>" ||
      $query_type eq "<${mf}UpdateEvaluationTest>")) {
    warn "Skipping query type $query_type - not supported\n"
      if $debug > 1;
    goto next_list_node;
  }

  my $lang = 'sparql';

  if($query_type && ($query_type eq "<${mf}PositiveSyntaxTest>" ||
		     $query_type eq "<${mf}PositiveSyntaxTest11>" ||
		     $query_type eq "<${mf}PositiveUpdateSyntaxTest11>" ||
		     $query_type eq "<${mfx}TestSyntax>" ||
		     $query_type eq "<${mf}NegativeSyntaxTest>" ||
		     $query_type eq "<${mf}NegativeSyntaxTest11>" ||
		     $query_type eq "<${mf}NegativeUpdateSyntaxTest11>" ||
		     $query_type eq "<${mfx}TestBadSyntax>")) {

    $lang = 'sparql11' if $query_type =~ /Test11>$/;

    $query_node=$action_node;
    $execute=0; # Syntax checks do not need execution, just parsing
    $expect_fail=1 if
      $query_type =~ /^<${mf}Negative/ ||
      $query_type eq "<${mf}NegativeSyntaxTest>" ||
      $query_type eq "<${mfx}TestBadSyntax>";
  } else {
    $query_node=$triples{$action_node}->{"<${qt}query>"}->[0];
  }

  my $test_uri=$entry_node; $test_uri =~ s/^<(.+)>$/$1/;
  my $test_type=$query_type; $test_type =~ s/^<(.+)>$/$1/ if defined $test_type;

  my $test_approval=$triples{$entry_node}->{"<${dawgt}approval>"}->[0];
  if($test_approval) {
    warn "Test $name ($test_uri) state $test_approval\n"
      if $debug > 1;
    if($test_approval eq "<${dawgt}Withdrawn>") {
      warn "Test $name ($test_uri) was withdrawn\n"
	if $debug;
      goto next_list_node;
    }
  }
  if($approved &&
    (!$test_approval || $test_approval ne "<${dawgt}Approved>")) {
    warn "$program: Test $name ($test_uri) was not approved by DAWG - skipping\n";
    goto next_list_node;
  }

  my $query_file=undef;
  if($query_node) {
    $query_file=($query_node =~ /^<(.+)>$/, $1);
    $query_file =~ s,^file:/*,/,;

    warn "Entry data_files=",join(", ",@data_files),"\n"
      if $debug > 1;
    warn "Entry named data_files=",join(", ",@named_data_files),"\n"
      if $debug > 1;
    warn "Entry query_file=$query_file\n"
      if $debug > 1;
  }

  if (!$unique_test || ($unique_test && (($name eq $unique_test) ||
					 ($test_uri =~ /$unique_test/)))) {
    push(@tests, {name => $name,
		  dir => $srcdir,
		  test_file => $query_file,
		  data_files => \@data_files,
		  named_data_files => \@named_data_files,
		  result_file => $result_file,
		  expect_fail => $expect_fail,
		  test_type => $test_type,
		  test_uri => $test_uri,
		  execute => $execute,
		  language => $lang
	 } );

    last if $unique_test;
  }

next_list_node:
  $list_node=$triples{$list_node}->{"<${rdf}rest>"}->[0];
  last if $list_node eq "<${rdf}nil>";
}

die "$program: Test $unique_test not found\n" if $unique_test && !@tests;

my(@failed);
my(@passed);
my(@test_results);
my $result=0;
my $start_time = time;
for my $test (@tests) {
  my($config)=$test;

  $config->{language} = $language;
  $config->{warning_level} = $warning_level;

  my $test_result = run_test($config);

  my $is_success = ($test_result->{'result'} eq 'success');
  $is_success = !$is_success if $config->{expect_fail};

  $test_result->{'is-success'} = $is_success;
  push(@test_results, $test_result);

  if($is_success) {
    push(@passed, $config);
  } else {
    push(@failed, $config);
  }
}
my $end_time = time;
my $elapsed_time = ($end_time - $start_time);

unlink "roqet.out", "result.out", "diff.out", "roqet.err", "roqet.tmp"
  unless $unique_test;

if($earl_report_file) {
  my $is_new=(!-r $earl_report_file);
  my $rasqal_version=`$roqet -v`;
  chomp $rasqal_version;

  my(@t)=gmtime;
  my $rasqal_date=sprintf("%04d-%02d-%02d", 1900+$t[5], 1+$t[4], $t[3]);

  my $rasqal_name="Rasqal $rasqal_version";

  open(OUT, ">>$earl_report_file") 
    or die "Cannot write to $earl_report_file - $!\n";
  print OUT <<"EOT"
\@prefix doap: <http://usefulinc.com/ns/doap\#> .
\@prefix earl: <http://www.w3.org/ns/earl\#> .
\@prefix foaf: <http://xmlns.com/foaf/0.1/> .
\@prefix xsd: <http://www.w3.org/2001/XMLSchema\#> .

 _:author a foaf:Person;
     foaf:homepage <http://www.dajobe.org/>;
     foaf:name "Dave Beckett". 

 <${rasqal_url}> a doap:Project;
     doap:name "Rasqal";
     doap:homepage <${rasqal_url}>;
     doap:release
       [ a doap:Version;
         doap:created "$rasqal_date"^^xsd:date ;
         doap:name "${rasqal_name}"].
EOT
    if $is_new;

  for my $config (@failed) {
    my $test_uri=$config->{test_uri};
    print OUT <<"EOT";
  [] a earl:Assertion;
     earl:assertedBy _:author;
     earl:result [
       a earl:TestResult;
       earl:outcome earl:fail
     ];
     earl:subject <${rasqal_url}>;
     earl:test <$test_uri> .
EOT
  }
  for my $config (@passed) {
    my $test_uri=$config->{test_uri};
    print OUT <<"EOT";
  [] a earl:Assertion;
     earl:assertedBy _:author;
     earl:result [
       a earl:TestResult;
       earl:outcome earl:pass
     ];
     earl:subject <${rasqal_url}>;
     earl:test <$test_uri> .
EOT
  }
  close(OUT);
}


if($junit_report_file) {
  my $rasqal_version=`$roqet -v`;
  chomp $rasqal_version;

  my(@t)=gmtime;
  my $timestamp=sprintf("%04d-%02d-%02dT%02d:%02d:%02d",
			1900+$t[5], 1+$t[4], $t[3], $t[2], $t[1], $t[0]);

  my $rasqal_name="Rasqal $rasqal_version";
  my $hostname="localhost";

  my $name = $suite_name;
  my $tests_count = scalar(@passed) + scalar(@failed);
  my $failures_count = scalar(@failed);
  my $errors_count = 0;
  my $runtime = $elapsed_time;
  my $id = 0; # this <testsuites> has only 1 testsuite

  open(OUT, ">$junit_report_file") 
    or die "Cannot write to $junit_report_file - $!\n";
  print OUT <<"EOT";
<?xml version="1.0" encoding="UTF-8" ?>
<testsuites>
  <testsuite
     name="$name"
     timestamp="$timestamp"
     hostname="$hostname"
     tests="$tests_count"
     failures="$failures_count"
     errors="$errors_count"
     time="$runtime"
     id="$id"
  >

    <properties>
       <property name="author-name" value="Dave Beckett" />
       <property name="author-homepage" value="http://www.dajobe.org/" />

       <property name="project-name" value="Rasqal" />
       <property name="project-uri" value="${rasqal_url}" />
       <property name="project-version" value="${rasqal_name}" />
    </properties>
EOT

  my $system_out = '';
  my $system_err = '';
  for my $test_result (@test_results) {
    my $test_uri   = $test_result->{uri};
    my $test_name  = $test_result->{name} || "unknown";
    my $class_name = $test_uri;
    my $is_success = $test_result->{'is-success'};
    my $elapsed    = $test_result->{'elapsed-time'};
    my $test_stdout = $test_result->{'stdout'} || '';
    my $test_stderr = $test_result->{'stderr'} || '';
    print OUT <<"EOT";
    <testcase name="$test_name" classname="$class_name" time="$elapsed_time">
EOT

    if(!$is_success) {
      my $message = html_escape("Failed");
      my $type = "org.librdf.fake";
      my $text = html_escape($test_stdout . $test_stderr);
      print OUT <<"EOT";
      <failure message="$message" type="$type">
         $text
      </failure>

EOT
    }

    # $system_out .= $test_stdout;
    # $system_err .= $test_stderr;
    print OUT <<"EOT";
    </testcase>

EOT
  } # test_result loop

  $system_out = html_escape($system_out);
  $system_err = html_escape($system_err);
  print OUT <<"EOT";
  <system-out>$system_out</system-out> 

  <system-err>$system_err</system-err> 

  </testsuite>
</testsuites>
EOT
  close(OUT);
}


my $failed_count=scalar(@failed);

if($debug) {
warn "$program: $failed_count FAILED tests:\n$program:   " .
     join("\n$program:   ", map { ($_->{name} || $_->{test_uri}). ($debug ? " (".$_->{test_uri}.")" : "") } @failed) .
     "\n"
  if $failed_count;
}
warn "$program: Summary: ".scalar(@passed)." tests passed  ".scalar(@failed)." tests failed\n";

exit $failed_count;

__END__

=head1 NAME

check-sparql - run SPARQL tests

=head1 SYNOPSIS

check-sparql [options] [test ...]

=head1 OPTIONS

=over 8

=item B<--debug>

Enable extra debugging output.

=item B<--help>

Give command help summary.

=item B<--manifest> MANIFEST

Set the input test MANIFEST file

=item B<--earl> EARL

Set the output test EARL summary file.

=item B<--junit> JUNIT

Set the output Ant Junit XML results file.

=item B<--suite> SUITE

Set the test suite name

=back

=head1 DESCRIPTION

Run SPARQL tests from a manifest file.

=cut
