org.elasticsearch.test.AbstractChunkedSerializingTestCase 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
There is a newer version: 9.0.2
/*
 * 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", the "GNU Affero General Public License v3.0 only", 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", the "GNU Affero General Public
 * License v3.0 only", or the "Server Side Public License, v 1".
 */

package org.elasticsearch.test;

import org.elasticsearch.common.io.stream.Writeable;
import org.elasticsearch.common.xcontent.ChunkedToXContent;
import org.elasticsearch.xcontent.ToXContent;
import org.elasticsearch.xcontent.XContentParser;
import org.elasticsearch.xcontent.XContentType;

import java.io.IOException;
import java.util.function.ToIntFunction;

import static org.elasticsearch.test.AbstractXContentTestCase.chunkedXContentTester;
import static org.elasticsearch.xcontent.ToXContent.EMPTY_PARAMS;
import static org.elasticsearch.xcontent.XContentFactory.jsonBuilder;

public abstract class AbstractChunkedSerializingTestCase extends AbstractSerializationTestCase {

    @Override
    protected AbstractXContentTestCase.XContentTester createXContentTester() {
        return chunkedXContentTester(this::createParser, this::createXContextTestInstance, getToXContentParams(), this::doParseInstance);
    }

    @Override
    protected ToXContent asXContent(T instance) {
        return ChunkedToXContent.wrapAsToXContent(instance);
    }

    @Override
    protected T createXContextTestInstance(XContentType xContentType) {
        return createTestInstance();
    }

    /**
     * Parses to a new instance using the provided {@link XContentParser}
     */
    protected abstract T doParseInstance(XContentParser parser) throws IOException;

    public static  void assertChunkCount(T instance, ToIntFunction expectedChunkCount) {
        assertChunkCount(instance, EMPTY_PARAMS, expectedChunkCount);
    }

    public static  void assertChunkCount(
        T instance,
        ToXContent.Params params,
        ToIntFunction expectedChunkCount
    ) {
        int chunkCount = 0;
        try (var builder = jsonBuilder()) {
            if (instance.isFragment()) {
                builder.startObject();
            }
            final var iterator = instance.toXContentChunked(params);
            while (iterator.hasNext()) {
                iterator.next().toXContent(builder, params);
                chunkCount += 1;
            }
            if (instance.isFragment()) {
                builder.endObject();
            }
        } catch (IOException e) {
            fail(e);
        } // closing the builder verifies that the XContent is well-formed
        assertEquals(expectedChunkCount.applyAsInt(instance), chunkCount);
    }
}