Merge pull request #159 from konarshankar07/schema-graphql-resolver-inspection--task-35

Vitaliy · web-flow · commit 03d84d20a4fd · 2020-04-24T03:06:05.000-07:00
#35 :- Inspection. GraphQL resolver should implement Resolver interface
diff --git a/resources/META-INF/withJsGraphQl.xml b/resources/META-INF/withJsGraphQl.xml
@@ -1,3 +1,10 @@
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+
 <idea-plugin>
     <extensions defaultExtensionNs="com.intellij">
         <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.graphql.GraphQlResolverIndex" />
@@ -9,5 +16,11 @@
                          enabledByDefault="true"
                          level="ERROR"
                          implementationClass="com.magento.idea.magento2plugin.inspections.php.GraphQlResolverInspection"/>
+        <localInspection language="GraphQL" groupPath="GraphQL"
+                         shortName="SchemaResolverInspection" displayName="Schema Resolver must implements ResolverInterface"
+                         groupName="Magento 2"
+                         enabledByDefault="true"
+                         level="ERROR"
+                         implementationClass="com.magento.idea.magento2plugin.inspections.graphqls.SchemaResolverInspection"/>
     </extensions>
 </idea-plugin>
diff --git a/resources/inspectionDescriptions/SchemaResolverInspection.html b/resources/inspectionDescriptions/SchemaResolverInspection.html
@@ -0,0 +1,13 @@
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<html>
+<body>
+<p>
+    This inspection detects the invalid resolver interface in schema.graphqls files
+</p>
+</body>
+</html>
diff --git a/resources/magento2/inspection.properties b/resources/magento2/inspection.properties
@@ -1,8 +1,7 @@
-inspection.class.hierarchyImplementationCheck=Class must implement {0}
-inspection.class.hierarchyExtendingCheck=Class must extend {0}
 inspection.plugin.duplicateInSameFile=The plugin name already used in this file. For more details see Inspection Description.
 inspection.plugin.duplicateInOtherPlaces=The plugin name "{0}" for targeted "{1}" class is already used in the module "{2}" ({3} scope). For more details see Inspection Description.
 inspection.graphql.resolver.mustImplement=Class must implements any of the following interfaces: \\Magento\\Framework\\GraphQl\\Query\\ResolverInterface, \\Magento\\Framework\\GraphQl\\Query\\Resolver\\BatchResolverInterface, \\Magento\\Framework\\GraphQl\\Query\\Resolver\\BatchServiceContractResolverInterface
+inspection.graphql.resolver.notExist=Resolver class do not exist
 inspection.graphql.resolver.fix.family=Implement Resolver interface
 inspection.graphql.resolver.fix.title=Select one of the following interface
 inspection.plugin.error.nonPublicMethod=You can't declare a plugin for a not public method.
