Merge pull request #310 from bohdan-harniuk/212-test-coverage

Vitaliy · web-flow · commit b184c8b3a8bb · 2020-10-13T09:36:41.000+03:00
Added test coverage for references and completions of crontab instance and method
diff --git a/src/com/magento/idea/magento2plugin/completion/xml/XmlCompletionContributor.java b/src/com/magento/idea/magento2plugin/completion/xml/XmlCompletionContributor.java
@@ -193,7 +193,7 @@ public XmlCompletionContributor() {
         extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
                 .inside(XmlPatterns.xmlAttribute().withName("method")
                     .withParent(XmlPatterns.xmlTag().withName("job"))
-                ).inFile(xmlFile().withName(string().endsWith("crontab.xml"))),
+                ).inFile(xmlFile().withName(string().matches("crontab.xml"))),
             new PhpJobMethodCompletionContributor()
         );
 
diff --git a/src/com/magento/idea/magento2plugin/reference/provider/PhpJobMethodReferenceProvider.java b/src/com/magento/idea/magento2plugin/reference/provider/PhpJobMethodReferenceProvider.java
@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
@@ -15,7 +15,6 @@
 import com.jetbrains.php.lang.psi.elements.PhpClass;
 import com.magento.idea.magento2plugin.indexes.DiIndex;
 import com.magento.idea.magento2plugin.reference.xml.PolyVariantReferenceBase;
-// CHECKSTYLE IGNORE check FOR NEXT 1 LINES
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
@@ -41,7 +40,7 @@ public PsiReference[] getReferencesByElement(@NotNull PsiElement element, @NotNu
         PhpClass phpClass = DiIndex.getPhpClassOfJobMethod((XmlElement) element);
         if (phpClass != null) {
             Collection<Method> methods = phpClass.getMethods();
-            methods.removeIf(m -> !m.getName().equalsIgnoreCase(methodName));
+            methods.removeIf(method -> !method.getName().contains(methodName));
             psiReferences.add(new PolyVariantReferenceBase(element, methods));
         }
 
diff --git a/src/com/magento/idea/magento2plugin/reference/xml/XmlReferenceContributor.java b/src/com/magento/idea/magento2plugin/reference/xml/XmlReferenceContributor.java
@@ -93,7 +93,7 @@ public void registerReferenceProviders(@NotNull PsiReferenceRegistrar registrar)
                         XmlPatterns.xmlAttribute().withName("method").withParent(
                                 XmlPatterns.xmlTag().withName("job")
                         )
-                ).inFile(xmlFile().withName(string().endsWith("crontab.xml"))),
+                ).inFile(xmlFile().withName(string().matches("crontab.xml"))),
                 new PhpJobMethodReferenceProvider()
         );
 
