改进此代码的方法

Question

我正在尝试使用 Scalatest 为我的 java 应用程序编写一些测试代码。我想，由于 Scala 具有更易读的语法，因此会产生更易读的测试代码。

到目前为止，这就是我所做的：

package com.xyz

import org.scalatest.FlatSpec
import org.scalatest.matchers.ShouldMatchers
import com.xyz.SecurityService
import org.mockito.Mockito._
import org.scalatest.mock.MockitoSugar
import org.mockito.Matchers._
import javax.servlet.jsp.tagext.Tag

class CheckRoleTagSpec extends FlatSpec with ShouldMatchers with  MockitoSugar {

  behavior of "CheckRole tag"

  it should "allow access when neither role nor root defined" in {
    val securityServiceMock = mock[SecurityService]

    val tag = new CheckRoleTag()
    tag.setSecurityService(securityServiceMock)

    tag.setGroup("group")
    tag.setPortal("portal")

    tag.setRoot(false)
    tag.setRole(null)

    tag.doStartTag should be(Tag.SKIP_BODY)
  }

}

我对这段代码非常失望。这实际上与我需要用 Java 编写的东西是一样的。请帮助我使它更像 scala 和功能。

Answer 1

您无法通过重写测试来修复丑陋的测试。您只能通过重新设计正在测试的 API 来修复它。

嗯，从技术上来说，如果你真的很努力，非常邪恶，非常愚蠢，喝醉了或者非常累，那么有可能为好的 API 编写丑陋的测试。但是编写一个丑陋的测试需要努力，而且程序员很懒，所以不太可能有人会选择编写一个丑陋的测试。编写丑陋的测试几乎是不可能的：你插入一些东西，取出一些东西，检查你是否得到了你所期望的东西。就是这样。那里确实没有什么可丑化的。

测试只是使用 API，就像 API 用户使用它一样。它基本上是如何正确使用 API 的示例，而且几乎作为副作用，它碰巧检查 API 实际上是否正确实现。这就是为什么丑陋的测试是糟糕的 API 设计的良好指标，也是为什么测试驱动 API 设计是一件好事，即使您不进行 TDD。

在这种特殊情况下，我可以看到很多改进 API 的方法，尽管这些建议必然是不完整、肤浅和简单化的（更不用说可能是错误的），因为我对您的域一无所知：

• 更好名称：setRoot听起来像是在设置根。但是，除非 false 是层次结构的根，否则我假设它的实际上设置是该标签是否是根。因此，它应该被命名为 isRoot 或 makeRoot 或 setIsRoot 或类似的名称。
• 更好的默认值：继续使用setRoot，假设我的猜测是正确的并且这设置了标签是否是根，那么默认值是错误的。根据“根”概念的定义，只能有一个根。因此，您强制用户setRoot(false)每次指定，除了他们实际定义根的一次 。非根标签应该是默认值，并且您应该只强制为实际上是根的一个标签setRoot(true) 。
• 更好的默认值，第二部分：setRole(null)。严重地？您是否强制用户明确设置要取消设置的角色？为什么不简单地取消设置默认值呢？毕竟，测试被称为“...当角色和根都没有定义时”，那么为什么要定义它们呢？
• Fluent API / Builder Pattern：如果您确实必须构造无效对象（但请参阅下一点），至少使用 Fluent API 或 Builder Pattern 之类的东西。
• 仅构造有效对象：但实际上，对象在构造时应该始终有效、完整且完全配置。您不必先构造一个对象，然后再配置它。

这样，测试基本上就变成了：

package com.xyz

import org.scalatest.FlatSpec
import org.scalatest.matchers.ShouldMatchers
import com.xyz.SecurityService
import org.mockito.Mockito._
import org.scalatest.mock.MockitoSugar
import org.mockito.Matchers._
import javax.servlet.jsp.tagext.Tag

class CheckRoleTagSpec extends FlatSpec with ShouldMatchers with MockitoSugar {
  behavior of "CheckRole tag"
  it should "allow access when neither role nor root defined" in {
    val tag = new CheckRoleTag(mock[SecurityService], "group", "portal")

    tag.doStartTag should be(Tag.SKIP_BODY)
  }
}

Answer 2

下面的代码创建了新的匿名类，但 doStartTag 按预期返回结果：

...
(new CheckRoleTag{
   setSecurityService(mock[SecurityService])
   setGroup("group")
   setPortal("portal")
   setRoot(false)
   setRole(null)
} doStartTag) should be(Tag.SKIP_BODY)
...

Answer 3

由于这个特定的测试只是在 Java 中实现的对象上调用一堆 setter，因此您无法做太多事情来使其更加简洁、功能性或 scalaish。您可以删除一些重复内容，例如

it should "allow access when neither role nor root defined" in {
  val securityServiceMock = mock[SecurityService]

  val tag = new CheckRoleTag()

  locally { 
    import tag._
    setSecurityService(securityServiceMock)
    setGroup("group")
    setPortal("portal")
    setRoot(false)
    setRole(null)
  }

  tag.doStartTag should be(Tag.SKIP_BODY)
}

“我不确定在这种情况下是否真的值得”。