You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@grails.apache.org by jd...@apache.org on 2025/07/04 11:17:10 UTC

(grails-core) 11/11: test: convert to specification

This is an automated email from the ASF dual-hosted git repository.

jdaugherty pushed a commit to branch issue14193Cleanup
in repository https://gitbox.apache.org/repos/asf/grails-core.git

commit 20d3546c0a791af4d22fb8d3d67f0c03a8afa2d4
Author: James Daugherty <jd...@jdresources.net>
AuthorDate: Fri Jul 4 06:57:54 2025 -0400

    test: convert to specification
---
 .../gsp/compiler/tags/GroovyEachParseTests.groovy  |   7 +-
 .../pages/{ParseTests.java => ParseSpec.groovy}    | 334 +++++++++++----------
 2 files changed, 180 insertions(+), 161 deletions(-)

diff --git a/grails-gsp/plugin/src/test/groovy/org/grails/gsp/compiler/tags/GroovyEachParseTests.groovy b/grails-gsp/plugin/src/test/groovy/org/grails/gsp/compiler/tags/GroovyEachParseTests.groovy
index ea296d520b..5d9d1b60bc 100644
--- a/grails-gsp/plugin/src/test/groovy/org/grails/gsp/compiler/tags/GroovyEachParseTests.groovy
+++ b/grails-gsp/plugin/src/test/groovy/org/grails/gsp/compiler/tags/GroovyEachParseTests.groovy
@@ -18,12 +18,15 @@
  */
 package org.grails.gsp.compiler.tags
 
-import org.grails.web.pages.ParseTests
 import org.junit.jupiter.api.Test
 
+import static org.grails.web.pages.ParseSpec.parseCode
+import static org.grails.web.pages.ParseSpec.trimAndRemoveCR
+import static org.grails.web.pages.ParseSpec.makeImports
+import static org.grails.web.pages.ParseSpec.GSP_FOOTER
 import static org.junit.jupiter.api.Assertions.assertEquals
 
