Merge pull request #752 from bohdan-harniuk/uct-inspection-non-existent-class

Eduard Chitoraga · web-flow · commit be7dc4339a1a · 2021-11-11T21:12:58.000+02:00
UCT-706: Developed existence check through VersionStateManager, added ImportingNonExistenceClass inspection
diff --git a/resources/META-INF/plugin.xml b/resources/META-INF/plugin.xml
@@ -340,6 +340,13 @@
                          enabledByDefault="false"
                          level="WARNING"
                          implementationClass="com.magento.idea.magento2uct.inspections.php.deprecation.UsingDeprecatedProperty"/>
+        <localInspection language="PHP" groupPath="UCT"
+                         shortName="ImportingNonExistentClass"
+                         bundle="uct.bundle.inspection" key="inspection.displayName.ImportingNonExistentClass"
+                         groupBundle="uct.bundle.inspection" groupKey="inspection.existence.group.name"
+                         enabledByDefault="false"
+                         level="ERROR"
+                         implementationClass="com.magento.idea.magento2uct.inspections.php.existence.ImportingNonExistentClass"/>
         <!-- \UCT inspection -->
 
         <internalFileTemplate name="Magento Composer JSON"/>
diff --git a/resources/inspectionDescriptions/ImportingNonExistentClass.html b/resources/inspectionDescriptions/ImportingNonExistentClass.html
@@ -0,0 +1,6 @@
+<html>
+<body>
+<p>[1112] The imported class is no longer present in the codebase.</p>
+<!-- tooltip end -->
+</body>
+</html>
diff --git a/resources/uct/bundle/inspection.properties b/resources/uct/bundle/inspection.properties
@@ -1,4 +1,5 @@
-inspection.deprecation.group.name=Deprecation Inspections
+inspection.deprecation.group.name=Deprecation
+inspection.existence.group.name=Existence
 inspection.issues.description.link=Check https://devdocs.magento.com/upgrade-compatibility-tool/errors.html for a detailed list of Upgrade Compatibility Tool errors.
 inspection.displayName.ExtendingDeprecatedClass=Extending from @deprecated class
 inspection.displayName.ImportingDeprecatedClass=Importing @deprecated class
@@ -12,6 +13,7 @@ inspection.displayName.InheritedDeprecatedInterface=Inherited from @deprecated i
 inspection.displayName.ImplementedDeprecatedInterface=Implemented @deprecated interface
 inspection.displayName.CallingDeprecatedMethod=Call @deprecated method
 inspection.displayName.UsingDeprecatedProperty=Using @deprecated property
+inspection.displayName.ImportingNonExistentClass=Importing non-existent Adobe Commerce class
 customCode.warnings.deprecated.1131=[1131] Extending from @deprecated class ''{0}''
 customCode.warnings.deprecated.1132=[1132] Importing @deprecated class ''{0}''
 customCode.warnings.deprecated.1134=[1134] Using @deprecated class ''{0}''
