[HDDS-9948] Compose annotation for tests parameterized with ContainerLayoutVersion

• Type: Sub-task
• Status: Resolved
• Priority: Major
• Resolution: Implemented
• Fix Version/s: 2.0.0
• Component/s: test
• Labels: pull-request-available
• Assignee: Zhaohui Wang
• Reporter: Attila Doroszlai
• Created: 18/Dec/23 08:03
• Updated: 20/Dec/23 14:12
• Resolved: 20/Dec/23 14:12

Description

ContainerLayoutVersion is used in several classes to parameterize test methods.

Example usage:

https://github.com/apache/ozone/blob/3f35ab738d84000b747396f1f68c5977476ec6a1/hadoop-hdds/container-service/src/test/java/org/apache/hadoop/ozone/container/common/statemachine/commandhandler/TestCloseContainerCommandHandler.java#L112-L114

  @ParameterizedTest
  @MethodSource("layoutVersion")
  public void closeContainerWithPipeline(ContainerLayoutVersion layout)

where the source method is defined as:

https://github.com/apache/ozone/blob/3f35ab738d84000b747396f1f68c5977476ec6a1/hadoop-hdds/container-service/src/test/java/org/apache/hadoop/ozone/container/common/statemachine/commandhandler/TestCloseContainerCommandHandler.java#L80-L82

  private static Iterable<Object[]> layoutVersion() {
    return ContainerLayoutTestInfo.containerLayoutParameters();
  }

All usages (found so far):

hadoop-hdds/container-service/src/test/java/org/apache/hadoop/ozone/container/common/impl/TestContainerDataYaml.java
hadoop-hdds/container-service/src/test/java/org/apache/hadoop/ozone/container/common/impl/TestContainerDeletionChoosingPolicy.java
hadoop-hdds/container-service/src/test/java/org/apache/hadoop/ozone/container/common/impl/TestContainerSet.java
hadoop-hdds/container-service/src/test/java/org/apache/hadoop/ozone/container/common/impl/TestHddsDispatcher.java
hadoop-hdds/container-service/src/test/java/org/apache/hadoop/ozone/container/common/statemachine/commandhandler/TestCloseContainerCommandHandler.java
hadoop-hdds/container-service/src/test/java/org/apache/hadoop/ozone/container/keyvalue/TestKeyValueContainerMarkUnhealthy.java
hadoop-hdds/container-service/src/test/java/org/apache/hadoop/ozone/container/keyvalue/TestKeyValueHandler.java
hadoop-hdds/container-service/src/test/java/org/apache/hadoop/ozone/container/replication/TestReplicationSupervisor.java
hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/client/rpc/read/TestChunkInputStream.java
hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/client/rpc/read/TestKeyInputStream.java

The goal of this task is to reduce code duplication by defining a composite annotation.

Using the custom annotation we can:

• replace repeated @ParameterizedTest and @MethodSource
• delete the local method used as source in the test class (layoutVersion() in the example above)

Please see similar annotation defined for ContainerTestVersionInfo in HDDS-9932:

https://github.com/apache/ozone/blob/3f35ab738d84000b747396f1f68c5977476ec6a1/hadoop-hdds/container-service/src/test/java/org/apache/hadoop/ozone/container/keyvalue/ContainerTestVersionInfo.java#L43-L52

  /**
   * Composite annotation for tests parameterized with {@link ContainerTestVersionInfo}.
   */
  @Target(ElementType.METHOD)
  @Retention(RetentionPolicy.RUNTIME)
  @ParameterizedTest
  @MethodSource("org.apache.hadoop.ozone.container.keyvalue.ContainerTestVersionInfo#getLayoutList")
  public @interface ContainerTest {
    // composite annotation
  }

and its usage:

https://github.com/apache/ozone/blob/3f35ab738d84000b747396f1f68c5977476ec6a1/hadoop-hdds/container-service/src/test/java/org/apache/hadoop/ozone/container/keyvalue/TestKeyValueContainer.java#L179-L181

  @ContainerTestVersionInfo.ContainerTest
  public void testCreateContainer(ContainerTestVersionInfo versionInfo)
      throws Exception {

Issue Links

• links to: GitHub Pull Request #5839