Skip to content

Bug 41719: Add rendering test coverage for Labels and Patroncards (rev 2) #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cnighswonger merged 1 commit into from
Jul 18, 2026
Merged

Bug 41719: Add rendering test coverage for Labels and Patroncards (rev 2) #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
220 changes: 215 additions & 5 deletions t/db_dependent/Labels/t_Label.t
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# This file is part of Koha.
#
# Copyright 2020 Koha Development team
# Copyright 2020, 2026 Koha Development team
# Copyright (C) 2017 Mark Tompsett
#
# Koha is free software; you can redistribute it and/or modify it
Expand All @@ -20,26 +20,58 @@

use Modern::Perl;

BEGIN {
eval { require PDF::Reuse; PDF::Reuse->VERSION(0.43) };
if ($@) {
require Test::More;
Test::More::plan( skip_all => 'PDF::Reuse >= 0.43 required (see Bug 41717)' );
}
}

use Test::NoWarnings;
use Test::More tests => 7;
use Test::More tests => 11;
use Test::Warn;
use t::lib::TestBuilder;
use t::lib::Mocks;

use MARC::Record;
use MARC::Field;
use Data::Dumper;
use File::Temp qw( tempfile );

use C4::Items;
use C4::Biblio;
use C4::Labels::Layout;
use C4::Creators::PDF;

use Koha::Database;

use_ok('C4::Labels::Label');

my $database = Koha::Database->new();
my $schema = $database->schema();
$schema->storage->txn_begin();
# Slurp whatever C4::Creators::PDF::End() prints to the currently selected
# filehandle, return it as a string. Centralises the tempfile/select/End
# dance so a future End() refactor only needs one edit. Dies if End()
# dies (after restoring the selected filehandle) so cleanup-only callers
# cannot silently pass through an End() regression.
sub capture_pdf_end {
my ($pdf) = @_;
my ( $fh, $path ) = tempfile( SUFFIX => '.pdf', UNLINK => 1 );
open( my $out, '>', $path ) or die "Cannot open $path for write: $!";
my $orig = select $out;
eval { $pdf->End() };
my $end_err = $@;
select $orig;
close $out;
die "pdf End() failed: $end_err" if $end_err;
open( my $in, '<', $path ) or die "Cannot open $path for read: $!";
local $/;
my $content = <$in>;
close $in;
return $content;
}

my $schema = Koha::Database->new->schema;
$schema->storage->txn_begin;

