Joomla CMS

https://github.com/joomla/joomla-cms
Admin
Joomla is a free and open-source content management system that enables you to build websites and...
Tokens:896,966
Snippets:5,210
Trust Score:8.9
License:GPL-2.0
Update:1 week ago
Show doc for...
Tokens:
Raw
### Expected output from integration test run

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/Integration/README.md

Example command-line output when running the integration tests successfully.

```text
$ ./libraries/vendor/bin/phpunit --testsuite Integration
PHPUnit 8.3.4 by Sebastian Bergmann and contributors.

........                                                            8 / 8 (100%)

Time: 155 ms, Memory: 10.00 MB

OK (8 tests, 33 assertions)
```

--------------------------------

### Run system tests with Docker Compose

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Executes a cleanup and starts the system tests from the current docker-compose.yml file. The database uses a temporary filesystem, so data is deleted on each start; the installation test must run first. The webserver is accessible at http://localhost:8080 or https://localhost:8443, and PHPMyAdmin at http://localhost:8081.

```bash
docker compose down && docker compose up system-tests
```

--------------------------------

### Run multiple Cypress test specs with patterns

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Runs multiple test specs separated by commas and supports patterns. This example runs all tests except the installation step.

```bash
npx cypress run --spec 'tests/System/integration/{administrator,site,api,plugins}/**/*.cy.js'
```

--------------------------------

### Run all Joomla System Tests with Cypress

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Starts the full Joomla System Tests suite in headless Cypress, beginning with the Joomla Web-Installer as the first test step. Use after installation.

```bash
npm run cypress:run
```

--------------------------------

### Install PHP and JavaScript dependencies

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Installs Composer (PHP) and npm (JavaScript) dependencies after navigating to the Joomla directory.

```bash
cd /var/www/html
composer install
npm ci
```

--------------------------------

### Run all tests (integration and unit)

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/Integration/README.md

Runs both integration and unit tests together after configuring the environment.

```bash
./libraries/vendor/bin/phpunit
```

--------------------------------

### Run a single Cypress test spec

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Executes a specific test spec, for example the installation step only. Replace the path with your target spec file.

```bash
npx cypress run --spec tests/System/integration/install/Installation.cy.js
```

--------------------------------

### Install Composer dependencies

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/README.md

Installs all PHP dependencies required by Joomla using Composer. This step is necessary after checking out the branch.

```bash
composer install
```

--------------------------------

### Create article in database with cy.db_createArticle

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Database command to create an article in the database. Asynchronous and must be chained with .then() to get the returned id.

```JavaScript
cy.db_createArticle({ title: 'automated test article' }).then((id) => { ... })`
```

--------------------------------

### Run integration tests with PHPUnit

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/Integration/README.md

Executes the Integration test suite. Expected output shows PHPUnit 8.3.4 and a successful run with 8 tests and 33 assertions.

```bash
./libraries/vendor/bin/phpunit --testsuite Integration
```

--------------------------------

### Run Cypress with sudo and CYPRESS_CACHE_FOLDER

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Command to run Cypress with `sudo` while using the current user's Cypress installation cache when the root user does not have Cypress installed.

```bash
sudo CYPRESS_CACHE_FOLDER=$HOME/.cache/Cypress npm run cypress:run
```

--------------------------------

### Install npm dependencies

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/README.md

Installs all JavaScript and SASS dependencies required by Joomla using npm. This step is necessary for compiling frontend assets.

```bash
npm ci
```

--------------------------------

### EACCES permission denied error output

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Example error output when Cypress installation or test suite is run by a non-root user, showing `EACCES: permission denied` for `./configuration.php`.

```text
1) Install Joomla
       Install Joomla:
       CypressError: `cy.task('writeRelativeFile')` failed with the following error:
       > EACCES: permission denied, open './configuration.php'
