Tomas Cohen Arazi
65927d0acb
This patch rewrites the tests, and also doesn't enforce additionalProperties to be false. We could need it, and there are routes that need to be reviewed that would break otherwise now: error.json, for example, is used everywhere, and some routes add some payload to it. The main change this patch introduces is using the resolved spec instead of finding each .json file, which wasn't even correct as we have .yaml files already. Parameters and responses are tested. To test: 1. Apply this patch 2. Run: $ kshell k$ prove xt/api.t => SUCCESS: Tests fail! A nice report on the failures is printed Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
76 lines
2.7 KiB
Perl
Executable file
76 lines
2.7 KiB
Perl
Executable file
# This file is part of Koha.
|
|
#
|
|
# Koha 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.
|
|
#
|
|
# Koha 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 Koha; if not, see <http://www.gnu.org/licenses>.
|
|
|
|
use Modern::Perl;
|
|
|
|
use Test::More tests => 2;
|
|
|
|
use Test::Mojo;
|
|
use Data::Dumper;
|
|
|
|
my $t = Test::Mojo->new('Koha::REST::V1');
|
|
my $spec = $t->get_ok( '/api/v1/', 'Correctly fetched the spec' )->tx->res->json;
|
|
|
|
my $paths = $spec->{paths};
|
|
|
|
my @missing_additionalProperties = ();
|
|
|
|
foreach my $route ( keys %{$paths} ) {
|
|
foreach my $verb ( keys %{ $paths->{$route} } ) {
|
|
|
|
# p($paths->{$route}->{$verb});
|
|
|
|
# check parameters []
|
|
foreach my $parameter ( @{ $paths->{$route}->{$verb}->{parameters} } ) {
|
|
if ( exists $parameter->{schema}
|
|
&& exists $parameter->{schema}->{type}
|
|
&& ref( $parameter->{schema}->{type} ) ne 'ARRAY'
|
|
&& $parameter->{schema}->{type} eq 'object' ) {
|
|
|
|
# it is an object type definition
|
|
if ( not exists $parameter->{schema}->{additionalProperties} ) {
|
|
push @missing_additionalProperties,
|
|
{ type => 'parameter',
|
|
route => $route,
|
|
verb => $verb,
|
|
name => $parameter->{name}
|
|
};
|
|
}
|
|
}
|
|
}
|
|
|
|
# check responses {}
|
|
my $responses = $paths->{$route}->{$verb}->{responses};
|
|
foreach my $response ( keys %{$responses} ) {
|
|
if ( exists $responses->{$response}->{schema}
|
|
&& exists $responses->{$response}->{schema}->{type}
|
|
&& ref( $responses->{$response}->{schema}->{type} ) ne 'ARRAY'
|
|
&& $responses->{$response}->{schema}->{type} eq 'object' ) {
|
|
|
|
# it is an object type definition
|
|
if ( not exists $responses->{$response}->{schema}->{additionalProperties} ) {
|
|
push @missing_additionalProperties,
|
|
{ type => 'response',
|
|
route => $route,
|
|
verb => $verb,
|
|
name => $response
|
|
};
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
is( scalar @missing_additionalProperties, 0 )
|
|
or diag Dumper \@missing_additionalProperties;
|