FOLIO integration test framework (UITEST-2)

[UITEST-6] Document how to run module tests from ui-testing Created: 25/Aug/17  Updated: 01/Sep/17  Resolved: 01/Sep/17

Status: Closed
Project: stripes-testing
Components: None
Affects versions: None
Fix versions: None
Parent: FOLIO integration test framework

Type: Sub-task Priority: P3
Reporter: Niels Erik Nielsen Assignee: Niels Erik Nielsen
Resolution: Done Votes: 0
Labels: sprint21
Remaining Estimate: Not Specified
Time Spent: 2 hours
Original estimate: Not Specified

Issue links:
Relates
relates to UITEST-5 Document how to write module tests to... Closed
Sprint:

 Description   

Should be linked to from the UI release procedure:

https://github.com/folio-org/stripes-core/blob/master/doc/release-procedure.md#notes-on-testing



 Comments   
Comment by Niels Erik Nielsen [ 28/Aug/17 ]

Have added help page to test-module.js:

Comment by Niels Erik Nielsen [ 28/Aug/17 ]

To run a Stripes module's Nightmare tests:

git clone https://github.com/folio-org/ui-testing.git
cd ui-testing
yarn install

and then, to test the users module:

yarn test-module -- -o --run=users 

Options for running individual tests from a module are explained in test-module's help page:

Usage:

  yarn test-module -- -o --run=module[:script[,script]][/module[:script[,script]]]

Examples:

  yarn test-module -- -o --run=requests                     Runs main tests (test.js) for UI module 'requests'
  yarn test-module -- -o --run=users/items                  Runs tests (test.js) for multiple UI modules
  yarn test-module -- -o --run=users:new_user,patron_group  Runs specific tests for 'users'

Info:

  The script will run a UI module's Nightmare tests, provided that the module has tests defined and 

   a) is included as a dependency in /ui-testing/package.json 
   b) runs on the FOLIO web application targeted by this test (see URL settings in /ui-testing/folio-ui-config.js)

  The npm version of the test suite should match the version of the live module being tested.

These commands would test a module in the default FOLIO application with default test settings (see URL and settings in ui-testing/folio-ui.config.js). The current README.md in ui-testing explains how to change the test URL and other test settings.

Comment by Niels Erik Nielsen [ 29/Aug/17 ]

Addition:

When running a UI module's test suite there are three potential sources for the actual version of the test being pulled in:

FOLIO's release repository: npm-folio
FOLIO's continuous integration repository: npm-folioci
A local checkout of the module, brought into ui-testing by yarn link or otherwise

Pulling the tests from the release repository makes sense if the purpose is to test a candidate for a stable Stripes platform release, since it will pull in a version of the test matching a released version of the UI module.

Otherwise, the intention is probably to test the very latest version of the UI module(s) and for that, uI-testing should be installed from npm-folioci.

In order to develop the test itself (not just run it against a developing UI module), the test programmer would probably yarn link a local checkout of the UI module into ui-testing

Generated at Thu Feb 08 23:08:28 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.