t/img.t

   1 #!/usr/bin/perl
   2 #
   3 # unit test that creates test images (png, svg, multi-page pdf), runs ikiwiki
   4 # on them, checks the resulting images for plausibility based on their image
   5 # sizes, and checks if they vanish when not required in the build process any
   6 # more
   7 #
   8 # if you have trouble here, be aware that there are three debian packages that
   9 # can provide Image::Magick: perlmagick, libimage-magick-perl and
  10 # graphicsmagick-libmagick-dev-compat
  11 #
  12 package IkiWiki;
  13
  14 use warnings;
  15 use strict;
  16 use Test::More;
  17
  18 BEGIN { use_ok("IkiWiki"); }
  19 BEGIN { use_ok("Image::Magick"); }
  20
  21 my $installed = $ENV{INSTALLED_TESTS};
  22
  23 my @command;
  24 if ($installed) {
  25         @command = qw(ikiwiki);
  26 }
  27 else {
  28         ok(! system("make -s ikiwiki.out"));
  29         @command = qw(perl -I. ./ikiwiki.out
  30                 --underlaydir=underlays/basewiki
  31                 --set underlaydirbase=underlays
  32                 --templatedir=templates);
  33 }
  34
  35 push @command, qw(--set usedirs=0 --plugin img t/tmp/in t/tmp/out --verbose);
  36
  37 my $magick = new Image::Magick;
  38
  39 $magick->Read("t/img/twopages.pdf");
  40 my $PDFS_WORK = defined $magick->Get("width");
  41
  42 ok(! system("rm -rf t/tmp; mkdir -p t/tmp/in"));
  43
  44 ok(! system("cp t/img/redsquare.png t/tmp/in/redsquare.png"));
  45 ok(! system("cp t/img/redsquare.jpg t/tmp/in/redsquare.jpg"));
  46 ok(! system("cp t/img/redsquare.jpg t/tmp/in/redsquare.jpeg"));
  47 ok(! system("cp t/img/redsquare.jpg t/tmp/in/SHOUTY.JPG"));
  48 # colons in filenames are a corner case for img
  49 ok(! system("cp t/img/redsquare.png t/tmp/in/hello:world.png"));
  50 ok(! system("cp t/img/redsquare.png t/tmp/in/a:b:c.png"));
  51 ok(! system("cp t/img/redsquare.png t/tmp/in/a:b:c:d.png"));
  52 ok(! system("cp t/img/redsquare.png t/tmp/in/a:b:c:d:e:f:g:h:i:j.png"));
  53
  54 writefile("bluesquare.svg", "t/tmp/in",
  55         '<svg width="30" height="30"><rect x="0" y="0" width="30" height="30" fill="blue"/></svg>');
  56 ok(! system("cp t/tmp/in/bluesquare.svg t/tmp/in/really-svg.png"));
  57 ok(! system("cp t/tmp/in/bluesquare.svg t/tmp/in/really-svg.bmp"));
  58 ok(! system("cp t/tmp/in/bluesquare.svg t/tmp/in/really-svg.pdf"));
  59
  60 # using different image sizes for different pages, so the pagenumber selection can be tested easily
  61 ok(! system("cp t/img/twopages.pdf t/tmp/in/twopages.pdf"));
  62 ok(! system("cp t/img/twopages.pdf t/tmp/in/really-pdf.JPEG"));
  63 ok(! system("cp t/img/twopages.pdf t/tmp/in/really-pdf.jpg"));
  64 ok(! system("cp t/img/twopages.pdf t/tmp/in/really-pdf.png"));
  65 ok(! system("cp t/img/twopages.pdf t/tmp/in/really-pdf.svg"));
  66
  67 my $maybe_pdf_img = "";
  68 if ($PDFS_WORK) {
  69         $maybe_pdf_img = <<EOF;
  70 [[!img twopages.pdf size=12x]]
  71 [[!img twopages.pdf size=16x pagenumber=1]]
  72 EOF
  73 }
  74
  75 writefile("imgconversions.mdwn", "t/tmp/in", <<EOF
  76 [[!img redsquare.png]]
  77 [[!img redsquare.jpg size=11x]]
  78 [[!img redsquare.jpeg size=12x]]
  79 [[!img SHOUTY.JPG size=13x]]
  80 [[!img redsquare.png size=10x]]
  81 [[!img redsquare.png size=30x50]] expecting 30x30
  82 [[!img hello:world.png size=x8]] expecting 8x8
  83 [[!img a:b:c.png size=x4]]
  84 [[!img a:b:c:d:e:f:g:h:i:j.png size=x6]]
  85 [[!img bluesquare.svg size=42x]] expecting 42x
  86 [[!img bluesquare.svg size=x43]] expecting x43
  87 [[!img bluesquare.svg size=42x43]] expecting 42x43 because aspect rario not preserved
  88 $maybe_pdf_img
  89
  90 # bad ideas
  91 [[!img really-svg.png size=666x]]
  92 [[!img really-svg.bmp size=666x]]
  93 [[!img really-svg.pdf size=666x]]
  94 [[!img really-pdf.JPEG size=666x]]
  95 [[!img really-pdf.jpg size=666x]]
  96 [[!img really-pdf.png size=666x]]
  97 [[!img really-pdf.svg size=666x]]
  98 EOF
  99 );
 100 ok(utime(333333333, 333333333, "t/tmp/in/imgconversions.mdwn"));
 101
 102 ok(! system(@command, '--set-yaml', 'img_allowed_formats=[JPEG, PNG, svg, pdf]'));
 103
 104 sub size($) {
 105         my $filename = shift;
 106         my $im = Image::Magick->new();
 107         my $r = $im->Read(":$filename");
 108         return "no image" if $r;
 109         my $w = $im->Get("width");
 110         my $h = $im->Get("height");
 111         return "${w}x${h}";
 112 }
 113
 114 my $outpath = "t/tmp/out/imgconversions";
 115 my $outhtml = readfile("$outpath.html");
 116
 117 is(size("$outpath/10x-redsquare.png"), "10x10");
 118 ok(! -e "$outpath/30x-redsquare.png");
 119 ok($outhtml =~ /width="30" height="30".*expecting 30x30/);
 120 ok($outhtml =~ /width="42".*expecting 42x/);
 121 ok($outhtml =~ /height="43".*expecting x43/);
 122 ok($outhtml =~ /width="42" height="43".*expecting 42x43/);
 123
 124 SKIP: {
 125         skip "PDF support not installed (try ghostscript)", 2
 126                 unless $PDFS_WORK;
 127         is(size("$outpath/12x-twopages.png"), "12x12");
 128         is(size("$outpath/16x-p1-twopages.png"), "16x2");
 129 }
 130
 131 ok($outhtml =~ /width="8" height="8".*expecting 8x8/);
 132 is(size("$outpath/x8-hello:world.png"), "8x8");
 133 is(size("$outpath/x4-a:b:c.png"), "4x4");
 134 is(size("$outpath/x6-a:b:c:d:e:f:g:h:i:j.png"), "6x6");
 135
 136 is(size("$outpath/11x-redsquare.jpg"), "11x11");
 137 is(size("$outpath/12x-redsquare.jpeg"), "12x12");
 138 is(size("$outpath/13x-SHOUTY.JPG"), "13x13");
 139 like($outhtml, qr{src="(\./)?imgconversions/11x-redsquare\.jpg" width="11" height="11"});
 140 like($outhtml, qr{src="(\./)?imgconversions/12x-redsquare\.jpeg" width="12" height="12"});
 141 like($outhtml, qr{src="(\./)?imgconversions/13x-SHOUTY\.JPG" width="13" height="13"});
 142
 143 # We do not misinterpret images
 144 my $quot = qr/(?:"|&quot;)/;
 145 like($outhtml, qr/${quot}really-svg\.png${quot} does not seem to be a valid png file/);
 146 ok(! -e "$outpath/666x-really-svg.png");
 147 ok(! -e "$outpath/666x-really-svg.bmp");
 148 like($outhtml, qr/${quot}really-pdf\.JPEG${quot} does not seem to be a valid jpeg file/);
 149 ok(! -e "$outpath/666x-really-pdf.jpeg");
 150 ok(! -e "$outpath/666x-really-pdf.JPEG");
 151 like($outhtml, qr/${quot}really-pdf\.jpg${quot} does not seem to be a valid jpeg file/);
 152 ok(! -e "$outpath/666x-really-pdf.jpg");
 153 like($outhtml, qr/${quot}really-pdf\.png${quot} does not seem to be a valid png file/);
 154 ok(! -e "$outpath/666x-really-pdf.png");
 155
 156 # disable support for uncommon formats and try again
 157 ok(! system(@command, "--rebuild"));
 158 ok(! -e "$outpath/10x-bluesquare.png");
 159 ok(! -e "$outpath/12x-twopages.png");
 160 ok(! -e "$outpath/16x-p1-twopages.png");
 161
 162 # now let's remove them again
 163
 164 if (1) { # for easier testing
 165         writefile("imgconversions.mdwn", "t/tmp/in", "nothing to see here");
 166
 167         ok(! system(@command, "--refresh"));
 168
 169         ok(! -e "$outpath/10x-redsquare.png");
 170         ok(! -e "$outpath/10x-bluesquare.png");
 171         ok(! -e "$outpath/12x-twopages.png");
 172         ok(! -e "$outpath/13x-SHOUTY.JPG");
 173         ok(! -e "$outpath/16x-p1-twopages.png");
 174         ok(! -e "$outpath/x8-hello:world.png");
 175         ok(! -e "$outpath/x4-a:b:c.png");
 176         ok(! -e "$outpath/x6-a:b:c:d:e:f:g:h:i:j.png");
 177
 178         # cleanup
 179         ok(! system("rm -rf t/tmp"));
 180 }
 181 done_testing;
 182
 183 1;