Merge pull request #639 from bohdan-harniuk/uct-project-dev

eduard13 · web-flow · commit b4d26e7a604c · 2021-09-15T00:07:27.000+03:00
Additional changes to both the built-in UCT and UCT Run Configuration
diff --git a/resources/inspectionDescriptions/CallingDeprecatedMethod.html b/resources/inspectionDescriptions/CallingDeprecatedMethod.html
@@ -2,6 +2,5 @@
 <body>
 <p>[1439] Call Adobe Commerce @deprecated method: The deprecated method will be removed in upcoming versions. Consider relying on methods declared in API interfaces instead.</p>
 <!-- tooltip end -->
-<p>Text after this comment will only be shown in the settings of the inspection.</p>
 </body>
 </html>
diff --git a/resources/inspectionDescriptions/ExtendingDeprecatedClass.html b/resources/inspectionDescriptions/ExtendingDeprecatedClass.html
@@ -2,6 +2,5 @@
 <body>
 <p>[1131] Extending from Adobe Commerce @deprecated class: The extended class will be removed in upcoming versions. Inheritance is not recommended way of extending Adobe Commerce functionality. Update code to use a class marked as @api.</p>
 <!-- tooltip end -->
-<p>Text after this comment will only be shown in the settings of the inspection.</p>
 </body>
 </html>
diff --git a/resources/inspectionDescriptions/ImplementedDeprecatedInterface.html b/resources/inspectionDescriptions/ImplementedDeprecatedInterface.html
@@ -2,6 +2,5 @@
 <body>
 <p>[1338] Implemented Adobe Commerce @deprecated interface: The deprecated interface will be removed in upcoming versions. Consider removing the interface inheritance, using an interface marked as @api or an interface introduced within your implementation instead.</p>
 <!-- tooltip end -->
-<p>Text after this comment will only be shown in the settings of the inspection.</p>
 </body>
 </html>
diff --git a/resources/inspectionDescriptions/ImportingDeprecatedClass.html b/resources/inspectionDescriptions/ImportingDeprecatedClass.html
@@ -2,6 +2,5 @@
 <body>
 <p>[1132] Importing Adobe Commerce @deprecated class: The extended class will be removed in upcoming versions. Consider using Adobe Commerce class marked as @api instead.</p>
 <!-- tooltip end -->
-<p>Text after this comment will only be shown in the settings of the inspection.</p>
 </body>
 </html>
diff --git a/resources/inspectionDescriptions/ImportingDeprecatedInterface.html b/resources/inspectionDescriptions/ImportingDeprecatedInterface.html
@@ -2,6 +2,5 @@
 <body>
 <p>[1332] Imported Adobe Commerce @deprecated interface: The deprecated interface will be removed in upcoming versions. Consider using an interface or class marked as @api instead.</p>
 <!-- tooltip end -->
-<p>Text after this comment will only be shown in the settings of the inspection.</p>
 </body>
 </html>
diff --git a/resources/inspectionDescriptions/InheritedDeprecatedInterface.html b/resources/inspectionDescriptions/InheritedDeprecatedInterface.html
@@ -2,6 +2,5 @@
 <body>
 <p>[1337] Inherited from Adobe Commerce @deprecated interface: The deprecated interface will be removed in upcoming versions. Consider removing the interface inheritance, using an interface marked as @api or an interface introduced within your implementation instead.</p>
 <!-- tooltip end -->
-<p>Text after this comment will only be shown in the settings of the inspection.</p>
 </body>
 </html>
diff --git a/resources/inspectionDescriptions/OverridingDeprecatedConstant.html b/resources/inspectionDescriptions/OverridingDeprecatedConstant.html
@@ -2,6 +2,5 @@
 <body>
 <p>[1235] Overriding Adobe Commerce @deprecated constant: The deprecated constant will be removed in upcoming versions. Consider using a constant marked as @api or a private constant within your implementation instead.</p>
 <!-- tooltip end -->
-<p>Text after this comment will only be shown in the settings of the inspection.</p>
 </body>
 </html>
