HDDS-12000. Add unit test for RatisContainerSafeModeRule and ECContainerSafeModeRule

[kostacie]

What changes were proposed in this pull request?

In this PR, unit tests for RatisContainerSafeModeRule and ECContainerSafeModeRule have been added.

What is the link to the Apache JIRA

HDDS-12000

How was this patch tested?

https://github.com/kostacie/ozone/actions/runs/16267148185

[jojochuang]

A few more corner case scenarios are worth adding:

  @Test
   public void testNoContainersPresent() {
       when(containerManager.getContainers(ReplicationType.RATIS)).thenReturn(Collections.emptyList());
       rule.refresh(false);
       assertEquals(0.0, rule.getCurrentContainerThreshold(), "Threshold should be 0.0 when no containers present");
       assertFalse(rule.validate(), "Validate should return false when no containers present");
   }

   @Test
   public void testAllContainersClosed() {
       List<ContainerInfo> closedContainers = Arrays.asList(
           ScmTestUtils.getContainerWithState(ContainerReplicaProto.State.CLOSED),
           ScmTestUtils.getContainerWithState(ContainerReplicaProto.State.CLOSED)
       );
       when(containerManager.getContainers(ReplicationType.RATIS)).thenReturn(closedContainers);
       rule.refresh(false);
       assertEquals(0.0, rule.getCurrentContainerThreshold(), "Threshold should be 0.0 when all containers are closed");
       assertFalse(rule.validate(), "Validate should return false when all containers are closed");
   }

   @Test
   public void testAllContainersOpen() {
       List<ContainerInfo> openContainers = Arrays.asList(
           ScmTestUtils.getContainerWithState(ContainerReplicaProto.State.OPEN),
           ScmTestUtils.getContainerWithState(ContainerReplicaProto.State.OPEN)
       );
       when(containerManager.getContainers(ReplicationType.RATIS)).thenReturn(openContainers);
       rule.refresh(false);
       // Depending on the rule logic, adjust the expectation below:
       assertEquals(1.0, rule.getCurrentContainerThreshold(), "Threshold should be 1.0 when all containers are open");
       assertTrue(rule.validate(), "Validate should return true when all containers are open");
   }

   @Test
   public void testNullContainerInfo() {
       List<ContainerInfo> containers = Arrays.asList(
           null,
           ScmTestUtils.getContainerWithState(ContainerReplicaProto.State.OPEN)
       );
       when(containerManager.getContainers(ReplicationType.RATIS)).thenReturn(containers);
       assertDoesNotThrow(() -> rule.refresh(false), "Null containers should be skipped/handled gracefully");
   }

   @Test
   public void testDuplicateContainerIdsInReports() {
       ContainerInfo container = ScmTestUtils.getContainerWithState(ContainerReplicaProto.State.OPEN);
       int containerId = container.getContainerID();
       rule.refresh(false);
       rule.process(containerId);
       rule.process(containerId); // Duplicate process
       // The rule should not double-count the container
       // Add your assertion based on how the threshold should change
   }

   @Test
   public void testValidateBasedOnReportProcessingTrue() {
       rule.setValidateBasedOnReportProcessing(true);
       // Simulate report processing
       ContainerInfo container = ScmTestUtils.getContainerWithState(ContainerReplicaProto.State.OPEN);
       when(containerManager.getContainers(ReplicationType.RATIS)).thenReturn(Collections.singletonList(container));
       rule.refresh(false);
       rule.process(container.getContainerID());
       assertTrue(rule.validate(), "Should validate based on report processing");
   }

1. No Containers Present
   Test behavior when the container list is empty.
   This will verify that methods like refresh, validate, and process handle the empty case gracefully.

2. All Containers in CLOSED State
   Test with all containers in CLOSED state to ensure the rule behaves as expected (e.g., threshold remains at 0, or validate returns false if that's the intended logic).

3. All Containers in OPEN State
   Test with all containers in OPEN state to verify the rule's threshold and validation logic.

4. Null or Corrupt ContainerInfo
   Test handling of nulls or bogus container objects in the list—either skip or throw a controlled exception.

5. Duplicate Container IDs in Reports
   Test processing a report that contains duplicate replicas/containers to ensure no double-counting.

6. validateBasedOnReportProcessing = true
   You currently call rule.setValidateBasedOnReportProcessing(false);. Add a test with this flag set to true and verify the code path.

[jojochuang]

how about covering more states?

enum LifeCycleState {
    OPEN = 1;
    CLOSING = 2;
    QUASI_CLOSED = 3;
    CLOSED = 4;
    DELETING = 5;
    DELETED = 6; // object is deleted.
    RECOVERING = 7;
}

[kostacie]

@jojochuang thank you for the review.

I would only notice that there is no ScmTestUtils.getContainerWithState() method and the process() requires a NodeRegistrationContainerReport object, so I'll add and modify the tests taking this into account.

Also, there is an issue with two suggested tests testNoContainersPresentand testNullContainerInfo.
The first one is failing for some reason as getCurrentContainerThreshold equals 1.0 and rule.validate() returns true instead of false. Is it incorrect result for this test?
The second one causes NullPointerException while getting LifeCycleState because isClosed method (in RatisContainerSafeModeRule and ECContainerSafeModeRule) doesn't check nor ignore a value if it is null:

private boolean isClosed(ContainerInfo container) {
final LifeCycleState state = container.getState();
return state == LifeCycleState.QUASI_CLOSED || state == LifeCycleState.CLOSED;
}

[jojochuang]

Thanks @kostacie this is merged. I added the "Generated-by:" tag because the suggested change was recommended by Copilot, which I took.

[adoroszlai]

Thanks @kostacie for the patch. There is much duplication between the new test classes, created HDDS-13485 to address that.