@thepalaceproject/circulation-admin 0.0.0-post.1

package/tests/__data__/statisticsApiResponseData.ts

@@ -0,0 +1,327 @@
+import { StatisticsData } from "../../src/interfaces";
+
+export const testLibraryKey = "lyrasis-reads";
+export const testLibraryName = "LYRASIS Reads";
+export const noCollectionsLibraryKey = "unfunded-library";
+export const noInventoryLibraryKey = "unfunded-library";
+export const noPatronsLibraryKey = "unused-library";
+export const statisticsApiResponseData: StatisticsData = {
+  collections: [
+    {
+      id: 7,
+      name: "TEST Palace Marketplace",
+      inventory: {
+        titles: 7753,
+        availableTitles: 7750,
+        selfHostedTitles: 0,
+        openAccessTitles: 0,
+        licensedTitles: 7753,
+        unlimitedLicenseTitles: 0,
+        meteredLicenseTitles: 7753,
+        meteredLicensesOwned: 305725,
+        meteredLicensesAvailable: 75337,
+      },
+    },
+    {
+      id: 8,
+      name: "TEST OverDrive",
+      inventory: {
+        titles: 4441,
+        availableTitles: 4436,
+        selfHostedTitles: 0,
+        openAccessTitles: 0,
+        licensedTitles: 4441,
+        unlimitedLicenseTitles: 0,
+        meteredLicenseTitles: 4441,
+        meteredLicensesOwned: 4072997338,
+        meteredLicensesAvailable: 4072997325,
+      },
+    },
+    {
+      id: 9,
+      name: "New Bibliotheca Test Collection",
+      inventory: {
+        titles: 76,
+        availableTitles: 64,
+        selfHostedTitles: 0,
+        openAccessTitles: 0,
+        licensedTitles: 76,
+        unlimitedLicenseTitles: 0,
+        meteredLicenseTitles: 76,
+        meteredLicensesOwned: 85,
+        meteredLicensesAvailable: 72,
+      },
+    },
+    {
+      id: 14,
+      name: "New BiblioBoard Test",
+      inventory: {
+        titles: 13306,
+        availableTitles: 13306,
+        selfHostedTitles: 0,
+        openAccessTitles: 0,
+        licensedTitles: 13306,
+        unlimitedLicenseTitles: 0,
+        meteredLicenseTitles: 13306,
+        meteredLicensesOwned: 13306,
+        meteredLicensesAvailable: 13306,
+      },
+    },
+    {
+      id: 16,
+      name: "TEST Baker & Taylor",
+      inventory: {
+        titles: 146,
+        availableTitles: 134,
+        selfHostedTitles: 0,
+        openAccessTitles: 0,
+        licensedTitles: 146,
+        unlimitedLicenseTitles: 0,
+        meteredLicenseTitles: 146,
+        meteredLicensesOwned: 147,
+        meteredLicensesAvailable: 135,
+      },
+    },
+    {
+      id: 17,
+      name: "A1QA Palace Marketplace",
+      inventory: {
+        titles: 7753,
+        availableTitles: 7750,
+        selfHostedTitles: 0,
+        openAccessTitles: 0,
+        licensedTitles: 7753,
+        unlimitedLicenseTitles: 0,
+        meteredLicenseTitles: 7753,
+        meteredLicensesOwned: 305730,
+        meteredLicensesAvailable: 75341,
+      },
+    },
+    {
+      id: 18,
+      name: "CALIFA Enki Test",
+      inventory: {
+        titles: 93239,
+        availableTitles: 91565,
+        selfHostedTitles: 0,
+        openAccessTitles: 0,
+        licensedTitles: 93239,
+        unlimitedLicenseTitles: 0,
+        meteredLicenseTitles: 93239,
+        meteredLicensesOwned: 7957965,
+        meteredLicensesAvailable: 7955952,
+      },
+    },
+    {
+      id: 19,
+      name: "Palace Bookshelf",
+      inventory: {
+        titles: 7838,
+        availableTitles: 7838,
+        selfHostedTitles: 0,
+        openAccessTitles: 7838,
+        licensedTitles: 0,
+        unlimitedLicenseTitles: 0,
+        meteredLicenseTitles: 0,
+        meteredLicensesOwned: 0,
+        meteredLicensesAvailable: 0,
+      },
+    },
+    {
+      id: 20,
+      name: "Test ProQuest OPDS 2",
+      inventory: {
+        titles: 1575,
+        availableTitles: 1575,
+        selfHostedTitles: 0,
+        openAccessTitles: 0,
+        licensedTitles: 1575,
+        unlimitedLicenseTitles: 1575,
+        meteredLicenseTitles: 0,
+        meteredLicensesOwned: 0,
+        meteredLicensesAvailable: 0,
+      },
+    },
+  ],
+  libraries: [
+    {
+      key: "lyrasis-reads",
+      name: "LYRASIS Reads",
+      patronStatistics: {
+        total: 132,
+        withActiveLoan: 21,
+        withActiveLoanOrHold: 23,
+        loans: 87,
+        holds: 5,
+      },
+      inventorySummary: {
+        titles: 29119,
+        availableTitles: 29092,
+        selfHostedTitles: 145,
+        openAccessTitles: 7838,
+        licensedTitles: 21281,
+        unlimitedLicenseTitles: 623,
+        meteredLicenseTitles: 20658,
+        meteredLicensesOwned: 319263,
+        meteredLicensesAvailable: 88850,
+      },
+      collectionIds: [7, 9, 14, 16, 19],
+    },
+    {
+      key: "announcements-test",
+      name: "Announcements Testing",
+      patronStatistics: {
+        total: 2,
+        withActiveLoan: 0,
+        withActiveLoanOrHold: 0,
+        loans: 0,
+        holds: 0,
+      },
+      inventorySummary: {
+        titles: 0,
+        availableTitles: 0,
+        selfHostedTitles: 0,
+        openAccessTitles: 0,
+        licensedTitles: 0,
+        unlimitedLicenseTitles: 0,
+        meteredLicenseTitles: 0,
+        meteredLicensesOwned: 0,
+        meteredLicensesAvailable: 0,
+      },
+      collectionIds: [],
+    },
+    {
+      key: "qa1223",
+      name: "Test Library for QA",
+      patronStatistics: {
+        total: 1,
+        withActiveLoan: 0,
+        withActiveLoanOrHold: 0,
+        loans: 0,
+        holds: 0,
+      },
+      inventorySummary: {
+        titles: 7753,
+        availableTitles: 7750,
+        selfHostedTitles: 0,
+        openAccessTitles: 0,
+        licensedTitles: 7753,
+        unlimitedLicenseTitles: 0,
+        meteredLicenseTitles: 7753,
+        meteredLicensesOwned: 305725,
+        meteredLicensesAvailable: 75337,
+      },
+      collectionIds: [7],
+    },
+    {
+      key: "od-test",
+      name: "Overdrive Integration Test",
+      patronStatistics: {
+        total: 3,
+        withActiveLoan: 0,
+        withActiveLoanOrHold: 0,
+        loans: 0,
+        holds: 0,
+      },
+      inventorySummary: {
+        titles: 4441,
+        availableTitles: 4436,
+        selfHostedTitles: 0,
+        openAccessTitles: 0,
+        licensedTitles: 4441,
+        unlimitedLicenseTitles: 0,
+        meteredLicenseTitles: 4441,
+        meteredLicensesOwned: 4072997338,
+        meteredLicensesAvailable: 4072997325,
+      },
+      collectionIds: [8],
+    },
+    {
+      key: "unused-library",
+      name: "The Unused Library",
+      patronStatistics: {
+        total: 0,
+        withActiveLoan: 0,
+        withActiveLoanOrHold: 0,
+        loans: 0,
+        holds: 0,
+      },
+      inventorySummary: {
+        titles: 33560,
+        availableTitles: 33528,
+        selfHostedTitles: 0,
+        openAccessTitles: 7838,
+        licensedTitles: 25722,
+        unlimitedLicenseTitles: 0,
+        meteredLicenseTitles: 25722,
+        meteredLicensesOwned: 4073316601,
+        meteredLicensesAvailable: 4073086175,
+      },
+      collectionIds: [7, 8, 9, 14, 16, 19],
+    },
+    {
+      key: "a1qa-test",
+      name: "A1QA Test Library",
+      patronStatistics: {
+        total: 7,
+        withActiveLoan: 0,
+        withActiveLoanOrHold: 0,
+        loans: 0,
+        holds: 0,
+      },
+      inventorySummary: {
+        titles: 107230,
+        availableTitles: 105524,
+        selfHostedTitles: 0,
+        openAccessTitles: 0,
+        licensedTitles: 107230,
+        unlimitedLicenseTitles: 1575,
+        meteredLicenseTitles: 105655,
+        meteredLicensesOwned: 4081261265,
+        meteredLicensesAvailable: 4081028825,
+      },
+      collectionIds: [8, 9, 16, 17, 18, 20],
+    },
+    {
+      key: "unfunded-library",
+      name: "The Unfunded Public Library",
+      patronStatistics: {
+        total: 0,
+        withActiveLoan: 0,
+        withActiveLoanOrHold: 0,
+        loans: 0,
+        holds: 0,
+      },
+      inventorySummary: {
+        titles: 0,
+        availableTitles: 0,
+        selfHostedTitles: 0,
+        openAccessTitles: 0,
+        licensedTitles: 0,
+        unlimitedLicenseTitles: 0,
+        meteredLicenseTitles: 0,
+        meteredLicensesOwned: 0,
+        meteredLicensesAvailable: 0,
+      },
+      collectionIds: [],
+    },
+  ],
+  inventorySummary: {
+    titles: 136127,
+    availableTitles: 134418,
+    selfHostedTitles: 0,
+    openAccessTitles: 7838,
+    licensedTitles: 128289,
+    unlimitedLicenseTitles: 1575,
+    meteredLicenseTitles: 126714,
+    meteredLicensesOwned: 4081580296,
+    meteredLicensesAvailable: 4081117468,
+  },
+  patronSummary: {
+    total: 145,
+    withActiveLoan: 0,
+    withActiveLoanOrHold: 4,
+    loans: 0,
+    holds: 5,
+  },
+};

