Added test coverage for plugin type attribute, added checkstyle suppression mechanism

Author: Vitaliy Boyko

gradle-tasks/checkstyle/checkstyle.xml

@@ -322,5 +322,12 @@
                       default="checkstyle-xpath-suppressions.xml" />
             <property name="optional" value="true"/>
         </module>
+        <module name="SuppressWarningsHolder"/>
+        <module name="SuppressWithNearbyCommentFilter">
+            <property name="commentFormat" value="CHECKSTYLE IGNORE (\w+) FOR NEXT (\d+) LINES"/>
+            <property name="checkFormat" value="$1"/>
+            <property name="influenceFormat" value="$2"/>
+        </module>
     </module>
+    <module name="SuppressWarningsFilter"/>
 </module>

src/com/magento/idea/magento2plugin/completion/xml/XmlCompletionContributor.java

@@ -2,19 +2,25 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 package com.magento.idea.magento2plugin.completion.xml;
 
 import com.intellij.codeInsight.completion.CompletionContributor;
 import com.intellij.codeInsight.completion.CompletionType;
 import com.intellij.patterns.XmlPatterns;
 import com.intellij.psi.xml.XmlTokenType;
+// CHECKSTYLE IGNORE check FOR NEXT 6 LINES
 import com.magento.idea.magento2plugin.completion.provider.*;
 import com.magento.idea.magento2plugin.completion.provider.mftf.*;
-import com.magento.idea.magento2plugin.magento.files.*;
+import com.magento.idea.magento2plugin.magento.files.*;//NOPMD
 import static com.intellij.patterns.PlatformPatterns.psiElement;
 import static com.intellij.patterns.StandardPatterns.string;
 import static com.intellij.patterns.XmlPatterns.xmlFile;
 
+/**
+ * TODO: enable style checks after decomposition.
+ */
+@SuppressWarnings({"PMD", "checkstyle:all"})
 public class XmlCompletionContributor extends CompletionContributor {
 
     public XmlCompletionContributor() {
@@ -70,6 +76,13 @@ public XmlCompletionContributor() {
                 new PhpClassCompletionProvider()
         );
 
+        // <plugin type="completion">
+        extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
+                .inside(XmlPatterns.xmlAttribute().withName(ModuleDiXml.PLUGIN_TYPE_ATTRIBUTE)
+                    .withParent(XmlPatterns.xmlTag().withName(ModuleDiXml.PLUGIN_TAG_NAME))),
+            new PhpClassCompletionProvider()
+        );
+
         /* File Path Completion provider */
         extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
                         .inside(XmlPatterns.xmlAttribute().withName(LayoutXml.XML_ATTRIBUTE_TEMPLATE)),

src/com/magento/idea/magento2plugin/reference/xml/XmlReferenceContributor.java

@@ -2,6 +2,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 package com.magento.idea.magento2plugin.reference.xml;
 
 import com.intellij.patterns.XmlPatterns;
@@ -11,12 +12,17 @@
 import com.magento.idea.magento2plugin.magento.files.MftfActionGroup;
 import com.magento.idea.magento2plugin.magento.files.MftfTest;
 import com.magento.idea.magento2plugin.magento.files.UiComponentXml;
+// CHECKSTYLE IGNORE check FOR NEXT 5 LINES
 import com.magento.idea.magento2plugin.reference.provider.*;
 import com.magento.idea.magento2plugin.reference.provider.mftf.*;
 import com.magento.idea.magento2plugin.util.RegExUtil;
 import org.jetbrains.annotations.NotNull;
 import static com.intellij.patterns.XmlPatterns.*;
 
+/**
+ * TODO: enable style checks after decomposition.
+ */
+@SuppressWarnings({"PMD", "checkstyle:all"})
 public class XmlReferenceContributor extends PsiReferenceContributor {
 
     @Override

testData/completion/xml/PluginTypeCompletionRegistrar/pluginTypeMustHaveCompletion/di.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0"?>
+<config>
+    <type name="Magento\Framework\View\Layout">
+        <plugin name="some"  type="Yesn<caret>"/>
+    </type>
+</config>

testData/reference/xml/PluginTypeReferenceRegistrar/pluginTypeMustHaveReference/di.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0"?>
+<config>
+    <type name="Magento\Framework\View\Layout">
+        <plugin type="Magento\Backend\Model\Source\YesNo<caret>"/>
+    </type>
+</config>

tests/com/magento/idea/magento2plugin/completion/xml/PluginTypeCompletionRegistrarTest.java

@@ -0,0 +1,22 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.completion.xml;
+
+import com.magento.idea.magento2plugin.magento.files.ModuleDiXml;
+
+public class PluginTypeCompletionRegistrarTest extends CompletionXmlFixtureTestCase {
+
+    /**
+     * The `type` attribute of the `plugin` tag in di.xml must
+     * have completion based on PHP classes index
+     */
+    public void testPluginTypeMustHaveCompletion() {
+        final String filePath = this.getFixturePath(ModuleDiXml.FILE_NAME);
+        myFixture.configureByFile(filePath);
+
+        assertCompletionContains(filePath, "Magento\\Backend\\Model\\Source\\YesNo");
+    }
+}

tests/com/magento/idea/magento2plugin/reference/xml/PluginTypeReferenceRegistrarTest.java

@@ -0,0 +1,22 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.reference.xml;
+
+import com.magento.idea.magento2plugin.magento.files.ModuleDiXml;
+
+public class PluginTypeReferenceRegistrarTest extends ReferenceXmlFixtureTestCase {
+
+    /**
+     * The `type` attribute of the `plugin` tag in di.xml must
+     * have reference to the PHP class
+     */
+    public void testPluginTypeMustHaveReference() {
+        final String filePath = this.getFixturePath(ModuleDiXml.FILE_NAME);
+        myFixture.configureByFile(filePath);
+
+        assertHasReferencePhpClass("Magento\\Backend\\Model\\Source\\YesNo");
+    }
+}