Added tests for PhpConstructorArgumentReferenceProvider

Author: drpayyne

src/com/magento/idea/magento2plugin/reference/xml/PolyVariantReferenceBase.java

@@ -41,10 +41,4 @@ public ResolveResult[] multiResolve(boolean incompleteCode) {
         }
         return resolveResults;
     }
-
-    @NotNull
-    @Override
-    public Object[] getVariants() {
-        return new Object[0];
-    }
 }

src/com/magento/idea/magento2plugin/reference/xml/XmlReferenceContributor.java

@@ -67,6 +67,7 @@ public void registerReferenceProviders(@NotNull PsiReferenceRegistrar registrar)
             new VirtualTypeReferenceProvider()
         );
 
+        /* TODO: Cover with tests */
         // arguments
         registrar.registerReferenceProvider(
             XmlPatterns.xmlAttributeValue().withParent(
@@ -79,6 +80,7 @@ public void registerReferenceProviders(@NotNull PsiReferenceRegistrar registrar)
             new PhpConstructorArgumentReferenceProvider()
         );
 
+        /* TODO: Cover with tests */
         // <service method="methodName"/>
         registrar.registerReferenceProvider(
             XmlPatterns.xmlAttributeValue().withParent(
@@ -89,6 +91,7 @@ public void registerReferenceProviders(@NotNull PsiReferenceRegistrar registrar)
             new PhpServiceMethodReferenceProvider()
         );
 
+        /* TODO: Cover with tests */
         // <job method="methodName"/>
         registrar.registerReferenceProvider(
                 XmlPatterns.xmlAttributeValue().withParent(
@@ -143,6 +146,7 @@ public void registerReferenceProviders(@NotNull PsiReferenceRegistrar registrar)
                 new UIComponentReferenceProvider()
         );
 
+        /* TODO: Cover with tests */
         // <event name="reference" />
         registrar.registerReferenceProvider(
             XmlPatterns.xmlAttributeValue().withParent(

testData/project/magento2/app/code/Foo/Bar/Model/Logger.php

@@ -0,0 +1,13 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Foo\Bar\Model;
+
+class Logger implements Magento\Framework\Logger\LoggerInterface
+{
+    public function log($level, $message, array $context = array())
+    {
+    }
+}

testData/project/magento2/vendor/magento/framework/Logger/LoggerInterface.php

@@ -0,0 +1,25 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Framework\Logger;
+
+/**
+ * Describes a logger instance.
+ */
+interface LoggerInterface
+{
+    /**
+     * Logs with an arbitrary level.
+     *
+     * @param mixed   $level
+     * @param string  $message
+     * @param mixed[] $context
+     *
+     * @return void
+     *
+     * @throws \Psr\Log\InvalidArgumentException
+     */
+    public function log($level, $message, array $context = array());
+}

testData/project/magento2/vendor/magento/module-backend/Model/Source/YesNo.php

@@ -1,9 +1,28 @@
 <?php
-
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
 namespace Magento\Backend\Model\Source;
 
 use Magento\Framework\Option\ArrayInterface;
+use Magento\Framework\Logger\LoggerInterface;
 
-class YesNo implements ArrayInterface {
+class YesNo implements ArrayInterface
+{
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
 
-}
+    /**
+     * YesNo constructor.
+     *
+     * @param LoggerInterface $logger
+     */
+    public function __construct(
+        LoggerInterface $logger
+    ) {
+        $this->logger = $logger;
+    }
+}

testData/reference/xml/ConstructorArgumentReferenceRegistrar/diXmlConstructorArgumentMustHaveReference/di.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0"?>
+<!--
+ /**
+  * Copyright © Magento, Inc. All rights reserved.
+  * See COPYING.txt for license details.
+  */
+-->
+<config>
+    <type name="Magento\Backend\Model\Source\YesNo">
+        <arguments>
+            <argument name="<caret>logger" xsi:type="object">Foo\Bar\Model\Logger</argument>
+        </arguments>
+    </type>
+</config>

testData/reference/xml/ConstructorArgumentReferenceRegistrar/diXmlConstructorArgumentMustNotHaveReference/di.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0"?>
+<!--
+ /**
+  * Copyright © Magento, Inc. All rights reserved.
+  * See COPYING.txt for license details.
+  */
+-->
+<config>
+    <type name="Magento\Backend\Model\Source\YesNo">
+        <arguments>
+            <argument name="<caret>loggers" xsi:type="object">Foo\Bar\Model\Logger</argument>
+        </arguments>
+    </type>
+</config>

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

@@ -13,10 +13,12 @@
 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.Parameter;
 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;
 
 public abstract class BaseReferenceTestCase extends BaseInspectionsTestCase {
     private static final String testDataFolderPath = "testData" + File.separator//NOPMD
@@ -153,6 +155,23 @@ protected void assertHasReferencePhpClass(final String phpClassFqn) {
         );
     }
 
+    protected void assertHasReferencetoConstructorParameter(final String argumentClassFqn, final String argumentName) {
+        final PsiElement element = getElementFromCaret();
+        final @Nullable PsiReference reference = element.getReference();
+
+        if (reference == null) {
+            final String referenceNotFound
+                    = "Failed that element does not contain and reference";
+            fail(referenceNotFound);
+        }
+
+        String parameterClassFqn = ((Parameter) reference.resolve()).getLocalType().toStringResolved();
+        String parameterName = ((Parameter) reference.resolve()).getName();
+
+        assertEquals(parameterClassFqn, argumentClassFqn);
+        assertEquals(parameterName, argumentName);
+    }
+
     protected void assertEmptyReference() {
         final PsiElement element = getElementFromCaret();
         assertEmpty(element.getReferences());

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

@@ -0,0 +1,31 @@
+/*
+ * 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.ModuleDiXml;
+
+public class ConstructorArgumentReferenceRegistrarTest extends ReferenceXmlFixtureTestCase {
+    /**
+     * Tests for valid reference in di.xml constructor argument
+     */
+    public void testDiXmlConstructorArgumentMustHaveReference() {
+        myFixture.configureByFile(this.getFixturePath(ModuleDiXml.FILE_NAME));
+
+        assertHasReferencetoConstructorParameter(
+                "\\Magento\\Framework\\Logger\\LoggerInterface",
+                "logger"
+        );
+    }
+
+    /**
+     * Tests for no reference in di.xml constructor argument
+     */
+    public void testDiXmlConstructorArgumentMustNotHaveReference() {
+        myFixture.configureByFile(this.getFixturePath(ModuleDiXml.FILE_NAME));
+
+        assertEmptyReference();
+    }
+}