RuntimeUDFContextTest.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.api.common.functions.util;

import static org.junit.Assert.*;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.concurrent.Future;

import org.apache.flink.api.common.ExecutionConfig;
import org.apache.flink.api.common.accumulators.Accumulator;
import org.apache.flink.api.common.functions.BroadcastVariableInitializer;
import org.apache.flink.core.fs.Path;
import org.junit.Test;


public class RuntimeUDFContextTest {
	
	@Test
	public void testBroadcastVariableNotFound() {
		try {
			RuntimeUDFContext ctx = new RuntimeUDFContext("test name", 3, 1, getClass().getClassLoader(), new ExecutionConfig(), new HashMap<String, Future<Path>>(),new HashMap<String, Accumulator<?, ?>>());
			
			try {
				ctx.getBroadcastVariable("some name");
				fail("should throw an exception");
			}
			catch (IllegalArgumentException e) {
				// expected
			}
			
			try {
				ctx.getBroadcastVariableWithInitializer("some name", new BroadcastVariableInitializer<Object, Object>() {
					public Object initializeBroadcastVariable(Iterable<Object> data) { return null; }
				});
				
				fail("should throw an exception");
			}
			catch (IllegalArgumentException e) {
				// expected
			}
		}
		catch (Exception e) {
			e.printStackTrace();
			fail(e.getMessage());
		}
	}
	
	@Test
	public void testBroadcastVariableSimple() {
		try {
			RuntimeUDFContext ctx = new RuntimeUDFContext("test name", 3, 1, getClass().getClassLoader(), new ExecutionConfig(), new HashMap<String, Future<Path>>(), new HashMap<String, Accumulator<?, ?>>());
			
			ctx.setBroadcastVariable("name1", Arrays.asList(1, 2, 3, 4));
			ctx.setBroadcastVariable("name2", Arrays.asList(1.0, 2.0, 3.0, 4.0));
			
			List<Integer> list1 = ctx.getBroadcastVariable("name1");
			List<Double> list2 = ctx.getBroadcastVariable("name2");
			
			assertEquals(Arrays.asList(1, 2, 3, 4), list1);
			assertEquals(Arrays.asList(1.0, 2.0, 3.0, 4.0), list2);
			
			// access again
			List<Integer> list3 = ctx.getBroadcastVariable("name1");
			List<Double> list4 = ctx.getBroadcastVariable("name2");
			
			assertEquals(Arrays.asList(1, 2, 3, 4), list3);
			assertEquals(Arrays.asList(1.0, 2.0, 3.0, 4.0), list4);
			
			// and again ;-)
			List<Integer> list5 = ctx.getBroadcastVariable("name1");
			List<Double> list6 = ctx.getBroadcastVariable("name2");
			
			assertEquals(Arrays.asList(1, 2, 3, 4), list5);
			assertEquals(Arrays.asList(1.0, 2.0, 3.0, 4.0), list6);
		}
		catch (Exception e) {
			e.printStackTrace();
			fail(e.getMessage());
		}
	}

	@Test
	public void testBroadcastVariableWithInitializer() {
		try {
			RuntimeUDFContext ctx = new RuntimeUDFContext("test name", 3, 1, getClass().getClassLoader(), new ExecutionConfig(), new HashMap<String, Future<Path>>(), new HashMap<String, Accumulator<?, ?>>());
			
			ctx.setBroadcastVariable("name", Arrays.asList(1, 2, 3, 4));
			
			// access it the first time with an initializer
			List<Double> list = ctx.getBroadcastVariableWithInitializer("name", new ConvertingInitializer());
			assertEquals(Arrays.asList(1.0, 2.0, 3.0, 4.0), list);
			
			// access it the second time with an initializer (which might not get executed)
			List<Double> list2 = ctx.getBroadcastVariableWithInitializer("name", new ConvertingInitializer());
			assertEquals(Arrays.asList(1.0, 2.0, 3.0, 4.0), list2);
			
			// access it the third time without an initializer (should work by "chance", because the result is a list)
			List<Double> list3 = ctx.getBroadcastVariable("name");
			assertEquals(Arrays.asList(1.0, 2.0, 3.0, 4.0), list3);
		}
		catch (Exception e) {
			e.printStackTrace();
			fail(e.getMessage());
		}
	}
	
	@Test
	public void testResetBroadcastVariableWithInitializer() {
		try {
			RuntimeUDFContext ctx = new RuntimeUDFContext("test name", 3, 1, getClass().getClassLoader(), new ExecutionConfig(), new HashMap<String, Future<Path>>(), new HashMap<String, Accumulator<?, ?>>());
			
			ctx.setBroadcastVariable("name", Arrays.asList(1, 2, 3, 4));
			
			// access it the first time with an initializer
			List<Double> list = ctx.getBroadcastVariableWithInitializer("name", new ConvertingInitializer());
			assertEquals(Arrays.asList(1.0, 2.0, 3.0, 4.0), list);
			
			// set it again to something different
			ctx.setBroadcastVariable("name", Arrays.asList(2, 3, 4, 5));
			
			List<Double> list2 = ctx.getBroadcastVariableWithInitializer("name", new ConvertingInitializer());
			assertEquals(Arrays.asList(2.0, 3.0, 4.0, 5.0), list2);
		}
		catch (Exception e) {
			e.printStackTrace();
			fail(e.getMessage());
		}
	}
	
	@Test
	public void testBroadcastVariableWithInitializerAndMismatch() {
		try {
			RuntimeUDFContext ctx = new RuntimeUDFContext("test name", 3, 1, getClass().getClassLoader(), new ExecutionConfig(), new HashMap<String, Future<Path>>(), new HashMap<String, Accumulator<?, ?>>());
			
			ctx.setBroadcastVariable("name", Arrays.asList(1, 2, 3, 4));
			
			// access it the first time with an initializer
			int sum = ctx.getBroadcastVariableWithInitializer("name", new SumInitializer());
			assertEquals(10, sum);
			
			// access it the second time with no initializer -> should fail due to type mismatch
			try {
				ctx.getBroadcastVariable("name");
				fail("should throw an exception");
			}
			catch (IllegalStateException e) {
				// expected
			}
		}
		catch (Exception e) {
			e.printStackTrace();
			fail(e.getMessage());
		}
	}
	
	// --------------------------------------------------------------------------------------------
	
	private static final class ConvertingInitializer implements BroadcastVariableInitializer<Integer, List<Double>> {
		@Override
		public List<Double> initializeBroadcastVariable(Iterable<Integer> data) {
			List<Double> list = new ArrayList<Double>();
			
			for (Integer i : data) {
				list.add(i.doubleValue());
			}
			return list;
		}
	}
	
	private static final class SumInitializer implements BroadcastVariableInitializer<Integer, Integer> {
		@Override
		public Integer initializeBroadcastVariable(Iterable<Integer> data) {
			int sum = 0;
			
			for (Integer i : data) {
				sum += i;
			}
			return sum;
		}
	}
}