Bug 13321: Rename variables
[koha.git] / t / db_dependent / Acquisition.t
index 0ae9ab7..bae9936 100755 (executable)
@@ -1,14 +1,26 @@
 #!/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.
 #
-# This Koha test module is a stub!
-# Add more tests here!!!
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
 
 use Modern::Perl;
-use POSIX qw(strftime);
 
-use C4::Bookseller qw( GetBookSellerFromId );
+use POSIX qw(strftime);
 
-use Test::More tests => 79;
+use Test::More tests => 92;
+use Koha::Database;
 
 BEGIN {
     use_ok('C4::Acquisition');
@@ -16,6 +28,8 @@ BEGIN {
     use_ok('C4::Biblio');
     use_ok('C4::Budgets');
     use_ok('C4::Bookseller');
+    use_ok('Koha::Acquisition::Order');
+    use_ok('Koha::Acquisition::Bookseller');
 }
 
 # Sub used for testing C4::Acquisition subs returning order(s):
@@ -25,7 +39,7 @@ BEGIN {
 # params :
 # $exp_fields             : arrayref whose elements are the keys we expect to find
 # $original_order_content : hashref whose 2 keys str and num contains hashrefs
-#                           containing content fields of the order created with NewOrder
+#                           containing content fields of the order created with Koha::Acquisition::Order
 # $order_to_check         : hashref whose keys/values are the content of an order
 #                           returned by the C4::Acquisition sub we are testing
 # returns :
@@ -103,8 +117,11 @@ sub _check_fields_of_orders {
     );
 }
 
+
+my $schema = Koha::Database->new()->schema();
+$schema->storage->txn_begin();
+
 my $dbh = C4::Context->dbh;
-$dbh->{AutoCommit} = 0;
 $dbh->{RaiseError} = 1;
 
 # Creating some orders
@@ -118,7 +135,7 @@ my $booksellerid = C4::Bookseller::AddBookseller(
     }
 );
 
-my $booksellerinfo = C4::Bookseller::GetBookSellerFromId($booksellerid);
+my $booksellerinfo = Koha::Acquisition::Bookseller->fetch({ id => $booksellerid });
 
 is( $booksellerinfo->{deliverytime},
     5, 'set deliverytime when creating vendor (Bug 10556)' );
@@ -130,10 +147,18 @@ ok(
 );
 ok( $basket = GetBasket($basketno), "GetBasket($basketno) returns $basket" );
 
+my $bpid=AddBudgetPeriod({
+        budget_period_startdate => '2008-01-01'
+        , budget_period_enddate => '2008-12-31'
+        , budget_period_active  => 1
+        , budget_period_description    => "MAPERI"
+});
+
 my $budgetid = C4::Budgets::AddBudget(
     {
         budget_code => "budget_code_test_getordersbybib",
         budget_name => "budget_name_test_getordersbybib",
+        budget_period_id => $bpid,
     }
 );
 my $budget = C4::Budgets::GetBudget($budgetid);
@@ -144,46 +169,6 @@ my ( $biblionumber2, $biblioitemnumber2 ) = AddBiblio( MARC::Record->new, '' );
 my ( $biblionumber3, $biblioitemnumber3 ) = AddBiblio( MARC::Record->new, '' );
 my ( $biblionumber4, $biblioitemnumber4 ) = AddBiblio( MARC::Record->new, '' );
 
