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