Merge pull request #223 from magento/213-web-api-linemarker-test

Added tests for WEB-API line markers, fixed performance issue

Author: Vitaliy

src/com/magento/idea/magento2plugin/linemarker/php/WebApiLineMarkerProvider.java

@@ -8,6 +8,7 @@
 import com.intellij.codeInsight.daemon.LineMarkerProvider;
 import com.intellij.codeInsight.navigation.NavigationGutterIconBuilder;
 import com.intellij.psi.PsiElement;
+import com.intellij.psi.util.PsiTreeUtil;
 import com.intellij.psi.xml.XmlTag;
 import com.jetbrains.php.lang.psi.elements.Method;
 import com.jetbrains.php.lang.psi.elements.PhpClass;
@@ -62,7 +63,7 @@ public void collectSlowLineMarkers(@NotNull List<PsiElement> psiElements, @NotNu
                     .create(MagentoIcons.WEB_API)
                     .setTargets(results)
                     .setTooltipText(tooltipText.toString());
-            collection.add(builder.createLineMarkerInfo(psiElement));
+            collection.add(builder.createLineMarkerInfo(PsiTreeUtil.getDeepestFirst(psiElement)));
         }
     }
 

testData/linemarker/php/WebApiLinemarkerRegistrar/regularPhpClassShouldNotHaveLinemarker/ClassNotConfiguredInWebApiXml.php

@@ -0,0 +1,18 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Catalog\Model;
+
+class ClassNotConfiguredInWebApiXml
+{
+    public function create()
+    {
+    }
+
+    public function update()
+    {
+    }
+}

testData/linemarker/php/WebApiLinemarkerRegistrar/webApiServiceShouldHaveLinemarker/TestService.php

@@ -0,0 +1,19 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Catalog\Service;
+
+class TestService
+{
+    public function create()
+    {
+    }
+
+    public function update()
+    {
+    }
+}
+

testData/project/magento2/vendor/magento/module-catalog/etc/webapi.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<routes xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Webapi:etc/webapi.xsd">
+    <route url="/V1/blog/post" method="PUT">
+        <service class="Magento\Catalog\Service\TestService" method="create"/>
+        <resources>
+            <resource ref="Magento_Catalog::test"/>
+        </resources>
+    </route>
+    <route url="/V1/blog/update" method="POST">
+        <service class="Magento\Catalog\Service\TestService" method="update"/>
+        <resources>
+            <resource ref="Magento_Catalog::test"/>
+        </resources>
+    </route>
+</routes>

tests/com/magento/idea/magento2plugin/inspections/php/GraphQlResolverInspectionTest.java

@@ -4,8 +4,6 @@
  */
 package com.magento.idea.magento2plugin.inspections.php;
 
-import com.magento.idea.magento2plugin.bundles.InspectionBundle;
-
 public class GraphQlResolverInspectionTest extends InspectionPhpFixtureTestCase {
 
     private final String errorMessage =  inspectionBundle.message(

tests/com/magento/idea/magento2plugin/linemarker/php/WebApiLinemarkerRegistrarTest.java

@@ -0,0 +1,63 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.linemarker.php;
+
+import com.intellij.openapi.application.impl.ApplicationInfoImpl;
+import com.magento.idea.magento2plugin.MagentoIcons;
+
+public class WebApiLinemarkerRegistrarTest extends LinemarkerPhpFixtureTestCase {
+
+    private static final String expectedClassLineMarkerTooltip =
+        "Navigate to Web API configuration:<pre>  PUT     /V1/blog/post\n" +
+        "  POST    /V1/blog/update\n" +
+        "</pre>";
+
+    private static final String expectedMethodCreateLineMarkerTooltip =
+        "Navigate to Web API configuration:<pre>  POST    /V1/blog/update\n" +
+        "</pre>";
+
+    private static final String expectedMethodUpdateLineMarkerTooltip =
+        "Navigate to Web API configuration:<pre>  PUT     /V1/blog/post\n" +
+        "</pre>";
+
+    /**
+     * Class configured as WEB API service in web_api.xml should have WEB API line markers
+     */
+    public void testWebApiServiceShouldHaveLinemarker() {
+        String filePath = this.getFixturePath("TestService.php");
+
+        //work around for issue caused by com.magento.idea.magento2plugin.linemarker.xml.LineMarkerXmlTagDecorator
+        //in com.intellij.psi.impl.smartPointers.SmartPsiElementPointerImpl.createElementInfo
+        boolean isInStressTestCurrent = ApplicationInfoImpl.isInStressTest();
+        ApplicationInfoImpl.setInStressTest(true);
+
+        myFixture.configureByFile(filePath);
+
+        //assert class line marker
+        assertHasLinemarkerWithTooltipAndIcon(expectedClassLineMarkerTooltip, MagentoIcons.WEB_API.toString());
+
+        //assert methods line markers
+        assertHasLinemarkerWithTooltipAndIcon(expectedMethodCreateLineMarkerTooltip, MagentoIcons.WEB_API.toString());
+        assertHasLinemarkerWithTooltipAndIcon(expectedMethodUpdateLineMarkerTooltip, MagentoIcons.WEB_API.toString());
+
+        //restore default value
+        ApplicationInfoImpl.setInStressTest(isInStressTestCurrent);
+    }
+
+    /**
+     * Regular class should not have WEB API line markers
+     */
+    public void testRegularPhpClassShouldNotHaveLinemarker() {
+        String filePath = this.getFixturePath("ClassNotConfiguredInWebApiXml.php");
+        myFixture.configureByFile(filePath);
+
+        //assert class line marker
+        assertHasNoLinemarkerWithTooltipAndIcon(expectedClassLineMarkerTooltip, MagentoIcons.WEB_API.toString());
+
+        //assert methods line markers
+        assertHasNoLinemarkerWithTooltipAndIcon(expectedMethodCreateLineMarkerTooltip, MagentoIcons.WEB_API.toString());
+        assertHasNoLinemarkerWithTooltipAndIcon(expectedMethodUpdateLineMarkerTooltip, MagentoIcons.WEB_API.toString());
+    }
+}