Koha-clms/t/db_dependent/Koha/SIP2/SIP2ModuleMigration.t

#!/usr/bin/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, see <https://www.gnu.org/licenses>.

use Modern::Perl;

use Test::More tests => 5;
use Test::NoWarnings;
use Test::MockModule;

use t::lib::TestBuilder;

use C4::Installer;
use C4::SIP::Sip::Configuration;
use XML::Simple;

use Koha::SIP2::Institutions;
use Koha::SIP2::Accounts;
use Koha::SIP2::SystemPreferenceOverrides;

subtest 'Config from XML matches config from database' => sub {

    plan tests => 4;

    my $schema = Koha::Database->new->schema;
    $schema->storage->txn_begin;

    Koha::SIP2::Institutions->delete;
    Koha::SIP2::Accounts->delete;
    Koha::SIP2::SystemPreferenceOverrides->delete;

    my $koha_instance    = $ENV{KOHA_CONF} =~ m!^.+/sites/([^/]+)/koha-conf\.xml$! ? $1 : undef;
    my $SIPconfigXMLFile = "/etc/koha/sites/$koha_instance/SIPconfig.xml";
    my $fileSIPconfig    = C4::SIP::Sip::Configuration->new($SIPconfigXMLFile);

    is( scalar( keys %{ $fileSIPconfig->{accounts} } ), 5, 'fileSIPconfig->{accounts} has 5 members' );
    is( Koha::SIP2::Accounts->search()->count,          0, 'Database does not yet contain any accounts' );

    my $db_rev_file = C4::Context->config('intranetdir') . '/installer/data/mysql/db_revs/250600035.pl';
    C4::Installer::run_db_rev($db_rev_file);

    is( Koha::SIP2::Accounts->search()->count, 5, 'Database now contains 5 accounts' );

    my $databaseSIPconfig = C4::SIP::Sip::Configuration->new($SIPconfigXMLFile);

    # Remove 'parms' out of each institution. This is not used and was not migrated
    foreach my $key ( keys %{ $fileSIPconfig->{institutions} } ) {
        delete $fileSIPconfig->{institutions}->{$key}{'parms'};
    }

    foreach my $key ( keys %{ $fileSIPconfig->{accounts} } ) {

        # Remove 'register_id' out of each account if it's empty. This can no longer be returned as an empty string as is now an FK constraint
        if ( defined $fileSIPconfig->{accounts}->{$key}{'register_id'}
            && $fileSIPconfig->{accounts}->{$key}{'register_id'} eq "" )
        {
            delete $fileSIPconfig->{accounts}->{$key}{'register_id'};
        }

        # Remove terminator from file check as it's no longer nullable and defaults to 'CRLF'
        if ( !$fileSIPconfig->{accounts}->{$key}{'terminator'} ) {
            $fileSIPconfig->{accounts}->{$key}{'terminator'} = 'CRLF';
        }

        # Remove delimiter from file check as it now defaults to '|'
        if ( !$fileSIPconfig->{accounts}->{$key}{'delimiter'} ) {
            $fileSIPconfig->{accounts}->{$key}{'delimiter'} = '|';
        }

        # patron_branchcode_in_ao defaults to 0 in the database schema
        # where in the SIP config it will mostly likely be 1 or non-existent
        $fileSIPconfig->{accounts}->{$key}{'patron_branchcode_in_ao'} ||= '0';

        # Remove 'password' from file config as it's no longer migrated (security improvement)
        # Passwords are now validated against the borrowers table using bcrypt hashes
        delete $fileSIPconfig->{accounts}->{$key}{'password'};
    }

    #Test accounts
    is_deeply(
        $fileSIPconfig,
        $databaseSIPconfig,
        'config from XML file matches config from database'
    );

    $schema->storage->txn_rollback;
};

