src/test/java/org/apache/sysds/test/functions/recompile/RandRecompileTest.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.sysds.test.functions.recompile;

import org.junit.Assert;
import org.junit.Test;
import org.apache.sysds.conf.CompilerConfig;
import org.apache.sysds.hops.OptimizerUtils;
import org.apache.sysds.test.AutomatedTestBase;
import org.apache.sysds.test.TestConfiguration;
import org.apache.sysds.utils.Statistics;

public class RandRecompileTest extends AutomatedTestBase 
{
	
	private final static String TEST_NAME1 = "rand_recompile"; //scalar values, IPA irrelevant
	private final static String TEST_NAME2 = "rand_recompile2"; //nrow
	private final static String TEST_NAME3 = "rand_recompile3"; //ncol
	private final static String TEST_DIR = "functions/recompile/";
	private final static String TEST_CLASS_DIR = TEST_DIR + RandRecompileTest.class.getSimpleName() + "/";
	
	private final static int rows = 200;
	private final static int cols = 200;
	
	@Override
	public void setUp() 
	{
		addTestConfiguration(TEST_NAME1, 
			new TestConfiguration(TEST_CLASS_DIR, TEST_NAME1, new String[]{} ));
		addTestConfiguration(TEST_NAME2, 
			new TestConfiguration(TEST_CLASS_DIR, TEST_NAME2, new String[]{} ));
		addTestConfiguration(TEST_NAME3, 
			new TestConfiguration(TEST_CLASS_DIR, TEST_NAME3, new String[]{} ));
	}

	@Test
	public void testRandScalarWithoutRecompile() 
	{
		runRandTest(TEST_NAME1, false, false);
	}
	
	@Test
	public void testRandScalarWithRecompile() 
	{
		runRandTest(TEST_NAME1, true, false);
	}

	@Test
	public void testRandNRowWithoutRecompileWithoutIPA() 
	{
		runRandTest(TEST_NAME2, false, false);
	}
	
	@Test
	public void testRandNRowWithRecompileWithoutIPA() 
	{
		runRandTest(TEST_NAME2, true, false);
	}
	
	@Test
	public void testRandNColWithoutRecompileWithoutIPA() 
	{
		runRandTest(TEST_NAME3, false, false);
	}
	
	@Test
	public void testRandNColWithRecompileWithoutIPA() 
	{
		runRandTest(TEST_NAME3, true, false);
	}

	@Test
	public void testRandNRowWithoutRecompileWithIPA() 
	{
		runRandTest(TEST_NAME2, false, true);
	}
	
	@Test
	public void testRandNRowWithRecompileWithIPA() 
	{
		runRandTest(TEST_NAME2, true, true);
	}
	
	@Test
	public void testRandNColWithoutRecompileWithIPA() 
	{
		runRandTest(TEST_NAME3, false, true);
	}
	
	@Test
	public void testRandNColWithRecompileWithIPA() 
	{
		runRandTest(TEST_NAME3, true, true);
	}
	 
	
	private void runRandTest( String testName, boolean recompile, boolean IPA )
	{	
		boolean oldFlagRecompile = CompilerConfig.FLAG_DYN_RECOMPILE;
		boolean oldFlagIPA = OptimizerUtils.ALLOW_INTER_PROCEDURAL_ANALYSIS;
		
		boolean oldFlagRand1 = OptimizerUtils.ALLOW_RAND_JOB_RECOMPILE;
		boolean oldFlagRand2 = OptimizerUtils.ALLOW_BRANCH_REMOVAL;
		boolean oldFlagRand3 = OptimizerUtils.ALLOW_WORSTCASE_SIZE_EXPRESSION_EVALUATION;
		
		try
		{
			TestConfiguration config = getTestConfiguration(testName);
			config.addVariable("rows", rows);
			config.addVariable("cols", cols);
			loadTestConfiguration(config);
			
			/* This is for running the junit test the new way, i.e., construct the arguments directly */
			String HOME = SCRIPT_DIR + TEST_DIR;
			fullDMLScriptName = HOME + testName + ".dml";
			programArgs = new String[]{"-args", Integer.toString(rows), Integer.toString(cols) };
			
			CompilerConfig.FLAG_DYN_RECOMPILE = recompile;
			OptimizerUtils.ALLOW_INTER_PROCEDURAL_ANALYSIS = IPA;
			
			//disable rand specific recompile
			OptimizerUtils.ALLOW_RAND_JOB_RECOMPILE = false;
			OptimizerUtils.ALLOW_BRANCH_REMOVAL = false;
			OptimizerUtils.ALLOW_WORSTCASE_SIZE_EXPRESSION_EVALUATION = false;
			
			boolean exceptionExpected = false;
			runTest(true, exceptionExpected, null, -1);
			
			//CHECK compiled MR jobs
			int expectNumCompiled = -1;
			if( IPA ) expectNumCompiled = 0; 
			else      expectNumCompiled = 2;//rand, GMR
			Assert.assertEquals("Unexpected number of compiled MR jobs.",
				expectNumCompiled, Statistics.getNoOfCompiledSPInst());
		
			//CHECK executed MR jobs
			int expectNumExecuted = -1;
			if( recompile ) expectNumExecuted = 0;
			else if( IPA )  expectNumExecuted = 0; 
			else            expectNumExecuted = 2; //rand, GMR
			Assert.assertEquals("Unexpected number of executed MR jobs.",
				expectNumExecuted, Statistics.getNoOfExecutedSPInst());
		}
		finally
		{
			CompilerConfig.FLAG_DYN_RECOMPILE = oldFlagRecompile;
			OptimizerUtils.ALLOW_INTER_PROCEDURAL_ANALYSIS = oldFlagIPA;
			
			OptimizerUtils.ALLOW_RAND_JOB_RECOMPILE = oldFlagRand1;
			OptimizerUtils.ALLOW_BRANCH_REMOVAL = oldFlagRand2;
			OptimizerUtils.ALLOW_WORSTCASE_SIZE_EXPRESSION_EVALUATION = oldFlagRand3;
		}
	}
	
}