com.izforge.izpack.test.util.TestConsole Maven / Gradle / Ivy
/*
* IzPack - Copyright 2001-2012 Julien Ponge, All Rights Reserved.
*
* http://izpack.org/
* http://izpack.codehaus.org/
*
* Copyright 2012 Tim Anderson
*
* Licensed 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 com.izforge.izpack.test.util;
import com.izforge.izpack.api.data.ConsolePrefs;
import com.izforge.izpack.api.resource.Messages;
import com.izforge.izpack.util.Console;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
/**
* An {@link Console} that takes its input from a list of command strings.
*
* @author Tim Anderson
*/
public class TestConsole extends Console
{
/**
* The input scripts.
*/
private List> scripts = new ArrayList>();
/**
* The output.
*/
private List output = new ArrayList();
/**
* The index into {@link #scripts}.
*/
private int scriptIndex = 0;
/**
* The current script.
*/
List currentScript = null;
/**
* The index into {@link #currentScript}.
*/
private int index = 0;
/**
* The no. of reads.
*/
private int reads = 0;
/**
* Constructs a TestConsole.
*/
public TestConsole(Messages messages, ConsolePrefs prefs)
{
super(messages, prefs);
}
/**
* Adds an input script. This is used to simulate keyboard input.
*
* @param name a name for the script, for error reporting purposes
* @param script the script. Each element corresponds to a line returned by {@link #readLine()}
*/
public void addScript(String name, String... script)
{
List list = new ArrayList();
list.add(name);
list.addAll(Arrays.asList(script));
scripts.add(list);
}
/**
* Returns the current script name.
*
* @return the current script name, or null if there is no script
*/
public String getScriptName()
{
return currentScript != null ? currentScript.get(0) : null;
}
/**
* Determines if the input script has completed.
*
* @return true if the script has completed, otherwise false
*/
public boolean scriptCompleted()
{
return scriptIndex == scripts.size() && (scripts.isEmpty() || index == scripts.get(scriptIndex - 1).size());
}
@Override
public int read() throws IOException
{
String line = this.readLine();
return (line!=null && !line.isEmpty()) ? line.charAt(0) : -1;
}
/**
* Reads a line of text. A line is considered to be terminated by any one of a line feed ('\\n'),
* a carriage return ('\\r'), or a carriage return followed immediately by a linefeed.
*
* @return a String containing the contents of the line, not including any line-termination characters, or
* null if the end of the stream has been reached
* @throws IOException if an I/O error occurs
*/
@Override
public String readLine() throws IOException
{
++reads;
String result = null;
advanceScript();
while (currentScript != null)
{
if (index == 0)
{
++index; // first index is the name of the script
}
if (index < currentScript.size())
{
result = currentScript.get(index++);
break;
}
else
{
advanceScript();
}
}
if (result != null)
{
if (result.endsWith("\r\n"))
{
result = result.substring(0, result.length() - 2);
}
else if (result.endsWith("\r") || result.endsWith("\n"))
{
result = result.substring(0, result.length() - 1);
}
println(result); // echo it out
}
return result;
}
/**
* Returns the no. of times {@link #readLine()} has been invoked.
*
* @return the no. of reads
*/
public int getReads()
{
return reads;
}
@Override
public void flush() throws IOException
{
// Ignore in tests
}
/**
* Prints a message to the console.
*
* @param message the message to print
*/
@Override
public void print(String message)
{
super.print(message);
output.add(message);
}
/**
* Prints a message to the console with a new line.
*
* @param message the message to print
*/
@Override
public void println(String message)
{
super.println(message);
output.add(message);
}
/**
* Returns the output.
*
* @return the output
*/
public List getOutput()
{
return output;
}
/**
* Advances to the next script, if required.
*/
private void advanceScript()
{
if (currentScript == null || index == currentScript.size())
{
if (scriptIndex < scripts.size())
{
currentScript = scripts.get(scriptIndex++);
System.out.println("TestConsole running script: " + getScriptName());
index = 0;
}
else
{
currentScript = null;
}
}
}
}