Main Koha release repository
https://koha-community.org
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
394 lines
14 KiB
394 lines
14 KiB
#!/usr/bin/env perl
|
|
|
|
# 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 => 5;
|
|
use Test::Mojo;
|
|
use Test::Warn;
|
|
|
|
use t::lib::TestBuilder;
|
|
use t::lib::Mocks;
|
|
|
|
use C4::Auth;
|
|
use Koha::Cities;
|
|
use Koha::Database;
|
|
|
|
my $schema = Koha::Database->new->schema;
|
|
my $builder = t::lib::TestBuilder->new;
|
|
|
|
# FIXME: sessionStorage defaults to mysql, but it seems to break transaction handling
|
|
# this affects the other REST api tests
|
|
t::lib::Mocks::mock_preference( 'SessionStorage', 'tmp' );
|
|
|
|
my $remote_address = '127.0.0.1';
|
|
my $t = Test::Mojo->new('Koha::REST::V1');
|
|
|
|
subtest 'list() tests' => sub {
|
|
|
|
plan tests => 18;
|
|
|
|
$schema->storage->txn_begin;
|
|
|
|
Koha::Cities->search->delete;
|
|
my ( $borrowernumber, $session_id ) = create_user_and_session({ authorized => 1 });
|
|
|
|
## Authorized user tests
|
|
# No cities, so empty array should be returned
|
|
my $tx = $t->ua->build_tx( GET => '/api/v1/cities' );
|
|
$tx->req->cookies( { name => 'CGISESSID', value => $session_id } );
|
|
$tx->req->env( { REMOTE_ADDR => $remote_address } );
|
|
$t->request_ok($tx)
|
|
->status_is(200)
|
|
->json_is( [] );
|
|
|
|
my $city = $builder->build_object({ class => 'Koha::Cities' });
|
|
|
|
# One city created, should get returned
|
|
$tx = $t->ua->build_tx( GET => '/api/v1/cities' );
|
|
$tx->req->cookies({ name => 'CGISESSID', value => $session_id });
|
|
$tx->req->env({ REMOTE_ADDR => $remote_address });
|
|
$t->request_ok($tx)
|
|
->status_is(200)
|
|
->json_is( [Koha::REST::V1::Cities::_to_api( $city->TO_JSON )] );
|
|
|
|
my $another_city = $builder->build_object(
|
|
{ class => 'Koha::Cities', value => { city_country => $city->city_country } } );
|
|
my $city_with_another_country = $builder->build_object({ class => 'Koha::Cities' });
|
|
|
|
# Two cities created, they should both be returned
|
|
$tx = $t->ua->build_tx( GET => '/api/v1/cities' );
|
|
$tx->req->cookies( { name => 'CGISESSID', value => $session_id } );
|
|
$tx->req->env( { REMOTE_ADDR => $remote_address } );
|
|
$t->request_ok($tx)->status_is(200)
|
|
->json_is([Koha::REST::V1::Cities::_to_api($city->TO_JSON),
|
|
Koha::REST::V1::Cities::_to_api($another_city->TO_JSON),
|
|
Koha::REST::V1::Cities::_to_api($city_with_another_country->TO_JSON)
|
|
] );
|
|
|
|
# Filtering works, two cities sharing city_country
|
|
$tx = $t->ua->build_tx( GET => "/api/v1/cities?country=" . $city->city_country );
|
|
$tx->req->cookies({ name => 'CGISESSID', value => $session_id });
|
|
$tx->req->env({ REMOTE_ADDR => $remote_address });
|
|
$t->request_ok($tx)
|
|
->status_is(200)
|
|
->json_is([ Koha::REST::V1::Cities::_to_api($city->TO_JSON),
|
|
Koha::REST::V1::Cities::_to_api($another_city->TO_JSON)
|
|
]);
|
|
|
|
$tx = $t->ua->build_tx( GET => "/api/v1/cities?name=" . $city->city_name );
|
|
$tx->req->cookies({ name => 'CGISESSID', value => $session_id });
|
|
$tx->req->env({ REMOTE_ADDR => $remote_address });
|
|
$t->request_ok($tx)
|
|
->status_is(200)
|
|
->json_is( [Koha::REST::V1::Cities::_to_api($city->TO_JSON)] );
|
|
|
|
# Warn on unsupported query parameter
|
|
$tx = $t->ua->build_tx( GET => '/api/v1/cities?city_blah=blah' );
|
|
$tx->req->cookies({ name => 'CGISESSID', value => $session_id });
|
|
$tx->req->env({ REMOTE_ADDR => $remote_address });
|
|
$t->request_ok($tx)
|
|
->status_is(400)
|
|
->json_is( [{ path => '/query/city_blah', message => 'Malformed query string'}] );
|
|
|
|
$schema->storage->txn_rollback;
|
|
};
|
|
|
|
subtest 'get() tests' => sub {
|
|
|
|
plan tests => 6;
|
|
|
|
$schema->storage->txn_begin;
|
|
|
|
my $city = $builder->build_object({ class => 'Koha::Cities' });
|
|
my ( $borrowernumber, $session_id ) = create_user_and_session({ authorized => 1 });
|
|
|
|
my $tx = $t->ua->build_tx( GET => "/api/v1/cities/" . $city->id );
|
|
$tx->req->cookies({ name => 'CGISESSID', value => $session_id });
|
|
$tx->req->env({ REMOTE_ADDR => $remote_address });
|
|
$t->request_ok($tx)
|
|
->status_is(200)
|
|
->json_is(Koha::REST::V1::Cities::_to_api($city->TO_JSON));
|
|
|
|
my $city_to_delete = $builder->build_object({ class => 'Koha::Cities' });
|
|
my $non_existent_id = $city_to_delete->id;
|
|
$city_to_delete->delete;
|
|
|
|
$tx = $t->ua->build_tx( GET => "/api/v1/cities/" . $non_existent_id );
|
|
$tx->req->cookies({ name => 'CGISESSID', value => $session_id });
|
|
$tx->req->env({ REMOTE_ADDR => $remote_address });
|
|
$t->request_ok($tx)
|
|
->status_is(404)
|
|
->json_is( '/error' => 'City not found' );
|
|
|
|
$schema->storage->txn_rollback;
|
|
};
|
|
|
|
subtest 'add() tests' => sub {
|
|
|
|
plan tests => 17;
|
|
|
|
$schema->storage->txn_begin;
|
|
|
|
my ( $unauthorized_borrowernumber, $unauthorized_session_id ) =
|
|
create_user_and_session( { authorized => 0 } );
|
|
my ( $authorized_borrowernumber, $authorized_session_id ) =
|
|
create_user_and_session( { authorized => 1 } );
|
|
my $city = {
|
|
name => "City Name",
|
|
state => "City State",
|
|
postal_code => "City Zipcode",
|
|
country => "City Country"
|
|
};
|
|
|
|
# Unauthorized attempt to write
|
|
my $tx = $t->ua->build_tx( POST => "/api/v1/cities/" => json => $city );
|
|
$tx->req->cookies({ name => 'CGISESSID', value => $unauthorized_session_id });
|
|
$tx->req->env({ REMOTE_ADDR => $remote_address });
|
|
$t->request_ok($tx)
|
|
->status_is(403);
|
|
|
|
# Authorized attempt to write invalid data
|
|
my $city_with_invalid_field = {
|
|
blah => "City Blah",
|
|
state => "City State",
|
|
postal_code => "City Zipcode",
|
|
country => "City Country"
|
|
};
|
|
|
|
$tx = $t->ua->build_tx( POST => "/api/v1/cities/" => json => $city_with_invalid_field );
|
|
$tx->req->cookies({ name => 'CGISESSID', value => $authorized_session_id });
|
|
$tx->req->env( { REMOTE_ADDR => $remote_address } );
|
|
$t->request_ok($tx)
|
|
->status_is(400)
|
|
->json_is(
|
|
"/errors" => [
|
|
{
|
|
message => "Properties not allowed: blah.",
|
|
path => "/body"
|
|
}
|
|
]
|
|
);
|
|
|
|
# Authorized attempt to write
|
|
$tx = $t->ua->build_tx( POST => "/api/v1/cities/" => json => $city );
|
|
$tx->req->cookies({ name => 'CGISESSID', value => $authorized_session_id });
|
|
$tx->req->env({ REMOTE_ADDR => $remote_address });
|
|
my $city_id =
|
|
$t->request_ok($tx)
|
|
->status_is(200)
|
|
->json_is( '/name' => $city->{name} )
|
|
->json_is( '/state' => $city->{state} )
|
|
->json_is( '/postal_code' => $city->{postal_code} )
|
|
->json_is( '/country' => $city->{country} )
|
|
->tx->res->json->{city_id};
|
|
|
|
# Authorized attempt to create with null id
|
|
$city->{city_id} = undef;
|
|
$tx = $t->ua->build_tx( POST => "/api/v1/cities/" => json => $city );
|
|
$tx->req->cookies({ name => 'CGISESSID', value => $authorized_session_id });
|
|
$tx->req->env({ REMOTE_ADDR => $remote_address });
|
|
$t->request_ok($tx)
|
|
->status_is(400)
|
|
->json_has('/errors');
|
|
|
|
# Authorized attempt to create with existing id
|
|
$city->{city_id} = $city_id;
|
|
$tx = $t->ua->build_tx( POST => "/api/v1/cities/" => json => $city );
|
|
$tx->req->cookies({ name => 'CGISESSID', value => $authorized_session_id });
|
|
$tx->req->env({ REMOTE_ADDR => $remote_address });
|
|
$t->request_ok($tx)
|
|
->status_is(400)
|
|
->json_is(
|
|
"/errors" => [
|
|
{
|
|
message => "Read-only.",
|
|
path => "/body/city_id"
|
|
}
|
|
]
|
|
);
|
|
|
|
$schema->storage->txn_rollback;
|
|
};
|
|
|
|
subtest 'update() tests' => sub {
|
|
|
|
plan tests => 15;
|
|
|
|
$schema->storage->txn_begin;
|
|
|
|
my ( $unauthorized_borrowernumber, $unauthorized_session_id ) =
|
|
create_user_and_session( { authorized => 0 } );
|
|
my ( $authorized_borrowernumber, $authorized_session_id ) =
|
|
create_user_and_session( { authorized => 1 } );
|
|
|
|
my $city_id = $builder->build_object({ class => 'Koha::Cities' } )->id;
|
|
|
|
# Unauthorized attempt to update
|
|
my $tx = $t->ua->build_tx( PUT => "/api/v1/cities/$city_id" => json =>
|
|
{ name => 'New unauthorized name change' } );
|
|
$tx->req->cookies({ name => 'CGISESSID', value => $unauthorized_session_id });
|
|
$tx->req->env({ REMOTE_ADDR => $remote_address });
|
|
$t->request_ok($tx)
|
|
->status_is(403);
|
|
|
|
# Attempt partial update on a PUT
|
|
my $city_with_missing_field = {
|
|
name => 'New name',
|
|
state => 'New state',
|
|
country => 'New country'
|
|
};
|
|
|
|
$tx = $t->ua->build_tx(
|
|
PUT => "/api/v1/cities/$city_id" => json => $city_with_missing_field );
|
|
$tx->req->cookies({ name => 'CGISESSID', value => $authorized_session_id });
|
|
$tx->req->env({ REMOTE_ADDR => $remote_address });
|
|
$t->request_ok($tx)->status_is(400)
|
|
->json_is( "/errors" =>
|
|
[ { message => "Missing property.", path => "/body/postal_code" } ]
|
|
);
|
|
|
|
# Full object update on PUT
|
|
my $city_with_updated_field = {
|
|
name => "London",
|
|
state => "City State",
|
|
postal_code => "City Zipcode",
|
|
country => "City Country"
|
|
};
|
|
|
|
$tx = $t->ua->build_tx( PUT => "/api/v1/cities/$city_id" => json => $city_with_updated_field );
|
|
$tx->req->cookies({ name => 'CGISESSID', value => $authorized_session_id });
|
|
$tx->req->env({ REMOTE_ADDR => $remote_address });
|
|
$t->request_ok($tx)
|
|
->status_is(200)
|
|
->json_is( '/name' => 'London' );
|
|
|
|
# Authorized attempt to write invalid data
|
|
my $city_with_invalid_field = {
|
|
blah => "City Blah",
|
|
state => "City State",
|
|
postal_code => "City Zipcode",
|
|
country => "City Country"
|
|
};
|
|
|
|
$tx = $t->ua->build_tx( PUT => "/api/v1/cities/$city_id" => json => $city_with_invalid_field );
|
|
$tx->req->cookies({ name => 'CGISESSID', value => $authorized_session_id });
|
|
$tx->req->env({ REMOTE_ADDR => $remote_address });
|
|
$t->request_ok($tx)
|
|
->status_is(400)
|
|
->json_is(
|
|
"/errors" => [
|
|
{
|
|
message => "Properties not allowed: blah.",
|
|
path => "/body"
|
|
}
|
|
]
|
|
);
|
|
|
|
my $city_to_delete = $builder->build_object({ class => 'Koha::Cities' });
|
|
my $non_existent_id = $city_to_delete->id;
|
|
$city_to_delete->delete;
|
|
|
|
$tx = $t->ua->build_tx( PUT => "/api/v1/cities/$non_existent_id" => json =>
|
|
$city_with_updated_field );
|
|
$tx->req->cookies({ name => 'CGISESSID', value => $authorized_session_id });
|
|
$tx->req->env({ REMOTE_ADDR => $remote_address });
|
|
$t->request_ok($tx)
|
|
->status_is(404);
|
|
|
|
$schema->storage->txn_rollback;
|
|
|
|
# Wrong method (POST)
|
|
$city_with_updated_field->{city_id} = 2;
|
|
|
|
$tx = $t->ua->build_tx(
|
|
POST => "/api/v1/cities/$city_id" => json => $city_with_updated_field );
|
|
$tx->req->cookies({ name => 'CGISESSID', value => $authorized_session_id });
|
|
$tx->req->env({ REMOTE_ADDR => $remote_address });
|
|
$t->request_ok($tx)
|
|
->status_is(404);
|
|
};
|
|
|
|
subtest 'delete() tests' => sub {
|
|
|
|
plan tests => 7;
|
|
|
|
$schema->storage->txn_begin;
|
|
|
|
my ( $unauthorized_borrowernumber, $unauthorized_session_id ) =
|
|
create_user_and_session( { authorized => 0 } );
|
|
my ( $authorized_borrowernumber, $authorized_session_id ) =
|
|
create_user_and_session( { authorized => 1 } );
|
|
|
|
my $city_id = $builder->build_object({ class => 'Koha::Cities' })->id;
|
|
|
|
# Unauthorized attempt to delete
|
|
my $tx = $t->ua->build_tx( DELETE => "/api/v1/cities/$city_id" );
|
|
$tx->req->cookies({ name => 'CGISESSID', value => $unauthorized_session_id });
|
|
$tx->req->env({ REMOTE_ADDR => $remote_address });
|
|
$t->request_ok($tx)
|
|
->status_is(403);
|
|
|
|
$tx = $t->ua->build_tx( DELETE => "/api/v1/cities/$city_id" );
|
|
$tx->req->cookies({ name => 'CGISESSID', value => $authorized_session_id });
|
|
$tx->req->env({ REMOTE_ADDR => $remote_address });
|
|
$t->request_ok($tx)
|
|
->status_is(200)
|
|
->content_is('""');
|
|
|
|
$tx = $t->ua->build_tx( DELETE => "/api/v1/cities/$city_id" );
|
|
$tx->req->cookies({ name => 'CGISESSID', value => $authorized_session_id });
|
|
$tx->req->env({ REMOTE_ADDR => $remote_address });
|
|
$t->request_ok($tx)
|
|
->status_is(404);
|
|
|
|
$schema->storage->txn_rollback;
|
|
};
|
|
|
|
sub create_user_and_session {
|
|
|
|
my $args = shift;
|
|
my $flags = ( $args->{authorized} ) ? $args->{authorized} : 0;
|
|
my $dbh = C4::Context->dbh;
|
|
|
|
my $user = $builder->build(
|
|
{
|
|
source => 'Borrower',
|
|
value => {
|
|
flags => $flags
|
|
}
|
|
}
|
|
);
|
|
|
|
# Create a session for the authorized user
|
|
my $session = C4::Auth::get_session('');
|
|
$session->param( 'number', $user->{borrowernumber} );
|
|
$session->param( 'id', $user->{userid} );
|
|
$session->param( 'ip', '127.0.0.1' );
|
|
$session->param( 'lasttime', time() );
|
|
$session->flush;
|
|
|
|
if ( $args->{authorized} ) {
|
|
$dbh->do( "
|
|
INSERT INTO user_permissions (borrowernumber,module_bit,code)
|
|
VALUES (?,3,'parameters_remaining_permissions')", undef,
|
|
$user->{borrowernumber} );
|
|
}
|
|
|
|
return ( $user->{borrowernumber}, $session->id );
|
|
}
|
|
|
|
|