Merge branch '2.1.0-develop' into module-layout-description

Author: Vitaliy

testData/linemarker/graphqls/GraphQlResolverClassLinemarkerRegistrar/withValidSchemaResolver/schema.graphqls

@@ -0,0 +1,6 @@
+# Copyright © Magento, Inc. All rights reserved.
+# See COPYING.txt for license details.
+
+type Query {
+    test(input: test!): test @resolver(class: "\\Magento\\CatalogGraphQl\\Model\\Resolver\\ImplementsResolverInterface")
+}

testData/linemarker/php/GraphQlResolverUsageLinemarkerRegistrar/regularClassShouldNotHaveLinemarker/ClassNotConfiguredInSchema.php

@@ -0,0 +1,11 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\CatalogGraphQl\Model\Resolver;
+
+class ClassNotConfiguredInSchema
+{
+}

testData/linemarker/php/GraphQlResolverUsageLinemarkerRegistrar/resolverClassShouldHaveLinemarker/Resolver.php

@@ -0,0 +1,13 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\CatalogGraphQl\Model\Resolver;
+
+use Magento\Framework\GraphQl\Query\ResolverInterface;
+
+class ImplementsResolverInterface implements ResolverInterface
+{
+}

tests/com/magento/idea/magento2plugin/linemarker/LinemarkerFixtureTestCase.java

@@ -0,0 +1,83 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.linemarker;
+
+import com.intellij.codeInsight.daemon.LineMarkerInfo;
+import com.intellij.codeInsight.daemon.impl.DaemonCodeAnalyzerImpl;
+import com.magento.idea.magento2plugin.BaseProjectTestCase;
+import com.magento.idea.magento2plugin.magento.packages.File;
+import java.util.List;
+import javax.swing.Icon;
+import org.jetbrains.annotations.NotNull;
+
+public abstract class LinemarkerFixtureTestCase extends BaseProjectTestCase {
+
+    private static final String TEST_DATA_PATH
+            = "testData" + File.separator + "linemarker" + File.separator;
+
+    @Override
+    protected void setUp() throws Exception {
+        super.setUp();
+        myFixture.setTestDataPath(TEST_DATA_PATH);
+    }
+
+    protected String getFixturePath(final String fileName, final String folder) {
+        return prepareFixturePath(fileName, folder + File.separator);
+    }
+
+    protected void assertHasLinemarkerWithTooltipAndIcon(final String tooltip, final String icon) {
+        myFixture.doHighlighting();
+
+        final List<LineMarkerInfo<?>> lineMarkers = getDocumentLineMarkers();
+        assertNotEmpty(lineMarkers);
+        for (final LineMarkerInfo lineMarkerInfo: lineMarkers) {
+            final String lineMarkerTooltip = lineMarkerInfo.getLineMarkerTooltip();
+            final Icon lineMarkerIcon = lineMarkerInfo.getIcon();
+            if (lineMarkerTooltip == null || lineMarkerIcon == null) {
+                continue;
+            }
+            if (lineMarkerTooltip.equals(tooltip)
+                    && lineMarkerIcon.toString().equals(icon)) {
+                return;
+            }
+        }
+
+        final String lineMarkerNotFound
+                = "Failed that documents contains linemarker with the tooltip `%s`";
+        fail(String.format(lineMarkerNotFound, tooltip));
+    }
+
+    protected void assertHasNoLinemarkerWithTooltipAndIcon(
+            final String tooltip,
+            final String icon
+    ) {
+        myFixture.doHighlighting();
+        final String lineMarkerExist
+                = "Failed that documents not contains linemarker with the tooltip `%s`";
+
+        final List<LineMarkerInfo<?>> lineMarkers = getDocumentLineMarkers();
+        assertNotEmpty(lineMarkers);
+        for (final LineMarkerInfo lineMarkerInfo: lineMarkers) {
+            final String lineMarkerTooltip = lineMarkerInfo.getLineMarkerTooltip();
+            final 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()
+        );
+    }
+}

tests/com/magento/idea/magento2plugin/linemarker/graphqls/GraphQlResolverClassLinemarkerRegistrarTest.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.linemarker.graphqls;
+
+import com.magento.idea.magento2plugin.linemarker.LinemarkerFixtureTestCase;
+
+public class GraphQlResolverClassLinemarkerRegistrarTest extends LinemarkerFixtureTestCase {
+
+    /**
+     * Tests linemarkers in the schema.graphqls file for PHP resolver classes.
+     */
+    public void testWithValidSchemaResolver() {
+        myFixture.configureByFile(this.getFixturePath("schema.graphqls", "graphqls"));
+
+        assertHasLinemarkerWithTooltipAndIcon("Navigate to class", "/nodes/class.svg");
+    }
+}

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

@@ -2,20 +2,27 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 package com.magento.idea.magento2plugin.linemarker.php;
 
