Fixed LinemarkerFixtureTestCase.java

VitaliyBoyko · VitaliyBoyko · commit f2e28a52d7d4 · 2026-03-21T20:18:30.000+02:00
diff --git a/src/main/java/com/magento/idea/magento2plugin/indexes/FixtureIndex.java b/src/main/java/com/magento/idea/magento2plugin/indexes/FixtureIndex.java
@@ -6,14 +6,19 @@
 package com.magento.idea.magento2plugin.indexes;
 
 import com.intellij.openapi.project.Project;
+import com.intellij.openapi.project.ProjectUtil;
+import com.intellij.openapi.vfs.VirtualFile;
+import com.intellij.psi.PsiFile;
 import com.intellij.psi.PsiFileSystemItem;
+import com.intellij.psi.PsiManager;
 import com.intellij.psi.search.FilenameIndex;
 import com.intellij.psi.search.GlobalSearchScope;
-import com.jetbrains.php.lang.psi.PhpFile;
 import com.magento.idea.magento2plugin.magento.files.TestFixture;
 import com.magento.idea.magento2plugin.magento.packages.File;
 import java.util.ArrayList;
+import java.util.LinkedHashSet;
 import java.util.List;
+import java.util.Set;
 import org.jetbrains.annotations.NotNull;
 
 public final class FixtureIndex {
@@ -26,12 +31,25 @@ public FixtureIndex(final Project project) {
     /**
      * Getter for data fixtures.
      */
-    public List<PhpFile> getDataFixtures(final String fixtureIdentifier) {
-        final List<PhpFile> result = new ArrayList<>();
-
-        final String[] fixturePathParts = fixtureIdentifier.split(File.separator);
+    public List<PsiFile> getDataFixtures(final String fixtureIdentifier) {
+        final List<PsiFile> result = new ArrayList<>();
+        final String normalizedFixtureIdentifier = fixtureIdentifier
+                .trim()
+                .replace('\\', '/')
+                .replaceFirst("^/+", "");
+        if (normalizedFixtureIdentifier.isEmpty()) {
+            return result;
+        }
+        final String[] fixturePathParts = normalizedFixtureIdentifier.split(File.separator);
         final String fixtureName = fixturePathParts[fixturePathParts.length - 1];
-        final String exactFilePath = TestFixture.FIXTURES_LOCATION.concat(fixtureIdentifier);
+        final List<String> expectedFilePaths = List.of(
+                TestFixture.FIXTURES_LOCATION.concat(normalizedFixtureIdentifier),
+                TestFixture.FIXTURES_LOCATION_API.concat(normalizedFixtureIdentifier)
+        );
+        result.addAll(getFixturesByProjectPath(expectedFilePaths));
+        if (!result.isEmpty()) {
+            return result;
+        }
 
         @NotNull final PsiFileSystemItem[] psiFiles = FilenameIndex.getFilesByName(
                 project,
@@ -41,16 +59,40 @@ public List<PhpFile> getDataFixtures(final String fixtureIdentifier) {
         );
 
         for (final PsiFileSystemItem psiFile: psiFiles) {
-            if (!(psiFile instanceof PhpFile)) {
+            if (!(psiFile instanceof PsiFile)) {
                 continue;
             }
-            @NotNull final String filePath = psiFile.getVirtualFile().getPath();
+            @NotNull final String filePath = psiFile.getVirtualFile().getPath().replace('\\', '/');
             if (!filePath.contains(TestFixture.FIXTURES_EXCLUDE_PATH)
-                    && filePath.contains(exactFilePath)) {
-                result.add((PhpFile) psiFile);
+                    && expectedFilePaths.stream().anyMatch(filePath::endsWith)) {
+                result.add((PsiFile) psiFile);
             }
         }
 
         return result;
     }
+
+    private @NotNull List<PsiFile> getFixturesByProjectPath(
+            final @NotNull List<String> expectedFilePaths
+    ) {
+        final Set<PsiFile> result = new LinkedHashSet<>();
+        final VirtualFile projectDir = ProjectUtil.guessProjectDir(project);
+        if (projectDir == null) {
+            return new ArrayList<>(result);
+        }
+
+        final PsiManager psiManager = PsiManager.getInstance(project);
+        for (final String expectedFilePath : expectedFilePaths) {
+            final VirtualFile virtualFile = projectDir.findFileByRelativePath(expectedFilePath);
+            if (virtualFile == null) {
+                continue;
+            }
+            final PsiFile psiFile = psiManager.findFile(virtualFile);
+            if (psiFile != null) {
+                result.add(psiFile);
+            }
+        }
+
+        return new ArrayList<>(result);
+    }
 }
diff --git a/src/main/java/com/magento/idea/magento2plugin/linemarker/php/TestFixtureLineMarkerProvider.java b/src/main/java/com/magento/idea/magento2plugin/linemarker/php/TestFixtureLineMarkerProvider.java
@@ -9,10 +9,12 @@
 import com.intellij.codeInsight.daemon.LineMarkerProvider;
 import com.intellij.codeInsight.navigation.NavigationGutterIconBuilder;
 import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiFile;
 import com.intellij.psi.util.PsiTreeUtil;
 import com.jetbrains.php.PhpIcons;
+import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocComment;
 import com.jetbrains.php.lang.documentation.phpdoc.psi.tags.PhpDocTag;
-import com.jetbrains.php.lang.psi.PhpFile;
+import com.jetbrains.php.lang.psi.elements.Method;
 import com.magento.idea.magento2plugin.indexes.FixtureIndex;
 import com.magento.idea.magento2plugin.magento.files.TestFixture;
 import com.magento.idea.magento2plugin.project.Settings;
@@ -39,35 +41,62 @@ public void collectSlowLineMarkers(
             return;
         }
         final FixtureIndex fixtureIndex = new FixtureIndex(elements.get(0).getProject());
-        final List<PhpFile> results = new ArrayList();
         for (final PsiElement psiElement: elements) {
-            if (psiElement instanceof PhpDocTag) {
-                @NotNull final String tagName = ((PhpDocTag) psiElement).getName();
-                if (!tagName.equals(TestFixture.PHP_DOC_TAG_NAME)
-                        && !tagName.equals(TestFixture.PHP_DOC_TAG_NAME_API)) {
-                    continue;
-                }
-                @NotNull final String tagValue = ((PhpDocTag) psiElement).getTagValue();
-                if (tagValue.isEmpty()) {
-                    continue;
-                }
-
-                final List<PhpFile> dataFixtures = fixtureIndex.getDataFixtures(tagValue);
-
-                if (dataFixtures.isEmpty()) {
-                    continue;
-                }
+            if (!(psiElement instanceof Method)) {
+                continue;
+            }
+            final PhpDocComment phpDocComment = ((Method) psiElement).getDocComment();
+            if (phpDocComment == null) {
+                continue;
+            }
+            final List<PsiFile> dataFixtures = collectDataFixtures(phpDocComment, fixtureIndex);
+            if (dataFixtures.isEmpty()) {
+                continue;
+            }
 
-                results.addAll(dataFixtures);
+            final String tooltipText = "Navigate to fixtures";
+            final NavigationGutterIconBuilder<PsiElement> builder = NavigationGutterIconBuilder
+                    .create(PhpIcons.PHP_FILE)
+                    .setTargets(dataFixtures)
+                    .setTooltipText(tooltipText);
 
-                final String tooltipText = "Navigate to fixtures";
-                final NavigationGutterIconBuilder<PsiElement> builder = NavigationGutterIconBuilder
-                        .create(PhpIcons.PHP_FILE)
-                        .setTargets(results)
-                        .setTooltipText(tooltipText);
+            result.add(builder.createLineMarkerInfo(PsiTreeUtil.getDeepestFirst(psiElement)));
+        }
+    }
 
-                result.add(builder.createLineMarkerInfo(PsiTreeUtil.getDeepestFirst(psiElement)));
+    private @NotNull List<PsiFile> collectDataFixtures(
+            final @NotNull PhpDocComment phpDocComment,
+            final @NotNull FixtureIndex fixtureIndex
+    ) {
+        final List<PsiFile> dataFixtures = new ArrayList<>();
+        for (final PhpDocTag phpDocTag : PsiTreeUtil.getChildrenOfTypeAsList(
+                phpDocComment,
+                PhpDocTag.class
+        )) {
+            @NotNull final String tagName = normalizeTagName(phpDocTag);
+            if (!isFixtureTagName(tagName)) {
+                continue;
             }
+            @NotNull final String tagValue = phpDocTag.getTagValue().trim();
+            if (tagValue.isEmpty()) {
+                continue;
+            }
+            dataFixtures.addAll(fixtureIndex.getDataFixtures(tagValue));
         }
+
+        return dataFixtures;
+    }
+
+    private boolean isFixtureTagName(final @NotNull String tagName) {
+        return tagName.equals(stripTagPrefix(TestFixture.PHP_DOC_TAG_NAME))
+                || tagName.equals(stripTagPrefix(TestFixture.PHP_DOC_TAG_NAME_API));
+    }
+
+    private @NotNull String normalizeTagName(final @NotNull PhpDocTag phpDocTag) {
+        return stripTagPrefix(phpDocTag.getName().trim());
+    }
+
+    private @NotNull String stripTagPrefix(final @NotNull String tagName) {
+        return tagName.startsWith("@") ? tagName.substring(1) : tagName;
     }
 }
diff --git a/src/main/java/com/magento/idea/magento2plugin/magento/files/TestFixture.java b/src/main/java/com/magento/idea/magento2plugin/magento/files/TestFixture.java
@@ -12,5 +12,6 @@ public class TestFixture {
     public static final String PHP_DOC_TAG_NAME = "@magentoDataFixture";
     public static final String PHP_DOC_TAG_NAME_API = "@magentoApiDataFixture";
     public static final String FIXTURES_LOCATION = "dev/tests/integration/testsuite/";
+    public static final String FIXTURES_LOCATION_API = "dev/tests/api-functional/testsuite/";
     public static final String FIXTURES_EXCLUDE_PATH = "vendor";
 }
diff --git a/src/test/java/com/magento/idea/magento2plugin/linemarker/LinemarkerFixtureTestCase.java b/src/test/java/com/magento/idea/magento2plugin/linemarker/LinemarkerFixtureTestCase.java
@@ -32,7 +32,7 @@ protected void assertHasLinemarkerWithTooltipAndIcon(final String tooltip, final
         myFixture.doHighlighting();
 
         final List<LineMarkerInfo<?>> lineMarkers = getDocumentLineMarkers();
-        assertNotEmpty(lineMarkers);
+        assertFalse("No line markers found in document", lineMarkers.isEmpty());
         for (final LineMarkerInfo lineMarkerInfo: lineMarkers) {
             final String lineMarkerTooltip = lineMarkerInfo.getLineMarkerTooltip();
             final Icon lineMarkerIcon = lineMarkerInfo.getIcon();
@@ -50,8 +50,8 @@ protected void assertHasLinemarkerWithTooltipAndIcon(final String tooltip, final
         }
 
         final String lineMarkerNotFound
-                = "Failed that documents contains linemarker with the tooltip `%s`";
-        fail(String.format(lineMarkerNotFound, tooltip));
+                = "Failed that documents contains linemarker with the tooltip `%s`. Found: %s";
+        fail(String.format(lineMarkerNotFound, tooltip, describeLineMarkers(lineMarkers)));
     }
 
     protected void assertHasNoLinemarkerWithTooltipAndIcon(
@@ -83,4 +83,18 @@ private List<LineMarkerInfo<?>> getDocumentLineMarkers() {
                 getProject()
         );
     }
+
+    private String describeLineMarkers(final @NotNull List<LineMarkerInfo<?>> lineMarkers) {
+        final StringBuilder description = new StringBuilder();
+        for (final LineMarkerInfo<?> lineMarkerInfo : lineMarkers) {
+            if (!description.isEmpty()) {
+                description.append("; ");
+            }
+            description.append("tooltip=")
+                    .append(lineMarkerInfo.getLineMarkerTooltip())
+                    .append(", icon=")
+                    .append(lineMarkerInfo.getIcon());
+        }
+        return description.toString();
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -12,5 +12,6 @@ public class TestFixture {`
`12`	`12`	`public static final String PHP_DOC_TAG_NAME = "@magentoDataFixture";`
`13`	`13`	`public static final String PHP_DOC_TAG_NAME_API = "@magentoApiDataFixture";`
`14`	`14`	`public static final String FIXTURES_LOCATION = "dev/tests/integration/testsuite/";`
	`15`	`+ public static final String FIXTURES_LOCATION_API = "dev/tests/api-functional/testsuite/";`
`15`	`16`	`public static final String FIXTURES_EXCLUDE_PATH = "vendor";`
`16`	`17`	`}`