flink-optimizer/src/test/java/org/apache/flink/optimizer/custompartition/GroupingKeySelectorTranslationTest.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.flink.optimizer.custompartition;

import org.apache.flink.api.common.InvalidProgramException;
import org.apache.flink.api.common.Plan;
import org.apache.flink.api.common.functions.Partitioner;
import org.apache.flink.api.common.operators.Order;
import org.apache.flink.api.java.DataSet;
import org.apache.flink.api.java.ExecutionEnvironment;
import org.apache.flink.api.java.functions.KeySelector;
import org.apache.flink.api.java.io.DiscardingOutputFormat;
import org.apache.flink.api.java.tuple.Tuple;
import org.apache.flink.api.java.tuple.Tuple2;
import org.apache.flink.api.java.tuple.Tuple3;
import org.apache.flink.optimizer.plan.OptimizedPlan;
import org.apache.flink.optimizer.plan.SingleInputPlanNode;
import org.apache.flink.optimizer.plan.SinkPlanNode;
import org.apache.flink.optimizer.testfunctions.IdentityGroupReducerCombinable;
import org.apache.flink.optimizer.testfunctions.SelectOneReducer;
import org.apache.flink.optimizer.util.CompilerTestBase;
import org.apache.flink.runtime.operators.shipping.ShipStrategyType;

import org.junit.Test;

import static org.junit.Assert.*;

@SuppressWarnings({"serial", "unchecked"})
public class GroupingKeySelectorTranslationTest extends CompilerTestBase {

    @Test
    public void testCustomPartitioningKeySelectorReduce() {
        try {
            ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment();

            DataSet<Tuple2<Integer, Integer>> data =
                    env.fromElements(new Tuple2<Integer, Integer>(0, 0))
                            .rebalance()
                            .setParallelism(4);

            data.groupBy(new TestKeySelector<Tuple2<Integer, Integer>>())
                    .withPartitioner(new TestPartitionerInt())
                    .reduce(new SelectOneReducer<Tuple2<Integer, Integer>>())
                    .output(new DiscardingOutputFormat<Tuple2<Integer, Integer>>());

            Plan p = env.createProgramPlan();
            OptimizedPlan op = compileNoStats(p);

            SinkPlanNode sink = op.getDataSinks().iterator().next();
            SingleInputPlanNode keyRemovingMapper =
                    (SingleInputPlanNode) sink.getInput().getSource();
            SingleInputPlanNode reducer =
                    (SingleInputPlanNode) keyRemovingMapper.getInput().getSource();
            SingleInputPlanNode combiner = (SingleInputPlanNode) reducer.getInput().getSource();

            assertEquals(ShipStrategyType.FORWARD, sink.getInput().getShipStrategy());
            assertEquals(ShipStrategyType.FORWARD, keyRemovingMapper.getInput().getShipStrategy());
            assertEquals(ShipStrategyType.PARTITION_CUSTOM, reducer.getInput().getShipStrategy());
            assertEquals(ShipStrategyType.FORWARD, combiner.getInput().getShipStrategy());
        } catch (Exception e) {
            e.printStackTrace();
            fail(e.getMessage());
        }
    }

    @Test
    public void testCustomPartitioningKeySelectorGroupReduce() {
        try {
            ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment();

            DataSet<Tuple2<Integer, Integer>> data =
                    env.fromElements(new Tuple2<Integer, Integer>(0, 0))
                            .rebalance()
                            .setParallelism(4);

            data.groupBy(new TestKeySelector<Tuple2<Integer, Integer>>())
                    .withPartitioner(new TestPartitionerInt())
                    .reduceGroup(new IdentityGroupReducerCombinable<Tuple2<Integer, Integer>>())
                    .output(new DiscardingOutputFormat<Tuple2<Integer, Integer>>());

            Plan p = env.createProgramPlan();
            OptimizedPlan op = compileNoStats(p);

            SinkPlanNode sink = op.getDataSinks().iterator().next();
            SingleInputPlanNode reducer = (SingleInputPlanNode) sink.getInput().getSource();
            SingleInputPlanNode combiner = (SingleInputPlanNode) reducer.getInput().getSource();

            assertEquals(ShipStrategyType.FORWARD, sink.getInput().getShipStrategy());
            assertEquals(ShipStrategyType.PARTITION_CUSTOM, reducer.getInput().getShipStrategy());
            assertEquals(ShipStrategyType.FORWARD, combiner.getInput().getShipStrategy());
        } catch (Exception e) {
            e.printStackTrace();
            fail(e.getMessage());
        }
    }

