Rewrite library module tests to use mocked inputs

.github/workflows/autotest.yml

@@ -31,5 +31,4 @@ jobs:
       - name: Run all tests with pytest
         run: pytest --cov=pittapi tests/
             --ignore=tests/lab_test.py
-            --ignore=tests/library_test.py
             --ignore=tests/people_test.py

.github/workflows/tests-on-push.yml

@@ -35,5 +35,4 @@ jobs:
     - name: Test with pytest
       run: pytest --cov=pittapi tests/
           --ignore=tests/lab_test.py
-          --ignore=tests/library_test.py
           --ignore=tests/people_test.py

pittapi/library.py

@@ -21,11 +21,16 @@
 from html.parser import HTMLParser
 from typing import Any, Dict, List
 
-LIBRARY_URL = """https://pitt.primo.exlibrisgroup.com/primaws/rest/pub/pnxs?acTriggered=false&blendFac
-etsSeparately=false&citationTrailFilterByAvailability=true&disableCache=false&getMore=0&inst=01PITT_INST&isCD
-Search=false&lang=en&limit=10&newspapersActive=false&newspapersSearch=false&offset=0&otbRanking=false&pcAvai
-lability=false&qExclude=&qInclude=&rapido=false&refEntryActive=false&rtaLinks=true&scope=MyInst_and_CI&searc
-hInFulltextUserSelection=false&skipDelivery=Y&sort=rank&tab=Everything&vid=01PITT_INST:01PITT_INST"""
+LIBRARY_URL = (
+    "https://pitt.primo.exlibrisgroup.com/primaws/rest/pub/pnxs"
+    "?acTriggered=false&blendFacetsSeparately=false"
+    "&citationTrailFilterByAvailability=true&disableCache=false&getMore=0"
+    "&inst=01PITT_INST&isCDSearch=false&lang=en&limit=10&newspapersActive=false"
+    "&newspapersSearch=false&offset=0&otbRanking=false&pcAvailability=false"
+    "&qExclude=&qInclude=&rapido=false&refEntryActive=false&rtaLinks=true"
+    "&scope=MyInst_and_CI&searchInFulltextUserSelection=false&skipDelivery=Y"
+    "&sort=rank&tab=Everything&vid=01PITT_INST:01PITT_INST"
+)
 
 QUERY_START = "&q=any,contains,"
 

tests/dining_test.py

@@ -40,7 +40,7 @@ def __init__(self, *args, **kwargs):
 
         with (SAMPLE_PATH / 'dining_menu.json').open() as f:
             self.dining_menu_data = json.load(f)
-        
+
 
     @responses.activate
     def test_get_locations(self):
@@ -70,4 +70,3 @@ def test_get_location_menu(self):
                       json=self.dining_menu_data, status=200)
         locations = dining.get_location_menu("The Eatery", datetime.datetime(2024, 4, 12), "Breakfast")
         self.assertIsInstance(locations, dict)
-

tests/library_test.py

@@ -17,24 +17,32 @@
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 """
 
+import json
 import unittest
-import pytest
+from pathlib import Path
 
-from pittapi import library
+import responses
 
-class LibraryTest(unittest.TestCase):
-    def test_get_documents(self):
-        self.assertIsInstance(library.get_documents("water"), dict)
+from pittapi import library
 
+SAMPLE_PATH = Path() / 'tests' / 'samples'
 
-    @pytest.mark.skip(reason="bookmarks seem to not be supported in new API anymore")
-    def test_get_document_by_bookmark(self):
-        bookmark_test = library.get_document_by_bookmark("ePnHCXMw42LgT" +
-            "QStzc4rAe_hSmEGbaYyt7QAHThpwMYgouGcGJDo6hSkCezyGQI7SJYmZgacDKzhQ" +
-            "LXAWkDazTXE2UMXdOZRPHT8Ih50Ha6hBehic_yyKlhkYVM48RbmFiamxibGAFlyLRc")
-        self.assertIsInstance(bookmark_test, dict)
 
+class LibraryTest(unittest.TestCase):
+    def __init__(self, *args, **kwargs):
+        unittest.TestCase.__init__(self, *args, **kwargs)
+        with (SAMPLE_PATH / 'library_mock_response_water.json').open() as f:
+            self.library_query = json.load(f)
 
-    @pytest.mark.skip(reason="bookmarks seem to not be supported in new API anymore")
-    def test_invalid_bookmark(self):
-        self.assertRaises(ValueError, library.get_document_by_bookmark("abcd"))
+    @responses.activate
+    def test_get_documents(self):
+        responses.add(
+            responses.GET,
+            library.LIBRARY_URL + library.QUERY_START + "water",
+            json=self.library_query,
+            status=200
+        )
+        query_result = library.get_documents("water")
+        self.assertIsInstance(query_result, dict)
+        self.assertEqual(query_result["pages"], 10)
+        self.assertEqual(len(query_result["docs"]), 10)

tests/people_test.py

@@ -125,7 +125,7 @@ def test_people_get_person(self):
     def test_people_get_person_too_many(self):
         responses.add(responses.POST, people.PEOPLE_SEARCH_URL,
                       body=TOO_MANY_TEST_DATA, status=200)
-        
+
         ans = people.get_person("Smith")
         self.assertIsInstance(ans,list)
         self.assertEqual(ans, [{"ERROR":"Too many people matched your criteria."}])
@@ -134,7 +134,7 @@ def test_people_get_person_too_many(self):
     def test_people_get_person_none(self):
         responses.add(responses.POST, people.PEOPLE_SEARCH_URL,
                       body=NONE_FOUND_TEST_DATA, status=200)
-        
+
         ans = people.get_person("Lebron Iverson Jordan Kobe")
         self.assertIsInstance(ans,list)
         self.assertEqual(ans, [{"ERROR":"No one found."}])