/*
 * 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.test.operators;

import org.apache.flink.api.common.functions.CrossFunction;
import org.apache.flink.api.common.functions.RichCrossFunction;
import org.apache.flink.api.java.DataSet;
import org.apache.flink.api.java.ExecutionEnvironment;
import org.apache.flink.api.java.tuple.Tuple2;
import org.apache.flink.api.java.tuple.Tuple3;
import org.apache.flink.api.java.tuple.Tuple5;
import org.apache.flink.api.java.tuple.Tuple6;
import org.apache.flink.configuration.Configuration;
import org.apache.flink.test.operators.util.CollectionDataSets;
import org.apache.flink.test.operators.util.CollectionDataSets.CustomType;
import org.apache.flink.test.util.MultipleProgramsTestBase;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;

import java.util.Collection;
import java.util.List;

/**
 * Integration tests for {@link CrossFunction} and {@link RichCrossFunction}.
 */
@RunWith(Parameterized.class)
public class CrossITCase extends MultipleProgramsTestBase {

	public CrossITCase(TestExecutionMode mode){
		super(mode);
	}

	@Test
	public void testCorretnessOfCrossOnTwoTupleInputs() throws Exception {
		/*
		 * check correctness of cross on two tuple inputs
		 */

		final ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment();

		DataSet<Tuple5<Integer, Long, Integer, String, Long>> ds = CollectionDataSets.getSmall5TupleDataSet(env);
		DataSet<Tuple5<Integer, Long, Integer, String, Long>> ds2 = CollectionDataSets.getSmall5TupleDataSet(env);
		DataSet<Tuple2<Integer, String>> crossDs = ds.cross(ds2).with(new Tuple5Cross());

		List<Tuple2<Integer, String>> result = crossDs.collect();

		String expected = "0,HalloHallo\n" +
				"1,HalloHallo Welt\n" +
				"2,HalloHallo Welt wie\n" +
				"1,Hallo WeltHallo\n" +
				"2,Hallo WeltHallo Welt\n" +
				"3,Hallo WeltHallo Welt wie\n" +
				"2,Hallo Welt wieHallo\n" +
				"3,Hallo Welt wieHallo Welt\n" +
				"4,Hallo Welt wieHallo Welt wie\n";

		compareResultAsTuples(result, expected);
	}

	@Test
	public void testCorrectnessOfCrossIfUDFReturnsLeftInputObject() throws Exception {
		/*
		 * check correctness of cross if UDF returns left input object
		 */

		final ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment();

		DataSet<Tuple3<Integer, Long, String>> ds = CollectionDataSets.getSmall3TupleDataSet(env);
		DataSet<Tuple5<Integer, Long, Integer, String, Long>> ds2 = CollectionDataSets.getSmall5TupleDataSet(env);
		DataSet<Tuple3<Integer, Long, String>> crossDs = ds.cross(ds2).with(new Tuple3ReturnLeft());

		List<Tuple3<Integer, Long, String>> result = crossDs.collect();

		String expected = "1,1,Hi\n" +
				"1,1,Hi\n" +
				"1,1,Hi\n" +
				"2,2,Hello\n" +
				"2,2,Hello\n" +
				"2,2,Hello\n" +
				"3,2,Hello world\n" +
				"3,2,Hello world\n" +
				"3,2,Hello world\n";

		compareResultAsTuples(result, expected);
	}

	@Test
	public void testCorrectnessOfCrossIfUDFReturnsRightInputObject() throws Exception {
		/*
		 * check correctness of cross if UDF returns right input object
		 */

		final ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment();

		DataSet<Tuple3<Integer, Long, String>> ds = CollectionDataSets.getSmall3TupleDataSet(env);
		DataSet<Tuple5<Integer, Long, Integer, String, Long>> ds2 = CollectionDataSets.getSmall5TupleDataSet(env);
		DataSet<Tuple5<Integer, Long, Integer, String, Long>> crossDs = ds.cross(ds2).with(new Tuple5ReturnRight());

		List<Tuple5<Integer, Long, Integer, String, Long>> result = crossDs
				.collect();

		String expected = "1,1,0,Hallo,1\n" +
				"1,1,0,Hallo,1\n" +
				"1,1,0,Hallo,1\n" +
				"2,2,1,Hallo Welt,2\n" +
				"2,2,1,Hallo Welt,2\n" +
				"2,2,1,Hallo Welt,2\n" +
				"2,3,2,Hallo Welt wie,1\n" +
				"2,3,2,Hallo Welt wie,1\n" +
				"2,3,2,Hallo Welt wie,1\n";

		compareResultAsTuples(result, expected);
	}

