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

Integration Tests Fail with Local PHP Binary in Paths Containing Spaces #38707

Open
1 of 5 tasks
DavidLambauer opened this issue May 8, 2024 · 6 comments
Open
1 of 5 tasks
Labels
Area: Framework Component: Integration Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: ready for dev Reported on 2.4.7 Indicates original Magento version for the Issue report. Reproduced on 2.4.x The issue has been reproduced on latest 2.4-develop branch Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it

Comments

@DavidLambauer
Copy link
Contributor

Preconditions and environment

When attempting to run integration tests using a local PHP binary located in a path containing spaces, the command fails to execute and produces a "No such file or directory" error. The issue arises due to the lack of escaping for spaces in file paths, specifically when passthru() is used in \Magento\Developer\Console\Command\DevTestsRunCommand.

Preconditions:

Magento 2.4.7 installed.

Local PHP binary path includes spaces, e.g., /Users/MYUSER/Library/Application Support/myphp/bin/php81.
Running command php bin/magento dev:tests:run integration.

Steps to reproduce

Ensure the local PHP binary path contains a space. You can check with php -r "echo PHP_BINARY;"
Execute the command: php bin/magento dev:tests:run integration.
Observe the failure in the command line output indicating "No such file or directory".

Expected result

The integration tests should run without errors, regardless of spaces in the PHP binary path.

Actual result

---- /Users/PATH_TO_PROJECT/dev/tests/integration> /Users/MYUSER/Library/Application Support/....../bin/php81 /Users/MYUSER/......./vendor/phpunit/phpunit/phpunit

sh: /Users/MYUSER/Library/Application: No such file or directory
----------------------------------------------------------------------
FAILED - 1 of 1:
 - /Users/MYUSER/........../dev/tests/integration> /Users/MYUSER/Library/Application Support/......./bin/php81 /Users/MYUSER/.........././vendor/phpunit/phpunit/phpunit

Additional information

Technical Details

The error occurs in Magento\Developer\Console\Command\DevTestsRunCommand, line 111:

passthru($command, $returnVal);

There is no prior validation or escaping of the command string to handle spaces in file paths.

Possible Solution

Replace passthru() with \Symfony\Component\Process\Process to handle command execution. This component properly escapes command line arguments and can manage spaces in paths more reliably.

Example of Problematic Usage

/tmp/my spaced dir/php bin/magento dev:tests:run integration

Additional Information

This issue only occurs when paths include spaces and using passthru() or exec() for command execution. Utilizing \Symfony\Component\Process\Process would mitigate this issue by providing more robust command line handling capabilities.

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”.
Copy link

m2-assistant bot commented May 8, 2024

Hi @DavidLambauer. 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. To deploy vanilla Magento instance on our environment, Add a comment to the issue:


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-community-project m2-community-project bot added this to Ready for Confirmation in Issue Confirmation and Triage Board May 8, 2024
@engcom-Bravo engcom-Bravo added Reported on 2.4.7 Indicates original Magento version for the Issue report. Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it labels May 8, 2024
@engcom-November engcom-November self-assigned this May 9, 2024
Copy link

m2-assistant bot commented May 9, 2024

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- Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
    - 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
Copy link
Contributor

Hello @DavidLambauer,

Thank you for the report and colaboration!

Verified this issue on 2.4-develop and 2.4.7 instance.
If PHP binary path contains space, the php bin/magento dev:tests:run integration command throws a "No such file or directory" error.
Please take a look at the screenshot below:
image

Hence confirming the issue.

Thank you.

@engcom-November engcom-November added Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Component: Integration Reproduced on 2.4.x The issue has been reproduced on latest 2.4-develop branch Area: Framework labels May 9, 2024
@m2-community-project m2-community-project bot moved this from Ready for Confirmation to Confirmed in Issue Confirmation and Triage Board May 9, 2024
@github-jira-sync-bot
Copy link

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

Copy link

m2-assistant bot commented May 9, 2024

✅ Confirmed by @engcom-November. Thank you for verifying the issue.
Issue Available: @engcom-November, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.

@engcom-November engcom-November added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label May 9, 2024
@m2-community-project m2-community-project bot added this to Ready for Development in High Priority Backlog May 9, 2024
@DavidLambauer
Copy link
Contributor Author

Here is another occupancy of the issue. This time using exec, not passthru

\Magento\Framework\Shell::execute

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Framework Component: Integration Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: ready for dev Reported on 2.4.7 Indicates original Magento version for the Issue report. Reproduced on 2.4.x The issue has been reproduced on latest 2.4-develop branch Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it
Projects
High Priority Backlog
  
Ready for Development
Development

No branches or pull requests

4 participants