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

Ignore all .phpunit.result.cache files in the dev/tests directory #34361

Merged

Conversation

hostep
Copy link
Contributor

@hostep hostep commented Oct 17, 2021

Description (*)

When following the instructions for running the functional graphql tests, you'll notice that afterwards your git status is dirty. Because the file dev/tests/api-functional/.phpunit.result.cache gets generated by running those tests. So we should ignore that file in git.

Related Pull Requests

Fixed Issues (if relevant)

None

Manual testing scenarios (*)

  1. Follow the instructions for running the functional graphql tests (you might need a workaround mentioned over here to get it working)
  2. Not expecting the git status to be dirty

Note for the release notes writers

This doesn't deserve mentioning in the release notes, as it doesn't fix something that users of Magento run into.

Questions or comments

Contribution checklist (*)

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/integration tests (if applicable)
  • README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
  • All automated tests passed successfully (all builds are green)

@m2-assistant
Copy link

m2-assistant bot commented Oct 17, 2021

Hi @hostep. Thank you for your contribution
Here are some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

  • @magento give me test instance - deploy test instance based on PR changes
  • @magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

  • @magento run all tests - run or re-run all required tests against the PR changes
  • @magento run <test-build(s)> - run or re-run specific test build(s)
    For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE,
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. Semantic Version Checker

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

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

⚠️ According to the Magento Contribution requirements, all Pull Requests 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 Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

@magento-engcom-team
Copy link
Contributor

Hi @ihor-sviziev, thank you for the review.
ENGCOM-9261 has been created to process this Pull Request
✳️ @ihor-sviziev, could you please add one of the following labels to the Pull Request?

Label Description
Auto-Tests: Covered All changes in Pull Request is covered by auto-tests
Auto-Tests: Not Covered Changes in Pull Request requires coverage by auto-tests
Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests

@ihor-sviziev ihor-sviziev added the Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests label Oct 18, 2021
@m2-community-project m2-community-project bot added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Oct 18, 2021
@ihor-sviziev
Copy link
Contributor

No manual testing required

@m2-community-project m2-community-project bot moved this from Ready for Testing to Merge in Progress in High Priority Pull Requests Dashboard Oct 18, 2021
@ihor-sviziev ihor-sviziev added the Severity: S4 Affects aesthetics, professional look and feel, “quality” or “usability”. label Oct 18, 2021
@m2-community-project m2-community-project bot moved this from Merge in Progress to Ready for Testing in High Priority Pull Requests Dashboard Oct 18, 2021
@m2-community-project m2-community-project bot moved this from Ready for Testing to Merge in Progress in High Priority Pull Requests Dashboard Oct 18, 2021
@ihor-sviziev
Copy link
Contributor

@hostep,
I also got the same thing for unit tests. Could you check it for other test types and add it to .gitignore as well?

@hostep
Copy link
Contributor Author

hostep commented Oct 21, 2021

Hmm, then maybe we should add a more global .gitignore file in the dev/tests directory which ignores all .phpunit.result.cache files in all subdirectories?

@ihor-sviziev
Copy link
Contributor

@hostep I think it's great idea!

… they get created by at least the static, unit and graphql functional tests).
@hostep hostep force-pushed the extra-phpunit-file-to-ignore branch from 5d25345 to f884c5c Compare October 21, 2021 11:35
@hostep
Copy link
Contributor Author

hostep commented Oct 21, 2021

Okay, done!

@hostep hostep changed the title Ignore .phpunit.result.cache file that gets generated by the graphql … Ignore all .phpunit.result.cache files in the dev/tests directory Oct 21, 2021
@m2-community-project m2-community-project bot moved this from Merge in Progress to Ready for Testing in High Priority Pull Requests Dashboard Oct 21, 2021
@magento-engcom-team
Copy link
Contributor

Hi @ihor-sviziev, thank you for the review.
ENGCOM-9261 has been created to process this Pull Request

@ihor-sviziev
Copy link
Contributor

ihor-sviziev commented Oct 22, 2021

Just tested locally - everything works fine.

✔ QA passed

Before

❌On the 2.4-develop branch the output of git status:

On branch 2.4-develop
Your branch is up to date with 'origin/2.4-develop'.

Untracked files:
  (use "git add <file>..." to include in what will be committed)
        .env
        dev/tests/acceptance/.phpunit.result.cache
        dev/tests/api-functional/.phpunit.result.cache
        dev/tests/integration/.phpunit.result.cache
        dev/tests/setup-integration/.phpunit.result.cache
        dev/tests/unit/.phpunit.result.cache

nothing added to commit but untracked files present (use "git add" to track)

After

✔ On the extra-phpunit-file-to-ignore (PR) branch the output of git status:

On branch extra-phpunit-file-to-ignore
Untracked files:
  (use "git add <file>..." to include in what will be committed)
        .env

nothing added to commit but untracked files present (use "git add" to track)

Note: Locally I have the .env file, so it's not related to this PR.

@m2-community-project m2-community-project bot moved this from Ready for Testing to Merge in Progress in High Priority Pull Requests Dashboard Oct 22, 2021
@magento-engcom-team magento-engcom-team merged commit 1525ae1 into magento:2.4-develop Oct 23, 2021
@m2-assistant
Copy link

m2-assistant bot commented Oct 23, 2021

Hi @hostep, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

@sidolov sidolov moved this from Merge in Progress to Recently Merged in High Priority Pull Requests Dashboard Oct 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: accept Release Line: 2.4 Severity: S4 Affects aesthetics, professional look and feel, “quality” or “usability”.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants