Add partial MFTF support (autocomplete/navigation)

META-INF/plugin.xml

@@ -56,6 +56,11 @@
         <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.ModulePackageIndex" />
         <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.ModuleNameIndex" />
         <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.xml.PhpClassNameIndex" />
+        <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.mftf.SectionIndex" />
+        <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.mftf.ActionGroupIndex" />
+        <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.mftf.DataIndex" />
+        <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.mftf.PageIndex" />
+        <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.mftf.StepKeyIndex" />
 
         <codeInsight.lineMarkerProvider language="PHP" implementationClass="com.magento.idea.magento2plugin.php.linemarker.PluginLineMarkerProvider"/>
         <codeInsight.lineMarkerProvider language="PHP" implementationClass="com.magento.idea.magento2plugin.php.linemarker.ClassConfigurationLineMarkerProvider"/>

src/com/magento/idea/magento2plugin/completion/provider/mftf/ActionGroupCompletionProvider.java

@@ -0,0 +1,35 @@
+package com.magento.idea.magento2plugin.completion.provider.mftf;
+
+import com.intellij.codeInsight.completion.CompletionParameters;
+import com.intellij.codeInsight.completion.CompletionProvider;
+import com.intellij.codeInsight.completion.CompletionResultSet;
+import com.intellij.codeInsight.lookup.LookupElementBuilder;
+import com.intellij.psi.PsiElement;
+import com.intellij.util.ProcessingContext;
+import com.intellij.util.indexing.FileBasedIndex;
+import com.magento.idea.magento2plugin.stubs.indexes.mftf.ActionGroupIndex;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.Collection;
+
+public class ActionGroupCompletionProvider extends CompletionProvider<CompletionParameters> {
+
+    @Override
+    protected void addCompletions(@NotNull CompletionParameters parameters,
+                                  ProcessingContext context,
+                                  @NotNull CompletionResultSet result)
+    {
+        PsiElement position = parameters.getPosition().getOriginalElement();
+
+        if (position == null) {
+            return;
+        }
+
+        Collection<String> selectorNames
+            = FileBasedIndex.getInstance().getAllKeys(ActionGroupIndex.KEY, position.getProject());
+
+        for (String selectorName: selectorNames) {
+            result.addElement(LookupElementBuilder.create(selectorName));
+        }
+    }
+}

src/com/magento/idea/magento2plugin/completion/provider/mftf/DataCompletionProvider.java

@@ -0,0 +1,35 @@
+package com.magento.idea.magento2plugin.completion.provider.mftf;
+
+import com.intellij.codeInsight.completion.CompletionParameters;
+import com.intellij.codeInsight.completion.CompletionProvider;
+import com.intellij.codeInsight.completion.CompletionResultSet;
+import com.intellij.codeInsight.lookup.LookupElementBuilder;
+import com.intellij.psi.PsiElement;
+import com.intellij.util.ProcessingContext;
+import com.intellij.util.indexing.FileBasedIndex;
+import com.magento.idea.magento2plugin.stubs.indexes.mftf.DataIndex;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.Collection;
+
+public class DataCompletionProvider extends CompletionProvider<CompletionParameters> {
+
+    @Override
+    protected void addCompletions(@NotNull CompletionParameters parameters,
+                                  ProcessingContext context,
+                                  @NotNull CompletionResultSet result)
+    {
+        PsiElement position = parameters.getPosition().getOriginalElement();
+
+        if (position == null) {
+            return;
+        }
+
+        Collection<String> selectorNames
+            = FileBasedIndex.getInstance().getAllKeys(DataIndex.KEY, position.getProject());
+
+        for (String selectorName: selectorNames) {
+            result.addElement(LookupElementBuilder.create(selectorName));
+        }
+    }
+}

src/com/magento/idea/magento2plugin/completion/provider/mftf/SelectorCompletionProvider.java

@@ -0,0 +1,35 @@
+package com.magento.idea.magento2plugin.completion.provider.mftf;
+
+import com.intellij.codeInsight.completion.CompletionParameters;
+import com.intellij.codeInsight.completion.CompletionProvider;
+import com.intellij.codeInsight.completion.CompletionResultSet;
+import com.intellij.codeInsight.lookup.LookupElementBuilder;
+import com.intellij.psi.PsiElement;
+import com.intellij.util.ProcessingContext;
+import com.intellij.util.indexing.FileBasedIndex;
+import com.magento.idea.magento2plugin.stubs.indexes.mftf.SectionIndex;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.Collection;
+
+public class SelectorCompletionProvider extends CompletionProvider<CompletionParameters> {
+
+    @Override
+    protected void addCompletions(@NotNull CompletionParameters parameters,
+                                  ProcessingContext context,
+                                  @NotNull CompletionResultSet result)
+    {
+        PsiElement position = parameters.getPosition().getOriginalElement();
+
+        if (position == null) {
+            return;
+        }
+
+        Collection<String> selectorNames
+            = FileBasedIndex.getInstance().getAllKeys(SectionIndex.KEY, position.getProject());
+
+        for (String selectorName: selectorNames) {
+            result.addElement(LookupElementBuilder.create(selectorName));
+        }
+    }
+}