```

--------------------------------

### Run unit tests with PHPUnit

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/Unit/README.md

Execute the unit test suite using the vendor-provided PHPUnit binary. This command assumes the environment is already set up via composer install.

```bash
./libraries/vendor/bin/phpunit --testsuite Unit
```

--------------------------------

### Run OpenLDAP Docker container for LDAP tests

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/Integration/README.md

Starts a Bitnami OpenLDAP container with TLS enabled and publishes ports 1389 and 1636. Mounts the tests/certs directory for certificates. Set JTEST_LDAP_HOST to localhost or adjust the hosts file to use this container.

```bash
docker run --rm --name openldap --env LDAP_ADMIN_USERNAME=admin --env LDAP_ADMIN_PASSWORD=adminpassword --env LDAP_USERS=customuser --env LDAP_PASSWORDS=custompassword --publish 1389:1389 --publish 1636:1636 --env LDAP_ENABLE_TLS=yes --env LDAP_TLS_CERT_FILE=/opt/bitnami/certs/openldap.crt --env LDAP_TLS_KEY_FILE=/opt/bitnami/certs/openldap.key --env LDAP_TLS_CA_FILE=/opt/bitnami/certs/CA.crt --env LDAP_CONFIG_ADMIN_ENABLED=yes --env LDAP_CONFIG_ADMIN_USERNAME=admin --env LDAP_CONFIG_ADMIN_PASSWORD=configpassword --env BITNAMI_DEBUG=true -v $(pwd)/tests/certs:/opt/bitnami/certs bitnami/openldap:latest
```

--------------------------------

### Timeout error output

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Example assertion timeout error on slow machines, showing `Timed out retrying after 4000ms`.

```text
     AssertionError: Timed out retrying after 4000ms: Expected to find element
```

--------------------------------

### Make API GET request with cy.api_get

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

API command to make a GET request to the CMS API endpoint /api/index.php/v1. Asynchronous and must be chained with .then() to handle the response object from Cypress request command.

```JavaScript
cy.api_get('/content/articles').then((response) => { ... })`
```

--------------------------------

### phpunit.xml configuration for integration tests

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/Integration/README.md

Copy phpunit.xml.dist to phpunit.xml and adjust JTEST_DB_* constants for your database (mysqli or pgsql). The Integration testsuite runs tests in ./tests/Integration.

```XML
<?xml version="1.0" encoding="UTF-8"?>
<phpunit bootstrap="tests/Unit/bootstrap.php" colors="false">
	<testsuites>
		<testsuite name="Unit">
			<directory suffix="Test.php">./tests/Unit</directory>
		</testsuite>
		<testsuite name="Integration">
			<directory suffix="Test.php">./tests/Integration</directory>
		</testsuite>
	</testsuites>
	<php>
		<const name="JTEST_DB_ENGINE" value="mysqli" />
		<const name="JTEST_DB_HOST" value="localhost" />
		<const name="JTEST_DB_NAME" value="joomla_db" />
		<const name="JTEST_DB_USER" value="Your DB user" />
		<const name="JTEST_DB_PASSWORD" value="Your Password" />
		...
	</php>
</phpunit>
```

--------------------------------

### EPERM operation not permitted error output

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Example error output on Microsoft Windows when the same permission issue occurs, showing `EPERM: operation not permitted` for `configuration.php`.

```text
       > EPERM: operation not permitted, open 'C:\laragon\www\joomla-cms\configuration.php'
```

--------------------------------

### api_get

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Performs an HTTP GET request to the CMS API endpoint `/api/index.php/v1` for the given path. Returns the Cypress request response object.

```APIDOC
## api_get

### Description
HTTP GET request for given path.

### Usage
```JavaScript
cy.api_get('/content/articles').then((response) => { ... })
```

### Parameters
- **path** (string) - Required - The API path to request.

### Returns
- **response** (object) - The Cypress request response object.
```

--------------------------------

### EADDRINUSE error output

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Example error output when the SMTP server port is already in use, showing `EADDRINUSE: address already in use :::1025`.

```text
    Your configFile threw an error from: cypress.config.mjs

    We stopped running your tests because your config file crashed.

    Error: listen EADDRINUSE: address already in use :::1025
```

--------------------------------

### Redirect to front controller when mod_rewrite is disabled

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/htaccess.txt

Temporary redirect of the start page to /index.php/ when Apache mod_rewrite is not available, using mod_alias. RedirectTemp cannot be used instead.

```apache
## These directives are only enabled if the Apache mod_rewrite module is disabled
<IfModule !mod_rewrite.c>
	<IfModule mod_alias.c>
		# When Apache mod_rewrite is not available, we instruct a temporary redirect
		# of the start page to the front controller explicitly so that the website
		# and the generated links can still be used.
		RedirectMatch 302 ^/$ /index.php/
		# RedirectTemp cannot be used instead
	</IfModule>
</IfModule>
```