-#
-# Test NewOrder
-#
-
-my ( $mandatoryparams, $return_error, $basketnum );
-
-# returns undef and croaks if basketno, quantity, biblionumber or budget_id is missing
-eval { ( $basketnum, $ordernumbers[0] ) = C4::Acquisition::NewOrder() };
-$return_error = $@;
-ok(
-    ( !( defined $basketnum || defined $ordernumbers[0] ) )
-      && ( defined $return_error ),
-    "NewOrder with no params returns undef and croaks"
-);
-
-$mandatoryparams = {
-    basketno     => $basketno,
-    quantity     => 24,
-    biblionumber => $biblionumber1,
-    budget_id    => $budget->{budget_id},
-};
-my @mandatoryparams_keys = keys %$mandatoryparams;
-foreach my $mandatoryparams_key (@mandatoryparams_keys) {
-    my %test_missing_mandatoryparams = %$mandatoryparams;
-    delete $test_missing_mandatoryparams{$mandatoryparams_key};
-    eval {
-        ( $basketnum, $ordernumbers[0] ) =
-          C4::Acquisition::NewOrder( \%test_missing_mandatoryparams );
-    };
-    $return_error = $@;
-    my $expected_error = "Mandatory parameter $mandatoryparams_key missing";
-    ok(
-        ( !( defined $basketnum || defined $ordernumbers[0] ) )
-          && ( index( $return_error, $expected_error ) >= 0 ),
-"NewOrder with no $mandatoryparams_key returns undef and croaks with expected error message"
-    );
-}
-
-# FIXME to do : test the other features of NewOrder
-
 # Prepare 5 orders, and make distinction beween fields to be tested with eq and with ==
 # Ex : a price of 50.1 will be stored internally as 5.100000
 
@@ -204,7 +189,7 @@ my @order_content = (
             ecost     => 38.15,
             rrp       => 40.15,
             discount  => 5.1111,
-            gstrate   => 0.0515
+            tax_rate   => 0.0515
         }
     },
     {
@@ -232,7 +217,7 @@ my @order_content = (
             ecost     => 38.1,
             rrp       => 11.0,
             discount  => 5.1,
-            gstrate   => 0.1
+            tax_rate   => 0.1
         }
     },
     {
@@ -252,7 +237,7 @@ my @order_content = (
             rrp            => 11.00,
             discount       => 0,
             uncertainprice => 0,
-            gstrate        => 0
+            tax_rate        => 0
         }
     },
     {
@@ -272,7 +257,7 @@ my @order_content = (
             rrp            => 10,
             discount       => 0,
             uncertainprice => 0,
-            gstrate        => 0
+            tax_rate        => 0
         }
     }
 );
@@ -284,7 +269,7 @@ for ( 0 .. 4 ) {
       values %{ $order_content[$_]->{num} };
     @ocontent{ keys %{ $order_content[$_]->{str} } } =
       values %{ $order_content[$_]->{str} };
-    ( undef, $ordernumbers[$_] ) = C4::Acquisition::NewOrder( \%ocontent );
+    $ordernumbers[$_] = Koha::Acquisition::Order->new( \%ocontent )->insert->{ordernumber};
     $order_content[$_]->{str}->{ordernumber} = $ordernumbers[$_];
 }
 
