summaryrefslogtreecommitdiffstats
path: root/t/scripts/harness/desc-fields.t
blob: 12207f1e48c119982bb5e40f31690d08b7466b74 (plain)
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
#!/usr/bin/perl

# Copyright (C) 2020 Felix Lechner
# Copyright (C) 2023 Axel Beckert
#
# This program 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 2 of the License, or
# (at your option) any later version.
#
# This program 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 this program.  If not, you can find it on the World Wide
# Web at https://www.gnu.org/copyleft/gpl.html, or write to the Free
# Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
# MA 02110-1301, USA.

# The harness for Lintian's test suite.  For detailed information on
# the test suite layout and naming conventions, see t/tests/README.
# For more information about running tests, see
# doc/tutorial/Lintian/Tutorial/TestSuite.pod
#

use strict;
use warnings;
use v5.10;

use Const::Fast;
use File::Find::Rule;
use List::SomeUtils qw(uniq);
use List::Util qw(all any);
use Path::Tiny;
use Test::More;

BEGIN { $ENV{'LINTIAN_BASE'} //= q{.}; }
use lib "$ENV{'LINTIAN_BASE'}/lib";

use Lintian::Profile;
use Test::Lintian::ConfigFile qw(read_config);

const my $FIXED_TESTS_PER_FILE => 7;

my @descpaths = File::Find::Rule->file()->name('desc')->in('t/recipes');

# mandatory fields
my @mandatory = qw(Testname);

# all known fields
my @known = qw(
  Check
  Default-Lintian-Options
  Exit-Status
  Lintian-Command-Line
  Match-Strategy
  Options
  Output-Format
  Profile
  See-Also
  Test-Against
  Test-Architectures
  Test-Conflicts
  Test-Depends
  Testname
  Todo
);

# disallowed fields
my @disallowed = qw(Test-For Checks References Reference Ref);

# tests per desc
my $perfile = $FIXED_TESTS_PER_FILE + scalar @mandatory + scalar @disallowed;

# set the testing plan
my $known_tests = $perfile * scalar @descpaths;

my $profile = Lintian::Profile->new;
$profile->load(undef, undef, 0);

for my $descpath (@descpaths) {

    # test for duplicate fields
    my %count;
    my @lines = path($descpath)->lines_utf8;
    for my $line (@lines) {
        my ($field) = $line =~ qr/^(\S+):/;
        $count{$field} += 1
          if defined $field;
    }
    ok(
        (all { $count{$_} == 1 } keys %count),
        "No duplicate fields in $descpath"
    );

    ok(
        (
            all {
                my $key = $_;
                any { $key eq $_ } @known;
            } keys %count
        ),
        "No unknown field names are present in $descpath"
    );

    my $testcase = read_config($descpath);

    # get test path
    my $testpath = path($descpath)->parent->parent->stringify;

    # get name from encapsulating directory
    my $name = path($testpath)->basename;

    # name equals encapsulating directory
    is($testcase->unfolded_value('Testname'),
        $name, "Test name matches encapsulating directory in $testpath");

    # mandatory fields
    ok($testcase->declares($_), "Field $_ exists in $name") for @mandatory;

    # disallowed fields
    ok(!$testcase->declares($_), "Field $_ does not exist in $name")
      for @disallowed;

    # no test-against without check
    ok(!$testcase->declares('Test-Against') || $testcase->declares('Check'),
        "No Test-Against without Check in $name");

    # get checks
    my @check_names = $testcase->trimmed_list('Check');

    # no duplicates in checks
    is(
        (scalar @check_names),
        (scalar uniq @check_names),
        "No duplicates in Check in $name"
    );

    # listed checks exist
    ok((all { length $profile->check_module_by_name->{$_} } @check_names),
        "All checks mentioned in $testpath exist");

    # no duplicates in tags against
    my @against = $testcase->trimmed_list('Test-Against');
    is(
        (scalar @against),
        (scalar uniq @against),
        "No duplicates in Test-Against in $name"
    );

    # listed test-against belong to listed checks
    $known_tests += scalar @against;
    my @tags = map { @{$profile->tag_names_for_check->{$_} // []} }
      (@check_names, 'lintian');
    my %relatedtags = map { $_ => 1 } @tags;
    for my $tag (@against) {
        ok(
            exists $relatedtags{$tag},
            "Tags $tag in Test-Against belongs to checks listed in $testpath"
        );
    }
}

done_testing($known_tests);

# Local Variables:
# indent-tabs-mode: nil
# cperl-indent-level: 4
# End:
# vim: syntax=perl sw=4 sts=4 sr et