--------------------------------

### Create Cypress configuration file

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Copies the distribution Cypress configuration template to the active configuration file.

```bash
cp cypress.config.dist.mjs cypress.config.mjs
```

--------------------------------

### Open Cypress GUI

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Opens the Cypress GUI, which lists all existing tests and can launch a browser for execution. Useful for rewinding and viewing Cypress log output in real time.

```bash
npm run cypress:open
```

--------------------------------

### Navigate to the joomla-cms directory

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/README.md

Changes the current working directory to the cloned joomla-cms folder. Run this after cloning the repository.

```bash
cd joomla-cms
```

--------------------------------

### db_createBannerClient

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Creates a banner client in the database and returns its ID. This command is asynchronous and must be chained with .then().

```APIDOC
## db_createBannerClient

### Description
Creates a banner client and returns the id.

### Usage
```JavaScript
cy.db_createBannerClient({ ... }).then((id) => { ... })
```

### Returns
- **id** (number) - The ID of the created banner client.
```

--------------------------------

### db_createUser

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Creates a user entry in the database and returns its ID. This command is asynchronous and must be chained with .then().

```APIDOC
## db_createUser

### Description
Creates a user entry and returns the id.

### Usage
```JavaScript
cy.db_createUser({ ... }).then((id) => { ... })
```

### Returns
- **id** (number) - The ID of the created user.
```

--------------------------------

### db_createMenuType

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Creates a menu type in the database and returns its ID. This command is asynchronous and must be chained with .then().

```APIDOC
## db_createMenuType

### Description
Creates a menu type and returns the id.

### Usage
```JavaScript
cy.db_createMenuType({ ... }).then((id) => { ... })
```

### Returns
- **id** (number) - The ID of the created menu type.
```

--------------------------------

### db_createMenuItem

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Creates a menu item in the database and returns its ID. This command is asynchronous and must be chained with .then().

```APIDOC
## db_createMenuItem

### Description
Creates a menu item and returns the id.

### Usage
```JavaScript
cy.db_createMenuItem({ ... }).then((id) => { ... })
```

### Returns
- **id** (number) - The ID of the created menu item.
```

--------------------------------

### Run Cypress with sudo

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Command to run Cypress with `sudo` on macOS, Linux, or Windows WSL 2 to give the user permission to write `configuration.php`.

```bash
sudo npm run cypress:run
```

--------------------------------

### db_createBanner

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Creates a banner in the database and returns its ID. This command is asynchronous and must be chained with .then().

```APIDOC
## db_createBanner

### Description
Creates a banner and returns the id.

### Usage
```JavaScript
cy.db_createBanner({ ... }).then((id) => { ... })
```

### Returns
- **id** (number) - The ID of the created banner.
```

--------------------------------

### db_createModule

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Creates a module in the database and returns its ID. This command is asynchronous and must be chained with .then().

```APIDOC
## db_createModule

### Description
Creates a module and returns the id.

### Usage
```JavaScript
cy.db_createModule({ ... }).then((id) => { ... })
```

### Returns
- **id** (number) - The ID of the created module.
```

--------------------------------

### db_enableExtension

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Sets the enabled status for the given extension. This command is asynchronous and must be chained with .then().

```APIDOC
## db_enableExtension

### Description
Sets the enabled status for the given extension.

### Usage
```JavaScript
cy.db_enableExtension({ ... }).then(() => { ... })
```

### Parameters
- **extension** (string) - Required - The extension to enable.
- **enabled** (boolean) - Required - The enabled status to set.
```

--------------------------------

### db_createUserLevel

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Creates a user access level in the database and returns its ID. This command is asynchronous and must be chained with .then().

```APIDOC
## db_createUserLevel

### Description
Creates a user access level and returns the id.

### Usage
```JavaScript
cy.db_createUserLevel({ ... }).then((id) => { ... })
```

### Returns
- **id** (number) - The ID of the created user access level.
```

--------------------------------

### db_createUserGroup

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Creates a user group in the database and returns its ID. This command is asynchronous and must be chained with .then().

```APIDOC
## db_createUserGroup

### Description
Creates a user group and returns the id.

### Usage
```JavaScript
cy.db_createUserGroup({ ... }).then((id) => { ... })
```

### Returns
- **id** (number) - The ID of the created user group.
```