src/com/magento/idea/magento2plugin/completion/xml/XmlCompletionContributor.java

@@ -5,6 +5,7 @@
 import com.intellij.patterns.XmlPatterns;
 import com.intellij.psi.xml.XmlTokenType;
 import com.magento.idea.magento2plugin.completion.provider.*;
+import com.magento.idea.magento2plugin.completion.provider.mftf.*;
 
 import static com.intellij.patterns.PlatformPatterns.psiElement;
 import static com.intellij.patterns.StandardPatterns.string;
@@ -101,5 +102,46 @@ public XmlCompletionContributor() {
             ).inFile(xmlFile().withName(string().endsWith("events.xml"))),
             new EventNameCompletionContributor()
         );
+
+        // mftf selector completion contributor
+        extend(CompletionType.BASIC,
+            psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
+            .inside(XmlPatterns.xmlAttribute())
+            .inFile(xmlFile().withName(string().endsWith("Test.xml"))),
+            new SelectorCompletionProvider()
+        );
+
+        // mftf action group completion contributor
+        extend(
+            CompletionType.BASIC,
+            psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
+                .inside(
+                    XmlPatterns.xmlAttribute().withName(string().oneOf("ref", "extends"))
+                        .withParent(XmlPatterns.xmlTag().withName("actionGroup")
+                )
+            ),
+            new ActionGroupCompletionProvider()
+        );
+
+        // mftf data entity completion contributor
+        extend(
+            CompletionType.BASIC,
+            psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
+                .inside(XmlPatterns.xmlAttribute().withName(string().oneOf("entity", "value", "userInput", "url"))
+            ),
+            new DataCompletionProvider()
+        );
+
+        // Data entity/extends completion contributor
+        extend(
+            CompletionType.BASIC,
+            psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
+                .inside(
+                    XmlPatterns.xmlAttribute().withName("extends")
+                        .withParent(XmlPatterns.xmlTag().withName("entity")
+                )
+            ),
+            new DataCompletionProvider()
+        );
     }
 }

src/com/magento/idea/magento2plugin/reference/provider/mftf/ActionGroupReferenceProvider.java

@@ -0,0 +1,74 @@
+package com.magento.idea.magento2plugin.reference.provider.mftf;
+
+import com.intellij.ide.highlighter.XmlFileType;
+import com.intellij.openapi.util.TextRange;
+import com.intellij.openapi.util.text.StringUtil;
+import com.intellij.openapi.vfs.VfsUtilCore;
+import com.intellij.openapi.vfs.VirtualFile;
+import com.intellij.openapi.vfs.VirtualFileManager;
+import com.intellij.openapi.vfs.VirtualFileVisitor;
+import com.intellij.psi.*;
+import com.intellij.psi.search.FilenameIndex;
+import com.intellij.psi.search.GlobalSearchScope;
+import com.intellij.psi.util.PsiTreeUtil;
+import com.intellij.psi.xml.*;
+import com.intellij.util.ProcessingContext;
+import com.intellij.util.indexing.FileBasedIndex;
+import com.jetbrains.php.lang.PhpFileType;
+import com.jetbrains.php.lang.psi.PhpFile;
+import com.magento.idea.magento2plugin.reference.xml.PolyVariantReferenceBase;
+import com.magento.idea.magento2plugin.stubs.indexes.mftf.ActionGroupIndex;
+import com.magento.idea.magento2plugin.xml.XmlPsiTreeUtil;
+import gnu.trove.THashMap;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+import java.util.Map;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+public class ActionGroupReferenceProvider extends PsiReferenceProvider {
+
+    @NotNull
+    @Override
+    public PsiReference[] getReferencesByElement(@NotNull PsiElement element, @NotNull ProcessingContext context) {
+        List<PsiReference> psiReferences = new ArrayList<>();
+
+        String origValue = StringUtil.unquoteString(element.getText());
+
+        Collection<VirtualFile> containingFiles = FileBasedIndex.getInstance()
+            .getContainingFiles(
+                ActionGroupIndex.KEY,
+                origValue,
+                GlobalSearchScope.getScopeRestrictedByFileTypes(
+                    GlobalSearchScope.allScope(element.getProject()),
+                    XmlFileType.INSTANCE
+                )
+            );
+
+        PsiManager psiManager = PsiManager.getInstance(element.getProject());
+
+        List<PsiElement> psiElements = new ArrayList<>();
+
+        for (VirtualFile virtualFile: containingFiles) {
+            XmlFile xmlFile = (XmlFile) psiManager.findFile(virtualFile);
+
+            if (xmlFile == null) {
+                continue;
+            }
+
+            Collection<XmlAttributeValue> valueElements = XmlPsiTreeUtil
+                    .findAttributeValueElements(xmlFile, "actionGroup", "name", origValue);
+
+            psiElements.addAll(valueElements);
+        }
+
+        if (psiElements.size() > 0) {
+            psiReferences.add(new PolyVariantReferenceBase(element, psiElements));
+        }
+
+        return psiReferences.toArray(new PsiReference[psiReferences.size()]);
+    }
+}

