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.yml";
  26 my @trans_notices_files = qw(
  27     fr-FR/1-Obligatoire/sample_notices.sql
  28     fr-CA/obligatoire/sample_notices.sql
  29     nb-NO/1-Obligatorisk/sample_notices.sql
  30     uk-UA/mandatory/sample_notices.sql
  31 );
  32
  33 ok(
  34     open( my $ref_fh, "<", "$root_dir/$base_notices_file" ),
  35     "Open reference sample notices file $root_dir/$base_notices_file" );
  36 my $ref_notice = get_notices_from_yml_file( $ref_fh );
  37 my @ref_notices = sort { lc $a cmp lc $b } keys %$ref_notice;
  38 cmp_ok(
  39     $#ref_notices, '>=', 0,
  40     "Found " . ($#ref_notices + 1) . " sample notices" );
  41
  42 foreach my $file_name ( @trans_notices_files ) {
  43     compare_notices( $file_name );
  44 }
  45
  46
  47 #
  48 # Get sample notices from SQL file populating letters table with INSERT
  49 # statement.
  50 #
  51 sub get_notices_from_sql_file {
  52     my $fh = shift;
  53     my %notice;
  54     while ( <$fh> ) {
  55         next unless /, *'([\_A-Z_]*)'/;
  56         $notice{$1} = 1;
  57     }
  58     return \%notice;
  59 }
  60 sub get_notices_from_yml_file {
  61     my $fh = shift;
  62     my %notice;
  63     while ( <$fh> ) {
  64         next unless /^\s+code:\s([\_A-Z_]*)$/;
  65         $notice{$1} = 1;
  66     }
  67     return \%notice;
  68 }
  69
  70
  71
  72 sub compare_notices {
  73     my $trans_file = shift;
  74     ok(
  75        open( my $trans_fh,"<", "$root_dir/$trans_file" ),
  76        "Open translated sample notices file $root_dir/$trans_file" );
  77     my $trans_notice = get_notices_from_sql_file( $trans_fh );
  78     my @trans_notices = sort { lc $a cmp lc $b } keys %$trans_notice;
  79     cmp_ok(
  80         $#trans_notices, '>=', 0,
  81         "Found " . ($#trans_notices + 1) . " notices" );
  82     my @to_add_notices;
  83     foreach ( @ref_notices ) {
  84        push @to_add_notices, $_ if ! $trans_notice->{$_};
  85     }
  86     if ( $#to_add_notices >= 0 ) {
  87         fail( 'No sample notice to add') or diag( "Sample notices to add in $trans_file: " . join(', ', @to_add_notices ) );
  88     }
  89     else {
  90         pass( 'No sample notice to add' );
  91     }
  92
  93     my @to_delete_notices;
  94     foreach ( @trans_notices ) {
  95        push @to_delete_notices, $_ if ! $ref_notice->{$_};
  96     }
  97     if ( $#to_delete_notices >= 0 ) {
  98         fail( 'No sample notice to delete' );
  99         diag( "Sample notices to delete in $trans_file: " . join(', ', @to_delete_notices ) );
 100         diag( 'Warning: Some of those sample notices may rather have to be added to English notice' );
 101     }
 102     else {
 103         pass( 'No sample notices to delete' );
 104     }
 105 }
 106
 107
 108 =head1 NAME
 109
 110 sample_notices.t
 111
 112 =head1 DESCRIPTION
 113
 114 This test identifies incoherences between translated sample notices and the
 115 'en' reference file.
 116
 117 Koha sample notices are loaded to 'letter' table from a text SQL file
 118 during Koha installation by web installer. The reference file is the one
 119 provided for English (en) installation :
 120
 121   <koha_root>/installer/data/mysql/en/mandatory/sample_notices.sql
 122
 123 Alternatives files are provided for other languages. Those files are difficult
 124 to keep synchronized with reference file. This could be an functional issue
 125 since some Koha operation depend on notice existence, for example Print Slip in
 126 Circulation.
 127
 128 =head1 USAGE
 129
 130  prove -v sample_notices.t
 131  prove sample_notices.t
 132
 133 =cut