    @Test
    public void testCustomPartitioningKeySelectorGroupReduceSorted() {
        try {
            ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment();

            DataSet<Tuple3<Integer, Integer, Integer>> data =
                    env.fromElements(new Tuple3<Integer, Integer, Integer>(0, 0, 0))
                            .rebalance()
                            .setParallelism(4);

            data.groupBy(new TestKeySelector<Tuple3<Integer, Integer, Integer>>())
                    .withPartitioner(new TestPartitionerInt())
                    .sortGroup(
                            new TestKeySelector<Tuple3<Integer, Integer, Integer>>(),
                            Order.ASCENDING)
                    .reduceGroup(
                            new IdentityGroupReducerCombinable<Tuple3<Integer, Integer, Integer>>())
                    .output(new DiscardingOutputFormat<Tuple3<Integer, Integer, Integer>>());

            Plan p = env.createProgramPlan();
            OptimizedPlan op = compileNoStats(p);

            SinkPlanNode sink = op.getDataSinks().iterator().next();
            SingleInputPlanNode reducer = (SingleInputPlanNode) sink.getInput().getSource();
            SingleInputPlanNode combiner = (SingleInputPlanNode) reducer.getInput().getSource();

            assertEquals(ShipStrategyType.FORWARD, sink.getInput().getShipStrategy());
            assertEquals(ShipStrategyType.PARTITION_CUSTOM, reducer.getInput().getShipStrategy());
            assertEquals(ShipStrategyType.FORWARD, combiner.getInput().getShipStrategy());
        } catch (Exception e) {
            e.printStackTrace();
            fail(e.getMessage());
        }
    }

    @Test
    public void testCustomPartitioningKeySelectorInvalidType() {
        try {
            ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment();

            DataSet<Tuple2<Integer, Integer>> data =
                    env.fromElements(new Tuple2<Integer, Integer>(0, 0))
                            .rebalance()
                            .setParallelism(4);

            try {
                data.groupBy(new TestKeySelector<Tuple2<Integer, Integer>>())
                        .withPartitioner(new TestPartitionerLong());
                fail("Should throw an exception");
            } catch (InvalidProgramException e) {
            }
        } catch (Exception e) {
            e.printStackTrace();
            fail(e.getMessage());
        }
    }

    @Test
    public void testCustomPartitioningKeySelectorInvalidTypeSorted() {
        try {
            ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment();

            DataSet<Tuple3<Integer, Integer, Integer>> data =
                    env.fromElements(new Tuple3<Integer, Integer, Integer>(0, 0, 0))
                            .rebalance()
                            .setParallelism(4);

            try {
                data.groupBy(new TestKeySelector<Tuple3<Integer, Integer, Integer>>())
                        .sortGroup(1, Order.ASCENDING)
                        .withPartitioner(new TestPartitionerLong());
                fail("Should throw an exception");
            } catch (InvalidProgramException e) {
            }
        } catch (Exception e) {
            e.printStackTrace();
            fail(e.getMessage());
        }
    }

    @Test
    public void testCustomPartitioningTupleRejectCompositeKey() {
        try {
            ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment();

            DataSet<Tuple3<Integer, Integer, Integer>> data =
                    env.fromElements(new Tuple3<Integer, Integer, Integer>(0, 0, 0))
                            .rebalance()
                            .setParallelism(4);

            try {
                data.groupBy(new TestBinaryKeySelector<Tuple3<Integer, Integer, Integer>>())
                        .withPartitioner(new TestPartitionerInt());
                fail("Should throw an exception");
            } catch (InvalidProgramException e) {
            }
        } catch (Exception e) {
            e.printStackTrace();
            fail(e.getMessage());
        }
    }

    // --------------------------------------------------------------------------------------------

    private static class TestPartitionerInt implements Partitioner<Integer> {
        @Override
        public int partition(Integer key, int numPartitions) {
            return 0;
        }
    }

    private static class TestPartitionerLong implements Partitioner<Long> {
        @Override
        public int partition(Long key, int numPartitions) {
            return 0;
        }
    }

    private static class TestKeySelector<T extends Tuple> implements KeySelector<T, Integer> {
        @Override
        public Integer getKey(T value) {
            return value.getField(0);
        }
    }

    private static class TestBinaryKeySelector<T extends Tuple>
            implements KeySelector<T, Tuple2<Integer, Integer>> {
        @Override
        public Tuple2<Integer, Integer> getKey(T value) {
            return new Tuple2<Integer, Integer>(
                    value.<Integer>getField(0), value.<Integer>getField(1));
        }
    }
}