Attachment 120414 Details for Bug 28278 – Bug 28278: Add unit test for Koha::Config::read_from_file

[patch] Bug 28278: Add unit test for Koha::Config::read_from_file

Bug-28278-Add-unit-test-for-KohaConfigreadfromfile.patch (text/plain), 22.12 KB, created by Victor Grousset/tuxayo on 2021-05-03 19:48:59 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Victor Grousset/tuxayo

Created: 2021-05-03 19:48:59 UTC

Size: 22.12 KB

patch

obsolete

>From a01abfc600146d4da5972a530a07c62eb4cc35b1 Mon Sep 17 00:00:00 2001
>From: Julian Maurice <julian.maurice@biblibre.com>
>Date: Fri, 30 Apr 2021 17:11:14 +0200
>Subject: [PATCH] Bug 28278: Add unit test for Koha::Config::read_from_file
>
>Signed-off-by: Victor Grousset/tuxayo <victor@tuxayo.net>
>---
> t/Koha/Config.t | 229 +++++++++++++++++++++++++++++++-----
> t/data/koha-conf.xml | 269 +++++++++++++++++++++++++++++++++++++++++++
> 2 files changed, 471 insertions(+), 27 deletions(-)
> create mode 100644 t/data/koha-conf.xml
>
>diff --git a/t/Koha/Config.t b/t/Koha/Config.t
>index b4168b9528..ceaab6edd7 100755
>--- a/t/Koha/Config.t
>+++ b/t/Koha/Config.t
>@@ -18,42 +18,217 @@
> use Modern::Perl;
> 
> use Test::More tests => 2;
>-use Test::MockModule;
>-use Test::Warn;
>-
>-use Carp;
>-
>-my $parsing_result = 'ok';
>-
>-my $xml_simple = Test::MockModule->new('XML::Simple');
>-$xml_simple->mock(
>- XMLin => sub {
>- if ( $parsing_result eq 'error' ) {
>- croak "Something";
>- } else {
>- return "XML data";
>- }
>- }
>-);
>+use FindBin qw($Bin $Script);
> 
> use_ok('Koha::Config');
> 
>-subtest 'read_from_file() tests' => sub {
>+my $config_filepath = "$Bin/../data/koha-conf.xml";
> 
>- plan tests => 4;
>+subtest 'read_from_file() tests' => sub {
>+ plan tests => 3;
> 
> is( Koha::Config->read_from_file(undef), undef,
> "Undef parameter makes function return undef");
> 
>- $parsing_result = 'ok';
>-
>- my $result = Koha::Config->read_from_file("SomeFile.xml");
>- is( $result, 'XML data', 'File read correctly' );
>-
>- $parsing_result = 'error';
>+ my $got = eval { Koha::Config->read_from_file($config_filepath) };
>+ my $expected = {
>+ 'listen' => {
>+ 'biblioserver' => {
>+ 'content' => 'unix:/home/koha/var/run/zebradb/bibliosocket',
>+ },
>+ 'authorityserver' => {
>+ 'content' => 'unix:/home/koha/var/run/zebradb/authoritysocket',
>+ },
>+ },
>+ 'server' => {
>+ 'biblioserver' => {
>+ 'listenref' => 'biblioserver',
>+ 'directory' => '/home/koha/var/lib/zebradb/biblios',
>+ 'config' => '/home/koha/etc/zebradb/zebra-biblios-dom.cfg',
>+ 'cql2rpn' => '/home/koha/etc/zebradb/pqf.properties',
>+ 'xi:include' => [
>+ {
>+ 'href' => '/home/koha/etc/zebradb/retrieval-info-bib-dom.xml',
>+ 'xmlns:xi' => 'http://www.w3.org/2001/XInclude'
>+ },
>+ {
>+ 'xmlns:xi' => 'http://www.w3.org/2001/XInclude',
>+ 'href' => '/home/koha/etc/zebradb/explain-biblios.xml'
>+ }
>+ ],
>+ },
>+ 'authorityserver' => {
>+ 'listenref' => 'authorityserver',
>+ 'directory' => '/home/koha/var/lib/zebradb/authorities',
>+ 'config' => '/home/koha/etc/zebradb/zebra-authorities-dom.cfg',
>+ 'cql2rpn' => '/home/koha/etc/zebradb/pqf.properties',
>+ 'xi:include' => [
>+ {
>+ 'xmlns:xi' => 'http://www.w3.org/2001/XInclude',
>+ 'href' => '/home/koha/etc/zebradb/retrieval-info-auth-dom.xml'
>+ },
>+ {
>+ 'href' => '/home/koha/etc/zebradb/explain-authorities.xml',
>+ 'xmlns:xi' => 'http://www.w3.org/2001/XInclude'
>+ }
>+ ],
>+ },
>+ },
>+ 'serverinfo' => {
>+ 'biblioserver' => {
>+ 'ccl2rpn' => '/home/koha/etc/zebradb/ccl.properties',
>+ 'user' => 'kohauser',
>+ 'password' => 'zebrastripes',
>+ },
>+ 'authorityserver' => {
>+ 'ccl2rpn' => '/home/koha/etc/zebradb/ccl.properties',
>+ 'user' => 'kohauser',
>+ 'password' => 'zebrastripes',
>+ }
>+ },
>+ 'config' => {
>+ 'db_scheme' => 'mysql',
>+ 'database' => 'koha',
>+ 'hostname' => 'localhost',
>+ 'port' => '3306',
>+ 'user' => 'kohaadmin',
>+ 'pass' => 'katikoan',
>+ 'tls' => 'no',
>+ 'ca' => '',
>+ 'cert' => '',
>+ 'key' => '',
>+ 'biblioserver' => 'biblios',
>+ 'biblioservershadow' => '1',
>+ 'authorityserver' => 'authorities',
>+ 'authorityservershadow' => '1',
>+ 'pluginsdir' => '/home/koha/var/lib/plugins',
>+ 'enable_plugins' => '0',
>+ 'upload_path' => '',
>+ 'tmp_path' => '',
>+ 'intranetdir' => '/home/koha/src',
>+ 'opacdir' => '/home/koha/src/opac',
>+ 'opachtdocs' => '/home/koha/src/koha-tmpl/opac-tmpl',
>+ 'intrahtdocs' => '/home/koha/src/koha-tmpl/intranet-tmpl',
>+ 'includes' => '/home/koha/src/koha-tmpl/intranet-tmpl/prog/en/includes/',
>+ 'logdir' => '/home/koha/var/log',
>+ 'docdir' => '/home/koha/doc',
>+ 'backupdir' => '/home/koha/var/spool',
>+ 'mana_config' => 'https://mana-kb.koha-community.org',
>+ 'backup_db_via_tools' => '0',
>+ 'backup_conf_via_tools' => '0',
>+ 'install_log' => '/home/koha/misc/koha-install-log',
>+ 'useldapserver' => '0',
>+ 'useshibboleth' => '0',
>+ 'zebra_lockdir' => '/home/koha/var/lock/zebradb',
>+ 'lockdir' => '__LOCK_DIR__',
>+ 'use_zebra_facets' => '1',
>+ 'zebra_max_record_size' => '1024',
>+ 'log4perl_conf' => '/home/koha/etc/log4perl.conf',
>+ 'memcached_servers' => '127.0.0.1:11211',
>+ 'memcached_namespace' => 'KOHA',
>+ 'template_cache_dir' => '/tmp/koha',
>+ 'api_secret_passphrase' => 'CHANGEME',
>+ 'ttf' => {
>+ 'font' => [
>+ {
>+ 'type' => 'TR',
>+ 'content' => '/usr/share/fonts/truetype/dejavu/DejaVuSerif.ttf',
>+ },
>+ {
>+ 'type' => 'TB',
>+ 'content' => '/usr/share/fonts/truetype/dejavu/DejaVuSerif-Bold.ttf',
>+ },
>+ {
>+ 'type' => 'TI',
>+ 'content' => '/usr/share/fonts/truetype/dejavu/DejaVuSerif-Italic.ttf',
>+ },
>+ {
>+ 'type' => 'TBI',
>+ 'content' => '/usr/share/fonts/truetype/dejavu/DejaVuSerif-BoldItalic.ttf',
>+ },
>+ {
>+ 'type' => 'C',
>+ 'content' => '/usr/share/fonts/truetype/dejavu/DejaVuSansMono.ttf',
>+ },
>+ {
>+ 'type' => 'CB',
>+ 'content' => '/usr/share/fonts/truetype/dejavu/DejaVuSansMono-Bold.ttf',
>+ },
>+ {
>+ 'type' => 'CO',
>+ 'content' => '/usr/share/fonts/truetype/dejavu/DejaVuSansMono-Oblique.ttf',
>+ },
>+ {
>+ 'type' => 'CBO',
>+ 'content' => '/usr/share/fonts/truetype/dejavu/DejaVuSansMono-BoldOblique.ttf',
>+ },
>+ {
>+ 'type' => 'H',
>+ 'content' => '/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf',
>+ },
>+ {
>+ 'type' => 'HO',
>+ 'content' => '/usr/share/fonts/truetype/dejavu/DejaVuSans-Oblique.ttf',
>+ },
>+ {
>+ 'type' => 'HB',
>+ 'content' => '/usr/share/fonts/truetype/dejavu/DejaVuSans-Bold.ttf',
>+ },
>+ {
>+ 'type' => 'HBO',
>+ 'content' => '/usr/share/fonts/truetype/dejavu/DejaVuSans-BoldOblique.ttf',
>+ },
>+ ],
>+ },
>+ 'sms_send_config' => '/home/koha/etc/sms_send/',
>+ 'plack_max_requests' => '50',
>+ 'plack_workers' => '2',
>+ 'elasticsearch' => {
>+ 'server' => [
>+ 'localhost:9200',
>+ ],
>+ 'index_name' => 'koha_master',
>+ 'cxn_pool' => 'Static',
>+ },
>+ 'interlibrary_loans' => {
>+ 'backend_directory' => '/home/koha/src/Koha/Illbackends',
>+ 'branch' => {
>+ 'code' => 'CPL',
>+ 'prefix' => 'ILL',
>+ },
>+ 'staff_request_comments' => 'hide',
>+ 'reply_date' => 'hide',
>+ 'digital_recipient' => 'branch',
>+ 'partner_code' => 'ILLLIBS',
>+ },
>+ 'timezone' => '',
>+ 'bcrypt_settings' => '__BCRYPT_SETTINGS__',
>+ 'dev_install' => '0',
>+ 'strict_sql_modes' => '0',
>+ 'plugin_repos' => '',
>+ 'koha_xslt_security' => '',
>+ 'smtp_server' => {
>+ 'host' => 'localhost',
>+ 'port' => '25',
>+ 'timeout' => '120',
>+ 'ssl_mode' => 'disabled',
>+ 'user_name' => '',
>+ 'password' => '',
>+ 'debug' => '0',
>+ },
>+ 'message_broker' => {
>+ 'hostname' => 'localhost',
>+ 'port' => '61613',
>+ 'username' => 'guest',
>+ 'password' => 'guest',
>+ 'vhost' => '',
>+ },
>+ },
>+ };
>+ is_deeply( $got, $expected, 'File read correctly' );
> 
>- $result = eval {Koha::Config->read_from_file("SomeFile.xml")};
>+ # Reading a Perl script as XML should fail hopefully
>+ eval { Koha::Config->read_from_file("$Bin/$Script") };
> like( $@, qr{.*Error reading file.*}, 'File failing to read raises warning');
>- is( $result, undef, 'Returns undef on error confition' );
> };
> 
>diff --git a/t/data/koha-conf.xml b/t/data/koha-conf.xml
>new file mode 100644
>index 0000000000..facbea97b3
>--- /dev/null
>+++ b/t/data/koha-conf.xml
>@@ -0,0 +1,269 @@
>+<yazgfs>
>+
>+
>+
>+
>+<listen id="biblioserver" >unix:/home/koha/var/run/zebradb/bibliosocket</listen>
>+<listen id="authorityserver" >unix:/home/koha/var/run/zebradb/authoritysocket</listen>
>+
>+
>+
>+
>+
>+<server id="biblioserver" listenref="biblioserver">
>+ <directory>/home/koha/var/lib/zebradb/biblios</directory>
>+ <config>/home/koha/etc/zebradb/zebra-biblios-dom.cfg</config>
>+ <cql2rpn>/home/koha/etc/zebradb/pqf.properties</cql2rpn>
>+ <xi:include href="/home/koha/etc/zebradb/retrieval-info-bib-dom.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
>+ <xi:include href="/home/koha/etc/zebradb/explain-biblios.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
>+</server>
>+<serverinfo id="biblioserver">
>+ <ccl2rpn>/home/koha/etc/zebradb/ccl.properties</ccl2rpn>
>+ <user>kohauser</user>
>+ <password>zebrastripes</password>
>+</serverinfo>
>+
>+
>+<server id="authorityserver" listenref="authorityserver" >
>+ <directory>/home/koha/var/lib/zebradb/authorities</directory>
>+ <config>/home/koha/etc/zebradb/zebra-authorities-dom.cfg</config>
>+ <cql2rpn>/home/koha/etc/zebradb/pqf.properties</cql2rpn>
>+ <xi:include href="/home/koha/etc/zebradb/retrieval-info-auth-dom.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
>+ <xi:include href="/home/koha/etc/zebradb/explain-authorities.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
>+</server>
>+<serverinfo id="authorityserver">
>+ <ccl2rpn>/home/koha/etc/zebradb/ccl.properties</ccl2rpn>
>+ <user>kohauser</user>
>+ <password>zebrastripes</password>
>+</serverinfo>
>+
>+
>+
>+
>+
>+
>+
>+
>+<config>
>+ <db_scheme>mysql</db_scheme>
>+ <database>koha</database>
>+ <hostname>localhost</hostname>
>+ <port>3306</port>
>+ <user>kohaadmin</user>
>+ <pass>katikoan</pass>
>+ <tls>no</tls>
>+ <ca></ca>
>+ <cert></cert>
>+ <key></key>
>+ <biblioserver>biblios</biblioserver>
>+ <biblioservershadow>1</biblioservershadow>
>+ <authorityserver>authorities</authorityserver>
>+ <authorityservershadow>1</authorityservershadow>
>+ <pluginsdir>/home/koha/var/lib/plugins</pluginsdir> 
>+ <enable_plugins>0</enable_plugins>
>+ <upload_path></upload_path>
>+ <tmp_path></tmp_path>
>+ <intranetdir>/home/koha/src</intranetdir>
>+ <opacdir>/home/koha/src/opac</opacdir>
>+ <opachtdocs>/home/koha/src/koha-tmpl/opac-tmpl</opachtdocs>
>+ <intrahtdocs>/home/koha/src/koha-tmpl/intranet-tmpl</intrahtdocs>
>+ <includes>/home/koha/src/koha-tmpl/intranet-tmpl/prog/en/includes/</includes>
>+ <logdir>/home/koha/var/log</logdir>
>+ <docdir>/home/koha/doc</docdir>
>+ <backupdir>/home/koha/var/spool</backupdir>
>+ 
>+ 
>+ <mana_config>https://mana-kb.koha-community.org</mana_config>
>+ 
>+ <backup_db_via_tools>0</backup_db_via_tools>
>+ <backup_conf_via_tools>0</backup_conf_via_tools>
>+ 
>+ 
>+ <install_log>/home/koha/misc/koha-install-log</install_log>
>+ <useldapserver>0</useldapserver>
>+ <useshibboleth>0</useshibboleth>
>+ <zebra_lockdir>/home/koha/var/lock/zebradb</zebra_lockdir>
>+ <lockdir>__LOCK_DIR__</lockdir>
>+ <use_zebra_facets>1</use_zebra_facets>
>+ <zebra_max_record_size>1024</zebra_max_record_size>
>+ <log4perl_conf>/home/koha/etc/log4perl.conf</log4perl_conf>
>+ 
>+ 
>+ <memcached_servers>127.0.0.1:11211</memcached_servers>
>+ <memcached_namespace>KOHA</memcached_namespace>
>+ <template_cache_dir>/tmp/koha</template_cache_dir>
>+
>+ 
>+ <api_secret_passphrase>CHANGEME</api_secret_passphrase>
>+
>+ 
>+ 
>+
>+ 
>+ <ttf>
>+ /usr/share/fonts/truetype/dejavu/DejaVuSerif.ttf
>+ /usr/share/fonts/truetype/dejavu/DejaVuSerif-Bold.ttf
>+ /usr/share/fonts/truetype/dejavu/DejaVuSerif-Italic.ttf
>+ /usr/share/fonts/truetype/dejavu/DejaVuSerif-BoldItalic.ttf
>+ /usr/share/fonts/truetype/dejavu/DejaVuSansMono.ttf
>+ /usr/share/fonts/truetype/dejavu/DejaVuSansMono-Bold.ttf
>+ /usr/share/fonts/truetype/dejavu/DejaVuSansMono-Oblique.ttf
>+ /usr/share/fonts/truetype/dejavu/DejaVuSansMono-BoldOblique.ttf
>+ /usr/share/fonts/truetype/dejavu/DejaVuSans.ttf
>+ /usr/share/fonts/truetype/dejavu/DejaVuSans-Oblique.ttf
>+ /usr/share/fonts/truetype/dejavu/DejaVuSans-Bold.ttf
>+ /usr/share/fonts/truetype/dejavu/DejaVuSans-BoldOblique.ttf
>+ </ttf>
>+
>+ 
>+ <sms_send_config>/home/koha/etc/sms_send/</sms_send_config>
>+
>+ 
>+ <plack_max_requests>50</plack_max_requests>
>+ <plack_workers>2</plack_workers>
>+
>+ 
>+ 
>+
>+ 
>+ <elasticsearch>
>+ <server>localhost:9200</server>
>+ <index_name>koha_master</index_name>
>+
>+ 
>+ <cxn_pool>Static</cxn_pool>
>+ 
>+ 
>+ </elasticsearch>
>+ 
>+ 
>+ 
>+ 
>+ 
>+ 
>+
>+ <interlibrary_loans>
>+ 
>+ <backend_directory>/home/koha/src/Koha/Illbackends</backend_directory>
>+ 
>+ <branch>
>+ 
>+ <code>CPL</code>
>+ 
>+ <prefix>ILL</prefix>
>+ </branch>
>+ 
>+ <staff_request_comments>hide</staff_request_comments>
>+ 
>+ <reply_date>hide</reply_date>
>+ 
>+ <digital_recipient>branch</digital_recipient>
>+ 
>+ <partner_code>ILLLIBS</partner_code>
>+ </interlibrary_loans>
>+
>+ 
>+ <timezone></timezone>
>+
>+ 
>+ <bcrypt_settings>__BCRYPT_SETTINGS__</bcrypt_settings>
>+
>+ 
>+ <dev_install>0</dev_install>
>+ <strict_sql_modes>0</strict_sql_modes>
>+ <plugin_repos>
>+ 
>+ </plugin_repos>
>+
>+ <koha_xslt_security>
>+ 
>+ </koha_xslt_security>
>+
>+ <smtp_server>
>+ <host>localhost</host>
>+ <port>25</port>
>+ <timeout>120</timeout>
>+ <ssl_mode>disabled</ssl_mode>
>+ <user_name></user_name>
>+ <password></password>
>+ <debug>0</debug>
>+ </smtp_server>
>+
>+ <message_broker>
>+ <hostname>localhost</hostname>
>+ <port>61613</port>
>+ <username>guest</username>
>+ <password>guest</password>
>+ <vhost></vhost>
>+ </message_broker>
>+
>+</config>
>+</yazgfs>
>-- 
>2.31.1

Actions: View | Diff | Splinter Review

Attachments on bug 28278: 120374 | 120375 | 120414 | 120415 | 120455 | 120456 | 120666