Merge pull request #153 from magento/observer-test-coverage

Vitaliy · web-flow · commit 980b5ff7b2aa · 2020-04-15T09:22:22.000+03:00
Added Observer test coverage (LineMarkers, Completion, Reference)
diff --git a/src/com/magento/idea/magento2plugin/completion/xml/XmlCompletionContributor.java b/src/com/magento/idea/magento2plugin/completion/xml/XmlCompletionContributor.java
@@ -11,7 +11,6 @@
 import com.magento.idea.magento2plugin.completion.provider.*;
 import com.magento.idea.magento2plugin.completion.provider.mftf.*;
 import com.magento.idea.magento2plugin.magento.files.*;
-
 import static com.intellij.patterns.PlatformPatterns.psiElement;
 import static com.intellij.patterns.StandardPatterns.string;
 import static com.intellij.patterns.XmlPatterns.xmlFile;
@@ -103,6 +102,16 @@ public XmlCompletionContributor() {
             new PhpConstructorArgumentCompletionProvider()
         );
 
+        // <observer instance="Class">
+        extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
+            .inside(XmlPatterns.xmlAttribute().withName(ModuleEventsXml.INSTANCE_ATTRIBUTE)
+                .withParent(XmlPatterns.xmlTag().withName(ModuleEventsXml.OBSERVER_TAG)
+                    .withParent(XmlPatterns.xmlTag().withName(ModuleEventsXml.EVENT_TAG))
+                )
+            ).inFile(xmlFile().withName(string().matches(ModuleEventsXml.FILE_NAME))),
+            new PhpClassCompletionProvider()
+        );
+
         // <source_model>php class completion</source_model> in system.xml files.
         extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_DATA_CHARACTERS)
             .inside(XmlPatterns.xmlTag().withName(ModuleSystemXml.XML_TAG_SOURCE_MODEL)
diff --git a/src/com/magento/idea/magento2plugin/magento/files/ModuleEventsXml.java b/src/com/magento/idea/magento2plugin/magento/files/ModuleEventsXml.java
@@ -14,6 +14,11 @@ public class ModuleEventsXml implements ModuleFileInterface {
     //code templates
     public static String TEMPLATE_OBSERVER = "Magento Module Events Xml Observer";
 
+    //tags
+    public static String OBSERVER_TAG = "observer";
+    public static String INSTANCE_ATTRIBUTE = "instance";
+    public static String EVENT_TAG = "event";
+
     private static ModuleEventsXml INSTANCE = null;
 
     public static ModuleEventsXml getInstance() {
diff --git a/testData/completion/xml/ObserverCompletionRegistrar/eventsXmlEventNameMustHaveCompletion/events.xml b/testData/completion/xml/ObserverCompletionRegistrar/eventsXmlEventNameMustHaveCompletion/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_e<caret>">
+        <observer name="test_observer" instance="Observer" />
+    </event>
+</config>
diff --git a/testData/completion/xml/ObserverCompletionRegistrar/eventsXmlMustHaveCompletion/events.xml b/testData/completion/xml/ObserverCompletionRegistrar/eventsXmlMustHaveCompletion/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">
+        <observer name="test_observer" instance="Observer<caret>" />
+    </event>
+</config>
diff --git a/testData/completion/xml/ObserverCompletionRegistrar/notEventsXmlMustBeEmpty/notevents.xml b/testData/completion/xml/ObserverCompletionRegistrar/notEventsXmlMustBeEmpty/notevents.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">
+        <observer name="test_observer" instance="Observer<caret>" />
+    </event>
+</config>
diff --git a/testData/linemarker/php/ObserverClassLinemarkerRegistrar/observerClassShouldHaveLinemarker/TestObserver.php b/testData/linemarker/php/ObserverClassLinemarkerRegistrar/observerClassShouldHaveLinemarker/TestObserver.php
@@ -0,0 +1,16 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Catalog\Observer;
+
+use Magento\Framework\Event\ObserverInterface;
+
+class TestObserver implements ObserverInterface
+{
+    public function execute()
+    {
+    }
+}
diff --git a/testData/linemarker/php/ObserverClassLinemarkerRegistrar/regularPhpClassShouldNotHaveLinemarker/TestNotObserver.php b/testData/linemarker/php/ObserverClassLinemarkerRegistrar/regularPhpClassShouldNotHaveLinemarker/TestNotObserver.php
@@ -0,0 +1,14 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Catalog\Model;
+
+class TestNotObserver
+{
+    public function execute()
+    {
+    }
+}
diff --git a/testData/project/magento2/vendor/magento/module-catalog/Block/Navigation.php b/testData/project/magento2/vendor/magento/module-catalog/Block/Navigation.php
@@ -11,5 +11,6 @@ class Navigation extends \Magento\Framework\View\Element\Template implements
 {
     public function someMethod()
     {
+        $this->_eventManager->dispatch('test_event_in_block', ['response_object' => "test"]);
     }
 }
diff --git a/testData/project/magento2/vendor/magento/module-catalog/Observer/TestObserver.php b/testData/project/magento2/vendor/magento/module-catalog/Observer/TestObserver.php
@@ -0,0 +1,16 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Catalog\Observer;
+
+use Magento\Framework\Event\ObserverInterface;
+
+class TestObserver implements ObserverInterface
+{
+    public function execute()
+    {
+    }
+}
diff --git a/testData/project/magento2/vendor/magento/module-catalog/etc/events.xml b/testData/project/magento2/vendor/magento/module-catalog/etc/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_test_class">
+        <observer name="test_observer" instance="Magento\Catalog\Observer\TestObserver" />
+    </event>
+</config>
diff --git a/testData/reference/php/ObserverDispatchEventReferenceRegistrar/dispatchCallParamMustHaveReference/TestBlock.php b/testData/reference/php/ObserverDispatchEventReferenceRegistrar/dispatchCallParamMustHaveReference/TestBlock.php
@@ -0,0 +1,16 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Catalog\Block;
+
+class TestBlock extends \Magento\Framework\View\Element\Template implements
+    \Magento\Framework\DataObject\IdentityInterface
+{
+    public function someMethod()
+    {
+        $this->_eventManager->dispatch('test_event_in_test_class<caret>', ['response_object' => "test"]);
+    }
+}
diff --git a/testData/reference/xml/ObserverReferenceRegistrar/eventsXmlMustHaveReference/events.xml b/testData/reference/xml/ObserverReferenceRegistrar/eventsXmlMustHaveReference/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">
+        <observer name="test_observer" instance="Magento\Catalog\Observer\TestObserver<caret>" />
+    </event>
+</config>
diff --git a/tests/com/magento/idea/magento2plugin/BaseProjectTestCase.java b/tests/com/magento/idea/magento2plugin/BaseProjectTestCase.java
@@ -1,3 +1,7 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
 package com.magento.idea.magento2plugin;
 
 import com.intellij.openapi.util.text.StringUtil;
diff --git a/tests/com/magento/idea/magento2plugin/completion/xml/ObserverCompletionRegistrarTest.java b/tests/com/magento/idea/magento2plugin/completion/xml/ObserverCompletionRegistrarTest.java
@@ -0,0 +1,38 @@
+/*
+ * 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.ModuleEventsXml;
+
+public class ObserverCompletionRegistrarTest extends CompletionXmlFixtureTestCase {
+
+    private static final String[] lookupStringsEntities = new String[] {
+        "Magento\\Catalog\\Observer\\TestObserver"
+      };
+    private static final String[] lookupStringsEvents = new String[] {
+        "test_event_in_block"
+      };
+
+    public void testEventsXmlMustHaveCompletion() {
+        String filePath = this.getFixturePath(ModuleEventsXml.FILE_NAME);
+        myFixture.copyFileToProject(filePath);
+
+        assertFileContainsCompletions(filePath, lookupStringsEntities);
+    }
+
+    public void testNotEventsXmlMustBeEmpty() {
+        String filePath = this.getFixturePath("notevents.xml");
+        myFixture.copyFileToProject(filePath);
+
+        assertCompletionNotShowing(filePath);
+    }
+
+    public void testEventsXmlEventNameMustHaveCompletion() {
+        String filePath = this.getFixturePath(ModuleEventsXml.FILE_NAME);
+        myFixture.copyFileToProject(filePath);
+
+        assertFileContainsCompletions(filePath, lookupStringsEvents);
+    }
+}
diff --git a/tests/com/magento/idea/magento2plugin/linemarker/php/LinemarkerPhpFixtureTestCase.java b/tests/com/magento/idea/magento2plugin/linemarker/php/LinemarkerPhpFixtureTestCase.java
@@ -0,0 +1,74 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.linemarker.php;
+
+import com.intellij.codeInsight.daemon.LineMarkerInfo;
+import com.intellij.codeInsight.daemon.impl.DaemonCodeAnalyzerImpl;
+import com.magento.idea.magento2plugin.BaseProjectTestCase;
+import org.jetbrains.annotations.NotNull;
+import javax.swing.*;
+import java.io.File;
+import java.util.List;
+
+abstract public class LinemarkerPhpFixtureTestCase extends BaseProjectTestCase {
+
+    private static final String testDataFolderPath = "testData" + File.separator + "linemarker" + File.separator;
+    private static final String fixturesFolderPath = "php" + File.separator;
+
+    @Override
+    protected void setUp() throws Exception {
+        super.setUp();
+        myFixture.setTestDataPath(testDataFolderPath);
+    }
+
+    protected String getFixturePath(String fileName) {
+        return prepareFixturePath(fileName, fixturesFolderPath);
+    }
+
+    protected void assertHasLinemarkerWithTooltipAndIcon(String tooltip, String icon) {
+        myFixture.doHighlighting();
+        String lineMarkerNotFound = "Failed that documents contains linemarker with the tooltip `%s`";
+
+        List<LineMarkerInfo<?>> lineMarkers = getDocumentLineMarkers();
+        assertNotEmpty(lineMarkers);
+        for (LineMarkerInfo lineMarkerInfo: lineMarkers) {
+            String lineMarkerTooltip = lineMarkerInfo.getLineMarkerTooltip();
+            Icon lineMarkerIcon = lineMarkerInfo.getIcon();
+            if (lineMarkerTooltip == null || lineMarkerIcon == null) {
+                continue;
+            }
+            if (lineMarkerTooltip.equals(tooltip) &&
+                    lineMarkerIcon.toString().equals(icon)) {
+                return;
+            }
+        }
+
+        fail(String.format(lineMarkerNotFound, tooltip));
+    }
+
+    protected void assertHasNoLinemarkerWithTooltipAndIcon(String tooltip, String icon) {
+        myFixture.doHighlighting();
+        String lineMarkerExist = "Failed that documents not contains linemarker with the tooltip `%s`";
+
+        List<LineMarkerInfo<?>> lineMarkers = getDocumentLineMarkers();
+        assertNotEmpty(lineMarkers);
+        for (LineMarkerInfo lineMarkerInfo: lineMarkers) {
+            String lineMarkerTooltip = lineMarkerInfo.getLineMarkerTooltip();
+            Icon lineMarkerIcon = lineMarkerInfo.getIcon();
+            if (lineMarkerTooltip == null || lineMarkerIcon == null) {
+                continue;
+            }
+            if (lineMarkerTooltip.equals(tooltip) &&
+                    lineMarkerIcon.toString().equals(icon)) {
+                fail(String.format(lineMarkerExist, tooltip));
+            }
+        }
+    }
+
+    @NotNull
+    private List<LineMarkerInfo<?>> getDocumentLineMarkers() {
+        return DaemonCodeAnalyzerImpl.getLineMarkers(myFixture.getEditor().getDocument(), getProject());
+    }
+}
diff --git a/tests/com/magento/idea/magento2plugin/linemarker/php/ObserverClassLinemarkerRegistrarTest.java b/tests/com/magento/idea/magento2plugin/linemarker/php/ObserverClassLinemarkerRegistrarTest.java
@@ -0,0 +1,22 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.linemarker.php;
+
+public class ObserverClassLinemarkerRegistrarTest extends LinemarkerPhpFixtureTestCase {
+
+    public void testObserverClassShouldHaveLinemarker() {
+        String filePath = this.getFixturePath("TestObserver.php");
+        myFixture.configureByFile(filePath);
+
+        assertHasLinemarkerWithTooltipAndIcon("Navigate to configuration", "/fileTypes/xml.svg");
+    }
+
+    public void testRegularPhpClassShouldNotHaveLinemarker() {
+        String filePath = this.getFixturePath("TestNotObserver.php");
+        myFixture.configureByFile(filePath);
+
+        assertHasNoLinemarkerWithTooltipAndIcon("Navigate to configuration", "/fileTypes/xml.svg");
+    }
+}
diff --git a/tests/com/magento/idea/magento2plugin/reference/php/ObserverDispatchEventReferenceRegistrarTest.java b/tests/com/magento/idea/magento2plugin/reference/php/ObserverDispatchEventReferenceRegistrarTest.java
@@ -0,0 +1,15 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.reference.php;
+
+public class ObserverDispatchEventReferenceRegistrarTest extends ReferencePhpFixtureTestCase {
+
+    public void testDispatchCallParamMustHaveReference() {
+        String filePath = this.getFixturePath("TestBlock.php");
+        myFixture.configureByFile(filePath);
+
+        assertHasReferenceToXmlAttributeValue("test_event_in_test_class");
+    }
+}
diff --git a/tests/com/magento/idea/magento2plugin/reference/php/ReferencePhpFixtureTestCase.java b/tests/com/magento/idea/magento2plugin/reference/php/ReferencePhpFixtureTestCase.java
@@ -0,0 +1,52 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.reference.php;
+
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiReference;
+import com.intellij.psi.impl.source.xml.XmlAttributeValueImpl;
+import com.magento.idea.magento2plugin.BaseProjectTestCase;
+import com.magento.idea.magento2plugin.reference.xml.PolyVariantReferenceBase;
+import java.io.File;
+
+abstract public class ReferencePhpFixtureTestCase extends BaseProjectTestCase {
+
+    private static final String testDataFolderPath = "testData" + File.separator + "reference" + File.separator;
+    private static final String fixturesFolderPath = "php" + File.separator;
+
+    @Override
+    protected void setUp() throws Exception {
+        super.setUp();
+        myFixture.setTestDataPath(testDataFolderPath);
+    }
+
+    protected String getFixturePath(String fileName) {
+        return prepareFixturePath(fileName, fixturesFolderPath);
+    }
+
+    protected void assertHasReferenceToXmlAttributeValue(String attributeValue) {
+        String referenceNotFound = "Failed that documents contains reference to XML attribute with value `%s`";
+
+        PsiElement element = getElementFromCaret();
+        PsiReference[] references = element.getReferences();
+        for (PsiReference reference: references) {
+            if (!(reference instanceof PolyVariantReferenceBase)) {
+                continue;
+            }
+            assertEquals(
+                    attributeValue,
+                    ((XmlAttributeValueImpl) reference.resolve())
+                            .getValue()
+            );
+            return;
+        }
+
+        fail(String.format(referenceNotFound, attributeValue));
+    }
+
+    private PsiElement getElementFromCaret() {
+        return myFixture.getFile().findElementAt(myFixture.getCaretOffset()).getParent();
+    }
+}
diff --git a/tests/com/magento/idea/magento2plugin/reference/xml/ObserverReferenceRegistrarTest.java b/tests/com/magento/idea/magento2plugin/reference/xml/ObserverReferenceRegistrarTest.java
diff --git a/tests/com/magento/idea/magento2plugin/reference/xml/ReferenceXmlFixtureTestCase.java b/tests/com/magento/idea/magento2plugin/reference/xml/ReferenceXmlFixtureTestCase.java

Original file line number	Diff line number	Diff line change
`@@ -11,5 +11,6 @@ class Navigation extends \Magento\Framework\View\Element\Template implements`
`11`	`11`	`{`
`12`	`12`	`public function someMethod()`
`13`	`13`	`{`
	`14`	`+ $this->_eventManager->dispatch('test_event_in_block', ['response_object' => "test"]);`
`14`	`15`	`}`
`15`	`16`	`}`