t/db_dependent/Koha/Object.t

   1 #!/usr/bin/perl
   2
   3 # This file is part of Koha.
   4 #
   5 # Koha is free software; you can redistribute it and/or modify it
   6 # under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # Koha is distributed in the hope that it will be useful, but
  11 # WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  17
  18 use Modern::Perl;
  19
  20 use Test::More tests => 22;
  21 use Test::Exception;
  22 use Test::Warn;
  23 use DateTime;
  24
  25 use C4::Context;
  26 use C4::Circulation qw( AddIssue );
  27 use C4::Biblio qw( AddBiblio );
  28
  29 use Koha::Database;
  30
  31 use Koha::Acquisition::Orders;
  32 use Koha::ApiKeys;
  33 use Koha::AuthorisedValueCategories;
  34 use Koha::AuthorisedValues;
  35 use Koha::DateUtils qw( dt_from_string );
  36 use Koha::Libraries;
  37 use Koha::Patrons;
  38 use Koha::Library::Groups;
  39
  40 use JSON;
  41 use Scalar::Util qw( isvstring );
  42 use Try::Tiny;
  43
  44 use t::lib::TestBuilder;
  45 use t::lib::Mocks;
  46
  47 BEGIN {
  48     use_ok('Koha::Object');
  49     use_ok('Koha::Patron');
  50 }
  51
  52 my $schema  = Koha::Database->new->schema;
  53 my $builder = t::lib::TestBuilder->new();
  54
  55 subtest 'is_changed / make_column_dirty' => sub {
  56     plan tests => 11;
  57
  58     $schema->storage->txn_begin;
  59
  60     my $categorycode = $builder->build({ source => 'Category' })->{categorycode};
  61     my $branchcode = $builder->build({ source => 'Branch' })->{branchcode};
  62
  63     my $object = Koha::Patron->new();
  64     $object->categorycode( $categorycode );
  65     $object->branchcode( $branchcode );
  66     $object->surname("Test Surname");
  67     $object->store->discard_changes;
  68     is( $object->is_changed(), 0, "Object is unchanged" );
  69     $object->surname("Test Surname");
  70     is( $object->is_changed(), 0, "Object is still unchanged" );
  71     $object->surname("Test Surname 2");
  72     is( $object->is_changed(), 1, "Object is changed" );
  73
  74     $object->store();
  75     is( $object->is_changed(), 0, "Object no longer marked as changed after being stored" );
  76
  77     $object->set({ firstname => 'Test Firstname' });
  78     is( $object->is_changed(), 1, "Object is changed after Set" );
  79     $object->store();
  80     is( $object->is_changed(), 0, "Object no longer marked as changed after being stored" );
  81
  82     # Test make_column_dirty
  83     is( $object->make_column_dirty('firstname'), '', 'make_column_dirty returns empty string on success' );
  84     is( $object->make_column_dirty('firstname'), 1, 'make_column_dirty returns 1 if already dirty' );
  85     is( $object->is_changed, 1, "Object is changed after make dirty" );
  86     $object->store;
  87     is( $object->is_changed, 0, "Store clears dirty mark" );
  88     $object->make_column_dirty('firstname');
  89     $object->discard_changes;
  90     is( $object->is_changed, 0, "Discard clears dirty mark too" );
  91
  92     $schema->storage->txn_rollback;
  93 };
  94
  95 subtest 'in_storage' => sub {
  96     plan tests => 6;
  97
  98     $schema->storage->txn_begin;
  99
 100     my $categorycode = $builder->build({ source => 'Category' })->{categorycode};
 101     my $branchcode = $builder->build({ source => 'Branch' })->{branchcode};
 102
 103     my $object = Koha::Patron->new();
 104     is( $object->in_storage, 0, "Object is not in storage" );
 105     $object->categorycode( $categorycode );
 106     $object->branchcode( $branchcode );
 107     $object->surname("Test Surname");
 108     $object->store();
 109     is( $object->in_storage, 1, "Object is now stored" );
 110     $object->surname("another surname");
 111     is( $object->in_storage, 1 );
 112
 113     my $borrowernumber = $object->borrowernumber;
 114     my $patron = $schema->resultset('Borrower')->find( $borrowernumber );
 115     is( $patron->surname(), "Test Surname", "Object found in database" );
 116
 117     $object->delete();
 118     $patron = $schema->resultset('Borrower')->find( $borrowernumber );
 119     ok( ! $patron, "Object no longer found in database" );
 120     is( $object->in_storage, 0, "Object is not in storage" );
 121
 122     $schema->storage->txn_rollback;
 123 };
 124
 125 subtest 'id' => sub {
 126     plan tests => 1;
 127
 128     $schema->storage->txn_begin;
 129
 130     my $categorycode = $builder->build({ source => 'Category' })->{categorycode};
 131     my $branchcode = $builder->build({ source => 'Branch' })->{branchcode};
 132
 133     my $patron = Koha::Patron->new({categorycode => $categorycode, branchcode => $branchcode })->store;
 134     is( $patron->id, $patron->borrowernumber );
 135
 136     $schema->storage->txn_rollback;
 137 };
 138
 139 subtest 'get_column' => sub {
 140     plan tests => 1;
 141
 142     $schema->storage->txn_begin;
 143
 144     my $categorycode = $builder->build({ source => 'Category' })->{categorycode};
 145     my $branchcode = $builder->build({ source => 'Branch' })->{branchcode};
 146
 147     my $patron = Koha::Patron->new({categorycode => $categorycode, branchcode => $branchcode })->store;
 148     is( $patron->get_column('borrowernumber'), $patron->borrowernumber, 'get_column should retrieve the correct value' );
 149
 150     $schema->storage->txn_rollback;
 151 };
 152
 153 subtest 'discard_changes' => sub {
 154     plan tests => 1;
 155
 156     $schema->storage->txn_begin;
 157
 158     my $patron = $builder->build( { source => 'Borrower' } );
 159     $patron = Koha::Patrons->find( $patron->{borrowernumber} );
 160     $patron->dateexpiry(dt_from_string);
 161     $patron->discard_changes;
 162     is(
 163         dt_from_string( $patron->dateexpiry ),
 164         dt_from_string->truncate( to => 'day' ),
 165         'discard_changes should refresh the object'
 166     );
 167
 168     $schema->storage->txn_rollback;
 169 };
 170
 171 subtest 'TO_JSON tests' => sub {
 172
 173     plan tests => 9;
 174
 175     $schema->storage->txn_begin;
 176
 177     my $dt = dt_from_string();
 178     my $borrowernumber = $builder->build(
 179         { source => 'Borrower',
 180           value => { lost => 1,
 181                      sms_provider_id => undef,
 182                      gonenoaddress => 0,
 183                      updated_on => $dt,
 184                      lastseen   => $dt, } })->{borrowernumber};
 185
 186     my $patron = Koha::Patrons->find($borrowernumber);
 187     my $lost = $patron->TO_JSON()->{lost};
 188     my $gonenoaddress = $patron->TO_JSON->{gonenoaddress};
 189     my $updated_on = $patron->TO_JSON->{updated_on};
 190     my $lastseen = $patron->TO_JSON->{lastseen};
 191
 192     ok( $lost->isa('JSON::PP::Boolean'), 'Boolean attribute type is correct' );
 193     is( $lost, 1, 'Boolean attribute value is correct (true)' );
 194
 195     ok( $gonenoaddress->isa('JSON::PP::Boolean'), 'Boolean attribute type is correct' );
 196     is( $gonenoaddress, 0, 'Boolean attribute value is correct (false)' );
 197
 198     is( $patron->TO_JSON->{sms_provider_id}, undef, 'Undef values should not be casted to 0' );
 199
 200     ok( !isvstring($patron->borrowernumber), 'Integer values are not coded as strings' );
 201
 202     my $rfc3999_regex = qr/
 203             (?<year>\d{4})
 204             -
 205             (?<month>\d{2})
 206             -
 207             (?<day>\d{2})
 208             ([Tt\s])
 209             (?<hour>\d{2})
 210             :
 211             (?<minute>\d{2})
 212             :
 213             (?<second>\d{2})
 214             (([Zz])|([\+|\-]([01][0-9]|2[0-3]):[0-5][0-9]))
 215         /xms;
 216     like( $updated_on, $rfc3999_regex, "Date-time $updated_on formatted correctly");
 217     like( $lastseen, $rfc3999_regex, "Date-time $updated_on formatted correctly");
 218
 219     # Test JSON doesn't receive strings
 220     my $order = $builder->build_object({ class => 'Koha::Acquisition::Orders' });
 221     $order = Koha::Acquisition::Orders->find( $order->ordernumber );
 222     is_deeply( $order->TO_JSON, decode_json( encode_json( $order->TO_JSON ) ), 'Orders are similar' );
 223
 224     $schema->storage->txn_rollback;
 225 };
 226
 227 subtest "to_api() tests" => sub {
 228
 229     plan tests => 29;
 230
 231     $schema->storage->txn_begin;
 232
 233     my $city = $builder->build_object({ class => 'Koha::Cities' });
 234
 235     # THE mapping
 236     # cityid       => 'city_id',
 237     # city_country => 'country',
 238     # city_name    => 'name',
 239     # city_state   => 'state',
 240     # city_zipcode => 'postal_code'
 241
 242     my $api_city = $city->to_api;
 243
 244     is( $api_city->{city_id},     $city->cityid,       'Attribute translated correctly' );
 245     is( $api_city->{country},     $city->city_country, 'Attribute translated correctly' );
 246     is( $api_city->{name},        $city->city_name,    'Attribute translated correctly' );
 247     is( $api_city->{state},       $city->city_state,   'Attribute translated correctly' );
 248     is( $api_city->{postal_code}, $city->city_zipcode, 'Attribute translated correctly' );
 249
 250     # Lets emulate an undef
 251     my $city_class = Test::MockModule->new('Koha::City');
 252     $city_class->mock( 'to_api_mapping',
 253         sub {
 254             return {
 255                 cityid       => 'city_id',
 256                 city_country => 'country',
 257                 city_name    => 'name',
 258                 city_state   => 'state',
 259                 city_zipcode => undef
 260             };
 261         }
 262     );
 263
 264     $api_city = $city->to_api;
 265
 266     is( $api_city->{city_id},     $city->cityid,       'Attribute translated correctly' );
 267     is( $api_city->{country},     $city->city_country, 'Attribute translated correctly' );
 268     is( $api_city->{name},        $city->city_name,    'Attribute translated correctly' );
 269     is( $api_city->{state},       $city->city_state,   'Attribute translated correctly' );
 270     ok( !exists $api_city->{postal_code}, 'Attribute removed' );
 271
 272     # Pick a class that won't have a mapping for the API
 273     my $illrequest = $builder->build_object({ class => 'Koha::Illrequests' });
 274     is_deeply( $illrequest->to_api, $illrequest->TO_JSON, 'If no overloaded to_api_mapping method, return TO_JSON' );
 275
 276     my $biblio = $builder->build_sample_biblio();
 277     my $item = $builder->build_sample_item({ biblionumber => $biblio->biblionumber });
 278     my $hold = $builder->build_object({ class => 'Koha::Holds', value => { itemnumber => $item->itemnumber } });
 279
 280     my $embeds = { 'items' => {} };
 281
 282     my $biblio_api = $biblio->to_api({ embed => $embeds });
 283
 284     ok(exists $biblio_api->{items}, 'Items where embedded in biblio results');
 285     is($biblio_api->{items}->[0]->{item_id}, $item->itemnumber, 'Item matches');
 286     ok(!exists $biblio_api->{items}->[0]->{holds}, 'No holds info should be embedded yet');
 287
 288     $embeds = (
 289         {
 290             'items' => {
 291                 'children' => {
 292                     'holds' => {}
 293                 }
 294             },
 295             'biblioitem' => {}
 296         }
 297     );
 298     $biblio_api = $biblio->to_api({ embed => $embeds });
 299
 300     ok(exists $biblio_api->{items}, 'Items where embedded in biblio results');
 301     is($biblio_api->{items}->[0]->{item_id}, $item->itemnumber, 'Item still matches');
 302     ok(exists $biblio_api->{items}->[0]->{holds}, 'Holds info should be embedded');
 303     is($biblio_api->{items}->[0]->{holds}->[0]->{hold_id}, $hold->reserve_id, 'Hold matches');
 304     is_deeply($biblio_api->{biblioitem}, $biblio->biblioitem->to_api, 'More than one root');
 305
 306     my $hold_api = $hold->to_api(
 307         {
 308             embed => { 'item' => {} }
 309         }
 310     );
 311
 312     is( ref($hold_api->{item}), 'HASH', 'Single nested object works correctly' );
 313     is( $hold_api->{item}->{item_id}, $item->itemnumber, 'Object embedded correctly' );
 314
 315     # biblio with no items
 316     my $new_biblio = $builder->build_sample_biblio;
 317     my $new_biblio_api = $new_biblio->to_api({ embed => $embeds });
 318
 319     is_deeply( $new_biblio_api->{items}, [], 'Empty list if no items' );
 320
 321     my $biblio_class = Test::MockModule->new('Koha::Biblio');
 322     $biblio_class->mock( 'undef_result', sub { return; } );
 323
 324     $new_biblio_api = $new_biblio->to_api({ embed => ( { 'undef_result' => {} } ) });
 325     ok( exists $new_biblio_api->{undef_result}, 'If a method returns undef, then the attribute is defined' );
 326     is( $new_biblio_api->{undef_result}, undef, 'If a method returns undef, then the attribute is undef' );
 327
 328     $biblio_class->mock( 'items',
 329         sub { return [ bless { itemnumber => 1 }, 'Somethings' ]; } );
 330
 331     throws_ok {
 332         $new_biblio_api = $new_biblio->to_api(
 333             { embed => { 'items' => { children => { asd => {} } } } } );
 334     }
 335     'Koha::Exception',
 336 "An exception is thrown if a blessed object to embed doesn't implement to_api";
 337
 338     is(
 339         $@->message,
 340         "Asked to embed items but its return value doesn't implement to_api",
 341         "Exception message correct"
 342     );
 343
 344
 345     my $patron = $builder->build_object( { class => 'Koha::Patrons' } );
 346     $builder->build_object(
 347         {
 348             class => 'Koha::Holds',
 349             value => {
 350                 biblionumber   => $biblio->biblionumber,
 351                 borrowernumber => $patron->borrowernumber
 352             }
 353         }
 354     );
 355     $builder->build_object(
 356         {
 357             class => 'Koha::Holds',
 358             value => {
 359                 biblionumber   => $biblio->biblionumber,
 360                 borrowernumber => $patron->borrowernumber
 361             }
 362         }
 363     );
 364
 365     my $patron_api = $patron->to_api(
 366         {
 367             embed => { holds_count => { is_count => 1 } }
 368         }
 369     );
 370     is( $patron_api->{holds_count}, $patron->holds->count, 'Count embeds are supported and work as expected' );
 371
 372     throws_ok
 373         {
 374             $patron->to_api({ embed => { holds_count => {} } });
 375         }
 376         'Koha::Exceptions::Object::MethodNotCoveredByTests',
 377         'Unknown method exception thrown if is_count not specified';
 378
 379     subtest 'unprivileged request tests' => sub {
 380
 381         my @all_attrs = Koha::Libraries->columns();
 382         my $public_attrs = { map { $_ => 1 } @{ Koha::Library->public_read_list() } };
 383         my $mapping = Koha::Library->to_api_mapping;
 384
 385         plan tests => scalar @all_attrs * 2;
 386
 387         # Create a sample library
 388         my $library = $builder->build_object( { class => 'Koha::Libraries' } );
 389
 390         my $unprivileged_representation = $library->to_api({ public => 1 });
 391         my $privileged_representation   = $library->to_api;
 392
 393         foreach my $attr (@all_attrs) {
 394             my $mapped = exists $mapping->{$attr} ? $mapping->{$attr} : $attr;
 395             if ( defined($mapped) ) {
 396                 ok(
 397                     exists $privileged_representation->{$mapped},
 398                     "Attribute '$attr' is present when privileged"
 399                 );
 400                 if ( exists $public_attrs->{$attr} ) {
 401                     ok(
 402                         exists $unprivileged_representation->{$mapped},
 403                         "Attribute '$attr' is present when public"
 404                     );
 405                 }
 406                 else {
 407                     ok(
 408                         !exists $unprivileged_representation->{$mapped},
 409                         "Attribute '$attr' is not present when public"
 410                     );
 411                 }
 412             }
 413             else {
 414                 ok(
 415                     !exists $privileged_representation->{$attr},
 416                     "Unmapped attribute '$attr' is not present when privileged"
 417                 );
 418                 ok(
 419                     !exists $unprivileged_representation->{$attr},
 420                     "Unmapped attribute '$attr' is not present when public"
 421                 );
 422             }
 423         }
 424     };
 425
 426     $schema->storage->txn_rollback;
 427 };
 428
 429 subtest "to_api_mapping() tests" => sub {
 430
 431     plan tests => 1;
 432
 433     $schema->storage->txn_begin;
 434
 435     my $illrequest = $builder->build_object({ class => 'Koha::Illrequests' });
 436     is_deeply( $illrequest->to_api_mapping, {}, 'If no to_api_mapping present, return empty hashref' );
 437
 438     $schema->storage->txn_rollback;
 439 };
 440
 441 subtest "from_api_mapping() tests" => sub {
 442
 443     plan tests => 5;
 444
 445     $schema->storage->txn_begin;
 446
 447     my $city = $builder->build_object({ class => 'Koha::Cities' });
 448
 449     # Lets emulate an undef
 450     my $city_class = Test::MockModule->new('Koha::City');
 451     $city_class->mock( 'to_api_mapping',
 452         sub {
 453             return {
 454                 cityid       => 'city_id',
 455                 city_country => 'country',
 456                 city_zipcode => undef
 457             };
 458         }
 459     );
 460
 461     is_deeply(
 462         $city->from_api_mapping,
 463         {
 464             city_id => 'cityid',
 465             country => 'city_country'
 466         },
 467         'Mapping returns correctly, undef ommited'
 468     );
 469
 470     $city_class->unmock( 'to_api_mapping');
 471     $city_class->mock( 'to_api_mapping',
 472         sub {
 473             return {
 474                 cityid       => 'city_id',
 475                 city_country => 'country',
 476                 city_zipcode => 'postal_code'
 477             };
 478         }
 479     );
 480
 481     is_deeply(
 482         $city->from_api_mapping,
 483         {
 484             city_id => 'cityid',
 485             country => 'city_country'
 486         },
 487         'Reverse mapping is cached'
 488     );
 489
 490     # Get a fresh object
 491     $city = $builder->build_object({ class => 'Koha::Cities' });
 492     is_deeply(
 493         $city->from_api_mapping,
 494         {
 495             city_id     => 'cityid',
 496             country     => 'city_country',
 497             postal_code => 'city_zipcode'
 498         },
 499         'Fresh mapping loaded'
 500     );
 501
 502     $city_class->unmock( 'to_api_mapping');
 503     $city_class->mock( 'to_api_mapping', undef );
 504
 505     # Get a fresh object
 506     $city = $builder->build_object({ class => 'Koha::Cities' });
 507     is_deeply(
 508         $city->from_api_mapping,
 509         {},
 510         'No to_api_mapping then empty hashref'
 511     );
 512
 513     $city_class->unmock( 'to_api_mapping');
 514     $city_class->mock( 'to_api_mapping', sub { return; } );
 515
 516     # Get a fresh object
 517     $city = $builder->build_object({ class => 'Koha::Cities' });
 518     is_deeply(
 519         $city->from_api_mapping,
 520         {},
 521         'Empty to_api_mapping then empty hashref'
 522     );
 523
 524     $schema->storage->txn_rollback;
 525 };
 526
 527 subtest 'set_from_api() tests' => sub {
 528
 529     plan tests => 4;
 530
 531     $schema->storage->txn_begin;
 532
 533     my $city = $builder->build_object({ class => 'Koha::Cities' });
 534     my $city_unblessed = $city->unblessed;
 535     my $attrs = {
 536         name        => 'Cordoba',
 537         country     => 'Argentina',
 538         postal_code => '5000'
 539     };
 540     $city->set_from_api($attrs);
 541
 542     is( $city->city_state, $city_unblessed->{city_state}, 'Untouched attributes are preserved' );
 543     is( $city->city_name, $attrs->{name}, 'city_name updated correctly' );
 544     is( $city->city_country, $attrs->{country}, 'city_country updated correctly' );
 545     is( $city->city_zipcode, $attrs->{postal_code}, 'city_zipcode updated correctly' );
 546
 547     $schema->storage->txn_rollback;
 548 };
 549
 550 subtest 'new_from_api() tests' => sub {
 551
 552     plan tests => 4;
 553
 554     $schema->storage->txn_begin;
 555
 556     my $attrs = {
 557         name        => 'Cordoba',
 558         country     => 'Argentina',
 559         postal_code => '5000'
 560     };
 561     my $city = Koha::City->new_from_api($attrs);
 562
 563     is( ref($city), 'Koha::City', 'Object type is correct' );
 564     is( $city->city_name,    $attrs->{name}, 'city_name updated correctly' );
 565     is( $city->city_country, $attrs->{country}, 'city_country updated correctly' );
 566     is( $city->city_zipcode, $attrs->{postal_code}, 'city_zipcode updated correctly' );
 567
 568     $schema->storage->txn_rollback;
 569 };
 570
 571 subtest 'attributes_from_api() tests' => sub {
 572
 573     plan tests => 2;
 574
 575     subtest 'date and date-time handling tests' => sub {
 576
 577         plan tests => 12;
 578
 579         my $patron = Koha::Patron->new();
 580
 581         my $attrs = $patron->attributes_from_api(
 582             {
 583                 updated_on     => '2019-12-27T14:53:00Z',
 584                 last_seen      => '2019-12-27T14:53:00Z',
 585                 date_of_birth  => '2019-12-27',
 586             }
 587         );
 588
 589         ok( exists $attrs->{updated_on},
 590             'No translation takes place if no mapping' );
 591         is(
 592             $attrs->{updated_on},
 593             '2019-12-27 14:53:00',
 594             'Given an rfc3339 formatted datetime string, a timestamp field is converted into an SQL formatted datetime string'
 595         );
 596
 597         ok( exists $attrs->{lastseen},
 598             'Translation takes place because of the defined mapping' );
 599         is(
 600             $attrs->{lastseen},
 601             '2019-12-27 14:53:00',
 602             'Given an rfc3339 formatted datetime string, a datetime field is converted into an SQL formatted datetime string'
 603         );
 604
 605         ok( exists $attrs->{dateofbirth},
 606             'Translation takes place because of the defined mapping' );
 607         is(
 608             $attrs->{dateofbirth},
 609             '2019-12-27',
 610             'Given an rfc3339 formatted date string, a date field is converted into an SQL formatted date string'
 611         );
 612
 613         $attrs = $patron->attributes_from_api(
 614             {
 615                 last_seen      => undef,
 616                 date_of_birth  => undef,
 617             }
 618         );
 619
 620         ok( exists $attrs->{lastseen},
 621             'undef parameter is not skipped (Bug 29157)' );
 622         is(
 623             $attrs->{lastseen},
 624             undef,
 625             'Given undef, a datetime field is set to undef (Bug 29157)'
 626         );
 627
 628         ok( exists $attrs->{dateofbirth},
 629             'undef parameter is not skipped (Bug 29157)' );
 630         is(
 631             $attrs->{dateofbirth},
 632             undef,
 633             'Given undef, a date field is set to undef (Bug 29157)'
 634         );
 635
 636         throws_ok
 637             {
 638                 $attrs = $patron->attributes_from_api(
 639                     {
 640                         date_of_birth => '20141205',
 641                     }
 642                 );
 643             }
 644             'Koha::Exceptions::BadParameter',
 645             'Bad date throws an exception';
 646
 647         is(
 648             $@->parameter,
 649             'date_of_birth',
 650             'Exception parameter is the API field name, not the DB one'
 651         );
 652     };
 653
 654     subtest 'booleans handling tests' => sub {
 655
 656         plan tests => 4;
 657
 658         my $patron = Koha::Patron->new;
 659
 660         my $attrs = $patron->attributes_from_api(
 661             {
 662                 incorrect_address => Mojo::JSON->true,
 663                 patron_card_lost  => Mojo::JSON->false,
 664             }
 665         );
 666
 667         ok( exists $attrs->{gonenoaddress}, 'Attribute gets translated' );
 668         is( $attrs->{gonenoaddress}, 1, 'Boolean correctly translated to integer (true => 1)' );
 669         ok( exists $attrs->{lost}, 'Attribute gets translated' );
 670         is( $attrs->{lost}, 0, 'Boolean correctly translated to integer (false => 0)' );
 671     };
 672 };
 673
 674 subtest "Test update method" => sub {
 675     plan tests => 6;
 676
 677     $schema->storage->txn_begin;
 678
 679     my $branchcode = $builder->build({ source => 'Branch' })->{branchcode};
 680     my $library = Koha::Libraries->find( $branchcode );
 681     $library->update({ branchname => 'New_Name', branchcity => 'AMS' });
 682     is( $library->branchname, 'New_Name', 'Changed name with update' );
 683     is( $library->branchcity, 'AMS', 'Changed city too' );
 684     is( $library->is_changed, 0, 'Change should be stored already' );
 685     try {
 686         $library->update({
 687             branchcity => 'NYC', not_a_column => 53, branchname => 'Name3',
 688         });
 689         fail( 'It should not be possible to update an unexisting column without an error from Koha::Object/DBIx' );
 690     } catch {
 691         ok( $_->isa('Koha::Exceptions::Object'), 'Caught error when updating wrong column' );
 692         $library->discard_changes; #requery after failing update
 693     };
 694     # Check if the columns are not updated
 695     is( $library->branchcity, 'AMS', 'First column not updated' );
 696     is( $library->branchname, 'New_Name', 'Third column not updated' );
 697
 698     $schema->storage->txn_rollback;
 699 };
 700
 701 subtest 'store() tests' => sub {
 702
 703     plan tests => 16;
 704
 705     # Using Koha::Library::Groups to test Koha::Object>-store
 706     # Simple object with foreign keys and unique key
 707
 708     $schema->storage->txn_begin;
 709
 710     # Create a library to make sure its ID doesn't exist on the DB
 711     my $library = $builder->build_object({ class => 'Koha::Libraries' });
 712     my $branchcode = $library->branchcode;
 713     $library->delete;
 714
 715     my $library_group = Koha::Library::Group->new(
 716         {
 717             branchcode      => $library->branchcode,
 718             title => 'a title',
 719         }
 720     );
 721
 722     my $dbh = $schema->storage->dbh;
 723     {
 724         local *STDERR;
 725         open STDERR, '>', '/dev/null';
 726         throws_ok
 727             { $library_group->store }
 728             'Koha::Exceptions::Object::FKConstraint',
 729             'Exception is thrown correctly';
 730         is(
 731             $@->message,
 732             "Broken FK constraint",
 733             'Exception message is correct'
 734         );
 735         is(
 736             $@->broken_fk,
 737             'branchcode',
 738             'Exception field is correct'
 739         );
 740
 741         $library_group = $builder->build_object({ class => 'Koha::Library::Groups' });
 742
 743         my $new_library_group = Koha::Library::Group->new(
 744             {
 745                 branchcode      => $library_group->branchcode,
 746                 title        => $library_group->title,
 747             }
 748         );
 749
 750         throws_ok
 751             { $new_library_group->store }
 752             'Koha::Exceptions::Object::DuplicateID',
 753             'Exception is thrown correctly';
 754
 755         is(
 756             $@->message,
 757             'Duplicate ID',
 758             'Exception message is correct'
 759         );
 760
 761         like(
 762            $@->duplicate_id,
 763            qr/(library_groups\.)?title/,
 764            'Exception field is correct (note that MySQL 8 is displaying the tablename)'
 765         );
 766         close STDERR;
 767     }
 768
 769     # Successful test
 770     $library_group->set({ title => 'Manuel' });
 771     my $ret = $library_group->store;
 772     is( ref($ret), 'Koha::Library::Group', 'store() returns the object on success' );
 773
 774     $library = $builder->build_object( { class => 'Koha::Libraries' } );
 775     my $patron_category = $builder->build_object(
 776         {
 777             class => 'Koha::Patron::Categories',
 778             value => { category_type => 'P', enrolmentfee => 0 }
 779         }
 780     );
 781
 782     my $patron = eval {
 783         Koha::Patron->new(
 784             {
 785                 categorycode    => $patron_category->categorycode,
 786                 branchcode      => $library->branchcode,
 787                 dateofbirth     => "", # date will be set to NULL
 788                 sms_provider_id => "", # Integer will be set to NULL
 789                 privacy         => "", # privacy cannot be NULL but has a default value
 790             }
 791         )->store;
 792     };
 793     is( $@, '', 'No error should be raised by ->store if empty strings are passed' );
 794     is( $patron->privacy, 1, 'Default value for privacy should be set to 1' );
 795     is( $patron->dateofbirth,     undef, 'dateofbirth must have been set to undef');
 796     is( $patron->sms_provider_id, undef, 'sms_provider_id must have been set to undef');
 797
 798     my $itemtype = eval {
 799         Koha::ItemType->new(
 800             {
 801                 itemtype        => 'IT4test',
 802                 rentalcharge    => "",
 803                 notforloan      => "",
 804                 hideinopac      => "",
 805             }
 806         )->store;
 807     };
 808     is( $@, '', 'No error should be raised by ->store if empty strings are passed' );
 809     is( $itemtype->rentalcharge, undef, 'decimal DEFAULT NULL should default to null');
 810     is( $itemtype->notforloan, undef, 'int DEFAULT NULL should default to null');
 811     is( $itemtype->hideinopac, 0, 'int NOT NULL DEFAULT 0 should default to 0');
 812
 813     subtest 'Bad value tests' => sub {
 814
 815         plan tests => 3;
 816
 817         my $patron = $builder->build_object({ class => 'Koha::Patrons' });
 818
 819
 820         try {
 821             local *STDERR;
 822             open STDERR, '>', '/dev/null';
 823             $patron->lastseen('wrong_value')->store;
 824             close STDERR;
 825         } catch {
 826             ok( $_->isa('Koha::Exceptions::Object::BadValue'), 'Exception thrown correctly' );
 827             like( $_->property, qr/(borrowers\.)?lastseen/, 'Column should be the expected one' ); # The table name is not always displayed, it depends on the DBMS version
 828             is( $_->value, 'wrong_value', 'Value should be the expected one' );
 829         };
 830     };
 831
 832     $schema->storage->txn_rollback;
 833 };
 834
 835 subtest 'unblessed_all_relateds' => sub {
 836     plan tests => 3;
 837
 838     $schema->storage->txn_begin;
 839
 840     # FIXME It's very painful to create an issue in tests!
 841     my $library = $builder->build_object( { class => 'Koha::Libraries' } );
 842     t::lib::Mocks::mock_userenv({ branchcode => $library->branchcode });
 843
 844     my $patron_category = $builder->build(
 845         {
 846             source => 'Category',
 847             value  => {
 848                 category_type                 => 'P',
 849                 enrolmentfee                  => 0,
 850                 BlockExpiredPatronOpacActions => -1, # Pick the pref value
 851             }
 852         }
 853     );
 854     my $patron_data = {
 855         firstname =>  'firstname',
 856         surname => 'surname',
 857         categorycode => $patron_category->{categorycode},
 858         branchcode => $library->branchcode,
 859     };
 860     my $patron = Koha::Patron->new($patron_data)->store;
 861     my ($biblionumber) = AddBiblio( MARC::Record->new, '' );
 862     my $biblio = Koha::Biblios->find( $biblionumber );
 863     my $item = $builder->build_object(
 864         {
 865             class => 'Koha::Items',
 866             value => {
 867                 homebranch    => $library->branchcode,
 868                 holdingbranch => $library->branchcode,
 869                 biblionumber  => $biblio->biblionumber,
 870                 itemlost      => 0,
 871                 withdrawn     => 0,
 872             }
 873         }
 874     );
 875
 876     my $issue = AddIssue( $patron->unblessed, $item->barcode, DateTime->now->subtract( days => 1 ) );
 877     my $overdues = Koha::Patrons->find( $patron->id )->overdues; # Koha::Patron->overdues prefetches
 878     my $overdue = $overdues->next->unblessed_all_relateds;
 879     is( $overdue->{issue_id}, $issue->issue_id, 'unblessed_all_relateds has field from the original table (issues)' );
 880     is( $overdue->{title}, $biblio->title, 'unblessed_all_relateds has field from other tables (biblio)' );
 881     is( $overdue->{homebranch}, $item->homebranch, 'unblessed_all_relateds has field from other tables (items)' );
 882
 883     $schema->storage->txn_rollback;
 884 };
 885
 886 subtest 'get_from_storage' => sub {
 887     plan tests => 4;
 888
 889     $schema->storage->txn_begin;
 890
 891     my $biblio = $builder->build_sample_biblio;
 892
 893     my $old_title = $biblio->title;
 894     my $new_title = 'new_title';
 895     Koha::Biblios->find( $biblio->biblionumber )->title($new_title)->store;
 896
 897     is( $biblio->title, $old_title, 'current $biblio should not be modified' );
 898     is( $biblio->get_from_storage->title,
 899         $new_title, 'get_from_storage should return an updated object' );
 900
 901     Koha::Biblios->find( $biblio->biblionumber )->delete;
 902     is( ref($biblio), 'Koha::Biblio', 'current $biblio should not be deleted' );
 903     is( $biblio->get_from_storage, undef,
 904         'get_from_storage should return undef if the object has been deleted' );
 905
 906     $schema->storage->txn_rollback;
 907 };
 908
 909 subtest 'prefetch_whitelist() tests' => sub {
 910
 911     plan tests => 3;
 912
 913     $schema->storage->txn_begin;
 914
 915     my $biblio = Koha::Biblio->new;
 916
 917     my $prefetch_whitelist = $biblio->prefetch_whitelist;
 918
 919     ok(
 920         exists $prefetch_whitelist->{orders},
 921         'Relationship matching method name is listed'
 922     );
 923     is(
 924         $prefetch_whitelist->{orders},
 925         'Koha::Acquisition::Order',
 926         'Guessed the non-standard object class correctly'
 927     );
 928
 929     is(
 930         $prefetch_whitelist->{items},
 931         'Koha::Item',
 932         'Guessed the standard object class correctly'
 933     );
 934
 935     $schema->storage->txn_rollback;
 936 };
 937
 938 subtest 'set_or_blank' => sub {
 939
 940     plan tests => 5;
 941
 942     $schema->storage->txn_begin;
 943
 944     my $item = $builder->build_sample_item;
 945     my $item_info = $item->unblessed;
 946     $item = $item->set_or_blank($item_info);
 947     is_deeply($item->unblessed, $item_info, 'set_or_blank assign the correct value if unchanged');
 948
 949     # int not null
 950     delete $item_info->{itemlost};
 951     $item = $item->set_or_blank($item_info);
 952     is($item->itemlost, 0, 'set_or_blank should have set itemlost to 0, default value defined in DB');
 953
 954     # int nullable
 955     delete $item_info->{restricted};
 956     $item = $item->set_or_blank($item_info);
 957     is($item->restricted, undef, 'set_or_blank should have set restristed to null' );
 958
 959     # datetime nullable
 960     delete $item_info->{dateaccessioned};
 961     $item = $item->set_or_blank($item_info);
 962     is($item->dateaccessioned, undef, 'set_or_blank should have set dateaccessioned to null');
 963
 964     # timestamp not null
 965     delete $item_info->{timestamp};
 966     $item = $item->set_or_blank($item_info);
 967     isnt($item->timestamp, undef, 'set_or_blank should have set timestamp to a correct value');
 968
 969     $schema->storage->txn_rollback;
 970 };
 971
 972 subtest 'messages() and add_message() tests' => sub {
 973
 974     plan tests => 7;
 975
 976     $schema->storage->txn_begin;
 977
 978     my $patron = Koha::Patron->new;
 979
 980     my @messages = @{ $patron->object_messages };
 981     is( scalar @messages, 0, 'No messages' );
 982
 983     $patron->add_message({ message => "message_1" });
 984     $patron->add_message({ message => "message_2" });
 985
 986     @messages = @{ $patron->object_messages };
 987
 988     is( scalar @messages, 2, 'Messages are returned' );
 989     is( ref($messages[0]), 'Koha::Object::Message', 'Right type returned' );
 990     is( ref($messages[1]), 'Koha::Object::Message', 'Right type returned' );
 991     is( $messages[0]->message, 'message_1', 'Right message recorded' );
 992
 993     my $patron_id = $builder->build_object({ class => 'Koha::Patrons' })->id;
 994     # get a patron from the DB, ->new is not called, ->object_messages should initialize _messages as an empty arrayref
 995     $patron = Koha::Patrons->find( $patron_id );
 996
 997     isnt( $patron->object_messages, undef, '->messages initializes the array if required' );
 998     is( scalar @{ $patron->object_messages }, 0, '->messages returns an empty arrayref' );
 999
1000     $schema->storage->txn_rollback;
1001 };
1002
1003 subtest 'Authorised values expansion' => sub {
1004     plan tests => 4;
1005
1006     $schema->storage->txn_begin;
1007
1008     Koha::AuthorisedValues->search({category => 'Countries'})->delete;
1009     Koha::AuthorisedValueCategories->search({category_name =>'Countries'})->delete;
1010
1011     my $cat = $builder->build_object({ class => 'Koha::AuthorisedValueCategories', value => {category_name =>'Countries'} });
1012     my $fr = $builder->build_object({ class => 'Koha::AuthorisedValues', value => {authorised_value => 'FR', lib=>'France', category=>$cat->category_name} });
1013     my $us = $builder->build_object({ class => 'Koha::AuthorisedValues', value => {authorised_value => 'US', lib=>'United States of America', category=>$cat->category_name} });
1014     my $ar = $builder->build_object({ class => 'Koha::AuthorisedValues', value => {authorised_value => 'AR', lib=>'Argentina', category=>$cat->category_name} });
1015
1016     my $city_class = Test::MockModule->new('Koha::City');
1017     $city_class->mock( '_fetch_authorised_values',
1018         sub {
1019             my ($self) = @_;
1020             use Koha::AuthorisedValues;
1021             my $av = Koha::AuthorisedValues->find({authorised_value => $self->city_country, category => 'Countries'});
1022             return {country => $av->unblessed};
1023         }
1024     );
1025
1026     my $marseille = $builder->build_object({ class => 'Koha::Cities', value => {city_country => 'FR', city_name => 'Marseille'} });
1027     my $cordoba = $builder->build_object({ class => 'Koha::Cities', value => {city_country => 'AR', city_name => 'Córdoba'} });
1028
1029     my $mobj = $marseille->to_api({av_expand => 1});
1030     my $cobj = $cordoba->to_api({av_expand => 1});
1031
1032     isnt($mobj->{_authorised_values}, undef, '_authorised_values exists for Marseille');
1033     isnt($cobj->{_authorised_values}, undef, '_authorised_values exists for Córdoba');
1034
1035     is($mobj->{_authorised_values}->{country}->{lib}, $fr->lib, 'Authorised value for country expanded');
1036     is($cobj->{_authorised_values}->{country}->{lib}, $ar->lib, 'Authorised value for country expanded');
1037
1038
1039     $schema->storage->txn_rollback;
1040 };