subtest 'config_timestamp is updated when database configuration changes' => sub {

    plan tests => 3;

    my $koha_instance    = $ENV{KOHA_CONF} =~ m!^.+/sites/([^/]+)/koha-conf\.xml$! ? $1 : undef;
    my $SIPconfigXMLFile = "/etc/koha/sites/$koha_instance/SIPconfig.xml";
    my $fileSIPconfig    = C4::SIP::Sip::Configuration->new($SIPconfigXMLFile);

    my $schema = Koha::Database->new->schema;
    $schema->storage->txn_begin;

    Koha::SIP2::Institutions->delete;
    Koha::SIP2::Accounts->delete;
    Koha::SIP2::SystemPreferenceOverrides->delete;

    my $builder     = t::lib::TestBuilder->new();
    my $branchcode  = $builder->build( { source => 'Branch' } )->{branchcode};
    my $seen_patron = $builder->build_object(
        {
            class => 'Koha::Patrons',
            value => {
                branchcode => $branchcode,
                password   => '123456',
            },
        }
    )->store();

    Koha::SIP2::Institutions->search()->delete;
    my $sip_institution = $builder->build_object(
        {
            class => 'Koha::SIP2::Institutions',
            value => {
                name           => 'CPL',
                implementation => 'ILS',
                retries        => 5,
                status_update  => 0,
                timeout        => 25,
            },
        }
    )->store();

    my $sip_account = $builder->build_object(
        {
            class => 'Koha::SIP2::Accounts',
            value => {
                login_id           => $seen_patron->userid,
                sip_institution_id => $sip_institution->sip_institution_id,
                allow_fields       => '',
                hide_fields        => '',
            },
        }
    )->store();

    my $cfg = C4::SIP::Sip::Configuration->get_configuration( undef, $fileSIPconfig );

    is(
        $cfg->{accounts}->{ $sip_account->login_id }->{allow_fields}, '',
        '$cfg->{accounts}->{$sip_account->login_id}->{allow_fields} is empty'
    );

    my $cache              = Koha::Caches->get_instance();
    my $original_timestamp = $cache->get_from_cache("sip2_resource_last_modified");

    sleep 1;
    $sip_account->allow_fields('AB')->store();
    $cfg = C4::SIP::Sip::Configuration->get_configuration( undef, $fileSIPconfig );

    my $last_timestamp = $cache->get_from_cache("sip2_resource_last_modified");

    isnt(
        $original_timestamp, $last_timestamp,
        'config_timestamp should be updated when database configuration changes'
    );

    is(
        $cfg->{accounts}->{ $sip_account->login_id }->{allow_fields}, $sip_account->allow_fields,
        '$cfg->{accounts}->{$sip_account->login_id}->{allow_fields} should now return the new value'
    );

    $schema->storage->txn_rollback;
};

subtest 'get_configuration() reseeds sip2_resource_last_modified when missing from cache' => sub {

    plan tests => 2;

    my $schema = Koha::Database->new->schema;
    $schema->storage->txn_begin;

    my $cache = Koha::Caches->get_instance();
    $cache->clear_from_cache('sip2_resource_last_modified');

    is( $cache->get_from_cache('sip2_resource_last_modified'), undef, 'sip2_resource_last_modified cleared' );

    C4::SIP::Sip::Configuration->get_configuration( undef, { listeners => {} } );

    ok( $cache->get_from_cache('sip2_resource_last_modified'), 'sip2_resource_last_modified is repopulated' );

    $schema->storage->txn_rollback;
};

subtest 'Atomicupdate skips migrating data if provided config file doesn\'t exist or is unreadable' => sub {

    plan tests => 1;

    my $captured_message;
    my $mock = Test::MockModule->new('Koha::Installer::Output');
    $mock->mock(
        'say_warning',
        sub {
            my ( $out_object, $message ) = @_;
            $captured_message = $message;
        }
    );

    my $koha_instance    = $ENV{KOHA_CONF} =~ m!^.+/sites/([^/]+)/koha-conf\.xml$! ? $1 : undef;
    my $SIPconfigXMLFile = "/etc/koha/sites/$koha_instance/SIPconfig.xml";
    my $fileSIPconfig    = C4::SIP::Sip::Configuration->new($SIPconfigXMLFile);

    rename $SIPconfigXMLFile, "/etc/koha/sites/$koha_instance/IDontExist.xml";
    my $db_rev_file = C4::Context->config('intranetdir') . '/installer/data/mysql/db_revs/250600035.pl';
    C4::Installer::run_db_rev($db_rev_file);
    is(
        $captured_message,
        "Skipping migration. SIP config file not found or unreadable",
        'say_warning received the correct migration skip message'
    );
    rename "/etc/koha/sites/$koha_instance/IDontExist.xml", $SIPconfigXMLFile;
    }