diff --git a/resources/inspectionDescriptions/OverridingDeprecatedProperty.html b/resources/inspectionDescriptions/OverridingDeprecatedProperty.html
@@ -2,6 +2,5 @@
 <body>
 <p>[1535] Overriding Adobe Commerce @deprecated property: The deprecated property will be removed in upcoming versions. Consider relying on methods declared in API interfaces or using a private property within your implementation instead.</p>
 <!-- tooltip end -->
-<p>Text after this comment will only be shown in the settings of the inspection.</p>
 </body>
 </html>
diff --git a/resources/inspectionDescriptions/UsingDeprecatedClass.html b/resources/inspectionDescriptions/UsingDeprecatedClass.html
@@ -2,6 +2,5 @@
 <body>
 <p>[1134] Using Adobe Commerce @deprecated class: The extended class will be removed in upcoming versions. Consider using Adobe Commerce class marked as @api instead.</p>
 <!-- tooltip end -->
-<p>Text after this comment will only be shown in the settings of the inspection.</p>
 </body>
 </html>
diff --git a/resources/inspectionDescriptions/UsingDeprecatedConstant.html b/resources/inspectionDescriptions/UsingDeprecatedConstant.html
@@ -2,6 +2,5 @@
 <body>
 <p>[1234] Using Adobe Commerce @deprecated constant: The deprecated constant will be removed in upcoming versions. Consider using a constant marked as @api or a private constant within your implementation instead.</p>
 <!-- tooltip end -->
-<p>Text after this comment will only be shown in the settings of the inspection.</p>
 </body>
 </html>
diff --git a/resources/inspectionDescriptions/UsingDeprecatedInterface.html b/resources/inspectionDescriptions/UsingDeprecatedInterface.html
@@ -2,6 +2,5 @@
 <body>
 <p>[1334] Used Adobe Commerce @deprecated interface: The deprecated interface will be removed in upcoming versions. Consider using an interface or class marked as @api instead.</p>
 <!-- tooltip end -->
-<p>Text after this comment will only be shown in the settings of the inspection.</p>
 </body>
 </html>
diff --git a/resources/inspectionDescriptions/UsingDeprecatedProperty.html b/resources/inspectionDescriptions/UsingDeprecatedProperty.html
@@ -2,6 +2,5 @@
 <body>
 <p>[1534] Using Adobe Commerce @deprecated property: The deprecated method will be removed in upcoming versions. Consider relying on methods declared in API interfaces instead.</p>
 <!-- tooltip end -->
-<p>Text after this comment will only be shown in the settings of the inspection.</p>
 </body>
 </html>
