Hyku SWORD QA

Test a Hyku Willow SWORD endpoint.

This tool will use a CSV file to define a series of HTTP tests to run against an endpoint. It leans heavily on XML for input and ouput (e.g. reading XML files for configuration, reading XML inputs, expecting XML responses).

The general idea is:

• Store xpath selector results as variables from local XML files
• Submit some XML to URL endpoints, get some XML back
• Examine the XML response via xpath selectors, comparing the results against stored variables
  • Maybe store some more variables to use in future requests

Sample tests are provided to run against a Hyku Willow SWORD v2 endpoint.

Quick Start

• Copy config.example to config.xml
  • edit the values to your Hyku instance
• If you want to change tests run, edit the "Tests.csv"
• Run runtests.py < "Tests.csv"
• Review output provided on the terminal

BYO files example

This example shows how some files in the provided tests were built from one another.

SimpleZip

Create a SWORD v2 SimpleZip file with a metadata.xml and .pdf file in the root, and a "supplement" directory with additional data files.

mkdir temp/simplezip; mkdir temp/simplezip/supplement; cp files/generic.minimal.xml temp/simplezip/metadata.xml; cp files/*.pdf temp/simplezip; cp files/*.csv files/*.xlsx files/*.png files/*.docx temp/simplezip/supplement
sed 's|<title>\(.*\)</title>|<title>SimpleZip (\1)</title>|' -i temp/simplezip/metadata.xml
pushd temp/simplezip/; zip -r SimpleZip.zip .; popd
mv temp/simplezip/SimpleZip.zip files/

BagIt

Package the above SimpleZip file as BagIt, then make a copy where the checksums fail by modifying the metadata file.

pip install bagit
sed 's|<title>SimpleZip|<title>BagIt|' -i temp/simplezip/metadata.xml
bagit.py --contact-name 'Hyku Demo User' temp/simplezip/
pushd temp/simplezip; zip -r BagIt.zip .; popd
mv temp/simplezip/BagIt.zip files/
sed 's/<metadata>/<metadata> /' -i temp/simplezip/data/metadata.xml
pushd temp/simplezip; zip -r BadBagIt.zip .; popd
mv temp/simplezip/BadBagIt.zip files/

Embargos

Create a version of the ETD metadata with and with embargo information.

mkdir temp/etd; cp files/etd.full.xml temp/etd/metadata.xml; cp files/*.pdf temp/etd/; cp files/*.png files/*.txt temp/etd/
zip -j files/EtdEmbargo.zip temp/etd/*
sed 's|<visibility>embargo</visibility>|<visibility>open</visibility>|' files/etd.full.xml | sed 's|<embargo_release_date>.*||' | sed 's|<visibility_during_embargo>.*||' | sed 's|<visibility_after_embargo>.*||' > files/etd.noembargo.xml

CSV Tests

Tests are defined in CSV format, using the following colunms:

• Title: a human readable name for the test
• Method: A (generally HTTP) method to use for the test e.g. GET, POST, PUT
  • FILE is a magic method which reads a local XML file; pair FILE with the Store column to set variables
  • XSLT is a magic method which applies an XSLT transform to a local XML file
• URI: The HTTP endpoint, or local filename which will be accessed
  • Variables as $VAR will be interpolated
  • For XSLT, this is the transformation xslt file that will be applied.
• Headers: Multiline HTTP headers to supply, e.g. Content-Type: application/xml
  • Variables as $VAR will be interpolated
• Form: Multiline form fields to be be submitted in the form of key=filename
  • Variables will be interpolated
• Payload: A filename which will be submitted as binary content to the request
  • For XSLT, this is the xml file, to which the xslt will be applied to.
• Expected: An expected HTTP status code
• Store: Multiline sequences that are either variable assignments as variable and xpath pairs, in the form of VAR=/ns:element/ns:subelement/@attr, or local filepaths in the form /path/to/file=*
  • Variables named here are global and will persist for subsequent calls, until overwritten
  • The xpath is executed against the URI column; that is, the content of a FILE, or the response of a GET, POST, PUT, etc.
  • The relevant content is stored within each of the filepaths provided; that is content of file, response of GET, POST, PUT, result of XSLT transformation etc.
• Test: Multiline assertions in the form of Expected=/xpath/expression[@attr="value"]
  • Variables will be interpolated
  • Use a left hand wildcard to indicate any value, e.g. *=//element/subelement
  • lxml's xpath syntax is supported
• NS: Multiline namespace aliases in the form of alias=uri://name.space/specification

Tests are run in order, so that subsequent tests can make use of earlier variable assignment.

License

Copyright (c) University Library System, University of Pittsburgh

Released under the MIT license