Skip to content
Martina Scholz edited this page Oct 14, 2024 · 10 revisions

Welcome to the Release Testing Tool Wiki

Release testing plays a crucial role in the Joomla development cycle. It ensures that new versions of the CMS are stable, almost bug-free, and ready for public use. Minor updates of the Joomla CMS are released as minor updates every six (6) Tuesdays (although the schedule may vary) - Joomla! Project Roadmap.
One week before the official release, a Release Candidate (RC) version is made available for testing and community participation is essential.

The more people who test, the better the quality of the final release.

However, manually testing every feature and step can be time-consuming and resource-intensive. That's why we've tried to develop a simple and intuitive solution to streamline the testing process. Our goal is to make testing as easy and accessible as possible.

With our project, you can easily test either a brand-new Joomla site or your own existing site. Use the restore option to quickly create a local clone of your Joomla site or simply use the remote option, allowing for fast and efficient testing in a controlled environment.

This repository takes care of all the dependencies for you, so there's no need to worry about configuring them manually. We've made the process straightforward, so you can focus on testing, not troubleshooting.

Pre Requisites

  • Docker: This application relies on Docker to create isolated environments and manage its components efficiently. Please install Docker by following the official documentation.

  • WSL2 (Windows Subsystem for Linux 2): If you're using Windows, WSL2 is essential for running Docker containers seamlessly. First you need to install your preferred Distro into WSL2. Then start the WSL Console where you find yourself in a full Linux terminal.

Open a terminal or command prompt and run the following command to check if Docker and Docker Compose are installed and running correctly:

docker version && docker compose version

Installation

git clone https://github.com/joomla-projects/release-testing.git

Windows

  • Click on the start.bat file to start working in a WSL console.

Testing with the Joomla! Pre-Release Testing Tool

Joomla E2E Test Suite Options

grafik

1. Remote

This option allows you to run end-to-end (E2E) tests on a remote Joomla site using Cypress.

  • Usage: Select this option if you want to test a website hosted remotely (e.g., https://example.com).
  • How to choose: 1 -> Enter when prompted to select this option.

2. Local

This option enables you to run E2E tests on a local Joomla site installed within this testing environment with Cypress.

  • Usage: Use this when you want to test a Joomla instance that runs in the local web server which is delivered with this test suite and runs automatically within the Docker environment as local environment.
  • How to choose: 2 -> Enter to run tests on your local site.

3. Manage

This option provides tools to manage your local Joomla sites that are running within a Dockerized local web server included with this test suite. You can create new Joomla sites, restore sites from backups, or delete existing ones directly within this environment.

  • Usage: Choose this if you need to handle site management tasks such as creating or restoring Joomla sites.
  • How to choose: 3 -> Enter to access site management features.

4. Shutdown

If you encounter any issues while running tests or managing sites, this option allows you to shutdown the current Docker container stack and start the process again. This is useful for resetting the environment or troubleshooting errors.

  • Usage: Select this if you need to restart the testing environment due to problems or errors or if you want to temporarily pause your testing session and free up resources on your computer for the time being.
  • How to choose: 4 -> Enter to shutdown the container stack.

5. Quit

This option allows you to exit the Joomla E2E Test Suite and shutting down your docker containers gracefully.

  • Usage: Choose this option when you are done with testing want to close the program.
  • How to choose: 5 -> Enter to exit the suite.
joomla-cypress-release-testing.1.mp4

Overview Page

You can reach an overview of all available tools via http://localhost:8080 after starting your testing session.

Testing in headless mode and generate HTML Reports

joomla-cypress-release-testing3.mp4

Removing a local testing site

joomla-cypress-release-testing5.mp4

Testing on your copied remote sites with test-data reset via API

joomla-cypress-release-testing6_compressed.mp4

Demonstration of recording click paths with cypress studio

joomla-cypress-release-testing2_compressed.mp4
Clone this wiki locally