--------------------------------

### db_createWorkflowTransition

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Creates a workflow transition in the database and returns the inserted record. This command is asynchronous and must be chained with .then().

```APIDOC
## db_createWorkflowTransition

### Description
Creates a workflow transition and returns the inserted record.

### Usage
```JavaScript
cy.db_createWorkflowTransition({ ... }).then((record) => { ... })
```

### Returns
- **record** (object) - The inserted workflow transition record.
```

--------------------------------

### db_createCategory

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Creates a category in the database and returns its ID. This command is asynchronous and must be chained with .then().

```APIDOC
## db_createCategory

### Description
Creates a category and returns the id.

### Usage
```JavaScript
cy.db_createCategory({ ... }).then((id) => { ... })
```

### Returns
- **id** (number) - The ID of the created category.
```

--------------------------------

### Set configuration parameter with cy.config_setParameter

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Config command to set a parameter in configuration.php. Asynchronous and must be chained with .then(). Uses cy.readFile() and the Cypress task writeRelativeFile to delegate file system operations to Node.js.

```JavaScript
cy.config_setParameter('sef', false).then(() => { ... })`
```

--------------------------------

### Serve gzip-compressed CSS and JS files with correct headers

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/htaccess.txt

When mod_headers is enabled, this block serves pre-compressed .gz files for CSS and JS if they exist and the client accepts gzip. It sets correct content types and prevents double compression. If the site looks strange or shows ERR_CONTENT_DECODING_FAILED, the server is already gzipping and this block should be disabled.

```apache
## GZIP & BROTLI
## These directives are only enabled if the Apache mod_headers module is enabled.
## This section will check if a .gz file exists and if so will stream it
##     directly or fallback to gzip any asset on the fly
## If your site starts to look strange after enabling this file, and you see
##     ERR_CONTENT_DECODING_FAILED in your browser console network tab,
##     then your server is already gzipping css and js files and you don't need this
##     block enabled in your .htaccess
<IfModule mod_headers.c>
	# Serve gzip compressed CSS files if they exist
	# and the client accepts gzip.
	RewriteCond "%{HTTP:Accept-encoding}" "gzip"
	RewriteCond "%{REQUEST_FILENAME}\.gz" -s
	RewriteRule "^(.*)\.css" "$1\.css\.gz" [QSA]

	# Serve gzip compressed JS files if they exist
	# and the client accepts gzip.
	RewriteCond "%{HTTP:Accept-encoding}" "gzip"
	RewriteCond "%{REQUEST_FILENAME}\.gz" -s
	RewriteRule "^(.*)\.js" "$1\.js\.gz" [QSA]

	# Serve correct content types, and prevent mod_deflate double compression.
	RewriteRule "\.css\.gz$" "-" [T=text/css,E=no-gzip:1,E=no-brotli:1]
	RewriteRule "\.js\.gz$" "-" [T=text/javascript,E=no-gzip:1,E=no-brotli:1]

	<FilesMatch "(\.js\.gz|\.css\.gz)$">
		# Serve correct encoding type.
		Header set Content-Encoding gzip

		# Force proxies to cache gzipped &
		# non-gzipped css/js files separately.
		Header append Vary Accept-Encoding
	</FilesMatch>
</IfModule>
```

--------------------------------

### db_createArticle

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Creates an article in the database and returns its ID. This command is asynchronous and must be chained with .then().

```APIDOC
## db_createArticle

### Description
Creates an article in the database and returns the id.

### Usage
```JavaScript
cy.db_createArticle({ title: 'automated test article' }).then((id) => { ... })
```

### Parameters
- **title** (string) - Required - The title of the article.

### Returns
- **id** (number) - The ID of the created article.
```

--------------------------------

### db_createWorkflow

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Creates a workflow in the database and returns the inserted record. This command is asynchronous and must be chained with .then().

```APIDOC
## db_createWorkflow

### Description
Creates a workflow and returns the inserted record.

### Usage
```JavaScript
cy.db_createWorkflow({ ... }).then((record) => { ... })
```

### Returns
- **record** (object) - The inserted workflow record.
```

--------------------------------

### db_createWorkflowStage

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Creates a workflow stage in the database and returns the inserted record. This command is asynchronous and must be chained with .then().

```APIDOC
## db_createWorkflowStage