	@Test
	public void testCorrectnessOfCrossWithBroadcastSet() throws Exception {
		/*
		 * check correctness of cross with broadcast set
		 */

		final ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment();

		DataSet<Integer> intDs = CollectionDataSets.getIntegerDataSet(env);

		DataSet<Tuple5<Integer, Long, Integer, String, Long>> ds = CollectionDataSets.getSmall5TupleDataSet(env);
		DataSet<Tuple5<Integer, Long, Integer, String, Long>> ds2 = CollectionDataSets.getSmall5TupleDataSet(env);
		DataSet<Tuple3<Integer, Integer, Integer>> crossDs = ds.cross(ds2).with(new Tuple5CrossBC()).withBroadcastSet(intDs, "ints");

		List<Tuple3<Integer, Integer, Integer>> result = crossDs.collect();

		String expected = "2,0,55\n" +
				"3,0,55\n" +
				"3,0,55\n" +
				"3,0,55\n" +
				"4,1,55\n" +
				"4,2,55\n" +
				"3,0,55\n" +
				"4,2,55\n" +
				"4,4,55\n";

		compareResultAsTuples(result, expected);
	}

	@Test
	public void testCorrectnessOfCrossWithHuge() throws Exception {
		/*
		 * check correctness of crossWithHuge (only correctness of result -> should be the same as with normal cross)
		 */

		final ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment();

		DataSet<Tuple5<Integer, Long, Integer, String, Long>> ds = CollectionDataSets.getSmall5TupleDataSet(env);
		DataSet<Tuple5<Integer, Long, Integer, String, Long>> ds2 = CollectionDataSets.getSmall5TupleDataSet(env);
		DataSet<Tuple2<Integer, String>> crossDs = ds.crossWithHuge(ds2).with(new Tuple5Cross());

		List<Tuple2<Integer, String>> result = crossDs.collect();

		String expected = "0,HalloHallo\n" +
				"1,HalloHallo Welt\n" +
				"2,HalloHallo Welt wie\n" +
				"1,Hallo WeltHallo\n" +
				"2,Hallo WeltHallo Welt\n" +
				"3,Hallo WeltHallo Welt wie\n" +
				"2,Hallo Welt wieHallo\n" +
				"3,Hallo Welt wieHallo Welt\n" +
				"4,Hallo Welt wieHallo Welt wie\n";

		compareResultAsTuples(result, expected);
	}

	@Test
	public void testCorrectnessOfCrossWithTiny() throws Exception {
		/*
		 * check correctness of crossWithTiny (only correctness of result -> should be the same as with normal cross)
		 */

		final ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment();

		DataSet<Tuple5<Integer, Long, Integer, String, Long>> ds = CollectionDataSets.getSmall5TupleDataSet(env);
		DataSet<Tuple5<Integer, Long, Integer, String, Long>> ds2 = CollectionDataSets.getSmall5TupleDataSet(env);
		DataSet<Tuple2<Integer, String>> crossDs = ds.crossWithTiny(ds2).with(new Tuple5Cross());

		List<Tuple2<Integer, String>> result = crossDs.collect();

		String expected = "0,HalloHallo\n" +
				"1,HalloHallo Welt\n" +
				"2,HalloHallo Welt wie\n" +
				"1,Hallo WeltHallo\n" +
				"2,Hallo WeltHallo Welt\n" +
				"3,Hallo WeltHallo Welt wie\n" +
				"2,Hallo Welt wieHallo\n" +
				"3,Hallo Welt wieHallo Welt\n" +
				"4,Hallo Welt wieHallo Welt wie\n";

		compareResultAsTuples(result, expected);
	}

	@Test
	public void testProjectCrossOnATupleInput1() throws Exception{
		/*
		 * project cross on a tuple input 1
		 */

		final ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment();

		DataSet<Tuple3<Integer, Long, String>> ds = CollectionDataSets.getSmall3TupleDataSet(env);
		DataSet<Tuple5<Integer, Long, Integer, String, Long>> ds2 = CollectionDataSets.getSmall5TupleDataSet(env);
		DataSet<Tuple6<String, Long, String, Integer, Long, Long>> crossDs = ds.cross(ds2)
				.projectFirst(2, 1)
				.projectSecond(3)
				.projectFirst(0)
				.projectSecond(4, 1);

		List<Tuple6<String, Long, String, Integer, Long, Long>> result = crossDs.collect();

		String expected = "Hi,1,Hallo,1,1,1\n" +
				"Hi,1,Hallo Welt,1,2,2\n" +
				"Hi,1,Hallo Welt wie,1,1,3\n" +
				"Hello,2,Hallo,2,1,1\n" +
				"Hello,2,Hallo Welt,2,2,2\n" +
				"Hello,2,Hallo Welt wie,2,1,3\n" +
				"Hello world,2,Hallo,3,1,1\n" +
				"Hello world,2,Hallo Welt,3,2,2\n" +
				"Hello world,2,Hallo Welt wie,3,1,3\n";

		compareResultAsTuples(result, expected);
	}

