Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: bf0c89fbd7
Fetching contributors…

Cannot retrieve contributors at this time

417 lines (334 sloc) 16.704 kb
package org.codehaus.groovy.grails.web.taglib
import grails.util.GrailsWebUtil
import grails.web.CamelCaseUrlConverter
import grails.web.UrlConverter
import javax.xml.parsers.DocumentBuilder
import javax.xml.parsers.DocumentBuilderFactory
import javax.xml.xpath.XPath
import javax.xml.xpath.XPathConstants
import javax.xml.xpath.XPathFactory
import org.codehaus.groovy.grails.commons.*
import org.codehaus.groovy.grails.commons.spring.WebRuntimeSpringConfiguration
import org.codehaus.groovy.grails.plugins.DefaultGrailsPlugin
import org.codehaus.groovy.grails.plugins.GrailsPluginManager
import org.codehaus.groovy.grails.plugins.MockGrailsPluginManager
import org.codehaus.groovy.grails.support.MockApplicationContext
import org.codehaus.groovy.grails.web.context.ServletContextHolder
import org.codehaus.groovy.grails.web.pages.*
import org.codehaus.groovy.grails.web.servlet.GrailsApplicationAttributes
import org.codehaus.groovy.grails.web.servlet.mvc.GrailsWebRequest
import org.codehaus.groovy.grails.web.sitemesh.GSPSitemeshPage
import org.codehaus.groovy.grails.web.sitemesh.GrailsPageFilter
import org.springframework.context.ApplicationContext
import org.springframework.context.ApplicationContextAware
import org.springframework.context.MessageSource
import org.springframework.context.support.StaticMessageSource
import org.springframework.core.io.Resource
import org.springframework.core.io.support.PathMatchingResourcePatternResolver
import org.springframework.mock.web.MockHttpServletRequest
import org.springframework.mock.web.MockHttpServletResponse
import org.springframework.mock.web.MockServletContext
import org.springframework.ui.context.Theme
import org.springframework.ui.context.ThemeSource
import org.springframework.ui.context.support.SimpleTheme
import org.springframework.web.context.WebApplicationContext
import org.springframework.web.context.request.RequestContextHolder
import org.springframework.web.servlet.DispatcherServlet
import org.springframework.web.servlet.i18n.AcceptHeaderLocaleResolver
import org.springframework.web.servlet.support.JstlUtils
import org.springframework.web.servlet.theme.SessionThemeResolver
import org.w3c.dom.Document
import com.opensymphony.module.sitemesh.RequestConstants
abstract class AbstractGrailsTagTests extends GroovyTestCase {
MockServletContext servletContext
GrailsWebRequest webRequest
MockHttpServletRequest request
MockHttpServletResponse response
ApplicationContext ctx
def originalHandler
ApplicationContext appCtx
GrailsApplication ga
GrailsPluginManager mockManager
GroovyClassLoader gcl = new GroovyClassLoader()
boolean enableProfile = false
GrailsApplication grailsApplication
StaticMessageSource messageSource
DocumentBuilder domBuilder
XPath xpath
def withConfig(String text, Closure callable) {
def config = new ConfigSlurper().parse(text)
try {
buildMockRequest(config)
callable()
}
finally {
RequestContextHolder.setRequestAttributes(null)
}
}
GrailsWebRequest buildMockRequest(ConfigObject config) throws Exception {
ga.config = config
servletContext.setAttribute(GrailsApplicationAttributes.APPLICATION_CONTEXT, appCtx)
servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, appCtx)
GrailsWebRequest request = GrailsWebUtil.bindMockWebRequest(appCtx)
initThemeSource(request.getCurrentRequest(), messageSource)
return request
}
def profile(String name, Closure callable) {
if (!enableProfile) return callable.call()
def now = System.currentTimeMillis()
for (i in 0..100) {
callable.call()
}
println "$name took ${System.currentTimeMillis()-now}ms"
}
def withTag(String tagName, Writer out, Closure callable) {
def result = null
runTest {
def webRequest = RequestContextHolder.currentRequestAttributes()
webRequest.out = out
def mockController = grailsApplication.getControllerClass("MockController").newInstance()
request.setAttribute(GrailsApplicationAttributes.CONTROLLER, mockController)
request.setAttribute(DispatcherServlet.LOCALE_RESOLVER_ATTRIBUTE, new AcceptHeaderLocaleResolver())
def tagLibrary = grailsApplication.getArtefactForFeature(TagLibArtefactHandler.TYPE, "g:" + tagName)
if (!tagLibrary) {
fail("No tag library found for tag $tagName")
}
def go = tagLibrary.newInstance()
if (go.properties.containsKey("grailsUrlMappingsHolder")) {
go.grailsUrlMappingsHolder = appCtx.grailsUrlMappingsHolder
}
if (go instanceof ApplicationContextAware) {
go.applicationContext = appCtx
}
GroovyPageOutputStack stack=GroovyPageOutputStack.createNew(out)
println "calling tag '${tagName}'"
def tag = go.getProperty(tagName)
def tagWrapper = { Object[] args ->
// the first or second arg may be a Map
// wrap Map args in GroovyPageAttributes
def newArgs = []
if (args?.length > 0) {
args.each {arg ->
if (arg instanceof Map && (!(arg instanceof GroovyPageAttributes))) {
newArgs << new GroovyPageAttributes(arg)
}
else {
newArgs << arg
}
}
}
tag.call(*newArgs)
}
result = callable.call(tagWrapper)
}
return result
}
protected void onSetUp() {}
protected void setUp() throws Exception {
domBuilder = DocumentBuilderFactory.newInstance().newDocumentBuilder()
xpath = XPathFactory.newInstance().newXPath()
originalHandler = GroovySystem.metaClassRegistry.metaClassCreationHandle
GroovySystem.metaClassRegistry.metaClassCreationHandle = new ExpandoMetaClassCreationHandle()
onSetUp()
grailsApplication = new DefaultGrailsApplication(gcl.loadedClasses, gcl)
ga = grailsApplication
def mainContext = new MockApplicationContext()
mainContext.registerMockBean UrlConverter.BEAN_NAME, new CamelCaseUrlConverter()
ga.mainContext = mainContext
grailsApplication.initialise()
mockManager = new MockGrailsPluginManager(grailsApplication)
mockManager.registerProvidedArtefacts(grailsApplication)
def mockControllerClass = gcl.parseClass("class MockController { def index = {} } ")
ctx = new MockApplicationContext()
ctx.servletContext.setAttribute(GrailsApplicationAttributes.APPLICATION_CONTEXT, ctx)
grailsApplication.setApplicationContext(ctx)
ctx.registerMockBean(GrailsApplication.APPLICATION_ID, grailsApplication)
ctx.registerMockBean("pluginManager", mockManager)
grailsApplication.addArtefact(ControllerArtefactHandler.TYPE, mockControllerClass)
messageSource = new StaticMessageSource()
ctx.registerMockBean("manager", mockManager)
ctx.registerMockBean("messageSource", messageSource)
ctx.registerMockBean("grailsApplication",grailsApplication)
ctx.registerMockBean(GroovyPagesUriService.BEAN_ID, new DefaultGroovyPagesUriService())
def dependantPluginClasses = []
dependantPluginClasses << gcl.loadClass("org.codehaus.groovy.grails.plugins.CoreGrailsPlugin")
dependantPluginClasses << gcl.loadClass("org.codehaus.groovy.grails.plugins.CodecsGrailsPlugin")
dependantPluginClasses << gcl.loadClass("org.codehaus.groovy.grails.plugins.DomainClassGrailsPlugin")
dependantPluginClasses << gcl.loadClass("org.codehaus.groovy.grails.plugins.i18n.I18nGrailsPlugin")
dependantPluginClasses << gcl.loadClass("org.codehaus.groovy.grails.plugins.web.ServletsGrailsPlugin")
dependantPluginClasses << gcl.loadClass("org.codehaus.groovy.grails.plugins.web.mapping.UrlMappingsGrailsPlugin")
dependantPluginClasses << gcl.loadClass("org.codehaus.groovy.grails.plugins.web.ControllersGrailsPlugin")
dependantPluginClasses << gcl.loadClass("org.codehaus.groovy.grails.plugins.web.GroovyPagesGrailsPlugin")
dependantPluginClasses << gcl.loadClass("org.codehaus.groovy.grails.plugins.log4j.Log4jGrailsPlugin")
def dependentPlugins = dependantPluginClasses.collect { new DefaultGrailsPlugin(it, grailsApplication)}
dependentPlugins.each{ mockManager.registerMockPlugin(it); it.manager = mockManager }
mockManager.registerProvidedArtefacts(grailsApplication)
def springConfig = new WebRuntimeSpringConfiguration(ctx)
webRequest = GrailsWebUtil.bindMockWebRequest(ctx)
onInit()
JstlUtils.exposeLocalizationContext webRequest.getRequest(),null
servletContext = webRequest.servletContext
ServletContextHolder.servletContext = servletContext
springConfig.servletContext = servletContext
dependentPlugins*.doWithRuntimeConfiguration(springConfig)
springConfig.addSingletonBean("messageSource", StaticMessageSource)
appCtx = springConfig.getApplicationContext()
ctx.servletContext.setAttribute(GrailsApplicationAttributes.APPLICATION_CONTEXT, appCtx)
servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, appCtx)
mockManager.applicationContext = appCtx
GroovySystem.metaClassRegistry.removeMetaClass(String)
GroovySystem.metaClassRegistry.removeMetaClass(Object)
// Why are the TagLibClasses removed?
//grailsApplication.tagLibClasses.each { tc -> GroovySystem.metaClassRegistry.removeMetaClass(tc.clazz)}
mockManager.doDynamicMethods()
request = webRequest.currentRequest
initThemeSource(request, messageSource)
request.characterEncoding = "utf-8"
response = webRequest.currentResponse
}
private def initThemeSource(request, StaticMessageSource messageSource) {
request.setAttribute(DispatcherServlet.THEME_SOURCE_ATTRIBUTE, new MockThemeSource(messageSource))
request.setAttribute(DispatcherServlet.THEME_RESOLVER_ATTRIBUTE, new SessionThemeResolver())
}
protected void tearDown() {
// Clear the page cache in the template engine since it's
// static and likely to cause tests to interfere with each other.
appCtx.groovyPagesTemplateEngine.clearPageCache()
RequestContextHolder.setRequestAttributes(null)
GroovySystem.metaClassRegistry.setMetaClassCreationHandle(originalHandler)
onDestroy()
ServletContextHolder.servletContext = null
}
protected void onInit() {}
protected void onDestroy() {}
protected MockServletContext createMockServletContext() { new MockServletContext() }
protected MockApplicationContext createMockApplicationContext() { new MockApplicationContext() }
protected Resource[] getResources(String pattern) {
new PathMatchingResourcePatternResolver().getResources(pattern)
}
void runTest(Closure callable) {
callable.call()
}
void printCompiledSource(template, params = [:]) {
def text = getCompiledSource(template, params)
println "----- GSP SOURCE -----"
println text
}
def getCompiledSource(template, params = [:]) {
def engine = appCtx.groovyPagesTemplateEngine
assert engine
def t = engine.createTemplate(template, "test_"+ System.currentTimeMillis())
def w = t.make(params)
w.showSource = true
def sw = new StringWriter()
def out = new PrintWriter(sw)
webRequest.out = out
w.writeTo(out)
String text = sw.toString()
}
def assertCompiledSourceContains(expected, template, params = [:]) {
def text = getCompiledSource(template, params)
return text.indexOf(expected) > -1
}
void assertOutputContains(expected, template, params = [:]) {
def result = applyTemplate(template, params)
assertTrue "Output does not contain expected string [$expected]. Output was: ${result}", result.indexOf(expected) > -1
}
void assertOutputNotContains(expected, template, params = [:]) {
def result = applyTemplate(template, params)
assertFalse "Output should not contain the expected string [$expected]. Output was: ${result}", result.indexOf(expected) > -1
}
/**
* Compares the output generated by a template with a string.
* @param expected The string that the template output is expected
* to match.
* @param template The template to run.
* @param params A map of variables to pass to the template - by
* default an empty map is used.
* @param transform A closure that is passed a StringWriter instance
* containing the output generated by the template. It is the result
* of this transformation that is actually compared with the expected
* string. The default transform simply converts the contents of the
* writer to a string.
*/
void assertOutputEquals(expected, template, params = [:], Closure transform = { it.toString() }) {
def engine = appCtx.groovyPagesTemplateEngine
//printCompiledSource(template)
assert engine
def t = engine.createTemplate(template, "test_"+ System.currentTimeMillis())
t.allowSettingContentType = true
/*
println "------------HTMLPARTS----------------------"
t.metaInfo.htmlParts.eachWithIndex {it, i -> print "htmlpart[${i}]:\n>${it}<\n--------\n" }
*/
def w = t.make(params)
MockHttpServletResponse mockResponse = new MockHttpServletResponse()
mockResponse.setCharacterEncoding("UTF-8")
GSPResponseWriter writer = GSPResponseWriter.getInstance(mockResponse)
webRequest.out = writer
w.writeTo(writer)
writer.flush()
assertEquals expected, transform(mockResponse.contentAsString)
}
def applyTemplate(template, params = [:], target = null, String filename = null) {
GroovyPagesTemplateEngine engine = appCtx.groovyPagesTemplateEngine
printCompiledSource(template)
assert engine
def t = engine.createTemplate(template, filename ?: "test_"+ System.currentTimeMillis())
def w = t.make(params)
if (!target) {
target = new FastStringWriter()
}
webRequest.out = target
w.writeTo(target)
target.flush()
return target.toString()
}
/**
* Applies sitemesh preprocessing to a template
*/
String sitemeshPreprocess(String template) {
def preprocessor=new SitemeshPreprocessor()
preprocessor.addGspSitemeshCapturing(template)
}
String applyLayout(String layout, String template, Map params=[:]) {
def page = new GSPSitemeshPage()
request.setAttribute(GrailsPageFilter.GSP_SITEMESH_PAGE, page)
applyTemplate(template, params)
request.removeAttribute(GrailsPageFilter.GSP_SITEMESH_PAGE)
try {
request.setAttribute(RequestConstants.PAGE, page)
return applyTemplate(layout, params,null, "/layouts/test_"+System.currentTimeMillis())
}
finally {
request.removeAttribute(RequestConstants.PAGE)
}
}
/**
* Parses the given XML text and creates a DOM document from it.
*/
protected final Document parseText(String xml) {
return domBuilder.parse(new ByteArrayInputStream(xml.getBytes("UTF-8")))
}
/**
* Asserts that the given XPath expression matches at least one
* node in the given DOM document.
*/
protected final void assertXPathExists(Document doc, String expr) {
assertTrue xpath.evaluate(expr, doc, XPathConstants.BOOLEAN)
}
/**
* Asserts that the given XPath expression matches no nodes in the
* given DOM document.
*/
protected final void assertXPathNotExists(Document doc, String expr) {
assertFalse xpath.evaluate(expr, doc, XPathConstants.BOOLEAN)
}
}
class MockThemeSource implements ThemeSource {
private messageSource
MockThemeSource(MessageSource messageSource) {
this.messageSource = messageSource
}
Theme getTheme(String themeName) { new SimpleTheme(themeName, messageSource) }
}
Jump to Line
Something went wrong with that request. Please try again.