### Description
Creates a workflow stage and returns the inserted record.

### Usage
```JavaScript
cy.db_createWorkflowStage({ ... }).then((record) => { ... })
```

### Returns
- **record** (object) - The inserted workflow stage record.
```

--------------------------------

### db_createNewsFeed

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Creates a news feed in the database and returns its ID. This command is asynchronous and must be chained with .then().

```APIDOC
## db_createNewsFeed

### Description
Creates a news feed and returns the id.

### Usage
```JavaScript
cy.db_createNewsFeed({ ... }).then((id) => { ... })
```

### Returns
- **id** (number) - The ID of the created news feed.
```

--------------------------------

### db_createContact

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Creates a contact in the database and returns its ID. This command is asynchronous and must be chained with .then().

```APIDOC
## db_createContact

### Description
Creates a contact and returns the id.

### Usage
```JavaScript
cy.db_createContact({ ... }).then((id) => { ... })
```

### Returns
- **id** (number) - The ID of the created contact.
```

--------------------------------

### db_createTag

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Creates a tag in the database and returns its ID. This command is asynchronous and must be chained with .then().

```APIDOC
## db_createTag

### Description
Creates a tag and returns the id.

### Usage
```JavaScript
cy.db_createTag({ ... }).then((id) => { ... })
```

### Returns
- **id** (number) - The ID of the created tag.
```

--------------------------------

### Enable browser console logging in headless mode

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Sets the ELECTRON_ENABLE_LOGGING environment variable to see console.log() output from the browser in headless mode, then runs Cypress with the Electron browser. Without this, only Cypress Task console.log() output appears in the Node.js environment.

```bash
export ELECTRON_ENABLE_LOGGING=1
npm run cypress:run --browser electron
```

--------------------------------

### db_createField

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Creates a field in the database and returns its ID. This command is asynchronous and must be chained with .then().

```APIDOC
## db_createField

### Description
Creates a field and returns the id.

### Usage
```JavaScript
cy.db_createField({ ... }).then((id) => { ... })
```

### Returns
- **id** (number) - The ID of the created field.
```

--------------------------------

### Clone the Joomla CMS repository

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/README.md

Clones the Joomla CMS source code from GitHub. This is the first step in setting up a local development environment from the source repository.

```bash
git clone https://github.com/joomla/joomla-cms.git
```

--------------------------------

### db_createPrivacyConsent

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Creates a privacy consent in the database and returns its ID. This command is asynchronous and must be chained with .then().

```APIDOC
## db_createPrivacyConsent

### Description
Creates a private consent and returns the id.

### Usage
```JavaScript
cy.db_createPrivacyConsent({ ... }).then((id) => { ... })
```

### Returns
- **id** (number) - The ID of the created privacy consent.
```

--------------------------------

### config_setParameter

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Sets a parameter in the `configuration.php` file. This command is asynchronous and must be chained with .then().

```APIDOC
## config_setParameter

### Description
Sets a parameter in `configuration.php` file.

### Usage
```JavaScript
cy.config_setParameter('sef', false).then(() => { ... })
```

### Parameters
- **parameter** (string) - Required - The parameter name.
- **value** (any) - Required - The value to set.
```

--------------------------------

### db_updateExtensionParameter

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Sets the parameter for the given extension. This command is asynchronous and must be chained with .then().

```APIDOC
## db_updateExtensionParameter

### Description
Sets the parameter for the given extension.

### Usage
```JavaScript
cy.db_updateExtensionParameter({ ... }).then(() => { ... })
```

### Parameters
- **extension** (string) - Required - The extension to update.
- **parameter** (string) - Required - The parameter to set.
```

--------------------------------

### db_createFieldGroup

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Creates a field group in the database and returns its ID. This command is asynchronous and must be chained with .then().

```APIDOC
## db_createFieldGroup

### Description
Creates a field group and returns the id.

### Usage
```JavaScript
cy.db_createFieldGroup({ ... }).then((id) => { ... })
```

### Returns
- **id** (number) - The ID of the created field group.
```

--------------------------------

### Custom Module Builder Class Structure

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/media_source/README.md

Defines a custom builder class for asset processing by implementing task lists and execution methods. The builder must implement getBuildTasks() to identify tasks for the complete build process.

```javascript
export default class ExampleModuleBuilder
{
	tasksBuild = ['clear', 'copy', 'css', 'js'];
	tasksExtras = ['gzip'];

