Unit Test / Deprecate / ObjectManager Helper

[lbajsarowicz]

Description (*)

During the Magento 1 to Magento 2 migration, the rush around forced Magento developers to make some compromises.
Last month we finally said Good Bye to Magento 1, but we still fight against the legacy we inherited.

One of the Ancient Artifacts is \Magento\Framework\TestFramework\Unit\Helper\ObjectManager which purpose was to mock all the dependencies that were not necessary to mock for specific Unit Tests. That enabled developers to introduce ugly classes with a few of dependencies.

In my personal opinion 2020 is about the time to stop this ridiculous practice and give up with using ObjectManager for instantiating classes under test and replace that with new keyword in Unit Tests.

Reason behind it

1. Need for mocking all the dependencies will make Developer think twice before introducing another few of dependencies.
2. Introducing new backwards-incompatible dependency to the class will result in Unit Tests failure, thus will point out Developer that he introduced the backwards-incompatible change.
3. ObjectManager hides the ugly complexity of Magento classes.

Related Pull Requests

N/A

Fixed Issues (if relevant)

PR makes an ugly world of Magento Unit Tests a slightly better place.

Manual testing scenarios (*)

N/A

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)
• All automated tests passed successfully (all builds are green)

Resolved issues:

1. resolves [Issue] Unit Test / Deprecate / ObjectManager Helper #29346: Unit Test / Deprecate / ObjectManager Helper

[m2-assistant]

Hi @lbajsarowicz. Thank you for your contribution
Here is 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

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

[ihor-sviziev]

@lbajsarowicz looks good! Could you double check why static test fails?

[lbajsarowicz]

@magento run all tests

The Static Tests were failing due to reference to non-existing classes.

[magento-engcom-team]

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

[engcom-Delta]

Notice: QA not applicable

[engcom-Delta]

@magento create issue

[m2-assistant]

Hi @lbajsarowicz, 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.