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