lib/Gruntmaster/Daemon/Runner.pod

   1 =encoding utf-8
   2
   3 =head1 NAME
   4
   5 Gruntmaster::Daemon::Runner - Modules for running tests
   6
   7 =head1 SYNOPSIS
   8
   9   use Gruntmaster::Daemon::Runner::Foo;
  10   Gruntmaster::Daemon::Runner::Foo::run(5, $meta);
  11
  12 =head1 DESCRIPTION
  13
  14 A runner is a module that runs a program on some input data, returning a verdict. Each runner has a subroutine, B<run>(I<$test>, I<$meta>), which runs the program on the given test and returns a verdict.
  15
  16 If the test is successful, the verdict is a string, usually a message (such as C<"Ok">) or a number of points (such as C<"10">). Otherwise, the verdict is an array reference with two elements: an error code (see L<Gruntmaster::Daemon::Constants> for a list) and an error message.
  17
  18 There are three runners in this distribution:
  19
  20 =over
  21
  22 =item L<Gruntmaster::Daemon::Runner::File> - Compare output with static text files
  23
  24 =item L<Gruntmaster::Daemon::Runner::Verifier> - Check the program output with a verifier
  25
  26 =item L<Gruntmaster::Daemon::Runner::Interactive> - Make an interactive verifier talk to the program
  27
  28 =back
  29
  30 =head1 AUTHOR
  31
  32 Marius Gavrilescu E<lt>marius@ieval.roE<gt>
  33
  34 =head1 COPYRIGHT AND LICENSE
  35
  36 Copyright (C) 2014 by Marius Gavrilescu
  37
  38 This library is free software: you can redistribute it and/or modify
  39 it under the terms of the GNU Affero General Public License as published by
  40 the Free Software Foundation, either version 3 of the License, or
  41 (at your option) any later version.
  42
  43
  44 =cut