org.elasticsearch.test.AbstractSerializationTestCase Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of framework Show documentation
Elasticsearch subproject :test:framework
The newest version!
/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0 and the Server Side Public License, v 1; you may not use this file except
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */
package org.elasticsearch.test;

import org.apache.lucene.util.BytesRef;
import org.elasticsearch.common.Strings;
import org.elasticsearch.common.io.stream.Writeable;
import org.elasticsearch.core.Predicates;
import org.elasticsearch.rest.action.search.RestSearchAction;
import org.elasticsearch.xcontent.ToXContent;
import org.elasticsearch.xcontent.XContentBuilder;
import org.elasticsearch.xcontent.XContentType;
import org.elasticsearch.xcontent.cbor.CborXContent;
import org.elasticsearch.xcontent.smile.SmileXContent;

import java.io.IOException;
import java.time.Instant;
import java.util.Date;
import java.util.concurrent.ExecutionException;
import java.util.function.Predicate;

import static java.util.Collections.singletonMap;
import static org.elasticsearch.common.xcontent.XContentHelper.toXContent;

public abstract class AbstractSerializationTestCase extends AbstractWireSerializingTestCase {

    /**
     * Generic test that creates new instance from the test instance and checks
     * both for equality and asserts equality on the two instances.
     */
    public final void testFromXContent() throws IOException {
        createXContentTester().numberOfTestRuns(NUMBER_OF_TEST_RUNS)
            .supportsUnknownFields(supportsUnknownFields())
            .shuffleFieldsExceptions(getShuffleFieldsExceptions())
            .randomFieldsExcludeFilter(getRandomFieldsExcludeFilter())
            .assertEqualsConsumer(this::assertEqualInstances)
            .assertToXContentEquivalence(assertToXContentEquivalence())
            .dispose(this::dispose)
            .test();
    }

    /**
     * Calls xContent serialization on many threads and verifies that
     * they produce the same result. Async search sometimes does this to
     * aggregation responses and, in general, we think it's reasonable for
     * everything that can convert itself to json to be able to do so
     * concurrently.
     */
    public final void testConcurrentToXContent() throws IOException, InterruptedException, ExecutionException {
        XContentType xContentType = randomValueOtherThanMany(
            /*
             * SMILE will sometimes use the unicode marker for ascii strings
             * if the it's internal buffer doeesn't have enough space for the
             * whole string. That's fine for SMILE readers, but we're comparing
             * bytes here so we can't use it.
             */
            type -> type.xContent() == SmileXContent.smileXContent,
            () -> randomFrom(XContentType.values())
        );
        T testInstance = createXContextTestInstance(xContentType);
        try {
            ToXContent.Params params = new ToXContent.DelegatingMapParams(
                singletonMap(RestSearchAction.TYPED_KEYS_PARAM, "true"),
                getToXContentParams()
            );
            boolean humanReadable = randomBoolean();
            BytesRef firstTimeBytes = toXContent(asXContent(testInstance), xContentType, params, humanReadable).toBytesRef();

            /*
             * 500 rounds seems to consistently reproduce the issue on Nik's
             * laptop. Larger numbers are going to be slower but more likely
             * to reproduce the issue.
             */
            int rounds = scaledRandomIntBetween(300, 5000);
            concurrentTest(() -> {
                try {
                    for (int r = 0; r < rounds; r++) {
                        BytesRef thisRoundBytes = toXContent(asXContent(testInstance), xContentType, params, humanReadable).toBytesRef();
                        if (firstTimeBytes.bytesEquals(thisRoundBytes)) {
                            continue;
                        }
                        StringBuilder error = new StringBuilder("Failed to round trip over ");
                        if (humanReadable) {
                            error.append("human readable ");
                        }
                        error.append(xContentType);
                        error.append("\nCanonical is:\n").append(Strings.toString(asXContent(testInstance), true, true));
                        boolean showBytes = xContentType.xContent() == CborXContent.cborXContent;
                        error.append("\nWanted : ").append(showBytes ? firstTimeBytes : firstTimeBytes.utf8ToString());
                        error.append("\nBut got: ").append(showBytes ? thisRoundBytes : thisRoundBytes.utf8ToString());
                        fail(error.toString());
                    }
                } catch (IOException e) {
                    throw new AssertionError(e);
                }
            });
        } finally {
            dispose(testInstance);
        }
    }

    protected abstract ToXContent asXContent(T instance);

    /**
     * Creates a random instance to use in the xcontent tests.
     * Override this method if the random instance that you build
     * should be aware of the {@link XContentType} used in the test.
     */
    protected abstract T createXContextTestInstance(XContentType xContentType);

    protected abstract AbstractXContentTestCase.XContentTester createXContentTester();

    /**
     * Indicates whether the parser supports unknown fields or not. In case it does, such behaviour will be tested by
     * inserting random fields before parsing and checking that they don't make parsing fail.
     */
    protected boolean supportsUnknownFields() {
        return false;
    }

    /**
     * Returns a predicate that given the field name indicates whether the field has to be excluded from random fields insertion or not
     */
    protected Predicate getRandomFieldsExcludeFilter() {
        return Predicates.never();
    }

    /**
     * Fields that have to be ignored when shuffling as part of testFromXContent
     */
    protected String[] getShuffleFieldsExceptions() {
        return Strings.EMPTY_ARRAY;
    }

    /**
     * Params that have to be provided when calling calling {@link ToXContent#toXContent(XContentBuilder, ToXContent.Params)}
     */
    protected ToXContent.Params getToXContentParams() {
        return ToXContent.EMPTY_PARAMS;
    }

    /**
     * Whether or not to assert equivalence of the {@link org.elasticsearch.xcontent.XContent} of the test instance and the instance
     * parsed from the {@link org.elasticsearch.xcontent.XContent} of the test instance.
     *
     * @return true if equivalence should be asserted, otherwise false
     */
    protected boolean assertToXContentEquivalence() {
        return true;
    }

    /**
     * @return a random date between 1970 and ca 2065
     */
    protected Date randomDate() {
        return new Date(randomLongBetween(0, 3000000000000L));
    }

    /**
     * @return a random instant between 1970 and ca 2065
     */
    protected Instant randomInstant() {
        return Instant.ofEpochSecond(randomLongBetween(0, 3000000000L), randomLongBetween(0, 999999999));
    }
}