src/groovy/grails/test/GroovyPagesTestCase.groovy

   1 /* Copyright 2004-2005 the original author or authors.
   2  *
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at
   6  *
   7  *      http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 package grails.test
  16
  17 import org.codehaus.groovy.grails.web.pages.GroovyPagesTemplateEngine
  18 import org.springframework.web.context.request.RequestContextHolder
  19
  20 /**
  21 * A test harness that eases testing of GSP and tag libraries for Grails
  22
  23 * @author Graeme Rocher
  24 */
  25 class GroovyPagesTestCase extends GroovyTestCase  {
  26     /**
  27      * The GroovyPagesTemplateEngine which gets wired into this GSP
  28      */
  29     GroovyPagesTemplateEngine groovyPagesTemplateEngine
  30
  31     /**
  32      * Sets the controller name to use. Should be called to override the defaut "test" value
  33      */
  34     void setControllerName(String name) {
  35         RequestContextHolder.currentRequestAttributes().controllerName = name
  36     }
  37
  38     /**
  39      * Asserts the output of a given template against the specified expected value
  40      *
  41      * @param expected The expected output
  42      * @param template A snippet of GSP
  43      * @param params An optional parameter that allows variables to be placed in the binding of the GSP
  44      * @param transform An optional parameter that allows the specification of a closure to transform the passed StringWriter
  45      */
  46     def assertOutputEquals(expected, template, params = [:], Closure transform = { it.toString() }) {
  47         def webRequest = RequestContextHolder.currentRequestAttributes()
  48         def engine = groovyPagesTemplateEngine
  49
  50         assert engine
  51         def t = engine.createTemplate(template, "test_"+ System.currentTimeMillis())
  52
  53         def w = t.make(params)
  54
  55         def sw = new StringWriter()
  56         def out = new PrintWriter(sw)
  57         webRequest.out = out
  58         w.writeTo(out)
  59
  60         assertEquals expected, transform(sw)
  61     }
  62
  63     /**
  64      * Applies a GSP template and returns its output as a String
  65      *
  66      * @param template The GSP template
  67      * @param params An optional parameter that allows the specification of the binding
  68      */
  69         def applyTemplate(template, params = [:] ) {
  70         def webRequest = RequestContextHolder.currentRequestAttributes()
  71         def engine = groovyPagesTemplateEngine
  72
  73         assert engine
  74         def t = engine.createTemplate(template, "test_"+ System.currentTimeMillis())
  75
  76         def w = t.make(params)
  77
  78         def sw = new StringWriter()
  79         def out = new PrintWriter(sw)
  80         webRequest.out = out
  81         w.writeTo(out)
  82
  83         return sw.toString()
  84     }
  85 }