Merge pull request #390 from drpayyne/tests-03

coderimus · web-flow · commit 9046134e4580 · 2020-11-19T09:52:47.000+02:00
Added test coverage for EventNameReferenceProvider
diff --git a/src/com/magento/idea/magento2plugin/reference/provider/EventNameReferenceProvider.java b/src/com/magento/idea/magento2plugin/reference/provider/EventNameReferenceProvider.java
@@ -2,6 +2,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 package com.magento.idea.magento2plugin.reference.provider;
 
 import com.intellij.openapi.util.text.StringUtil;
@@ -15,52 +16,63 @@
 import com.intellij.util.indexing.FileBasedIndex;
 import com.jetbrains.php.lang.PhpFileType;
 import com.jetbrains.php.lang.psi.PhpFile;
-import com.magento.idea.magento2plugin.util.php.PhpPatternsHelper;
 import com.magento.idea.magento2plugin.reference.xml.PolyVariantReferenceBase;
 import com.magento.idea.magento2plugin.stubs.indexes.EventNameIndex;
-import org.jetbrains.annotations.NotNull;
-
+import com.magento.idea.magento2plugin.util.php.PhpPatternsHelper;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
+import org.jetbrains.annotations.NotNull;
 
 public class EventNameReferenceProvider  extends PsiReferenceProvider {
 
     @NotNull
     @Override
-    public PsiReference[] getReferencesByElement(@NotNull PsiElement element, @NotNull ProcessingContext context) {
-        String value = StringUtil.unquoteString(element.getText());
-        Collection<VirtualFile> containingFiles = FileBasedIndex.getInstance()
-            .getContainingFiles(EventNameIndex.KEY, value,
-                    GlobalSearchScope.getScopeRestrictedByFileTypes(
-                            GlobalSearchScope.allScope(element.getProject()),
-                            PhpFileType.INSTANCE
-                    )
-            );
+    public PsiReference[] getReferencesByElement(
+            @NotNull final PsiElement element,
+            @NotNull final ProcessingContext context
+    ) {
+        final String value = StringUtil.unquoteString(element.getText());
+        final List<PsiReference> psiReferences = new ArrayList<>();
+        final Collection<VirtualFile> containingFiles = FileBasedIndex.getInstance()
+                .getContainingFiles(
+                        EventNameIndex.KEY,
+                        value,
+                        GlobalSearchScope.getScopeRestrictedByFileTypes(
+                                GlobalSearchScope.allScope(element.getProject()),
+                                PhpFileType.INSTANCE
+                        )
+                );
 
-        PsiManager psiManager = PsiManager.getInstance(element.getProject());
-        for (VirtualFile virtualFile: containingFiles) {
-            PhpFile phpFile = (PhpFile) psiManager.findFile(virtualFile);
+        final PsiManager psiManager = PsiManager.getInstance(element.getProject());
+        final List<PsiElement> psiElements = new ArrayList<>();
+        for (final VirtualFile virtualFile: containingFiles) {
+            final PhpFile phpFile = (PhpFile) psiManager.findFile(virtualFile);
             if (phpFile != null) {
-                List<PsiElement> psiElements = new ArrayList<>();
                 recursiveFill(psiElements, phpFile, value);
-                if (psiElements.size() > 0) {
-                    return new PsiReference[] {new PolyVariantReferenceBase(element, psiElements)};
+                if (!psiElements.isEmpty()) {
+                    psiReferences.add(new PolyVariantReferenceBase(element, psiElements));//NOPMD
+                    break;
                 }
             }
         }
-        return PsiReference.EMPTY_ARRAY;
+
+        return psiReferences.toArray(new PsiReference[0]);
     }
 
-    private void recursiveFill(List<PsiElement> psiElements, PsiElement psiElement, String typeName) {
+    private void recursiveFill(
+            final List<PsiElement> psiElements,
+            final PsiElement psiElement,
+            final String typeName
+    ) {
         if (PhpPatternsHelper.STRING_METHOD_ARGUMENT.accepts(psiElement)) {
             if (StringUtil.unquoteString(psiElement.getText()).equals(typeName)) {
                 psiElements.add(psiElement);
             }
             return;
         }
 
-        for (PsiElement child: psiElement.getChildren()) {
+        for (final PsiElement child: psiElement.getChildren()) {
             recursiveFill(psiElements, child, typeName);
         }
     }
diff --git a/testData/reference/xml/ObserverReferenceRegistrar/eventNameMustHaveReference/events.xml b/testData/reference/xml/ObserverReferenceRegistrar/eventNameMustHaveReference/events.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ /**
+  * Copyright © Magento, Inc. All rights reserved.
+  * See COPYING.txt for license details.
+  */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
+    <event name="test_event_in_block<caret>">
+        <observer name="test_observer" instance="Magento\Catalog\Observer\TestObserver" />
+    </event>
+</config>
diff --git a/testData/reference/xml/ObserverReferenceRegistrar/eventNameMustNotHaveReference/events.xml b/testData/reference/xml/ObserverReferenceRegistrar/eventNameMustNotHaveReference/events.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ /**
+  * Copyright © Magento, Inc. All rights reserved.
+  * See COPYING.txt for license details.
+  */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
+    <event name="invalid_event<caret>">
+        <observer name="test_observer" instance="Magento\Catalog\Observer\TestObserver" />
+    </event>
+</config>
diff --git a/testData/reference/xml/ObserverReferenceRegistrar/observerInstanceMustHaveReference/events.xml b/testData/reference/xml/ObserverReferenceRegistrar/observerInstanceMustHaveReference/events.xml
diff --git a/tests/com/magento/idea/magento2plugin/reference/BaseReferenceTestCase.java b/tests/com/magento/idea/magento2plugin/reference/BaseReferenceTestCase.java
@@ -5,6 +5,7 @@
 
 package com.magento.idea.magento2plugin.reference;
 
+import com.intellij.openapi.util.text.StringUtil;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiFile;
 import com.intellij.psi.PsiReference;
@@ -15,12 +16,16 @@
 import com.intellij.psi.xml.XmlTag;
 import com.jetbrains.php.lang.psi.elements.Method;
 import com.jetbrains.php.lang.psi.elements.Parameter;
+import com.jetbrains.php.lang.psi.elements.ParameterList;
 import com.jetbrains.php.lang.psi.elements.PhpClass;
 import com.magento.idea.magento2plugin.inspections.BaseInspectionsTestCase;
 import com.magento.idea.magento2plugin.magento.packages.File;
 import com.magento.idea.magento2plugin.reference.xml.PolyVariantReferenceBase;
 import org.jetbrains.annotations.Nullable;
 
+@SuppressWarnings({
+        "PMD.TooManyMethods",
+})
 public abstract class BaseReferenceTestCase extends BaseInspectionsTestCase {
     private static final String testDataFolderPath = "testData" + File.separator//NOPMD
             + "reference" + File.separator;
@@ -204,6 +209,23 @@ protected void assertHasReferenceToClassMethod(
         );
     }
 
+    protected void assertHasReferenceToMethodArgument(final String argument) {
+        final PsiReference[] references = getElementFromCaret().getReferences();
+        final String actualArgument
+                = StringUtil.unquoteString(references[references.length - 1].resolve().getText());
+        final PsiElement parameterList = references[0].resolve().getParent();
+
+        if (!(parameterList instanceof ParameterList)) {
+            fail("Element doesn't have a reference to a method parameter");
+        }
+
+        assertEquals(
+                "Event dispatch argument",
+                argument,
+                actualArgument
+        );
+    }
+
     protected void assertEmptyReference() {
         final PsiElement element = getElementFromCaret();
         assertEmpty(element.getReferences());
diff --git a/tests/com/magento/idea/magento2plugin/reference/xml/ObserverReferenceRegistrarTest.java b/tests/com/magento/idea/magento2plugin/reference/xml/ObserverReferenceRegistrarTest.java
@@ -2,16 +2,37 @@
  * 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.ModuleEventsXml;
 
 public class ObserverReferenceRegistrarTest extends ReferenceXmlFixtureTestCase {
 
-    public void testEventsXmlMustHaveReference() {
-        String filePath = this.getFixturePath(ModuleEventsXml.FILE_NAME);
-        myFixture.configureByFile(filePath);
+    /**
+     * Tests for observer instance reference in events.xml.
+     */
+    public void testObserverInstanceMustHaveReference() {
+        myFixture.configureByFile(this.getFixturePath(ModuleEventsXml.FILE_NAME));
 
         assertHasReferencePhpClass("Magento\\Catalog\\Observer\\TestObserver");
     }
+
+    /**
+     * Tests for event name reference in events.xml.
+     */
+    public void testEventNameMustHaveReference() {
+        myFixture.configureByFile(this.getFixturePath(ModuleEventsXml.FILE_NAME));
+
+        assertHasReferenceToMethodArgument("test_event_in_block");
+    }
+
+    /**
+     * Tests for no event name reference in events.xml.
+     */
+    public void testEventNameMustNotHaveReference() {
+        myFixture.configureByFile(this.getFixturePath(ModuleEventsXml.FILE_NAME));
+
+        assertEmptyReference();
+    }
 }
