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

import java.io.ByteArrayOutputStream;
import java.io.PrintStream;

import org.apache.sysds.hops.OptimizerUtils;
import org.apache.sysds.parser.LanguageException;
import org.apache.sysds.parser.ParseException;
import org.apache.sysds.runtime.util.HDFSTool;
import org.apache.sysds.test.AutomatedTestBase;
import org.apache.sysds.test.TestConfiguration;
import org.apache.sysds.utils.Statistics;
import org.junit.Assert;
import org.junit.Test;

public class FunctionNamespaceTest extends AutomatedTestBase 
{
	private final static String TEST_NAME0 = "FunctionsA";
	private final static String TEST_NAME1 = "Functions1";
	private final static String TEST_NAME2 = "Functions2";
	private final static String TEST_NAME3 = "Functions3";
	private final static String TEST_NAME4 = "Functions4";
	private final static String TEST_NAME5 = "Functions5";
	private final static String TEST_NAME6 = "Functions6";
	private final static String TEST_NAME7 = "Functions7";
	private final static String TEST_NAME8 = "Functions8";
	private final static String TEST_NAME9 = "Functions9";
	private final static String TEST_NAME10 = "Functions10";
	private final static String TEST_NAME11 = "Functions11";
	private final static String TEST_NAME12 = "Functions12";
	private final static String TEST_NAME13 = "Functions13";
	private final static String TEST_NAME14 = "Functions14";
	private final static String TEST_DIR = "functions/misc/";
	private final static String TEST_CLASS_DIR = TEST_DIR + FunctionNamespaceTest.class.getSimpleName() + "/";
	
	private final static long rows = 3400;
	private final static long cols = 2700;
	private final static double val = 1.0;
	
	@Override
	public void setUp() {
		addTestConfiguration(TEST_NAME0, new TestConfiguration(TEST_CLASS_DIR, TEST_NAME0));
		addTestConfiguration(TEST_NAME1, new TestConfiguration(TEST_CLASS_DIR, TEST_NAME1));
		addTestConfiguration(TEST_NAME2, new TestConfiguration(TEST_CLASS_DIR, TEST_NAME2));
		addTestConfiguration(TEST_NAME3, new TestConfiguration(TEST_CLASS_DIR, TEST_NAME3));
		addTestConfiguration(TEST_NAME4, new TestConfiguration(TEST_CLASS_DIR, TEST_NAME4));
		addTestConfiguration(TEST_NAME5, new TestConfiguration(TEST_CLASS_DIR, TEST_NAME5));
		addTestConfiguration(TEST_NAME6, new TestConfiguration(TEST_CLASS_DIR, TEST_NAME6));
		addTestConfiguration(TEST_NAME7, new TestConfiguration(TEST_CLASS_DIR, TEST_NAME7));
		addTestConfiguration(TEST_NAME8, new TestConfiguration(TEST_CLASS_DIR, TEST_NAME8));
		addTestConfiguration(TEST_NAME9, new TestConfiguration(TEST_CLASS_DIR, TEST_NAME9));
		addTestConfiguration(TEST_NAME10, new TestConfiguration(TEST_CLASS_DIR, TEST_NAME10));
		addTestConfiguration(TEST_NAME11, new TestConfiguration(TEST_CLASS_DIR, TEST_NAME11));
		addTestConfiguration(TEST_NAME12, new TestConfiguration(TEST_CLASS_DIR, TEST_NAME12));
		addTestConfiguration(TEST_NAME13, new TestConfiguration(TEST_CLASS_DIR, TEST_NAME13));
		addTestConfiguration(TEST_NAME14, new TestConfiguration(TEST_CLASS_DIR, TEST_NAME14));
	}
	
	@Test
	public void testFunctionDefaultNS() {
		runFunctionNamespaceTest(TEST_NAME0);
	}
	
	@Test
	public void testFunctionSourceNS() {
		runFunctionNamespaceTest(TEST_NAME1);
	}
	
	@Test
	public void testFunctionWithoutNS() {
		runFunctionNamespaceTest(TEST_NAME2);
	}
	
	@Test
	public void testFunctionImportSource() {
		runFunctionNamespaceTest(TEST_NAME3);
	}
	
	@Test
	public void testFunctionMultiSource() {
		runFunctionNamespaceTest(TEST_NAME4);
	}
	
	@Test
	public void testFunctionNoInliningIPA() {
		runFunctionNoInliningNamespaceTest(TEST_NAME5, true);
	}
	
