RuleTester.java

/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.facebook.presto.sql.planner.iterative.rule.test;

import com.facebook.presto.Session;
import com.facebook.presto.metadata.Metadata;
import com.facebook.presto.metadata.SessionPropertyManager;
import com.facebook.presto.spi.ColumnHandle;
import com.facebook.presto.spi.ConnectorId;
import com.facebook.presto.spi.Plugin;
import com.facebook.presto.spi.TableHandle;
import com.facebook.presto.spi.connector.ConnectorFactory;
import com.facebook.presto.spi.constraints.TableConstraint;
import com.facebook.presto.spi.plan.LogicalPropertiesProvider;
import com.facebook.presto.spi.security.AccessControl;
import com.facebook.presto.split.PageSourceManager;
import com.facebook.presto.split.SplitManager;
import com.facebook.presto.sql.expressions.ExpressionOptimizerManager;
import com.facebook.presto.sql.parser.SqlParser;
import com.facebook.presto.sql.planner.RuleStatsRecorder;
import com.facebook.presto.sql.planner.assertions.OptimizerAssert;
import com.facebook.presto.sql.planner.iterative.IterativeOptimizer;
import com.facebook.presto.sql.planner.iterative.Rule;
import com.facebook.presto.sql.planner.optimizations.PlanOptimizer;
import com.facebook.presto.testing.LocalQueryRunner;
import com.facebook.presto.tpch.TpchConnectorFactory;
import com.facebook.presto.transaction.TransactionManager;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;

import java.io.Closeable;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;

import static com.facebook.presto.metadata.SessionPropertyManager.createTestingSessionPropertyManager;
import static com.facebook.presto.testing.TestingSession.testSessionBuilder;
import static java.util.Collections.emptyList;

