File: Validator.pm

package info (click to toggle)
libcsaf-perl 0.26-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 2,280 kB
  • sloc: perl: 7,583; makefile: 2
file content (161 lines) | stat: -rw-r--r-- 3,826 bytes parent folder | download
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
package CSAF::Validator;

use 5.010001;
use strict;
use warnings;
use utf8;

use CSAF::Validator::MandatoryTests;
use CSAF::Validator::OptionalTests;
use CSAF::Validator::InformativeTests;

use CSAF::Validator::Schema;
use CSAF::Validator::Message;

use constant DEBUG => $ENV{CSAF_VALIDATOR_DEBUG};

use Moo;
extends 'CSAF::Validator::Base';
with 'CSAF::Util::Log';

sub validate {

    my ($self, $type) = @_;

    my %validator = (

        # 9.1.14 Conformance Clause 14: CSAF basic validator
        schema    => sub { CSAF::Validator::Schema->new($self->csaf)->validate },
        mandatory => sub { CSAF::Validator::MandatoryTests->new($self->csaf)->validate },

        # 9.1.15 Conformance Clause 15: CSAF extended validator
        optional => sub { CSAF::Validator::OptionalTests->new($self->csaf)->validate },

        # 9.1.16 Conformance Clause 16: CSAF full validator
        informative => sub { CSAF::Validator::InformativeTests->new($self->csaf)->validate },

    );

    my @types    = (qw[schema mandatory optional informative]);
    my @messages = ();

    if (defined $type && defined $validator{$type}) {
        @types = ($type);
    }

    foreach (@types) {
        push @messages, $validator{$_}->();
    }

    push @{$self->messages}, @messages;

    if (DEBUG && @{$self->messages}) {
        $self->log->debug('Validation messages(s)');
        $self->log->debug(sprintf('- %s', $_)) for (@{$self->messages});
    }

    return @{$self->messages};

}

1;

__END__

=encoding utf-8

=head1 NAME

CSAF::Validator - Conformance Validator

=head1 SYNOPSIS

    use CSAF::Validator;

    my $v = CSAF::Validator( csaf => $csaf );
    my @messages = $v->validate;

    if ($v->has_error) {
        say "Validator errors";
        say $_ for (@messages);
    }



=head1 DESCRIPTION

L<CSAF::Validator> reads documents and performs a check against the JSON schema 
(L<CSAF::Validator::Schema>), performs all mandatory (L<CSAF::Validator::MandatoryTests>),
optional (L<CSAF::Validator::OptionalTests>) and informative tests (L<CSAF::Validator::Informative>).

Conformance profiles:

=over

=item * CSAF basic validator: A program that reads a document and checks it against the JSON schema and performs mandatory tests.

=item * CSAF extended validator: A CSAF basic validator that additionally performs optional tests.

=item * CSAF full validator: A CSAF extended validator that additionally performs informative tests.

=back

L<https://docs.oasis-open.org/csaf/csaf/v2.0/os/csaf-v2.0-os.html>


=head2 METHODS

L<CSAF::Validator> inherits all methods from L<CSAF::Validator::Base> and implements the following new ones.

=over

=item validate ( [$type] )

Execute all validation tests type (C<schema>, C<mandatory>, C<optional> and C<informative>)
and return all validation messages.

    my @messages = $v->validate;
    say $_ for (@messages);

    # Execute only the mandatory tests

    my @messages = $v->validate('mandatory');
    Carp::croak 'Validation error' if @messages;

=back

=head1 SUPPORT

=head2 Bugs / Feature Requests

Please report any bugs or feature requests through the issue tracker
at L<https://github.com/giterlizzi/perl-CSAF/issues>.
You will be notified automatically of any progress on your issue.

=head2 Source Code

This is open source software.  The code repository is available for
public review and contribution under the terms of the license.

L<https://github.com/giterlizzi/perl-CSAF>

    git clone https://github.com/giterlizzi/perl-CSAF.git


=head1 AUTHOR

=over 4

=item * Giuseppe Di Terlizzi <gdt@cpan.org>

=back


=head1 LICENSE AND COPYRIGHT

This software is copyright (c) 2023-2025 by Giuseppe Di Terlizzi.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut