MFTF: Static test to verify that ActionGroup file contains single ActionGroup

[lbajsarowicz]

Summary (*)

When submitting Magento Functional Testing Framework tests, developers usually submit several ActionGroup sections inside single ActionGroup/*ActionGroup.xml file. That's against MFTF best practices and should be avoided.

Examples (*)

Discussion covered in magento/magento2#25812

Proposed solution

Static analysis to verify that ActionGroup file contains single ActionGroup and it's name is corresponding to filename.

[m2-assistant]

Hi @lbajsarowicz. Thank you for your report.
To help us process this issue please make sure that you provided the following information:

• Summary of the issue
• Information on your environment
• Steps to reproduce
• Expected and actual results

Please make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, please, add a comment to the issue:

@magento give me 2.3-develop instance - upcoming 2.3.x release

For more details, please, review the Magento Contributor Assistant documentation.

@lbajsarowicz do you confirm that you were able to reproduce the issue on vanilla Magento instance following steps to reproduce?

• yes
• no

---

• Join Magento Community Engineering Slack and ask your questions in #github channel.

[lbajsarowicz]

Actually it turned out that it's enough to change XSD file, however it's strongly backward incompatible change and we'll be able to introduce such change only to MFTF core when all Magento core code contains properly separated Action Groups.

[m2-assistant]

Hi @engcom-Charlie. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).

  Details

  If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.

• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.

• 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

• 4. Verify that the issue is reproducible on 2.3-develop branch

  Details

  - Add the comment @magento give me 2.3-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.3-develop branch, please, add the label Reproduced on 2.3.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!

• 5. Add label Issue: Confirmed once verification is complete.

• 6. Make sure that automatic system confirms that report has been added to the backlog.

[magento-engcom-team]

✅ Confirmed by @engcom-Charlie
Thank you for verifying the issue. Based on the provided information internal tickets MC-29336 were created

Issue Available: @engcom-Charlie, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.

[jilu1]

@lbajsarowicz Thank you for your suggestion!
I have this feature request ticket MC-29336 moved to our team as MQE-1914. We will keep you updated with progress and feedback through this PR.

[jilu1]

@lbajsarowicz Similar feature is delivered in MFTF-3.0.0-RC1. Only single ActionGroup is allowed in one file. Violation will result in generation error. Upgrade script is provided to help user to change tests into new format.