Merge pull request #2509 from vitaliyboykocontributor/1263-Possibility-to-add-second-code-source-directory-for-modules-local-composer-development-using-content-root-feature-tests

1263: Added UI tests for MarkDirectoryAsMagentoContentRoot

Author: VitaliyBoyko

.github/workflows/uitests.yml

@@ -0,0 +1,85 @@
+# This workflow will build a Java project with Gradle
+# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-gradle
+
+name: Run automated tests
+
+on:
+  pull_request:
+    branches: [ master, '*-develop', 'mainline*' ]
+
+jobs:
+
+  testUI:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-latest
+            runIde: |
+              export DISPLAY=:99.0
+              Xvfb -ac :99 -screen 0 1920x1080x24 &
+              sleep 10
+              ./gradlew runIdeForUiTests &
+#          TODO: fix for windows is needed, currently Gradle can't process .form files for windows
+
+#          - os: windows-latest
+#            runIde: start gradlew.bat runIdeForUiTests
+#          - os: macos-latest
+#            runIde: ./gradlew runIdeForUiTests &
+
+    steps:
+
+      # Check out the current repository
+      - name: Fetch Sources
+        uses: actions/checkout@v4
+
+      # Set up Java environment for the next steps
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: zulu
+          java-version: 17
+
+      # Setup Gradle
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
+
+      # Run IDEA prepared for UI testing
+      - name: Run IDE
+        run: ${{ matrix.runIde }}
+
+      # Wait for IDEA to be started
+      - name: Health Check
+        uses: jtalk/url-health-check-action@v4
+        with:
+          url: http://127.0.0.1:8082
+          max-attempts: 15
+          retry-delay: 30s
+
+      # Run tests
+      - name: Tests
+        if: matrix.os != 'ubuntu-latest'
+        run: ./gradlew uiTests
+
+      - name: Tests Ubuntu
+        if: matrix.os == 'ubuntu-latest'
+        run: |
+          export DISPLAY=:99.0
+          ./gradlew uiTests
+
+# Uncomment if investigation is needed:
+
+#      - name: Capture Test Artifacts on Failure
+#        if: failure() && matrix.os == 'windows-latest'
+#        run: tar -cvzf video.tgz ./video
+#        shell: bash
+#
+#      - name: Upload Test Video Artifact
+#        if: failure() && matrix.os == 'windows-latest'
+#        uses: actions/upload-artifact@v4
+#        with:
+#          name: latest-test-video
+#          path: video.tgz
+#          overwrite: true
+

.gitignore

@@ -36,4 +36,6 @@ out
 .gradle
 .idea-sandbox
 build