diff --git a/src/com/magento/idea/magento2plugin/inspections/graphqls/SchemaResolverInspection.java b/src/com/magento/idea/magento2plugin/inspections/graphqls/SchemaResolverInspection.java
@@ -0,0 +1,55 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.inspections.graphqls;
+
+import com.intellij.codeInspection.LocalInspectionTool;
+import com.intellij.codeInspection.ProblemHighlightType;
+import com.intellij.codeInspection.ProblemsHolder;
+import com.intellij.lang.jsgraphql.psi.GraphQLValue;
+import com.intellij.lang.jsgraphql.psi.GraphQLVisitor;
+import com.jetbrains.php.lang.psi.elements.PhpClass;
+import com.magento.idea.magento2plugin.bundles.InspectionBundle;
+import com.magento.idea.magento2plugin.util.GetPhpClassByFQN;
+import com.magento.idea.magento2plugin.util.magento.graphql.GraphQlUtil;
+import org.jetbrains.annotations.NotNull;
+
+public class SchemaResolverInspection extends LocalInspectionTool {
+
+    private final InspectionBundle inspectionBundle = new InspectionBundle();
+
+    @NotNull
+    @Override
+    public GraphQLVisitor buildVisitor(@NotNull final ProblemsHolder holder, boolean isOnTheFly) {
+        return new GraphQLVisitor() {
+            @Override
+            public void visitValue(@NotNull GraphQLValue element) {
+                String getVisitedElementValue = element.getText();
+                if (getVisitedElementValue == null) {
+                    return;
+                }
+
+                String resolverFQN = GraphQlUtil.resolverStringToPhpFQN(getVisitedElementValue);
+                GetPhpClassByFQN getPhpClassByFQN = GetPhpClassByFQN.getInstance(holder.getProject());
+                PhpClass resolverClass = getPhpClassByFQN.execute(resolverFQN);
+                if (resolverClass == null) {
+                    holder.registerProblem(element,
+                        inspectionBundle.message(
+                            "inspection.graphql.resolver.notExist"
+                        ),
+                        ProblemHighlightType.ERROR);
+                    return;
+                }
+                if (!GraphQlUtil.isResolver(resolverClass)) {
+                    holder.registerProblem(element,
+                        inspectionBundle.message(
+                            "inspection.graphql.resolver.mustImplement"
+                        ),
+                        ProblemHighlightType.ERROR);
+                }
+            }
+        };
+    }
+}
diff --git a/src/com/magento/idea/magento2plugin/magento/files/GraphQLSchema.java b/src/com/magento/idea/magento2plugin/magento/files/GraphQLSchema.java
@@ -0,0 +1,9 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.magento.files;
+
+public class GraphQLSchema {
+    public static String FILE_NAME = "schema.graphqls";
+}
diff --git a/testData/inspections/graphqls/SchemaResolverInspection/withInvalidSchemaResolverInterface/schema.graphqls b/testData/inspections/graphqls/SchemaResolverInspection/withInvalidSchemaResolverInterface/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\\Backend\\Model\\Source\\YesNo") @doc(description: "Test")
+}
diff --git a/testData/inspections/graphqls/SchemaResolverInspection/withValidBatchResolverInterface/schema.graphqls b/testData/inspections/graphqls/SchemaResolverInspection/withValidBatchResolverInterface/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\\ImplementsBatchResolverInterface") @doc(description: "Test")
+}
diff --git a/testData/inspections/graphqls/SchemaResolverInspection/withValidBatchServiceContractResolverInterface/schema.graphqls b/testData/inspections/graphqls/SchemaResolverInspection/withValidBatchServiceContractResolverInterface/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\\ImplementsBatchServiceContractResolverInterface") @doc(description: "Test")
+}
diff --git a/testData/inspections/graphqls/SchemaResolverInspection/withValidSchemaResolverInterface/schema.graphqls b/testData/inspections/graphqls/SchemaResolverInspection/withValidSchemaResolverInterface/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") @doc(description: "Test")
+}
diff --git a/testData/project/magento2/vendor/magento/module-catalog-graph-ql/Model/Resolver/ImplementsBatchResolverInterface.php b/testData/project/magento2/vendor/magento/module-catalog-graph-ql/Model/Resolver/ImplementsBatchResolverInterface.php
@@ -0,0 +1,14 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CatalogGraphQl\Model\Resolver;
+
+use Magento\Framework\GraphQl\Query\Resolver\BatchResolverInterface;
+
+class ImplementsBatchResolverInterface implements BatchResolverInterface
+{
+}
diff --git a/testData/project/magento2/vendor/magento/module-catalog-graph-ql/Model/Resolver/ImplementsBatchServiceContractResolverInterface.php b/testData/project/magento2/vendor/magento/module-catalog-graph-ql/Model/Resolver/ImplementsBatchServiceContractResolverInterface.php
@@ -0,0 +1,14 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CatalogGraphQl\Model\Resolver;
+
+use Magento\Framework\GraphQl\Query\Resolver\BatchServiceContractResolverInterface;
+
+class ImplementsBatchServiceContractResolverInterface implements BatchServiceContractResolverInterface
+{
+}
diff --git a/testData/project/magento2/vendor/magento/module-catalog-graph-ql/Model/Resolver/ImplementsResolverInterface.php b/testData/project/magento2/vendor/magento/module-catalog-graph-ql/Model/Resolver/ImplementsResolverInterface.php
@@ -0,0 +1,14 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CatalogGraphQl\Model\Resolver;
+
+use Magento\Framework\GraphQl\Query\ResolverInterface;
+
+class ImplementsResolverInterface implements ResolverInterface
+{
+}
diff --git a/tests/com/magento/idea/magento2plugin/BaseProjectTestCase.java b/tests/com/magento/idea/magento2plugin/BaseProjectTestCase.java
@@ -8,7 +8,6 @@
 import com.intellij.testFramework.fixtures.BasePlatformTestCase;
 import com.magento.idea.magento2plugin.indexes.IndexManager;
 import com.magento.idea.magento2plugin.project.Settings;
