Added test coverage for EventNameReferenceProvider

Author: drpayyne

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>

testData/reference/xml/ObserverReferenceRegistrar/eventsXmlMustHaveReference/events.xml renamed to testData/reference/xml/ObserverReferenceRegistrar/observerInstanceMustHaveReference/events.xml

@@ -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,6 +16,7 @@
 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;
@@ -204,6 +206,22 @@ 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());

tests/com/magento/idea/magento2plugin/reference/BaseReferenceTestCase.java

@@ -2,16 +2,28 @@
  * 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");
+    }
 }