	@Test
	public void testProjectCrossOnATupleInput2() throws Exception {
		/*
		 * project cross on a tuple input 2
		 */

		final ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment();

		DataSet<Tuple3<Integer, Long, String>> ds = CollectionDataSets.getSmall3TupleDataSet(env);
		DataSet<Tuple5<Integer, Long, Integer, String, Long>> ds2 = CollectionDataSets.getSmall5TupleDataSet(env);
		DataSet<Tuple6<String, String, Long, Long, Long, Integer>> crossDs = ds.cross(ds2)
				.projectSecond(3)
				.projectFirst(2, 1)
				.projectSecond(4, 1)
				.projectFirst(0);

		List<Tuple6<String, String, Long, Long, Long, Integer>> result = crossDs.collect();

		String expected = "Hallo,Hi,1,1,1,1\n" +
				"Hallo Welt,Hi,1,2,2,1\n" +
				"Hallo Welt wie,Hi,1,1,3,1\n" +
				"Hallo,Hello,2,1,1,2\n" +
				"Hallo Welt,Hello,2,2,2,2\n" +
				"Hallo Welt wie,Hello,2,1,3,2\n" +
				"Hallo,Hello world,2,1,1,3\n" +
				"Hallo Welt,Hello world,2,2,2,3\n" +
				"Hallo Welt wie,Hello world,2,1,3,3\n";

		compareResultAsTuples(result, expected);
	}

	@Test
	public void testCorrectnessOfDefaultCross() throws Exception {
		/*
		 * check correctness of default cross
		 */

		final ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment();

		DataSet<Tuple3<Integer, Long, String>> ds = CollectionDataSets.getSmall3TupleDataSet(env);
		DataSet<Tuple5<Integer, Long, Integer, String, Long>> ds2 = CollectionDataSets.getSmall5TupleDataSet(env);
		DataSet<Tuple2<Tuple3<Integer, Long, String>, Tuple5<Integer, Long, Integer, String, Long>>> crossDs = ds.cross(ds2);

		List<Tuple2<Tuple3<Integer, Long, String>, Tuple5<Integer, Long, Integer, String, Long>>> result = crossDs.collect();

		String expected = "(1,1,Hi),(2,2,1,Hallo Welt,2)\n"
				+
				"(1,1,Hi),(1,1,0,Hallo,1)\n" +
				"(1,1,Hi),(2,3,2,Hallo Welt wie,1)\n" +
				"(2,2,Hello),(2,2,1,Hallo Welt,2)\n" +
				"(2,2,Hello),(1,1,0,Hallo,1)\n" +
				"(2,2,Hello),(2,3,2,Hallo Welt wie,1)\n" +
				"(3,2,Hello world),(2,2,1,Hallo Welt,2)\n" +
				"(3,2,Hello world),(1,1,0,Hallo,1)\n" +
				"(3,2,Hello world),(2,3,2,Hallo Welt wie,1)\n";

		compareResultAsTuples(result, expected);
	}

	@Test
	public void testCorrectnessOfCrossOnTwoCustomTypeInputs() throws Exception {
		/*
		 * check correctness of cross on two custom type inputs
		 */

		final ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment();

		DataSet<CustomType> ds = CollectionDataSets.getSmallCustomTypeDataSet(env);
		DataSet<CustomType> ds2 = CollectionDataSets.getSmallCustomTypeDataSet(env);
		DataSet<CustomType> crossDs = ds.cross(ds2).with(new CustomTypeCross());

		List<CustomType> result = crossDs.collect();

		String expected = "1,0,HiHi\n"
				+ "2,1,HiHello\n"
				+ "2,2,HiHello world\n"
				+ "2,1,HelloHi\n"
				+ "4,2,HelloHello\n"
				+ "4,3,HelloHello world\n"
				+ "2,2,Hello worldHi\n"
				+ "4,3,Hello worldHello\n"
				+ "4,4,Hello worldHello world";

		compareResultAsText(result, expected);
	}