package/tests/__mocks__/fileMock.js

@@ -0,0 +1 @@
+module.exports = "test-file-stub";

package/tests/__mocks__/styleMock.js

@@ -0,0 +1 @@
+module.exports = {};

package/tests/browser/README.md

@@ -0,0 +1,19 @@
+## Nightwatch Tests
+
+### Setup
+
+To set up credentials for the tests to use, create a copy of `/tests/browser/globals.js.sample` as `/tests/browser/globals.js` and update the variables.
+
+### Running Tests
+
+Note: There are currently known bugs between Selenium and the Firefox test browser. The Nightwatch tests will currently not work when running `npm run test-firefox`. We recommend to only run tests in Chrome at the moment.
+
+Run `npm run test-chrome` and `npm run test-firefox` to run tests in Chrome and Firefox, respectively. To run the tests on headless browsers of Chrome and Firefox together, run `npm run test-browser`.
+
+### File Structure
+
+Custom Nightwatch assertions can be found in `/tests/browser/assertions`. These extend the already available `.assert` and `.verify` assertions for any specific app related tests.
+
+Custom Nightwatch commands can be found in `/tests/browser/commands`. These are reusable commands that we need the browser to execute often.
+
+Page Objects can be found in `/tests/browser/pages`. They are a common end-to-end pattern used to wrap specific element selectors in pages found in an app.

