xt/sample_notices.t

   1 #!/usr/bin/perl
   2
   3 # Copyright (C) 2014 Tamil s.a.r.l.
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 use Modern::Perl;
  21 use Test::More qw(no_plan);
  22
  23
  24 my $root_dir = 'installer/data/mysql';
  25 my $base_notices_file = "en/mandatory/sample_notices.sql";
  26 my @trans_notices_files = qw(
  27     fr-FR/1-Obligatoire/sample_notices.sql
  28     fr-CA/obligatoire/sample_notices.sql
  29     de-DE/mandatory/sample_notices.sql
  30     es-ES/mandatory/sample_notices.sql
  31     it-IT/necessari/notices.sql
  32     nb-NO/1-Obligatorisk/sample_notices.sql
  33     pl-PL/mandatory/sample_notices.sql
  34     ru-RU/mandatory/sample_notices.sql
  35     uk-UA/mandatory/sample_notices.sql
  36 );
  37
  38 ok(
  39     open( my $ref_fh, "<", "$root_dir/$base_notices_file" ),
  40     "Open reference sample notices file $root_dir/$base_notices_file" );
  41 my $ref_notice = get_notices_from_file( $ref_fh );
  42 my @ref_notices = sort { lc $a cmp lc $b } keys %$ref_notice;
  43 cmp_ok(
  44     $#ref_notices, '>=', 0,
  45     "Found " . ($#ref_notices + 1) . " sample notices" );
  46
  47 foreach my $file_name ( @trans_notices_files ) {
  48     compare_notices( $file_name );
  49 }
  50
  51
  52 #
  53 # Get sample notices from SQL file populating letters table with INSERT
  54 # statement.
  55 #
  56 sub get_notices_from_file {
  57     my $fh = shift;
  58     my %notice;
  59     while ( <$fh> ) {
  60         next unless /, *'([\_A-Z_]*)'/;
  61         $notice{$1} = 1;
  62     }
  63     return \%notice;
  64 }
  65
  66
  67 sub compare_notices {
  68     my $trans_file = shift;
  69     ok(
  70        open( my $trans_fh,"<", "$root_dir/$trans_file" ),
  71        "Open translated sample notices file $root_dir/$trans_file" );
  72     my $trans_notice = get_notices_from_file( $trans_fh );
  73     use YAML;
  74     my @trans_notices = sort { lc $a cmp lc $b } keys %$trans_notice;
  75     cmp_ok(
  76         $#trans_notices, '>=', 0,
  77         "Found " . ($#trans_notices + 1) . " notices" );
  78     my @to_add_notices;
  79     foreach ( @ref_notices ) {
  80        push @to_add_notices, $_ if ! $trans_notice->{$_};
  81     }
  82     if ( $#to_add_notices >= 0 ) {
  83         fail( 'No sample notice to add') or diag( "Sample notices to add in $trans_file: " . join(', ', @to_add_notices ) );
  84     }
  85     else {
  86         pass( 'No sample notice to add' );
  87     }
  88
  89     my @to_delete_notices;
  90     foreach ( @trans_notices ) {
  91        push @to_delete_notices, $_ if ! $ref_notice->{$_};
  92     }
  93     if ( $#to_delete_notices >= 0 ) {
  94         fail( 'No sample notice to delete' );
  95         diag( "Sample notices to delete in $trans_file: " . join(', ', @to_delete_notices ) );
  96         diag( 'Warning: Some of those sample notices may rather have to be added to English notice' );
  97     }
  98     else {
  99         pass( 'No sample notices to delete' );
 100     }
 101 }
 102
 103
 104 =head1 NAME
 105
 106 sample_notices.t
 107
 108 =head1 DESCRIPTION
 109
 110 This test identifies incoherences between translated sample notices and the
 111 'en' reference file.
 112
 113 Koha sample notices are loaded to 'letter' table from a text SQL file
 114 during Koha installation by web installer. The reference file is the one
 115 provided for English (en) installation :
 116
 117   <koha_root>/installer/data/mysql/en/mandatory/sample_notices.sql
 118
 119 Alternatives files are provided for other languages. Those files are difficult
 120 to keep synchronized with reference file. This could be an functional issue
 121 since some Koha operation depend on notice existence, for example Print Slip in
 122 Circulation.
 123
 124 =head1 USAGE
 125
 126  prove -v sample_notices.t
 127  prove sample_notices.t
 128
 129 =cut