单元测试Grails域(超过?)扩展使用服务的基类

时间:2015-01-20 14:45:42

标签: unit-testing grails inheritance groovy gorm

所以,我有一个基类,我想扩展我的域类的大部分(但不是全部)。目标是我可以使用简单的extends将我需要的六个审计信息列添加到任何域类。对于创建和更新,我想记录日期,用户和程序(基于请求URI)。它使用Grails服务(称为CasService)来查找当前登录的用户。然后,CasService使用Spring Security和数据库调用来获取该字段的相关用户信息。

问题是,如果我这样做,那么我将不得不在测试使用这些类的域的任何单元测试中模拟CasService并请求对象。这也将影响使用这些域的服务和控制器的单元测试。这将使单元测试有点痛苦,并增加锅炉板代码,这是我试图避免的。

我喜欢钓鱼以获得更好的设计选择,我愿意接受建议。我当前的默认设置是简单地将相同的样板添加到我的所有域类中并完成它。请参阅下面的源代码以及我到目前为止所尝试的内容。

来源

通用审计域类

package com.mine.common

import grails.util.Holders
import org.springframework.web.context.request.RequestContextHolder

class AuditDomain implements GroovyInterceptable {

    def casService = Holders.grailsApplication.mainContext.getBean('casService')
    def request = RequestContextHolder?.getRequestAttributes()?.getRequest()

    String creator
    String creatorProgram
    String lastUpdater
    String lastUpdateProgram

    Date dateCreated
    Date lastUpdated

    def beforeValidate() {
        beforeInsert()
        beforeUpdate()
    }

    def beforeInsert() {
        if (this.creator == null) {
            this.creator = casService?.getUser() ?: 'unknown'
        }

        if (this.creatorProgram == null) {
            this.creatorProgram = request?.requestURI ?: 'unknown'
        }
    }

    def beforeUpdate() {
        this.lastUpdater = casService?.getUser() ?: 'unknown'
        this.lastUpdateProgram = request?.requestURI ?: 'unknown'
    }

    static constraints = {
        creator nullable:true, blank: true
        lastUpdater nullable:true, blank: true
        creatorProgram nullable:true, blank: true
        lastUpdateProgram nullable:true, blank: true
     }
}

CasService

package com.mine.common

import groovy.sql.Sql

class CasService {
    def springSecurityService, sqlService, personService

    def getUser() {
        if (isLoggedIn()) {
            def loginId = springSecurityService.authentication.name.toLowerCase()
            def query = "select USER_UNIQUE_ID from some_table where USER_LOGIN = ?"
            def parameters = [loginId]
            return sqlService.call(query, parameters)
        } else {
            return null
        }
    }

    def private isLoggedIn() {
        if (springSecurityService.isLoggedIn()) {
            return true
        } else {
            log.info "User is not logged in"
            return false
        }
    }

    //...
}

我尝试过什么

创建测试实用程序类以执行设置逻辑

我尝试过建立这样的课程:

class AuditTestUtils {

    def setup() {
        println "Tell AuditDomain to sit down and shut up"
        AuditDomain.metaClass.casService = null
        AuditDomain.metaClass.request = null
        AuditDomain.metaClass.beforeInsert = {}
        AuditDomain.metaClass.beforeUpdate = {}
    }

    def manipulateClass(classToTest) {
        classToTest.metaClass.beforeInsert = {println "Yo mama"}
        classToTest.metaClass.beforeUpdate = {println "Yo mamak"}
    }
}

然后在我的单元测试的setup()和setupSpec()块中调用它:

def setupSpec() {
    def au = new AuditTestUtils()
    au.setup()
}

OR

def setupSpec() {
    def au = new AuditTestUtils()
    au.manipulateClass(TheDomainIAmTesting)
}

没有骰子。一旦我尝试保存扩展AuditDomain的域类,就会在CasService上出现NullPointerException错误。

java.lang.NullPointerException: Cannot invoke method isLoggedIn() on null object
    at com.mine.common.CasService.isLoggedIn(CasService.groovy:127)
    at com.mine.common.CasService.getPidm(CasService.groovy:9)
    at com.mine.common.AuditDomain.beforeInsert(AuditDomain.groovy:26)
    //...
    at org.grails.datastore.gorm.GormInstanceApi.save(GormInstanceApi.groovy:161)
    at com.mine.common.SomeDomainSpec.test creation(SomeDomainSpec:30)

我愿意采用其他方式来解决将审核信息泄露到我的域名中的问题。我定居在inheritance,但还有其他方法。在我的环境中没有特征可用(Grails 2.3.6),但也许这只是开始更新到最新版本的原因。

我也对有关如何以不同方式测试这些域的建议持开放态度。也许我应该必须在每个拥有它们的域类的单元测试中与审核列竞争,尽管我不愿意。我可以在集成测试中处理它,但我可以自己轻松地单独测试AuditDomain类。我更喜欢在我的域上进行单元测试,测试这些域带来的特定内容,而不是它们都有的常见内容。

1 个答案:

答案 0 :(得分:2)

所以,最终,我和Groovy代表团一起去了解这个需求。

验证逻辑全部存在于

class AuditDomainValidator extends AuditDomainProperties {

    def domainClassInstance 

    public AuditDomainValidator(dci) {
        domainClassInstance = dci
    }

    def beforeValidate() {
        def user = defaultUser()
        def program = defaultProgram()
        if (this.creator == null) {
            this.creator = user
        }

        if (this.creatorProgram == null) {
            this.creatorProgram = program
        }
        this.lastUpdater = user
        this.lastUpdateProgram = program
    }

    private def defaultProgram() {
        domainClassInstance.getClass().getCanonicalName()
    }

    private def defaultUser() {
        domainClassInstance.casService?.getUser() ?: 'unknown'
    }
}

我创建了这个抽象类来在尝试各种解决方案时保存属性。它可能会毫无问题地折叠到验证器类中,但我只是懒得把它留在那里,因为它正在工作。

abstract class AuditDomainProperties {
    String creator
    String creatorProgram
    String lastUpdater
    String lastUpdateProgram

    Date dateCreated
    Date lastUpdated
}

最后,这里是如何在Grails域类中实现验证器类。

import my.company.CasService
import my.company.AuditDomainValidator

class MyClass {
    def casService

    @Delegate AuditDomainValidator adv = new AuditDomainValidator(this)
    static transients = ['adv']
    //...domain class code

    static mapping = {
        //..domain column mapping
        creator column: 'CREATOR'
        lastUpdater column: 'LAST_UPADTER'
        creatorProgram column: 'CREATOR_PGM'
        lastUpdateProgram column: 'LAST_UPDATE_PGM'
        dateCreated column: 'DATE_CREATED'
        lastUpdated column: 'LAST_UPDATED'
    }
}

这种方法似乎并不适用于单元和集成测试。尝试访问其中的dateCreated列失败,并显示相关域类没有此类属性的错误。多数民众赞成,因为运行应用程序运行正常。通过单元测试,我认为这是一个嘲弄的问题,但我不认为这是集成测试中的问题。