Skip to content

Latest commit

 

History

History

tests

README.md

Automated Tests for Joomla Developer Manuals

All the Joomla developer manual tutorial samples from ../module-tutorial can be automatically tested in a web browser using Cypress.

Installation

Git, Cypress and npm are required and must be installed. In addition, a target Joomla installation with the language en-GB for the Joomla admin user is required.

The tests are based on Node module joomla-cypress.

Perform the following steps on the command line:

  1. Clone the repository
git clone --depth 1 https://github.com/joomla/manual-examples
  1. Change to the tests sub-directory
cd manual-examples/tests
  1. Copy template cypress.config.dist.js to the Cypress configuration file cypress.config.js:
cp cypress.config.dist.js cypress.config.js
  1. In the file cypress.config.js adjust the three values joomlaBaseURL, joomlaAdminUserName and joomlaAdminUserPassword if necessary.
  2. Perform a clean installation of the project's dependencies:
npm ci

Test Run

Each example found in the module-tutorial directory is tested with the following steps:

  • Before each test, delete the module if it already exists.
  • Install the module, publish it, display it on all pages, and place it in the sidebar-right.
  • Verify that the module exists in the administrator backend view.
  • Check the module on the website frontend, ensuring it displays with the correct title and content.

Run tests for all module-tutorial examples with headless Cypress:

npx cypress run

screenshot npx cypress run

Run a test for one example only:

npx cypress run --env test=step1_basic_module

You can run Cypress with GUI to watch the web browser actions and to see all the logging output:

npx cypress open

You can run a single example in the Cypress GUI:

npx cypress open --env test=step2_tmpl_file

👉 After each test, the module remains installed and can be inspected manually in the target Joomla.

👉 In order to have the option of using a remote target Joomla, the plugin is installed as a ZIP file. You will find the most recently created ZIP archive in the cypress/fixtures folder.

Display Console Messages

Console messages in Cypress Test Runner from the Electron browser can be displayed in the JavaScript console of the Cypress GUI. If Cypress is executed headless, the console messages can be displayed by setting the environment variable ELECTRON_ENABLE_LOGGING:

ELECTRON_ENABLE_LOGGING=1 npx cypress run

Logging

In Cypress GUI mode, you can see the log messages. The log messages created by Cypress manual-examples test are using ****, for example:

log **** installAndConfigure ****
log **** directory: 'step1_basic_module'
log **** moduleName: 'Joomla module tutorial'
log **** absolutePath: '/Users/hlu/Desktop/manual-examples/module-tutorial/step1_basic_module'