jqwik中在@Provide方法中使用@ForAll处理集合的正确姿势

本文深入探讨了在jqwik中结合@forall注解与集合类型在@provide方法中使用的常见误区与正确实践。主要解决了cannotfindarbitraryexception异常,阐明了@domain注解的正确作用范围,并提供了一种更推荐的方式来生成包含自定义类型集合的arbitrary,避免了在@provide方法参数中使用@forall可能导致的混淆和不当的扁平化映射行为。

理解jqwik中的领域上下文与任意值提供

在jqwik中,@Domain注解用于指定一个领域上下文(Domain Context),该上下文负责为测试提供自定义类型的任意值(Arbitrary)。例如,如果你的测试需要Name类型的实例,你可以通过一个继承自DomainContextBase的类来定义如何生成Name的Arbitrary。

// 领域模型
public class Name {
  public final String first;
  public final String last;
  public Name(String f, String l) { 
    this.first = f;
    this.last = l;
  }
}

// jqwik 领域上下文
public class NameDomain extends DomainContextBase {
  @Provide
  public Arbitrary arbName() {
    return Combinators.combine(
      Arbitraries.strings().alpha(), 
      Arbitraries.strings().alpha()
    ).as(Name::new);
  }
}

通过NameDomain,我们告诉jqwik如何构造Name的Arbitrary。当一个属性测试(Property Test)需要Name类型的参数时,jqwik会查找并使用这个arbName()方法。

@Domain注解的正确作用范围

一个常见的错误是将@Domain注解应用到提供方法(@Provide方法)的参数上,或者直接应用到提供方法本身。@Domain注解的正确作用范围是属性方法(@Property方法)或包含这些属性方法的测试类。它告诉jqwik在执行特定属性测试时,应该使用哪个领域上下文来解析其参数。

考虑以下不正确的用法,它会导致net.jqwik.api.CannotFindArbitraryException异常:

// 错误的 @Provide 方法,试图在参数中使用 @ForAll 和 @Domain 上下文
public class NameProperties {
  @Provide
  @Domain(NameDomain.class) // <-- 错误:@Domain 不应放在这里
  public Arbitrary> namesToParse(
    @ForAll @Size(min = 1, max = 4) Set names) {
    // ... 代码 ...
    return Arbitraries.just(new HashSet<>()); // 示例返回
  }

  @Property
  public void namesAreParsed(@ForAll("namesToParse") Set names) {
    // ... 代码 ...
  }
}

当jqwik尝试为namesToParse方法的参数Set names寻找Arbitrary时,它会因为@Domain(NameDomain.class)注解被错误地放置在@Provide方法上而感到困惑,无法正确解析该参数所需的Arbitrary。

正确的@Domain注解放置方式是将其应用于属性方法或整个测试类:

// 方式一:将 @Domain 应用于属性方法
public class NameProperties {
  // ... 其他代码 ...

  @Property
  @Domain(NameDomain.class) // <-- 正确:@Domain 应用于属性方法
  public void namesAreParsed(@ForAll("namesToParse") Set names) {
    // ... 代码 ...
  }
}

或者:

// 方式二:将 @Domain 应用于测试类
@Domain(NameDomain.class) // <-- 正确:@Domain 应用于测试类
class NameProperties { 
  // ... 属性方法和提供方法 ...
}

这确保了在执行namesAreParsed属性测试时,jqwik能够正确地利用NameDomain来处理任何Name类型的参数或其衍生物。

@ForAll参数在@Provide方法中的含义与替代方案

当你在一个@Provide方法中声明@ForAll参数时,jqwik会将其解释为一种扁平化映射(flat mapping)操作。这意味着jqwik会首先生成该参数的任意值,然后为每个生成的值调用@Provide方法来生成最终的Arbitrary。这种机制通常用于更复杂的场景,例如根据一个随机生成的配置来决定如何生成后续的任意值。

然而,如果你的目标仅仅是想生成一个包含自定义类型(如Name)的集合(如Set),然后对其进行映射或组合以产生另一个Arbitrary(如Arbitrary>),那么在@Provide方法中直接使用@ForAll参数来接收这个集合并不是最直接或推荐的方式。这可能导致逻辑上的混淆,并且在某些情况下,如上述所示,与@Domain的错误使用结合时,会引发异常。

推荐的替代方案是直接在@Provide方法内部构建所需集合的Arbitrary,利用Arbitraries.defaultFor()和集合任意值构建器。这样可以更清晰地表达你的意图,并避免@ForAll参数的扁平化映射语义带来的复杂性。

例如,如果你想提供一个Set,其中每个String都是由Name对象的first和last字段组合而成,你可以这样实现namesToParse方法:

public class NameProperties {
  // ... NameDomain 保持不变 ...

  @Provide
  @Domain(NameDomain.class) // 如果整个类都使用NameDomain,也可以放在类上
  public Arbitrary> namesToParse()

{ // 1. 获取 Name 类型的默认 Arbitrary,这会利用 NameDomain 中定义的 arbName() SetArbitrary namesArbitrary = Arbitraries.defaultFor(Name.class) .set() .ofMinSize(1) .ofMaxSize(4); // 2. 对生成的 Name 集合进行映射,转换为 Set // mapEach 方法允许你对集合中的每个元素进行转换 return namesArbitrary.map(nameSet -> { Set parsedNames = new HashSet<>(); for (Name n : nameSet) { parsedNames.add(n.first + " " + n.last); } return parsedNames; }); // 或者,如果每个元素转换独立,可以使用 mapEachValue // return namesArbitrary.mapEachValue((index, n) -> n.first + " " + n.last); } @Property @Domain(NameDomain.class) // 确保属性测试能访问 NameDomain public void namesAreParsed(@ForAll("namesToParse") Set names) { // 这里的 names 会由上面的 namesToParse() 方法提供 // ... 对 names 进行测试 ... System.out.println("Parsed names: " + names); assert !names.isEmpty(); } }

在这个改进的namesToParse()方法中:

  1. 我们没有在方法参数中使用@ForAll。
  2. 我们直接通过Arbitraries.defaultFor(Name.class)获取了Name类型的Arbitrary,这会自动查找并使用NameDomain中定义的arbName()方法。
  3. 我们使用.set().ofMinSize(1).ofMaxSize(4)构建了一个Set的Arbitrary。
  4. 最后,我们使用.map()操作将Set转换为Set

这种方法清晰地表达了生成过程:首先生成一个Name对象的集合,然后将这个集合转换成字符串集合。

总结

在jqwik中处理自定义类型集合的任意值时,请牢记以下几点:

  • @Domain注解应作用于@Property方法或其所在的测试类,而非@Provide方法或其参数。它定义了属性测试的领域上下文。
  • 在@Provide方法中声明@ForAll参数意味着扁平化映射,这可能不是你生成集合并进行转换时的初衷。
  • 对于生成包含自定义类型集合的Arbitrary,推荐直接在@Provide方法内部构建。利用Arbitraries.defaultFor(YourType.class)获取自定义类型的任意值,然后使用.set()、.list()等方法构建集合的任意值,最后通过.map()或.mapEachValue()进行转换。

遵循这些原则将帮助你更有效地利用jqwik的强大功能,编写出清晰、健壮的基于属性的测试。