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.

Sign up for GitHub

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

Jump to bottom

magento/web-api-test-recursive-array-comparison #29458

Merged
merged 2 commits into from
Aug 19, 2020
Merged

magento/web-api-test-recursive-array-comparison #29458

merged 2 commits into from
Aug 19, 2020

Conversation

bricht
Copy link

@bricht bricht commented Aug 10, 2020 •
edited by m2-assistant bot
Loading

Description (*)

This pull request adds a function to \Magento\TestFramework\TestCase\WebapiAbstract to enable comparing large nested arrays of expected and actual outcomes in tests. It also means we're able to ignore irrelevant keys in the actual outcome, unlike with \PHPUnit\Framework\Assert::assertEquals().

Related Pull Requests

N/A

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)

Questions or comments

This currently resides in GraphQlAbstract override on magento/catalog-storefront. But it would be useful in other tests as well.

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] magento/web-api-test-recursive-array-comparison #29498: magento/web-api-test-recursive-array-comparison

magento/web-api-test-recursive-array-comparison
9cf55e5 
-Added a function to WebApi Test framework for recursively comparing two arrays
-Modified CategoryManagementTest to remove need for array_replace_recursive
@m2-assistant
Copy link

m2-assistant bot commented Aug 10, 2020

Hi @bricht. 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

@bricht
Copy link
Author

bricht commented Aug 10, 2020

@magento run all tests

rogyar
rogyar reviewed Aug 10, 2020
View reviewed changes
dev/tests/api-functional/framework/Magento/TestFramework/TestCase/WebapiAbstract.php Outdated
* @param array $actual
* @return array
*/
public function compareArraysRecursively(array $expected, array $actual): array
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the idea but I would stand against feeding such a big monster as WebapiAbstract.php once again. Instead, I would suggest creating a separate class like Magento\TestFramework\Helper\CompareArraysRecursively with the only one public method (let's say execute) and use this class when necessary instead of the abstract methods.

@sivaschenko what do you think about this idea?

Thank you!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with @rogyar.
Moreover, this functionality could be useful for other types of tests (e.g. Integration).

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved the function as suggested.

@ghost ghost assigned rogyar and swnsma Aug 10, 2020
magento/web-api-test-recursive-array-comparison
289af76 
    -Added a function to TestFramework for comparing two arrays recursively.
@bricht
Copy link
Author

bricht commented Aug 12, 2020

@magento run all tests

@m2-assistant m2-assistant bot mentioned this pull request Aug 12, 2020
Closed
8 tasks
@ghost ghost added Priority: P3 May be fixed according to the position in the backlog. Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround. labels Aug 12, 2020
@rogyar rogyar added the Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests label Aug 13, 2020
@magento-engcom-team
Copy link
Contributor

Hi @rogyar, thank you for the review.
ENGCOM-8009 has been created to process this Pull Request

@magento-engcom-team
Copy link
Contributor

@bricht thank you for contributing. Please accept Community Contributors team invitation here to gain extended permissions for this repository.

@engcom-Alfa engcom-Alfa self-assigned this Aug 14, 2020
@engcom-Alfa
Copy link
Contributor

QA not applicable

@engcom-Charlie engcom-Charlie self-assigned this Aug 14, 2020
@engcom-Charlie engcom-Charlie added Auto-Tests: Covered All changes in Pull Request is covered by auto-tests QA: Ready to add to Regression Scope Should be analyzed and added to Regression Testing Scope(if applicable) and removed Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests labels Aug 17, 2020
@bricht bricht mentioned this pull request Aug 17, 2020
Merged
4 tasks
@engcom-Alfa engcom-Alfa added QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope and removed QA: Ready to add to Regression Scope Should be analyzed and added to Regression Testing Scope(if applicable) labels Aug 18, 2020
magento-engcom-team pushed a commit that referenced this pull request Aug 19, 2020
@gabrieldagama
ENGCOM-8009: magento/web-api-test-recursive-array-comparison #29458
04b9633
@magento-engcom-team magento-engcom-team merged commit 0c64ec8 into magento:2.4-develop Aug 19, 2020
@m2-assistant
Copy link

m2-assistant bot commented Aug 19, 2020

Hi @bricht, 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 added this to the 2.4.2 milestone Aug 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@swnsma swnsma swnsma left review comments

@rogyar rogyar rogyar approved these changes

Assignees

@rogyar rogyar

@swnsma swnsma

@engcom-Alfa engcom-Alfa

@engcom-Charlie engcom-Charlie

Labels
Auto-Tests: Covered All changes in Pull Request is covered by auto-tests Priority: P3 May be fixed according to the position in the backlog. Progress: accept QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope Release Line: 2.4 Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround.
Projects
Pull Requests Dashboard
Archived in project
Milestone
2.4.2
Development

Successfully merging this pull request may close these issues.

[Issue] magento/web-api-test-recursive-array-comparison
7 participants
@bricht @magento-engcom-team @engcom-Alfa @rogyar @swnsma @sidolov @engcom-Charlie