@@ -24,3 +26,5 @@ customCode.warnings.deprecated.1338=[1338] Implemented @deprecated interface ''{
 customCode.warnings.deprecated.1439=[1439] Call @deprecated method ''{0}''
 customCode.warnings.deprecated.1534=[1534] Using @deprecated property ''{0}''
 customCode.warnings.deprecated.1535=[1535] Overriding @deprecated property ''{0}''
+customCode.critical.existence.1112=[1112] Imported non-existent class ''{0}''
+customCode.critical.existence.1112.changelog=[1112] Imported class ''{0}'' that is removed in the ''{1}''
diff --git a/src/com/magento/idea/magento2uct/inspections/php/ImportInspection.java b/src/com/magento/idea/magento2uct/inspections/php/ImportInspection.java
@@ -3,7 +3,7 @@
  * See COPYING.txt for license details.
  */
 
-package com.magento.idea.magento2uct.inspections.php.deprecation;
+package com.magento.idea.magento2uct.inspections.php;
 
 import com.intellij.codeInspection.ProblemsHolder;
 import com.intellij.openapi.project.Project;
@@ -20,33 +20,11 @@
 import com.magento.idea.magento2plugin.util.GetFirstClassOfFile;
 import com.magento.idea.magento2uct.packages.IssueSeverityLevel;
 import com.magento.idea.magento2uct.settings.UctSettingsService;
-import com.magento.idea.magento2uct.versioning.VersionStateManager;
 import org.jetbrains.annotations.NotNull;
 
-public abstract class ImportingDeprecatedType extends PhpInspection {
-
-    /**
-     * Register type specific problem.
-     *
-     * @param problemsHolder ProblemsHolder
-     * @param use PhpUse
-     * @param isInterface boolean
-     */
-    protected abstract void registerProblem(
-            final @NotNull ProblemsHolder problemsHolder,
-            final PhpUse use,
-            final boolean isInterface
-    );
-
-    /**
-     * Get issue severity level for concrete inspection.
-     *
-     * @return IssueSeverityLevel
-     */
-    protected abstract IssueSeverityLevel getSeverityLevel();
+public abstract class ImportInspection extends PhpInspection {
 
     @Override
-    @SuppressWarnings({"PMD.CognitiveComplexity", "PMD.AvoidDeeplyNestedIfStmts"})
     public @NotNull PsiElementVisitor buildVisitor(
             final @NotNull ProblemsHolder problemsHolder,
             final boolean isOnTheFly
@@ -62,45 +40,57 @@ public void visitPhpUseList(final PhpUseList useList) {
                         || !settings.isIssueLevelSatisfiable(getSeverityLevel())) {
                     return;
                 }
-                final PhpClass phpClass = getParentClass(useList);
+                final PsiFile file = useList.getContainingFile();
+                final PhpClass phpClass = GetFirstClassOfFile.getInstance().execute((PhpFile) file);
 
                 if (phpClass == null) {
                     return;
                 }
-                for (final PhpUse use : useList.getDeclarations()) {
-                    if (VersionStateManager.getInstance(project).isDeprecated(use.getFQN())) {
-                        final PhpReference phpReference = use.getTargetReference();
-                        boolean isInterface = false;
-
-                        if (phpReference != null) {
-                            final PsiElement element = phpReference.resolve();
 
-                            if (element instanceof PhpClass
-                                    && ((PhpClass) element).isInterface()) {
-                                isInterface = true;
-                            }
-                        }
-                        registerProblem(problemsHolder, use, isInterface);
-                    }
+                for (final PhpUse use : useList.getDeclarations()) {
+                    execute(project, problemsHolder, use, isInterface(use));
                 }
             }
 
             /**
-             * Get parent class for use list.
+             * Check if inspected use is an interface.
              *
-             * @param useList PhpUseList
+             * @param use PhpUse
              *
-             * @return PhpClass
+             * @return boolean
              */
-            private PhpClass getParentClass(final PhpUseList useList) {
-                final PsiFile file = useList.getContainingFile();
+            private boolean isInterface(final PhpUse use) {
+                final PhpReference phpReference = use.getTargetReference();
 
-                if (!(file instanceof PhpFile)) {
-                    return null;
+                if (phpReference != null) {
+                    final PsiElement element = phpReference.resolve();
+                    return element instanceof PhpClass && ((PhpClass) element).isInterface();
                 }
 
-                return GetFirstClassOfFile.getInstance().execute((PhpFile) file);
+                return false;
             }
         };
     }
+
+    /**
+     * Implement this method to specify inspection logic.
+     *
+     * @param project Project
+     * @param problemsHolder ProblemsHolder
+     * @param use PhpUse
+     * @param isInterface boolean
+     */
+    protected abstract void execute(
+            final Project project,
+            final @NotNull ProblemsHolder problemsHolder,
+            final PhpUse use,
+            final boolean isInterface
+    );
+
+    /**
+     * Implement this method to specify issue severity level for target inspection.
+     *
+     * @return IssueSeverityLevel
+     */
+    protected abstract IssueSeverityLevel getSeverityLevel();
 }
diff --git a/src/com/magento/idea/magento2uct/inspections/php/deprecation/ImportingDeprecatedClass.java b/src/com/magento/idea/magento2uct/inspections/php/deprecation/ImportingDeprecatedClass.java
@@ -7,21 +7,28 @@
 
 import com.intellij.codeInspection.ProblemHighlightType;
 import com.intellij.codeInspection.ProblemsHolder;
+import com.intellij.openapi.project.Project;
 import com.jetbrains.php.lang.psi.elements.PhpUse;
 import com.magento.idea.magento2uct.inspections.UctProblemsHolder;
+import com.magento.idea.magento2uct.inspections.php.ImportInspection;
 import com.magento.idea.magento2uct.packages.IssueSeverityLevel;
 import com.magento.idea.magento2uct.packages.SupportedIssue;
+import com.magento.idea.magento2uct.versioning.VersionStateManager;
 import org.jetbrains.annotations.NotNull;
 
-public class ImportingDeprecatedClass extends ImportingDeprecatedType {
+public class ImportingDeprecatedClass extends ImportInspection {
 
     @Override
-    protected void registerProblem(
+    protected void execute(
+            final Project project,
             final @NotNull ProblemsHolder problemsHolder,
             final PhpUse use,
             final boolean isInterface
     ) {
-        if (!isInterface) {
+        if (VersionStateManager.getInstance(project).isDeprecated(use.getFQN())) {
+            if (isInterface) {
+                return;
+            }
             if (problemsHolder instanceof UctProblemsHolder) {
                 ((UctProblemsHolder) problemsHolder).setReservedErrorCode(
                         SupportedIssue.IMPORTING_DEPRECATED_CLASS.getCode()
diff --git a/src/com/magento/idea/magento2uct/inspections/php/deprecation/ImportingDeprecatedInterface.java b/src/com/magento/idea/magento2uct/inspections/php/deprecation/ImportingDeprecatedInterface.java
@@ -7,21 +7,28 @@
 
 import com.intellij.codeInspection.ProblemHighlightType;
 import com.intellij.codeInspection.ProblemsHolder;
+import com.intellij.openapi.project.Project;
 import com.jetbrains.php.lang.psi.elements.PhpUse;
 import com.magento.idea.magento2uct.inspections.UctProblemsHolder;
+import com.magento.idea.magento2uct.inspections.php.ImportInspection;
 import com.magento.idea.magento2uct.packages.IssueSeverityLevel;
 import com.magento.idea.magento2uct.packages.SupportedIssue;
+import com.magento.idea.magento2uct.versioning.VersionStateManager;
 import org.jetbrains.annotations.NotNull;
 
-public class ImportingDeprecatedInterface extends ImportingDeprecatedType {
+public class ImportingDeprecatedInterface extends ImportInspection {
 
     @Override
-    protected void registerProblem(
+    protected void execute(
+            final Project project,
             final @NotNull ProblemsHolder problemsHolder,
             final PhpUse use,
             final boolean isInterface
     ) {
-        if (isInterface) {
+        if (VersionStateManager.getInstance(project).isDeprecated(use.getFQN())) {
+            if (!isInterface) {
+                return;
+            }
             if (problemsHolder instanceof UctProblemsHolder) {
                 ((UctProblemsHolder) problemsHolder).setReservedErrorCode(
                         SupportedIssue.IMPORTING_DEPRECATED_INTERFACE.getCode()
diff --git a/src/com/magento/idea/magento2uct/inspections/php/existence/ImportingNonExistentClass.java b/src/com/magento/idea/magento2uct/inspections/php/existence/ImportingNonExistentClass.java
@@ -0,0 +1,53 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2uct.inspections.php.existence;
+
+import com.intellij.codeInspection.ProblemHighlightType;
+import com.intellij.codeInspection.ProblemsHolder;
+import com.intellij.openapi.project.Project;
+import com.jetbrains.php.lang.psi.elements.PhpUse;
+import com.magento.idea.magento2uct.inspections.UctProblemsHolder;
+import com.magento.idea.magento2uct.inspections.php.ImportInspection;
+import com.magento.idea.magento2uct.packages.IssueSeverityLevel;
+import com.magento.idea.magento2uct.packages.SupportedIssue;
+import com.magento.idea.magento2uct.versioning.VersionStateManager;
+import org.jetbrains.annotations.NotNull;
+
+public class ImportingNonExistentClass extends ImportInspection {
+
+    @Override
+    protected void execute(
+            final Project project,
+            final @NotNull ProblemsHolder problemsHolder,
+            final PhpUse use,
+            final boolean isInterface
+    ) {
+        if (isInterface || VersionStateManager.getInstance(project).isExists(use.getFQN())) {
+            return;
+        }
+        final String removedIn = VersionStateManager.getInstance(project).getRemovedInVersion();
+        final String message = removedIn.isEmpty()
+                ? SupportedIssue.IMPORTED_NON_EXISTENT_CLASS.getMessage(use.getFQN())
+                : SupportedIssue.IMPORTED_NON_EXISTENT_CLASS.getChangelogMessage(
+                        use.getFQN(), removedIn);
+
+        if (problemsHolder instanceof UctProblemsHolder) {
+            ((UctProblemsHolder) problemsHolder).setReservedErrorCode(
+                    SupportedIssue.IMPORTED_NON_EXISTENT_CLASS.getCode()
+            );
+        }
+        problemsHolder.registerProblem(
+                use,
+                message,
+                ProblemHighlightType.ERROR
+        );
+    }
+
+    @Override
+    protected IssueSeverityLevel getSeverityLevel() {
+        return SupportedIssue.IMPORTED_NON_EXISTENT_CLASS.getLevel();
+    }
+}
diff --git a/src/com/magento/idea/magento2uct/packages/SupportedIssue.java b/src/com/magento/idea/magento2uct/packages/SupportedIssue.java
@@ -21,6 +21,7 @@
 import com.magento.idea.magento2uct.inspections.php.deprecation.UsingDeprecatedConstant;
 import com.magento.idea.magento2uct.inspections.php.deprecation.UsingDeprecatedInterface;
 import com.magento.idea.magento2uct.inspections.php.deprecation.UsingDeprecatedProperty;
+import com.magento.idea.magento2uct.inspections.php.existence.ImportingNonExistentClass;
 import java.lang.reflect.InvocationTargetException;
 import java.util.LinkedList;
 import java.util.List;
@@ -99,11 +100,19 @@ public enum SupportedIssue {
             IssueSeverityLevel.WARNING,
             "customCode.warnings.deprecated.1534",
             UsingDeprecatedProperty.class
+    ),
+    IMPORTED_NON_EXISTENT_CLASS(
+            1112,
+            IssueSeverityLevel.CRITICAL,
+            "customCode.critical.existence.1112",
+            ImportingNonExistentClass.class,
+            "customCode.critical.existence.1112.changelog"
     );
 
     private final int code;
     private final IssueSeverityLevel level;
-    private final String messageKey;
+    private final String message;
+    private final String changelogMessage;
     private final Class<? extends LocalInspectionTool> inspectionClass;
     private static final UctInspectionBundle BUNDLE = new UctInspectionBundle();
 
@@ -112,19 +121,39 @@ public enum SupportedIssue {
      *
      * @param code IssueSeverityLevel
      * @param level IssueSeverityLevel
-     * @param messageKey String
+     * @param message String
      * @param inspectionClass Class
      */
     SupportedIssue(
             final int code,
             final IssueSeverityLevel level,
-            final String messageKey,
+            final String message,
             final Class<? extends LocalInspectionTool> inspectionClass
+    ) {
+        this(code, level, message, inspectionClass, null);
+    }
+
+    /**
+     * Known issue ENUM.
+     *
+     * @param code IssueSeverityLevel
+     * @param level IssueSeverityLevel
+     * @param message String
+     * @param inspectionClass Class
+     * @param changelogMessage String
+     */
+    SupportedIssue(
+            final int code,
+            final IssueSeverityLevel level,
+            final String message,
+            final Class<? extends LocalInspectionTool> inspectionClass,
+            final String changelogMessage
     ) {
         this.code = code;
         this.level = level;
-        this.messageKey = messageKey;
+        this.message = message;
         this.inspectionClass = inspectionClass;
+        this.changelogMessage = changelogMessage;
     }
 
     /**
@@ -153,7 +182,22 @@ public IssueSeverityLevel getLevel() {
      * @return String
      */
     public String getMessage(final Object... args) {
-        return BUNDLE.message(messageKey, args);
+        return BUNDLE.message(message, args);
+    }
+
+    /**
+     * Get bundle message for the issue (including changelog arguments).
+     *
+     * @param args Object
+     *
+     * @return String
+     */
+    public String getChangelogMessage(final Object... args) {
+        if (changelogMessage == null) {
+            return getMessage(args);
+        }
+
+        return BUNDLE.message(changelogMessage, args);
     }
 
     /**
diff --git a/src/com/magento/idea/magento2uct/versioning/VersionStateManager.java b/src/com/magento/idea/magento2uct/versioning/VersionStateManager.java
diff --git a/src/com/magento/idea/magento2uct/versioning/indexes/data/ExistenceStateIndex.java b/src/com/magento/idea/magento2uct/versioning/indexes/data/ExistenceStateIndex.java

-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +<html>
 +<body>
 +<p>[1112] The imported class is no longer present in the codebase.</p>
 +<!-- tooltip end -->
 +</body>
 +</html>