Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Improvement]: Insert right autoload path in Application Testing Documentation #17004

Open
sl0wlydeadly opened this issue Apr 30, 2024 · 1 comment

Comments

@sl0wlydeadly
Copy link

Improvement description

Description

In the Application Testing section of the Pimcore documentation there is a discrepancy between the _bootstrap.php and the functional.suite.yml code examples.
The autoloader for the first has the following path

PIMCORE_PROJECT_ROOT . '/vendor/pimcore/pimcore/tests/Support'

mapped to:

'Pimcore\Tests'

But then in the functional.suite.yml example the Helper is called like this:

\Pimcore\Tests\Support\Helper\Pimcore:

Instead of this:

\Pimcore\Tests\Helper\Pimcore:

which is a small detail but can save a lot of time and research for copy pasters like myself.

Generally I would prefer to have 'Pimcore\Tests' mapped to PIMCORE_PROJECT_ROOT . '/vendor/pimcore/pimcore/tests instead of PIMCORE_PROJECT_ROOT . '/vendor/pimcore/pimcore/tests/Support'

Suggestions

I would also like to suggest removing

- \Tests\Support\Helper\Functional:

From the functional.suite.yml code example since it does not exist and is not being generated.

And I think functional.suite.yml should be renamed to Functional.suite.yml as it being generated and mentioned in the Codeception documentation.

Sources

  • Pimcore Application Testing Documentation:
https://pimcore.com/docs/platform/Pimcore/Development_Tools_and_Details/Testing/Application_Testing
  • Codeception Functional Suite Documentation:
https://codeception.com/docs/FunctionalTests

Screenshots

Bildschirmfoto 2024-04-30 um 11 52 19

Bildschirmfoto 2024-04-30 um 11 51 21

Copy link

Thanks a lot for reporting the issue. We did not consider the issue as "Pimcore:Priority", "Pimcore:ToDo" or "Pimcore:Backlog", so we're not going to work on that anytime soon. Please create a pull request to fix the issue if this is a bug report. We'll then review it as quickly as possible. If you're interested in contributing a feature, please contact us first here before creating a pull request. We'll then decide whether we'd accept it or not. Thanks for your understanding.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant