Develop plugin declaration inspections #588
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| <!-- | ||
| /* | ||
| * Copyright © Magento, Inc. All rights reserved. | ||
| * See COPYING.txt for license details. | ||
| */ | ||
| --> | ||
| <html> | ||
| <body> | ||
| <p> | ||
| Validates if attribute `type` in the <plugin/> tag of di.xml files contains valid classes or interfaces | ||
| and that it cannot be empty. | ||
| </p> | ||
| <p>This inspection inspects: | ||
| <ul> | ||
| <li>The existence of the class on the specified path</li> | ||
| <li>Tag `type` is not empty</li> | ||
| </ul> | ||
| </body> | ||
| </html> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,114 @@ | ||||||
| /* | ||||||
| * Copyright © Magento, Inc. All rights reserved. | ||||||
| * See COPYING.txt for license details. | ||||||
| */ | ||||||
|
|
||||||
| package com.magento.idea.magento2plugin.inspections.xml; | ||||||
|
|
||||||
| import com.intellij.codeInspection.ProblemHighlightType; | ||||||
| import com.intellij.codeInspection.ProblemsHolder; | ||||||
| import com.intellij.codeInspection.XmlSuppressableInspectionTool; | ||||||
| import com.intellij.psi.PsiElement; | ||||||
| import com.intellij.psi.PsiElementVisitor; | ||||||
| import com.intellij.psi.PsiFile; | ||||||
| import com.intellij.psi.XmlElementVisitor; | ||||||
| import com.intellij.psi.xml.XmlAttribute; | ||||||
| import com.intellij.psi.xml.XmlTag; | ||||||
| import com.magento.idea.magento2plugin.bundles.InspectionBundle; | ||||||
| import com.magento.idea.magento2plugin.inspections.validator.InspectionValidator; | ||||||
| import com.magento.idea.magento2plugin.inspections.validator.NotEmptyValidator; | ||||||
| import com.magento.idea.magento2plugin.inspections.validator.PhpClassExistenceValidator; | ||||||
| import com.magento.idea.magento2plugin.magento.files.ModuleDiXml; | ||||||
| import org.jetbrains.annotations.NotNull; | ||||||
|
|
||||||
| public class PluginAttrTypeInspection extends XmlSuppressableInspectionTool { | ||||||
|
There was a problem hiding this comment.
Suggested change
Let's avoid such a shortening. |
||||||
|
|
||||||
| @Override | ||||||
| public @NotNull | ||||||
| PsiElementVisitor buildVisitor( | ||||||
| final @NotNull ProblemsHolder problemsHolder, | ||||||
| final boolean isOnTheFly | ||||||
| ) { | ||||||
| return new XmlElementVisitor() { | ||||||
|
|
||||||
| private final InspectionBundle inspectionBundle = new InspectionBundle(); | ||||||
| private final InspectionValidator phpClassExistenceValidator = | ||||||
| new PhpClassExistenceValidator(problemsHolder.getProject()); | ||||||
| private final InspectionValidator notEmptyValidator = new NotEmptyValidator(); | ||||||
|
|
||||||
| @Override | ||||||
| public void visitXmlTag(final XmlTag xmlTag) { | ||||||
| final PsiFile file = xmlTag.getContainingFile(); | ||||||
|
|
||||||
| if (!file.getName().equals(ModuleDiXml.FILE_NAME) | ||||||
| || !xmlTag.getName().equals(ModuleDiXml.PLUGIN_TAG_NAME)) { | ||||||
| return; | ||||||
| } | ||||||
|
|
||||||
| final XmlAttribute pluginTypeAttribute = | ||||||
| xmlTag.getAttribute(ModuleDiXml.TYPE_ATTR); | ||||||
|
|
||||||
| if (pluginTypeAttribute == null | ||||||
| || pluginTypeAttribute.getValue() == null | ||||||
| || pluginTypeAttribute.getValueElement() == null | ||||||
| || pluginTypeAttribute.getValueElement().getText().isEmpty()) { | ||||||
| return; | ||||||
| } | ||||||
|
|
||||||
| if (!notEmptyValidator.validate(pluginTypeAttribute.getValue())) { | ||||||
| reportCouldNotBeEmpty( | ||||||
| pluginTypeAttribute.getValueElement(), | ||||||
| pluginTypeAttribute.getName() | ||||||
| ); | ||||||
| } | ||||||
|
|
||||||
| if (!phpClassExistenceValidator.validate(pluginTypeAttribute.getValue())) { | ||||||
| reportClassDoesNotExists( | ||||||
| pluginTypeAttribute.getValueElement(), | ||||||
| pluginTypeAttribute.getValue() | ||||||
| ); | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Report Attribute Value could not be empty. | ||||||
| * | ||||||
| * @param psiElement PsiElement | ||||||
| * @param messageParams Object... | ||||||
| */ | ||||||
| private void reportCouldNotBeEmpty( | ||||||
| final @NotNull PsiElement psiElement, | ||||||
| final Object... messageParams | ||||||
| ) { | ||||||
| problemsHolder.registerProblem( | ||||||
| psiElement, | ||||||
| inspectionBundle.message( | ||||||
| "inspection.error.idAttributeCanNotBeEmpty", | ||||||
| messageParams | ||||||
| ), | ||||||
| ProblemHighlightType.ERROR | ||||||
| ); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Report class does not exists. | ||||||
| * | ||||||
| * @param psiElement PsiElement | ||||||
| * @param messageParams Object... | ||||||
| */ | ||||||
| private void reportClassDoesNotExists( | ||||||
| final @NotNull PsiElement psiElement, | ||||||
| final Object... messageParams | ||||||
| ) { | ||||||
| problemsHolder.registerProblem( | ||||||
| psiElement, | ||||||
| inspectionBundle.message( | ||||||
| "inspection.warning.class.does.not.exist", | ||||||
| messageParams | ||||||
| ), | ||||||
| ProblemHighlightType.WARNING | ||||||
| ); | ||||||
| } | ||||||
| }; | ||||||
| } | ||||||
| } | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| <?xml version="1.0"?> | ||
| <config> | ||
| <type name="Magento\CatalogSearch\Helper\Data"> | ||
| <plugin name="unique_plugin_name" type=""/> | ||
| </type> | ||
| </config> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| <?xml version="1.0"?> | ||
| <config> | ||
| <type name="Magento\CatalogSearch\Helper\Data"> | ||
| <plugin name="unique_plugin_name" type="Magento\Catalog\Plugin\PluginClass"/> | ||
| </type> | ||
| </config> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| <?xml version="1.0"?> | ||
| <config> | ||
| <type name="Magento\CatalogSearch\Helper\Data"> | ||
| <plugin name="unique_plugin_name" type="Not\Existent\Class"/> | ||
| </type> | ||
| </config> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| <?xml version="1.0"?> | ||
| <config> | ||
| <type name="Magento\CatalogSearch\Helper\Data"> | ||
| <plugin name="unique_plugin_name" type="Magento\Catalog\Plugin\PluginClass"/> | ||
| </type> | ||
| </config> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,89 @@ | ||||||
| /* | ||||||
| * Copyright © Magento, Inc. All rights reserved. | ||||||
| * See COPYING.txt for license details. | ||||||
| */ | ||||||
|
|
||||||
| package com.magento.idea.magento2plugin.inspections.xml; | ||||||
|
|
||||||
| import com.magento.idea.magento2plugin.magento.files.ModuleDiXml; | ||||||
|
|
||||||
| public class PluginAttrTypeInspectionTest extends InspectionXmlFixtureTestCase { | ||||||
|
|
||||||
| private static final String ARGUMENT_VALUE_IS_EMPTY = | ||||||
| "inspection.error.idAttributeCanNotBeEmpty"; | ||||||
| private static final String CLASS_DOES_NOT_EXIST = | ||||||
| "inspection.warning.class.does.not.exist"; | ||||||
| private static final String EXISTENT_CLASS = | ||||||
| "Magento\\Catalog\\Plugin\\PluginClass"; | ||||||
| private static final String NOT_EXISTENT_CLASS = | ||||||
| "Not\\Existent\\Class"; | ||||||
|
|
||||||
| @Override | ||||||
| public void setUp() throws Exception { | ||||||
| super.setUp(); | ||||||
| myFixture.enableInspections(PluginAttrTypeInspection.class); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Test for an error for the "type" attribute because it is empty. | ||||||
| * <plugin name="unique_plugin_name" type=""/> | ||||||
| */ | ||||||
| public void testAttrArgTypeValueIsEmpty() { | ||||||
| configureFixture(); | ||||||
|
|
||||||
| final String forAttrIsEmptyMessage = inspectionBundle.message( | ||||||
| ARGUMENT_VALUE_IS_EMPTY, | ||||||
| ModuleDiXml.TYPE_ATTR | ||||||
| ); | ||||||
|
|
||||||
| assertHasHighlighting(forAttrIsEmptyMessage); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Test for an no error for the "type" attribute because this class exists. | ||||||
|
There was a problem hiding this comment. Test for no error for the "type" attribute because this class exists.
Suggested change
|
||||||
| * <plugin name="unique_plugin_name" type="Magento\Catalog\Plugin\PluginClass" /> | ||||||
| */ | ||||||
| public void testAttrTypeClassExists() { | ||||||
| configureFixture(); | ||||||
|
|
||||||
| final String typeAttrIsEmptyMessage = inspectionBundle.message( | ||||||
| ARGUMENT_VALUE_IS_EMPTY, | ||||||
| ModuleDiXml.TYPE_ATTR | ||||||
| ); | ||||||
|
|
||||||
| assertHasNoHighlighting(typeAttrIsEmptyMessage); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Test for throwing an error for a class that does not exist for the "type" attribute. | ||||||
| */ | ||||||
| public void testClassAttrTypeDoesNotExists() { | ||||||
| configureFixture(); | ||||||
|
|
||||||
| final String forClassDoesNotExists = inspectionBundle.message( | ||||||
| CLASS_DOES_NOT_EXIST, | ||||||
| NOT_EXISTENT_CLASS | ||||||
| ); | ||||||
|
|
||||||
| assertHasHighlighting(forClassDoesNotExists); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Test for the absence of an error in the presence of | ||||||
| * classes or interfaces specified for plugins. | ||||||
| */ | ||||||
| public void testClassAttrTypeIsExist() { | ||||||
| configureFixture(); | ||||||
|
|
||||||
| final String classOneExists = inspectionBundle.message( | ||||||
| CLASS_DOES_NOT_EXIST, | ||||||
| EXISTENT_CLASS | ||||||
| ); | ||||||
|
|
||||||
| assertHasNoHighlighting(classOneExists); | ||||||
| } | ||||||
|
|
||||||
| private void configureFixture() { | ||||||
| myFixture.configureByFile(getFixturePath(ModuleDiXml.FILE_NAME)); | ||||||
| } | ||||||
| } | ||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed