Metadata search for the DLTS Open Square website.
- Node (at least Node 10.x recommended)
- Java (at least Java 8 recommended) - for Selenium tests
- rsync - for deployment scripts
- yarn is recommended, but not required. All instructions
below assume
yarn.
# Install dependencies including devDependencies
# If NODE_ENV is not set to production, can leave out --production=false
yarn install --production=false
# Serve development version with hot reload at localhost:8080
# Uses environment variables from .env.development
yarn serve
# Uses environment variables from .env.dev
yarn build:dev
# Uses environment variables from .env.stage
yarn build:stage
# Uses environment variables from .env.prod
yarn build:prod
# Run all unit and browser tests
yarn test
# Run Selenium tests headlessly against localhost ENM
yarn test:browser:local
# Debugging Selenium tests in Chrome only - not in headless mode
# Timeout is set to very hight value to allow for pausing at breakpoints
yarn test:browser:local:debug:chrome
# Debugging Selenium tests in Firefox only - not in headless mode
# Timeout is set to very hight value to allow for pausing at breakpoints
yarn test:browser:local:debug:firefox
# Run tests headlessly against live dev server ENM
yarn test:browser:dev
# Run tests headlessly against live staging server ENM
yarn test:browser:stage
# Run tests headlessly against live production server ENM
yarn test:browser:prod
yarn test:unit
yarn lint
yarn lint --no-fix
See Configuration Reference and Environment Variables and Modes.
The solr query string parameter is used by the browser tests to make the application under test
send all Solr requests to a Solr fake running on localhost:3000.
The Solr Fake is currently a very basic in-house implementation included as an
NPM module:
NYULibraries/dlts-solr-fake.
The Solr fake is configured and started automatically in tests/browser/conf/wdio.main.conf.js:
// DLTS Solr Fake
solrFake : {
url : 'http://localhost:3000/',
},
//
// =====
// Hooks
// =====
// WebdriverIO provides several hooks you can use to interfere with the test process in order to enhance
// it and to build services around it. You can either apply a single function or an array of
// methods to it. If one of them returns with a promise, WebdriverIO will wait until that promise got
// resolved to continue.
/**
* Gets executed once before all workers get launched.
* @param {Object} config wdio configuration object
* @param {Array.<Object>} capabilities list of capabilities details
*/
onPrepare : function ( config, capabilities ) {
if ( this.solrFake ) {
const options = {
solrResponsesDirectory : SOLR_FAKE_RESPONSES_DIRECTORY,
};
// UPDATE_SOLR_RESPONSES_SOLR_SERVER_URL environment variable if used
// should be of the form:
// http://[HOST]:[PORT]/solr/open-square-metadata/select
if ( process.env.UPDATE_SOLR_RESPONSES_SOLR_SERVER_URL ) {
options.updateSolrResponsesSolrServerUrl = process.env.UPDATE_SOLR_RESPONSES_SOLR_SERVER_URL;
}
solrFake.startSolrFake( options );
}
},The Solr responses served by the Solr fake are in tests/browser/fixtures/solr-fake/.
The index.json file maps Solr request query strings to response files.
To update the files in tests/browser/fixtures/solr-fake/:
-
Make any desired changes to the Solr requests in the tests, if any. This may involve editing the golden files.
-
Make any desired changes to the production Solr index, if any. The production Solr index will be used to generate the new Solr fixture data.
-
Run
yarn test:browser:update:fixtures.
The index.json and Solr response files in tests/browser/fixtures/solr-fake/ will be updated
by the Solr fake.
Note that even though the tests in search-form.js use the Solr fake, they are
not included in the test:browser:update:fixtures script because the spinner test
is designed to perform a search for which the Solr fake will never have a stored
response. This is to ensure the spinner stays visible long enough for the test
to register its appearance. The other test in the search-form suite uses a
blank search which should never return results, so the fixture file should never
need to be updated.
The initial golden files were created by a script which generated golden file data
from the Solr fake fixture files in tests/browser/fixtures/solr-fake/. The fixture files
were generated from the live Solr indexes which themselves were programmatically
verified against the metadata files in
NYULibraries/dlts-epub-metadata.
In the future, if the fixture data for the Solr fake changes, the golden files
can be updated by running yarn test:browser:update:golden.
Note that there may be some tests that do not verify against golden files but have expected values directly hardcoded into the scripts. These will need to be updated manually if they are broken by the data changes to the Solr fake.
The Solr server used for Open Square Search can be overridden using the solr query parameter.
Example:
http://opensquare.nyupress.org/search/?solr=http://stagediscovery.dlib.nyu.edu:8983/solr/enm-pages/
...informs the application that all Solr requests should be routed to the stage Solr server instead of the production Solr server.
?solrErrorSimulation=search- Simulates Solr request error for initial topic/full-text search
# Build dev server version, copy to server, and run tests
yarn deploy:dev
# Build stage server version, copy to server, and run tests
yarn deploy:stage
# Build prod server version, copy to server, and run tests
yarn deploy:prod
A deploy task does the following:
- Builds the specified version of the search application
- Copies it to the appropriate server
- Runs tests against the newly deployed application
Note that the scripts assume "devweb1", "stageweb1", and "web1" in ~/.ssh/config. This is necessary to get the username, which can't be hardcoded in the repo. It also allows for convenient handling of the tunneling through bastion, if using a configuration like this:
Host bastion
Hostname b.dlib.nyu.edu
User [USERNAME]
Host devdb1
Hostname devdb1.dlib.nyu.edu
ProxyCommand ssh bastion -W %h:%p
User [USERNAME]