	constructor(name = '', basePath = '', targetPath = '', options = {}) {
		if (!name) {
			throw new Error(`Argument "name" is required for ModuleBuilder.`);
		}

		if (!basePath || !targetPath) {
			throw new Error(`Arguments "basePath" and "targetPath"  is required for "${name}" ModuleBuilder.`);
		}

		this.name = name;
		this.basePath = path.join(basePath, name);
		this.targetPath = path.join(targetPath, name);
		this.options = options;
	}

	getAllTasks() {
		return [ ...this.tasksBuild, ...this.tasksExtras ];
	}

	getBuildTasks() {
		return this.tasksBuild;
	}

	// The methods to execute each task
	async clear() {}
	async copy() {}
	async css() {}
	async js() {}
	async gzip() {}
}
```

--------------------------------

### Apache configuration for rewrite module and directory overrides

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Apache configuration required for Joomla System Tests. Loads the rewrite module and enables directory overrides with AllowOverride All. The directory path should be replaced with the actual web root.

```apache
# Load the rewrite module
LoadModule rewrite_module lib/httpd/modules/mod_rewrite.so

# Configure directory overrides
<Directory "...">
    AllowOverride All
</Directory>
```

--------------------------------

### Checkout the 6.2-dev branch

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/README.md

Switches to the 6.2-dev development branch of the Joomla CMS repository. This branch is used for development work.

```bash
git checkout 6.2-dev
```

--------------------------------

### api_post

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Performs an HTTP POST request to the CMS API endpoint `/api/index.php/v1` for the given path and body. Returns the Cypress request response object.

```APIDOC
## api_post

### Description
HTTP POST request for given path and body.

### Usage
```JavaScript
cy.api_post('/content/articles', { ... }).then((response) => { ... })
```

### Parameters
- **path** (string) - Required - The API path to request.
- **body** (object) - Required - The request body.

### Returns
- **response** (object) - The Cypress request response object.
```

--------------------------------

### Execute writeRelativeFile Cypress Task

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Use this snippet in a Joomla System Test to write a file relative to the CMS root folder via the 'writeRelativeFile' Cypress Task. The task is asynchronous and must be chained with .then() to handle the result.

```JavaScript
 cy.task('writeRelativeFile', { path: 'images/dummy.text', content: '1' }).then(() =>  { ... })
```

--------------------------------

### Insert a delay with cy.wait

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Insert a 20-second delay to observe test status during debugging. Do not use `wait()` regularly in tests.

```JavaScript
cy.wait(20000); // waits for 20 seconds
```

--------------------------------

### Clone Joomla repository

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Clones the Joomla CMS repository into the web server directory. Uses --depth 1 for a shallow clone.

```bash
git clone --depth 1 https://github.com/joomla/joomla-cms /var/www/html
```

--------------------------------

### api_getBearerToken

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Returns the bearer token, creating a user entry if needed. This command is asynchronous and must be chained with .then().

```APIDOC
## api_getBearerToken

### Description
Returns the bearer token, creates user entry if needed.

### Usage
```JavaScript
cy.api_getBearerToken().then((token) => { ... })
```

### Returns
- **token** (string) - The bearer token.
```

--------------------------------

### db_createPrivacyRequest

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Creates a privacy request in the database and returns its ID. This command is asynchronous and must be chained with .then().

```APIDOC
## db_createPrivacyRequest

### Description
Creates a private request and returns the id.

### Usage
```JavaScript
cy.db_createPrivacyRequest({ ... }).then((id) => { ... })
```

### Returns
- **id** (number) - The ID of the created privacy request.
```

--------------------------------

### Extending DefaultModuleBuilder for Custom Logic

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/media_source/README.md

Simplifies custom builder creation by extending the DefaultModuleBuilder class. This allows overriding specific task methods like js() while retaining default functionality via super.

```javascript
import DefaultModuleBuilder from '../../build/build-modules-js/builder/default-module-builder.mjs';

