Merge pull request #229 from magento/require-js-test-coverage

Vitaliy · web-flow · commit 016a60adbfcf · 2020-04-28T11:10:19.000-07:00
RequireJs mapping test coverage
diff --git a/.github/workflows/gradlepublishalpha.yml b/.github/workflows/gradlepublishalpha.yml
@@ -5,7 +5,7 @@ name: Publish Plugin alpha version
 on:
   push:
     branches:
-      - 1.0.1-develop
+      - master
 
 jobs:
   build:
@@ -23,7 +23,6 @@ jobs:
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
       - name: Run publish plugin
-        if: contains(github.event.pull_request.labels.*.name, 'deploy-alpha')
         run: ./gradlew publishPlugin -i
         env:
           MAGENTO_PHPSTORM_intellijPublishToken: ${{ secrets.JET_BRAINS_TOKEN }}
diff --git a/src/com/magento/idea/magento2plugin/completion/xml/XmlCompletionContributor.java b/src/com/magento/idea/magento2plugin/completion/xml/XmlCompletionContributor.java
@@ -76,6 +76,16 @@ public XmlCompletionContributor() {
                 new FilePathCompletionProvider()
         );
 
+        extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_DATA_CHARACTERS)
+                .withParent(XmlPatterns.xmlText().withParent(
+                    XmlPatterns.xmlTag().withName(UiComponentXml.XML_TAG_ITEM).withChild(
+                        XmlPatterns.xmlAttribute().withValue(string()
+                            .matches(UiComponentXml.XML_ATTRIBUTE_TEMPLATE))
+                    ))
+                ),
+            new FilePathCompletionProvider()
+        );
+
         extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
                 .inside(XmlPatterns.xmlAttribute().withName("type")),
             new VirtualTypeCompletionProvider()
@@ -198,21 +208,28 @@ public XmlCompletionContributor() {
 
         extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
             .inside(XmlPatterns.xmlAttributeValue().withParent(
-                XmlPatterns.xmlAttribute().withName("component")
+                XmlPatterns.xmlAttribute().withName(UiComponentXml.XML_ATTRIBUTE_COMPONENT)
             )),
-            new RequireJsMappingCompletionProvider()
+            new CompositeCompletionProvider(
+                new RequireJsMappingCompletionProvider(),
+                new FilePathCompletionProvider()
+            )
         );
 
         extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_DATA_CHARACTERS)
              .withParent(XmlPatterns.xmlText().withParent(
-                XmlPatterns.xmlTag().withName("item").withChild(
-                        XmlPatterns.xmlAttribute().withValue(string().matches("component"))
+                XmlPatterns.xmlTag().withName(UiComponentXml.XML_TAG_ITEM).withChild(
+                        XmlPatterns.xmlAttribute().withValue(string()
+                            .matches(UiComponentXml.XML_ATTRIBUTE_COMPONENT))
                     ).withChild(
-                        XmlPatterns.xmlAttribute().withName("name")
+                        XmlPatterns.xmlAttribute().withName(UiComponentXml.XML_ATTRIBUTE_NAME)
                     )
                 )
             ),
-            new RequireJsMappingCompletionProvider()
+            new CompositeCompletionProvider(
+                new RequireJsMappingCompletionProvider(),
+                new FilePathCompletionProvider()
+            )
         );
 
         // mftf action group completion contributor
