Merge pull request #192 from magento/107-mftf-test-extends

Implemented MFTF test extends reference and completion

Author: Vitaliy

resources/META-INF/plugin.xml

@@ -105,7 +105,7 @@
         <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" />
+        <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.mftf.TestNameIndex" />
         <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.js.RequireJsIndex" />
         <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.js.MagentoLibJsIndex" />
 

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

@@ -0,0 +1,64 @@
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+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.psi.util.PsiTreeUtil;
+import com.intellij.psi.xml.XmlAttribute;
+import com.intellij.psi.xml.XmlAttributeValue;
+import com.intellij.psi.xml.XmlTag;
+import com.intellij.util.ProcessingContext;
+import com.intellij.util.indexing.FileBasedIndex;
+import com.magento.idea.magento2plugin.magento.files.MftfTest;
+import com.magento.idea.magento2plugin.stubs.indexes.mftf.TestNameIndex;
+import org.jetbrains.annotations.NotNull;
+import java.util.Collection;
+
+public class TestNameCompletionProvider 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> allKeys = FileBasedIndex.getInstance().getAllKeys(TestNameIndex.KEY, position.getProject());
+
+        String currentTestName = getCurrentTestName((XmlAttributeValue) parameters.getPosition().getParent());
+        for (String testName: allKeys) {
+            if (testName.equals(currentTestName)) {
+                continue;
+            }
+            result.addElement(LookupElementBuilder.create(testName));
+        }
+    }
+
+    private String getCurrentTestName(XmlAttributeValue xmlAttributeValue) {
+        PsiElement xmlAttribute = xmlAttributeValue.getParent();
+        XmlTag xmlTag = PsiTreeUtil.getParentOfType(xmlAttribute, XmlTag.class);
+        if (xmlTag == null) {
+            return null;
+        }
+        XmlAttribute nameAttribute = xmlTag.getAttribute(MftfTest.NAME_ATTRIBUTE);
+        if (nameAttribute == null) {
+            return null;
+        }
+        String value = nameAttribute.getValue();
+        if (value == null || value.isEmpty()) {
+            return null;
+        }
+
+        return value;
+    }
+}

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

@@ -248,6 +248,20 @@ public XmlCompletionContributor() {
             new DataCompletionProvider()
         );
 
+        // MFTF Test extends completion contributor
+        extend(
+            CompletionType.BASIC,
+            psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
+                .inside(
+                    XmlPatterns.xmlAttribute().withName(MftfTest.EXTENDS_ATTRIBUTE)
+                        .withParent(XmlPatterns.xmlTag().withName(MftfTest.TEST_TAG)
+                        .withParent(XmlPatterns.xmlTag().withName(MftfTest.ROOT_TAG)
+                        )
+                    )
+                ),
+            new TestNameCompletionProvider()
+        );
+
         registerCompletionsForDifferentNesting();
     }
 
@@ -264,7 +278,7 @@ private void registerCompletionsForDifferentNesting() {
                             i,
                             XmlPatterns.xmlTag().withParent(
                                 XmlPatterns.xmlTag().withName(
-                                    string().oneOf(MftfActionGroup.ROOT_TAG, MftfTest.ROOT_TAG)
+                                    string().oneOf(MftfActionGroup.ROOT_TAG, MftfTest.TEST_TAG)
                                 )))
                     ),
                 new SelectorCompletionProvider()
@@ -278,7 +292,7 @@ private void registerCompletionsForDifferentNesting() {
                         XmlPatterns.xmlAttribute().withName(MftfActionGroup.URL_ATTRIBUTE)
                             .withSuperParent(i ,XmlPatterns.xmlTag().withParent(
                                 XmlPatterns.xmlTag().withName(
-                                    string().oneOf(MftfActionGroup.ROOT_TAG, MftfTest.ROOT_TAG)
+                                    string().oneOf(MftfActionGroup.ROOT_TAG, MftfTest.TEST_TAG)
                                 )))
                     ),
                 new PageCompletionProvider()

src/com/magento/idea/magento2plugin/indexes/IndexManager.java

@@ -40,7 +40,7 @@ public static void manualReindex() {
             DataIndex.KEY,
             PageIndex.KEY,
             SectionIndex.KEY,
-            StepKeyIndex.KEY,
+            TestNameIndex.KEY,
              //graphql
             GraphQlResolverIndex.KEY
         };

src/com/magento/idea/magento2plugin/linemarker/php/PluginTargetLineMarkerProvider.java

@@ -169,6 +169,9 @@ private String getTargetMethodName(Method pluginMethod, String pluginPrefix) {
             String pluginMethodName = pluginMethod.getName();
             String targetClassMethodName = pluginMethodName.
                     replace(pluginPrefix, "");
+            if (targetClassMethodName.isEmpty()) {
+                return null;
+            }
             char firstCharOfTargetName = targetClassMethodName.charAt(0);
             int charType = Character.getType(firstCharOfTargetName);
             if (charType == Character.LOWERCASE_LETTER) {

src/com/magento/idea/magento2plugin/magento/files/MftfTest.java

@@ -6,5 +6,9 @@
 
 public class MftfTest {
 
-    public static String ROOT_TAG = "test";
+    public static String ROOT_TAG = "tests";
+    public static String TEST_TAG = "test";
+    public static String NAME_ATTRIBUTE = "name";
+    public static String EXTENDS_ATTRIBUTE = "extends";
+    public static String FILE_DIR_PARENTS = "Test/Mftf";
 }

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

@@ -1,3 +1,7 @@
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
 package com.magento.idea.magento2plugin.reference.provider.mftf;
 
 import com.intellij.ide.highlighter.XmlFileType;
@@ -12,7 +16,6 @@
 import com.magento.idea.magento2plugin.stubs.indexes.mftf.ActionGroupIndex;
 import com.magento.idea.magento2plugin.util.xml.XmlPsiTreeUtil;
 import org.jetbrains.annotations.NotNull;
-
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;

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

@@ -1,3 +1,7 @@
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
 package com.magento.idea.magento2plugin.reference.provider.mftf;
 
 import com.intellij.ide.highlighter.XmlFileType;
@@ -18,12 +22,10 @@
 import com.magento.idea.magento2plugin.stubs.indexes.mftf.DataIndex;
 import com.magento.idea.magento2plugin.util.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

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

@@ -1,3 +1,7 @@
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
 package com.magento.idea.magento2plugin.reference.provider.mftf;
 
 import com.intellij.ide.highlighter.XmlFileType;
@@ -16,7 +20,6 @@
 import com.magento.idea.magento2plugin.stubs.indexes.mftf.PageIndex;
 import com.magento.idea.magento2plugin.util.xml.XmlPsiTreeUtil;
 import org.jetbrains.annotations.NotNull;
-
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;

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

@@ -1,3 +1,7 @@
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
 package com.magento.idea.magento2plugin.reference.provider.mftf;
 
 import com.intellij.ide.highlighter.XmlFileType;