	@Test
	public void testCorrectnessOfCrossATupleInputAndACustomTypeInput() throws Exception {
		/*
		 * check correctness of cross a tuple input and a custom type input
		 */

		final ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment();

		DataSet<Tuple5<Integer, Long, Integer, String, Long>> ds = CollectionDataSets.getSmall5TupleDataSet(env);
		DataSet<CustomType> ds2 = CollectionDataSets.getSmallCustomTypeDataSet(env);
		DataSet<Tuple3<Integer, Long, String>> crossDs = ds.cross(ds2).with(new MixedCross());

		List<Tuple3<Integer, Long, String>> result = crossDs.collect();

		String expected = "2,0,HalloHi\n" +
				"3,0,HalloHello\n" +
				"3,0,HalloHello world\n" +
				"3,0,Hallo WeltHi\n" +
				"4,1,Hallo WeltHello\n" +
				"4,2,Hallo WeltHello world\n" +
				"3,0,Hallo Welt wieHi\n" +
				"4,2,Hallo Welt wieHello\n" +
				"4,4,Hallo Welt wieHello world\n";

		compareResultAsTuples(result, expected);
	}

	private static class Tuple5Cross implements CrossFunction<Tuple5<Integer, Long, Integer, String, Long>, Tuple5<Integer, Long, Integer, String, Long>, Tuple2<Integer, String>> {

		private static final long serialVersionUID = 1L;

		@Override
		public Tuple2<Integer, String> cross(
				Tuple5<Integer, Long, Integer, String, Long> first,
				Tuple5<Integer, Long, Integer, String, Long> second)
				throws Exception {

				return new Tuple2<Integer, String>(first.f2 + second.f2, first.f3 + second.f3);
		}

	}

	private static class CustomTypeCross implements CrossFunction<CustomType, CustomType, CustomType> {

		private static final long serialVersionUID = 1L;

		@Override
		public CustomType cross(CustomType first, CustomType second)
				throws Exception {

			return new CustomType(first.myInt * second.myInt, first.myLong + second.myLong, first.myString + second.myString);
		}

	}

	private static class MixedCross implements CrossFunction<Tuple5<Integer, Long, Integer, String, Long>, CustomType, Tuple3<Integer, Long, String>> {

		private static final long serialVersionUID = 1L;

		@Override
		public Tuple3<Integer, Long, String> cross(
				Tuple5<Integer, Long, Integer, String, Long> first,
				CustomType second) throws Exception {

			return new Tuple3<Integer, Long, String>(first.f0 + second.myInt, first.f2 * second.myLong, first.f3 + second.myString);
		}

	}

	private static class Tuple3ReturnLeft implements CrossFunction<Tuple3<Integer, Long, String>, Tuple5<Integer, Long, Integer, String, Long>, Tuple3<Integer, Long, String>> {

		private static final long serialVersionUID = 1L;

		@Override
		public Tuple3<Integer, Long, String> cross(
				Tuple3<Integer, Long, String> first,
				Tuple5<Integer, Long, Integer, String, Long> second) throws Exception {

			return first;
		}
	}

	private static class Tuple5ReturnRight implements CrossFunction<Tuple3<Integer, Long, String>, Tuple5<Integer, Long, Integer, String, Long>, Tuple5<Integer, Long, Integer, String, Long>> {

		private static final long serialVersionUID = 1L;

		@Override
		public Tuple5<Integer, Long, Integer, String, Long> cross(
				Tuple3<Integer, Long, String> first,
				Tuple5<Integer, Long, Integer, String, Long> second)
				throws Exception {

			return second;
		}

	}

	private static class Tuple5CrossBC extends RichCrossFunction<Tuple5<Integer, Long, Integer, String, Long>, Tuple5<Integer, Long, Integer, String, Long>, Tuple3<Integer, Integer, Integer>> {

		private static final long serialVersionUID = 1L;

		private int broadcast = 42;

		@Override
		public void open(Configuration config) {

			Collection<Integer> ints = this.getRuntimeContext().getBroadcastVariable("ints");
			int sum = 0;
			for (Integer i : ints) {
				sum += i;
			}
			broadcast = sum;

		}

		@Override
		public Tuple3<Integer, Integer, Integer> cross(
				Tuple5<Integer, Long, Integer, String, Long> first,
				Tuple5<Integer, Long, Integer, String, Long> second)
				throws Exception {

			return new Tuple3<Integer, Integer, Integer>(first.f0 + second.f0, first.f2 * second.f2, broadcast);
		}
	}
}