我应该在 Immutables 的单元测试中使用真实对象还是模拟对象?
Should I use real objects or mocks in unit tests with Immutables?
如果我必须测试使用可变实体的服务,我会构建我需要的最小对象(一个真实的对象)并将其传递给我的服务。示例:
User joe = new User();
joe.setEmail("joe@example.com");
resetPasswordService.resetPassword(joe);
verif(emailServiceMock).sendEmail("joe@example.com", "Your password has been reset!");
显然用户有很多字段,但我没有设置它们,因为 resetPasswordService
不需要它们。这对重构非常友好,因为如果我重命名不是电子邮件的用户字段,此测试将不会更改。
当我尝试对 Immutables 对象执行相同操作时出现问题。我将坚持使用相同的示例,将 User 从一个实体变成一个不可变的。
@Value.Immutable
public abstract class User {
public abstract String getEmail();
public abstract PostalAddress getPostalAddress();
//more fields
}
User joe = new ImmutableUserBuilder().email("joe@example.com").build();
resetPasswordService.resetPassword(joe);
verif(emailServiceMock).sendEmail("joe@example.com", "Your password has been reset!");
java.lang.IllegalStateException: 无法建立用户,一些必需的属性没有设置 [postalAddress, signupDate, city, ....]
构建器尝试构建对象时失败。那我该怎么办呢?
- 为用户使用 mock 并让它 return mock 即使 every time a mock returns a mock a fairy dies
- 创建一个测试 DSL 并拥有某种工厂来构建包含我不需要的所有字段的整个用户树结构?看起来很重而且不太适合重构。这使得测试的要求不那么透明。
- 在用户
@Nullable
中创建所有字段并让构建器不验证对象?这会让我面临生产中对象不完整的风险,对吧?
- 我错过了其他选项吗?
我知道用户应该是实体而不是不可变的值对象。我在这个例子中使用了用户,因为它很容易理解。
简单回答:您仅在必要时使用模拟。
含义:当您需要以 "real" class 不支持的方式 控制 对象的行为时。或者当您必须 验证 模拟调用时。
所以:当你可以编写一个测试用例来完成你想要它做的事情时而不使用模拟 - 那么就去做吧。
模拟框架是工具。您不使用它们不是因为您 可以 ,而是因为它们为您解决了您无法(轻松)解决的问题。
除此之外:如前所述,默认设置应避免模拟。另一方面,编程总是关于 平衡 努力和 "return on investment"。这就是为什么我在上面使用 easily 这个词。当事实证明使用 mock 会导致写下 2、3 行易于理解的代码......但是使用 "the real" class 就很多了更复杂(或依赖于某些关于 class 如何工作的 隐式 假设) - 那么使用模拟可能是更好的选择。
从这个意义上说,答案是:不要将答案和规则作为黄金标准。最后,这总是关于人的判断。
您的测试目前依赖于密码重置功能的实施细节。
这是您想要测试的行为:
- 给定一个用户
- 当该用户请求重设密码时
- 然后发送一封电子邮件
假设您稍后决定更改密码重置功能,以便电子邮件包含他们的姓名:
Dear Joe,
You have requested a password reset...
您的测试现在将失败并显示 NullPointerException
,因为您的测试策略基于 User
实例永远不需要名称的假设。一个完全无害的更改导致我们的测试在它应该通过的时候失败了。
解决方法:使用真实的对象。如果您发现您在不同的测试中创建了大量用户,请将用户创建重构为它自己的函数:
private User getUser()
{
User joe = new User();
joe.setEmail("joe@example.com");
joe.setName("Joe");
joe.setAge(20);
joe.setHeight(180);
return joe;
}
如果我必须测试使用可变实体的服务,我会构建我需要的最小对象(一个真实的对象)并将其传递给我的服务。示例:
User joe = new User();
joe.setEmail("joe@example.com");
resetPasswordService.resetPassword(joe);
verif(emailServiceMock).sendEmail("joe@example.com", "Your password has been reset!");
显然用户有很多字段,但我没有设置它们,因为 resetPasswordService
不需要它们。这对重构非常友好,因为如果我重命名不是电子邮件的用户字段,此测试将不会更改。
当我尝试对 Immutables 对象执行相同操作时出现问题。我将坚持使用相同的示例,将 User 从一个实体变成一个不可变的。
@Value.Immutable
public abstract class User {
public abstract String getEmail();
public abstract PostalAddress getPostalAddress();
//more fields
}
User joe = new ImmutableUserBuilder().email("joe@example.com").build();
resetPasswordService.resetPassword(joe);
verif(emailServiceMock).sendEmail("joe@example.com", "Your password has been reset!");
java.lang.IllegalStateException: 无法建立用户,一些必需的属性没有设置 [postalAddress, signupDate, city, ....]
构建器尝试构建对象时失败。那我该怎么办呢?
- 为用户使用 mock 并让它 return mock 即使 every time a mock returns a mock a fairy dies
- 创建一个测试 DSL 并拥有某种工厂来构建包含我不需要的所有字段的整个用户树结构?看起来很重而且不太适合重构。这使得测试的要求不那么透明。
- 在用户
@Nullable
中创建所有字段并让构建器不验证对象?这会让我面临生产中对象不完整的风险,对吧? - 我错过了其他选项吗?
我知道用户应该是实体而不是不可变的值对象。我在这个例子中使用了用户,因为它很容易理解。
简单回答:您仅在必要时使用模拟。
含义:当您需要以 "real" class 不支持的方式 控制 对象的行为时。或者当您必须 验证 模拟调用时。
所以:当你可以编写一个测试用例来完成你想要它做的事情时而不使用模拟 - 那么就去做吧。
模拟框架是工具。您不使用它们不是因为您 可以 ,而是因为它们为您解决了您无法(轻松)解决的问题。
除此之外:如前所述,默认设置应避免模拟。另一方面,编程总是关于 平衡 努力和 "return on investment"。这就是为什么我在上面使用 easily 这个词。当事实证明使用 mock 会导致写下 2、3 行易于理解的代码......但是使用 "the real" class 就很多了更复杂(或依赖于某些关于 class 如何工作的 隐式 假设) - 那么使用模拟可能是更好的选择。
从这个意义上说,答案是:不要将答案和规则作为黄金标准。最后,这总是关于人的判断。
您的测试目前依赖于密码重置功能的实施细节。
这是您想要测试的行为:
- 给定一个用户
- 当该用户请求重设密码时
- 然后发送一封电子邮件
假设您稍后决定更改密码重置功能,以便电子邮件包含他们的姓名:
Dear Joe,
You have requested a password reset...
您的测试现在将失败并显示 NullPointerException
,因为您的测试策略基于 User
实例永远不需要名称的假设。一个完全无害的更改导致我们的测试在它应该通过的时候失败了。
解决方法:使用真实的对象。如果您发现您在不同的测试中创建了大量用户,请将用户创建重构为它自己的函数:
private User getUser()
{
User joe = new User();
joe.setEmail("joe@example.com");
joe.setName("Joe");
joe.setAge(20);
joe.setHeight(180);
return joe;
}