-.intellijPlatform/*
+.intellijPlatform/*
+video/*
+intellij-test-project

build.gradle.kts

@@ -39,24 +39,24 @@ dependencies {
     testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.10.0")
 
     testImplementation("org.junit.vintage:junit-vintage-engine:5.10.0")
-
-    implementation("com.googlecode.json-simple:json-simple:1.1.1")
+    implementation("org.json:json:20171018")
     implementation("org.codehaus.plexus:plexus-utils:3.4.0")
+    testImplementation("com.automation-remarks:video-recorder-junit5:2.0")
+    testImplementation("com.intellij.remoterobot:remote-robot:0.11.23")
+    testImplementation("com.intellij.remoterobot:remote-fixtures:0.11.23")
+    testImplementation("com.squareup.okhttp3:logging-interceptor:4.12.0")
 
     intellijPlatform {
         create(providers.gradleProperty("platformType"), providers.gradleProperty("platformVersion"))
 
         bundledPlugins(providers.gradleProperty("platformBundledPlugins").map { it.split(',') })
         plugins(providers.gradleProperty("platformPlugins").map { it.split(',') })
         plugin("com.intellij.lang.jsgraphql", "243.21565.122")
-        instrumentationTools()
         pluginVerifier()
         zipSigner()
         testFramework(TestFrameworkType.Platform)
 
         phpstorm("2024.3")
-        bundledPlugin("com.jetbrains.php")
-        bundledPlugin("com.intellij.copyright")
     }
 }
 
@@ -137,6 +137,7 @@ tasks {
     }
 
     test {
+        exclude("**/userInterface/**")
         useJUnitPlatform()
     }
 
@@ -246,3 +247,11 @@ kover {
         }
     }
 }
+
+tasks.register<Test>("uiTests") {
+    exclude("**/reference/**")
+    exclude("**/linemarker/**")
+    exclude("**/inspections/**")
+    exclude("**/completion/**")
+    exclude("**/actions/**") // Deprecated, all actions should be reimplemented in the UI tests and this exclude should be removed
+}

gradle.properties

@@ -7,7 +7,7 @@ pluginUntilBuild = 258.*
 platformType = PS
 platformVersion = 2024.3
 platformPlugins =
-platformBundledPlugins = com.intellij.modules.json
+platformBundledPlugins = com.intellij.modules.json,com.jetbrains.php,JavaScript,com.intellij.copyright
 gradleVersion = 8.10.2
 kotlin.stdlib.default.dependency = false
 org.gradle.configuration-cache = true

gradle/libs.versions.toml

@@ -4,7 +4,7 @@ junit = "4.13.2"
 
 # plugins
 changelog = "2.2.1"
-intelliJPlatform = "2.1.0"
+intelliJPlatform = "2.4.0"
 kotlin = "1.9.25"
 kover = "0.8.3"
 qodana = "2024.2.3"

runTests.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+./gradlew clean
+./gradlew runIdeForUiTests --scan &
+RUN_IDE_PID=$!
+
+sleep 10
+
+./gradlew test --no-daemon --scan
+
+# run certain test
+#./gradlew test --tests "com.magento.idea.magento2plugin.actions.content.MarkDirectoryAsMagentoRootTest.testMarkDirectoryAsMagentoRoot" --scan
+
+kill $RUN_IDE_PID
+
+wait $RUN_IDE_PID 2>/dev/null

src/main/java/com/magento/idea/magento2plugin/actions/content/root/MarkDirectoryAsMagentoContentRot.java

@@ -7,7 +7,11 @@
 
 import com.intellij.ide.projectView.ProjectView;
 import com.intellij.ide.projectView.actions.MarkRootActionBase;
-import com.intellij.openapi.actionSystem.*;
+import com.intellij.openapi.actionSystem.AnActionEvent;
+import com.intellij.openapi.actionSystem.DataContext;
+import com.intellij.openapi.actionSystem.LangDataKeys;
+import com.intellij.openapi.actionSystem.PlatformCoreDataKeys;
+import com.intellij.openapi.actionSystem.Presentation;
 import com.intellij.openapi.module.Module;
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.roots.ContentEntry;
@@ -18,21 +22,28 @@
 import com.magento.idea.magento2plugin.MagentoIcons;
 import com.magento.idea.magento2plugin.project.Settings;
 import com.magento.idea.magento2plugin.util.magento.MagentoPathUrlUtil;
-import org.jetbrains.annotations.NotNull;
 import java.net.MalformedURLException;
 import java.net.URL;
+import org.jetbrains.annotations.NotNull;
 
 public class MarkDirectoryAsMagentoContentRot extends MarkRootActionBase {
     private Project project;
 
+    /**
+     * This action is used to mark a selected directory as
+     * a Magento content root within the project structure.
+     */
     public MarkDirectoryAsMagentoContentRot() {
         super();
         final Presentation presentation = this.getTemplatePresentation();
         presentation.setIcon(MagentoIcons.MARK_AS);
     }
 
     @Override