diff --git a/src/com/magento/idea/magento2uct/execution/configurations/UctRunConfiguration.java b/src/com/magento/idea/magento2uct/execution/configurations/UctRunConfiguration.java
@@ -280,6 +280,7 @@ public boolean isNewlyCreated() {
                 if (hasIgnoreCurrentVersionIssues()) {
                     commandLine.addParameter("--ignore-current-version-compatibility-issues");
                 }
+                commandLine.addParameter("--context=phpstorm");
                 commandLine.addParameter("--ansi");
 
                 final OSProcessHandler processHandler = ProcessHandlerFactory
diff --git a/src/com/magento/idea/magento2uct/execution/configurations/UctSettingsEditor.form b/src/com/magento/idea/magento2uct/execution/configurations/UctSettingsEditor.form
@@ -84,7 +84,7 @@
           <text value="Minimum issue level to show in report. Default is [WARNING]."/>
         </properties>
       </component>
-      <component id="18a6c" class="javax.swing.JRadioButton" binding="ignoreCurrentVersionIssues">
+      <component id="18a6c" class="javax.swing.JCheckBox" binding="ignoreCurrentVersionIssues">
         <constraints>
           <grid row="10" column="1" row-span="1" col-span="1" vsize-policy="0" hsize-policy="3" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
         </constraints>
diff --git a/src/com/magento/idea/magento2uct/execution/configurations/UctSettingsEditor.java b/src/com/magento/idea/magento2uct/execution/configurations/UctSettingsEditor.java
@@ -29,12 +29,12 @@
 import java.awt.Container;
 import java.net.URI;
 import java.net.URISyntaxException;
+import javax.swing.JCheckBox;
 import javax.swing.JComboBox;
 import javax.swing.JComponent;
 import javax.swing.JLabel;
 import javax.swing.JOptionPane;
 import javax.swing.JPanel;
-import javax.swing.JRadioButton;
 import javax.swing.event.DocumentEvent;
 import org.jdesktop.swingx.JXHyperlink;
 import org.jetbrains.annotations.NotNull;
@@ -55,7 +55,7 @@ public class UctSettingsEditor extends SettingsEditor<UctRunConfiguration> {
     private LabeledComponent<TextFieldWithBrowseButton> modulePath;
     private JComboBox<ComboBoxItemData> comingVersion;
     private JComboBox<ComboBoxItemData> minIssueLevel;
-    private JRadioButton ignoreCurrentVersionIssues;
+    private JCheckBox ignoreCurrentVersionIssues;
     private JPanel warningPanel;
     private JLabel myScriptNameLabel;//NOPMD
     private JLabel comingVersionLabel;//NOPMD
@@ -239,7 +239,10 @@ private void lookupUctExecutablePath(
             uctExecutablePath = storedUctExecutable;
             return;
         }
-        final VirtualFile uctExecutableVf = UctModuleLocatorUtil.locateUctExecutable(project);
+        final VirtualFile uctExecutableVf = UctModuleLocatorUtil.locateUctExecutable(
+                project,
+                uctRunConfiguration.getProjectRoot()
+        );
 
         if (uctExecutableVf == null) {
             warningPanel.setVisible(true);
@@ -264,7 +267,11 @@ private String getStoredUctExecutablePath(
         if (!uctRunConfiguration.getScriptName().isEmpty()) {
             uctExecutablePath = uctRunConfiguration.getScriptName();
 
-            return uctExecutablePath;
+            if (UctExecutableValidatorUtil.validate(uctExecutablePath)) {
+                return uctExecutablePath;
+            } else {
+                uctRunConfiguration.setScriptName("");
+            }
         }
         if (!uctRunConfiguration.isNewlyCreated()) {
             return null;
@@ -298,10 +305,6 @@ private void initializeComboboxSources() {
             comingVersion.addItem(new ComboBoxItemData(version, version));
         }
 
-        minIssueLevel.addItem(
-                new ComboBoxItemData("", "Choose a minimum issue level to show in report")
-        );
-
         for (final IssueSeverityLevel level : IssueSeverityLevel.getSeverityLabels()) {
             minIssueLevel.addItem(
                     new ComboBoxItemData(String.valueOf(level.getLevel()), level.getLabel())
diff --git a/src/com/magento/idea/magento2uct/execution/output/ReportBuilder.java b/src/com/magento/idea/magento2uct/execution/output/ReportBuilder.java
@@ -28,6 +28,8 @@
 import java.util.ArrayList;
 import java.util.LinkedList;
 import java.util.List;
+import java.util.Locale;
+
 import org.jetbrains.annotations.NotNull;
 import org.json.simple.JSONObject;
 
@@ -39,7 +41,10 @@ public class ReportBuilder {
 
     private final Project project;
     private final Report report;
-    private final DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyyMMddHms");
+    private final DateTimeFormatter formatter = DateTimeFormatter.ofPattern(
+            "dd_MMM_yyyy_HH:mm:ss",
+            Locale.US
+    );
 
     /**
      * Report builder.
diff --git a/src/com/magento/idea/magento2uct/util/module/UctModuleLocatorUtil.java b/src/com/magento/idea/magento2uct/util/module/UctModuleLocatorUtil.java
@@ -27,14 +27,18 @@ private UctModuleLocatorUtil() {
     }
 
     /**
-     * Find UCT executable for the specified project.
+     * Find UCT executable for the specified magento 2 project path.
      *
      * @param project Project
+     * @param projectRoot String
      *
      * @return VirtualFile
      */
-    public static @Nullable VirtualFile locateUctExecutable(final @NotNull Project project) {
-        final PsiDirectory uctModuleDir = locateModule(project);
+    public static @Nullable VirtualFile locateUctExecutable(
+            final @NotNull Project project,
+            final @NotNull String projectRoot
+    ) {
+        final PsiDirectory uctModuleDir = locateModule(project, projectRoot);
 
         if (uctModuleDir == null) {
             return null;
@@ -54,6 +58,7 @@ private UctModuleLocatorUtil() {
      * Find UCT module base directory.
      *
      * @param project Project
+     * @param projectRoot String
      *
      * @return PsiDirectory
      */
@@ -63,24 +68,27 @@ private UctModuleLocatorUtil() {
             "PMD.CyclomaticComplexity",
             "PMD.AvoidDeeplyNestedIfStmts"
     })
-    public static @Nullable PsiDirectory locateModule(final @NotNull Project project) {
-        final String projectBasePath = project.getBasePath();
-
-        if (projectBasePath == null) {
+    public static @Nullable PsiDirectory locateModule(
+            final @NotNull Project project,
+            final @NotNull String projectRoot
+    ) {
+        if (projectRoot.isEmpty()) {
             return null;
         }
-        final VirtualFile projectBaseVf = VfsUtil.findFile(Path.of(projectBasePath), false);
+        final VirtualFile magentoProjectBaseVf = VfsUtil.findFile(Path.of(projectRoot), false);
 
-        if (projectBaseVf == null) {
+        if (magentoProjectBaseVf == null) {
             return null;
         }
         final PsiManager psiManager = PsiManager.getInstance(project);
-        final PsiDirectory projectBaseDir = psiManager.findDirectory(projectBaseVf);
+        final PsiDirectory magentoProjectBaseDir = psiManager.findDirectory(magentoProjectBaseVf);
 
-        if (projectBaseDir == null) {
+        if (magentoProjectBaseDir == null) {
             return null;
         }
-        final PsiFile composerConfigurationFile = projectBaseDir.findFile(ComposerJson.FILE_NAME);
+        final PsiFile composerConfigurationFile = magentoProjectBaseDir.findFile(
+                ComposerJson.FILE_NAME
+        );
 
         if (composerConfigurationFile instanceof JsonFile) {
             final boolean hasUctAsProjectDependency = composerConfigurationFile
@@ -89,15 +97,15 @@ private UctModuleLocatorUtil() {
 
             if (hasUctAsProjectDependency) {
                 PsiDirectory uctBaseDir = findSubdirectoryByPath(
-                        projectBaseDir,
+                        magentoProjectBaseDir,
                         "vendor".concat(File.separator)
                                 .concat("magento")
                                 .concat(File.separator)
                                 .concat("module-upgrade-compatibility-tool")
                 );
                 if (uctBaseDir == null) {
                     uctBaseDir = findSubdirectoryByPath(
-                            projectBaseDir,
+                            magentoProjectBaseDir,
                             "app".concat(File.separator)
                                     .concat("code")
                                     .concat(File.separator)
@@ -110,6 +118,21 @@ private UctModuleLocatorUtil() {
                     return uctBaseDir;
                 }
             }
+            final String projectBasePath = project.getBasePath();
+
+            if (projectBasePath == null) {
+                return null;
+            }
+            final VirtualFile projectBaseVf = VfsUtil.findFile(Path.of(projectBasePath), false);
+
+            if (projectBaseVf == null) {
+                return null;
+            }
+            final PsiDirectory projectBaseDir = psiManager.findDirectory(projectBaseVf);
+
+            if (projectBaseDir == null) {
+                return null;
+            }
 
             for (final PsiDirectory subDir : projectBaseDir.getSubdirectories()) {
                 final PsiFile composerFile = subDir.findFile(ComposerJson.FILE_NAME);