-import com.magento.idea.magento2plugin.project.util.GetProjectBasePath;
 import com.magento.idea.magento2plugin.magento.packages.File;
 
 /**
@@ -65,4 +64,5 @@ protected String prepareFixturePath(String fileName, String fixturesFolderPath)
     private String name() {
         return StringUtil.trimEnd(getTestName(true), "Test");
     }
+
 }
diff --git a/tests/com/magento/idea/magento2plugin/inspections/BaseInspectionsTestCase.java b/tests/com/magento/idea/magento2plugin/inspections/BaseInspectionsTestCase.java
@@ -0,0 +1,52 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.inspections;
+
+import com.intellij.codeInsight.daemon.impl.HighlightInfo;
+import com.magento.idea.magento2plugin.BaseProjectTestCase;
+import com.magento.idea.magento2plugin.bundles.InspectionBundle;
+import java.util.List;
+
+/**
+ * Configure test environment with Magento 2 project
+ */
+abstract public class BaseInspectionsTestCase extends BaseProjectTestCase {
+    protected final InspectionBundle inspectionBundle = new InspectionBundle();
+
+    protected void assertHasHighlighting(String message) {
+        String highlightingNotFound = "Failed that documents contains highlighting with the description `%s`";
+
+        List<HighlightInfo> highlightingList = myFixture.doHighlighting();
+        if (highlightingList.isEmpty()) {
+            fail(String.format(highlightingNotFound, message));
+        }
+
+        for (HighlightInfo highlighting :
+                highlightingList) {
+            if (highlighting.getDescription() == null) continue;
+            if (highlighting.getDescription().equals(message)) {
+                return;
+            }
+        }
+        fail(String.format(highlightingNotFound, message));
+    }
+
+    protected void assertHasNoHighlighting(String message) {
+        String highlightingNotFound = "Failed that documents not contains highlighting with the description `%s`";
+
+        List<HighlightInfo> highlightingList = myFixture.doHighlighting();
+        if (highlightingList.isEmpty()) {
+            return;
+        }
+
+        for (HighlightInfo highlighting :
+                highlightingList) {
+            if (highlighting.getDescription() == null) continue;
+            if (highlighting.getDescription().equals(message)) {
+                fail(String.format(highlightingNotFound, message));
+            }
+        }
+    }
+}
diff --git a/tests/com/magento/idea/magento2plugin/inspections/graphqls/InspectionGraphqlsFixtureTestCase.java b/tests/com/magento/idea/magento2plugin/inspections/graphqls/InspectionGraphqlsFixtureTestCase.java
@@ -0,0 +1,30 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.inspections.graphqls;
+
+import com.magento.idea.magento2plugin.inspections.BaseInspectionsTestCase;
+import com.magento.idea.magento2plugin.magento.packages.File;
+
+abstract public class InspectionGraphqlsFixtureTestCase extends BaseInspectionsTestCase {
+
+    private static final String testDataFolderPath = "testData" + File.separator + "inspections" + File.separator;
+    private static final String fixturesFolderPath = "graphqls" + File.separator;
+
+    @Override
+    protected void setUp() throws Exception {
+        super.setUp();
+        myFixture.setTestDataPath(testDataFolderPath);
+    }
+
+    @Override
+    protected boolean isWriteActionRequired() {
+        return false;
+    }
+
+    protected String getFixturePath(String fileName) {
+        return prepareFixturePath(fileName, fixturesFolderPath);
+    }
+}
diff --git a/tests/com/magento/idea/magento2plugin/inspections/graphqls/SchemaResolverInspectionTest.java b/tests/com/magento/idea/magento2plugin/inspections/graphqls/SchemaResolverInspectionTest.java
@@ -0,0 +1,46 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.inspections.graphqls;
+
+import com.magento.idea.magento2plugin.magento.files.GraphQLSchema;
+
+public class SchemaResolverInspectionTest extends InspectionGraphqlsFixtureTestCase {
+
+    private final String errorMessage =  inspectionBundle.message(
+            "inspection.graphql.resolver.mustImplement"
+    );
+
+    @Override
+    public void setUp() throws Exception {
+        super.setUp();
+        myFixture.enableInspections(SchemaResolverInspection.class);
+    }
+
+    protected boolean isWriteActionRequired() {
+        return false;
+    }
+
+    public void testWithValidSchemaResolverInterface() throws Exception {
+        myFixture.configureByFile(getFixturePath(GraphQLSchema.FILE_NAME));
+        assertHasNoHighlighting(errorMessage);
+    }
+
+    public void testWithInvalidSchemaResolverInterface() throws Exception {
+        myFixture.configureByFile(getFixturePath(GraphQLSchema.FILE_NAME));
+        assertHasHighlighting(errorMessage);
+    }
+
+    public void testWithValidBatchResolverInterface() throws Exception {
+        myFixture.configureByFile(getFixturePath(GraphQLSchema.FILE_NAME));
+
+        assertHasNoHighlighting(errorMessage);
+    }
+
+    public void testWithValidBatchServiceContractResolverInterface() throws Exception {
+        myFixture.configureByFile(getFixturePath(GraphQLSchema.FILE_NAME));
+
+        assertHasNoHighlighting(errorMessage);
+    }
+}
diff --git a/tests/com/magento/idea/magento2plugin/inspections/php/GraphQlResolverInspectionTest.java b/tests/com/magento/idea/magento2plugin/inspections/php/GraphQlResolverInspectionTest.java
@@ -8,7 +8,6 @@
 
 public class GraphQlResolverInspectionTest extends InspectionPhpFixtureTestCase {
 
-    private final InspectionBundle inspectionBundle = new InspectionBundle();
     private final String errorMessage =  inspectionBundle.message(
         "inspection.graphql.resolver.mustImplement"
     );
diff --git a/tests/com/magento/idea/magento2plugin/inspections/php/InspectionPhpFixtureTestCase.java b/tests/com/magento/idea/magento2plugin/inspections/php/InspectionPhpFixtureTestCase.java
@@ -4,12 +4,10 @@
  */
 package com.magento.idea.magento2plugin.inspections.php;
 
-import com.intellij.codeInsight.daemon.impl.HighlightInfo;
-import com.magento.idea.magento2plugin.BaseProjectTestCase;
+import com.magento.idea.magento2plugin.inspections.BaseInspectionsTestCase;
 import com.magento.idea.magento2plugin.magento.packages.File;
-import java.util.List;
 
-abstract public class InspectionPhpFixtureTestCase extends BaseProjectTestCase {
+abstract public class InspectionPhpFixtureTestCase extends BaseInspectionsTestCase {
 
     private static final String testDataFolderPath = "testData" + File.separator + "inspections" + File.separator;
     private static final String fixturesFolderPath = "php" + File.separator;
@@ -28,37 +26,4 @@ protected boolean isWriteActionRequired() {
     protected String getFixturePath(String fileName) {
         return prepareFixturePath(fileName, fixturesFolderPath);
     }
-
-    protected void assertHasHighlighting(String message) {
-        String highlightingNotFound = "Failed that documents contains highlighting with the description `%s`";
-
-        List<HighlightInfo> highlightingList = myFixture.doHighlighting();
-        if (highlightingList.isEmpty()) {
-            fail(String.format(highlightingNotFound, message));
-        }
-
-        for (HighlightInfo highlighting :
-            highlightingList) {
-            if (highlighting.getDescription().equals(message)) {
-                return;
-            }
-        }
-        fail(String.format(highlightingNotFound, message));
-    }
-
-    protected void assertHasNoHighlighting(String message) {
-        String highlightingFound = "Failed that documents not contains highlighting with the description `%s`";
-
-        List<HighlightInfo> highlightingList = myFixture.doHighlighting();
-        if (highlightingList.isEmpty()) {
-            return;
-        }
-
-        for (HighlightInfo highlighting :
-            highlightingList) {
-            if (highlighting.getDescription().equals(message)) {
-                fail(String.format(highlightingFound, message));
-            }
-        }
-    }
 }
diff --git a/tests/com/magento/idea/magento2plugin/inspections/xml/InspectionXmlFixtureTestCase.java b/tests/com/magento/idea/magento2plugin/inspections/xml/InspectionXmlFixtureTestCase.java
