org.apache.calcite.test

Class CalciteAssert

java.lang.Object

org.apache.calcite.test.CalciteAssert

public class CalciteAssert
extends java.lang.Object

Fluid DSL for testing Calcite connections and queries.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CalciteAssert.AddSchemaPostProcessor Adds Schema and sets it as default.
static class	CalciteAssert.AddSchemaSpecPostProcessor Adds CalciteAssert.SchemaSpec (set of schemes) to a connection.
static class	CalciteAssert.AssertMetaData Fluent interface for building a metadata query to be tested.
static class	CalciteAssert.AssertQuery Fluent interface for building a query to be tested.
static class	CalciteAssert.AssertThat Result of calling that().
static class	CalciteAssert.Config Connection configuration.
static class	CalciteAssert.ConnectionFactory Abstract implementation of connection factory whose with methods throw.
static interface	CalciteAssert.ConnectionPostProcessor Connection post processor
static class	CalciteAssert.DatabaseInstance Information necessary to create a JDBC connection.
static class	CalciteAssert.DefaultSchemaPostProcessor Sets a default schema name.
static class	CalciteAssert.SchemaSpec Specification for common test schemas.

Field Summary

Fields

Modifier and Type	Field and Description
static CalciteAssert.DatabaseInstance	DB Which database to use for tests that require a JDBC data source.
static CalciteAssert.ConnectionFactory	EMPTY_CONNECTION_FACTORY
static boolean	ENABLE_SLOW Whether to enable slow tests.

Method Summary

Modifier and Type	Method and Description
static org.apache.calcite.schema.SchemaPlus	addSchema(org.apache.calcite.schema.SchemaPlus rootSchema, CalciteAssert.SchemaSpec schema)
static void	assertArrayEqual(java.lang.String message, java.lang.Object[] expected, java.lang.Object[] actual) Asserts that two objects are equal.
static java.util.function.Consumer<java.sql.ResultSet>	checkMaskedResultContains(java.lang.String expected)
static java.util.function.Consumer<java.sql.ResultSet>	checkResultContains(java.lang.String... expected)
static java.util.function.Consumer<java.sql.ResultSet>	checkResultContains(java.lang.String expected, int count)
static java.util.function.Consumer<java.sql.ResultSet>	checkResultCount(org.hamcrest.Matcher<java.lang.Integer> expected)
static java.util.function.Consumer<java.sql.ResultSet>	checkResultType(java.lang.String expected)
static java.util.function.Consumer<java.lang.Integer>	checkUpdateCount(int expected)
static CalciteAssert.AssertThat	hr() Short-hand for CalciteAssert.that().with(Config.REGULAR).
static CalciteAssert.AssertThat	model(java.lang.String model) Short-hand for CalciteAssert.that().with(Config.EMPTY).withModel(model).
static CalciteAssert.AssertThat	that() Creates an instance of CalciteAssert with the empty configuration.
static CalciteAssert.AssertThat	that(CalciteAssert.Config config) Creates an instance of CalciteAssert with a given configuration.

Methods inherited from class java.lang.Object

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

Field Detail

DB

public static final CalciteAssert.DatabaseInstance DB

Which database to use for tests that require a JDBC data source. By default the test suite runs against the embedded hsqldb database.

We recommend that casual users use hsqldb, and frequent Calcite developers use MySQL. The test suite runs faster against the MySQL database (mainly because of the 0.1s versus 6s startup time). You have to populate MySQL manually with the foodmart data set, otherwise there will be test failures. To run against MySQL, specify '-Dcalcite.test.db=mysql' on the java command line.

ENABLE_SLOW

public static final boolean ENABLE_SLOW

Whether to enable slow tests. Default is false.

EMPTY_CONNECTION_FACTORY

public static final CalciteAssert.ConnectionFactory EMPTY_CONNECTION_FACTORY

Method Detail

that

public static CalciteAssert.AssertThat that()

Creates an instance of CalciteAssert with the empty configuration.

that

public static CalciteAssert.AssertThat that(CalciteAssert.Config config)

Creates an instance of CalciteAssert with a given configuration.

model

public static CalciteAssert.AssertThat model(java.lang.String model)

Short-hand for CalciteAssert.that().with(Config.EMPTY).withModel(model).

hr

public static CalciteAssert.AssertThat hr()

Short-hand for CalciteAssert.that().with(Config.REGULAR).

checkResultCount

public static java.util.function.Consumer<java.sql.ResultSet> checkResultCount(org.hamcrest.Matcher<java.lang.Integer> expected)

checkUpdateCount

public static java.util.function.Consumer<java.lang.Integer> checkUpdateCount(int expected)

checkResultContains

public static java.util.function.Consumer<java.sql.ResultSet> checkResultContains(java.lang.String... expected)

checkResultContains

public static java.util.function.Consumer<java.sql.ResultSet> checkResultContains(java.lang.String expected,
                                                                                  int count)

checkMaskedResultContains

public static java.util.function.Consumer<java.sql.ResultSet> checkMaskedResultContains(java.lang.String expected)

checkResultType

public static java.util.function.Consumer<java.sql.ResultSet> checkResultType(java.lang.String expected)

addSchema

public static org.apache.calcite.schema.SchemaPlus addSchema(org.apache.calcite.schema.SchemaPlus rootSchema,
                                                             CalciteAssert.SchemaSpec schema)

assertArrayEqual

public static void assertArrayEqual(java.lang.String message,
                                    java.lang.Object[] expected,
                                    java.lang.Object[] actual)

Asserts that two objects are equal. If they are not, an AssertionError is thrown with the given message. If expected and actual are null, they are considered equal.

This method produces more user-friendly error messages than Assert.assertArrayEquals(String, Object[], Object[])

Parameters:

message - the identifying message for the AssertionError (null okay)

expected - expected value

actual - actual value