Covert PHP class completion for backend_model & tests refactoring

Vasilii Burlacu · Vasilii Burlacu · commit 5bfba9cc3d55 · 2020-04-08T19:17:38.000+03:00
Refactored the implementation for SourceModelXmlCompletionRegistrarTest.java to match the new pattern for test fixtures
diff --git a/src/com/magento/idea/magento2plugin/magento/files/ModuleConfigXml.java b/src/com/magento/idea/magento2plugin/magento/files/ModuleConfigXml.java
@@ -5,5 +5,6 @@
 package com.magento.idea.magento2plugin.magento.files;
 
 public class ModuleConfigXml {
+    public static final String FILE_NAME = "config.xml";
     public static final String XML_ATTRIBUTE_BACKEND_MODEL = "backend_model";
 }
diff --git a/testData/completion/common/xml/BackendModelXmlCompletionRegistrar/configXmlBackendModelAttributeDontMatchWithFile/other-file-than-config.xml b/testData/completion/common/xml/BackendModelXmlCompletionRegistrar/configXmlBackendModelAttributeDontMatchWithFile/other-file-than-config.xml
@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Store:etc/config.xsd">
+    <default>
+        <payment>
+            <test>
+                <test backend_model="Yesno<caret>" />
+            </test>
+        </payment>
+    </default>
+</config>
diff --git a/testData/completion/common/xml/BackendModelXmlCompletionRegistrar/configXmlBackendModelAttributeMatchWithFile/config.xml b/testData/completion/common/xml/BackendModelXmlCompletionRegistrar/configXmlBackendModelAttributeMatchWithFile/config.xml
@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Store:etc/config.xsd">
+    <default>
+        <payment>
+            <test>
+                <test backend_model="Yesno<caret>" />
+            </test>
+        </payment>
+    </default>
+</config>
diff --git a/testData/completion/common/xml/BackendModelXmlCompletionRegistrar/configXmlElementCompletionWontShow/config.xml b/testData/completion/common/xml/BackendModelXmlCompletionRegistrar/configXmlElementCompletionWontShow/config.xml
@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Store:etc/config.xsd">
+    <default>
+        <payment>
+            <test>
+                <test backend_model="NotExistentClass<caret>" />
+            </test>
+        </payment>
+    </default>
+</config>
diff --git a/testData/completion/common/xml/BackendModelXmlCompletionRegistrar/configXmlElementProvideCompletion/config.xml b/testData/completion/common/xml/BackendModelXmlCompletionRegistrar/configXmlElementProvideCompletion/config.xml
@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Store:etc/config.xsd">
+    <default>
+        <payment>
+            <test>
+                <test backend_model="Yesno<caret>" />
+            </test>
+        </payment>
+    </default>
+</config>
diff --git a/testData/completion/common/xml/BackendModelXmlCompletionRegistrar/systemXmlBackendModelAttributeDontMatchWithFile/other-file-than-system.xml b/testData/completion/common/xml/BackendModelXmlCompletionRegistrar/systemXmlBackendModelAttributeDontMatchWithFile/other-file-than-system.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
+    <system>
+        <section id="catalog">
+            <group id="test">
+                <field id="test">
+                    <label>Test suit to check completion WON'T work for backend_model tag</label>
+                    <backend_model>Roles<caret></backend_model>
+                </field>
+            </group>
+        </section>
+    </system>
+</config>
diff --git a/testData/completion/common/xml/BackendModelXmlCompletionRegistrar/systemXmlBackendModelAttributeMatchWithFile/system.xml b/testData/completion/common/xml/BackendModelXmlCompletionRegistrar/systemXmlBackendModelAttributeMatchWithFile/system.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
+    <system>
+        <section id="catalog">
+            <group id="test">
+                <field id="test">
+                    <label>Test suit to check completion for backend_model tag exactly in system.xml file</label>
+                    <backend_model>Roles<caret></backend_model>
+                </field>
+            </group>
+        </section>
+    </system>
+</config>
diff --git a/testData/completion/common/xml/BackendModelXmlCompletionRegistrar/systemXmlElementCompletionWontShow/system.xml b/testData/completion/common/xml/BackendModelXmlCompletionRegistrar/systemXmlElementCompletionWontShow/system.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
+    <system>
+        <section id="catalog">
+            <group id="test">
+                <field id="test">
+                    <label>Test suit to check missing completion for backend_model tag</label>
+                    <backend_model>NotExistingSource<caret></backend_model>
+                </field>
+            </group>
+        </section>
+    </system>
+</config>
diff --git a/testData/completion/common/xml/BackendModelXmlCompletionRegistrar/systemXmlElementProvideCompletion/system.xml b/testData/completion/common/xml/BackendModelXmlCompletionRegistrar/systemXmlElementProvideCompletion/system.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
+    <system>
+        <section id="catalog">
+            <group id="test">
+                <field id="test">
+                    <label>Test suit to check completion for backend_model tag</label>
+                    <backend_model>Roles<caret></backend_model>
+                </field>
+            </group>
+        </section>
+    </system>
+</config>
diff --git a/testData/completion/common/xml/SourceModelXmlCompletionRegistrar/sourceModelXmlAttributeMatchWithFileNegativeCase/not-widget.xml b/testData/completion/common/xml/SourceModelXmlCompletionRegistrar/sourceModelXmlAttributeMatchWithFileNegativeCase/not-widget.xml
diff --git a/testData/completion/common/xml/SourceModelXmlCompletionRegistrar/sourceModelXmlAttributeMatchWithFilePositiveCase/widget.xml b/testData/completion/common/xml/SourceModelXmlCompletionRegistrar/sourceModelXmlAttributeMatchWithFilePositiveCase/widget.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<widgets xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Widget:etc/widget.xsd">
+    <widget id="test">
+        <label translate="true">Test Widget</label>
+        <description translate="true">Test Widget</description>
+        <parameters>
+            <parameter name="test_yesno" xsi:type="select" source_model="Yesno<caret>">
+                <label translate="true">Test Boolean field</label>
+            </parameter>
+        </parameters>
+    </widget>
+</widgets>
diff --git a/testData/completion/common/xml/SourceModelXmlCompletionRegistrar/sourceModelXmlAttributeMustProvideCompletion/widget.xml b/testData/completion/common/xml/SourceModelXmlCompletionRegistrar/sourceModelXmlAttributeMustProvideCompletion/widget.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<widgets xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Widget:etc/widget.xsd">
+    <widget id="test">
+        <label translate="true">Test Widget</label>
+        <description translate="true">Test Widget</description>
+        <parameters>
+            <parameter name="test_yesno" xsi:type="select" source_model="Yesno<caret>">
+                <label translate="true">Test Boolean field</label>
+            </parameter>
+        </parameters>
+    </widget>
+</widgets>
diff --git a/testData/completion/common/xml/SourceModelXmlCompletionRegistrar/sourceModelXmlElementMatchWithFileNegativeCase/not-system.xml b/testData/completion/common/xml/SourceModelXmlCompletionRegistrar/sourceModelXmlElementMatchWithFileNegativeCase/not-system.xml
diff --git a/testData/completion/common/xml/SourceModelXmlCompletionRegistrar/sourceModelXmlElementMatchWithFilePositiveCase/system.xml b/testData/completion/common/xml/SourceModelXmlCompletionRegistrar/sourceModelXmlElementMatchWithFilePositiveCase/system.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
+    <system>
+        <section id="catalog">
+            <group id="test">
+                <field id="test">
+                    <label>Test suit to check completion for source_model tag</label>
+                    <source_model>Yesno<caret></source_model>
+                </field>
+            </group>
+        </section>
+    </system>
+</config>
diff --git a/testData/completion/common/xml/SourceModelXmlCompletionRegistrar/sourceModelXmlElementMustProvideCompletion/system.xml b/testData/completion/common/xml/SourceModelXmlCompletionRegistrar/sourceModelXmlElementMustProvideCompletion/system.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
+    <system>
+        <section id="catalog">
+            <group id="test">
+                <field id="test">
+                    <label>Test suit to check completion for source_model tag</label>
+                    <source_model>Yesno<caret></source_model>
+                </field>
+            </group>
+        </section>
+    </system>
+</config>
diff --git a/tests/com/magento/idea/magento2plugin/completion/xml/BackendModelXmlCompletionRegistrarTest.java b/tests/com/magento/idea/magento2plugin/completion/xml/BackendModelXmlCompletionRegistrarTest.java
@@ -0,0 +1,128 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.completion.xml;
+
+import com.intellij.openapi.vfs.VirtualFile;
+import com.magento.idea.magento2plugin.magento.files.ModuleConfigXml;
+import com.magento.idea.magento2plugin.magento.files.ModuleSystemXml;
+
+import java.io.File;
+
+public class BackendModelXmlCompletionRegistrarTest extends CompletionLightJavaCodeInsightFixtureTestCase {
+
+    private static VirtualFile systemXmlVirtualFile;
+    private static VirtualFile configXmlVirtualFile;
+    private static final String testDataFolderPath;
+    private static final String fixturesFolderPath;
+    private static final String classesSourceFile;
+    private static final String[] systemXmlBackendModelLookupStringCheck;
+    private static final String[] configXmlBackendModelLookupStringCheck;
+
+    static {
+        testDataFolderPath = "testData/completion/common/";
+        fixturesFolderPath = "xml/BackendModelXmlCompletionRegistrar";
+        classesSourceFile = "classes.php";
+        systemXmlBackendModelLookupStringCheck = new String[]{
+                "Magento\\Backend\\Model\\Source\\Roles"
+        };
+        configXmlBackendModelLookupStringCheck = new String[]{
+                "Magento\\Config\\Model\\Config\\Source\\Yesno"
+        };
+    }
+
+    @Override
+    protected void setUp() throws Exception {
+        super.setUp();
+        myFixture.copyFileToProject(classesSourceFile);
+    }
+
+    @Override
+    protected String getTestDataPath() {
+        return testDataFolderPath;
+    }
+
+    protected String getFixturePath(String folderName, String fileName) {
+        return fixturesFolderPath + File.separator + folderName + File.separator + fileName;
+    }
+
+    public void testSystemXmlBackendModelElementProvideCompletion() {
+        String filePath = this.getFixturePath("systemXmlElementProvideCompletion", ModuleSystemXml.FILE_NAME);
+        systemXmlVirtualFile = myFixture.copyFileToProject(filePath);
+
+        assertCompletionContains(filePath, systemXmlBackendModelLookupStringCheck);
+    }
+
+    public void testSystemXmlBackendModelElementCompletionWontShow() {
+        String filePath = this.getFixturePath(
+            "systemXmlElementCompletionWontShow",
+            ModuleSystemXml.FILE_NAME
+        );
+        systemXmlVirtualFile = myFixture.copyFileToProject(filePath);
+
+        assertCompletionNotShowing(filePath);
+    }
+
+    public void testSystemXmlBackendModelAttributeMatchWithFile() {
+        String filePath = this.getFixturePath(
+            "systemXmlBackendModelAttributeMatchWithFile",
+            ModuleSystemXml.FILE_NAME
+        );
+
+        assertCompletionMatchWithFilePositiveCase(filePath, systemXmlBackendModelLookupStringCheck);
+    }
+
+    public void testSystemXmlBackendModelAttributeDontMatchWithFile() {
+        String filePath = this.getFixturePath(
+            "systemXmlBackendModelAttributeDontMatchWithFile",
+            "other-file-than-system.xml"
+        );
+
+        assertCompletionMatchWithFileNegativeCase(
+                filePath,
+                systemXmlBackendModelLookupStringCheck
+        );
+    }
+
+    public void testConfigXmlBackendModelElementProvideCompletion() {
+        String filePath = this.getFixturePath(
+            "configXmlElementProvideCompletion",
+            ModuleConfigXml.FILE_NAME
+        );
+        configXmlVirtualFile = myFixture.copyFileToProject(filePath);
+
+        assertCompletionContains(filePath, configXmlBackendModelLookupStringCheck);
+    }
+
+    public void testConfigXmlBackendModelElementCompletionWontShow() {
+        String filePath = this.getFixturePath(
+            "configXmlElementCompletionWontShow",
+            ModuleConfigXml.FILE_NAME
+        );
+        configXmlVirtualFile = myFixture.copyFileToProject(filePath);
+
+        assertCompletionNotShowing(filePath);
+    }
+
+    public void testConfigXmlBackendModelAttributeMatchWithFile() {
+        String filePath = this.getFixturePath(
+            "configXmlBackendModelAttributeMatchWithFile",
+            ModuleConfigXml.FILE_NAME
+        );
+
+        assertCompletionMatchWithFilePositiveCase(filePath, configXmlBackendModelLookupStringCheck);
+    }
+
+    public void testConfigXmlBackendModelAttributeDontMatchWithFile() {
+        String filePath = this.getFixturePath(
+            "configXmlBackendModelAttributeDontMatchWithFile",
+            "other-file-than-config.xml"
+        );
+
+        assertCompletionMatchWithFileNegativeCase(
+                filePath,
+                configXmlBackendModelLookupStringCheck
+        );
+    }
+}
diff --git a/tests/com/magento/idea/magento2plugin/completion/xml/CompletionLightJavaCodeInsightFixtureTestCase.java b/tests/com/magento/idea/magento2plugin/completion/xml/CompletionLightJavaCodeInsightFixtureTestCase.java
diff --git a/tests/com/magento/idea/magento2plugin/completion/xml/SourceModelXmlCompletionRegistrarTest.java b/tests/com/magento/idea/magento2plugin/completion/xml/SourceModelXmlCompletionRegistrarTest.java

Original file line number	Diff line number	Diff line change
`@@ -5,5 +5,6 @@`
`5`	`5`	`package com.magento.idea.magento2plugin.magento.files;`
`6`	`6`
`7`	`7`	`public class ModuleConfigXml {`
	`8`	`+ public static final String FILE_NAME = "config.xml";`
`8`	`9`	`public static final String XML_ATTRIBUTE_BACKEND_MODEL = "backend_model";`
`9`	`10`	`}`