invenio-app-ils 4.2.0__py2.py3-none-any.whl → 4.3.0__py2.py3-none-any.whl

tests/api/circulation/test_loan_checkout.py

@@ -15,13 +15,16 @@ import arrow
 from flask import url_for
 from flask_principal import UserNeed
 from invenio_access.permissions import Permission
+from invenio_search import current_search
 
-from invenio_app_ils.items.api import Item
-from invenio_app_ils.permissions import (
-    authenticated_user_permission,
-    loan_checkout_permission,
-    views_permissions_factory,
+from invenio_app_ils.errors import (
+    LoanSelfCheckoutDocumentOverbooked,
+    LoanSelfCheckoutItemActiveLoan,
+    LoanSelfCheckoutItemInvalidStatus,
 )
+from invenio_app_ils.items.api import Item
+from invenio_app_ils.items.serializers import item
+from invenio_app_ils.proxies import current_app_ils
 from tests.helpers import user_login, user_logout
 
 NEW_LOAN = {
@@ -30,7 +33,15 @@ NEW_LOAN = {
     "patron_pid": "3",
     "transaction_location_pid": "locid-1",
     "pickup_location_pid": "locid-1",
-    "delivery": {"method": "PICK_UP"},
+    "delivery": {"method": "PICKUP"},
+}
+
+NEW_LOAN_REQUEST = {
+    "document_pid": "CHANGE ME IN EACH TEST",
+    "patron_pid": "3",
+    "transaction_location_pid": "locid-1",
+    "pickup_location_pid": "locid-1",
+    "delivery": {"method": "PICKUP"},
 }
 
 
@@ -215,77 +226,171 @@ def test_checkout_loader_start_end_dates(app, client, json_headers, users, testd
     assert res.status_code == 400
 
 
-def _views_permissions_factory(action):
-    """Override ILS views permissions factory."""
-    if action == "circulation-loan-checkout":
-        return authenticated_user_permission()
-    return views_permissions_factory(action)
+def test_self_checkout_search(app, client, json_headers, users, testdata):
+    """Test self-checkout search."""
+    app.config["ILS_SELF_CHECKOUT_ENABLED"] = True
+
+    # test that anonymous user cannot search for barcodes
+    url = url_for("invenio_app_ils_circulation.loan_self_checkout")
+    res = client.get(f"{url}?barcode=123456", headers=json_headers)
+    assert res.status_code == 401
 
+    user_login(client, "patron2", users)
 
-def test_self_checkout(app, client, json_headers, users, testdata):
-    """Tests for self checkout feature."""
-    app.config["ILS_SELF_CHECKOUT_ENABLED"] = True
-    app.config["ILS_VIEWS_PERMISSIONS_FACTORY"] = _views_permissions_factory
-    app.config["RECORDS_REST_ENDPOINTS"]["pitmid"][
-        "list_permission_factory_imp"
-    ] = authenticated_user_permission
-    app.config["ILS_CIRCULATION_RECORDS_REST_ENDPOINTS"]["loanid"][
-        "update_permission_factory_imp"
-    ] = loan_checkout_permission
-
-    # Self checkout by librarian should pass
-    librarian = users["librarian"]
+    # test the missing parameter error
+    url = url_for("invenio_app_ils_circulation.loan_self_checkout")
+    res = client.get(url, headers=json_headers)
+    assert res.status_code == 400
+
+    # test that authenticated user can search for barcodes, but it will return
+    # 400 when not found
+    unexisting_barcode = "123456"
+    res = client.get(f"{url}?barcode={unexisting_barcode}", headers=json_headers)
+    assert res.status_code == 400
+
+    # test that an error is returned when the item cannot circulate
+    missing_item_barcode = "123456789-1"
+    url = url_for("invenio_app_ils_circulation.loan_self_checkout")
+    res = client.get(f"{url}?barcode={missing_item_barcode}", headers=json_headers)
+    assert res.status_code == 400
+    # assert that the payload will contain the key error with a msg
+    response = res.get_json()
+    assert LoanSelfCheckoutItemInvalidStatus.description in response["message"]
+    assert LoanSelfCheckoutItemInvalidStatus.supportCode in response["supportCode"]
+
+    # create a loan on the same patron, and another one on another patron
     user_login(client, "librarian", users)
-    params = deepcopy(NEW_LOAN)
-    params["item_pid"] = dict(type="pitmid", value="itemid-60")
-    params["transaction_user_pid"] = str(librarian.id)
-    params["patron_pid"] = str(librarian.id)
     url = url_for("invenio_app_ils_circulation.loan_checkout")
-    res = client.post(url, headers=json_headers, data=json.dumps(params))
 
-    assert res.status_code == 202
-    loan = res.get_json()["metadata"]
-    assert loan["state"] == "ITEM_ON_LOAN"
-    assert loan["item_pid"] == params["item_pid"]
-    assert loan["patron_pid"] == str(librarian.id)
-    user_logout(client)
+    for item_pid, patron_pid in [
+        ("itemid-60", "2"),  # barcode 123456789-60
+        ("itemid-61", "1"),  # barcode 123456789-61
+    ]:
+        params = deepcopy(NEW_LOAN)
+        params["transaction_user_pid"] = str(users["librarian"].id)
+        params["item_pid"] = dict(type="pitmid", value=item_pid)
+        params["patron_pid"] = patron_pid
+        res = client.post(url, headers=json_headers, data=json.dumps(params))
+        assert res.status_code == 202
+
+    # ensure new loans and related items are fully indexed
+    current_search.flush_and_refresh(index="*")
+
+    user_login(client, "patron2", users)
+
+    # test that an error is returned when the item is already on loan by the same user
+    on_loan_same_patron_barcode = "123456789-60"
+    url = url_for("invenio_app_ils_circulation.loan_self_checkout")
+    res = client.get(
+        f"{url}?barcode={on_loan_same_patron_barcode}", headers=json_headers
+    )
+    assert res.status_code == 400
+    # assert that the payload will contain the key error with a msg
+    response = res.get_json()
+    assert LoanSelfCheckoutItemActiveLoan.description in response["message"]
+    assert LoanSelfCheckoutItemActiveLoan.supportCode in response["supportCode"]
+
+    # test that an error is returned when the item is already on loan by another user
+    on_loan_other_patron_barcode = "123456789-61"
+    url = url_for("invenio_app_ils_circulation.loan_self_checkout")
+    res = client.get(
+        f"{url}?barcode={on_loan_other_patron_barcode}", headers=json_headers
+    )
+    assert res.status_code == 400
+    # assert that the payload will contain the key error with a msg
+    response = res.get_json()
+    assert LoanSelfCheckoutItemActiveLoan.description in response["message"]
+    assert LoanSelfCheckoutItemActiveLoan.supportCode in response["supportCode"]
 
-    # Self checkout by patron should pass if patron_pid matches
-    patron3 = users["patron3"]
-    user_login(client, "patron3", users)
-    params = deepcopy(NEW_LOAN)
-    params["item_pid"] = dict(type="pitmid", value="itemid-61")
-    params["transaction_user_pid"] = str(patron3.id)
-    params["patron_pid"] = str(patron3.id)
-    url = url_for("invenio_app_ils_circulation.loan_checkout")
-    res = client.post(url, headers=json_headers, data=json.dumps(params))
+    # test happy path
+    available_barcode = "123456789-10"
+    url = url_for("invenio_app_ils_circulation.loan_self_checkout")
+    res = client.get(f"{url}?barcode={available_barcode}", headers=json_headers)
+    assert res.status_code == 200
+    response = res.get_json()
+    assert response["metadata"]["pid"] == "itemid-10"
 
-    assert res.status_code == 202
-    loan = res.get_json()["metadata"]
-    assert loan["state"] == "ITEM_ON_LOAN"
-    assert loan["item_pid"] == params["item_pid"]
-    assert loan["patron_pid"] == str(patron3.id)
 
-    # Self checkout should fail if feature flag is not set to true
+def test_self_checkout(app, client, json_headers, users, testdata):
+    """Test self-checkout."""
+
+    def _create_request(patron, document_pid):
+        url = url_for("invenio_app_ils_circulation.loan_request")
+        user = user_login(client, patron, users)
+        params = deepcopy(NEW_LOAN_REQUEST)
+        params["document_pid"] = document_pid
+        params["patron_pid"] = str(user.id)
+        params["transaction_user_pid"] = str(user.id)
+        res = client.post(url, headers=json_headers, data=json.dumps(params))
+        assert res.status_code == 202
+        current_search.flush_and_refresh(index="*")
+
+    def _self_checkout(patron, item_pid, document_pid):
+        params = deepcopy(NEW_LOAN)
+        params["document_pid"] = document_pid
+        params["item_pid"] = dict(type="pitmid", value=item_pid)
+        params["patron_pid"] = str(patron.id)
+        params["transaction_user_pid"] = str(patron.id)
+        return client.post(url, headers=json_headers, data=json.dumps(params))
+
+    url = url_for("invenio_app_ils_circulation.loan_self_checkout")
+
     app.config["ILS_SELF_CHECKOUT_ENABLED"] = False
-    params = deepcopy(NEW_LOAN)
-    params["item_pid"] = dict(type="pitmid", value="itemid-62")
-    params["transaction_user_pid"] = str(patron3.id)
-    params["patron_pid"] = str(patron3.id)
-    url = url_for("invenio_app_ils_circulation.loan_checkout")
-    res = client.post(url, headers=json_headers, data=json.dumps(params))
 
+    # test a logged in user cannot self-checkout when the feature is disabled
+    patron2 = user_login(client, "patron2", users)
+    res = client.post(url, headers=json_headers)
     assert res.status_code == 403
+
     user_logout(client)
+    app.config["ILS_SELF_CHECKOUT_ENABLED"] = True
 
-    # Self checkout should fail if if patron_pid doesn't match
-    patron1 = users["patron1"]
-    user_login(client, "patron1", users)
-    params = deepcopy(NEW_LOAN)
-    params["item_pid"] = dict(type="pitmid", value="itemid-63")
-    params["transaction_user_pid"] = str(patron1.id)
-    params["patron_pid"] = str(patron3.id)
-    url = url_for("invenio_app_ils_circulation.loan_checkout")
-    res = client.post(url, headers=json_headers, data=json.dumps(params))
+    # test that anonymous user cannot self-checkout
+    res = client.post(url, headers=json_headers)
+    assert res.status_code == 401
 
-    assert res.status_code == 403
+    # test overbooked books
+    # create multiple requests from different patrons
+    _create_request("patron1", "docid-15")
+    _create_request("patron3", "docid-15")
+
+    document_rec = current_app_ils.document_record_cls.get_record_by_pid("docid-15")
+    document = document_rec.replace_refs()
+    assert document["circulation"]["overbooked"]
+
+    # test that user cannot self-checkout an overbooked book, without having a request
+    patron2 = user_login(client, "patron2", users)
+    res = _self_checkout(patron2, "itemid-71", "docid-15")
+    assert res.status_code == 400
+    response = res.get_json()
+    assert LoanSelfCheckoutDocumentOverbooked.description in response["message"]
+    assert LoanSelfCheckoutDocumentOverbooked.supportCode in response["supportCode"]
+
+    # test that user cannot self-checkout an overbooked book, having a request
+    # create request from the same patron
+    _create_request("patron2", "docid-15")
+    patron2 = user_login(client, "patron2", users)
+    res = _self_checkout(patron2, "itemid-71", "docid-15")
+    assert res.status_code == 400
+    response = res.get_json()
+    assert LoanSelfCheckoutDocumentOverbooked.description in response["message"]
+    assert LoanSelfCheckoutDocumentOverbooked.supportCode in response["supportCode"]
+
+    # test that user can self-checkout having a prior request
+    _create_request("patron2", "docid-16")
+
+    patron2 = user_login(client, "patron2", users)
+    res = _self_checkout(patron2, "itemid-72", "docid-16")
+    assert res.status_code == 202
+    response = res.get_json()
+    assert response["metadata"]["delivery"]["method"] == "SELF-CHECKOUT"
+
+    # test that user can self-checkout without having a prior request, even if there
+    # are other requests on the book (but not overbooked)
+    _create_request("patron1", "docid-17")
+
+    patron2 = user_login(client, "patron2", users)
+    res = _self_checkout(patron2, "itemid-73", "docid-17")
+    assert res.status_code == 202
+    response = res.get_json()
+    assert response["metadata"]["delivery"]["method"] == "SELF-CHECKOUT"

tests/data/items.json

@@ -1,7 +1,7 @@
 [
   {
     "pid": "itemid-1",
-    "created_by": {"type": "script", "value": "demo"},
+    "created_by": { "type": "script", "value": "demo" },
     "barcode": "123456789-1",
     "document_pid": "docid-1",
     "internal_location_pid": "ilocid-1",
@@ -12,7 +12,7 @@
   },
   {
     "pid": "itemid-2",
-    "created_by": {"type": "script", "value": "demo"},
+    "created_by": { "type": "script", "value": "demo" },
     "barcode": "123456789-2",
     "document_pid": "docid-1",
     "internal_location_pid": "ilocid-2",
@@ -23,7 +23,7 @@
   },
   {
     "pid": "itemid-3",
-    "created_by": {"type": "script", "value": "demo"},
+    "created_by": { "type": "script", "value": "demo" },
     "barcode": "123456789-3",
     "document_pid": "docid-2",
     "internal_location_pid": "ilocid-1",
@@ -34,7 +34,7 @@
   },
   {
     "pid": "itemid-4",
-    "created_by": {"type": "script", "value": "demo"},
+    "created_by": { "type": "script", "value": "demo" },
     "barcode": "123456789-4",
     "document_pid": "docid-3",
     "internal_location_pid": "ilocid-2",
@@ -45,7 +45,7 @@
   },
   {
     "pid": "itemid-5",
-    "created_by": {"type": "script", "value": "demo"},
+    "created_by": { "type": "script", "value": "demo" },
     "barcode": "123456789-5",
     "document_pid": "docid-3",
     "internal_location_pid": "ilocid-1",
@@ -56,7 +56,7 @@
   },
   {
     "pid": "itemid-6",
-    "created_by": {"type": "script", "value": "demo"},
+    "created_by": { "type": "script", "value": "demo" },
     "barcode": "123456789-6",
     "document_pid": "docid-3",
     "internal_location_pid": "ilocid-1",
@@ -67,7 +67,7 @@
   },
   {
     "pid": "itemid-7",
-    "created_by": {"type": "script", "value": "demo"},
+    "created_by": { "type": "script", "value": "demo" },
     "barcode": "123456789-7",
     "document_pid": "docid-5",
     "internal_location_pid": "ilocid-2",
@@ -78,7 +78,7 @@
   },
   {
     "pid": "itemid-8",
-    "created_by": {"type": "script", "value": "demo"},
+    "created_by": { "type": "script", "value": "demo" },
     "barcode": "123456789-8",
     "document_pid": "docid-5",
     "internal_location_pid": "ilocid-1",
@@ -89,7 +89,7 @@
   },
   {
     "pid": "itemid-9",
-    "created_by": {"type": "script", "value": "demo"},
+    "created_by": { "type": "script", "value": "demo" },
     "barcode": "123456789-9",
     "document_pid": "docid-5",
     "internal_location_pid": "ilocid-1",
@@ -100,7 +100,7 @@
   },
   {
     "pid": "itemid-10",
-    "created_by": {"type": "script", "value": "demo"},
+    "created_by": { "type": "script", "value": "demo" },
     "barcode": "123456789-10",
     "document_pid": "docid-5",
     "internal_location_pid": "ilocid-1",
@@ -111,7 +111,7 @@
   },
   {
     "pid": "itemid-50",
-    "created_by": {"type": "script", "value": "demo"},
+    "created_by": { "type": "script", "value": "demo" },
     "barcode": "123456789-50",
     "document_pid": "docid-5",
     "internal_location_pid": "ilocid-1",
@@ -123,7 +123,7 @@
   },
   {
     "pid": "itemid-51",
-    "created_by": {"type": "script", "value": "demo"},
+    "created_by": { "type": "script", "value": "demo" },
     "barcode": "123456789-51",
     "document_pid": "docid-5",
     "internal_location_pid": "ilocid-2",
@@ -135,7 +135,7 @@
   },
   {
     "pid": "itemid-52",
-    "created_by": {"type": "script", "value": "demo"},
+    "created_by": { "type": "script", "value": "demo" },
     "barcode": "123456789-52",
     "document_pid": "docid-5",
     "internal_location_pid": "ilocid-1",
@@ -147,7 +147,7 @@
   },
   {
     "pid": "itemid-53",
-    "created_by": {"type": "script", "value": "demo"},
+    "created_by": { "type": "script", "value": "demo" },
     "barcode": "123456789-53",
     "document_pid": "docid-5",
     "internal_location_pid": "ilocid-1",
@@ -159,7 +159,7 @@
   },
   {
     "pid": "itemid-54",
-    "created_by": {"type": "script", "value": "demo"},
+    "created_by": { "type": "script", "value": "demo" },
     "barcode": "123456789-54",
     "document_pid": "docid-5",
     "internal_location_pid": "ilocid-1",
@@ -171,7 +171,7 @@
   },
   {
     "pid": "itemid-55",
-    "created_by": {"type": "script", "value": "demo"},
+    "created_by": { "type": "script", "value": "demo" },
     "barcode": "123456789-55",
     "document_pid": "docid-1",
     "internal_location_pid": "ilocid-1",
@@ -182,7 +182,7 @@
   },
   {
     "pid": "itemid-56",
-    "created_by": {"type": "script", "value": "demo"},
+    "created_by": { "type": "script", "value": "demo" },
     "barcode": "123456789-54",
     "document_pid": "docid-5",
     "internal_location_pid": "ilocid-1",
@@ -193,7 +193,7 @@
   },
   {
     "pid": "itemid-57",
-    "created_by": {"type": "script", "value": "demo"},
+    "created_by": { "type": "script", "value": "demo" },
     "barcode": "123456789-55",
     "document_pid": "docid-1",
     "internal_location_pid": "ilocid-1",
@@ -204,7 +204,7 @@
   },
   {
     "pid": "itemid-MISSING",
-    "created_by": {"type": "script", "value": "demo"},
+    "created_by": { "type": "script", "value": "demo" },
     "barcode": "123456789-55",
     "document_pid": "docid-1",
     "internal_location_pid": "ilocid-1",
@@ -215,8 +215,8 @@
   },
   {
     "pid": "itemid-60",
-    "created_by": {"type": "script", "value": "demo"},
-    "barcode": "123456789-55",
+    "created_by": { "type": "script", "value": "demo" },
+    "barcode": "123456789-60",
     "document_pid": "docid-1",
     "internal_location_pid": "ilocid-1",
     "circulation_restriction": "NO_RESTRICTION",
@@ -226,8 +226,8 @@
   },
   {
     "pid": "itemid-61",
-    "created_by": {"type": "script", "value": "demo"},
-    "barcode": "123456789-55",
+    "created_by": { "type": "script", "value": "demo" },
+    "barcode": "123456789-61",
     "document_pid": "docid-1",
     "internal_location_pid": "ilocid-1",
     "circulation_restriction": "NO_RESTRICTION",
@@ -237,7 +237,7 @@
   },
   {
     "pid": "itemid-62",
-    "created_by": {"type": "script", "value": "demo"},
+    "created_by": { "type": "script", "value": "demo" },
     "barcode": "123456789-55",
     "document_pid": "docid-1",
     "internal_location_pid": "ilocid-1",
@@ -248,7 +248,7 @@
   },
   {
     "pid": "itemid-63",
-    "created_by": {"type": "script", "value": "demo"},
+    "created_by": { "type": "script", "value": "demo" },
     "barcode": "123456789-55",
     "document_pid": "docid-1",
     "internal_location_pid": "ilocid-1",
@@ -259,13 +259,35 @@
   },
   {
     "pid": "itemid-71",
-    "created_by": {"type": "script", "value": "demo"},
+    "created_by": { "type": "script", "value": "demo" },
     "barcode": "123456789-55",
-    "document_pid": "docid-17",
+    "document_pid": "docid-15",
     "internal_location_pid": "ilocid-4",
     "circulation_restriction": "NO_RESTRICTION",
     "medium": "NOT_SPECIFIED",
     "status": "CAN_CIRCULATE",
     "document": {}
+  },
+  {
+    "pid": "itemid-72",
+    "created_by": { "type": "script", "value": "demo" },
+    "barcode": "123456789-72",
+    "document_pid": "docid-16",
+    "internal_location_pid": "ilocid-1",
+    "circulation_restriction": "NO_RESTRICTION",
+    "medium": "NOT_SPECIFIED",
+    "status": "CAN_CIRCULATE",
+    "document": {}
+  },
+  {
+    "pid": "itemid-73",
+    "created_by": { "type": "script", "value": "demo" },
+    "barcode": "123456789-73",
+    "document_pid": "docid-17",
+    "internal_location_pid": "ilocid-1",
+    "circulation_restriction": "NO_RESTRICTION",
+    "medium": "NOT_SPECIFIED",
+    "status": "CAN_CIRCULATE",
+    "document": {}
   }
 ]