Fix adding an option with label '0'

[mbijnsdorp]

Description (*)

When adding an option to an attribute programmatically via \Magento\Eav\Model\Entity\Attribute\OptionManagement::add, it's not possible to use the label '0' for the option.

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]

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

ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.

For more details, 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, 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

[mbijnsdorp]

@magento run all tests

[magento-automated-testing]

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

[mbijnsdorp]

@magento run Functional Tests B2B

[magento-automated-testing]

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

[ihor-sviziev]

Hi @mbijnsdorp,
Your changes look good to me.
Could you cover your changes with some automated tests?

[mbijnsdorp]

Hi @ihor-sviziev,
I'm inexperienced when it comes to writing tests. I could adjust the label of the add method https://github.com/magento/magento2/blob/2.4-develop/app/code/Magento/Eav/Test/Unit/Model/Entity/Attribute/OptionManagementTest.php#L68, but that wouldn't make it very obvious. Would you suggest a similar method to that one?

[eduard13]

Hi @mbijnsdorp, thank you for your contribution. The existing test you mentioned, is a good place to cover your case. I'd suggest adding a simple dataProvider, that will provide different options labels to the add method. Something like in the following Unit Test.

magento2/app/code/Magento/Customer/Test/Unit/Block/Widget/NameTest.php

Lines 179 to 211 in f3e8f25

	* @dataProvider methodDataProvider
	*/
	public function testMethodWithNoSuchEntityException($method): void
	{
	$this->customerMetadata->expects(
	$this->any()
	)->method(
	'getAttributeMetadata'
	)->willThrowException(
	new NoSuchEntityException(
	__(
	'No such entity with %fieldName = %fieldValue',
	['fieldName' => 'field', 'fieldValue' => 'value']
	)
	)
	);
	$this->assertFalse($this->_block->{$method}());
	}
	/**
	* @return array
	*/
	public function methodDataProvider(): array
	{
	return [
	'showPrefix' => ['showPrefix'],
	'isPrefixRequired' => ['isPrefixRequired'],
	'showMiddlename' => ['showMiddlename'],
	'isMiddlenameRequired' => ['isMiddlenameRequired'],
	'showSuffix' => ['showSuffix'],
	'isSuffixRequired' => ['isSuffixRequired']
	];
	}

Please let me know if you have any questions.

Thank you.

[mbijnsdorp]

Hi @eduard13, thank you for the pointers. I've updated the test with a data provider based on the given example. Please let me know if it requires any other changes.

[mbijnsdorp]

@magento run all tests

[magento-automated-testing]

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

[mbijnsdorp]

@magento run Unit Tests

[magento-automated-testing]

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

[mbijnsdorp]

@magento run all tests

[magento-automated-testing]

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

[ihor-sviziev]

@magento run Functional Tests CE, Functional Tests EE

[magento-automated-testing]

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

[ihor-sviziev]

@magento run all tests

[magento-automated-testing]

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

[mbijnsdorp]

@ihor-sviziev Could you also add the partner Youwe label?

[ihor-sviziev]

@sidolov @sivaschenko, could you check why the partner label wasn't applied?

[magento-automated-testing]

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

[ihor-sviziev]

@mbijnsdorp, great job! Thank you for your contribution!
✔ Approved

[magento-engcom-team]

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

[magento-engcom-team]

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

[sidolov]

@ihor-sviziev label wasn't added because @mbijnsdorp is not a part of Youwe team on the GitHub

[engcom-Dash]

✔️ QA Passed

Manual testing scenario:

1. Add the code to add product attribute manually with label ‘0’ at the listing page of product by adding a custom function addOption() in ListProduct.php block (app/code/Magento/Catalog/Block/Product/ListProduct.php) and calling the function on page in list.phtml (app/code/Magento/Catalog/view/frontend/templates/product/list.phtml) (screenshot below)

2. Run the code on the magento server

Before: ✖️ Exception is throwing with message ‘The attribute option label is empty. Enter the value and try again.’

After: ✔️ The code run successfully without expection.