-class GroovyEachParseTests extends ParseTests {
+class GroovyEachParseTests {
 
     @Test
     void testEachOutput() {
diff --git a/grails-gsp/plugin/src/test/groovy/org/grails/web/pages/ParseTests.java b/grails-gsp/plugin/src/test/groovy/org/grails/web/pages/ParseSpec.groovy
similarity index 50%
rename from grails-gsp/plugin/src/test/groovy/org/grails/web/pages/ParseTests.java
rename to grails-gsp/plugin/src/test/groovy/org/grails/web/pages/ParseSpec.groovy
index 992a9589f1..cf1a403ba5 100644
--- a/grails-gsp/plugin/src/test/groovy/org/grails/web/pages/ParseTests.java
+++ b/grails-gsp/plugin/src/test/groovy/org/grails/web/pages/ParseSpec.groovy
@@ -16,31 +16,27 @@
  *  specific language governing permissions and limitations
  *  under the License.
  */
-package org.grails.web.pages;
-
-import grails.core.DefaultGrailsApplication;
-import grails.core.GrailsApplication;
-import grails.util.GrailsWebMockUtil;
-import grails.util.GrailsWebUtil;
-import grails.web.pages.GroovyPagesUriService;
-import groovy.util.ConfigObject;
-import groovy.util.ConfigSlurper;
-import org.codehaus.groovy.runtime.IOGroovyMethods;
-import org.grails.gsp.GroovyPage;
-import org.grails.gsp.compiler.GroovyPageParser;
-import org.grails.taglib.GrailsTagException;
-import org.grails.web.servlet.mvc.GrailsWebRequest;
-import org.grails.web.util.GrailsApplicationAttributes;
-import org.junit.jupiter.api.Assertions;
-import org.junit.jupiter.api.Test;
-import org.springframework.mock.web.MockServletContext;
-import org.springframework.web.context.WebApplicationContext;
-import org.springframework.web.context.request.RequestContextHolder;
-import org.springframework.web.context.support.GenericWebApplicationContext;
-
-import java.io.ByteArrayInputStream;
-import java.io.IOException;
-import java.io.InputStream;
+
+package org.grails.web.pages
+
+import grails.core.DefaultGrailsApplication
+import grails.core.GrailsApplication
+import grails.util.GrailsWebMockUtil
+import grails.util.GrailsWebUtil
+import grails.web.pages.GroovyPagesUriService
+import groovy.transform.CompileStatic
+import org.codehaus.groovy.runtime.IOGroovyMethods
+import org.grails.gsp.GroovyPage
+import org.grails.gsp.compiler.GroovyPageParser
+import org.grails.taglib.GrailsTagException
+import org.grails.web.servlet.mvc.GrailsWebRequest
+import org.grails.web.util.GrailsApplicationAttributes
+import org.junit.jupiter.api.Assertions
+import org.springframework.mock.web.MockServletContext
+import org.springframework.web.context.WebApplicationContext
+import org.springframework.web.context.request.RequestContextHolder
+import org.springframework.web.context.support.GenericWebApplicationContext
+import spock.lang.Specification
 
 /**
  * Tests the GSP parser.  This can detect issues caused by improper
@@ -49,45 +45,23 @@ import java.io.InputStream;
  * <p>
  * The methods parseCode() and trimAndRemoveCR() have been added
  * to simplify test case code.
- *
- * @author Daiji
  */
-public class ParseTests {
-
-    class ParsedResult {
-        String generatedGsp;
-        GroovyPageParser parser;
-        String[] htmlParts;
-
-        @Override
-        public String toString() {
-            return generatedGsp;
-        }
-    }
-
-    protected static final String GSP_FOOTER = "public static final Map JSP_TAGS = new HashMap()\n"
-            + "protected void init() {\n"
-            + "\tthis.jspTags = JSP_TAGS\n"
-            + "}\n"
-            + "public static final String CONTENT_TYPE = 'text/html;charset=UTF-8'\n"
-            + "public static final long LAST_MODIFIED = 0L\n"
-            + "public static final String EXPRESSION_CODEC = 'HTML'\n"
-            + "public static final String STATIC_CODEC = 'none'\n"
-            + "public static final String OUT_CODEC = 'none'\n"
-            + "public static final String TAGLIB_CODEC = 'none'\n" +
-            "}\n";
-
-    protected String makeImports() {
-        StringBuilder result = new StringBuilder();
-        for (int i = 0; i < GroovyPageParser.DEFAULT_IMPORTS.length; i++) {
-            result.append("import ").append(GroovyPageParser.DEFAULT_IMPORTS[i]).append("\n");
-        }
-        return result.toString();
-    }
+class ParseSpec extends Specification {
+    static final String GSP_FOOTER = """public static final Map JSP_TAGS = new HashMap()
+protected void init() {
+\tthis.jspTags = JSP_TAGS
+}
+public static final String CONTENT_TYPE = 'text/html;charset=UTF-8'
+public static final long LAST_MODIFIED = 0L
+public static final String EXPRESSION_CODEC = 'HTML'
+public static final String STATIC_CODEC = 'none'
+public static final String OUT_CODEC = 'none'
+public static final String TAGLIB_CODEC = 'none'
+}
+"""
 
-    @Test
-    public void testParse() throws Exception {
-        ParsedResult result = parseCode("myTest1", "<div>hi</div>");
+    void "parse"() {
+        given:
         String expected = makeImports() +
                 "\n" +
                 "class myTest1 extends org.grails.gsp.GroovyPage {\n" +
@@ -96,14 +70,18 @@ public class ParseTests {
                 "Writer out = getOut()\n" +
                 "Writer expressionOut = getExpressionOut()\n" +
                 "printHtmlPart(0)\n" +
-                "}\n" + GSP_FOOTER;
-        Assertions.assertEquals(trimAndRemoveCR(expected), trimAndRemoveCR(result.generatedGsp));
-        Assertions.assertEquals("<div>hi</div>", result.htmlParts[0]);
+                "}\n" + GSP_FOOTER
+
+        when:
+        ParsedResult result = parseCode("myTest1", "<div>hi</div>")
+
+        then:
+        trimAndRemoveCR(expected) == trimAndRemoveCR(result.generatedGsp)
+        "<div>hi</div>" == result.htmlParts[0]
     }
 
-    @Test
-    public void testParseWithUnclosedSquareBracket() throws Exception {
-        String output = parseCode("myTest2", "<g:message code=\"testing [\"/>").generatedGsp;
+    void "parse with unclosed square brackets"() {
+        given:
         String expected = makeImports() +
                 "\n" +
                 "class myTest2 extends org.grails.gsp.GroovyPage {\n" +
@@ -113,33 +91,30 @@ public class ParseTests {
                 "Writer expressionOut = getExpressionOut()\n" +
 
                 "invokeTag('message','g',1,['code':evaluate('\"testing [\"', 1, it) { return \"testing [\" }],-1)\n" +
-                "}\n" + GSP_FOOTER;
+                "}\n" + GSP_FOOTER
+
+        when:
+        String output = parseCode("myTest2", "<g:message code=\"testing [\"/>").generatedGsp;
 
-        Assertions.assertEquals(trimAndRemoveCR(expected), trimAndRemoveCR(output));
+        then:
+        trimAndRemoveCR(expected) == trimAndRemoveCR(output)
     }
 
-    @Test
-    public void testParseWithUnclosedGstringThrowsException() throws IOException {
-        Assertions.assertThrows(GrailsTagException.class, () -> parseCode("myTest3", "<g:message value=\"${boom\">"), "[myTest3:1] Unclosed GSP expression");
+    void "parse without unclosed gstring throws exception"() {
+        when:
+        parseCode('myTest3', '<g:message_value="${boom">')
+
+        then:
+        def e = thrown(GrailsTagException)
+        e.message == '[myTest3:1] Unclosed GSP expression'
     }
 
-    @Test
-    public void testParseWithUTF8() throws Exception {
+    void "parse with utf8"() {
+        given:
         // This is some unicode Chinese (who knows what it says!)
-        String src = "Chinese text: \u3421\u3437\u343f\u3443\u3410\u3405\u38b3\u389a\u395e\u3947\u3adb\u3b5a\u3b67";
-        // Sanity check the string loaded OK as unicode - it won't look right if you output it, default stdout is not UTF-8
-        // on many OSes
-        Assertions.assertEquals(src.indexOf('?'), -1);
+        String src = "Chinese text: \u3421\u3437\u343f\u3443\u3410\u3405\u38b3\u389a\u395e\u3947\u3adb\u3b5a\u3b67"
 
-        ConfigObject config = new ConfigSlurper().parse("grails.views.gsp.encoding = \"UTF-8\"");
-
-        buildMockRequest(config);
-        ParsedResult output = null;
-        try {
-            output = parseCode("myTest4", src);
-        } finally {
-            RequestContextHolder.resetRequestAttributes();
-        }
+        and:
         String expected = makeImports() +
                 "\n" +
                 "class myTest4 extends org.grails.gsp.GroovyPage {\n" +
@@ -148,33 +123,33 @@ public class ParseTests {
                 "Writer out = getOut()\n" +
                 "Writer expressionOut = getExpressionOut()\n" +
                 "printHtmlPart(0)\n" +
-                "}\n" + GSP_FOOTER;
-        Assertions.assertEquals(trimAndRemoveCR(expected), trimAndRemoveCR(output.generatedGsp));
-        Assertions.assertEquals(src, output.htmlParts[0]);
-    }
+                "}\n" + GSP_FOOTER
+
+        // Sanity check the string loaded OK as unicode - it won't look right if you output it, default stdout is not UTF-8
+        // on many OSes
+        Assertions.assertEquals(src.indexOf('?'), -1)
+        ConfigObject config = new ConfigSlurper().parse("grails.views.gsp.encoding = \"UTF-8\"")
+        buildMockRequest(config)
 
-    private GrailsWebRequest buildMockRequest(ConfigObject config) throws Exception {
-        GenericWebApplicationContext appCtx = new GenericWebApplicationContext(new MockServletContext());
-        appCtx.refresh();
-        appCtx.getBeanFactory().registerSingleton(GroovyPagesUriService.BEAN_ID, new DefaultGroovyPagesUriService());
-
-        DefaultGrailsApplication grailsApplication = new DefaultGrailsApplication();
-        grailsApplication.setConfig(config);
-        appCtx.getBeanFactory().registerSingleton(GrailsApplication.APPLICATION_ID, grailsApplication);
-        appCtx.getServletContext().setAttribute(GrailsApplicationAttributes.APPLICATION_CONTEXT, appCtx);
-        appCtx.getServletContext().setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, appCtx);
-        return GrailsWebMockUtil.bindMockWebRequest(appCtx);
+        when:
+        ParsedResult output = parseCode("myTest4", src)
+
+        then:
+        trimAndRemoveCR(expected) == trimAndRemoveCR(output.generatedGsp)
+        src == output.htmlParts[0]
+
+        cleanup:
+        RequestContextHolder.resetRequestAttributes()
     }
 
-    @Test
-    public void testParseWithLocalEncoding() throws IOException {
-        String src = "This is just plain ASCII to make sure test works on all platforms";
+    void "parse with local encoding"() {
+        given:
+        String src = 'This is just plain ASCII to make sure test works on all platforms'
         // Sanity check the string loaded OK as unicode - it won't look right if you output it,
         // default stdout is not UTF-8 on many OSes
-        Assertions.assertEquals(src.indexOf('?'), -1);
+        Assertions.assertEquals(src.indexOf('?'), -1)
 
-        ParsedResult output = null;
-        output = parseCode("myTest5", src);
+        and:
         String expected = makeImports() +
                 "\n" +
                 "class myTest5 extends org.grails.gsp.GroovyPage {\n" +
@@ -183,56 +158,30 @@ public class ParseTests {
                 "Writer out = getOut()\n" +
                 "Writer expressionOut = getExpressionOut()\n" +
                 "printHtmlPart(0)\n" +
-                "}\n" + GSP_FOOTER;
-        Assertions.assertEquals(trimAndRemoveCR(expected), trimAndRemoveCR(output.generatedGsp));
-        Assertions.assertEquals(src, output.htmlParts[0]);
-    }
+                "}\n" + GSP_FOOTER
 
-    /**
-     * Eliminate potential issues caused by operating system differences
-     * and minor output differences that we don't care about.
-     * <p>
-     * Note: this code is inefficient and could stand to be optimized.
-     */
-    public String trimAndRemoveCR(String s) {
-        int index;
-        StringBuilder sb = new StringBuilder(s.trim());
-        while (((index = sb.toString().indexOf('\r')) != -1) || ((index = sb.toString().indexOf('\n')) != -1)) {
-            sb.deleteCharAt(index);
-        }
-        return sb.toString();
-    }
-
-    public ParsedResult parseCode(String uri, String gsp) throws IOException {
-        // Simulate what the parser does so we get it in the encoding expected
-        Object enc = GrailsWebUtil.currentConfiguration().get("grails.views.gsp.encoding");
-        if ((enc == null) || (enc.toString().trim().length() == 0)) {
-            enc = System.getProperty("file.encoding", "us-ascii");
-        }
+        when:
+        ParsedResult output = parseCode("myTest5", src)
 
-        InputStream gspIn = new ByteArrayInputStream(gsp.getBytes(enc.toString()));
-        GroovyPageParser parse = new GroovyPageParser(uri, uri, uri, gspIn, enc.toString(), "HTML", null);
-
-        InputStream in = parse.parse();
-        ParsedResult result = new ParsedResult();
-        result.parser = parse;
-        result.generatedGsp = IOGroovyMethods.getText(in, enc.toString());
-        result.htmlParts = parse.getHtmlPartsArray();
-        return result;
+        then:
+        trimAndRemoveCR(expected) == trimAndRemoveCR(output.generatedGsp)
+        src == output.htmlParts[0]
     }
 
-    @Test
-    public void testParseGTagsWithNamespaces() throws Exception {
+    void "parse gtags with namespace"() {
+        given:
         String output = parseCode("myTest6",
                 "<tbody>\n" +
                         "  <tt:form />\n" +
                         "</tbody>").generatedGsp;
         System.out.println("output = " + output);
-        Assertions.assertTrue(output.indexOf("invokeTag('form','tt',2,[:],-1)") > -1, "should have call to tag with 'tt' namespace");
+
+        expect: "should have call to tag with 'tt' namespace"
+        output.indexOf("invokeTag('form','tt',2,[:],-1)") > -1
     }
 
-    @Test
-    public void testParseWithWhitespaceNotEaten() throws Exception {
+    void "parse with whitespace not eaten"() {
+        given:
         String expected = makeImports() +
                 "\n" +
                 "class myTest7 extends org.grails.gsp.GroovyPage {\n" +
@@ -245,17 +194,84 @@ public class ParseTests {
                 "printHtmlPart(1)\n" +
                 "}\n" + GSP_FOOTER;
 
-        ParsedResult output = parseCode("myTest7",
-                "Please click the link below to confirm your email address:\n" +
-                        "\n" +
-                        "${uri}\n" +
-                        "\n" +
-                        "\n" +
-                        "Thanks");
-
-        Assertions.assertEquals(expected.replaceAll("[\r\n]", ""), output.generatedGsp.replaceAll("[\r\n]", ""));
-        Assertions.assertEquals("Please click the link below to confirm your email address:\n\n", output.htmlParts[0]);
-        Assertions.assertEquals("\n\n\nThanks", output.htmlParts[1]);
+        when:
+        ParsedResult output = parseCode('myTest7',
+                'Please click the link below to confirm your email address:\n' +
+                        '\n' +
+                        '${uri}\n' +
+                        '\n' +
+                        '\n' +
+                        'Thanks')
+
+        then:
+        expected.replaceAll("[\r\n]", "") == output.generatedGsp.replaceAll("[\r\n]", "")
+        "Please click the link below to confirm your email address:\n\n" == output.htmlParts[0]
+        "\n\n\nThanks" == output.htmlParts[1]
+    }
+
+    static ParsedResult parseCode(String uri, String gsp) throws IOException {
+        // Simulate what the parser does so we get it in the encoding expected
+        Object enc = GrailsWebUtil.currentConfiguration().get("grails.views.gsp.encoding")
+        if ((enc == null) || (enc.toString().trim().length() == 0)) {
+            enc = System.getProperty("file.encoding", "us-ascii")
+        }
+
+        InputStream gspIn = new ByteArrayInputStream(gsp.getBytes(enc.toString()))
+        GroovyPageParser parse = new GroovyPageParser(uri, uri, uri, gspIn, enc.toString(), "HTML", null)
+
+        InputStream inStream = parse.parse()
+        ParsedResult result = new ParsedResult()
+        result.parser = parse
+        result.generatedGsp = IOGroovyMethods.getText(inStream, enc.toString())
+        result.htmlParts = parse.getHtmlPartsArray()
+        return result
+    }
+
+    static String makeImports() {
+        StringBuilder result = new StringBuilder()
+        for (int i = 0; i < GroovyPageParser.DEFAULT_IMPORTS.length; i++) {
+            result.append("import ").append(GroovyPageParser.DEFAULT_IMPORTS[i]).append("\n")
+        }
+        return result.toString()
     }
 
+    /**
+     * Eliminate potential issues caused by operating system differences
+     * and minor output differences that we don't care about.
+     * <p>
+     * Note: this code is inefficient and could stand to be optimized.
+     */
+    static String trimAndRemoveCR(String s) {
+        int index
+        StringBuilder sb = new StringBuilder(s.trim())
+        while (((index = sb.toString().indexOf('\r')) != -1) || ((index = sb.toString().indexOf('\n')) != -1)) {
+            sb.deleteCharAt(index)
+        }
+        return sb.toString()
+    }
+
+    static GrailsWebRequest buildMockRequest(ConfigObject config) throws Exception {
+        GenericWebApplicationContext appCtx = new GenericWebApplicationContext(new MockServletContext())
+        appCtx.refresh()
+        appCtx.getBeanFactory().registerSingleton(GroovyPagesUriService.BEAN_ID, new DefaultGroovyPagesUriService())
+
+        DefaultGrailsApplication grailsApplication = new DefaultGrailsApplication()
+        grailsApplication.setConfig(config)
+        appCtx.getBeanFactory().registerSingleton(GrailsApplication.APPLICATION_ID, grailsApplication)
+        appCtx.getServletContext().setAttribute(GrailsApplicationAttributes.APPLICATION_CONTEXT, appCtx)
+        appCtx.getServletContext().setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, appCtx)
+        return GrailsWebMockUtil.bindMockWebRequest(appCtx)
+    }
+}
+
+@CompileStatic
+class ParsedResult {
+    String generatedGsp;
+    GroovyPageParser parser;
+    String[] htmlParts;
+
+    @Override
+    String toString() {
+        return generatedGsp;
+    }
 }