my $batch_id;
my ( $llx, $lly ) = ( 0, 0 );
Expand Down Expand Up @@ -152,6 +184,184 @@ is_deeply(
is( $barcode_width, '2.104', );
is( $barcode_height, '0.01', );

# ========================================
# Subtest: draw_label_text() deep assertions
# ========================================
subtest 'draw_label_text() returns correct text structure' => sub {
plan tests => 6;

# Local fixture: deterministic two-field format so this subtest does
# not depend on whatever was last assigned to the top-level $format_string.
my $local_format = '100a 245a,enumchron copynumber';

my $label_bib = C4::Labels::Label->new(
%$label_info,
format_string => $local_format,
printing_type => 'BIB',
justify => 'L',
);
my $text_result = $label_bib->create_label();

ok( defined $text_result, 'create_label(BIB) returns defined value' );
is( ref $text_result, 'ARRAY', 'Return value is an arrayref' );
cmp_ok( scalar @$text_result, '>=', 2, 'Two-field format yields at least two text lines' );

my $first_line = $text_result->[0];
my $expected_llx = $label_info->{llx} + $label_info->{left_text_margin};
my $expected_first_y = $label_info->{lly} + $label_info->{height} - $label_info->{top_text_margin};

is(
$first_line->{text_llx}, $expected_llx,
'First line text_llx = llx + left_text_margin (justify L)'
);
is(
$first_line->{text_lly}, $expected_first_y,
'First line text_lly = lly + height - top_text_margin (per _BIB)'
);
cmp_ok(
$text_result->[1]{text_lly}, '<', $first_line->{text_lly},
'Second line text_lly is less than first (text flows downward)'
);
};

# ========================================
# Subtest: draw_guide_box()
# ========================================
subtest 'draw_guide_box() returns PDF stream when enabled' => sub {
plan tests => 3;

my $label_with_box = C4::Labels::Label->new(
%$label_info,
format_string => $format_string,
guidebox => 1,
llx => 10,
lly => 20,
width => 100,
height => 50,
);
my $box_stream = $label_with_box->draw_guide_box();
ok( $box_stream, 'draw_guide_box returns truthy when guidebox enabled' );
like( $box_stream, qr/10 20 100 50 re/, 'PDF stream contains expected rectangle coordinates' );

my $label_no_box = C4::Labels::Label->new(
%$label_info,
format_string => $format_string,
guidebox => 0,
);
ok( !$label_no_box->draw_guide_box(), 'draw_guide_box returns falsy when guidebox disabled' );
};

# ========================================
# Subtest: barcode() with all supported types
# ========================================
subtest 'barcode() generates all supported barcode types' => sub {
plan tests => 7;

# Local fixture; do not inherit top-level $format_string state.
my $local_format = '100a 245a';

my $pdf = C4::Creators::PDF->new( InitVars => 1 );
$pdf->Page();

# C4::Labels::Label::barcode() converts every PDF::Reuse::Barcode::*
# failure to a warn (Label.pm:556,573,590,609), so a per-type test that
# only checks "did it die" cannot distinguish success from a silent
# barcode-generation failure. We therefore assert no barcode-generation
# warning fires for each type, which is the actual breakage signal.
# CODE39MOD10 (modulo-10 / 'siret') needs numeric data; alpha input
# yields an empty checksum and silently degenerates.
my @barcode_tests = (
{ type => 'CODE39', barcode => 'TEST97531', desc => 'CODE39' },
{ type => 'CODE39MOD', barcode => 'TEST97531', desc => 'CODE39MOD (modulo43 checksum)' },
{ type => 'CODE39MOD10', barcode => '97531', desc => 'CODE39MOD10 (modulo10 checksum)' },
{ type => 'COOP2OF5', barcode => '97531', desc => 'COOP2OF5 (numeric)' },
{ type => 'INDUSTRIAL2OF5', barcode => '97531', desc => 'INDUSTRIAL2OF5 (numeric)' },
{ type => 'EAN13', barcode => '5901234123457', desc => 'EAN13 (13-digit)' },
);

for my $bc_test (@barcode_tests) {
my $bc_label = C4::Labels::Label->new(
%$label_info,
format_string => $local_format,
printing_type => 'BAR',
barcode_type => $bc_test->{type},
barcode => $bc_test->{barcode},
);
warnings_are { $bc_label->create_label() } [],
"barcode() $bc_test->{desc} emits no barcode-generation warning";
}

# Slurp the PDF and assert it contains at least one barcode graphic
# stroke (Code39 / 2-of-5 / EAN13 all emit rectangle 're' operators),
# so the per-type checks above can't all pass against an empty document.
my $content = capture_pdf_end($pdf);
like( $content, qr/\bre\b/, 'PDF contains barcode rectangle operators' );
};

# ========================================
# Subtest: create_label() printing type orchestration
# ========================================
subtest 'create_label() printing type orchestration' => sub {
plan tests => 5;

my $local_format = '100a 245a';

my $pdf = C4::Creators::PDF->new( InitVars => 1 );
$pdf->Page();

# BIB - returns label_text (text only)
my $label_bib = C4::Labels::Label->new(
%$label_info,
format_string => $local_format,
printing_type => 'BIB',
);
my $bib_result = $label_bib->create_label();
ok( defined $bib_result, 'BIB printing type returns label text' );

# BAR - returns undef (barcode only)
my $label_bar = C4::Labels::Label->new(
%$label_info,
format_string => $local_format,
printing_type => 'BAR',
barcode_type => 'CODE39',
barcode => 'ORCHTEST1',
);
my $bar_result = $label_bar->create_label();
ok( !defined $bar_result, 'BAR printing type returns undef (barcode only)' );

# BIBBAR - text-above-barcode geometry (text near top of label)
my $label_bibbar = C4::Labels::Label->new(
%$label_info,
format_string => $local_format,
printing_type => 'BIBBAR',
barcode_type => 'CODE39',
barcode => 'ORCHTEST2',
);
my $bibbar_result = $label_bibbar->create_label();
ok( defined $bibbar_result, 'BIBBAR printing type returns label text' );

# BARBIB - barcode-above-text geometry (text shifted downward)
my $label_barbib = C4::Labels::Label->new(
%$label_info,
format_string => $local_format,
printing_type => 'BARBIB',
barcode_type => 'CODE39',
barcode => 'ORCHTEST3',
);
my $barbib_result = $label_barbib->create_label();
ok( defined $barbib_result, 'BARBIB printing type returns label text' );

# If _BIBBAR and _BARBIB were swapped, both return arrays with defined
# entries and the four checks above would still pass. Pin the geometric
# contract: BIBBAR puts text above BARBIB's text.
cmp_ok(
$bibbar_result->[0]{text_lly}, '>', $barbib_result->[0]{text_lly},
'BIBBAR places first text line above BARBIB (text_lly higher)'
);

capture_pdf_end($pdf);
};

$schema->storage->txn_rollback();

1;
Loading
Loading