SystemOutTest.java

/**
 *  Catroid: An on-device visual programming system for Android devices
 *  Copyright (C) 2010-2013 The Catrobat Team
 *  (<http://developer.catrobat.org/credits>)
 *  
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as
 *  published by the Free Software Foundation, either version 3 of the
 *  License, or (at your option) any later version.
 *  
 *  An additional term exception under section 7 of the GNU Affero
 *  General Public License, version 3, is available at
 *  http://developer.catrobat.org/license_additional_term
 *  
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU Affero General Public License for more details.
 *  
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.catrobat.musicdroid.test.code;

import junit.framework.TestCase;

import org.catrobat.musicdroid.test.utils.Utils;

import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.util.List;

public class SystemOutTest extends TestCase {

	private String errorMessages;
	private boolean errorFound;

	private static final String[] SYSTEM_OUT_DIRECTORIES = { "../MusicdroidTest", "../MusicdroidUiTest",
			"../Musicdroid" };
	private static final String[] STACK_TRACE_DIRECTORIES = { "../Musicdroid", "../MusicdroidTest",
			"../MusicdroidUiTest" };
	private static final String SYSTEM_OUT = "System.out";
	private static final String PRINT_STACK_TRACE = ".printStackTrace()";

	private void checkFileForString(File file, String string) throws IOException {
		BufferedReader reader = new BufferedReader(new FileReader(file));

		int lineCount = 1;
		String line;

		while ((line = reader.readLine()) != null) {
			if (line.contains(string)) {
				errorFound = true;
				errorMessages += file.getName() + " in line " + lineCount + "\n";
			}
			++lineCount;
		}
		reader.close();
	}

	private void checkForStringInFiles(String string, String[] directories) throws IOException {
		for (String directoryName : directories) {
			File directory = new File(directoryName);
			assertTrue("Couldn't find directory: " + directoryName, directory.exists() && directory.isDirectory());
			assertTrue("Couldn't read directory: " + directoryName, directory.canRead());

			List<File> filesToCheck = Utils.getFilesFromDirectoryByExtension(directory, new String[] { ".java", });
			for (File file : filesToCheck) {
				checkFileForString(file, string);
			}
		}
	}

	@Override
	public void setUp() {
		errorMessages = "";
		errorFound = false;
	}

	public void testForSystemOut() throws IOException {
		checkForStringInFiles(SYSTEM_OUT, SYSTEM_OUT_DIRECTORIES);

		assertFalse("Files with 'System.out' found! \nPlease use 'Log.d(TAG, message)' instead \n\n" + errorMessages,
				errorFound);
	}

	public void testForPrintStackTrace() throws IOException {
		checkForStringInFiles(PRINT_STACK_TRACE, STACK_TRACE_DIRECTORIES);

		assertFalse(
				"Files with '.printStackTrace()' found! \nPlease use 'Log.e(TAG, \"Reason for Exception\", exception)' or 'Log.e(TAG, Log.getStackTraceString(exception))' instead\n\n"
						+ errorMessages, errorFound);
	}
}