-public class ConfigurationTypeClassLinemarkerRegistrarTest extends LinemarkerPhpFixtureTestCase {
+import com.magento.idea.magento2plugin.linemarker.LinemarkerFixtureTestCase;
+
+public class ConfigurationTypeClassLinemarkerRegistrarTest extends LinemarkerFixtureTestCase {
 
+    /**
+     * Tests linemarkers in the configured class.
+     */
     public void testTypeNameClassShouldHaveLinemarker() {
-        String filePath = this.getFixturePath("Topmenu.php");
-        myFixture.configureByFile(filePath);
+        myFixture.configureByFile(this.getFixturePath("Topmenu.php", "php"));
 
         assertHasLinemarkerWithTooltipAndIcon("Navigate to configuration", "/fileTypes/xml.svg");
     }
 
+    /**
+     * Tests linemarkers in the non-configured class.
+     */
     public void testRegularPhpClassShouldNotHaveLinemarker() {
-        String filePath = this.getFixturePath("ClassNotConfiguredInDiXml.php");
-        myFixture.configureByFile(filePath);
+        myFixture.configureByFile(this.getFixturePath("ClassNotConfiguredInDiXml.php", "php"));
 
         assertHasNoLinemarkerWithTooltipAndIcon("Navigate to configuration", "/fileTypes/xml.svg");
     }

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

@@ -0,0 +1,29 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.linemarker.php;
+
+import com.magento.idea.magento2plugin.linemarker.LinemarkerFixtureTestCase;
+
+public class GraphQlResolverUsageLinemarkerRegistrarTest extends LinemarkerFixtureTestCase {
+
+    /**
+     * Tests linemarkers in the resolver class.
+     */
+    public void testResolverClassShouldHaveLinemarker() {
+        myFixture.configureByFile(this.getFixturePath("Resolver.php", "php"));
+
+        assertHasNoLinemarkerWithTooltipAndIcon("Navigate to schema", "/icons/graphqlFile.svg");
+    }
+
+    /**
+     * Tests linemarkers in the regular class.
+     */
+    public void testRegularClassShouldNotHaveLinemarker() {
+        myFixture.configureByFile(this.getFixturePath("ClassNotConfiguredInSchema.php", "php"));
+
+        assertHasNoLinemarkerWithTooltipAndIcon("Navigate to schema", "/icons/graphqlFile.svg");
+    }
+}

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

@@ -2,20 +2,27 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 package com.magento.idea.magento2plugin.linemarker.php;
 
-public class ObserverClassLinemarkerRegistrarTest extends LinemarkerPhpFixtureTestCase {
+import com.magento.idea.magento2plugin.linemarker.LinemarkerFixtureTestCase;
+
+public class ObserverClassLinemarkerRegistrarTest extends LinemarkerFixtureTestCase {
 
+    /**
+     * Tests linemarkers in the Observer class.
+     */
     public void testObserverClassShouldHaveLinemarker() {
-        String filePath = this.getFixturePath("TestObserver.php");
-        myFixture.configureByFile(filePath);
+        myFixture.configureByFile(this.getFixturePath("TestObserver.php", "php"));
 
         assertHasLinemarkerWithTooltipAndIcon("Navigate to configuration", "/fileTypes/xml.svg");
     }
 
+    /**
+     * Tests linemarkers in the regular class.
+     */
     public void testRegularPhpClassShouldNotHaveLinemarker() {
-        String filePath = this.getFixturePath("TestNotObserver.php");
-        myFixture.configureByFile(filePath);
+        myFixture.configureByFile(this.getFixturePath("TestNotObserver.php", "php"));
 
         assertHasNoLinemarkerWithTooltipAndIcon("Navigate to configuration", "/fileTypes/xml.svg");
     }

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

@@ -5,14 +5,16 @@
 
 package com.magento.idea.magento2plugin.linemarker.php;
 
+import com.magento.idea.magento2plugin.linemarker.LinemarkerFixtureTestCase;
+
 @SuppressWarnings("PMD.JUnitTestContainsTooManyAsserts")
-public class PluginTargetLinemarkerRegistrarTest extends LinemarkerPhpFixtureTestCase {
+public class PluginTargetLinemarkerRegistrarTest extends LinemarkerFixtureTestCase {
 
     /**
      * Tests linemarkers in a class which plugs in to a class and its method.
      */
     public void testPluginToClassShouldHaveLinemarker() {
-        myFixture.configureByFile(this.getFixturePath("Topmenu.php"));
+        myFixture.configureByFile(this.getFixturePath("Topmenu.php", "php"));
 
         assertHasLinemarkerWithTooltipAndIcon("Navigate to target method", "/nodes/method.svg");
         assertHasLinemarkerWithTooltipAndIcon("Navigate to target class", "/nodes/class.svg");
@@ -22,7 +24,7 @@ public void testPluginToClassShouldHaveLinemarker() {
      * Tests linemarkers in a class which plugs in to an interface and its method.
      */
     public void testPluginToInterfaceShouldHaveLinemarker() {
-        myFixture.configureByFile(this.getFixturePath("MviewState.php"));
+        myFixture.configureByFile(this.getFixturePath("MviewState.php", "php"));
 
         assertHasLinemarkerWithTooltipAndIcon("Navigate to target method", "/nodes/method.svg");
         assertHasLinemarkerWithTooltipAndIcon("Navigate to target class", "/nodes/class.svg");
@@ -32,7 +34,7 @@ public void testPluginToInterfaceShouldHaveLinemarker() {
      * Tests linemarkers in a regular class which does not plug in to any class or interface.
      */
     public void testRegularClassShouldNotHaveLinemarker() {
-        myFixture.configureByFile(this.getFixturePath("ClassNotConfiguredInDiXml.php"));
+        myFixture.configureByFile(this.getFixturePath("ClassNotConfiguredInDiXml.php", "php"));
 
         assertHasNoLinemarkerWithTooltipAndIcon("Navigate to target method", "/nodes/method.svg");
         assertHasNoLinemarkerWithTooltipAndIcon("Navigate to target class", "/nodes/class.svg");