lyx_mirror/lib/scripts/lyx_batch.pl.in
Kornel Benko aca3031352 Cmake tests: Added check to inspect created pdf in test "AMS-import"
If the command "comparepdf" is found, it will be used.
Also the script lyx_batch.pl is now easier to expand for
possible new comparision tools.
2018-06-09 09:15:21 +02:00

205 lines
5.5 KiB
Perl

#! /usr/bin/env perl
# -*- mode: perl; -*-
# lyx_batch.pl testname
use strict;
use warnings;
use File::Copy;
use File::Compare;
sub checkPrecondition();
sub system1(@);
sub addFiles($$$);
sub mycompare($$$);
my $builddir = "@CMAKE_BINARY_DIR@";
my $userdir = "$builddir/Testing/.lyxbatch";
my $workdir = "$builddir/autotests/out-home";
my $vsuffix = "@PROGRAM_SUFFIX@";
my $lyx_exe = "$builddir/bin/lyx$vsuffix";
my $git_exe = "@LYX_GITVERSION@";
my $qt_version = "@LYX_USE_QT@";
my $lyxsource = "@LYX_ABS_TOP_SRCDIR@";
my $data = "$lyxsource/development/batchtests";
my $comparepdf = "@COMPAREPDF_EXECUTABLE@";
# src_files := Files to be copied from lyx-source to build-dir
# check := List of tripples
# created file (in build-dir)
# expected file (in source dir, to be compared with the created one)
# eventually system command to compare files
# commands := List of commands (lyx-functions) to be executed by lyx in a batch
# precondition: system commands to be executed prior to the test
# command_line: List of parameters to be used on the lyx-command-line
my %Tests = (
beamer_test => {
src_files => ["beamer_test.lyx"],
check => [["beamer_test.tex", "beamer_test.tex.orig"]],
commands => ["file-open beamer_test.lyx",
"buffer-begin",
"repeat 150 outline-down",
"repeat 150 outline-up",
"buffer-export pdflatex",
"buffer-reload dump",
"lyx-quit"],
},
vcs_info_export => {
precondition => {
command => [$git_exe, "ls-files", "--error-unmatch", "vcs_info_export.lyx"],
workdir => "$data",
},
src_files => ["vcs_info_export.lyx"],
check => [["vcs_info_export.tex", "vcs_info_export.tex.orig"]],
command_line => ["-E", "pdflatex", "vcs_info_export.tex", "$data/vcs_info_export.lyx"],
},
"ams-import" => {
src_files => ["ams-import.tex"],
check => [["ams-import.pdf", "ams-import.pdf", $comparepdf],
["ams-import.lyx"]],
commands => ["buffer-new",
"buffer-import latex ams-import.tex",
"buffer-write",
"buffer-export pdf2",
"lyx-quit"],
},
);
die("Expected argument missing") if (! defined($ARGV[0]));
my $test = $ARGV[0];
die("Invalid argument") if (! defined($Tests{$test}));
if (! -e $userdir) {
mkdir($userdir);
}
my @expected = &addFiles($data, $Tests{$test}->{check},1);
my @created = &addFiles($workdir, $Tests{$test}->{check}, 0);
my @comparecommand = &addFiles(undef, $Tests{$test}->{check}, 2);
# Copy src-files to work with
for my $f (@{$Tests{$test}->{src_files}}) {
copy("$data/$f", "$workdir/$f") or die("Copy failed: $!");
}
print "Unlinking " . join(' ', @created) . "\n";
unlink(@created);
$ENV{LANG} = "en";
$ENV{LC_ALL} = "C";
$ENV{LANGUAGE} = "en_US";
&checkPrecondition();
chdir($workdir);
my @command = ($lyx_exe, "-userdir", $userdir);
if (defined($Tests{$test}->{command_line})) {
push(@command, @{$Tests{$test}->{command_line}});
}
if (defined($Tests{$test}->{commands}->[0])) {
if ($qt_version eq "QT5") {
push(@command, "-platform", "offscreen");
}
if (defined($Tests{$test}->{commands}->[1])) { # more than one command
push(@command, "-x", "command-sequence " . join(';', @{$Tests{$test}->{commands}}));
}
else {
push(@command, "-x", $Tests{$test}->{commands}->[0]);
}
}
&system1(@command);
for (my $i = 0; defined($created[$i]); $i++) {
die("File \"$created[$i]\" not created") if (! -e "$created[$i]");
if (defined($expected[$i])) {
die("Expected ($expected[$i]) and created ($created[$i]) files differ") if (&mycompare($comparecommand[$i], $expected[$i], $created[$i]) != 0);
}
}
exit(0);
sub checkPrecondition()
{
return if (! defined($Tests{$test}->{precondition}));
my $rPrecond = $Tests{$test}->{precondition};
my @command = @{$rPrecond->{command}};
if (defined($rPrecond->{workdir})) {
chdir($rPrecond->{workdir});
}
my $result = &system1(@command);
print "Pre-condition result = $result\n";
die("Pre-condition error") if ($result != 0);
}
sub system1(@)
{
my ($exe, @params) = @_;
print "Executing:\n\t$exe '" . join("' '", @params) . "'\n";
return(system($exe, @params));
}
# Create a list of file paths
# dir: result-dir
# rBases: List of base-names
sub addFiles($$$)
{
my ($tdir, $rrBases, $idx) = @_;
my $dir;
if (defined($tdir)) {
$dir = "$tdir/";
}
else {
$dir = "";
}
my @result = ();
for my $rf (@{$rrBases}) {
my $path = undef;
if (defined($rf) && defined($rf->[$idx])) {
$path = "$dir$rf->[$idx]";
}
push(@result, $path);
}
return(@result);
}
sub mycompare($$$)
{
my ($cmd, $expected, $created) = @_;
my $result;
if (defined($cmd)) { # system command desired
my @params = ();
if ($cmd =~ /NOTFOUND/) {
# no check is done due to missing executable
}
else {
if ($cmd =~ /comparepdf/) {
push(@params, "-ca", "-v=1", $expected, $created);
}
else {
die("unknown system command $cmd");
}
my $error = "";
if (&system1($cmd, @params) != 0) {
if ($? == -1) {
$error = sprintf("failed to execute: $cmd");
}
elsif ($? & 127) {
$error = sprintf("$cmd with signal %d, %s coredump",
($? & 127), ($? & 128) ? 'with' : 'without');
}
else {
$error = sprintf("child $cmd exited with value %d", $? >> 8);
}
}
die($error) if ($error ne "");
}
$result = 0;
}
else {
# defaut text comparision
$result = compare($created, $expected);
}
return($result);
}