-    protected void modifyRoots(final VirtualFile virtualFile, ContentEntry contentEntry) {
+    protected void modifyRoots(
+            final VirtualFile virtualFile,
+            final ContentEntry contentEntry
+    ) {
         if (project != null) {
             final Settings settings = Settings.getInstance(project);
             Settings.getInstance(project).addMagentoFolder(virtualFile.getUrl());
@@ -61,14 +72,14 @@ public void update(@NotNull final AnActionEvent event) {
             project = module.getProject();
         }
 
-        if (targetElement instanceof PsiDirectory) {
-            final Settings settings = Settings.getInstance(project);
+        if (targetElement instanceof PsiDirectory && project != null) {
             final String magentoPathUrl = MagentoPathUrlUtil.execute(project);
             final String directoryUrl = ((PsiDirectory) targetElement).getVirtualFile().getUrl();
             if (magentoPathUrl != null && magentoPathUrl.equals(directoryUrl)) {
                 event.getPresentation().setEnabledAndVisible(false);
                 return;
             }
+            final Settings settings = Settings.getInstance(project);
             if (!settings.containsMagentoFolder(directoryUrl)) {
                 event.getPresentation().setEnabledAndVisible(true);
                 return;
@@ -79,7 +90,10 @@ public void update(@NotNull final AnActionEvent event) {
     }
 
     @Override
-    protected boolean isEnabled(@NotNull RootsSelection rootsSelection, @NotNull Module module) {
+    protected boolean isEnabled(
+            @NotNull final RootsSelection rootsSelection,
+            @NotNull final Module module
+    ) {
         return false;
     }
 }

src/main/java/com/magento/idea/magento2plugin/actions/content/root/UnmarkDirectoryAsMagentoContentRot.java

@@ -7,7 +7,10 @@
 
 import com.intellij.ide.projectView.ProjectView;
 import com.intellij.ide.projectView.actions.MarkRootActionBase;
-import com.intellij.openapi.actionSystem.*;
+import com.intellij.openapi.actionSystem.AnActionEvent;
+import com.intellij.openapi.actionSystem.DataContext;
+import com.intellij.openapi.actionSystem.LangDataKeys;
+import com.intellij.openapi.actionSystem.PlatformCoreDataKeys;
 import com.intellij.openapi.module.Module;
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.roots.ContentEntry;
@@ -17,25 +20,24 @@
 import com.intellij.psi.PsiElement;
 import com.magento.idea.magento2plugin.project.Settings;
 import com.magento.idea.magento2plugin.util.magento.MagentoPathUrlUtil;
-import org.jetbrains.annotations.NotNull;
 import java.net.MalformedURLException;
 import java.net.URL;
+import org.jetbrains.annotations.NotNull;
 
 public class UnmarkDirectoryAsMagentoContentRot extends MarkRootActionBase {
     private Project project;
 
-    public UnmarkDirectoryAsMagentoContentRot() {
-        super();
-    }
-
     @Override
-    protected void modifyRoots(VirtualFile virtualFile, ContentEntry contentEntry) {
+    protected void modifyRoots(
+            final VirtualFile virtualFile,
+            final ContentEntry contentEntry
+    ) {
         if (project != null) {
-            Settings settings = Settings.getInstance(project);
+            final Settings settings = Settings.getInstance(project);
             Settings.getInstance(project).removeMagentoFolder(virtualFile.getUrl());
             if (settings.getMagentoFolders() != null) {
                 settings.getMagentoFolders().removeIf(folder -> {
-                    VirtualFile file = null;
+                    final VirtualFile file;
                     try {
                         file = VfsUtil.findFileByURL(new URL(folder));
                     } catch (MalformedURLException e) {
@@ -50,23 +52,23 @@ protected void modifyRoots(VirtualFile virtualFile, ContentEntry contentEntry) {
     }
 
     @Override
-    public void update(@NotNull AnActionEvent event) {
+    public void update(@NotNull final AnActionEvent event) {
         final DataContext context = event.getDataContext();
         final PsiElement targetElement = LangDataKeys.PSI_ELEMENT.getData(context);
-        Module module = event.getData(PlatformCoreDataKeys.MODULE);
+        final Module module = event.getData(PlatformCoreDataKeys.MODULE);
         if (module != null) {
             project = module.getProject();
         }
 
-        if (targetElement instanceof PsiDirectory) {
-            Settings settings = Settings.getInstance(project);
-            String magentoPathUrl = MagentoPathUrlUtil.execute(project);
-            String directoryUrl = ((PsiDirectory) targetElement).getVirtualFile().getUrl();
+        if (targetElement instanceof PsiDirectory && project != null) {
+            final String magentoPathUrl = MagentoPathUrlUtil.execute(project);
+            final String directoryUrl = ((PsiDirectory) targetElement).getVirtualFile().getUrl();
             if (magentoPathUrl != null && magentoPathUrl.equals(directoryUrl)) {
                 event.getPresentation().setEnabledAndVisible(false);
                 return;
             }
 
+            final Settings settings = Settings.getInstance(project);
             if (settings.containsMagentoFolder(directoryUrl)) {
                 event.getPresentation().setEnabledAndVisible(true);
                 return;
@@ -77,7 +79,10 @@ public void update(@NotNull AnActionEvent event) {
     }
 
     @Override
-    protected boolean isEnabled(@NotNull RootsSelection rootsSelection, @NotNull Module module) {
+    protected boolean isEnabled(
+            @NotNull final RootsSelection rootsSelection,
+            @NotNull final Module module
+    ) {
         return false;
     }
 }

src/main/java/com/magento/idea/magento2plugin/actions/generation/dialog/CreateAPluginDialog.form

@@ -65,7 +65,9 @@
                 <preferred-size width="150" height="-1"/>
               </grid>
             </constraints>
-            <properties/>
+            <properties>
+              <name value="Class Name"/>
+            </properties>
             <clientProperties>
               <html.disable class="java.lang.Boolean" value="true"/>
             </clientProperties>

src/main/java/com/magento/idea/magento2plugin/actions/generation/dialog/NewModuleDialog.java

@@ -51,7 +51,13 @@
 import org.apache.commons.lang3.ArrayUtils;
 import org.jetbrains.annotations.NotNull;
 
-@SuppressWarnings({"PMD.TooManyFields", "PMD.DataClass", "PMD.UnusedPrivateMethod"})
+@SuppressWarnings({
+        "PMD.TooManyFields",
+        "PMD.DataClass",
+        "PMD.UnusedPrivateMethod",
+        "PMD.ConstructorCallsOverridableMethod",
+        "PMD.SingularField"
+})
 public class NewModuleDialog extends AbstractDialog implements ListSelectionListener { //NOPMD
     private static final String MODULE_DESCRIPTION = "module description";
     private static final String MODULE_VERSION = "module version";
@@ -111,8 +117,8 @@ public class NewModuleDialog extends AbstractDialog implements ListSelectionList
     @NotNull
     private final PsiDirectory initialBaseDir;
     private String detectedPackageName;
-    private final ModuleIndex moduleIndex;
-    private final CamelCaseToHyphen camelCaseToHyphen;
+    private final transient ModuleIndex moduleIndex;
+    private final transient CamelCaseToHyphen camelCaseToHyphen;
 
     /**
      * Constructor.
@@ -178,8 +184,10 @@ private void detectPackageName(final @NotNull PsiDirectory initialBaseDir) {
         }
     }
 
+    @Override
     protected void onWriteActionOK() {
         generateFiles();
+        exit();
     }
 
     private void generateFiles() {