diff --git a/testData/completion/xml/CrontabCompletionRegistrar/cronJobInstanceMustHaveCompletion/crontab.xml b/testData/completion/xml/CrontabCompletionRegistrar/cronJobInstanceMustHaveCompletion/crontab.xml
@@ -0,0 +1,15 @@
+<?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_Cron:etc/crontab.xsd">
+    <group id="default">
+        <job name="test_catalog_index_refresh_price" instance="RefreshSpe<caret>" method="">
+            <schedule>0 * * * *</schedule>
+        </job>
+    </group>
+</config>
diff --git a/testData/completion/xml/CrontabCompletionRegistrar/cronJobMethodMustHaveCompletion/crontab.xml b/testData/completion/xml/CrontabCompletionRegistrar/cronJobMethodMustHaveCompletion/crontab.xml
@@ -0,0 +1,15 @@
+<?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_Cron:etc/crontab.xsd">
+    <group id="default">
+        <job name="test_catalog_index_refresh_price" instance="Magento\Catalog\Cron\RefreshSpecialPrices" method="exe<caret>">
+            <schedule>0 * * * *</schedule>
+        </job>
+    </group>
+</config>
diff --git a/testData/completion/xml/CrontabCompletionRegistrar/notCrontabXmlMethodMustHaveNotCompletion/wrong_named_crontab.xml b/testData/completion/xml/CrontabCompletionRegistrar/notCrontabXmlMethodMustHaveNotCompletion/wrong_named_crontab.xml
@@ -0,0 +1,15 @@
+<?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_Cron:etc/crontab.xsd">
+    <group id="default">
+        <job name="" instance="Magento\Catalog\Cron\RefreshSpecialPrices" method="ex<caret>">
+            <schedule>0 * * * *</schedule>
+        </job>
+    </group>
+</config>
diff --git a/testData/completion/xml/CrontabCompletionRegistrar/notCrontabXmlMustHaveNotCompletion/wrong_named_crontab.xml b/testData/completion/xml/CrontabCompletionRegistrar/notCrontabXmlMustHaveNotCompletion/wrong_named_crontab.xml
@@ -0,0 +1,15 @@
+<?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_Cron:etc/crontab.xsd">
+    <group id="default">
+        <job name="test_catalog_index_refresh_price" instance="RefreshSpe<caret>" method="">
+            <schedule>0 * * * *</schedule>
+        </job>
+    </group>
+</config>
diff --git a/testData/completion/xml/CrontabCompletionRegistrar/notInstanceAttrMustHaveNotCompletion/crontab.xml b/testData/completion/xml/CrontabCompletionRegistrar/notInstanceAttrMustHaveNotCompletion/crontab.xml
@@ -0,0 +1,15 @@
+<?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_Cron:etc/crontab.xsd">
+    <group id="default">
+        <job name="test_catalog_index_refresh_price" wrong_attr="RefreshSpe<caret>" method="">
+            <schedule>0 * * * *</schedule>
+        </job>
+    </group>
+</config>
diff --git a/testData/completion/xml/CrontabCompletionRegistrar/notJobTagMustHaveNotCompletion/crontab.xml b/testData/completion/xml/CrontabCompletionRegistrar/notJobTagMustHaveNotCompletion/crontab.xml
@@ -0,0 +1,15 @@
+<?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_Cron:etc/crontab.xsd">
+    <group id="default">
+        <jobless name="test_catalog_index_refresh_price" instance="RefreshSpe<caret>" method="">
+            <schedule>0 * * * *</schedule>
+        </jobless>
+    </group>
+</config>
diff --git a/testData/project/magento2/vendor/magento/module-catalog/Cron/RefreshSpecialPrices.php b/testData/project/magento2/vendor/magento/module-catalog/Cron/RefreshSpecialPrices.php
@@ -0,0 +1,18 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Catalog\Cron;
+
+class RefreshSpecialPrices
+{
+    public function execute()
+    {
+    }
+
+    public function executeFull()
+    {
+    }
+}
diff --git a/testData/reference/xml/CrontabReferenceRegistrar/crontabInstanceMustHaveReference/crontab.xml b/testData/reference/xml/CrontabReferenceRegistrar/crontabInstanceMustHaveReference/crontab.xml
@@ -0,0 +1,15 @@
+<?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_Cron:etc/crontab.xsd">
+    <group id="default">
+        <job name="test_catalog_index_refresh_price" instance="Magento\Catalog\Cron\RefreshSpecialPrices<caret>" method="">
+            <schedule>0 * * * *</schedule>
+        </job>
+    </group>
+</config>
diff --git a/testData/reference/xml/CrontabReferenceRegistrar/crontabMethodMustHaveReference/crontab.xml b/testData/reference/xml/CrontabReferenceRegistrar/crontabMethodMustHaveReference/crontab.xml
@@ -0,0 +1,15 @@
+<?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_Cron:etc/crontab.xsd">
+    <group id="default">
+        <job name="test_catalog_index_refresh_price" instance="Magento\Catalog\Cron\RefreshSpecialPrices" method="execute<caret>">
+            <schedule>0 * * * *</schedule>
+        </job>
+    </group>
+</config>
diff --git a/tests/com/magento/idea/magento2plugin/completion/xml/CrontabCompletionRegistrarTest.java b/tests/com/magento/idea/magento2plugin/completion/xml/CrontabCompletionRegistrarTest.java
@@ -0,0 +1,68 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.completion.xml;
+
+import com.magento.idea.magento2plugin.magento.files.CrontabXmlTemplate;
+
+public class CrontabCompletionRegistrarTest extends CompletionXmlFixtureTestCase {
+    private static final String EXPECTED_INSTANCE = "Magento\\Catalog\\Cron\\RefreshSpecialPrices";
+    private static final String EXPECTED_METHOD = "execute";
+    private static final String WRONG_FILE_NAME = "wrong_named_crontab.xml";
+
+    /**
+     * The `instance` attribute of the `job` tag in crontab.xml must
+     * have completion based on PHP classes index.
+     */
+    public void testCronJobInstanceMustHaveCompletion() {
+        final String filePath = this.getFixturePath(CrontabXmlTemplate.FILE_NAME);
+        assertCompletionContains(filePath, EXPECTED_INSTANCE);
+    }
+
+    /**
+     * The `instance` attribute of the `job` tag in the
+     * non crontab.xml file must not have completion.
+     */
+    public void testNotCrontabXmlMustHaveNotCompletion() {
+        final String filePath = this.getFixturePath(WRONG_FILE_NAME);
+        assertFileNotContainsCompletions(filePath, EXPECTED_INSTANCE);
+    }
+
+    /**
+     * The non `instance` attribute of the `job` tag in crontab.xml must
+     * not have completion.
+     */
+    public void testNotInstanceAttrMustHaveNotCompletion() {
+        final String filePath = this.getFixturePath(CrontabXmlTemplate.FILE_NAME);
+        assertFileNotContainsCompletions(filePath, EXPECTED_INSTANCE);
+    }
+
+    /**
+     * The `instance` attribute that isn't in the `job` tag in crontab.xml must
+     * not have completion.
+     */
+    public void testNotJobTagMustHaveNotCompletion() {
+        final String filePath = this.getFixturePath(CrontabXmlTemplate.FILE_NAME);
+        assertFileNotContainsCompletions(filePath, EXPECTED_INSTANCE);
+    }
+
+    /**
+     * The `method` attribute of the `job` tag in crontab.xml must
+     * have completion based on PHP Job method completion provider.
+     */
+    public void testCronJobMethodMustHaveCompletion() {
+        final String filePath = this.getFixturePath(CrontabXmlTemplate.FILE_NAME);
+        assertCompletionContains(filePath, EXPECTED_METHOD);
+    }
+
+    /**
+     * The `method` attribute must not have completion
+     * if it isn`t in the crontab.xml file.
+     */
+    public void testNotCrontabXmlMethodMustHaveNotCompletion() {
+        final String filePath = this.getFixturePath(WRONG_FILE_NAME);
+        assertFileNotContainsCompletions(filePath, EXPECTED_METHOD);
+    }
+}
diff --git a/tests/com/magento/idea/magento2plugin/reference/xml/CrontabReferenceRegistrarTest.java b/tests/com/magento/idea/magento2plugin/reference/xml/CrontabReferenceRegistrarTest.java
@@ -0,0 +1,23 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.reference.xml;
+
+import com.magento.idea.magento2plugin.magento.files.CrontabXmlTemplate;
+
+public class CrontabReferenceRegistrarTest extends ReferenceXmlFixtureTestCase {
+    private static final String EXPECTED_REFERENCE = "Magento\\Catalog\\Cron\\RefreshSpecialPrices";
+
+    /**
+     * Test instance attribute of the crontab.xml file
+     * must have reference.
+     */
+    public void testCrontabInstanceMustHaveReference() {
+        final String filePath = this.getFixturePath(CrontabXmlTemplate.FILE_NAME);
+        myFixture.configureByFile(filePath);
+
+        assertHasReferencePhpClass(EXPECTED_REFERENCE);
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,7 @@ public void registerReferenceProviders(@NotNull PsiReferenceRegistrar registrar)`
`93`	`93`	`XmlPatterns.xmlAttribute().withName("method").withParent(`
`94`	`94`	`XmlPatterns.xmlTag().withName("job")`
`95`	`95`	`)`
`96`		`- ).inFile(xmlFile().withName(string().endsWith("crontab.xml"))),`
	`96`	`+ ).inFile(xmlFile().withName(string().matches("crontab.xml"))),`
`97`	`97`	`new PhpJobMethodReferenceProvider()`
`98`	`98`	`);`
`99`	`99`