package/tests/browser/assertions/noError.js

@@ -0,0 +1,38 @@
+/**
+ * Asserts that no error exists in the DOM.
+ *
+ * ```
+ *    this.demoTest = function (client) {
+ *      browser.assert.noError();
+ *    };
+ * ```
+ *
+ * @method noError
+ * @param {string} [message] Optional log message to display in the output.
+ *  If missing, one is displayed by default.
+ * @api assertion
+ */
+
+ const util = require('util');
+
+ exports.assertion = function(msg) {
+   this.message = msg || util.format('Testing if no error is present.');
+   this.expected = 'not present';
+
+   this.pass = function(value) {
+     return value === null;
+   };
+
+   this.value = function(result) {
+     let value = null;
+     if (result.value.length !== 0) {
+       value = 'present';
+     }
+     return value;
+   };
+
+   this.command = function(callback) {
+     return this.api.elements(this.client.locateStrategy, ".error", callback);
+   };
+ };
+ 

package/tests/browser/commands/goHome.js

@@ -0,0 +1,13 @@
+var bookSelector = ".lane-books li:first-child a";
+
+/**
+ * @method goHome
+ * @api command
+ * @description This custom command navigates the user to the home page.
+ */
+exports.command = function() {
+  return this
+    .url(this.globals.homeUrl)
+    .waitForElementVisible(bookSelector, 5000)
+    .verify.noError();
+};

package/tests/browser/commands/signIn.js

@@ -0,0 +1,18 @@
+/**
+ * @method signIn
+ * @param {string} username The login form username.
+ * @param {string} password The login form password.
+ * @api command
+ * @description This custom command uses the `login` page object to
+ *  fill out the form.
+ */
+exports.command = function(username, password) {
+  const login = this.page.login();
+
+  return login
+    .navigate()
+    .waitForElementVisible("@username", 1000)
+    .setValue("@username", username)
+    .setValue("@password", password)
+    .click("@submit")
+};

package/tests/browser/globals.js.sample

@@ -0,0 +1,5 @@
+module.exports = {
+  homeUrl: "http://localhost:6500/admin/web/",
+  username: "fakeusername",
+  password: "fakepassword"
+};