Added test for CacheableFalseInDefaultLayoutInspection, updated inspection

Vitaliy Boyko · Vitaliy Boyko · commit 240c69a34de3 · 2020-04-01T18:21:07.000+03:00
diff --git a/.gitignore b/.gitignore
@@ -50,3 +50,5 @@ out
 .idea-sandbox
 build
 gradle
+gradlew
+gradlew.bat
diff --git a/build.gradle b/build.gradle
@@ -33,6 +33,12 @@ intellij {
 }
 
 sourceSets {
-    main.java.srcDirs = ['src']
-    main.resources.srcDirs = ['resources']
+    main {
+        java.srcDirs 'src'
+        resources.srcDir 'resources'
+    }
+    test {
+        java.srcDir 'tests'
+        resources.srcDir 'testData'
+    }
 }
diff --git a/gradlew b/gradlew
diff --git a/gradlew.bat b/gradlew.bat
diff --git a/src/com/magento/idea/magento2plugin/inspections/xml/CacheableFalseInDefaultLayoutInspection.java b/src/com/magento/idea/magento2plugin/inspections/xml/CacheableFalseInDefaultLayoutInspection.java
@@ -15,19 +15,21 @@
 import org.jetbrains.annotations.NotNull;
 
 public class CacheableFalseInDefaultLayoutInspection extends XmlSuppressableInspectionTool {
+    public static final String CacheDisableProblemDescription = "Cacheable false attribute on the default layout will disable cache site-wide";
+
     @NotNull
     @Override
     public PsiElementVisitor buildVisitor(final @NotNull ProblemsHolder holder, final boolean isOnTheFly) {
         return new XmlElementVisitor() {
-            private static final String CacheDisableProblemDescription = "Cacheable false attribute on the default layout will disable cache site-wide";
             @Override
             public void visitXmlAttribute(XmlAttribute attribute) {
                 String fileName = holder.getFile().getName();
                 if (!fileName.equals(LayoutXml.DefaultFileName)) return;
                 final String text = attribute.getValue();
                 final String attributeName = attribute.getName();
                 if (!attributeName.equals(LayoutXml.CacheableAttributeName)) return;
-                if (!attribute.getParent().getName().equals(LayoutXml.BlockAttributeTagName)) return;
+                if (!attribute.getParent().getName().equals(LayoutXml.BlockAttributeTagName)
+                && !attribute.getParent().getName().equals(LayoutXml.ReferenceBlockAttributeTagName)) return;
                 if (text == null) return;
                 if (text.equals(LayoutXml.CacheableAttributeFalseValue)) {
                     holder.registerProblem(attribute, CacheDisableProblemDescription,
diff --git a/src/com/magento/idea/magento2plugin/magento/files/LayoutXml.java b/src/com/magento/idea/magento2plugin/magento/files/LayoutXml.java
@@ -9,4 +9,5 @@ public class LayoutXml {
     public static String CacheableAttributeName = "cacheable";
     public static String CacheableAttributeFalseValue = "false";
     public static String BlockAttributeTagName = "block";
+    public static String ReferenceBlockAttributeTagName = "referenceBlock";
 }
diff --git a/testData/inspections/xml/CacheableFalseInDefaultLayoutInspection/withCacheableFalseBlock/default.xml b/testData/inspections/xml/CacheableFalseInDefaultLayoutInspection/withCacheableFalseBlock/default.xml
@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<!--
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<page>
+    <body>
+        <referenceBlock name="footer_links" <warning descr="Cacheable false attribute on the default layout will disable cache site-wide">cacheable="false"</warning>/>
+    </body>
+</page>
diff --git a/testData/inspections/xml/CacheableFalseInDefaultLayoutInspection/withCacheableFalseBlockNotDefaultLayout/some_layout_index.xml b/testData/inspections/xml/CacheableFalseInDefaultLayoutInspection/withCacheableFalseBlockNotDefaultLayout/some_layout_index.xml
@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<!--
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<page>
+    <body>
+        <referenceBlock name="footer_links" cacheable="false" />
+    </body>
+</page>
diff --git a/testData/inspections/xml/CacheableFalseInDefaultLayoutInspection/withoutCacheableFalseBlock/default.xml b/testData/inspections/xml/CacheableFalseInDefaultLayoutInspection/withoutCacheableFalseBlock/default.xml
@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<!--
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
+<page>
+    <body>
+        <referenceBlock name="footer_links"/>
+    </body>
+</page>
diff --git a/tests/com/magento/idea/magento2plugin/inspections/xml/CacheableFalseInDefaultLayoutInspectionTest.java b/tests/com/magento/idea/magento2plugin/inspections/xml/CacheableFalseInDefaultLayoutInspectionTest.java
@@ -0,0 +1,45 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+package com.magento.idea.magento2plugin.inspections.xml;
+
+import com.magento.idea.magento2plugin.magento.files.LayoutXml;
+import com.intellij.testFramework.fixtures.BasePlatformTestCase;
+import java.io.File;
+
+//tested referenceBlock only as block tag is Special markup for the tests
+//@see https://www.jetbrains.org/intellij/sdk/docs/basics/testing_plugins/test_project_and_testdata_directories.html
+public class CacheableFalseInDefaultLayoutInspectionTest extends BasePlatformTestCase {
+    @Override
+    public void setUp() throws Exception {
+        super.setUp();
+        myFixture.enableInspections(CacheableFalseInDefaultLayoutInspection.class);
+    }
+
+    @Override
+    protected String getTestDataPath() {
+        return new File("testData/inspections/xml/"
+                + getClass().getSimpleName().replace("Test", "")).getAbsolutePath();
+    }
+
+    @Override
+    protected boolean isWriteActionRequired() {
+        return false;
+    }
+
+    public void testWithCacheableFalseBlock() throws Exception {
+        myFixture.configureByFile(getTestName(true) + "/" + LayoutXml.DefaultFileName);
+        myFixture.testHighlighting(true, false, false);
+    }
+
+    public void testWithoutCacheableFalseBlock() throws Exception {
+        myFixture.configureByFile(getTestName(true) + "/" + LayoutXml.DefaultFileName);
+        myFixture.testHighlighting(true, true, true);
+    }
+
+    public void testWithCacheableFalseBlockNotDefaultLayout() throws Exception {
+        myFixture.configureByFile(getTestName(true) + "/" + "some_layout_index.xml");
+        myFixture.testHighlighting(true, true, true);
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,12 @@ intellij {`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`sourceSets {`
`36`		`- main.java.srcDirs = ['src']`
`37`		`- main.resources.srcDirs = ['resources']`
	`36`	`+ main {`
	`37`	`+ java.srcDirs 'src'`
	`38`	`+ resources.srcDir 'resources'`
	`39`	`+ }`
	`40`	`+ test {`
	`41`	`+ java.srcDir 'tests'`
	`42`	`+ resources.srcDir 'testData'`
	`43`	`+ }`
`38`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,4 +9,5 @@ public class LayoutXml {`
`9`	`9`	`public static String CacheableAttributeName = "cacheable";`
`10`	`10`	`public static String CacheableAttributeFalseValue = "false";`
`11`	`11`	`public static String BlockAttributeTagName = "block";`
	`12`	`+ public static String ReferenceBlockAttributeTagName = "referenceBlock";`
`12`	`13`	`}`