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