Implement getMutateFunction in all AbstractWireSerializingTestCase and AbstractStreamableTestCase subclasses

[colings86]

#25910 changed AbstractWireSerializingTestCase and AbstractStreamableTestCase to add a getMutateFunction method that is used when testing hashCode and equals to ensure that changing properties on the test instance makes it not equal to the original. At present this method defaults to returning null which disables the inequality checks (the equality checks are still run).

We should make getMutateFunction abstract so we force all subclasses to implement this method and so improve test coverage. Before we can do that we need to implement the method for the ~90 classes that already extend AbstractWireSerializingTestCase and AbstractStreamableTestCase. This issue serves to track the implementation of the method on those classes.

Subclasses of AbstractWireSerializingTestCase:

• FieldCapabilitiesTests (Adds mutate function to various tests #25999)
• ScriptMetaDataTests (Adds mutate function to various tests #25999)
• StoredScriptSourceTests (Adds mutate function to various tests #25999)
• StoredScriptTests ([TEST] Adds mutate method to more tests #26094)
• InternalOrderTests ([TEST] Adds mutate method to more tests #26094)
• InternalAdjacencyMatrixTests ([TEST] Adds mutate method to more tests #26094)
• InternalFiltersTests (Adds mutate function to various tests #25999)
• InternalFilterTests (Adds mutate function to various tests #25999)
• InternalGeoHashGridTests ([TEST] Adds mutate function for all metric aggregation tests #26056)
• InternalGlobalTests (Adds mutate function to various tests #25999)
• InternalDateHistogramTests ([TEST] Adds mutate function for all metric aggregation tests #26056)
• InternalHistogramTests ([TEST] Adds mutate function for all metric aggregation tests #26056)
• InternalMissingTests (Adds mutate function to various tests #25999)
• InternalNestedTests (Adds mutate function to various tests #25999)
• InternalReverseNestedTests (Adds mutate function to various tests #25999)
• InternalBinaryRangeTests ([TEST] Adds mutate method to more tests #26094)
• InternalDateRangeTests ([TEST] Adds mutate method to more tests #26094)
• InternalGeoDistanceTests ([TEST] Adds mutate method to more tests #26094)
• InternalRangeTests ([TEST] Adds mutate method to more tests #26094)
• InternalSamplerTests (Adds mutate function to various tests #25999)
• SignificantLongTermsTests ([TEST] Adds mutate method to more tests #26094)
• SignificantStringTermsTests ([TEST] Adds mutate method to more tests #26094)
• DoubleTermsTests ([TEST] Adds mutate method to more tests #26094)
• LongTermsTests ([TEST] Adds mutate method to more tests #26094)
• StringTermsTests ([TEST] Adds mutate method to more tests #26094)
• InternalExtendedStatsTests ([TEST] Adds mutate function for all metric aggregation tests #26056)
• InternalMaxTests ([TEST] Adds mutate function for all metric aggregation tests #26056)
• InternalStatsTests ([TEST] Adds mutate function for all metric aggregation tests #26056)
• InternalAvgTests ([TEST] Adds mutate function for all metric aggregation tests #26056)
• InternalCardinalityTests ([TEST] Adds mutate function for all metric aggregation tests #26056)
• InternalGeoBoundsTests ([TEST] Adds mutate function for all metric aggregation tests #26056)
• InternalGeoCentroidTests ([TEST] Adds mutate function for all metric aggregation tests #26056)
• InternalMinTests ([TEST] Adds mutate function for all metric aggregation tests #26056)
• InternalHDRPercentilesRanksTests ([TEST] Adds mutate function for all metric aggregation tests #26056)
• InternalHDRPercentilesTests ([TEST] Adds mutate function for all metric aggregation tests #26056)
• InternalTDigestPercentilesRanksTests ([TEST] Adds mutate function for all metric aggregation tests #26056)
• InternalTDigestPercentilesTests ([TEST] Adds mutate function for all metric aggregation tests #26056)
• InternalScriptedMetricTests ([TEST] Adds mutate function for all metric aggregation tests #26056)
• InternalSumTests ([TEST] Adds mutate function for all metric aggregation tests #26056)
• InternalTopHitsTests ([TEST] Adds mutate function for all metric aggregation tests #26056)
• InternalValueCountTests ([TEST] Adds mutate function for all metric aggregation tests #26056)
• InternalSimpleValueTests (Adds mutate function for all pipeline aggregation tests #26058)
• InternalBucketMetricValueTests (Adds mutate function for all pipeline aggregation tests #26058)
• InternalPercentilesBucketTests (Adds mutate function for all pipeline aggregation tests #26058)
• InternalDerivativeTests (Adds mutate function for all pipeline aggregation tests #26058)
• CollapseBuilderTests (Adds mutate function to various tests #25999)
• RepositoriesMetaDataSerializationTests (Adds mutate function to various tests #25999)
• SnapshotsInProgressSerializationTests (Adds mutate function to various tests #25999)
• InternalMatrixStatsTests (Adds mutate function to various tests #25999)
• InternalChildrenTests (Adds mutate function to various tests #25999)

Subclasses of AbstractStreamableTestCase:

• RefreshStatsTests (Adds mutate function to various tests #25999)

Cleanup

• Make AbstractWireSerializingTestCase.mutateInstance() abstract
• Make AbstractStreamableTestCase.mutateInstance() abstract

[elasticmachine]

Pinging @elastic/es-core-infra

[idegtiarenko]

Should we make AbstractWireSerializingTestCase.mutateInstance() abstract now and implement with empty return null; in all remaining sub-classes? This way we would not accidentally introduce more test cases that are silently skipping instance mutation.

[rjernst]

Are there new tests created since this issue was created? If so can they be added to the list in the original description? That would help guide whether they can be cutover to avoid more new instances as you suggest.

[idegtiarenko]

This is the compile failures I got after trying to compile only the server module after making mutateInstance() abstract:

• RetentionLeaseStatsWireSerializingTests
• ShardCountStatsTest
• ExplainResponseTests
• GetStoredScriptResponseTests
• IndexFeatureStatsTests
• ClusterStateResponseTests
• SnapshotStatusTests
• SnapshotsStatusResponseTests
• ResolveIndexResponseTests
• ResolveIndexRequestTests
• GetIndexResponseTests
• CloseIndexResponseTests
• GetFieldMappingsResponseTests
• GetIndexTemplatesResponseTests
• QueryExplanationTests
• CreateIndexRequestTests
• ResizeRequestTests
• GetSettingsResponseTests
• HealthMetadataSerializationTests
• HealthStatusTests
• HealthNodeTaskParamsTests
• DataStreamAliasTests
• DesiredNodesMetadataSerializationTests
• ItemUsageTests
• DataStreamTests
• DataStreamTemplateTests
• ClusterApplierRecordingServiceStatsTests
• RoundingWireTests
• UpdatePersistentTaskRequestTests
• PersistentTasksExecutorResponseTests
• StartPersistentActionRequestTests
• CancelPersistentTaskRequestTests
• PersistentTasksCustomMetadataTests
• CompletionPersistentTaskRequestTests
• PersistentTasksNodeServiceStatusTests
• SystemIndexMigrationTaskParamsTests
• FetchSourceContextTests
• PointInTimeBuilderTests
• SearchHitTests
• CollectorResultTests
• QueryProfileShardResultTests
• AggregationProfileShardResultTests
• SearchProfileResultsTests
• SearchProfileShardResultTests
• ProfileResultTests
• SearchProfileDfsPhaseResultTests
• SearchProfileQueryPhaseResultTests
• InternalIpPrefixTests
• MultiValuesSourceFieldConfigTests
• WeightedAvgAggregationBuilderTests
• AggregatorFactoriesBuilderTests

[rjernst]

It seems like some tests were missed in the generation of the original list. If you think you can cleanly cut these all over to to returning null so that the base method can be made abstract, it would seem worthwhile to stop more tests from being added that do not implement mutateInstance().