export default class ExampleModuleBuilder extends DefaultModuleBuilder {
	async js() {
		await super.js();

		// Run custom code
	}
}
```

--------------------------------

### Increase defaultCommandTimeout in cypress.config.mjs

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Configuration snippet to increase the default waiting time to 20 seconds in `cypress.config.mjs` to avoid timeout errors on slow machines.

```JavaScript
    export default defineConfig({
      defaultCommandTimeout: 20000, // sets the waiting time to 20 seconds
      ...
    }
```

--------------------------------

### Custom redirects placeholder

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/htaccess.txt

Placeholder section for custom redirects, such as non-www to www. Requires correct RewriteRule syntax and [R=301,L] flags.

```apache
# If you need to redirect some pages, or set a canonical non-www to
# www redirect (or vice versa), place that code here. Ensure those
# redirects use the correct RewriteRule syntax and the [R=301,L] flags.
```

--------------------------------

### Run a single test with it.only

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Add `.only` to a test function to run only that test from a spec file for debugging. See Cypress documentation for details.

```JavaScript
it.only('running only this test', () => {
    ...
})
```

--------------------------------

### Convert PDF to SVG using pdf2svg

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/images/README.md

Use the pdf2svg command line tool to convert a PDF file exported from OpenOffice Draw into an SVG format.

```bash
pdf2svg
```

--------------------------------

### Joomla SEF URL rewriting for API and frontend

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/htaccess.txt

Rewrites requests to api/index.php for /api paths and to index.php for the frontend, preserving HTTP Authorization for PHP FastCGI. Requires mod_rewrite and excludes existing files/folders.

```apache
RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
# -- SEF URLs for the API application
# If the requested path starts with /api, the file is not /api/index.php
# and the request has not already been internally rewritten to the
# api/index.php script
RewriteCond %{REQUEST_URI} ^/api/
RewriteCond %{REQUEST_URI} !^/api/index\.php
# and the requested path and file doesn't directly match a physical file
RewriteCond %{REQUEST_FILENAME} !-f
# and the requested path and file doesn't directly match a physical folder
RewriteCond %{REQUEST_FILENAME} !-d
# internally rewrite the request to the /api/index.php script
RewriteRule .* api/index.php [L]
# -- SEF URLs for the public frontend application
# If the requested path and file is not /index.php and the request
# has not already been internally rewritten to the index.php script
RewriteCond %{REQUEST_URI} !^/index\.php
# and the requested path and file doesn't directly match a physical file
RewriteCond %{REQUEST_FILENAME} !-f
# and the requested path and file doesn't directly match a physical folder
RewriteCond %{REQUEST_FILENAME} !-d
# internally rewrite the request to the index.php script
RewriteRule .* index.php [L]
```

--------------------------------

### db_deleteMenuItem

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Deletes a menu item with the given title. This command is asynchronous and must be chained with .then().

```APIDOC
## db_deleteMenuItem

### Description
Deletes a menu item with the given title.

### Usage
```JavaScript
cy.db_deleteMenuItem({ title: '...' }).then(() => { ... })
```

### Parameters
- **title** (string) - Required - The title of the menu item to delete.
```

--------------------------------

### db_getUserId

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Returns the ID of the currently logged in user. This command is asynchronous and must be chained with .then().

```APIDOC
## db_getUserId

### Description
Returns the id of the currently logged in user.

### Usage
```JavaScript
cy.db_getUserId().then((id) => { ... })
```

### Returns
- **id** (number) - The ID of the currently logged in user.
```

--------------------------------

### RewriteBase directive (commented)

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/htaccess.txt

Uncomment to set the base URL for rewriting when the webserver's URL is not directly related to physical file paths. Update the directory path for Joomla root.

```apache
# RewriteBase /
```

--------------------------------

### Modify SVG dimensions

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/images/README.md

Update the SVG file attributes to ensure responsive sizing by setting width to 100% and height to auto.

```xml
<svg ... width="100%" height="auto" ...>
```

--------------------------------

### Initialize and localize fatal error page

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/templates/system/fatal-error.html

This script initializes the fatal error page by populating a language selection dropdown and updating the page content based on the user's browser language or selection. It requires the errorLocale variable to be defined in the global scope.

```javascript
var errorLocale=window.errorLocale||null;(function(e,t){
```

```javascript
"use strict";if(t){var l=e.getElementById("headerText"),i=e.getElementById("descText1"),g=e.getElementById("linkHelp");Object.keys(t).forEach(function(n){var s=e.getElementById("translatedLanguagesSelect"),u=e.createElement("option");u.text=t[n].language,u.value=n,n==="en-GB"&&u.setAttribute("selected","selected"),e.getElementById("translatedLanguagesSelect").addEventListener("change",function(f){var a=f.target.value;if(a){l&&i&&g&&(l.innerHTML=t[a].header,i.innerHTML=t[a].text1,g.innerText=t[a]["help-url-text"]);var r=e.documentElement;r&&r.setAttribute("lang",a)}}),s.appendChild(u)}),Object.keys(t).forEach(function(n){if(navigator.language===n){e.querySelector('#translatedLanguagesSelect option[value="en-GB"]').removeAttribute("selected"),e.querySelector('#translatedLanguagesSelect option[value="'+n+'"]').setAttribute("selected","selected"),l&&i&&g&&(l.innerHTML=t[n].header,i.innerHTML=t[n].text1,g.innerText=t[n]["help-url-text"]);var s=e.documentElement;s&&s.setAttribute("lang",n)}})}})(document,errorLocale);
```

--------------------------------

### api_delete

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Performs an HTTP DELETE request to the CMS API endpoint `/api/index.php/v1` for the given path. Returns the Cypress request response object.

```APIDOC
## api_delete

### Description
HTTP DELETE request for given path.

### Usage
```JavaScript
cy.api_delete('/content/articles/1').then((response) => { ... })
```

### Parameters
- **path** (string) - Required - The API path to request.

### Returns
- **response** (object) - The Cypress request response object.
```

--------------------------------

### api_patch

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Performs an HTTP PATCH request to the CMS API endpoint `/api/index.php/v1` for the given path and body. Returns the Cypress request response object.

```APIDOC
## api_patch

### Description
HTTP PATCH request for given path and body.

### Usage
```JavaScript
cy.api_patch('/content/articles/1', { ... }).then((response) => { ... })
```

### Parameters
- **path** (string) - Required - The API path to request.
- **body** (object) - Required - The request body.

### Returns
- **response** (object) - The Cypress request response object.
```

--------------------------------

### Block common exploits via mod_rewrite

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/htaccess.txt

Rewrites URLs that contain base64_encode, script tags, GLOBALS, or _REQUEST variables to return a 403 Forbidden header. Requires Apache mod_rewrite; comment out lines if issues occur.

```apache
RewriteCond %{QUERY_STRING} base64_encode[^(]*\([^)]*\) [OR]
RewriteCond %{QUERY_STRING} (<|%3C)([^s]*s)+cript.*(>|%3E) [NC,OR]
RewriteCond %{QUERY_STRING} GLOBALS(=|\[|\%[0-9A-Z]{0,2}) [OR]
RewriteCond %{QUERY_STRING} _REQUEST(=|\[|\%[0-9A-Z]{0,2})
RewriteRule .* index.php [F]
```

--------------------------------

### db_deleteCategory

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Deletes a category with the given title. This command is asynchronous and must be chained with .then().

```APIDOC
## db_deleteCategory

### Description
Deletes a category with the given title.

### Usage
```JavaScript
cy.db_deleteCategory({ title: '...' }).then(() => { ... })
```

### Parameters
- **title** (string) - Required - The title of the category to delete.
```

--------------------------------

### api_responseContains

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/tests/System/README.md

Checks if the given attribute in the response contains the specified value. This command is asynchronous and must be chained with .then().

```APIDOC
## api_responseContains

### Description
Checks if the given attribute in the response contains the specified value.

### Usage
```JavaScript
cy.api_responseContains(response, 'attribute', 'value').then((result) => { ... })
```

### Parameters
- **response** (object) - Required - The response object.
- **attribute** (string) - Required - The attribute to check.
- **value** (string) - Required - The value to check for.

### Returns
- **result** (boolean) - Whether the attribute contains the value.
```

--------------------------------

### Disable inline JavaScript for SVG files

Source: https://github.com/joomla/joomla-cms/blob/6.2-dev/htaccess.txt

Sets a Content-Security-Policy header to block inline scripts when serving SVG files, either directly or via object tags. Requires the Apache mod_headers module.

```apache
<FilesMatch "\.svg$">
  <IfModule mod_headers.c>
    Header always set Content-Security-Policy "script-src 'none'"
  </IfModule>
</FilesMatch>
```
Tokens:
Raw