Attachment 63429 Details for Bug 17499 – Bug 17499: Add basic validation for messaging preference

[patch] Bug 17499: Add basic validation for messaging preference

Bug-17499-Add-basic-validation-for-messaging-prefe.patch (text/plain), 5.48 KB, created by Lari Taskula on 2017-05-12 13:26:11 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Lari Taskula

Created: 2017-05-12 13:26:11 UTC

Size: 5.48 KB

patch

obsolete

>From 5816b312a7e16b55c53086e4ad4801eefc83bb42 Mon Sep 17 00:00:00 2001
>From: Lari Taskula <lari.taskula@jns.fi>
>Date: Wed, 26 Oct 2016 14:54:40 +0300
>Subject: [PATCH] Bug 17499: Add basic validation for messaging preference
>
>This patch adds simple validation for messaging preferences.
>
>The validation includes
>- check that only either borrowernumber or categorycode is given, but not both
>- throw exception if patron for the given borrowernumber is not found
>- throw exception if category for the given categorycode is not found
>
>To test:
>1. Run t/db_dependent/Koha/Patron/Message/Preferences.t
>---
> Koha/Patron/Message/Preference.pm                | 62 ++++++++++++++++++++++++
> t/db_dependent/Koha/Patron/Message/Preferences.t | 33 ++++++++++++-
> 2 files changed, 94 insertions(+), 1 deletion(-)
>
>diff --git a/Koha/Patron/Message/Preference.pm b/Koha/Patron/Message/Preference.pm
>index daeae5c..670e296 100644
>--- a/Koha/Patron/Message/Preference.pm
>+++ b/Koha/Patron/Message/Preference.pm
>@@ -20,6 +20,9 @@ package Koha::Patron::Message::Preference;
> use Modern::Perl;
> 
> use Koha::Database;
>+use Koha::Exceptions;
>+use Koha::Patron::Categories;
>+use Koha::Patrons;
> 
> use base qw(Koha::Object);
> 
>@@ -33,6 +36,65 @@ Koha::Patron::Message::Preference - Koha Patron Message Preference object class
> 
> =cut
> 
>+=head3 store
>+
>+Makes a validation before actual Koha::Object->store so that proper exceptions
>+can be thrown. See C<validate()> for documentation about exceptions.
>+
>+=cut
>+
>+sub store {
>+    my $self = shift;
>+
>+    return $self->validate->SUPER::store(@_);
>+}
>+
>+=head3 validate
>+
>+Makes a basic validation for object.
>+
>+Throws following exceptions regarding parameters.
>+- Koha::Exceptions::MissingParameter
>+- Koha::Exceptions::TooManyParameters
>+- Koha::Exceptions::BadParameter
>+
>+See $_->parameter to identify the parameter causing the exception.
>+
>+Returns Koha::Patron::Message::Preference object.
>+
>+=cut
>+
>+sub validate {
>+    my ($self) = @_;
>+
>+    if ($self->borrowernumber && $self->categorycode) {
>+        Koha::Exceptions::TooManyParameters->throw(
>+            error => "Both borrowernumber and category given, only one accepted",
>+            parameter => ['borrowernumber', 'categorycode'],
>+        );
>+    }
>+    if (!$self->borrowernumber && !$self->categorycode) {
>+        Koha::Exceptions::MissingParameter->throw(
>+            error => "borrowernumber or category required, none given",
>+            parameter => ['borrowernumber', 'categorycode'],
>+        );
>+    }
>+    if ($self->borrowernumber) {
>+        Koha::Exceptions::BadParameter->throw(
>+            error => "Patron not found.",
>+            parameter => 'borrowernumber',
>+        ) unless Koha::Patrons->find($self->borrowernumber);
>+    }
>+    if ($self->categorycode) {
>+        Koha::Exceptions::BadParameter->throw(
>+            error => "Category not found.",
>+            parameter => 'categorycode',
>+        ) unless Koha::Patron::Categories->find($self->categorycode);
>+    }
>+
>+    return $self;
>+}
>+
> =head3 type
> 
> =cut
>diff --git a/t/db_dependent/Koha/Patron/Message/Preferences.t b/t/db_dependent/Koha/Patron/Message/Preferences.t
>index 3d87943..0527d78 100644
>--- a/t/db_dependent/Koha/Patron/Message/Preferences.t
>+++ b/t/db_dependent/Koha/Patron/Message/Preferences.t
>@@ -94,7 +94,7 @@ subtest 'Add a test messaging transport' => sub {
> };
> 
> subtest 'Add a messaging preference to patron' => sub {
>-    plan tests => 2;
>+    plan tests => 3;
> 
>     ok($preference = Koha::Patron::Message::Preference->new({
>         borrowernumber => $patron->{'borrowernumber'},
>@@ -105,6 +105,37 @@ subtest 'Add a messaging preference to patron' => sub {
>     is(Koha::Patron::Message::Preferences->find({
>         borrowernumber => $patron->{'borrowernumber'} })->message_attribute_id,
>        $preference->message_attribute_id, "Found test messaging preference from database.");
>+    subtest 'Attempt to add a messaging preference with invalid parameters' => sub {
>+        plan tests => 6;
>+
>+        eval { Koha::Patron::Message::Preference->new->store };
>+        is (ref $@, "Koha::Exceptions::MissingParameter",
>+            "Adding a message preference without parameters"
>+            ." => Koha::Exceptions::MissingParameter");
>+        eval { Koha::Patron::Message::Preference->new({
>+                borrowernumber => $patron->{'borrowernumber'},
>+                categorycode   => $patron->{'categorycode'},
>+            })->store };
>+        is (ref $@, "Koha::Exceptions::TooManyParameters",
>+            "Adding a message preference with both borrowernumber and categorycode"
>+            ." => Koha::Exceptions::TooManyParameters");
>+        eval { Koha::Patron::Message::Preference->new({
>+                borrowernumber => -999,
>+            })->store };
>+        is (ref $@, "Koha::Exceptions::BadParameter",
>+            "Adding a message preference with invalid borrowernumber"
>+            ." => Koha::Exceptions::BadParameter");
>+        is ($@->parameter, "borrowernumber", "The previous exception tells us it"
>+            ." was the borrowernumber.");
>+        eval { Koha::Patron::Message::Preference->new({
>+                categorycode => "nonexistent",
>+            })->store };
>+        is (ref $@, "Koha::Exceptions::BadParameter",
>+            "Adding a message preference with invalid categorycode"
>+            ." => Koha::Exceptions::BadParameter");
>+        is ($@->parameter, "categorycode", "The previous exception tells us it"
>+            ." was the categorycode.");
>+    };
> };
> 
> subtest 'Add a messaging transport preference to patron' => sub {
>-- 
>2.7.4

Actions: View | Diff | Splinter Review

Attachments on bug 17499: 63427 | 63428 | 63429 | 63430 | 63431 | 63432 | 63433 | 63434 | 63786 | 63787 | 63788 | 63789 | 63790 | 63791 | 63792 | 63793 | 63801 | 63802 | 63803 | 63804 | 63805 | 63806 | 63807 | 63808 | 63809 | 63810 | 63811 | 63812 | 63878 | 63895 | 64035 | 64036 | 64037 | 64038 | 64039 | 64040 | 64041 | 64042 | 64043 | 64044 | 64795 | 66686 | 69434 | 69435 | 69458 | 91864 | 93863 | 93865 | 93872 | 94748 | 99479 | 99634 | 99668 | 99669 | 99670 | 103441 | 103442 | 103443 | 106653 | 106654 | 106655 | 106656 | 106657 | 107612 | 107613 | 107614 | 107615 | 107616 | 113010 | 113011 | 113127 | 113129 | 113686 | 113687 | 113765 | 113766 | 113767 | 113768 | 118452 | 118453 | 119470 | 119471 | 119472 | 119473 | 119474 | 119475 | 119476 | 119477 | 119478 | 119479 | 119480 | 119481 | 119482 | 119483 | 119484 | 119485 | 119486 | 119487 | 119488 | 119489 | 119490 | 119491 | 141408 | 141409 | 141410 | 141411 | 141412 | 141413 | 141414 | 141415 | 141416 | 141417 | 141418 | 146529 | 146530 | 146531 | 146532 | 146533 | 146534 | 146535 | 146536 | 146537 | 146538 | 146539 | 146540 | 151900 | 151901 | 151902 | 151903 | 151904 | 151905 | 151906 | 151907 | 151908 | 151909 | 151910 | 151911 | 151937 | 151938 | 151939 | 151940 | 151941 | 151942 | 151943 | 151944 | 151945 | 151946 | 151947 | 151948 | 155365 | 155366 | 155367 | 155368 | 155369 | 155370 | 155371 | 155372 | 155373 | 155374 | 155375 | 155376