Package org.elasticsearch.index.seqno

Class SequenceNumbersTestUtils

java.lang.Object
org.elasticsearch.index.seqno.SequenceNumbersTestUtils
public final class SequenceNumbersTestUtils extends Object
Utilities for asserting on sequence number fields at the Lucene level in integration tests.

  • Method Details

    • assertShardsHaveSeqNoDocValues

      public static void assertShardsHaveSeqNoDocValues(String indexName, boolean expectDocValuesOnDisk, int expectedShards) throws Exception
      Asserts that all shards of the given index either have or lack _seq_no doc values on disk. Uses the default ESIntegTestCase.internalCluster().
      Parameters:
      indexName - the index to check
      expectDocValuesOnDisk - true to assert doc values are present, false to assert they are empty
      expectedShards - the exact number of shards expected to be verified
      Throws:
      Exception

    • assertShardsHaveSeqNoDocValues

      public static void assertShardsHaveSeqNoDocValues(InternalTestCluster cluster, String indexName, boolean expectDocValuesOnDisk, int expectedShards) throws Exception
      Asserts that all shards of the given index on the given cluster either have or lack _seq_no doc values on disk.
      Parameters:
      cluster - the cluster to check
      indexName - the index to check
      expectDocValuesOnDisk - true to assert doc values are present, false to assert they are empty
      expectedShards - the exact number of shards expected to be verified
      Throws:
      Exception

    • assertShardsSeqNoDocValuesCount

      public static void assertShardsSeqNoDocValuesCount(InternalTestCluster cluster, String indexName, long expectedCount, int expectedShards)
      Asserts that the total number of _seq_no doc values across all shards of the given index equals the expected count.
      Parameters:
      cluster - the cluster to check
      indexName - the index to check
      expectedCount - the expected total number of doc values per shard
      expectedShards - the exact number of shards expected to be verified

    • assertShardsSeqNoDocValuesCount

      public static void assertShardsSeqNoDocValuesCount(IndicesService indicesService, String indexName, long expectedCount, int expectedShards)
      Asserts that the total number of _seq_no doc values for each shard of the given index on a specific node equals the expected count.
      Parameters:
      indicesService - the IndicesService instance for the node to check
      indexName - the index to check
      expectedCount - the expected total number of doc values per shard
      expectedShards - the exact number of shards expected to be verified

    • assertMinRetainedSeqNoAdvanced

      public static void assertMinRetainedSeqNoAdvanced(InternalTestCluster cluster, String indexName, long expectedSeqNo) throws Exception
      Waits until the minimum retained sequence number on the primary shard of the given index has advanced to at least the expected value. Calling `getMinRetainedSeqNo()` directly on the shard advances the cached value whenever the retention lock is not held. This method retries via `assertBusy` to find such a window, ensuring the value is stored durably.
      Parameters:
      cluster - the cluster containing the index
      indexName - the index to check
      expectedSeqNo - the expected minimum retained sequence number
      Throws:
      Exception

    • assertRetentionLeasesAdvanced

      public static void assertRetentionLeasesAdvanced(Client client, String indexName, long expectedRetainingSeqNo) throws Exception
      Waits until all retention leases on all shards of the given index have their retaining sequence number equal to the expected value.
      Parameters:
      client - the client to use for stats requests
      indexName - the index to check
      expectedRetainingSeqNo - the expected retaining sequence number for every lease
      Throws:
      Exception

    • persistGlobalCheckpointOnPrimaryShards

      public static void persistGlobalCheckpointOnPrimaryShards(String index) throws Exception
      Persist the global checkpoint on all primary shards of the given index into disk. This makes sure that the persisted global checkpoint on those shards will equal to the in-memory value. This helper method is useful if you do not use replicas in your test setup. Uses the default ESIntegTestCase.internalCluster().
      Throws:
      Exception

    • persistGlobalCheckpointOnPrimaryShards

      public static void persistGlobalCheckpointOnPrimaryShards(InternalTestCluster cluster, String indexName) throws Exception
      Persist the global checkpoint on all primary shards of the given index into disk. This makes sure that the persisted global checkpoint on those shards will equal to the in-memory value. This helper method is useful if you do not use replicas in your test setup.
      Parameters:
      cluster - the cluster containing the index
      indexName - the name of the index
      Throws:
      Exception