Merge pull request #388 from drpayyne/tests-02

Added test for PhpServiceMethodReferenceProvider

Author: Vitaliy

src/com/magento/idea/magento2plugin/reference/provider/PhpServiceMethodReferenceProvider.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;
@@ -14,32 +15,31 @@
 import com.jetbrains.php.lang.psi.elements.PhpClass;
 import com.magento.idea.magento2plugin.indexes.DiIndex;
 import com.magento.idea.magento2plugin.reference.xml.PolyVariantReferenceBase;
-import org.jetbrains.annotations.NotNull;
-
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
+import org.jetbrains.annotations.NotNull;
 
 public class PhpServiceMethodReferenceProvider  extends PsiReferenceProvider {
 
     @NotNull
     @Override
-    public PsiReference[] getReferencesByElement(@NotNull PsiElement element, @NotNull ProcessingContext context) {
-        if (!(element instanceof XmlElement)) {
-            return PsiReference.EMPTY_ARRAY;
-        }
-
-        List<PsiReference> psiReferences = new ArrayList<>();
-
-        String methodName = StringUtil.unquoteString(element.getText());
+    public PsiReference[] getReferencesByElement(
+            @NotNull final PsiElement element,
+            @NotNull final ProcessingContext context
+    ) {
+        final List<PsiReference> psiReferences = new ArrayList<>();
+        final String methodName = StringUtil.unquoteString(element.getText());
+        final PhpClass phpClass = DiIndex.getPhpClassOfServiceMethod((XmlElement) element);
 
-        PhpClass phpClass = DiIndex.getPhpClassOfServiceMethod((XmlElement) element);
         if (phpClass != null) {
-            Collection<Method> methods = phpClass.getMethods();
+            final Collection<Method> methods = phpClass.getMethods();
             methods.removeIf(m -> !m.getName().equalsIgnoreCase(methodName));
-            psiReferences.add(new PolyVariantReferenceBase(element, methods));
+            if (!methods.isEmpty()) {
+                psiReferences.add(new PolyVariantReferenceBase(element, methods));
+            }
         }
 
-        return psiReferences.toArray(new PsiReference[psiReferences.size()]);
+        return psiReferences.toArray(new PsiReference[0]);
     }
 }

testData/project/magento2/vendor/magento/module-catalog/Api/ProductRepositoryInterface.php

@@ -0,0 +1,12 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Catalog\Api;
+
+interface ProductRepositoryInterface
+{
+    public function save();
+}

testData/reference/xml/WebApiMethodReferenceRegistrar/webApiMethodMustHaveReference/webapi.xml

@@ -0,0 +1,19 @@
+<?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">
+
+    <!-- Product Service -->
+    <route url="/V1/products" method="POST">
+        <service class="Magento\Catalog\Api\ProductRepositoryInterface" method="save<caret>"/>
+        <resources>
+            <resource ref="Magento_Catalog::products" />
+        </resources>
+    </route>
+
+</routes>

testData/reference/xml/WebApiMethodReferenceRegistrar/webApiMethodMustNotHaveReference/webapi.xml

@@ -0,0 +1,19 @@
+<?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">
+
+    <!-- Product Service -->
+    <route url="/V1/products" method="POST">
+        <service class="Magento\Catalog\Api\ProductRepositoryInterface" method="get<caret>"/>
+        <resources>
+            <resource ref="Magento_Catalog::products" />
+        </resources>
+    </route>
+
+</routes>

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

@@ -13,6 +13,7 @@
 import com.intellij.psi.xml.XmlAttributeValue;
 import com.intellij.psi.xml.XmlFile;
 import com.intellij.psi.xml.XmlTag;
+import com.jetbrains.php.lang.psi.elements.Method;
 import com.jetbrains.php.lang.psi.elements.PhpClass;
 import com.magento.idea.magento2plugin.inspections.BaseInspectionsTestCase;
 import com.magento.idea.magento2plugin.magento.packages.File;
@@ -153,6 +154,29 @@ protected void assertHasReferencePhpClass(final String phpClassFqn) {
         );
     }
 
+    protected void assertHasReferenceToClassMethod(
+            final String className,
+            final String methodName
+    ) {
+        final PsiElement element = getElementFromCaret();
+        final PsiReference[] references = element.getReferences();
+        final String actualClassName = ((PhpClass) references[references.length - 1].resolve()
+                .getParent()).getFQN();
+        final String actualMethodName = ((Method) references[references.length - 1].resolve())
+                .getName();
+
+        assertEquals(
+                "Class name",
+                className,
+                actualClassName
+        );
+        assertEquals(
+                "Method name",
+                methodName,
+                actualMethodName
+        );
+    }
+
     protected void assertEmptyReference() {
         final PsiElement element = getElementFromCaret();
         assertEmpty(element.getReferences());

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

@@ -0,0 +1,30 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.reference.xml;
+
+public class WebApiMethodReferenceRegistrarTest extends ReferenceXmlFixtureTestCase {
+
+    /**
+     * Tests for reference to valid PHP method in webapi.xml.
+     */
+    public void testWebApiMethodMustHaveReference() {
+        myFixture.configureByFile(this.getFixturePath("webapi.xml"));
+
+        assertHasReferenceToClassMethod(
+                "\\Magento\\Catalog\\Api\\ProductRepositoryInterface",
+                "save"
+        );
+    }
+
+    /**
+     * Tests for no reference to invalid PHP method in webapi.xml.
+     */
+    public void testWebApiMethodMustNotHaveReference() {
+        myFixture.configureByFile(this.getFixturePath("webapi.xml"));
+
+        assertEmptyReference();
+    }
+}