UCT-722: Developed ImportedNonApiClass inspection

bohdan-harniuk · bohdan-harniuk · commit 18a245214503 · 2021-11-17T16:50:48.000+01:00
diff --git a/resources/META-INF/plugin.xml b/resources/META-INF/plugin.xml
@@ -403,6 +403,13 @@
                          enabledByDefault="false"
                          level="ERROR"
                          implementationClass="com.magento.idea.magento2uct.inspections.php.existence.UsedNonExistentType"/>
+        <localInspection language="PHP" groupPath="UCT"
+                         shortName="ImportedNonApiClass"
+                         bundle="uct.bundle.inspection" key="inspection.displayName.ImportedNonApiClass"
+                         groupBundle="uct.bundle.inspection" groupKey="inspection.api.group.name"
+                         enabledByDefault="false"
+                         level="WARNING"
+                         implementationClass="com.magento.idea.magento2uct.inspections.php.api.ImportedNonApiClass"/>
         <!-- \UCT inspection -->
 
         <internalFileTemplate name="Magento Composer JSON"/>
diff --git a/resources/inspectionDescriptions/ImportedNonApiClass.html b/resources/inspectionDescriptions/ImportedNonApiClass.html
@@ -0,0 +1,6 @@
+<html>
+<body>
+<p>[1122] The imported class is not marked as an API.</p>
+<!-- tooltip end -->
+</body>
+</html>
diff --git a/resources/uct/bundle/inspection.properties b/resources/uct/bundle/inspection.properties
@@ -1,5 +1,6 @@
 inspection.deprecation.group.name=Deprecation
 inspection.existence.group.name=Existence
+inspection.api.group.name=API
 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
@@ -22,6 +23,7 @@ inspection.displayName.OverriddenNonExistentConstant=Overridden non-existent Ado
 inspection.displayName.OverriddenNonExistentProperty=Overridden non-existent Adobe Commerce property
 inspection.displayName.CalledNonExistentMethod=Call non-existent Adobe Commerce method
 inspection.displayName.UsedNonExistentType=Used non-existent Adobe Commerce type
+inspection.displayName.ImportedNonApiClass=Imported non Adobe Commerce API 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}''
@@ -43,3 +45,4 @@ customCode.critical.existence.1215=[1215] Overridden constant ''{0}'' that is re
 customCode.critical.existence.1515=[1515] Overridden property ''{0}'' that is removed in the ''{1}''
 customCode.critical.existence.1410=[1410] Called method ''{0}'' that is removed in the ''{1}''
 customCode.critical.existence.1110=[1110] Used type ''{0}'' that is removed in the ''{1}''
+customCode.critical.api.1122=[1122] Imported class ''{0}'' is not marked as an API
diff --git a/src/com/magento/idea/magento2uct/inspections/php/api/ImportedNonApiClass.java b/src/com/magento/idea/magento2uct/inspections/php/api/ImportedNonApiClass.java
@@ -0,0 +1,45 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2uct.inspections.php.api;
+
+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 ImportedNonApiClass extends ImportInspection {
+
+    @Override
+    protected void execute(
+            final Project project,
+            final @NotNull ProblemsHolder problemsHolder,
+            final PhpUse use,
+            final boolean isInterface
+    ) {
+        if (isInterface || VersionStateManager.getInstance(project).isApi(use.getFQN())) {
+            return;
+        }
+        final String message = SupportedIssue.IMPORTED_NON_API_CLASS.getMessage(use.getFQN());
+
+        if (problemsHolder instanceof UctProblemsHolder) {
+            ((UctProblemsHolder) problemsHolder).setReservedErrorCode(
+                    SupportedIssue.IMPORTED_NON_API_CLASS.getCode()
+            );
+        }
+        problemsHolder.registerProblem(use, message, ProblemHighlightType.WARNING);
+    }
+
+    @Override
+    protected IssueSeverityLevel getSeverityLevel() {
+        return SupportedIssue.IMPORTED_NON_API_CLASS.getLevel();
+    }
+}
diff --git a/src/com/magento/idea/magento2uct/packages/SupportedIssue.java b/src/com/magento/idea/magento2uct/packages/SupportedIssue.java
@@ -9,6 +9,7 @@
 import com.intellij.psi.PsiElementVisitor;
 import com.magento.idea.magento2uct.bundles.UctInspectionBundle;
 import com.magento.idea.magento2uct.inspections.UctProblemsHolder;
+import com.magento.idea.magento2uct.inspections.php.api.ImportedNonApiClass;
 import com.magento.idea.magento2uct.inspections.php.deprecation.CallingDeprecatedMethod;
 import com.magento.idea.magento2uct.inspections.php.deprecation.ExtendingDeprecatedClass;
 import com.magento.idea.magento2uct.inspections.php.deprecation.ImplementedDeprecatedInterface;
@@ -162,6 +163,12 @@ public enum SupportedIssue {
             IssueSeverityLevel.CRITICAL,
             "customCode.critical.existence.1110",
             UsedNonExistentType.class
+    ),
+    IMPORTED_NON_API_CLASS(
+            1122,
+            IssueSeverityLevel.ERROR,
+            "customCode.critical.api.1122",
+            ImportedNonApiClass.class
     );
 
     private final int code;

-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +<html>
 +<body>
 +<p>[1122] The imported class is not marked as an API.</p>
 +<!-- tooltip end -->
 +</body>
 +</html>