src/com/magento/idea/magento2plugin/reference/provider/mftf/DataReferenceProvider.java

@@ -0,0 +1,106 @@
+package com.magento.idea.magento2plugin.reference.provider.mftf;
+
+import com.intellij.ide.highlighter.XmlFileType;
+import com.intellij.openapi.util.text.StringUtil;
+import com.intellij.openapi.vfs.VirtualFile;
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiManager;
+import com.intellij.psi.PsiReference;
+import com.intellij.psi.PsiReferenceProvider;
+import com.intellij.psi.search.GlobalSearchScope;
+import com.intellij.psi.xml.XmlAttribute;
+import com.intellij.psi.xml.XmlAttributeValue;
+import com.intellij.psi.xml.XmlFile;
+import com.intellij.psi.xml.XmlTag;
+import com.intellij.util.ProcessingContext;
+import com.intellij.util.indexing.FileBasedIndex;
+import com.magento.idea.magento2plugin.reference.xml.PolyVariantReferenceBase;
+import com.magento.idea.magento2plugin.stubs.indexes.mftf.DataIndex;
+import com.magento.idea.magento2plugin.xml.XmlPsiTreeUtil;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+
+
+public class DataReferenceProvider extends PsiReferenceProvider {
+
+    @NotNull
+    @Override
+    public PsiReference[] getReferencesByElement(@NotNull PsiElement element, @NotNull ProcessingContext context) {
+        List<PsiReference> psiReferences = new ArrayList<>();
+
+        String origValue = StringUtil.unquoteString(element.getText());
+        String modifiedValue = origValue.replaceAll("\\{{2}([_A-Za-z0-9.]+)(\\([^}]+\\))?\\}{2}", "$1").toString();
+
+        Collection<VirtualFile> containingFiles = FileBasedIndex.getInstance()
+            .getContainingFiles(
+                DataIndex.KEY,
+                modifiedValue,
+                GlobalSearchScope.getScopeRestrictedByFileTypes(
+                    GlobalSearchScope.allScope(element.getProject()),
+                    XmlFileType.INSTANCE
+                )
+            );
+
+        PsiManager psiManager = PsiManager.getInstance(element.getProject());
+
+        List<PsiElement> psiElements = new ArrayList<>();
+
+        for (VirtualFile virtualFile: containingFiles) {
+            XmlFile xmlFile = (XmlFile) psiManager.findFile(virtualFile);
+
+            if (xmlFile == null) {
+                continue;
+            }
+
+            if (!modifiedValue.contains(".")) {
+                Collection<XmlAttributeValue> valueElements = XmlPsiTreeUtil
+                    .findAttributeValueElements(xmlFile, "entity", "name", modifiedValue);
+
+                psiElements.addAll(valueElements);
+                continue;
+            }
+
+
+            String[] parts = modifiedValue.split("\\.");
+            String entityName = parts[0];
+            String dataName = parts[1];
+
+            XmlTag rootTag = xmlFile.getRootTag();
+
+            for (XmlTag entityTag: rootTag.findSubTags("entity")) {
+                if (entityTag == null) {
+                    continue;
+                }
+
+                XmlAttribute entityNameAttribute = entityTag.getAttribute("name");
+
+                if (entityNameAttribute == null ||
+                    entityNameAttribute.getValueElement() == null ||
+                    !entityNameAttribute.getValueElement().getValue().equals(entityName)
+                ) {
+                    continue;
+                }
+
+                for (XmlTag dataTag: entityTag.findSubTags("data")) {
+                    XmlAttribute keyNameAttribute = dataTag.getAttribute("key");
+
+                    if (keyNameAttribute != null &&
+                        keyNameAttribute.getValueElement() != null &&
+                        keyNameAttribute.getValueElement().getValue().equals(dataName)
+                    ) {
+                        psiElements.add(keyNameAttribute.getValueElement());
+                    }
+                }
+            }
+        }
+
+        if (psiElements.size() > 0) {
+            psiReferences.add(new PolyVariantReferenceBase(element, psiElements));
+        }
+
+        return psiReferences.toArray(new PsiReference[psiReferences.size()]);
+    }
+}