File: decorate-errors.pl

package info (click to toggle)
datamash 1.9-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, trixie
  • size: 13,600 kB
  • sloc: ansic: 65,320; sh: 8,982; perl: 5,127; makefile: 250; sed: 16
file content (228 lines) | stat: -rw-r--r-- 9,009 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
#!/usr/bin/env perl
=pod
  Unit Tests for decorate

   Copyright (C) 2020-2021 Assaf Gordon <assafgordon@gmail.com>
   Copyright (C) 2022-2025 Timothy Rice <trice@posteo.net>

   This file is part of GNU Datamash.

   GNU Datamash is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.

   GNU Datamash is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with GNU Datamash.  If not, see <https://www.gnu.org/licenses/>.

   Written by Assaf Gordon.
=cut
use strict;
use warnings;

# Until a better way comes along to auto-use Coreutils Perl modules
# as in the coreutils' autotools system.
use Coreutils;
use CuSkip;
use CuTmpdir qw(decorate);
use MIME::Base64 ;

(my $program_name = $0) =~ s|.*/||;
my $prog = 'decorate';


# TODO: add localization tests with "grouping"
# Turn off localization of executable's output.
@ENV{qw(LANGUAGE LANG LC_ALL)} = ('C') x 3;


my $ordering_flags_error_prefix="ordering flags (b/d/i/h/n/g/M/R/V) " .
    "cannot be combined with a conversion function: " .
    "invalid field specification";

