Package org.elasticsearch.index.mapper

Class BlockLoaderTestRunner

java.lang.Object

org.elasticsearch.index.mapper.BlockLoaderTestRunner

public class BlockLoaderTestRunner
extends Object

Test helper for BlockLoader. Run it like:

  BlockLoaderTestRunner runner = new BlockLoaderTestRunner(params);
  runner.mapperService(createMapperService...);
  runner.fieldName("field").document(Map.of("field", 1));
  runner.run(1);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BlockLoaderTestRunner.ResultMatcher

Constructor Summary

Constructors

Constructor	Description
BlockLoaderTestRunner(BlockLoaderTestCase.Params params)

Method Summary

Modifier and Type	Method	Description
BlockLoaderTestRunner	allowDummyDocs()	Allow dummy documents in test index.
BlockLoaderTestRunner	breaker(CircuitBreaker breaker)	Set the CircuitBreaker used for the test.
ParsedDocument	document()	The document being parsed.
void	document(Map<String,Object> doc)	Set the document to be parsed.
void	document(ParsedDocument doc)	Set the document to be parsed.
String	fieldName()	The name of the field to load.
BlockLoaderTestRunner	fieldName(String fieldName)	Set the name of the field to load.
Map<String,Object>	mapDoc()	The document to be parsed as a Map.
BlockLoaderTestRunner	mapperService(MapperService mapperService)	Set the MapperService to use for the test.
BlockLoaderTestRunner	matcher(BlockLoaderTestRunner.ResultMatcher matcher)	Configuration a non-standard matcher.
void	run(Object expected)	Run the test and compare to expected.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BlockLoaderTestRunner

public BlockLoaderTestRunner(BlockLoaderTestCase.Params params)

Method Details

allowDummyDocs

public BlockLoaderTestRunner allowDummyDocs()

Allow dummy documents in test index. This defaults to false but many callers are fine with these and call this.

mapperService

public BlockLoaderTestRunner mapperService(MapperService mapperService)

Set the MapperService to use for the test. This must be provided before calling run(java.lang.Object).

breaker

public BlockLoaderTestRunner breaker(CircuitBreaker breaker)

Set the CircuitBreaker used for the test. This must be provided before calling run(java.lang.Object).

fieldName

public String fieldName()

The name of the field to load. The test sends this to MapperService.fieldType(java.lang.String).

fieldName

public BlockLoaderTestRunner fieldName(String fieldName)

Set the name of the field to load. The test sends this to MapperService.fieldType(java.lang.String). This is required before calling run(java.lang.Object)

matcher

public BlockLoaderTestRunner matcher(BlockLoaderTestRunner.ResultMatcher matcher)

Configuration a non-standard matcher. The default matcher is usually fine, and you often don't have to call this.

document

public ParsedDocument document()

The document being parsed.

mapDoc

public Map<String,Object> mapDoc()

The document to be parsed as a Map. This will only work if the document was set with document(Map).

document

public void document(Map<String,Object> doc)
              throws IOException

Set the document to be parsed. A method with this name must be called before calling run(java.lang.Object).

Throws:

IOException

document

public void document(ParsedDocument doc)
              throws IOException

Set the document to be parsed. A method with this name must be called before calling run(java.lang.Object).

Throws:

IOException

run

public void run(Object expected)
         throws IOException

Run the test and compare to expected.

Throws:

IOException