diff --git a/src/com/magento/idea/magento2plugin/magento/files/UiComponentXml.java b/src/com/magento/idea/magento2plugin/magento/files/UiComponentXml.java
@@ -0,0 +1,12 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.magento.files;
+
+public class UiComponentXml {
+    public static String XML_ATTRIBUTE_TEMPLATE = "template";
+    public static String XML_ATTRIBUTE_COMPONENT = "component";
+    public static String XML_TAG_ITEM = "item";
+    public static String XML_ATTRIBUTE_NAME = "name";
+}
diff --git a/src/com/magento/idea/magento2plugin/magento/packages/Package.java b/src/com/magento/idea/magento2plugin/magento/packages/Package.java
@@ -6,6 +6,7 @@
 
 public class Package {
     public static String PACKAGES_ROOT = "app/code";
+    public static String LIB_WEB_ROOT = "lib/web";
     public static String APP = "app";
     public static String VENDOR = "vendor";
     public static String MODULE_BASE_AREA_DIR = "etc";
diff --git a/src/com/magento/idea/magento2plugin/reference/xml/XmlReferenceContributor.java b/src/com/magento/idea/magento2plugin/reference/xml/XmlReferenceContributor.java
@@ -10,6 +10,7 @@
 import com.intellij.psi.xml.XmlTokenType;
 import com.magento.idea.magento2plugin.magento.files.MftfActionGroup;
 import com.magento.idea.magento2plugin.magento.files.MftfTest;
+import com.magento.idea.magento2plugin.magento.files.UiComponentXml;
 import com.magento.idea.magento2plugin.reference.provider.*;
 import com.magento.idea.magento2plugin.reference.provider.mftf.*;
 import com.magento.idea.magento2plugin.util.RegExUtil;
@@ -226,24 +227,38 @@ public void registerReferenceProviders(@NotNull PsiReferenceRegistrar registrar)
 
         // <someXmlTag component="requireJsMappingKey" />
         registrar.registerReferenceProvider(
-                XmlPatterns.xmlAttributeValue().withParent(
-                        XmlPatterns.xmlAttribute().withName("component")
-                ),
-                new RequireJsPreferenceReferenceProvider()
+            XmlPatterns.xmlAttributeValue().withParent(
+                XmlPatterns.xmlAttribute().withName(UiComponentXml.XML_ATTRIBUTE_COMPONENT)
+            ),
+            new RequireJsPreferenceReferenceProvider()
         );
 
         // <item name="component">requireJsMappingKey</item>
         registrar.registerReferenceProvider(
-                XmlPatterns.psiElement(XmlTokenType.XML_DATA_CHARACTERS).withParent(
-                        XmlPatterns.xmlText().withParent(
-                                XmlPatterns.xmlTag().withName("item").withChild(
-                                        XmlPatterns.xmlAttribute().withValue(string().matches("component"))
-                                ).withChild(
-                                        XmlPatterns.xmlAttribute().withName("name")
-                                )
-                        )
-                ),
-                new RequireJsPreferenceReferenceProvider()
+            XmlPatterns.psiElement(XmlTokenType.XML_DATA_CHARACTERS).withParent(
+                XmlPatterns.xmlText().withParent(
+                    XmlPatterns.xmlTag().withName(UiComponentXml.XML_TAG_ITEM).withChild(
+                        XmlPatterns.xmlAttribute().withValue(string().matches(UiComponentXml.XML_ATTRIBUTE_COMPONENT))
+                    ).withChild(
+                        XmlPatterns.xmlAttribute().withName(UiComponentXml.XML_ATTRIBUTE_NAME)
+                    )
+                )
+            ),
+            new RequireJsPreferenceReferenceProvider()
+        );
+
+        // <item name="template">reference</item>
+        registrar.registerReferenceProvider(
+            XmlPatterns.psiElement(XmlTokenType.XML_DATA_CHARACTERS).withParent(
+                XmlPatterns.xmlText().withParent(
+                    XmlPatterns.xmlTag().withName(UiComponentXml.XML_TAG_ITEM).withChild(
+                        XmlPatterns.xmlAttribute().withValue(string().matches(UiComponentXml.XML_ATTRIBUTE_TEMPLATE))
+                    ).withChild(
+                        XmlPatterns.xmlAttribute().withName(UiComponentXml.XML_ATTRIBUTE_NAME)
+                    )
+                )
+            ),
+            new FilePathReferenceProvider()
         );
 
         registerReferenceForDifferentNesting(registrar);
diff --git a/src/com/magento/idea/magento2plugin/stubs/indexes/js/MagentoLibJsIndex.java b/src/com/magento/idea/magento2plugin/stubs/indexes/js/MagentoLibJsIndex.java
@@ -9,6 +9,9 @@
 import com.intellij.util.indexing.*;
 import com.intellij.util.io.EnumeratorStringDescriptor;
 import com.intellij.util.io.KeyDescriptor;
+import com.magento.idea.magento2plugin.magento.packages.File;
+import com.magento.idea.magento2plugin.magento.packages.Package;
+import com.magento.idea.magento2plugin.project.Settings;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.HashMap;
@@ -29,7 +32,8 @@ public ID<String, Void> getName() {
     public DataIndexer<String, Void, FileContent> getIndexer() {
         return inputData -> {
             Map<String, Void> map = new HashMap<>();
-            String libPath = inputData.getProject().getBasePath() + "/lib/web/";
+            String libPath = Settings.getMagentoPath(inputData.getProject()) +
+                File.separator + Package.LIB_WEB_ROOT + File.separator;
             VirtualFile file = inputData.getFile();
 
             if (!file.getPath().contains(libPath)){
diff --git a/testData/completion/xml/RequireJsCompletionRegistrar/fileComponentAttributeMustHaveCompletion/test_form.xml b/testData/completion/xml/RequireJsCompletionRegistrar/fileComponentAttributeMustHaveCompletion/test_form.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<form xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
+    <fieldset name="general" >
+        <field name="test_field" component="Foo_Bar/js/fi<caret>">
+        </field>
+    </fieldset>
+</form>
diff --git a/testData/completion/xml/RequireJsCompletionRegistrar/fileComponentItemAttributeMustHaveCompletion/test_form.xml b/testData/completion/xml/RequireJsCompletionRegistrar/fileComponentItemAttributeMustHaveCompletion/test_form.xml
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<form xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
+    <dataSource name="test_source">
+        <argument name="data" xsi:type="array">
+            <item name="js_config" xsi:type="array">
+                <item name="component" xsi:type="string">Foo_Bar/js/fi<caret></item>
+            </item>
+        </argument>
+    </dataSource>
+</form>
diff --git a/testData/completion/xml/RequireJsCompletionRegistrar/mappedComponentAttributeMustHaveCompletion/test_form.xml b/testData/completion/xml/RequireJsCompletionRegistrar/mappedComponentAttributeMustHaveCompletion/test_form.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<form xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
+    <fieldset name="general" >
+        <field name="test_field" component="testF<caret>">
+        </field>
+    </fieldset>
+</form>
diff --git a/testData/completion/xml/RequireJsCompletionRegistrar/mappedComponentItemAttributeMustHaveCompletion/test_form.xml b/testData/completion/xml/RequireJsCompletionRegistrar/mappedComponentItemAttributeMustHaveCompletion/test_form.xml
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<form xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
+    <dataSource name="test_source">
+        <argument name="data" xsi:type="array">
+            <item name="js_config" xsi:type="array">
+                <item name="component" xsi:type="string">testF<caret></item>
+            </item>
+        </argument>
+    </dataSource>
+</form>
diff --git a/testData/completion/xml/UiComponentTemplateCompletionRegistrar/fileTemplateAttributeMustHaveCompletion/test_form.xml b/testData/completion/xml/UiComponentTemplateCompletionRegistrar/fileTemplateAttributeMustHaveCompletion/test_form.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<form xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
+    <fieldset name="general" >
+        <field name="test_field" template="Foo_Bar/temp<caret>">
+        </field>
+    </fieldset>
+</form>
diff --git a/testData/completion/xml/UiComponentTemplateCompletionRegistrar/fileTemplateItemAttributeMustHaveCompletion/test_form.xml b/testData/completion/xml/UiComponentTemplateCompletionRegistrar/fileTemplateItemAttributeMustHaveCompletion/test_form.xml
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<form xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
+    <dataSource name="test_source">
+        <argument name="data" xsi:type="array">
+            <item name="js_config" xsi:type="array">
+                <item name="template" xsi:type="string">Foo_Bar/temp<caret></item>
+            </item>
+        </argument>
+    </dataSource>
+</form>
diff --git a/testData/project/magento2/app/code/Foo/Bar/view/frontend/requirejs-config.js b/testData/project/magento2/app/code/Foo/Bar/view/frontend/requirejs-config.js
@@ -0,0 +1,10 @@
+var config = {
+    map: {
+        '*': {
+            testFile: 'Foo_Bar/js/file',
+        }
+    },
+    paths: {
+        'testFile2': 'Foo_Bar/js/file2'
+    }
+}
diff --git a/testData/project/magento2/app/code/Foo/Bar/view/frontend/web/js/file.js b/testData/project/magento2/app/code/Foo/Bar/view/frontend/web/js/file.js
@@ -0,0 +1,8 @@
+define([
+    'lib'
+], function(lib) {
+    'use strict';
+
+    return {
+    }
+});
diff --git a/testData/project/magento2/app/code/Foo/Bar/view/frontend/web/js/file2.js b/testData/project/magento2/app/code/Foo/Bar/view/frontend/web/js/file2.js
@@ -0,0 +1,8 @@
+define([
+    'lib'
+], function(lib) {
+    'use strict';
+
+    return {
+    }
+});
diff --git a/testData/project/magento2/app/code/Foo/Bar/view/frontend/web/template/template.html b/testData/project/magento2/app/code/Foo/Bar/view/frontend/web/template/template.html
@@ -0,0 +1 @@
+<h1>test</h1>
diff --git a/testData/project/magento2/app/code/Foo/Bar/view/frontend/web/template/template2.html b/testData/project/magento2/app/code/Foo/Bar/view/frontend/web/template/template2.html
@@ -0,0 +1 @@
+<h1>test</h1>
diff --git a/testData/project/magento2/lib/web/testjs.js b/testData/project/magento2/lib/web/testjs.js
@@ -0,0 +1 @@
+var test = 1;
diff --git a/testData/reference/js/RequireJsReferenceRegistrar/fileInjectionParameterMustHaveReference/test.js b/testData/reference/js/RequireJsReferenceRegistrar/fileInjectionParameterMustHaveReference/test.js
@@ -0,0 +1,8 @@
+define([
+    'Foo_Bar/js/file<caret>'
+], function(test) {
+    'use strict';
+
+    return {
+    }
+});
diff --git a/testData/reference/js/RequireJsReferenceRegistrar/libInjectionParameterMustHaveReference/test.js b/testData/reference/js/RequireJsReferenceRegistrar/libInjectionParameterMustHaveReference/test.js
@@ -0,0 +1,8 @@
+define([
+    'testjs<caret>'
+], function(test) {
+    'use strict';
+
+    return {
+    }
+});
diff --git a/testData/reference/js/RequireJsReferenceRegistrar/mappedInjectionParameterMustHaveReference/test.js b/testData/reference/js/RequireJsReferenceRegistrar/mappedInjectionParameterMustHaveReference/test.js
@@ -0,0 +1,8 @@
+define([
+    'testFile<caret>'
+], function(test) {
+    'use strict';
+
+    return {
+    }
+});
diff --git a/testData/reference/js/RequireJsReferenceRegistrar/pathInjectionParameterMustHaveReference/test.js b/testData/reference/js/RequireJsReferenceRegistrar/pathInjectionParameterMustHaveReference/test.js
@@ -0,0 +1,8 @@
+define([
+    'testFile2<caret>'
+], function(test) {
+    'use strict';
+
+    return {
+    }
+});
diff --git a/testData/reference/xml/RequireJsReferenceRegistrar/fileComponentMustHaveReference/test_form.xml b/testData/reference/xml/RequireJsReferenceRegistrar/fileComponentMustHaveReference/test_form.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<form xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
+    <fieldset name="general" >
+        <field name="test_field" component="Foo_Bar/js/file<caret>">
+        </field>
+    </fieldset>
+</form>
diff --git a/testData/reference/xml/RequireJsReferenceRegistrar/libComponentMustHaveReference/test_form.xml b/testData/reference/xml/RequireJsReferenceRegistrar/libComponentMustHaveReference/test_form.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<form xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
+    <fieldset name="general" >
+        <field name="test_field" component="testjs<caret>">
+        </field>
+    </fieldset>
+</form>
diff --git a/testData/reference/xml/RequireJsReferenceRegistrar/mappedComponentMustHaveReference/test_form.xml b/testData/reference/xml/RequireJsReferenceRegistrar/mappedComponentMustHaveReference/test_form.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<form xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
+    <fieldset name="general" >
+        <field name="test_field" component="testFile<caret>">
+        </field>
+    </fieldset>
+</form>
diff --git a/testData/reference/xml/RequireJsReferenceRegistrar/pathComponentMustHaveReference/test_form.xml b/testData/reference/xml/RequireJsReferenceRegistrar/pathComponentMustHaveReference/test_form.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<form xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
+    <fieldset name="general" >
+        <field name="test_field" component="testFile2<caret>">
+        </field>
+    </fieldset>
+</form>
diff --git a/testData/reference/xml/UiComponentTemplateReferenceRegistrar/fileTemplateAttributeMustHaveReference/test_form.xml b/testData/reference/xml/UiComponentTemplateReferenceRegistrar/fileTemplateAttributeMustHaveReference/test_form.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<form xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
+    <fieldset name="general" >
+        <field name="test_field" template="Foo_Bar/template2<caret>">
+        </field>
+    </fieldset>
+</form>
diff --git a/tests/com/magento/idea/magento2plugin/BaseProjectTestCase.java b/tests/com/magento/idea/magento2plugin/BaseProjectTestCase.java
@@ -40,6 +40,7 @@ protected String getTestDataPath() {
 
     protected void enablePluginAndReindex() {
         Settings settings = Settings.getInstance(myFixture.getProject());
+        settings.magentoPath = "/src";
         settings.pluginEnabled = true;
         settings.mftfSupportEnabled = true;
         IndexManager.manualReindex();
diff --git a/tests/com/magento/idea/magento2plugin/completion/xml/RequireJsCompletionRegistrarTest.java b/tests/com/magento/idea/magento2plugin/completion/xml/RequireJsCompletionRegistrarTest.java
diff --git a/tests/com/magento/idea/magento2plugin/completion/xml/UiComponentTemplateCompletionRegistrarTest.java b/tests/com/magento/idea/magento2plugin/completion/xml/UiComponentTemplateCompletionRegistrarTest.java
diff --git a/tests/com/magento/idea/magento2plugin/reference/BaseReferenceTestCase.java b/tests/com/magento/idea/magento2plugin/reference/BaseReferenceTestCase.java
diff --git a/tests/com/magento/idea/magento2plugin/reference/js/ReferenceJsFixtureTestCase.java b/tests/com/magento/idea/magento2plugin/reference/js/ReferenceJsFixtureTestCase.java
diff --git a/tests/com/magento/idea/magento2plugin/reference/js/RequireJsReferenceRegistrarTest.java b/tests/com/magento/idea/magento2plugin/reference/js/RequireJsReferenceRegistrarTest.java
diff --git a/tests/com/magento/idea/magento2plugin/reference/php/ReferencePhpFixtureTestCase.java b/tests/com/magento/idea/magento2plugin/reference/php/ReferencePhpFixtureTestCase.java
diff --git a/tests/com/magento/idea/magento2plugin/reference/xml/ReferenceXmlFixtureTestCase.java b/tests/com/magento/idea/magento2plugin/reference/xml/ReferenceXmlFixtureTestCase.java
diff --git a/tests/com/magento/idea/magento2plugin/reference/xml/RequireJsReferenceRegistrarTest.java b/tests/com/magento/idea/magento2plugin/reference/xml/RequireJsReferenceRegistrarTest.java
diff --git a/tests/com/magento/idea/magento2plugin/reference/xml/UiComponentTemplateReferenceRegistrarTest.java b/tests/com/magento/idea/magento2plugin/reference/xml/UiComponentTemplateReferenceRegistrarTest.java
