11 15 2023 Meeting

New Structure for REDCap Cypress:

REDCap Cypress

• Feature Tests are now managed independently of the REDCap Cypress repository
• You do not see any tests written in the download of the repository
• You do not see any supporting code anymore
• Framework is extracted outside of the repository
• All you see is import 'rctf' - https://github.com/aldefouw/redcap_cypress/blob/master/cypress/support/e2e.js

RCTF is now true framework

• Step Definitions, Commands, Parameters, and Database Interactions are now within a repo called "RCTF"
• Importantly, this becomes an actual Test Framework with this pattern because we now include the code we've written is now in a package
• Opens up the possibility for people to

• test their External Modules
• write their own Institutional Instance features

• Documentation for the Step Definitions should probably be moved to this framework in the long run

Core Feature Test Downloads

1. Set the version of tests you want in the package.json in devDependencies -

"redcap_rsvc": "git://github.com/aldefouw/redcap_rsvc#v13.1.37"

2. npm run redcap_rsvc:install

3. This installs the version you have specified in a folder called "redcap_rsvc"

4. In cypress.config.js, you adjust this:

specPattern: ['cypress/features/*.feature', 'redcap_rsvc/*/[ABC]/*/*.feature']

Decoupling between Feature Tests & Framework

• RCTF can be used to test any feature test, so long as the version of the RCTF contains the steps you need
• That means that, moving forward, we can use versioning of RCTF to signal breaking changes
• We can also push improvements to the RCTF without altering features

For a given release of core tests, we basically pin:

    "rctf": "git://github.com/aldefouw/rctf#v1.0.4",
    "redcap_rsvc": "git://github.com/aldefouw/redcap_rsvc#v13.1.37",