Koha/t/db_dependent/api/v1/swagger/definitions.t
Kyle M Hall 9e477baa5e Bug 17032 [QA Followup] - Update path to swagger.json file
Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
2016-09-09 13:00:09 +00:00

88 lines
3 KiB
Perl

#!/usr/bin/env perl
# Copyright 2016 Koha-Suomi
#
# 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, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
use Modern::Perl;
use Test::More tests => 1;
use Test::Mojo;
use Module::Load::Conditional;
use Swagger2;
use C4::Context;
my $swaggerPath = C4::Context->config('intranetdir') . "/api/v1/swagger";
my $swagger = Swagger2->new( $swaggerPath . "/swagger.json" )->expand;
my $api_spec = $swagger->api_spec->data;
# The basic idea of this test:
# 1. Find all definitions in Swagger under api/v1/definitions
# 2. Iterating over each definition, check 'type' of the definition
# * If type is not 'object', definition is ok. We only want objects.
# * If type is an 'object', attempt to load the corresponding Koha-object.
# -> If corresponding Koha-object is not found, definition is ok.
# -> If corresponding Koha-object is found and loaded, compare its
# columns to properties of the object defined in Swagger.
# --> If columns match properties, definition is ok.
# --> If columns do not match properties, definition is not ok.
my @definition_names = keys %{ $api_spec->{definitions} };
subtest 'api/v1/definitions/*.json up-to-date with corresponding Koha-object' => sub {
plan tests => scalar(@definition_names);
foreach my $name (@definition_names) {
my $definition = $api_spec->{definitions}->{$name};
if ($definition->{type} eq "object") {
my $kohaObject = _koha_object($name);
unless ($kohaObject && $kohaObject->can("_columns")) {
ok(1, "$name is an object, but not a Koha-object!");
next;
}
my $columns = $kohaObject->_columns;
my $properties = $definition->{properties};
is(_is_up_to_date($properties, $columns), "",
"$name matches ".ref($kohaObject)." and is not missing any properties.");
} else {
ok(1, "$name type is not an object. It is ".$definition->{type}.".");
}
}
};
sub _koha_object {
my ($name) = @_;
$name = "Koha::" . ucfirst $name;
if (Module::Load::Conditional::can_load(modules => {$name => undef})) {
return bless {}, $name ;
}
}
sub _is_up_to_date {
my ($properties, $columns) = @_;
my @missing;
foreach my $column (@$columns) {
push @missing, $column unless $properties->{$column};
}
return join(', ' , @missing);
}