my @Tests =
(
  ['e1','--foo-bar',
    {ERR_SUBST=>'s/unknown/unrecognized/; s/-- foo-bar/\'--foo-bar\'/'},
    {ERR=>"$prog: unrecognized option '--foo-bar'\n" .
          "Try '$prog --help' for more information.\n"},
    {EXIT=>2}],
  ['e2','-k1,1:strlen no-such-file.txt', {EXIT=>2},
    {ERR=>"$prog: no-such-file.txt: No such file or directory\n"}],
  ['e3','--decorate -k1,1:strlen no-such-file.txt', {EXIT=>2},
    {ERR=>"$prog: no-such-file.txt: No such file or directory\n"}],
  ['e4','--undecorate 2 no-such-file.txt', {EXIT=>2},
    {ERR=>"$prog: no-such-file.txt: No such file or directory\n"}],

  ['e5','-k1,1%', {EXIT=>2},
    {ERR=>"$prog: invalid key specification: " .
          "invalid field specification '1,1%'\n"}],
  ['e6','-k1,1:', {EXIT=>2},
    {ERR=>"$prog: missing internal conversion function: " .
          "invalid field specification '1,1:'\n"}],
  ['e7','-k1,1@', {EXIT=>2},
    {ERR=>"$prog: missing external conversion command: " .
          "invalid field specification '1,1\@'\n"}],
  ['e8','-k1,1@foobar', {EXIT=>2},
    {ERR=>"$prog: external commands are not implemented (yet)\n"}],
  ['e9','-k1,1:foobar', {EXIT=>2},
    {ERR=>"$prog: invalid built-in conversion option: " .
          "invalid field specification '1,1:foobar'\n"}],

  ## Bad --key=KEYDEF syntax (should be identical to sort's behavior)
  ['e10','-k0', {EXIT=>2},
    {ERR=>"$prog: field number is zero: invalid field specification '0'\n"}],
  ['e11','-k1.0', {EXIT=>2},
    {ERR=>"$prog: character offset is zero: " .
          "invalid field specification '1.0'\n"}],
  ['e12','-k1.A', {EXIT=>2},
    {ERR=>"$prog: invalid number after '.': invalid count at start of 'A'\n"}],
  ['e13','-k1,0', {EXIT=>2},
    {ERR=>"$prog: field number is zero: invalid field specification '1,0'\n"}],
  ['e14','-k1,2.B', {EXIT=>2},
    {ERR=>"$prog: invalid number after '.': invalid count at start of 'B'\n"}],


  ## sort key ordering aren't allowed with conversion functions
  ## (except 'r' for reverse order)
  ['e20','-k1b,1:foobar', {EXIT=>2},
    {ERR=>"$prog: $ordering_flags_error_prefix '1b,1:foobar'\n"}],
  ['e21','-k1,1b:foobar', {EXIT=>2},
    {ERR=>"$prog: $ordering_flags_error_prefix '1,1b:foobar'\n"}],
  ['e22','-k1f,1:foobar', {EXIT=>2},
    {ERR=>"$prog: $ordering_flags_error_prefix '1f,1:foobar'\n"}],
  ['e23','-k1d,1:foobar', {EXIT=>2},
    {ERR=>"$prog: $ordering_flags_error_prefix '1d,1:foobar'\n"}],
  ['e24','-k1n,1:foobar', {EXIT=>2},
    {ERR=>"$prog: $ordering_flags_error_prefix '1n,1:foobar'\n"}],
  ['e25','-k1g,1:foobar', {EXIT=>2},
    {ERR=>"$prog: $ordering_flags_error_prefix '1g,1:foobar'\n"}],
  ['e26','-k1M,1:foobar', {EXIT=>2},
    {ERR=>"$prog: $ordering_flags_error_prefix '1M,1:foobar'\n"}],
  ['e27','-k1h,1:foobar', {EXIT=>2},
    {ERR=>"$prog: $ordering_flags_error_prefix '1h,1:foobar'\n"}],
  ['e28','-k1V,1:foobar', {EXIT=>2},
    {ERR=>"$prog: $ordering_flags_error_prefix '1V,1:foobar'\n"}],
  ['e29','-k1,1R:foobar', {EXIT=>2},
    {ERR=>"$prog: $ordering_flags_error_prefix '1,1R:foobar'\n"}],


  ['e40','-t "" -k1,1:foobar', {EXIT=>2},
    {ERR=>"$prog: empty tab\n"}],
  ['e41','-tab -k1,1:foobar', {EXIT=>2},
    {ERR=>"$prog: multi-character tab 'ab'\n"}],
  ['e42','-t: -t, -k1,1:foobar', {EXIT=>2},
    {ERR=>"$prog: incompatible tabs\n"}],


  ['e50','--undecorate 0', {EXIT=>2},
    {ERR=>"$prog: invalid number of fields to undecorate '0'\n"}],
  ['e51','--undecorate A', {EXIT=>2},
    {ERR=>"$prog: invalid number of fields to undecorate 'A'\n"}],
  ['e52','--undecorate -4', {EXIT=>2},
    {ERR=>"$prog: invalid number of fields to undecorate '-4'\n"}],

  ['e60','--decorate -k1,1:roman --undecorate 4', {EXIT=>2},
    {ERR=>"$prog: --decorate and --undecorate options " .
          "are mutually exclusive\n"}],
  ['e61','-k1,1:roman --undecorate 4', {EXIT=>2},
    {ERR=>"$prog: --undecorate cannot be used with --keys or --decorate\n"}],
  ['e62','', {EXIT=>2},
    {ERR=>"$prog: missing -k/--key decoration or --undecorate options\n"}],

  ['e70', '--header X --decorate -k2,2:ipv4' , {EXIT=>2},
    {ERR=>"$prog: invalid number of header lines 'X'\n"}],


  # Conversion Errors
  ['c1', '--decorate -k1,1:roman' , {IN_PIPE=>"\n"}, {OUT => " "}, {EXIT=>2},
    {ERR=>"$prog: invalid empty roman numeral\n" .
          "$prog: conversion failed in line 1\n" }],
  ['c2', '--decorate -k2,2:roman' , {IN_PIPE=>"M"}, {OUT => " "}, {EXIT=>2},
    {ERR=>"$prog: invalid empty roman numeral\n" .
          "$prog: conversion failed in line 1\n" }],
  ['c3', '--decorate -k1,1:ipv4' , {IN_PIPE=>"FOO\n"}, {OUT => " "}, {EXIT=>2},
    {ERR=>"$prog: invalid dot-decimal IPv4 address 'FOO'\n" .
          "$prog: conversion failed in line 1\n" }],
  ['c4', '--decorate -k1,1:ipv4inet' , {IN_PIPE=>"FOO\n"}, {OUT => " "},
    {EXIT=>2},
    {ERR=>"$prog: invalid IPv4 address 'FOO'\n" .
          "$prog: conversion failed in line 1\n" }],
  ['c5', '--decorate -k1,1:ipv6' , {IN_PIPE=>"FOO\n"}, {OUT => " "}, {EXIT=>2},
    {ERR=>"$prog: invalid IPv6 address 'FOO'\n" .
          "$prog: conversion failed in line 1\n" }],
  ['c6', '--decorate -k1,1:ipv6v4map', {IN_PIPE=>"FOO\n"}, {OUT => " "},
    {EXIT=>2},
    {ERR=>"$prog: invalid IP address 'FOO'\n" .
          "$prog: conversion failed in line 1\n" }],
  ['c7', '--decorate -k1,1:ipv6v4comp', {IN_PIPE=>"FOO\n"}, {OUT => " "},
    {EXIT=>2},
    {ERR=>"$prog: invalid IP address 'FOO'\n" .
          "$prog: conversion failed in line 1\n" }],
  ['c8', '--decorate -k1,1:ipv6v4map', {IN_PIPE=>"0\n"}, {OUT => " "},
    {EXIT=>2},
    {ERR=>"$prog: invalid IP address '0'\n" .
          "$prog: conversion failed in line 1\n" }],
  ['c9', '--decorate -k1,1:ipv6v4comp', {IN_PIPE=>"0\n"}, {OUT => " "},
    {EXIT=>2},
    {ERR=>"$prog: invalid IP address '0'\n" .
          "$prog: conversion failed in line 1\n" }],
  ['c10', '--decorate -k1,1:ipv6v4map', {IN_PIPE=>"\n"}, {OUT => " "},
    {EXIT=>2},
    {ERR=>"$prog: invalid IP address ''\n" .
          "$prog: conversion failed in line 1\n" }],
  ['c11', '--decorate -k1,1:ipv6v4comp', {IN_PIPE=>"\n"}, {OUT => " "},
    {EXIT=>2},
    {ERR=>"$prog: invalid IP address ''\n" .
          "$prog: conversion failed in line 1\n" }],


  # on a different architecture, would printf(%Lg) print something else?
  # Use OUT_SUBST to trim output to 1.3 digits
  #['b14', 'mean 1',     {IN_PIPE=>$in1},  {OUT => "5.454\n"},
  #    {OUT_SUBST=>'s/^(\d\.\d{3}).*/\1/'}],

  ## Some error checkings
  #['e1',  'sum',  {IN_PIPE=>""}, {EXIT=>1},
  #    {ERR=>"$prog: missing field for operation 'sum'\n"}],
);

# Repeat all tests with --debug option, ensure it does not cause any regression
my @debug_tests;
foreach my $t (@Tests)
  {
    # Skip tests with EXIT!=0 or ERR_SUBST part
    # (as '--debug' requires its own ERR_SUBST).
    my $exit_val;
    my $have_err_subst;
    foreach my $e (@$t)
      {
        next unless ref $e && ref $e eq 'HASH';
        $exit_val = $e->{EXIT} if defined $e->{EXIT};
        $have_err_subst = 1 if defined $e->{ERR_SUBST};
      }
    next if $exit_val || $have_err_subst;

    # Duplicate the test, add '--debug' argument
    my @newt = @$t;
    $newt[0] = 'dbg_' . $newt[0];
    $newt[1] = '---debug ' . $newt[1];

    # Discard all debug printouts before comparing output
    push @newt, {ERR_SUBST => q!s/.*\n//m!};

    push @debug_tests, \@newt;
  }
push @Tests, @debug_tests;


my $save_temps = $ENV{SAVE_TEMPS};
my $verbose = $ENV{VERBOSE};

my $fail = run_tests ($program_name, $prog, \@Tests, $save_temps, $verbose);
exit $fail;