public class RuleTester
        implements Closeable
{
    public static final String CATALOG_ID = "local";
    public static final ConnectorId CONNECTOR_ID = new ConnectorId(CATALOG_ID);

    private final Metadata metadata;
    private final Session session;
    private final LocalQueryRunner queryRunner;
    private final TransactionManager transactionManager;
    private final SplitManager splitManager;
    private final PageSourceManager pageSourceManager;
    private final AccessControl accessControl;
    private final SqlParser sqlParser;
    private ExpressionOptimizerManager expressionOptimizerManager;

    public RuleTester()
    {
        this(emptyList());
    }

    public RuleTester(List<Plugin> plugins)
    {
        this(plugins, ImmutableMap.of());
    }

    public RuleTester(List<Plugin> plugins, Map<String, String> sessionProperties)
    {
        this(plugins, sessionProperties, Optional.empty());
    }

    public RuleTester(List<Plugin> plugins, Map<String, String> sessionProperties, Optional<Integer> nodeCountForStats)
    {
        this(plugins, sessionProperties, nodeCountForStats, new TpchConnectorFactory(1));
    }

    public RuleTester(List<Plugin> plugins, Map<String, String> sessionProperties, Optional<Integer> nodeCountForStats, ConnectorFactory connectorFactory)
    {
        this(plugins, sessionProperties, createTestingSessionPropertyManager(), nodeCountForStats, connectorFactory);
    }

    public RuleTester(List<Plugin> plugins, Map<String, String> sessionProperties, SessionPropertyManager sessionPropertyManager, Optional<Integer> nodeCountForStats, ConnectorFactory connectorFactory)
    {
        this(plugins, getSession(sessionProperties, sessionPropertyManager), nodeCountForStats, connectorFactory);
    }

    public RuleTester(List<Plugin> plugins, Session session, Optional<Integer> nodeCountForStats, ConnectorFactory connectorFactory)
    {
        this(plugins,
                session,
                nodeCountForStats.map(nodeCount -> LocalQueryRunner.queryRunnerWithFakeNodeCountForStats(session, nodeCount))
                        .orElseGet(() -> new LocalQueryRunner(session)),
                connectorFactory);
    }

    public RuleTester(List<Plugin> plugins, Session session, LocalQueryRunner preCreatedRunner, ConnectorFactory connectorFactory)
    {
        this.session = session;
        queryRunner = preCreatedRunner;

        queryRunner.createCatalog(session.getCatalog().get(),
                connectorFactory,
                ImmutableMap.of());
        plugins.stream().forEach(queryRunner::installPlugin);
        expressionOptimizerManager = queryRunner.getExpressionManager();

        this.metadata = queryRunner.getMetadata();
        this.transactionManager = queryRunner.getTransactionManager();
        this.splitManager = queryRunner.getSplitManager();
        this.pageSourceManager = queryRunner.getPageSourceManager();
        this.accessControl = queryRunner.getAccessControl();
        this.sqlParser = queryRunner.getSqlParser();
    }

    public static Session getSession(Map<String, String> sessionProperties, SessionPropertyManager sessionPropertyManager)
    {
        Session.SessionBuilder sessionBuilder = testSessionBuilder(sessionPropertyManager)
                .setCatalog(CATALOG_ID)
                .setSchema("tiny")
                .setSystemProperty("task_concurrency", "1"); // these tests don't handle exchanges from local parallel

        for (Map.Entry<String, String> entry : sessionProperties.entrySet()) {
            sessionBuilder.setSystemProperty(entry.getKey(), entry.getValue());
        }

        return sessionBuilder.build();
    }

    public RuleAssert assertThat(Rule rule)
    {
        return new RuleAssert(metadata, queryRunner.getStatsCalculator(), queryRunner.getEstimatedExchangesCostCalculator(), session, rule, transactionManager, accessControl);
    }

    public RuleAssert assertThat(Rule rule, LogicalPropertiesProvider logicalPropertiesProvider)
    {
        return new RuleAssert(metadata, queryRunner.getStatsCalculator(), queryRunner.getEstimatedExchangesCostCalculator(), session, rule, transactionManager, accessControl, Optional.of(logicalPropertiesProvider), ImmutableList.of());
    }

    public RuleAssert assertThat(Rule rule, List<String> extraCatalogs)
    {
        return new RuleAssert(metadata, queryRunner.getStatsCalculator(), queryRunner.getEstimatedExchangesCostCalculator(), session, rule, transactionManager, accessControl, Optional.empty(), extraCatalogs);
    }

    public OptimizerAssert assertThat(Set<Rule<?>> rules)
    {
        PlanOptimizer optimizer = new IterativeOptimizer(
                getMetadata(),
                new RuleStatsRecorder(),
                queryRunner.getStatsCalculator(),
                queryRunner.getCostCalculator(),
                rules);
        return new OptimizerAssert(metadata, queryRunner, queryRunner.getStatsCalculator(), session, optimizer, transactionManager, accessControl);
    }

    public OptimizerAssert assertThat(Set<Rule<?>> rules, LogicalPropertiesProvider logicalPropertiesProvider)
    {
        PlanOptimizer optimizer = new IterativeOptimizer(
                getMetadata(),
                new RuleStatsRecorder(),
                queryRunner.getStatsCalculator(),
                queryRunner.getCostCalculator(),
                Optional.of(logicalPropertiesProvider),
                rules);
        return new OptimizerAssert(metadata, queryRunner, queryRunner.getStatsCalculator(), session, optimizer, transactionManager, accessControl);
    }

    public OptimizerAssert assertThat(PlanOptimizer optimizer)
    {
        return new OptimizerAssert(metadata, queryRunner, queryRunner.getStatsCalculator(), session, optimizer, transactionManager, accessControl);
    }

    @Override
    public void close()
    {
        queryRunner.close();
    }

    public Metadata getMetadata()
    {
        return metadata;
    }

    public Session getSession()
    {
        return session;
    }

    public SplitManager getSplitManager()
    {
        return splitManager;
    }

    public PageSourceManager getPageSourceManager()
    {
        return pageSourceManager;
    }

    public SqlParser getSqlParser()
    {
        return sqlParser;
    }

    public ConnectorId getCurrentConnectorId()
    {
        return queryRunner.inTransaction(transactionSession -> metadata.getCatalogHandle(transactionSession, session.getCatalog().get())).get();
    }

    public List<TableConstraint<ColumnHandle>> getTableConstraints(TableHandle tableHandle)
    {
        return queryRunner.inTransaction(transactionSession -> {
            metadata.getCatalogHandle(transactionSession, session.getCatalog().get());
            return metadata.getTableMetadata(transactionSession, tableHandle).getMetadata().getTableConstraintsHolder().getTableConstraintsWithColumnHandles();
        });
    }

    public ExpressionOptimizerManager getExpressionManager()
    {
        return expressionOptimizerManager;
    }
}