Class AbstractWireTestCase<T>

java.lang.Object
org.junit.Assert
org.apache.lucene.tests.util.LuceneTestCase
org.opensearch.test.OpenSearchTestCase
org.opensearch.test.AbstractWireTestCase<T>
Direct Known Subclasses:
AbstractNamedWriteableTestCase, AbstractWireSerializingTestCase
public abstract class AbstractWireTestCase<T> extends OpenSearchTestCase
Standard test case for testing wire serialization. If the class being tested extends Writeable then prefer extending AbstractWireSerializingTestCase.

  • Field Details

  • Constructor Details

    • AbstractWireTestCase

      public AbstractWireTestCase()

  • Method Details

    • createTestInstance

      protected abstract T createTestInstance()
      Creates a random test instance to use in the tests. This method will be called multiple times during test execution and should return a different random instance each time it is called.

    • mutateInstance

      protected T mutateInstance(T instance) throws IOException
      Returns an instance which is mutated slightly so it should not be equal to the given instance.
      Throws:
      IOException

    • testEqualsAndHashcode

      public final void testEqualsAndHashcode()
      Tests that the equals and hashcode methods are consistent and copied versions of the instance are equal.

    • testSerialization

      public final void testSerialization() throws IOException
      Test serialization and deserialization of the test instance.
      Throws:
      IOException

    • assertSerialization

      protected final void assertSerialization(T testInstance) throws IOException
      Serialize the given instance and asserts that both are equal.
      Throws:
      IOException

    • assertSerialization

      protected final void assertSerialization(T testInstance, org.opensearch.Version version) throws IOException
      Assert that instances copied at a particular version are equal. The version is useful for sanity checking the backwards compatibility of the wire. It isn't a substitute for real backwards compatibility tests but it is *so* much faster.
      Throws:
      IOException

    • assertEqualInstances

      protected void assertEqualInstances(T expectedInstance, T newInstance)
      Assert that two instances are equal. This is intentionally not final so we can override how equality is checked.

    • copyInstance

      protected final T copyInstance(T instance) throws IOException
      Throws:
      IOException

    • copyInstance

      protected abstract T copyInstance(T instance, org.opensearch.Version version) throws IOException
      Copy the instance as by reading and writing using the code specific to the provided version. The version is useful for sanity checking the backwards compatibility of the wire. It isn't a substitute for real backwards compatibility tests but it is *so* much faster.
      Throws:
      IOException

    • getNamedWriteableRegistry

      protected org.opensearch.core.common.io.stream.NamedWriteableRegistry getNamedWriteableRegistry()
      Get the NamedWriteableRegistry to use when de-serializing the object.

      Override this method if you need to register NamedWriteables for the test object to de-serialize.

      By default this will return a NamedWriteableRegistry with no registered NamedWriteables