	@Test
	public void testFunctionNoInliningNoIPA() {
		runFunctionNoInliningNamespaceTest(TEST_NAME5, false);
	}
	
	@Test
	public void testFunctionCircular() {
		runFunctionNamespaceTest(TEST_NAME6);
	}
	
	@Test
	public void testFunctionCircularChain() {
		runFunctionNoInliningNamespaceTest(TEST_NAME7, true);
	}
	
	@Test
	public void testFunctionCircularChainNoIPA() {
		runFunctionNoInliningNamespaceTest(TEST_NAME7, false);
	}
	@Test
	public void testFunctionErrorConflict() {
		runFunctionNamespaceTest(TEST_NAME8);
	}
	
	@Test
	public void testFunctionIndirectConflict() {
		runFunctionNoInliningNamespaceTest(TEST_NAME9, true);
	}
	
	@Test
	public void testFunctionMultiConflict() {
		runFunctionNamespaceTest(TEST_NAME10);
	}
	
	@Test
	public void testFunctionBuiltinOverride() {
		runFunctionNamespaceTest(TEST_NAME11);
	}
	
	@Test
	public void testFunctionMultiOverride() {
		runFunctionNamespaceTest(TEST_NAME12);
	}
	
	@Test
	public void testFunctionErrorOverride() {
		runFunctionNamespaceTest(TEST_NAME13);
	}
	
	@Test
	public void testFunctionRandomCDF() {
		runFunctionNamespaceTest(TEST_NAME14);
	}
	
	private void runFunctionNamespaceTest(String TEST_NAME)
	{
		getAndLoadTestConfiguration(TEST_NAME);
		
		fullDMLScriptName = SCRIPT_DIR + TEST_DIR + TEST_NAME + ".dml";
		programArgs = new String[]{};
		
		PrintStream origStdErr = System.err;

		try {
			if(TEST_NAME2.equals(TEST_NAME))
				runTest(true, true, LanguageException.class, -1);
			else if(TEST_NAME8.equals(TEST_NAME) || TEST_NAME13.equals(TEST_NAME))
				runTest(true, true, ParseException.class, -1);
			else
				runTest(true, false, null, -1);
		}
		catch (Exception e) {
			e.printStackTrace(origStdErr);
			Assert.fail("Unexpected exception: " + e);
		}
		finally {
			System.setErr(origStdErr);
		}
	}

	private void runFunctionNoInliningNamespaceTest(String TEST_NAME, boolean IPA)
	{
		boolean origIPA = OptimizerUtils.ALLOW_INTER_PROCEDURAL_ANALYSIS;
		
		getAndLoadTestConfiguration(TEST_NAME);
		
		fullDMLScriptName = SCRIPT_DIR + TEST_DIR + TEST_NAME + ".dml";
		programArgs = new String[]{"-args", String.valueOf(rows), String.valueOf(cols), String.valueOf(val), output("Rout")};
		
		PrintStream originalStdErr = System.err;

		try
		{
			ByteArrayOutputStream baos = new ByteArrayOutputStream();
			PrintStream newStdErr = new PrintStream(baos);
			System.setErr(newStdErr);
			
			OptimizerUtils.ALLOW_INTER_PROCEDURAL_ANALYSIS = IPA;
			runTest(true, false, null, -1); 
			
			//compare output
			double ret = HDFSTool.readDoubleFromHDFSFile(output("Rout"));
			Assert.assertEquals(Double.valueOf(rows*cols*val*6), Double.valueOf(ret));
			
			//compiled MR jobs
			int expectNumCompiled = IPA ? 0 : 4; 
			Assert.assertEquals("Unexpected number of compiled MR jobs.", expectNumCompiled, Statistics.getNoOfCompiledSPInst());
		
			//check executed MR jobs (should always be 0 due to dynamic recompilation)
			int expectNumExecuted = 0;
			Assert.assertEquals("Unexpected number of executed MR jobs.", expectNumExecuted, Statistics.getNoOfExecutedSPInst());
			
			String stdErrString = baos.toString();
			if (stdErrString != null && stdErrString.length() > 0)
				Assert.fail("Unexpected parse error or DML script error: " + stdErrString);
		}
		catch (Exception e) {
			e.printStackTrace(originalStdErr);
			Assert.fail("Unexpected exception: " + e);
		}
		finally {
			System.setErr(originalStdErr);
			OptimizerUtils.ALLOW_INTER_PROCEDURAL_ANALYSIS = origIPA;
		}
	}
}