[Cypress] Remove Joomla command line client tool dependency #44656
+137
−99
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
With the `SefPlugin.cy.js` test specification, the Joomla command line client tool was added to the Joomla system tests for the first time. This is an additional complexity and dependency. Especially if the test environment is containerised and Cypress container has no PHP installed. And PHP version needs to be 8.1 and additional modules like `php-simplexml` are needed. And with the Docker access rights, `configuration.php` must be opened for writing (`chmod 644`). And then there is the locally running Cypress GUI to be configured... Therefore switched from using the Joomla command line client tool to using the existing `config_setParameter` Cypress command. The original creator of [44253](joomla#44253) could not know as it is not documented (will be solved with another PR and together with enabling `mod_rewrite` and the `AllowOverride All` needed configuration). Since sometimes the first SEF test failed when the entire Joomla System Tests was performed, the following was implemented: * The operations of the `writeRelativeFile` Cypress task are wrapped in a Promise to ensure that they are only resolved when everything is done * The `config_setParameter` Cypress custom command to return a Cypress chainable * Chaining has been implemented everywhere in `SefPlugin.cy.js` For this test spec the Cypress best practice to use `beforeEach` to ensure tests is added to run independently from one another (and needed for other places in the Joomla System Tests – one more PR). As a small side effect the SEF test spec with 9 tests runs faster, e.g. 3 instead of 18 seconds before. Tested with own target Joomla 5.2-dev three times the single test spec on: * Intel macOS 15.2 using Apache/MariaDB * Apple Silicon macOS 15.2 using Apache/MariaDB * Windows 11 24H2 using Laragon/Apache/MySQL ``` npx cypress run --spec tests/System/integration/plugins/system/sef/SefPlugin.cy.js ``` And once the overall test suite: ``` npm run cypress:run ```
muhme
changed the title
|
I have tested this item ✅ successfully on 0595b79 This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/44656. |
heelc29
reviewed
Jan 3, 2025
| * wait for the task to complete and chain it. | ||
| */ | ||
| return cy.task('writeRelativeFile', { path: 'configuration.php', content }).then((result) => { | ||
| cy.log(result); // Log success message for debugging |
| @@ -36,24 +36,29 @@ function deleteRelativePath(relativePath, config) { | |||
| * @returns null | |||
There was a problem hiding this comment.
return type changed to Promise
There was a problem hiding this comment.
Thank you for the hint, it looks right as one more change and I will test it and adopt the function header, but I'm running out of time these days, come back soon ...
Testing the CLI application is also not a bad idea ... now there is also a PR for it #44683 |
4 tasks
Yes and can we implement this outside Joomla System Tests? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of Changes
Refactoring of the Cypress test for SEF to replace the dependency on the Joomla command line client tool with Cypress custom commands.
With the
SefPlugin.cy.jsCypress test, the Joomla command line client tool was added to the Joomla System Tests for the first time. This is an additional complexity and dependency. Especially if the test environment is containerised and Cypress container has no PHP installed. And PHP version needs to be 8.1 and additional modules likephp-simplexmlare needed. And with the Docker access rights,configuration.phpmust be opened for writing (chmod 644). And then there is the locally running Cypress GUI to be configured...Therefore switched from using the Joomla command line client tool to using the existing
config_setParameterCypress custom command. The original creator of 44253 could not know as it is not documented (will be solved with another PR #44660, together with the description for configuring the now required enablemod_rewriteandAllowOverride All).Since sometimes the first SEF test failed when the entire Joomla System Tests was performed after refactoring, the following was implemented:
writeRelativeFileCypress task are wrapped in a Promise to ensure that they are only resolved when everything is doneconfig_setParameterCypress custom command to return a Cypress chainableSefPlugin.cy.jsThe Cypress best practice of using
beforeEachis used to ensure that the tests can be run independently (this is still needed for other places in the Joomla system tests - another PR).As a small side effect the SEF test spec with 9 tests runs faster, e.g. 3 instead of 18 seconds before.
Testing Instructions
And once the overall test suite:
Three times the single test spec on:
And once the overall test suite:
Actual result BEFORE applying this Pull Request
Joomla System Tests require Joomla command line client
Expected result AFTER applying this Pull Request
Joomla System Tests doesn't require Joomla command line client
Link to documentations
Please select:
Documentation link for docs.joomla.org:
No documentation changes for docs.joomla.org needed
Pull Request link for manual.joomla.org:
No documentation changes for manual.joomla.org needed
Related PR for adopting Joomla System Tests GitHub will follow