@@ -358,26 +343,29 @@ my @expectedfields = qw(
   quantity
   currency
   listprice
-  totalamount
   datereceived
   invoiceid
   freight
   unitprice
+  unitprice_tax_included
+  unitprice_tax_excluded
   quantityreceived
-  cancelledby
   datecancellationprinted
-  supplierreference
   purchaseordernumber
   basketno
   timestamp
   rrp
+  rrp_tax_included
+  rrp_tax_excluded
   ecost
+  ecost_tax_included
+  ecost_tax_excluded
   unitpricesupplier
   unitpricelib
-  gstrate
+  tax_rate
+  tax_value
   discount
   budget_id
-  budgetgroup_id
   budgetdate
   sort1
   sort2
@@ -389,6 +377,10 @@ my @expectedfields = qw(
   subscriptionid
   parent_ordernumber
   orderstatus
+  line_item_id
+  suppliers_reference_number
+  suppliers_reference_qualifier
+  suppliers_report
   title
   author
   basketname
@@ -409,6 +401,7 @@ my @expectedfields = qw(
   quantity_to_receive
   subtotal
   latesince
+  cancellationreason
 );
 (
     $test_missing_fields,   $test_extra_fields,
@@ -438,9 +431,9 @@ my @base_expectedfields = qw(
   notes
   ordernumber
   ecost
+  ecost_tax_included
+  ecost_tax_excluded
   uncertainprice
-  marc
-  cancelledby
   url
   isbn
   copyrightdate
@@ -469,6 +462,8 @@ my @base_expectedfields = qw(
   budget_parent_id
   publishercode
   unitprice
+  unitprice_tax_included
+  unitprice_tax_excluded
   collectionvolume
   budget_amount
   budget_owner_id
@@ -484,10 +479,14 @@ my @base_expectedfields = qw(
   biblioitemnumber
   datereceived
   orderstatus
-  supplierreference
+  line_item_id
+  suppliers_reference_number
+  suppliers_reference_qualifier
+  suppliers_report
   agerestriction
   budget_branchcode
-  gstrate
+  tax_rate
+  tax_value
   listprice
   budget_code
   budgetdate
@@ -498,7 +497,6 @@ my @base_expectedfields = qw(
   publicationyear
   collectiontitle
   invoiceid
-  budgetgroup_id
   place
   issn
   quantityreceived
@@ -511,8 +509,9 @@ my @base_expectedfields = qw(
   sort2_authcat
   budget_expend
   rrp
+  rrp_tax_included
+  rrp_tax_excluded
   cn_sort
-  totalamount
   lccn
   sort1
   volume
@@ -522,6 +521,7 @@ my @base_expectedfields = qw(
   frameworkcode
   volumedesc
   datecancellationprinted
+  cancellationreason
 );
 @expectedfields =
   ( @base_expectedfields,
@@ -554,14 +554,12 @@ ok(
 );
 
 #
-# Test GetCancelledOrders
+# Test GetOrders { cancelled => 1 }
 #
 
 @expectedfields =
   ( @base_expectedfields, ( 'transferred_to_timestamp', 'transferred_to' ) );
-is( GetCancelledOrders(), undef,
-    "GetCancelledOrders with no params returns undef" );
-@get_orders = GetCancelledOrders($basketno);
+@get_orders = GetOrders($basketno, { cancelled => 1 });
 (
     $test_missing_fields,   $test_extra_fields,
     $test_different_fields, $test_nbr_fields
@@ -570,21 +568,21 @@ is( GetCancelledOrders(), undef,
 is(
     $$test_nbr_fields[0],
     scalar @expectedfields,
-    "GetCancelledOrders gets orders with the right number of fields"
+    "GetOrders { cancelled => 1 } gets orders with the right number of fields"
 );
 is( join( " ", @$test_missing_fields ),
-    '', "GetCancelledOrders gets orders with no missing fields" );
+    '', "GetOrders { cancelled => 1 } gets orders with no missing fields" );
 is( join( " ", @$test_extra_fields ),
-    '', "GetCancelledOrders gets orders with no unexpected fields" );
+    '', "GetOrders { cancelled => 1 } gets orders with no unexpected fields" );
 is( join( " ", @$test_different_fields ),
     '',
-    "GetCancelledOrders gets orders with the right content in every fields" );
+    "GetOrders { cancelled => 1 } gets orders with the right content in every fields" );
 ok(
     (
         ( scalar @get_orders == 1 )
           and grep ( $_->{ordernumber} eq $ordernumbers[3], @get_orders )
     ),
-    "GetCancelledOrders only gets cancelled orders"
+    "GetOrders { cancelled => 1 } only gets cancelled orders"
 );
 
 #
@@ -600,15 +598,20 @@ ok(
   firstname
   biblioitemnumber
   ecost
+  ecost_tax_included
+  ecost_tax_excluded
   uncertainprice
   creationdate
   datereceived
   orderstatus
-  supplierreference
-  cancelledby
+  line_item_id
+  suppliers_reference_number
+  suppliers_reference_qualifier
+  suppliers_report
   isbn
   copyrightdate
-  gstrate
+  tax_rate
+  tax_value
   serial
   listprice
   budgetdate
@@ -620,7 +623,6 @@ ok(
   title
   closedate
   basketname
-  budgetgroup_id
   invoiceid
   author
   parent_ordernumber
@@ -635,8 +637,11 @@ ok(
   unititle
   sort2_authcat
   rrp
+  rrp_tax_included
+  rrp_tax_excluded
   unitprice
-  totalamount
+  unitprice_tax_included
+  unitprice_tax_excluded
   sort1
   ordernumber
   datecreated
@@ -650,6 +655,7 @@ ok(
   budget_id
   authorisedby
   booksellerid
+  cancellationreason
 );
 
 # note that authorisedby was added to the return of SearchOrder by the
@@ -661,15 +667,14 @@ my $invoiceid = AddInvoice(
     unknown       => "unknown"
 );
 
+my $invoice = GetInvoice( $invoiceid );
+
 my ($datereceived, $new_ordernumber) = ModReceiveOrder(
     {
         biblionumber      => $biblionumber4,
-        ordernumber       => $ordernumbers[4],
+        order             => GetOrder( $ordernumbers[4] ),
         quantityreceived  => 1,
-        cost              => 10,
-        ecost             => 10,
-        invoiceid         => $invoiceid,
-        rrp               => 10,
+        invoice           => $invoice,
         budget_id          => $order_content[4]->{str}->{budget_id},
     }
 );
@@ -827,20 +832,18 @@ is(
     "AddClaim : Check claimed_date"
 );
 
+my $order2 = GetOrder( $ordernumbers[1] );
+$order2->{order_internalnote} = "my notes";
 ( $datereceived, $new_ordernumber ) = ModReceiveOrder(
     {
         biblionumber     => $biblionumber2,
-        ordernumber      => $ordernumbers[1],
+        order            => $order2,
         quantityreceived => 2,
-        cost             => 12,
-        ecost            => 12,
-        invoiceid        => $invoiceid,
-        rrp              => 42,
-        order_internalnote => "my notes",
-        order_vendornote   => "my vendor notes",
+        invoice          => $invoice,
     }
-);
-my $order2 = GetOrder( $ordernumbers[1] );
+)
+;
+$order2 = GetOrder( $ordernumbers[1] );
 is( $order2->{'quantityreceived'},
     0, 'Splitting up order did not receive any on original order' );
 is( $order2->{'quantity'}, 40, '40 items on original order' );
@@ -848,8 +851,6 @@ is( $order2->{'budget_id'}, $budgetid,
     'Budget on original order is unchanged' );
 is( $order2->{order_internalnote}, "my notes",
     'ModReceiveOrder and GetOrder deal with internal notes' );
-is( $order2->{order_vendornote}, "my vendor notes",
-    'ModReceiveOrder and GetOrder deal with vendor notes' );
 
 $neworder = GetOrder($new_ordernumber);
 is( $neworder->{'quantity'}, 2, '2 items on new order' );
@@ -860,9 +861,9 @@ is( $neworder->{'budget_id'}, $budgetid, 'Budget on new order is unchanged' );
 is( $neworder->{ordernumber}, $new_ordernumber, 'Split: test ordernumber' );
 is( $neworder->{parent_ordernumber}, $ordernumbers[1], 'Split: test parent_ordernumber' );
 
-my ( $orders ) = GetHistory( ordernumber => $ordernumbers[1] );
+my $orders = GetHistory( ordernumber => $ordernumbers[1] );
 is( scalar( @$orders ), 1, 'GetHistory with a given ordernumber returns 1 order' );
-( $orders ) = GetHistory( ordernumber => $ordernumbers[1], search_children_too => 1 );
+$orders = GetHistory( ordernumber => $ordernumbers[1], search_children_too => 1 );
 is( scalar( @$orders ), 2, 'GetHistory with a given ordernumber and search_children_too set returns 2 orders' );
 
 my $budgetid2 = C4::Budgets::AddBudget(
@@ -872,21 +873,19 @@ my $budgetid2 = C4::Budgets::AddBudget(
     }
 );
 
+my $order3 = GetOrder( $ordernumbers[2] );
+$order3->{order_internalnote} = "my other notes";
 ( $datereceived, $new_ordernumber ) = ModReceiveOrder(
     {
         biblionumber     => $biblionumber2,
-        ordernumber      => $ordernumbers[2],
+        order            => $order3,
         quantityreceived => 2,
-        cost             => 12,
-        ecost            => 12,
-        invoiceid        => $invoiceid,
-        rrp              => 42,
+        invoice          => $invoice,
         budget_id        => $budgetid2,
-        order_internalnote => "my other notes",
     }
 );
 
-my $order3 = GetOrder( $ordernumbers[2] );
+$order3 = GetOrder( $ordernumbers[2] );
 is( $order3->{'quantityreceived'},
     0, 'Splitting up order did not receive any on original order' );
 is( $order3->{'quantity'}, 2, '2 items on original order' );
@@ -901,17 +900,15 @@ is( $neworder->{'quantityreceived'},
     2, 'Splitting up order received items on new order' );
 is( $neworder->{'budget_id'}, $budgetid2, 'Budget on new order is changed' );
 
+$order3 = GetOrder( $ordernumbers[2] );
+$order3->{order_internalnote} = "my third notes";
 ( $datereceived, $new_ordernumber ) = ModReceiveOrder(
     {
         biblionumber     => $biblionumber2,
-        ordernumber      => $ordernumbers[2],
+        order            => $order3,
         quantityreceived => 2,
-        cost             => 12,
-        ecost            => 12,
-        invoiceid        => $invoiceid,
-        rrp              => 42,
+        invoice          => $invoice,
         budget_id        => $budgetid2,
-        order_internalnote => "my third notes",
     }
 );
 
@@ -926,4 +923,47 @@ is( $nonexistent_order, undef, 'GetOrder returns undef if no ordernumber is give
 $nonexistent_order = GetOrder( 424242424242 );
 is( $nonexistent_order, undef, 'GetOrder returns undef if a nonexistent ordernumber is given' );
 
-$dbh->rollback;
+# Tests for DelOrder
+my $order1 = GetOrder($ordernumbers[0]);
+my $error = DelOrder($order1->{biblionumber}, $order1->{ordernumber});
+ok((not defined $error), "DelOrder does not fail");
+$order1 = GetOrder($order1->{ordernumber});
+ok((defined $order1->{datecancellationprinted}), "order is cancelled");
+ok((not defined $order1->{cancellationreason}), "order has no cancellation reason");
+ok((defined GetBiblio($order1->{biblionumber})), "biblio still exists");
+
+$order2 = GetOrder($ordernumbers[1]);
+$error = DelOrder($order2->{biblionumber}, $order2->{ordernumber}, 1);
+ok((not defined $error), "DelOrder does not fail");
+$order2 = GetOrder($order2->{ordernumber});
+ok((defined $order2->{datecancellationprinted}), "order is cancelled");
+ok((not defined $order2->{cancellationreason}), "order has no cancellation reason");
+ok((not defined GetBiblio($order2->{biblionumber})), "biblio does not exist anymore");
+
+my $order4 = GetOrder($ordernumbers[3]);
+$error = DelOrder($order4->{biblionumber}, $order4->{ordernumber}, 1, "foobar");
+ok((not defined $error), "DelOrder does not fail");
+$order4 = GetOrder($order4->{ordernumber});
+ok((defined $order4->{datecancellationprinted}), "order is cancelled");
+ok(($order4->{cancellationreason} eq "foobar"), "order has cancellation reason \"foobar\"");
+ok((not defined GetBiblio($order4->{biblionumber})), "biblio does not exist anymore");
+# End of tests for DelOrder
+
+subtest 'ModOrder' => sub {
+    plan tests => 1;
+    ModOrder( { ordernumber => $order1->{ordernumber}, unitprice => 42 } );
+    my $order = GetOrder( $order1->{ordernumber} );
+    is( int($order->{unitprice}), 42, 'ModOrder should work even if biblionumber if not passed');
+};
+
+# Budget reports
+my $all_count = scalar GetBudgetsReport();
+ok($all_count >= 1, "GetBudgetReport OK");
+
+my $active_count = scalar GetBudgetsReport(1);
+ok($active_count >= 1 , "GetBudgetsReport(1) OK");
+
+is($all_count, scalar GetBudgetsReport(), "GetBudgetReport returns inactive budget period acquisitions.");
+ok($active_count >= scalar GetBudgetsReport(1), "GetBudgetReport doesn't return inactive budget period acquisitions.");
+
+$schema->storage->txn_rollback();