Allure Reports Missing Test Name when test uses magentoDataFixture or other custom annotation

[dmanners]

Preconditions and environment

• 2.4.6 and 2.4.7
• Allure 2.30.0

Steps to reproduce

1. Run the integration tests when a test contains a magentoDataFixture or other custom magento annotation.
2. View the resulting json file of the test in dev/tests/integration/var/allure-results

Expected result

The name should be filled in the json file

Actual result

The name is empty in the json file

Additional information

This seems to have been an issue brought in with version 2.4.6 and the move from a listener to an extension for the allure config.

Old version: https://github.com/magento/magento2/blob/2.4.5/dev/tests/integration/phpunit.xml.dist#L95

To fix this we have added a new custom extension.

<extension class="Fix\IntegrationTests\Extension\IgnoreMagentoAnnotations">
            <arguments>
                <array>
                    <element key="codingStandardsIgnoreStart">
                        <string>codingStandardsIgnoreStart</string>
                    </element>
                    <element key="codingStandardsIgnoreEnd">
                        <string>codingStandardsIgnoreEnd</string>
                    </element>
                    <element key="expectedExceptionMessageRegExp">
                        <string>expectedExceptionMessageRegExp</string>
                    </element>
                    <element key="magentoAdminConfigFixture">
                        <string>magentoAdminConfigFixture</string>
                    </element>
                    <element key="magentoAppArea">
                        <string>magentoAppArea</string>
                    </element>
                    <element key="magentoAppIsolation">
                        <string>magentoAppIsolation</string>
                    </element>
                    <element key="magentoCache">
                        <string>magentoCache</string>
                    </element>
                    <element key="magentoComponentsDir">
                        <string>magentoComponentsDir</string>
                    </element>
                    <element key="magentoConfigFixture">
                        <string>magentoConfigFixture</string>
                    </element>
                    <element key="magentoDataFixture">
                        <string>magentoDataFixture</string>
                    </element>
                    <element key="magentoDataFixtureBeforeTransaction">
                        <string>magentoDataFixtureBeforeTransaction</string>
                    </element>
                    <element key="magentoDbIsolation">
                        <string>magentoDbIsolation</string>
                    </element>
                    <element key="magentoIndexerDimensionMode">
                        <string>magentoIndexerDimensionMode</string>
                    </element>
                </array>
            </arguments>
        </extension>

And the class looks as follows:

<?php
declare(strict_types=1);

namespace Fix\IntegrationTests\Extension;

use PHPUnit\Runner\BeforeFirstTestHook;
use Doctrine\Common\Annotations\AnnotationReader;

class IgnoreMagentoAnnotations implements BeforeFirstTestHook
{
    /**
     * @param array $configOptions
     */
    public function __construct(
        private readonly array $configOptions = []
    ) {
    }

    /**
     * Setup all the given names to be ignored by the annotation reader
     *
     * @return void
     */
    public function executeBeforeFirstTest(): void
    {
        foreach ($this->configOptions as $annotationNameToIgnore) {
            AnnotationReader::addGlobalIgnoredName($annotationNameToIgnore);
        }
    }
}

Release note

No response

Triage and priority

• Severity: S0 - Affects critical data or functionality and leaves users without workaround.
• Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
• Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
• Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
• Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.

[m2-assistant]

Hi @dmanners. Thank you for your report.
To speed up processing of this issue, make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce.

• For more details, review the Magento Contributor Assistant documentation.
• Add a comment to assign the issue: @magento I am working on this
• To learn more about issue processing workflow, refer to the Code Contributions.

---

Join Magento Community Engineering Slack and ask your questions in #github channel.
⚠️ According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.
🕙 You can find the schedule on the Magento Community Calendar page.
📞 The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

[m2-assistant]

Hi @engcom-November. 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).
• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
• 3. Add Area: XXXXX label to the ticket, indicating the functional areas it may be related to.
• 4. Verify that the issue is reproducible on 2.4-develop branch
  Details

  - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.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.

[engcom-November]

Hello @dmanners,

Thank you for the report and collaboration!

Verified this on 2.4-develop and it's reproducible.
Ran a integration test with magentoDataFixture and the resulting json file in dev/tests/integration/var/allure-results had null in name field.
Please take a look at the screenshot below:

Hence confirming this.

Thank you.

[github-jira-sync-bot]

✅ Jira issue https://jira.corp.adobe.com/browse/AC-13218 is successfully created for this GitHub issue.