Compare commits

..

38 Commits

Author SHA1 Message Date
89847738e5 [maven-release-plugin] prepare release gclc-socket-1.1.11 2018-10-15 09:35:58 -04:00
cd76d438c1 Update config
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-15 09:34:59 -04:00
fa46939c54 Added doc. Clean up code
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-15 09:34:51 -04:00
fe4851053a Update configurations
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-15 09:14:06 -04:00
6a7d0b11a0 Removed thread sleeping lock
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-15 09:10:31 -04:00
93589c750e Reformatting
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 23:07:41 -04:00
c23af20b17 Update version of configuration
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 19:05:49 -04:00
c7625c8006 Update dependencies, organize imports
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 18:58:17 -04:00
ad65165169 [maven-release-plugin] prepare for next development iteration 2018-10-14 18:28:48 -04:00
0814ab5740 [maven-release-plugin] prepare release gclc-2.0.9 2018-10-14 18:28:43 -04:00
ba26a70daa Minor javadoc
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 18:24:54 -04:00
4301f2a15e Fix test and wait
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 18:15:49 -04:00
2a05366e31 REmoved unnecessary boolean variable
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 11:04:13 -04:00
bd44b5bf85 Added empty else for readability
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 11:02:14 -04:00
4e804325e6 Removed initialisation to default
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 11:02:05 -04:00
ae5dc1aeba Move help command to package of defined commands
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 10:55:55 -04:00
d5a7d4a16f Avoid contains and get calls on same key in map
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 10:04:08 -04:00
de593c00a1 Update config, remove site descriptor, to use inherited one 2018-10-14 09:29:42 -04:00
50ac6eec06 Moved out increments
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-14 09:28:04 -04:00
74c66dcbdd Moved listeners from list to set 2018-10-14 09:26:55 -04:00
7c94dea7b5 Avoid multiple creation of empty array 2018-10-14 09:26:27 -04:00
a580133945 Removed method with constant return 2018-10-14 09:26:07 -04:00
38fe457f47 Formating in logs 2018-10-11 12:50:19 -04:00
159805701c Fixed run lockings
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-11 12:43:17 -04:00
f7876dc964 Remove unused final modifiers 2018-10-11 12:38:09 -04:00
c4db9f43fb Clean up and format 2018-10-11 12:29:49 -04:00
67abd91f72 Use concurrent hash map, where possible
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-10-11 12:13:21 -04:00
7934ab7435 Removed unnecessary exception 2018-10-11 12:09:42 -04:00
761d640f0b Synchronization organisation 2018-10-11 12:09:24 -04:00
98d22782c1 Collections initial size 2018-10-11 12:08:59 -04:00
f8da1c0119 Move from list to linked set for order conservation and use efficiency 2018-10-11 11:33:15 -04:00
438727e7b9 Fix stream for efficient garbage collection 2018-10-11 11:32:49 -04:00
a2a87eb0d7 Added site definition 2018-10-11 11:32:32 -04:00
7ba8b38624 Added synchronize block 2018-10-11 11:32:23 -04:00
6bcf2b0c91 [maven-release-plugin] prepare for next development iteration 2018-10-11 11:11:23 -04:00
3a568d3723 [maven-release-plugin] prepare release gclc-2.0.8 2018-10-11 11:10:37 -04:00
7e81105785 Remove unecessary imports and site resources, update configurations 2018-10-11 11:04:05 -04:00
bb7c01a7f2 [maven-release-plugin] prepare for next development iteration 2018-10-08 15:05:15 -04:00
120 changed files with 2726 additions and 2812 deletions

View File

@@ -34,7 +34,7 @@
<groupId>net.bigeon.gclc</groupId>
<artifactId>process</artifactId>
<version>0.0.3</version>
<version>0.0.4-SNAPSHOT</version>
<packaging>jar</packaging>
<name>process</name>
@@ -49,13 +49,13 @@
<parent>
<groupId>net.bigeon.config</groupId>
<artifactId>ebigeon-config</artifactId>
<version>1.8.4</version>
<version>1.8.12</version>
</parent>
<dependencies>
<dependency>
<groupId>net.bigeon</groupId>
<artifactId>gclc</artifactId>
<version>2.0.7</version>
<version>2.0.9</version>
</dependency>
</dependencies>
@@ -68,11 +68,6 @@
</licenses>
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.3</version>
</plugin>
<plugin>
<groupId>com.github.sevntu-checkstyle</groupId>
<artifactId>dsm-maven-plugin</artifactId>
@@ -92,7 +87,7 @@
</developers>
<scm>
<tag>process-0.0.3</tag>
<tag>HEAD</tag>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
</scm>
</project>

View File

@@ -72,13 +72,10 @@ import java.util.Arrays;
import net.bigeon.gclc.command.ICommand;
import net.bigeon.gclc.exception.CommandRunException;
/**
* @author Emmanuel Bigeon
*
*/
/** @author Emmanuel Bigeon */
public class ForkCommandTask extends ForkTask {
private final ICommand command;
private final String[] args;
private final ICommand command;
private final String[] args;
/** @param cmd the command
* @param args the arguements
@@ -89,13 +86,6 @@ public class ForkCommandTask extends ForkTask {
this.args = Arrays.copyOf(args, args.length);
}
/* (non-Javadoc)
* @see net.bigeon.gclc.process.Task#getName() */
@Override
public String getName() {
return command.getCommandName();
}
/* (non-Javadoc)
* @see net.bigeon.gclc.process.ForkTask#doRun() */
@Override
@@ -103,4 +93,11 @@ public class ForkCommandTask extends ForkTask {
command.execute(out, in, args);
}
/* (non-Javadoc)
* @see net.bigeon.gclc.process.Task#getName() */
@Override
public String getName() {
return command.getCommandName();
}
}

View File

@@ -89,8 +89,8 @@ public abstract class ForkTask implements Task {
protected final ConnectingConsoleInput in = new ConnectingConsoleInput();
protected final ConnectingConsoleOutput out;
private CommandRunException exception;
private final Object runLock = new Object();
private CommandRunException exception;
private final Object runLock = new Object();
/** @param lines the number of print to store in the output */
public ForkTask(int lines) {
@@ -105,6 +105,20 @@ public abstract class ForkTask implements Task {
listeners.add(listener);
}
/** Actually run the fork. */
protected abstract void doRun() throws CommandRunException;
/** Get the excepion that caused a failure.
*
* @return the exception */
public final CommandRunException getException() {
return exception;
}
protected final Object getRunningLock() {
return runLock;
}
/* (non-Javadoc)
* @see net.bigeon.gclc.process.Task#isRunning() */
@Override
@@ -162,16 +176,6 @@ public abstract class ForkTask implements Task {
}
}
/** Actually run the fork. */
protected abstract void doRun() throws CommandRunException;
/** Get the excepion that caused a failure.
*
* @return the exception */
public final CommandRunException getException() {
return exception;
}
/* (non-Javadoc)
* @see net.bigeon.gclc.process.Task#setRunning(boolean) */
@Override
@@ -181,8 +185,4 @@ public abstract class ForkTask implements Task {
runLock.notifyAll();
}
}
protected final Object getRunningLock() {
return runLock;
}
}

View File

@@ -71,10 +71,7 @@ import net.bigeon.gclc.ApplicationAttachement;
import net.bigeon.gclc.command.ICommandProvider;
import net.bigeon.gclc.exception.InvalidCommandName;
/**
* @author Emmanuel Bigeon
*
*/
/** @author Emmanuel Bigeon */
public class ProcessAttachement implements ApplicationAttachement {
private final TaskPool pool;
@@ -86,8 +83,8 @@ public class ProcessAttachement implements ApplicationAttachement {
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.ApplicationAttachement#attach(fr.bigeon.gclc.ConsoleApplication)
*/
* @see fr.bigeon.gclc.ApplicationAttachement#attach(fr.bigeon.gclc.
* ConsoleApplication) */
@Override
public void attach(ICommandProvider application) throws InvalidCommandName {
application.add(new ProcessKill("kill", pool));

View File

@@ -89,11 +89,10 @@ public final class ProcessClear extends Command {
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
final String... args) throws CommandRunException {
for (final String id : pool.getPIDs()) {
if (!pool.get(id).isRunning()) {
pool.remove(id);

View File

@@ -89,11 +89,10 @@ public final class ProcessKill extends Command {
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
final String... args) throws CommandRunException {
pool.get(args[0]).setRunning(false);
}

View File

@@ -95,11 +95,10 @@ public final class ProcessList extends Command {
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
final String... args) throws CommandRunException {
final ArrayList<String> pids = new ArrayList<>(pool.getPIDs());
Collections.sort(pids);
for (final String string : pids) {
@@ -107,8 +106,7 @@ public final class ProcessList extends Command {
out.println(MessageFormat.format("{0}\t{1}", string, //$NON-NLS-1$
pool.get(string).getName()));
} catch (final IOException e) {
throw new CommandRunException(
CommandRunExceptionType.INTERACTION,
throw new CommandRunException(CommandRunExceptionType.INTERACTION,
"Unable to communicate with user", e); //$NON-NLS-1$
}
}

View File

@@ -103,8 +103,8 @@ public interface Task extends Runnable {
/** Set the running state.
* <p>
* This method should be only called by external objects with the false
* argument. Calling this method with true has unspecified behavior and
* could do nothing as well as restart the command for example.
* argument. Calling this method with true has unspecified behavior and could do
* nothing as well as restart the command for example.
*
* @param running the running state */
void setRunning(boolean running);

View File

@@ -95,16 +95,6 @@ public final class TaskPool {
this.autoClear = autoClear;
}
/** Remove a task from the pool
*
* @param pid the task id */
public void remove(String pid) {
synchronized (lock) {
running.remove(pid);
count = Math.min(count, Integer.parseInt(pid));
}
}
/** Add a process in the pool.
*
* @param cmd the process
@@ -168,6 +158,16 @@ public final class TaskPool {
return autoClear;
}
/** Remove a task from the pool
*
* @param pid the task id */
public void remove(String pid) {
synchronized (lock) {
running.remove(pid);
count = Math.min(count, Integer.parseInt(pid));
}
}
/** Request all task to stop running.
* <p>
* This call does not guaranty end of execution, it is up to the task

View File

@@ -80,7 +80,7 @@ import net.bigeon.gclc.manager.ConsoleOutput;
* @author Emmanuel Bigeon */
public abstract class TaskSpawner extends Command {
/** The process pool */
private final TaskPool pool;
private final TaskPool pool;
private final ExecutorService threadPool;
/** @param name the command name
@@ -97,16 +97,15 @@ public abstract class TaskSpawner extends Command {
* @param args the arguments
* @return the process to start and add to the pool
* @throws CommandRunException if the task creation failed */
protected abstract Task createTask(ConsoleOutput out, ConsoleInput in,
String... args) throws CommandRunException;
protected abstract Task createTask(ConsoleOutput out, ConsoleInput in, String... args)
throws CommandRunException;
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[]) */
@Override
public final void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
final String... args) throws CommandRunException {
final Task task = createTask(out, in, args);
final Thread th = new Thread(task);
pool.add(task);

View File

@@ -77,9 +77,9 @@ import net.bigeon.gclc.tools.StringProvider;
/** @author Emmanuel Bigeon */
public final class ConnectingConsoleInput implements ConsoleInput {
private static final Logger LOGGER = Logger
private static final Logger LOGGER = Logger
.getLogger(ConnectingConsoleInput.class.getName());
private boolean close = false;
private boolean close = false;
private StringProvider prompt;
private boolean prompting;
private final Object promptLock = new Object();
@@ -94,6 +94,26 @@ public final class ConnectingConsoleInput implements ConsoleInput {
close = true;
}
public void connect(ConsoleInput input) {
disconnect();
synchronized (promptLock) {
connected = input;
promptLock.notifyAll();
}
}
public void disconnect() {
synchronized (connectionLock) {
if (connected != null) {
disconnection = true;
synchronized (promptLock) {
connected.interruptPrompt();
}
connected = null;
}
}
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#getPrompt() */
@Override
@@ -128,14 +148,6 @@ public final class ConnectingConsoleInput implements ConsoleInput {
return prompt(prompt.apply());
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(fr.bigeon.gclc.tools.
* StringProvider) */
@Override
public void setPrompt(StringProvider string) {
prompt = string;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(long) */
@Override
@@ -222,23 +234,11 @@ public final class ConnectingConsoleInput implements ConsoleInput {
};
}
public void connect(ConsoleInput input) {
disconnect();
synchronized (promptLock) {
connected = input;
promptLock.notifyAll();
}
}
public void disconnect() {
synchronized (connectionLock) {
if (connected != null) {
disconnection = true;
synchronized (promptLock) {
connected.interruptPrompt();
}
connected = null;
}
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(fr.bigeon.gclc.tools.
* StringProvider) */
@Override
public void setPrompt(StringProvider string) {
prompt = string;
}
}

View File

@@ -130,6 +130,25 @@ public class ConnectingConsoleOutput implements ConsoleOutput {
close = true;
}
public synchronized void connect(ConsoleOutput output) {
this.output = output;
for (final String string : messages) {
try {
output.print(string);
} catch (final IOException e) {
LOGGER.severe("nable to print to connecting console");
LOGGER.log(Level.FINE, "Console error", e);
}
}
if (!persistent) {
messages.clear();
}
}
public synchronized void disconnect() {
output = null;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleOutput#isClosed() */
@Override
@@ -157,23 +176,4 @@ public class ConnectingConsoleOutput implements ConsoleOutput {
public void println(String message) {
addMessage(message + System.lineSeparator());
}
public synchronized void connect(ConsoleOutput output) {
this.output = output;
for (final String string : messages) {
try {
output.print(string);
} catch (final IOException e) {
LOGGER.severe("nable to print to connecting console");
LOGGER.log(Level.FINE, "Console error", e);
}
}
if (!persistent) {
messages.clear();
}
}
public synchronized void disconnect() {
output = null;
}
}

View File

@@ -34,11 +34,10 @@
-->
<project name="GCLC">
<bannerLeft>
<name>GCLC</name>
<src>banner_dev_60.png</src>
<href>http://bigeon.net/</href>
</bannerLeft>
<bannerRight>
<src>https://bigeon.net/images/logo_48.png</src>
<href>https://bigeon.net/</href>
</bannerRight>
<body>
<menu ref="reports"/>
</body>

View File

@@ -33,7 +33,7 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<artifactId>gclc-socket</artifactId>
<version>1.1.11-SNAPSHOT</version>
<version>1.1.11</version>
<packaging>jar</packaging>
<url>http://www.bigeon.net</url>
<properties>
@@ -46,18 +46,18 @@
<dependency>
<groupId>net.bigeon</groupId>
<artifactId>gclc</artifactId>
<version>2.0.7</version>
<version>2.0.9</version>
</dependency>
<dependency>
<groupId>net.bigeon</groupId>
<artifactId>smu</artifactId>
<version>1.0.0</version>
<version>1.0.5</version>
</dependency>
</dependencies>
<parent>
<groupId>net.bigeon.config</groupId>
<artifactId>ebigeon-config</artifactId>
<version>1.8.4</version>
<version>1.8.12</version>
</parent>
<licenses>
<license>
@@ -68,11 +68,6 @@
</licenses>
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.3</version>
</plugin>
<plugin>
<groupId>com.github.sevntu-checkstyle</groupId>
<artifactId>dsm-maven-plugin</artifactId>
@@ -94,7 +89,7 @@
<description>Socket implementation of GCLC</description>
<scm>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<tag>HEAD</tag>
<tag>gclc-socket-1.1.11</tag>
</scm>
<groupId>net.bigeon.gclc</groupId>
<inceptionYear>2016</inceptionYear>

View File

@@ -50,23 +50,24 @@ import java.util.logging.Logger;
public final class DConnexionManager<T> implements ConnexionManager<T> {
/** Class logger. */
private static final Logger LOGGER = Logger
private static final Logger LOGGER = Logger
.getLogger(DConnexionManager.class.getName());
/** The connected objects. */
private final Map<String, T> connecteds = new HashMap<>();
private final Map<String, T> connecteds = new HashMap<>();
/** The locks for the connexions. */
private final Map<String, Object> locks = new HashMap<>();
private final Map<String, Object> locks = new HashMap<>();
/** The counter for the disconnexion locks. */
private final Map<String, Integer> counters = new HashMap<>();
private final Map<String, Integer> counters = new HashMap<>();
/** The lock for modification of {@link #counters}. */
private final Object counterLock = new Object();
private final Object counterLock = new Object();
/** The count of connexions. */
private int count = 0;
private int count;
/** Default.constructor. */
public DConnexionManager() {
//
}
/* (non-Javadoc)
* @see
* net.bigeon.gclc.socket.ConnexionManager#addConnexion(java.lang.Object) */
@@ -80,29 +81,28 @@ public final class DConnexionManager<T> implements ConnexionManager<T> {
}
/* (non-Javadoc)
* @see
* net.bigeon.gclc.socket.ConnexionManager#disconnect(java.lang.String) */
* @see net.bigeon.gclc.socket.ConnexionManager#disconnect(java.lang.String) */
@Override
public T disconnect(final String id) {
if (connecteds.containsKey(id)) {
final T disc = connecteds.remove(id);
final Object lock = locks.get(id);
synchronized (lock) {
lock.notifyAll();
}
synchronized (counterLock) {
while (counters.get(id).intValue() > 0) {
try {
counterLock.wait();
} catch (final InterruptedException e) {
LOGGER.log(Level.FINE, "Interruption of thread", e); //$NON-NLS-1$
Thread.currentThread().interrupt();
}
if (!connecteds.containsKey(id)) {
return null;
}
final T disc = connecteds.remove(id);
final Object lock = locks.get(id);
synchronized (lock) {
lock.notifyAll();
}
synchronized (counterLock) {
while (counters.get(id).intValue() > 0) {
try {
counterLock.wait();
} catch (final InterruptedException e) {
LOGGER.log(Level.FINE, "Interruption of thread", e); //$NON-NLS-1$
Thread.currentThread().interrupt();
}
}
return disc;
}
return null;
return disc;
}
/* (non-Javadoc)
@@ -120,8 +120,7 @@ public final class DConnexionManager<T> implements ConnexionManager<T> {
}
/* (non-Javadoc)
* @see
* net.bigeon.gclc.socket.ConnexionManager#isConnected(java.lang.String) */
* @see net.bigeon.gclc.socket.ConnexionManager#isConnected(java.lang.String) */
@Override
public boolean isConnected(final String id) {
return connecteds.containsKey(id);
@@ -154,8 +153,8 @@ public final class DConnexionManager<T> implements ConnexionManager<T> {
@Override
public void releaseDisconnexionLock(final String id) {
synchronized (counterLock) {
counters.put(id, Integer
.valueOf(Math.max(counters.get(id).intValue() - 1, 0)));
counters.put(id,
Integer.valueOf(Math.max(counters.get(id).intValue() - 1, 0)));
counterLock.notifyAll();
}
}

View File

@@ -61,28 +61,28 @@ import net.bigeon.gclc.utils.ReadingRunnable;
* @author Emmanuel Bigeon */
public final class PluggableConsoleInput implements ConsoleInput {
/** The ten constant. */
private static final int TENTH = 10;
private static final int TENTH = 10;
/** Class logger. */
private static final Logger LOGGER = Logger
private static final Logger LOGGER = Logger
.getLogger(PluggableConsoleInput.class.getName());
/** The default time out. */
private static final long TIMEOUT = 100;
private static final long TIMEOUT = 100;
/** The prompting. */
private boolean prompting = false;
private boolean prompting = false;
/** If the element is closed. */
private boolean closed = false;
private boolean closed = false;
/** The default prompt. */
private StringProvider prompt = new ConstantString("> "); //$NON-NLS-1$
private StringProvider prompt = new ConstantString("> "); //$NON-NLS-1$
/** If the input is plugged or buffering. */
private boolean connected = false;
private boolean connected = false;
/** The current connexion (if any). */
private ReadingRunnable connexion;
private ReadingRunnable connexion;
/** The interrupted status for prompts. */
private boolean interrupted = false;
private boolean interrupted = false;
/** The last hint hint. */
private String hint;
private String hint;
/** The output for hints. */
private PrintStream output;
private PrintStream output;
// Locks
/** The lock for connexion and disconnexion of actual streams. */
@@ -100,18 +100,16 @@ public final class PluggableConsoleInput implements ConsoleInput {
closed = true;
}
/** Connect the given input stream to the input and output to the hints
* writing.
/** Connect the given input stream to the input and output to the hints writing.
*
* @param stream the input stream
* @param out the output for hints.
* @throws IOException if the input is already connected. */
public void connect(final InputStream stream,
final PrintStream out) throws IOException {
public void connect(final InputStream stream, final PrintStream out)
throws IOException {
synchronized (connexionLock) {
if (connected) {
throw new IOException(
"Input already connected to an input stream"); //$NON-NLS-1$
throw new IOException("Input already connected to an input stream"); //$NON-NLS-1$
}
output = out;
@@ -120,8 +118,8 @@ public final class PluggableConsoleInput implements ConsoleInput {
out.flush();
}
final InputStreamReader streamReader = new InputStreamReader(
stream, StandardCharsets.UTF_8);
final InputStreamReader streamReader = new InputStreamReader(stream,
StandardCharsets.UTF_8);
final BufferedReader reader = new BufferedReader(streamReader);
connexion = new ReadingRunnable(reader);
final Thread th = new Thread(connexion, "GCLC Socket - Read input"); //$NON-NLS-1$
@@ -218,11 +216,9 @@ public final class PluggableConsoleInput implements ConsoleInput {
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String,
* long) */
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, long) */
@Override
public String prompt(final String message,
final long timeout) throws IOException {
public String prompt(final String message, final long timeout) throws IOException {
if (closed) {
throw new IOException();
}
@@ -240,8 +236,7 @@ public final class PluggableConsoleInput implements ConsoleInput {
long time = System.currentTimeMillis() - tic;
while (res == null && !interrupted && time < timeout) {
try {
res = waitMessageOrConnexion(timeout - time,
(timeout - time) / TENTH);
res = waitMessageOrConnexion(timeout - time, (timeout - time) / TENTH);
} catch (final InterruptedException e) {
LOGGER.log(Level.FINE, "Interruption of thread", e); //$NON-NLS-1$
Thread.currentThread().interrupt();
@@ -255,26 +250,25 @@ public final class PluggableConsoleInput implements ConsoleInput {
return res;
}
@Override
public void setPrompt(String prompt) {
setPrompt(new ConstantString(prompt));
}
@Override
public void setPrompt(final StringProvider prompt) {
this.prompt = prompt;
}
@Override
public void setPrompt(String prompt) {
setPrompt(new ConstantString(prompt));
}
/** Wait for a hint or connexion.
/** Wait for a hint or connection.
*
* @param messageTimeout the timeout on the current connexion hint waiting
* @param connexionTimeout the timeout on the new connexion wait
* @param messageTimeout the timeout on the current connection hint waiting
* @param connexionTimeout the timeout on the new connection wait
* @return the hint, or null if not connected or timed out.
* @throws IOException if the reading failed.
* @throws InterruptedException if the wait was interrupted */
private String waitMessageOrConnexion(final long messageTimeout,
final long connexionTimeout) throws IOException,
InterruptedException {
final long connexionTimeout) throws IOException, InterruptedException {
synchronized (connexionLock) {
if (connected) {
return connexion.getNextMessage(messageTimeout);

View File

@@ -50,16 +50,17 @@ import net.bigeon.gclc.manager.ConsoleOutput;
public final class PluggableConsoleOutput implements ConsoleOutput {
/** The actual output. */
private PrintStream out;
private PrintStream out;
/** The buffered messages. */
private final Deque<String> messages = new ArrayDeque<>();
/** If this output is closed. */
private boolean closed = false;
private boolean closed = false;
/** Default constructor. */
public PluggableConsoleOutput() {
//
}
/* (non-Javadoc)
* @see java.lang.AutoCloseable#close() */
@Override

View File

@@ -57,16 +57,16 @@ public final class RemoteDisconnectCommand<T> extends Command {
private final ConnexionManager<T> manager;
/** If all connexion should be disconnected when no argument have been
* specified. */
private final boolean all;
private final boolean all;
/** Create the disconnection command.
*
* @param name the command name
* @param manager the manager
* @param all if all elements should be disconnected when no argument is
* provided */
public RemoteDisconnectCommand(final String name,
final ConnexionManager<T> manager, final boolean all) {
* provided */
public RemoteDisconnectCommand(final String name, final ConnexionManager<T> manager,
final boolean all) {
super(name);
this.manager = manager;
this.all = all;
@@ -74,11 +74,10 @@ public final class RemoteDisconnectCommand<T> extends Command {
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
final String... args) throws CommandRunException {
if (args.length == 0 && all) {
final Collection<String> coll = manager.getConnected();
for (final String string : coll) {
@@ -89,8 +88,8 @@ public final class RemoteDisconnectCommand<T> extends Command {
if (manager.isConnected(string)) {
manager.disconnect(string);
} else {
print(out, MessageFormat
.format("[WARNING] {0} is not connected", string)); //$NON-NLS-1$
print(out,
MessageFormat.format("[WARNING] {0} is not connected", string)); //$NON-NLS-1$
}
}
}
@@ -99,16 +98,14 @@ public final class RemoteDisconnectCommand<T> extends Command {
*
* @param out the output
* @param string the message
* @throws CommandRunException if the output exists but cannot be printed
* to */
private void print(final ConsoleOutput out,
final String string) throws CommandRunException {
* @throws CommandRunException if the output exists but cannot be printed to */
private static void print(final ConsoleOutput out, final String string)
throws CommandRunException {
if (out != null) {
try {
out.println(string);
} catch (final IOException e) {
throw new CommandRunException(
CommandRunExceptionType.INTERACTION,
throw new CommandRunException(CommandRunExceptionType.INTERACTION,
"Unable to print to existing output", e); //$NON-NLS-1$
}
}
@@ -123,12 +120,11 @@ public final class RemoteDisconnectCommand<T> extends Command {
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@SuppressWarnings("nls")
@Override
protected String usageDetail() {
return MessageFormat.format(
" If arguments are provided the corresponding connexions are closed, " +
"otherwise{0}{1} are.",
" If arguments are provided the corresponding connexions are closed, "
+ "otherwise{0}{1} are.",
System.lineSeparator(), all ? "all connexions" : "none");
}
}

View File

@@ -64,31 +64,30 @@ import net.bigeon.gclc.ConsoleApplication;
public final class SocketConsoleApplicationShell implements Runnable {
/** The class logger. */
private static final Logger LOGGER = Logger
private static final Logger LOGGER = Logger
.getLogger(SocketConsoleApplicationShell.class.getName());
/** The listening port. */
private final int port;
private final int port;
/** The running status. */
private boolean running;
private boolean running;
/** The socket console interface. */
private SocketConsoleInterface sci;
private SocketConsoleInterface sci;
/** The remote disconnection command. */
private ConnexionManager<Socket> rdc;
/** The application. */
private ConsoleApplication app;
private ConsoleApplication app;
/** The server socket. */
private ServerSocket serverSocket;
private ServerSocket serverSocket;
/** THe server address. */
private final InetAddress addr;
/** Create a socket application shell which will listen on the given port
* and network interface.
/** Create a socket application shell which will listen on the given port and
* network interface.
*
* @param port the part
* @param addr the inet address */
public SocketConsoleApplicationShell(final int port,
final InetAddress addr) {
public SocketConsoleApplicationShell(final int port, final InetAddress addr) {
super();
this.port = port;
this.addr = addr;
@@ -110,9 +109,9 @@ public final class SocketConsoleApplicationShell implements Runnable {
}
/** If the port provided was 0, this allows to get the actual port.
*
* @return the local port
* @see java.net.ServerSocket#getLocalPort()
*/
* @see java.net.ServerSocket#getLocalPort() */
public int getLocalPort() {
return serverSocket.getLocalPort();
}
@@ -122,16 +121,14 @@ public final class SocketConsoleApplicationShell implements Runnable {
@Override
public void run() {
// Create the server
try (ServerSocket actualServerSocket = new ServerSocket(port, 1,
addr)) {
try (ServerSocket actualServerSocket = new ServerSocket(port, 1, addr)) {
serverSocket = actualServerSocket;
running = true;
// Create the streams
runSokectServer();
} catch (final IOException e) {
LOGGER.severe("Communication error between client and server"); //$NON-NLS-1$
LOGGER.log(Level.FINE,
"Communication error between client and server", e); //$NON-NLS-1$
LOGGER.log(Level.FINE, "Communication error between client and server", e); //$NON-NLS-1$
}
}
@@ -141,7 +138,7 @@ public final class SocketConsoleApplicationShell implements Runnable {
private void runSokectServer() throws IOException {
while (running && app.isRunning()) {
LOGGER.info("Waiting client"); //$NON-NLS-1$
try (Socket clientSocket = serverSocket.accept();) {
try (Socket clientSocket = serverSocket.accept()) {
sci.connect(clientSocket);

View File

@@ -48,7 +48,7 @@ import java.nio.charset.StandardCharsets;
public final class SocketConsoleInterface {
/** The application's input. */
private final PluggableConsoleInput input;
private final PluggableConsoleInput input;
/** The application's output. */
private final PluggableConsoleOutput output;
@@ -57,7 +57,7 @@ public final class SocketConsoleInterface {
* @param input the input
* @param output the output */
public SocketConsoleInterface(final PluggableConsoleInput input,
final PluggableConsoleOutput output) {
final PluggableConsoleOutput output) {
super();
this.input = input;
this.output = output;
@@ -68,12 +68,10 @@ public final class SocketConsoleInterface {
* @param socket the socket
* @throws IOException if the connection failed */
public void connect(final Socket socket) throws IOException {
final PrintStream printStream = new PrintStream(
socket.getOutputStream(), true,
final PrintStream printStream = new PrintStream(socket.getOutputStream(), true,
StandardCharsets.UTF_8.name());
output.connect(printStream);
input.connect(socket.getInputStream(),
printStream);
input.connect(socket.getInputStream(), printStream);
}
/** Disconnect the input and output of the application from the socket's. */

View File

@@ -0,0 +1,44 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
#%L
Generic Command Ligne console
%%
Copyright (C) 2014 - 2018 Bigeon
%%
This software is governed by the CeCILL license under French law and
abiding by the rules of distribution of free software. You can use,
modify and/ or redistribute the software under the terms of the CeCILL
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info".
As a counterpart to the access to the source code and rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty and the software's author, the holder of the
economic rights, and the successive licensors have only limited
liability.
In this respect, the user's attention is drawn to the risks associated
with loading, using, modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean that it is complicated to manipulate, and that also
therefore means that it is reserved for developers and experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or
data to be ensured and, more generally, to use and operate it in the
same conditions as regards security.
The fact that you are presently reading this means that you have had
knowledge of the CeCILL license and that you accept its terms.
#L%
-->
<project name="GCLC">
<bannerRight>
<src>https://bigeon.net/images/logo_48.png</src>
<href>https://bigeon.net/</href>
</bannerRight>
<body>
<menu ref="reports"/>
</body>
</project>

View File

@@ -39,14 +39,12 @@ import java.util.Collection;
import net.bigeon.gclc.ConsoleApplication;
import net.bigeon.gclc.command.Command;
import net.bigeon.gclc.command.HelpExecutor;
import net.bigeon.gclc.command.base.ExitCommand;
import net.bigeon.gclc.command.base.HelpExecutor;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.InvalidCommandName;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
import net.bigeon.gclc.socket.ConnexionManager;
import net.bigeon.gclc.socket.RemoteDisconnectCommand;
/** A test-purpose application
*
@@ -64,13 +62,10 @@ public class ConsoleTestApplication {
* @return create the application */
@SuppressWarnings("nls")
public static ConsoleApplication create(final ConsoleOutput output,
final ConsoleInput input,
final ConnexionManager<Socket> manager) {
final ConsoleInput input, final ConnexionManager<Socket> manager) {
try {
final ConsoleApplication application = new ConsoleApplication(
output, input,
"Welcome to the test application. Type help or test.",
"See you");
final ConsoleApplication application = new ConsoleApplication(output, input,
"Welcome to the test application. Type help or test.", "See you");
application.add(new ExitCommand(EXIT, application) {
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ExitCommand#beforeExit() */
@@ -82,8 +77,7 @@ public class ConsoleTestApplication {
}
}
});
application
.add(new HelpExecutor("help", application.root));
application.add(new HelpExecutor("help", application.root));
application.add(new Command("test") {
/* (non-Javadoc)
@@ -91,9 +85,8 @@ public class ConsoleTestApplication {
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out,
final ConsoleInput in,
final String... args) throws CommandRunException {
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
try {
output.println("Test command ran fine");
} catch (final IOException e) {
@@ -107,8 +100,7 @@ public class ConsoleTestApplication {
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail()
*/
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
// TODO Auto-generated method stub
@@ -123,11 +115,13 @@ public class ConsoleTestApplication {
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out,
final ConsoleInput in,
final String... args) throws CommandRunException {
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
try {
Thread.sleep(2000);
Object obj = new Object();
synchronized (obj) {
obj.wait(2000);
}
output.println("Test command ran fine");
} catch (IOException | InterruptedException e) {
throw new CommandRunException("manager closed", e);
@@ -140,8 +134,7 @@ public class ConsoleTestApplication {
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail()
*/
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
// TODO Auto-generated method stub
@@ -149,8 +142,7 @@ public class ConsoleTestApplication {
throw new RuntimeException("Not implemented yet");
}
});
application.add(
new RemoteDisconnectCommand<>("out", manager, true));
application.add(new RemoteDisconnectCommand<>("out", manager, true));
return application;
} catch (final InvalidCommandName e) {
e.printStackTrace();

View File

@@ -39,6 +39,7 @@ package net.bigeon.gclc.socket;
*/
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
@@ -46,11 +47,10 @@ import java.io.IOException;
import java.io.PipedInputStream;
import java.io.PipedOutputStream;
import java.io.PrintStream;
import java.util.concurrent.atomic.AtomicReference;
import org.junit.Test;
import net.bigeon.gclc.socket.PluggableConsoleInput;
/**
* <p>
* TODO
@@ -90,7 +90,10 @@ public class PluggableConsoleInputTest {
}
try {
Thread.sleep(100);
Object obj = new Object();
synchronized (obj) {
obj.wait(100);
}
} catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
@@ -112,7 +115,10 @@ public class PluggableConsoleInputTest {
@Override
public void run() {
try {
Thread.sleep(200);
Object obj = new Object();
synchronized (obj) {
obj.wait(200);
}
} catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
@@ -135,11 +141,11 @@ public class PluggableConsoleInputTest {
input.disconnect();
try (final PipedInputStream pis = new PipedInputStream();
final PipedOutputStream pos = new PipedOutputStream();
final PipedInputStream inner = new PipedInputStream(pos);
final PipedOutputStream innerPos = new PipedOutputStream(pis);
final PrintStream testIn = new PrintStream(innerPos, true, "UTF8");
final PrintStream out = new PrintStream(pos)) {
final PipedOutputStream pos = new PipedOutputStream();
final PipedInputStream inner = new PipedInputStream(pos);
final PipedOutputStream innerPos = new PipedOutputStream(pis);
final PrintStream testIn = new PrintStream(innerPos, true, "UTF8");
final PrintStream out = new PrintStream(pos)) {
input.connect(pis, out);
try {
input.connect(pis, out);
@@ -162,32 +168,40 @@ public class PluggableConsoleInputTest {
});
th.start();
while (!input.isPrompting()) {
Thread.sleep(10);
Object obj = new Object();
synchronized (obj) {
while (!input.isPrompting()) {
obj.wait(10);
}
}
input.connect(pis, out);
testIn.println("tac");
final AtomicReference<IOException> ref = new AtomicReference<>();
final Thread th2 = new Thread(new Runnable() {
@Override
public void run() {
try {
input.prompt("Test", 5000);
fail("Prompt should io");
// fail("Prompt should io");
} catch (final IOException e) {
// ok
ref.set(e);
}
}
});
th2.start();
while (!input.isPrompting()) {
Thread.sleep(10);
synchronized (obj) {
while (!input.isPrompting()) {
obj.wait(10);
}
}
input.close();
th2.join();
assertNotNull("Prompt should io", ref.get());
}
}

View File

@@ -46,8 +46,6 @@ import java.io.IOException;
import org.junit.Test;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.socket.DConnexionManager;
import net.bigeon.gclc.socket.RemoteDisconnectCommand;
import net.bigeon.gclc.utils.PipedConsoleOutput;
/**
@@ -65,10 +63,10 @@ public class RemoteDisconnectCommandTest {
@Test
public final void testExecute() throws CommandRunException, IOException {
final DConnexionManager<String> manager = new DConnexionManager<>();
final RemoteDisconnectCommand<String> cmd = new RemoteDisconnectCommand<>(
"quit", manager, true);
final RemoteDisconnectCommand<String> cmd2 = new RemoteDisconnectCommand<>(
"quit", manager, false);
final RemoteDisconnectCommand<String> cmd = new RemoteDisconnectCommand<>("quit",
manager, true);
final RemoteDisconnectCommand<String> cmd2 = new RemoteDisconnectCommand<>("quit",
manager, false);
manager.addConnexion("test");
cmd2.execute(null, null);

View File

@@ -48,12 +48,10 @@ import java.util.logging.Logger;
import org.junit.Test;
import net.bigeon.gclc.socket.SocketConsoleApplicationShell;
/** Test class for {@link SocketConsoleApplicationShell}
*
* @author Emmanuel Bigeon */
@SuppressWarnings({"static-method", "javadoc", "nls"})
@SuppressWarnings({ "static-method", "javadoc", "nls" })
public class SocketConsoleApplicationTest {
private static final Logger LOGGER = Logger
@@ -62,12 +60,12 @@ public class SocketConsoleApplicationTest {
/** @param in the input
* @return the string
* @throws IOException if the input reading failed */
private String consumeToPrompt(final String server,
final BufferedReader in) throws IOException {
private String consumeToPrompt(final String server, final BufferedReader in)
throws IOException {
String fromServer = server;
LOGGER.fine("Server: \n" + fromServer);
while (fromServer != null && !fromServer.equals("Bye.") &&
!fromServer.equals("> ")) {
while (fromServer != null && !fromServer.equals("Bye.")
&& !fromServer.equals("> ")) {
fromServer = in.readLine();
LOGGER.fine("Server: \n" + fromServer);
}
@@ -78,19 +76,17 @@ public class SocketConsoleApplicationTest {
public void testIntegration() throws IOException, InterruptedException {
Thread server;
server = TestServer.getServer();
Thread.sleep(1000);
final String hostName = "127.0.0.1";
final int portNumber = 3300;
try (Socket kkSocket = new Socket(hostName, portNumber);
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(),
true);
BufferedReader in = new BufferedReader(
new InputStreamReader(kkSocket.getInputStream()));) {
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(), true);
BufferedReader in = new BufferedReader(
new InputStreamReader(kkSocket.getInputStream()));) {
String fromServer;
int i = -1;
final String[] cmds = {"help", "toto", "test", "out"};
final String[] cmds = { "help", "toto", "test", "out" };
while ((fromServer = in.readLine()) != null) {
i++;
fromServer = consumeToPrompt(fromServer, in);
@@ -108,15 +104,13 @@ public class SocketConsoleApplicationTest {
}
try (Socket kkSocket = new Socket(hostName, portNumber);
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(),
true);
BufferedReader in = new BufferedReader(
new InputStreamReader(kkSocket.getInputStream()));) {
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(), true);
BufferedReader in = new BufferedReader(
new InputStreamReader(kkSocket.getInputStream()));) {
String fromServer;
int i = 0;
final String[] cmds = {"help", "toto", "test",
ConsoleTestApplication.EXIT};
final String[] cmds = { "help", "toto", "test", ConsoleTestApplication.EXIT };
while ((fromServer = in.readLine()) != null) {
fromServer = consumeToPrompt(fromServer, in);
if (fromServer == null || fromServer.equals("Bye.")) {
@@ -131,26 +125,20 @@ public class SocketConsoleApplicationTest {
}
i++;
}
assertEquals("Application exit command should close connection", 4,
i);
assertEquals("Application exit command should close connection", 4, i);
}
Thread.sleep(100);
TestServer.closeServer();
server.join();
server = TestServer.getServer();
Thread.sleep(1000);
try (Socket kkSocket = new Socket(hostName, portNumber);
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(),
true);
BufferedReader in = new BufferedReader(
new InputStreamReader(kkSocket.getInputStream()));) {
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(), true);
BufferedReader in = new BufferedReader(
new InputStreamReader(kkSocket.getInputStream()));) {
String fromServer;
int i = 0;
final String[] cmds = {"help", "toto", "test",
ConsoleTestApplication.EXIT};
final String[] cmds = { "help", "toto", "test", ConsoleTestApplication.EXIT };
while ((fromServer = in.readLine()) != null) {
fromServer = consumeToPrompt(fromServer, in);
if (fromServer == null || fromServer.equals("Bye.")) {
@@ -164,8 +152,7 @@ public class SocketConsoleApplicationTest {
}
i++;
}
assertEquals("Application exit command should close connection", 4,
i);
assertEquals("Application exit command should close connection", 4, i);
}
TestServer.closeServer();
server.join();

View File

@@ -44,9 +44,8 @@ import java.util.Collection;
import net.bigeon.smu.StringEncoder;
/** TODO Describe TestConsoleClient.java
* @author Emmanuel Bigeon
*
*/
* @author Emmanuel Bigeon */
@SuppressWarnings("nls")
public class TestConsoleClient {
@SuppressWarnings("javadoc")
@@ -56,8 +55,7 @@ public class TestConsoleClient {
}
@SuppressWarnings("javadoc")
private static final StringEncoder ENCODER = new StringEncoder("%",
TO_ENCODE);
private static final StringEncoder ENCODER = new StringEncoder("%", TO_ENCODE);
@SuppressWarnings("javadoc")
public static void main(String[] args) {
@@ -65,10 +63,9 @@ public class TestConsoleClient {
final int portNumber = 3300;
try (Socket kkSocket = new Socket(hostName, portNumber);
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(),
true);
BufferedReader in = new BufferedReader(new InputStreamReader(
kkSocket.getInputStream()));) {
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(), true);
BufferedReader in = new BufferedReader(
new InputStreamReader(kkSocket.getInputStream()));) {
String fromServer;
while ((fromServer = in.readLine()) != null) {

View File

@@ -39,24 +39,18 @@ import java.net.Socket;
import java.net.UnknownHostException;
import net.bigeon.gclc.ConsoleApplication;
import net.bigeon.gclc.socket.ConnexionManager;
import net.bigeon.gclc.socket.DConnexionManager;
import net.bigeon.gclc.socket.PluggableConsoleInput;
import net.bigeon.gclc.socket.PluggableConsoleOutput;
import net.bigeon.gclc.socket.SocketConsoleApplicationShell;
import net.bigeon.gclc.socket.SocketConsoleInterface;
/** A test server
*
* @author Emmanuel Bigeon */
@SuppressWarnings({"javadoc", "nls"})
@SuppressWarnings({ "javadoc", "nls" })
public class TestServer {
private static SocketConsoleApplicationShell SHELL;
private static ConnexionManager<Socket> manager;
private static ConnexionManager<Socket> manager;
private static Thread server;
private static PluggableConsoleInput input;
private static Thread server;
private static PluggableConsoleInput input;
private static PluggableConsoleOutput output;
public static synchronized void closeServer() {
@@ -83,8 +77,8 @@ public class TestServer {
manager = new DConnexionManager<>();
SHELL = new SocketConsoleApplicationShell(3300,
InetAddress.getByName("127.0.0.1"));
final ConsoleApplication app = ConsoleTestApplication
.create(output, input, manager);
final ConsoleApplication app = ConsoleTestApplication.create(output, input,
manager);
SHELL.setInterface(new SocketConsoleInterface(input, output));
SHELL.setConnexionManager(manager);
SHELL.setApplication(app);
@@ -96,6 +90,16 @@ public class TestServer {
}
});
th.start();
try {
Object waiting = new Object();
synchronized (waiting) {
while (!input.isPrompting()) {
waiting.wait(50);
}
}
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
}
}
return SHELL;
}

View File

@@ -42,7 +42,7 @@
<parent>
<groupId>net.bigeon.config</groupId>
<artifactId>swt-config</artifactId>
<version>1.8.5</version>
<version>1.8.9</version>
</parent>
<properties>
@@ -55,7 +55,7 @@
<dependency>
<groupId>net.bigeon</groupId>
<artifactId>gclc</artifactId>
<version>2.0.7</version>
<version>2.0.9</version>
</dependency>
<dependency>
<groupId>net.bigeon</groupId>
@@ -73,11 +73,6 @@
</licenses>
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.3</version>
</plugin>
<plugin>
<groupId>com.github.sevntu-checkstyle</groupId>
<artifactId>dsm-maven-plugin</artifactId>

View File

@@ -77,6 +77,7 @@ package net.bigeon.gclc.swt;
* @author Emmanuel Bigeon */
public interface ConsoleDelayIO {
/** Get the input text.
*
* @return the non validated input */
String getInput();

View File

@@ -81,13 +81,13 @@ import net.bigeon.collections.Ribbon;
public final class HistoryTextKeyListener extends KeyAdapter {
/** The size of commands history. */
private static final int DEFAULT_HISTORY_SIZE = 10;
private static final int DEFAULT_HISTORY_SIZE = 10;
/** The empty string constant. */
private static final String EMPTY = ""; //$NON-NLS-1$
private static final String EMPTY = ""; //$NON-NLS-1$
/** The history ribbon. */
private final Ribbon<String> commands;
/** The current index in history search. */
private int currentIndex = 0;
private int currentIndex = 0;
/** The console to notify of command validation. */
private final ConsoleDelayIO console;
@@ -123,8 +123,7 @@ public final class HistoryTextKeyListener extends KeyAdapter {
}
// Upper arrow retrieves previous commands
if (keyCode == SWT.ARROW_UP &&
currentIndex < commands.size() - 1) {
if (keyCode == SWT.ARROW_UP && currentIndex < commands.size() - 1) {
currentIndex++;
final String cmd = commands.get(commands.size() - currentIndex - 1);
console.setInput(cmd);
@@ -136,8 +135,7 @@ public final class HistoryTextKeyListener extends KeyAdapter {
currentIndex--;
console.setInput(EMPTY);
} else if (currentIndex > 0) {
final String cmd = commands
.get(commands.size() - (--currentIndex) - 1);
final String cmd = commands.get(commands.size() - (--currentIndex) - 1);
console.setInput(cmd);
}
}

View File

@@ -309,8 +309,8 @@ public final class SWTConsole extends Composite
promptLock.notifyAll();
final long start = System.currentTimeMillis();
long cur = start;
while (prompting && start + timeout>cur) {
promptLock.wait((cur-start-timeout)/2);
while (prompting && start + timeout > cur) {
promptLock.wait((cur - start - timeout) / 2);
cur = System.currentTimeMillis();
}
} catch (final InterruptedException e) {
@@ -397,6 +397,11 @@ public final class SWTConsole extends Composite
consoleInput.setSelection(input.length());
}
@Override
public void setPrompt(String prompt) {
setPrompt(new ConstantString(prompt));
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#setPrompt(java.lang.String) */
@Override
@@ -415,11 +420,6 @@ public final class SWTConsole extends Composite
});
}
@Override
public void setPrompt(String prompt) {
setPrompt(new ConstantString(prompt));
}
/** @param string the text */
public void setText(final String string) {
consoleInput.setText(string);

View File

@@ -92,8 +92,7 @@ public final class SWTConsoleView extends Composite implements ConsoleDelayIO {
/** The local implementation of the forwarding runnable
*
* @author Emmanuel Bigeon */
private final class ToSWTConsoleForwardRunnable
extends AOutputForwardRunnable {
private final class ToSWTConsoleForwardRunnable extends AOutputForwardRunnable {
/** The running status */
private boolean running = true;
@@ -119,14 +118,14 @@ public final class SWTConsoleView extends Composite implements ConsoleDelayIO {
}
/** The class logger */
private static final Logger LOGGER = Logger
private static final Logger LOGGER = Logger
.getLogger(SWTConsoleView.class.getName());
/** The console output text field */
private final Text consoleOutput;
private final Text consoleOutput;
/** The console input text field */
private final Text consoleInput;
private final Text consoleInput;
/** The input. */
private PipedConsoleInput input;
private PipedConsoleInput input;
/** The forwarding runnable */
private ToSWTConsoleForwardRunnable forward;
@@ -139,15 +138,13 @@ public final class SWTConsoleView extends Composite implements ConsoleDelayIO {
setLayout(new GridLayout(1, false));
consoleOutput = new Text(this, SWT.BORDER | SWT.READ_ONLY | SWT.WRAP |
SWT.V_SCROLL | SWT.MULTI);
consoleOutput.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true,
1, 1));
consoleOutput = new Text(this,
SWT.BORDER | SWT.READ_ONLY | SWT.WRAP | SWT.V_SCROLL | SWT.MULTI);
consoleOutput.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true, 1, 1));
consoleOutput.setRedraw(true);
consoleInput = new Text(this, SWT.BORDER);
consoleInput.setLayoutData(
new GridData(SWT.FILL, SWT.CENTER, true, false, 1, 1));
consoleInput.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false, 1, 1));
consoleInput.addKeyListener(new HistoryTextKeyListener(this));
}
@@ -194,7 +191,7 @@ public final class SWTConsoleView extends Composite implements ConsoleDelayIO {
* @param manager the output to set
* @param input the input */
public void setManager(final PipedConsoleOutput manager,
final PipedConsoleInput input) {
final PipedConsoleInput input) {
this.input = input;
if (forward != null) {
forward.setRunning(false);

View File

@@ -0,0 +1,44 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
#%L
Generic Command Ligne console
%%
Copyright (C) 2014 - 2018 Bigeon
%%
This software is governed by the CeCILL license under French law and
abiding by the rules of distribution of free software. You can use,
modify and/ or redistribute the software under the terms of the CeCILL
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info".
As a counterpart to the access to the source code and rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty and the software's author, the holder of the
economic rights, and the successive licensors have only limited
liability.
In this respect, the user's attention is drawn to the risks associated
with loading, using, modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean that it is complicated to manipulate, and that also
therefore means that it is reserved for developers and experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or
data to be ensured and, more generally, to use and operate it in the
same conditions as regards security.
The fact that you are presently reading this means that you have had
knowledge of the CeCILL license and that you accept its terms.
#L%
-->
<project name="GCLC">
<bannerRight>
<src>https://bigeon.net/images/logo_48.png</src>
<href>https://bigeon.net/</href>
</bannerRight>
<body>
<menu ref="reports"/>
</body>
</project>

View File

@@ -73,10 +73,8 @@ import static org.junit.Assert.assertEquals;
import org.eclipse.swt.SWT;
import org.junit.Test;
import net.bigeon.gclc.swt.ConsoleDelayIO;
import net.bigeon.gclc.swt.HistoryTextKeyListener;
/** <p>
/**
* <p>
* TODO
*
* @author Emmanuel Bigeon */
@@ -90,8 +88,8 @@ public class HistoryTextKeyListenerTest {
private String input = "";
@Override
public void validateInput() {
input = "";
public String getInput() {
return input;
}
@Override
@@ -100,8 +98,8 @@ public class HistoryTextKeyListenerTest {
}
@Override
public String getInput() {
return input;
public void validateInput() {
input = "";
}
};
HistoryTextKeyListener listener = new HistoryTextKeyListener(io);

View File

@@ -85,27 +85,25 @@ import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.InvalidCommandName;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
import net.bigeon.gclc.swt.SWTConsole;
import net.bigeon.gclc.swt.SWTConsoleShell;
/**
* <p>
* TODO
*
* @author Emmanuel Bigeon */
@SuppressWarnings({"javadoc", "static-method", "nls", "deprecation"})
@SuppressWarnings({ "javadoc", "static-method", "nls", "deprecation" })
public class SWTConsoleShellTest {
protected static final long TWO_SECONDS = 2000;
private static final Display DISPLAY = Display.getDefault();
protected static final long TWO_SECONDS = 2000;
private static final Display DISPLAY = Display.getDefault();
@Test
public void test() {
final SWTConsoleShell shell = new SWTConsoleShell(DISPLAY);
final SWTConsole swtConsole = shell.getManager();
try {
final ConsoleApplication appl = new ConsoleApplication(swtConsole,
swtConsole, "Hello", "See you");
final ConsoleApplication appl = new ConsoleApplication(swtConsole, swtConsole,
"Hello", "See you");
appl.add(new ExitCommand("exit", appl));
appl.add(new Command("long") {
@@ -114,9 +112,8 @@ public class SWTConsoleShellTest {
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out,
final ConsoleInput in,
final String... args) throws CommandRunException {
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
try {
Thread.sleep(TWO_SECONDS);
} catch (final InterruptedException e) {
@@ -139,7 +136,7 @@ public class SWTConsoleShellTest {
throw new RuntimeException("Not implemented yet");
}
});
// shell.pack();
// shell.pack();
shell.open();
final Thread applThread = new Thread(new Runnable() {
@@ -186,7 +183,7 @@ public class SWTConsoleShellTest {
DISPLAY.sleep();
}
}
// DISPLAY.dispose();
// DISPLAY.dispose();
assertTrue(swtConsole.isClosed());
Thread.sleep(TWO_SECONDS);
assertFalse(appl.isRunning());
@@ -206,8 +203,8 @@ public class SWTConsoleShellTest {
swtConsole.close();
swtConsole.setPrompt(":");
try {
final ConsoleApplication appl = new ConsoleApplication(swtConsole,
swtConsole, "Hello", "See you");
final ConsoleApplication appl = new ConsoleApplication(swtConsole, swtConsole,
"Hello", "See you");
appl.add(new ExitCommand("exit", appl));
appl.add(new Command("long") {
/* (non-Javadoc)
@@ -215,9 +212,8 @@ public class SWTConsoleShellTest {
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out,
final ConsoleInput in,
final String... args) throws CommandRunException {
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
try {
Thread.sleep(TWO_SECONDS);
} catch (final InterruptedException e) {
@@ -246,9 +242,8 @@ public class SWTConsoleShellTest {
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out,
final ConsoleInput in,
final String... args) throws CommandRunException {
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
try {
swtConsole.prompt("Test");
} catch (final IOException e) {
@@ -270,7 +265,7 @@ public class SWTConsoleShellTest {
throw new RuntimeException("Not implemented yet");
}
});
// shell.pack();
// shell.pack();
shell.open();
final Thread applThread = new Thread(new Runnable() {
@@ -353,7 +348,7 @@ public class SWTConsoleShellTest {
} catch (final IOException e) {
assertNotNull(e);
}
// DISPLAY.dispose();
// DISPLAY.dispose();
assertTrue(swtConsole.isClosed());
Thread.sleep(TWO_SECONDS);
assertFalse(appl.isRunning());

View File

@@ -84,45 +84,45 @@ import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.InvalidCommandName;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
import net.bigeon.gclc.swt.SWTConsoleView;
import net.bigeon.gclc.utils.PipedConsoleInput;
import net.bigeon.gclc.utils.PipedConsoleOutput;
/** <p>
/**
* <p>
* TODO
*
* @author Emmanuel Bigeon */
@SuppressWarnings({"javadoc", "static-method", "nls", "deprecation"})
@SuppressWarnings({ "javadoc", "static-method", "nls", "deprecation" })
public class SWTConsoleViewTest {
protected static final long TWO_SECONDS = 2000;
private static final Display DISPLAY = Display.getDefault();
protected static final long TWO_SECONDS = 2000;
private static final Display DISPLAY = Display.getDefault();
@Test
public void test() {
final Shell shell = new Shell(DISPLAY);
final SWTConsoleView swtConsole = new SWTConsoleView(shell, SWT.NONE);
try (PipedConsoleOutput manager = new PipedConsoleOutput();
PipedConsoleInput input = new PipedConsoleInput(System.out)) {
PipedConsoleInput input = new PipedConsoleInput(System.out)) {
swtConsole.setManager(manager, input);
} catch (final IOException e2) {
assertNull(e2);
}
try (PipedConsoleOutput manager = new PipedConsoleOutput();
PipedConsoleInput input = new PipedConsoleInput(System.out)) {
PipedConsoleInput input = new PipedConsoleInput(System.out)) {
swtConsole.setManager(manager, input);
final ConsoleApplication appl = new ConsoleApplication(manager,
input,
final ConsoleApplication appl = new ConsoleApplication(manager, input,
"Hello", "See you");
appl.add(new ExitCommand("exit", appl));
appl.add(new Command("long") {
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[])
*/
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
final String... args) throws CommandRunException {
try {
Thread.sleep(TWO_SECONDS);
} catch (final InterruptedException e) {
@@ -145,7 +145,7 @@ public class SWTConsoleViewTest {
throw new RuntimeException("Not implemented yet");
}
});
// shell.pack();
// shell.pack();
shell.open();
final Thread applThread = new Thread(new Runnable() {

View File

@@ -15,16 +15,10 @@
</plugins>
</build>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.11</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>net.bigeon</groupId>
<artifactId>gclc</artifactId>
<version>2.0.7</version>
<version>2.0.9</version>
</dependency>
</dependencies>
<name>GCLC system command</name>
@@ -40,11 +34,6 @@
</licenses>
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.3</version>
</plugin>
<plugin>
<groupId>com.github.sevntu-checkstyle</groupId>
<artifactId>dsm-maven-plugin</artifactId>
@@ -70,6 +59,6 @@
<parent>
<groupId>net.bigeon.config</groupId>
<artifactId>ebigeon-config</artifactId>
<version>1.8.4</version>
<version>1.8.12</version>
</parent>
</project>

View File

@@ -56,32 +56,35 @@ import net.bigeon.gclc.manager.ConsoleOutput;
* @author Emmanuel Bigeon */
public class ExecSystemCommand extends Command {
/** Error message for the manager closed. */
private static final String MANAGER_WAS_CLOSED = "manager was closed";
/** The command default name */
private static final String COMMAND_DEFAULT_NAME = "exec"; //$NON-NLS-1$
private static final String COMMAND_DEFAULT_NAME = "exec"; //$NON-NLS-1$
/** The end of line separator */
private static final String EOL = System.lineSeparator();
private static final String EOL = System.lineSeparator();
/** The class logger */
private static final Logger LOGGER = Logger
private static final Logger LOGGER = Logger
.getLogger(ExecSystemCommand.class.getName());
/***/
/** Create the command with the name 'exec'. */
public ExecSystemCommand() {
super(COMMAND_DEFAULT_NAME);
}
/** @param name the name of the command (the input from the manager that
* should trigger this command) */
/** Create the command with a custom name.
*
* @param name the name of the command (the input from the manager that should
* trigger this command) */
public ExecSystemCommand(final String name) {
super(name);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
final String... args) throws CommandRunException {
Process proc;
try {
proc = Runtime.getRuntime().exec(args);
@@ -90,19 +93,16 @@ public class ExecSystemCommand extends Command {
return;
}
final InputStream is = proc
.getInputStream();
final InputStream is = proc.getInputStream();
final Thread th = new Thread(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
try {
readToEnd(out, is);
is.close();
} catch (final CommandRunException e) {
LOGGER.log(Level.WARNING,
"Manager was closed in the meantime...", e); //$NON-NLS-1$
LOGGER.log(Level.WARNING, "Manager was closed in the meantime...", e); //$NON-NLS-1$
} catch (final IOException e) {
LOGGER.log(Level.WARNING, "Input stream was closed...", e); //$NON-NLS-1$
}
@@ -111,46 +111,47 @@ public class ExecSystemCommand extends Command {
th.start();
in.setPrompt(""); //$NON-NLS-1$
final OutputStream os = proc.getOutputStream();
try (BufferedWriter writer = new BufferedWriter(
new OutputStreamWriter(os))) {
try (BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(os))) {
while (th.isAlive()) {
String user;
try {
user = in.prompt();
} catch (final IOException e) {
throw new CommandRunException(
CommandRunExceptionType.INTERACTION,
"manager was closed", e); //$NON-NLS-1$
}
String user = in.prompt();
writer.write(user + EOL);
}
} catch (final IOException e1) {
throw new CommandRunException(CommandRunExceptionType.INTERACTION,
"manager was closed", e1); //$NON-NLS-1$
MANAGER_WAS_CLOSED, e1); // $NON-NLS-1$
}
}
/** @param is the input stream
* @throws CommandRunException if the manager was closed while writing the
* stream */
protected void readToEnd(final ConsoleOutput out,
final InputStream is) throws CommandRunException {
* stream */
protected void readToEnd(final ConsoleOutput out, final InputStream is)
throws CommandRunException {
int c;
try {
while ((c = is.read()) != -1) {
try {
out.print(Character.valueOf((char) c).toString());
} catch (final IOException e) {
throw new CommandRunException(
CommandRunExceptionType.INTERACTION,
"manager was closed", e); //$NON-NLS-1$
}
printCharacter(out, (char) c);
}
} catch (final IOException e) {
LOGGER.log(Level.INFO, "input stream reading failed", e); //$NON-NLS-1$
}
}
/** Print a character on the console.
*
* @param out the console
* @param c the character
* @throws CommandRunException if the console failed to print the character. */
private void printCharacter(final ConsoleOutput out, char c)
throws CommandRunException {
try {
out.print(Character.toString(c));
} catch (final IOException e) {
throw new CommandRunException(CommandRunExceptionType.INTERACTION,
MANAGER_WAS_CLOSED, e); // $NON-NLS-1$
}
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@Override
@@ -163,12 +164,11 @@ public class ExecSystemCommand extends Command {
@Override
protected String usageDetail() {
return " The system command is a system dependend command like sh on linux or" + //$NON-NLS-1$
System.lineSeparator() + "powershell on windows." + //$NON-NLS-1$
System.lineSeparator() + System.lineSeparator() +
" As an example if you give \"cat /etc/hostname\" as argument, on a linux" + //$NON-NLS-1$
System.lineSeparator() +
"system, you would get the computer name." + //$NON-NLS-1$
System.lineSeparator();
System.lineSeparator() + "powershell on windows." + //$NON-NLS-1$
System.lineSeparator() + System.lineSeparator()
+ " As an example if you give \"cat /etc/hostname\" as argument, on a linux" //$NON-NLS-1$
+ System.lineSeparator() + "system, you would get the computer name." + //$NON-NLS-1$
System.lineSeparator();
}
/* (non-Javadoc)

View File

@@ -0,0 +1,8 @@
/** This package contains classes for command execution on the system.
* <p>
* The class {@link net.bigeon.gclc.system.ExecSystemCommand} is, in the current
* version (0.0.1), a source of vulnerability and should probably be used only
* in private projects where the user is aware of the dangers.
*
* @author Emmanuel Bigeon */
package net.bigeon.gclc.system;

View File

@@ -0,0 +1,44 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
#%L
Generic Command Ligne console
%%
Copyright (C) 2014 - 2018 Bigeon
%%
This software is governed by the CeCILL license under French law and
abiding by the rules of distribution of free software. You can use,
modify and/ or redistribute the software under the terms of the CeCILL
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info".
As a counterpart to the access to the source code and rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty and the software's author, the holder of the
economic rights, and the successive licensors have only limited
liability.
In this respect, the user's attention is drawn to the risks associated
with loading, using, modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean that it is complicated to manipulate, and that also
therefore means that it is reserved for developers and experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or
data to be ensured and, more generally, to use and operate it in the
same conditions as regards security.
The fact that you are presently reading this means that you have had
knowledge of the CeCILL license and that you accept its terms.
#L%
-->
<project name="GCLC">
<bannerRight>
<src>https://bigeon.net/images/logo_48.png</src>
<href>https://bigeon.net/</href>
</bannerRight>
<body>
<menu ref="reports"/>
</body>
</project>

View File

@@ -2,7 +2,7 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<artifactId>gclc</artifactId>
<version>2.0.8-SNAPSHOT</version>
<version>2.0.10-SNAPSHOT</version>
<packaging>jar</packaging>
<url>http://bigeon.net</url>
<properties>
@@ -22,7 +22,7 @@
<parent>
<groupId>net.bigeon.config</groupId>
<artifactId>ebigeon-config</artifactId>
<version>1.8.3</version>
<version>1.8.12</version>
</parent>
<build>
<plugins>
@@ -47,16 +47,16 @@
</licenses>
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.3</version>
</plugin>
<plugin>
<groupId>com.github.sevntu-checkstyle</groupId>
<artifactId>dsm-maven-plugin</artifactId>
<version>2.2.0</version>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>jdepend-maven-plugin</artifactId>
<version>2.0</version>
</plugin>
</plugins>
</reporting>
<developers>

View File

@@ -71,9 +71,10 @@ package net.bigeon.gclc;
*/
import java.io.IOException;
import java.io.InterruptedIOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
@@ -88,9 +89,8 @@ import net.bigeon.gclc.i18n.Messages;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
/**
* A {@link ConsoleApplication} is an application that require the user to input
* commands.
/** A {@link ConsoleApplication} is an application that require the user to
* input commands.
* <p>
* A typical use case is the following:
*
@@ -111,22 +111,22 @@ import net.bigeon.gclc.manager.ConsoleOutput;
public final class ConsoleApplication implements ICommandProvider {
/** The class logger. */
private static final Logger LOGGER = Logger
private static final Logger LOGGER = Logger
.getLogger(ConsoleApplication.class.getName());
/** The welcome message. */
public final String header;
public final String header;
/** The good bye message. */
public final String footer;
public final String footer;
/** The standard output for the application. */
private final ConsoleOutput out;
private final ConsoleOutput out;
/** The standard input for the application. */
private final ConsoleInput in;
private final ConsoleInput in;
/** The container of commands. */
public final SubedCommand root;
public final SubedCommand root;
/** The state of this application. */
private boolean running;
private boolean running;
/** The listeners. */
private final List<CommandRequestListener> listeners = new ArrayList<>();
private final Set<CommandRequestListener> listeners = new LinkedHashSet<>();
/** Create a console application.
*
@@ -135,8 +135,7 @@ public final class ConsoleApplication implements ICommandProvider {
* @param welcome the welcoming message
* @param goodbye the goodbye message */
public ConsoleApplication(final ConsoleOutput out, final ConsoleInput in,
final String welcome,
final String goodbye) {
final String welcome, final String goodbye) {
header = welcome;
footer = goodbye;
this.in = in;
@@ -161,8 +160,7 @@ public final class ConsoleApplication implements ICommandProvider {
* java.lang.String[]) */
@Override
public void executeSub(final ConsoleOutput output, final ConsoleInput input,
final String command,
final String... args) throws CommandRunException {
final String command, final String... args) throws CommandRunException {
root.executeSub(output, input, command, args);
}
@@ -182,8 +180,8 @@ public final class ConsoleApplication implements ICommandProvider {
/** Interpret a command line.
* <p>
* This method will split the command in its part and execute the command
* with {@link #executeSub(ConsoleOutput, ConsoleInput, String, String...)}.
* This method will split the command in its part and execute the command with
* {@link #executeSub(ConsoleOutput, ConsoleInput, String, String...)}.
*
* @param cmd the command
* @throws IOException if the command could not be parsed */
@@ -191,19 +189,18 @@ public final class ConsoleApplication implements ICommandProvider {
List<String> args;
try {
args = GCLCConstants.splitCommand(cmd);
} catch (final CommandParsingException e1) {
} catch (final CommandParsingException e) {
out.println("Command line cannot be parsed"); //$NON-NLS-1$
LOGGER.log(Level.FINE, "Invalid user command " + cmd, e1); //$NON-NLS-1$
LOGGER.log(Level.FINE, "Invalid user command " + cmd, e); //$NON-NLS-1$
return;
}
if (!args.isEmpty()) {
try {
executeSub(out, in, args.get(0), Arrays.copyOfRange(
args.toArray(new String[0]), 1, args.size()));
executeSub(out, in, args.get(0),
Arrays.copyOfRange(args.toArray(new String[0]), 1, args.size()));
} catch (final CommandRunException e) {
LOGGER.log(Level.FINE, "Command failed: " + cmd, e); //$NON-NLS-1$
out.println(Messages
.getString("ConsoleApplication.cmd.failed", cmd)); //$NON-NLS-1$
out.println(Messages.getString("ConsoleApplication.cmd.failed", cmd)); //$NON-NLS-1$
out.println(e.getLocalizedMessage());
if (e.getType() == CommandRunExceptionType.USAGE) {
get(args.get(0)).help(out);
@@ -228,8 +225,8 @@ public final class ConsoleApplication implements ICommandProvider {
/** The running loop content.
* <p>
* This consisting in getting the command, executing it and exiting
* (restarting the loop). */
* This consisting in getting the command, executing it and exiting (restarting
* the loop). */
private void runLoop() {
try {
final String cmd = in.prompt();
@@ -241,8 +238,7 @@ public final class ConsoleApplication implements ICommandProvider {
}
interpretCommand(cmd);
} catch (final InterruptedIOException e) {
LOGGER.info(
"Prompt interrupted. It is likely the application is closing."); //$NON-NLS-1$
LOGGER.info("Prompt interrupted. It is likely the application is closing."); //$NON-NLS-1$
LOGGER.log(Level.FINER, "Interruption of the prompt.", //$NON-NLS-1$
e);
} catch (final IOException e) {
@@ -250,8 +246,7 @@ public final class ConsoleApplication implements ICommandProvider {
running = false;
LOGGER.warning(
"The console manager was closed. Closing the application as no one can reach it."); //$NON-NLS-1$
LOGGER.log(Level.FINE,
"An exception caused the closing of the application", //$NON-NLS-1$
LOGGER.log(Level.FINE, "An exception caused the closing of the application", //$NON-NLS-1$
e);
}
}
@@ -268,8 +263,7 @@ public final class ConsoleApplication implements ICommandProvider {
running = false;
LOGGER.warning(
"The console manager was closed. Closing the application as no one can reach it."); //$NON-NLS-1$
LOGGER.log(Level.FINE,
"An exception caused the closing of the application", //$NON-NLS-1$
LOGGER.log(Level.FINE, "An exception caused the closing of the application", //$NON-NLS-1$
e);
return;
}

View File

@@ -85,7 +85,7 @@ import net.bigeon.gclc.exception.CommandParsingException;
public final class GCLCConstants {
/** The escaping character. */
private static final char ESCAPING_CHAR = getSystemEscapingChar();
private static final char ESCAPING_CHAR = '\\';
/** Hide utility class constructor. */
private GCLCConstants() {
@@ -99,22 +99,15 @@ public final class GCLCConstants {
* @param index the index of the current position
* @return the argument
* @throws CommandParsingException if the end of string does not mark end of
* command and is not followed by a space */
* command and is not followed by a space */
private static String endOfString(final String cmd, final int startIndex,
final int index) throws CommandParsingException {
final int index) throws CommandParsingException {
if (index < cmd.length() && cmd.charAt(index) != ' ') {
throw new CommandParsingException("Misplaced quote"); //$NON-NLS-1$
}
return cmd.substring(startIndex + 1, index - 1);
}
/** Get the excaping character.
*
* @return the escaping character */
private static char getSystemEscapingChar() {
return '\\';
}
/** Remove escaping characters from the string.
*
* @param arg the string to remove excaping character from
@@ -137,7 +130,8 @@ public final class GCLCConstants {
* @param cmd the command to split in its parts
* @return the list of argument preceded by the command name
* @throws CommandParsingException if the parsing of the command failed */
public static List<String> splitCommand(final String cmd) throws CommandParsingException {
public static List<String> splitCommand(final String cmd)
throws CommandParsingException {
final List<String> args = new ArrayList<>();
// parse the string to separate arguments
int index = 0;
@@ -164,6 +158,8 @@ public final class GCLCConstants {
startIndex = index;
}
inString = startIndex == index - 1;
} else {
// No special processing
}
}
if (startIndex < cmd.length()) {

View File

@@ -68,7 +68,7 @@ public abstract class Command implements ICommand {
/** The linux end of line character. */
private static final String EOL_LINUX = "\n"; //$NON-NLS-1$
/** The name of the command. */
protected final String name;
protected final String name;
/** Create the command.
*
@@ -80,8 +80,8 @@ public abstract class Command implements ICommand {
/** Get the brief part of the command help.
* <p>
* This method may be overriden by implementations to improve the help
* content. The default behavior is to print the tip.
* This method may be overriden by implementations to improve the help content.
* The default behavior is to print the tip.
*
* @return a brief description of the command
* @see Command#help(ConsoleOutput, String...) */
@@ -112,8 +112,8 @@ public abstract class Command implements ICommand {
*
* @see net.bigeon.gclc.command.ICommand#help(ConsoleOutput, String...) */
@Override
public final void help(final ConsoleOutput manager,
final String... args) throws IOException {
public final void help(final ConsoleOutput manager, final String... args)
throws IOException {
manager.println(getCommandName());
manager.println(brief());
manager.println();
@@ -123,8 +123,8 @@ public abstract class Command implements ICommand {
final String details = usageDetail();
if (details != null && !details.isEmpty()) {
manager.print(details);
if (!(details.endsWith(EOL_LINUX) ||
details.endsWith(System.lineSeparator()))) {
if (!(details.endsWith(EOL_LINUX)
|| details.endsWith(System.lineSeparator()))) {
manager.println();
}
}

View File

@@ -43,6 +43,7 @@ import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import net.bigeon.gclc.exception.CommandParsingException;
@@ -53,15 +54,15 @@ import net.bigeon.gclc.exception.CommandParsingException;
* @author Emmanuel BIGEON */
public final class CommandParameters {
/** Number of element for a string argument. */
private static final int STRINGARG_NUMBER_OF_ELEMENTS = 2;
private static final int STRINGARG_NUMBER_OF_ELEMENTS = 2;
/** Boolean arguments. */
private final Map<String, Boolean> booleanArguments = new HashMap<>();
private final Map<String, Boolean> booleanArguments;
/** String arguments. */
private final Map<String, String> stringArguments = new HashMap<>();
private final Map<String, String> stringArguments;
/** Arguments restriction on the named ones. */
private final boolean strict;
private final boolean strict;
/** additional (unnamed) parameters. */
private final List<String> additional = new ArrayList<>();
private final List<String> additional = new ArrayList<>();
/** Create a command parameter object.
*
@@ -69,10 +70,13 @@ public final class CommandParameters {
* @param strings the string parameters
* @param strict if the argument are restricted to the declared ones */
public CommandParameters(final Set<String> bools, final Set<String> strings,
final boolean strict) {
final boolean strict) {
booleanArguments = new ConcurrentHashMap<>(bools.size());
for (final String string : bools) {
booleanArguments.put(string, Boolean.FALSE);
}
// Cannot use concurrent because of the null values.
stringArguments = new HashMap<>(strings.size());
for (final String string : strings) {
stringArguments.put(string, null);
}
@@ -98,9 +102,9 @@ public final class CommandParameters {
*
* @param key the key
* @return if the key was specified */
public boolean getBool(final String key) {
return booleanArguments.containsKey(key) &&
booleanArguments.get(key).booleanValue();
public boolean isActive(final String key) {
Boolean val = booleanArguments.get(key);
return val != null && val.booleanValue();
}
/** Get the boolean arguments.
@@ -122,14 +126,13 @@ public final class CommandParameters {
* @param key the key
* @return if the key is present in string arguments or boolean ones. */
public boolean hasArgument(final String key) {
return stringArguments.containsKey(key) ||
booleanArguments.containsKey(key);
return stringArguments.containsKey(key) || booleanArguments.containsKey(key);
}
/** Attempt to parse an argument.
* <p>
* This method return 0 if the parsing was incorrect, or the number of
* parsed elements.
* This method return 0 if the parsing was incorrect, or the number of parsed
* elements.
*
* @param arg the argument
* @param next the next element
@@ -170,8 +173,7 @@ public final class CommandParameters {
}
final int p = parseArg(args[i], next);
if (p == 0) {
throw new CommandParsingException(
"Invalid parameter " + args[i]); //$NON-NLS-1$
throw new CommandParsingException("Invalid parameter " + args[i]); //$NON-NLS-1$
}
i += p;
}

View File

@@ -35,8 +35,8 @@ package net.bigeon.gclc.command;
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.util.ArrayList;
import java.util.List;
import java.util.LinkedHashSet;
import java.util.Set;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.InvalidCommandName;
@@ -49,27 +49,20 @@ import net.bigeon.gclc.manager.ConsoleOutput;
* @author Emmanuel BIGEON */
public class CommandProvider implements ICommandProvider {
/** The minus character. */
private static final String MINUS = "-"; //$NON-NLS-1$
private static final String MINUS = "-"; //$NON-NLS-1$
/** The space character. */
private static final String SPACE = " "; //$NON-NLS-1$
/** The commands map. */
protected final List<ICommand> commands;
private static final String SPACE = " "; //$NON-NLS-1$
/** The commands set.
* <p>
* The insertion order is conserved through the use of a
* {@link LinkedHashSet}. */
protected final Set<ICommand> commands;
/** Create a command provider. */
public CommandProvider() {
super();
commands = new ArrayList<>();
}
/** Test the command name validity.
*
* @param name the command name
* @throws InvalidCommandName if the name is invalid */
private static void testCommandName(final String name) throws InvalidCommandName {
if (name == null || name.isEmpty() || name.startsWith(MINUS)
|| name.contains(SPACE)) {
throw new InvalidCommandName();
}
commands = new LinkedHashSet<>();
}
/* (non-Javadoc)
@@ -118,4 +111,15 @@ public class CommandProvider implements ICommandProvider {
}
return null;
}
/** Test the command name validity.
*
* @param name the command name
* @throws InvalidCommandName if the name is invalid */
private static void testCommandName(final String name) throws InvalidCommandName {
if (name == null || name.isEmpty() || name.startsWith(MINUS)
|| name.contains(SPACE)) {
throw new InvalidCommandName();
}
}
}

View File

@@ -90,8 +90,8 @@ public interface ICommand {
* @param in the input
* @param args the arguments
* @throws CommandRunException if the command failed */
void execute(ConsoleOutput out, ConsoleInput in,
String... args) throws CommandRunException;
void execute(ConsoleOutput out, ConsoleInput in, String... args)
throws CommandRunException;
/** Get teh command name.
*

View File

@@ -81,8 +81,8 @@ import net.bigeon.gclc.manager.ConsoleOutput;
* @author Emmanuel BIGEON */
public interface ICommandProvider {
/** Adds a command to this provider, if no command was associated with the
* given key.
/** Adds a command to this provider, if no command was associated with the given
* key.
*
* @param value the command to execute
* @return if the command was added
@@ -91,25 +91,25 @@ public interface ICommandProvider {
/** Execute the command with the given name.
* <p>
* If no command with this name is found, an error command is usually
* executed. If there are several commands with the same name, the behavior
* is unspecified. Depending on the implementation, it may run an error
* command or prompt the user for a choice.
* If no command with this name is found, an error command is usually executed.
* If there are several commands with the same name, the behavior is
* unspecified. Depending on the implementation, it may run an error command or
* prompt the user for a choice.
*
* @param out the output
* @param in the input
* @param command the name of the command the user wishes to execute
* @param args the arguments for the command
* @throws CommandRunException if the command failed to run */
void executeSub(ConsoleOutput out, ConsoleInput in, String command,
String... args) throws CommandRunException;
void executeSub(ConsoleOutput out, ConsoleInput in, String command, String... args)
throws CommandRunException;
/** Get the command with the given name.
* <p>
* If no command with this name is found, an error command is usually
* returned. If there are several commands with the same name, the behavior
* is unspecified. Depending on the implementation, it may return an error
* command or the first command with this name found.
* If no command with this name is found, an error command is usually returned.
* If there are several commands with the same name, the behavior is
* unspecified. Depending on the implementation, it may return an error command
* or the first command with this name found.
*
* @param command the name of the command the user wishes to execute
* @return the command to execute */

View File

@@ -89,9 +89,8 @@ public abstract class ParametrizedCommand extends Command {
/** Create a parametrized command.
* <p>
* Implementation are supposed to call the
* {@link #addBooleanParameter(String)} and
* {@link #addStringParameter(String, boolean)} method to set the
* Implementation are supposed to call the {@link #addBooleanParameter(String)}
* and {@link #addStringParameter(String, boolean)} method to set the
* parameters.
*
* @param name the name */
@@ -101,9 +100,8 @@ public abstract class ParametrizedCommand extends Command {
/** Create a parametrized command.
* <p>
* Implementation are supposed to call the
* {@link #addBooleanParameter(String)} and
* {@link #addStringParameter(String, boolean)} method to set the
* Implementation are supposed to call the {@link #addBooleanParameter(String)}
* and {@link #addStringParameter(String, boolean)} method to set the
* parameters.
*
* @param name the name
@@ -116,9 +114,10 @@ public abstract class ParametrizedCommand extends Command {
/** Add a boolean parameter to defined parmaters.
*
* @param flag the boolean flag
* @throws InvalidParameterException if the parameter is already defined as
* a string parameter */
protected final void addBooleanParameter(final String flag) throws InvalidParameterException {
* @throws InvalidParameterException if the parameter is already defined as a
* string parameter */
protected final void addBooleanParameter(final String flag)
throws InvalidParameterException {
data.addBooleanParameter(flag);
}
@@ -126,10 +125,10 @@ public abstract class ParametrizedCommand extends Command {
*
* @param flag the parameter flag
* @param needed if the parameter's absence should cause an exception
* @throws InvalidParameterException if the parameter is already defined as
* a boolean parameter */
protected final void addStringParameter(final String flag,
final boolean needed) throws InvalidParameterException {
* @throws InvalidParameterException if the parameter is already defined as a
* boolean parameter */
protected final void addStringParameter(final String flag, final boolean needed)
throws InvalidParameterException {
data.addStringParameter(flag, needed);
}
@@ -140,14 +139,13 @@ public abstract class ParametrizedCommand extends Command {
* @param parameters the command parameters
* @throws CommandRunException if the command failed */
protected abstract void doExecute(ConsoleOutput out, ConsoleInput in,
CommandParameters parameters) throws CommandRunException;
CommandParameters parameters) throws CommandRunException;
/* (non-Javadoc)
* @see net.bigeon.gclc.command.Command#execute(java.lang.String[]) */
@Override
public final void execute(final ConsoleOutput output,
final ConsoleInput input,
final String... args) throws CommandRunException {
public final void execute(final ConsoleOutput output, final ConsoleInput input,
final String... args) throws CommandRunException {
try {
doExecute(output, input, data.getParameters(input, args));
} catch (final IOException e) {

View File

@@ -75,18 +75,17 @@ import java.io.IOException;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import net.bigeon.gclc.exception.CommandParsingException;
import net.bigeon.gclc.exception.InvalidParameterException;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.EmptyInput;
import java.util.Set;
import net.bigeon.gclc.utils.EmptyInput;
/** An object to handle standardized command parameters.
*
@@ -94,11 +93,12 @@ import java.util.Set;
public final class ParametrizedCommandData {
/** The boolean parameters mandatory status. */
private final Set<String> boolParams = new HashSet<>();
private final Set<String> boolParams = new HashSet<>();
/** The string parameters mandatory status. */
private final Map<String, Boolean> stringParams = new HashMap<>();
private final Map<String, Boolean> stringParams = new ConcurrentHashMap<>();
/** The parameters mandatory status. */
private final Map<String, Boolean> params = new HashMap<>();
private final Map<String, Boolean> params = new ConcurrentHashMap<>();
/** The restriction of provided parameters on execution to declared paramters in
* the status maps. */
private final boolean strict;
@@ -120,8 +120,7 @@ public final class ParametrizedCommandData {
* @param flag the boolean flag
* @throws InvalidParameterException if the parameter is already defined as a
* string parameter */
public final void addBooleanParameter(final String flag)
throws InvalidParameterException {
public void addBooleanParameter(final String flag) throws InvalidParameterException {
if (params.containsKey(flag) && stringParams.containsKey(flag)) {
throw new InvalidParameterException("Parameter is already defined as string"); //$NON-NLS-1$
}
@@ -135,7 +134,7 @@ public final class ParametrizedCommandData {
* @param needed if the parameter's absence should cause an exception
* @throws InvalidParameterException if the parameter is already defined as a
* boolean parameter */
public final void addStringParameter(final String flag, final boolean needed)
public void addStringParameter(final String flag, final boolean needed)
throws InvalidParameterException {
if (params.containsKey(flag)) {
checkParam(flag, needed);
@@ -152,9 +151,9 @@ public final class ParametrizedCommandData {
* @throws InvalidParameterException if the new definition is invalid */
private void checkParam(final String param, final boolean needed)
throws InvalidParameterException {
if (stringParams.containsKey(param)) {
final Boolean need = Boolean
.valueOf(needed || stringParams.get(param).booleanValue());
Boolean val = stringParams.get(param);
if (val != null) {
final Boolean need = Boolean.valueOf(needed || val.booleanValue());
stringParams.put(param, need);
params.put(param, need);
return;
@@ -162,14 +161,28 @@ public final class ParametrizedCommandData {
throw new InvalidParameterException("Parameter is already defined as boolean"); //$NON-NLS-1$
}
/** Retrieve the boolean parameters (aka flags).
*
* @return the set of boolean parameters */
public Set<String> getBooleanParameters() {
return Collections.unmodifiableSet(boolParams);
}
/** Retrieve the parameter names.
*
* @return the stringParams */
public Set<String> getParameters() {
return params.keySet();
}
/** Get the parameters from an input.
*
* @param input the input
* @param args the command arguments
* @return the command object
* @throws IOException if the command could not be filled. */
public final CommandParameters getParameters(final ConsoleInput input,
final String... args) throws IOException {
public CommandParameters getParameters(final ConsoleInput input, final String... args)
throws IOException {
final CommandParameters parameters = new CommandParameters(boolParams,
stringParams.keySet(), strict);
try {
@@ -192,6 +205,29 @@ public final class ParametrizedCommandData {
return parameters;
}
/** Get the string parameters names.
*
* @return the stringParams */
public Set<String> getStringParameters() {
return stringParams.keySet();
}
/** Test if a parameter is needed.
*
* @param param the parameter name
* @return if the parameter is needed */
public boolean isNeeded(final String param) {
Boolean val = params.get(param);
return val != null && val.booleanValue();
}
/** If the command refuse unrecognized parameters.
*
* @return the strict */
public boolean isStrict() {
return strict;
}
/** Fill the undefined parameters.
* <p>
* This method prompts the user to fill the needed parameters.
@@ -200,7 +236,7 @@ public final class ParametrizedCommandData {
* @param parameters the parameter list to complete
* @param toProvide the parameters to ask for
* @throws IOException if the manager was closed */
private final static void fillParameters(final ConsoleInput input,
private static void fillParameters(final ConsoleInput input,
final List<String> toProvide, final CommandParameters parameters)
throws IOException {
for (final String string : toProvide) {
@@ -214,40 +250,4 @@ public final class ParametrizedCommandData {
parameters.set(string, value);
}
}
/** Retrieve the boolean parameters (aka flags).
*
* @return the set of boolean parameters */
public final Set<String> getBooleanParameters() {
return Collections.unmodifiableSet(boolParams);
}
/** Retrieve the parameter names.
*
* @return the stringParams */
public final Set<String> getParameters() {
return params.keySet();
}
/** Get the string parameters names.
*
* @return the stringParams */
public final Set<String> getStringParameters() {
return stringParams.keySet();
}
/** Test if a parameter is needed.
*
* @param param the parameter name
* @return if the parameter is needed */
public final boolean isNeeded(final String param) {
return params.containsKey(param) && params.get(param).booleanValue();
}
/** If the command refuse unrecognized parameters.
*
* @return the strict */
public final boolean isStrict() {
return strict;
}
}

View File

@@ -86,16 +86,15 @@ import net.bigeon.gclc.manager.ConsoleOutput;
public final class SubedCommand extends CommandProvider implements ICommand {
/** The tab character. */
private static final String TAB = "\t"; //$NON-NLS-1$
/** The command to execute when this command is called with no sub
* arguments.
private static final String TAB = "\t"; //$NON-NLS-1$
/** The command to execute when this command is called with no sub arguments.
* <p>
* This may be null, in which case the command should have arguments. */
private final ICommand noArgCommand;
private final ICommand noArgCommand;
/** A tip on this command. */
private final String tip;
private final String tip;
/** The name of the command. */
private final String name;
private final String name;
/** Create the command that defines sub commands.
*
@@ -111,7 +110,7 @@ public final class SubedCommand extends CommandProvider implements ICommand {
*
* @param name the name of the command
* @param noArgCommand the command to execute when no extra parameter are
* provided */
* provided */
public SubedCommand(final String name, final ICommand noArgCommand) {
super();
this.name = name;
@@ -125,7 +124,7 @@ public final class SubedCommand extends CommandProvider implements ICommand {
* @param noArgCommand the command to execute
* @param tip the help tip associated */
public SubedCommand(final String name, final ICommand noArgCommand,
final String tip) {
final String tip) {
super();
this.name = name;
this.noArgCommand = noArgCommand;
@@ -147,7 +146,7 @@ public final class SubedCommand extends CommandProvider implements ICommand {
* @see fr.bigeon.acide.Command#execute(java.lang.String[]) */
@Override
public void execute(final ConsoleOutput output, final ConsoleInput input,
final String... args) throws CommandRunException {
final String... args) throws CommandRunException {
if (args.length == 0 || args[0].startsWith("-")) { //$NON-NLS-1$
if (noArgCommand != null) {
noArgCommand.execute(output, input, args);
@@ -176,15 +175,15 @@ public final class SubedCommand extends CommandProvider implements ICommand {
/* (non-Javadoc)
* @see net.bigeon.gclc.command.Command#help() */
@Override
public void help(final ConsoleOutput manager,
final String... args) throws IOException {
public void help(final ConsoleOutput manager, final String... args)
throws IOException {
if (args.length != 0 && !args[0].startsWith("-")) { //$NON-NLS-1$
// Specific
final ICommand c = get(args[0]);
if (c != null) {
c.help(manager, Arrays.copyOfRange(args, 1, args.length));
} else {
manager.println("No command "+Arrays.toString(args));
manager.println("No command " + Arrays.toString(args));
}
} else {
// Generic
@@ -196,7 +195,7 @@ public final class SubedCommand extends CommandProvider implements ICommand {
manager.println(TAB + cmd.getCommandName());
} else {
manager.println(TAB + cmd.getCommandName() + ": " + //$NON-NLS-1$
cmd.tip());
cmd.tip());
}
}
}

View File

@@ -84,13 +84,13 @@ import net.bigeon.gclc.prompt.CLIPrompterMessages;
* @author Emmanuel BIGEON */
public class ExitCommand implements ICommand {
/** The exit command manual message key. */
private static final String EXIT_MAN = "exit.man"; //$NON-NLS-1$
private static final String EXIT_MAN = "exit.man"; //$NON-NLS-1$
/** The tip of the exit command. */
private static final String EXIT = "exit.tip"; //$NON-NLS-1$
private static final String EXIT = "exit.tip"; //$NON-NLS-1$
/** The application that will be exited when this command runs. */
private final ConsoleApplication app;
/** The exit command name. */
private final String name;
private final String name;
/** Create the exiting command.
*
@@ -109,8 +109,8 @@ public class ExitCommand implements ICommand {
}
@Override
public final void execute(final ConsoleOutput output,
final ConsoleInput input, final String... args) {
public final void execute(final ConsoleOutput output, final ConsoleInput input,
final String... args) {
beforeExit();
app.exit();
}
@@ -123,11 +123,11 @@ public class ExitCommand implements ICommand {
}
@Override
public final void help(final ConsoleOutput manager,
final String... args) throws IOException {
manager.println(
CLIPrompterMessages.getString(EXIT_MAN, (Object[]) args));
public final void help(final ConsoleOutput manager, final String... args)
throws IOException {
manager.println(CLIPrompterMessages.getString(EXIT_MAN, (Object[]) args));
}
@Override
public final String tip() {
return CLIPrompterMessages.getString(EXIT);

View File

@@ -36,7 +36,7 @@
* gclc:net.bigeon.gclc.command.HelpExecutor.java
* Created on: Sep 6, 2014
*/
package net.bigeon.gclc.command;
package net.bigeon.gclc.command.base;
/*-
* #%L
@@ -73,6 +73,9 @@ package net.bigeon.gclc.command;
*/
import java.io.IOException;
import net.bigeon.gclc.command.Command;
import net.bigeon.gclc.command.ICommand;
import net.bigeon.gclc.command.SubedCommand;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.CommandRunExceptionType;
import net.bigeon.gclc.manager.ConsoleInput;
@@ -93,8 +96,7 @@ public final class HelpExecutor extends Command {
*
* @param cmdName the command name
* @param cmd the command to execute the help of */
public HelpExecutor(final String cmdName,
final ICommand cmd) {
public HelpExecutor(final String cmdName, final ICommand cmd) {
super(cmdName);
this.cmd = cmd;
}
@@ -114,7 +116,7 @@ public final class HelpExecutor extends Command {
* String[]) */
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
final String... args) throws CommandRunException {
try {
cmd.help(out, args);
} catch (final IOException e) {
@@ -131,8 +133,7 @@ public final class HelpExecutor extends Command {
}
/* (non-Javadoc)
* @see net.bigeon.gclc.command.Command#usageDetail()
*/
* @see net.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
return null;

View File

@@ -98,7 +98,7 @@ public final class MockCommand implements ICommand {
* String[]) */
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) {
final String... args) {
//
}
@@ -113,8 +113,7 @@ public final class MockCommand implements ICommand {
* @see net.bigeon.gclc.command.ICommand#help(net.bigeon.gclc.manager.
* ConsoleManager, java.lang.String[]) */
@Override
public void help(final ConsoleOutput manager,
final String... args) {
public void help(final ConsoleOutput manager, final String... args) {
//
}

View File

@@ -72,10 +72,11 @@ package net.bigeon.gclc.command.base;
* #L%
*/
import java.io.BufferedReader;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.nio.charset.Charset;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.text.MessageFormat;
import java.util.Arrays;
import java.util.List;
@@ -98,13 +99,16 @@ import net.bigeon.gclc.manager.ConsoleOutput;
public final class ScriptExecution extends Command {
/** The tab character. */
private static final String TAB = "\t"; //$NON-NLS-1$
private static final String TAB = "\t"; //$NON-NLS-1$
/** the space character. */
private static final String SPACE = " "; //$NON-NLS-1$
private static final String SPACE = " "; //$NON-NLS-1$
/** The application. */
private final ConsoleApplication application;
/** The commenting prefix. */
private final String commentPrefix;
/** The charset for files. */
private final Charset charset;
@@ -115,40 +119,27 @@ public final class ScriptExecution extends Command {
* @param commentPrefix the comment prefix in the script files
* @param charset the charset to use for files */
public ScriptExecution(final String name, final ConsoleApplication application,
final String commentPrefix, final Charset charset) {
final String commentPrefix, final Charset charset) {
super(name);
this.application = application;
this.commentPrefix = commentPrefix;
this.charset = charset;
}
/** Check the arguments.
*
* @param args the arguments
* @throws CommandRunException if the arguments were not the ones
* expected */
private static void checkArgs(final String[] args) throws CommandRunException {
if (args.length == 0) {
throw new CommandRunException(CommandRunExceptionType.USAGE,
"Expecting a file"); //$NON-NLS-1$
}
}
/* (non-Javadoc)
* @see net.bigeon.gclc.command.ICommand#execute(java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
final String... args) throws CommandRunException {
checkArgs(args);
final String scriptFile = args[0];
final String[] params = Arrays.copyOfRange(args, 1, args.length);
String cmd;
int lineNo = -1;
try (InputStreamReader fReader = new InputStreamReader(
new FileInputStream(scriptFile), charset);
BufferedReader reader = new BufferedReader(fReader)) {
Files.newInputStream(Paths.get(scriptFile)), charset);
BufferedReader reader = new BufferedReader(fReader)) {
String[] emptyArray = new String[0];
while ((cmd = reader.readLine()) != null) {
lineNo++;
final String cmdLine = readCommandLine(cmd, params);
@@ -157,12 +148,12 @@ public final class ScriptExecution extends Command {
}
final List<String> ps = GCLCConstants.splitCommand(cmdLine);
final String command = ps.remove(0);
application.executeSub(out, in, command,
ps.toArray(new String[0]));
application.executeSub(out, in, command, ps.toArray(emptyArray));
}
} catch (final CommandParsingException e) {
throw new CommandRunException(MessageFormat.format(
"Invalid command in script ({0})", e.getLocalizedMessage()), //$NON-NLS-1$
throw new CommandRunException(
MessageFormat.format("Invalid command in script ({0})", //$NON-NLS-1$
e.getLocalizedMessage()),
e);
} catch (final IOException e) {
throw new CommandRunException("Unable to read script", //$NON-NLS-1$
@@ -172,29 +163,14 @@ public final class ScriptExecution extends Command {
}
}
/** This method will create the correct exception. The exception source must
* be this command.
*
* @param e the exception
* @param lineNo the line nu;ber
* @return the exception to actually throw */
private static CommandRunException manageRunException(final CommandRunException e,
final int lineNo) {
return new CommandRunException(CommandRunExceptionType.EXECUTION,
MessageFormat.format(
"The script could not complete due to command failure at line {0} ({1})", //$NON-NLS-1$
Integer.valueOf(lineNo), e.getLocalizedMessage()),
e);
}
/** Read a line of the script.
*
* @param cmd the line
* @param params the formatting parameters
* @return the command if it is indeed one, null otherwise
* @throws CommandRunException if the line stqrted with a space character */
private String readCommandLine(final String cmd,
final Object[] params) throws CommandRunException {
private String readCommandLine(final String cmd, final Object[] params)
throws CommandRunException {
if (cmd.startsWith(SPACE) || cmd.startsWith(TAB)) {
throw new CommandRunException(
"Invalid line in script (line starts with space character)");
@@ -225,8 +201,7 @@ public final class ScriptExecution extends Command {
builder.append(
" The script file must contain one line commands. The lines must never"); //$NON-NLS-1$
builder.append(System.lineSeparator());
builder.append(
"start with whitespace characters. The lines starting with"); //$NON-NLS-1$
builder.append("start with whitespace characters. The lines starting with"); //$NON-NLS-1$
builder.append(System.lineSeparator());
builder.append('"');
builder.append(commentPrefix);
@@ -243,4 +218,30 @@ public final class ScriptExecution extends Command {
return super.usagePattern() + " <scriptfile>"; //$NON-NLS-1$
}
/** Check the arguments.
*
* @param args the arguments
* @throws CommandRunException if the arguments were not the ones expected */
private static void checkArgs(final String[] args) throws CommandRunException {
if (args.length == 0) {
throw new CommandRunException(CommandRunExceptionType.USAGE,
"Expecting a file"); //$NON-NLS-1$
}
}
/** This method will create the correct exception. The exception source must be
* this command.
*
* @param e the exception
* @param lineNo the line nu;ber
* @return the exception to actually throw */
private static CommandRunException manageRunException(final CommandRunException e,
final int lineNo) {
return new CommandRunException(CommandRunExceptionType.EXECUTION,
MessageFormat.format(
"The script could not complete due to command failure at line {0} ({1})", //$NON-NLS-1$
Integer.valueOf(lineNo), e.getLocalizedMessage()),
e);
}
}

View File

@@ -1,7 +1,4 @@
/**
* @author Emmanuel Bigeon
*
*/
/** @author Emmanuel Bigeon */
package net.bigeon.gclc.command.base;
/*-

View File

@@ -4,9 +4,9 @@
* There are some implementations, such as the
* {@link net.bigeon.gclc.command.ParametrizedCommand} for commands with a
* predefined set of flags and option taking a string as value, the
* {@link net.bigeon.gclc.command.SubedCommand} for a command that is declined in
* a set of sub commands, the {@link net.bigeon.gclc.command.HelpExecutor} for
* help display of other commands and the
* {@link net.bigeon.gclc.command.SubedCommand} for a command that is declined
* in a set of sub commands, the {@link net.bigeon.gclc.command.base.HelpExecutor}
* for help display of other commands and the
*
* @author Emmanuel BIGEON */
package net.bigeon.gclc.command;

View File

@@ -80,16 +80,16 @@ public class CommandParsingException extends Exception {
private static final long serialVersionUID = 1L;
/** Create the exception with a message.
*
* @param message the message */
*
* @param message the message */
public CommandParsingException(final String message) {
super(message);
}
/** Create the exception with a message and a cause.
*
* @param message the message
* @param cause the cause */
*
* @param message the message
* @param cause the cause */
public CommandParsingException(final String message, final Throwable cause) {
super(message, cause);
}

View File

@@ -87,8 +87,7 @@ public final class CommandRunException extends Exception {
*
* @param type the type of exception
* @param message the message */
public CommandRunException(final CommandRunExceptionType type,
final String message) {
public CommandRunException(final CommandRunExceptionType type, final String message) {
super(message);
this.type = type;
}
@@ -98,8 +97,8 @@ public final class CommandRunException extends Exception {
* @param type the type of exception
* @param message a message
* @param cause the cause */
public CommandRunException(final CommandRunExceptionType type,
final String message, final Throwable cause) {
public CommandRunException(final CommandRunExceptionType type, final String message,
final Throwable cause) {
super(message, cause);
this.type = type;
}
@@ -128,7 +127,7 @@ public final class CommandRunException extends Exception {
public String getLocalizedMessage() {
if (getCause() != null) {
return super.getLocalizedMessage() + ": " + //$NON-NLS-1$
getCause().getLocalizedMessage();
getCause().getLocalizedMessage();
}
return super.getLocalizedMessage();
}

View File

@@ -89,8 +89,7 @@ public final class Messages {
.getBundle(BUNDLE_NAME);
/** The class logger. */
private static final Logger LOGGER = Logger
.getLogger(Messages.class.getName());
private static final Logger LOGGER = Logger.getLogger(Messages.class.getName());
/** Utility class. */
private Messages() {

View File

@@ -86,14 +86,12 @@ public interface ConsoleOutput extends AutoCloseable {
/** Print a string.
*
* @param text the message to print (without line break at the end).
* @throws IOException if the manager is closed or could not read the
* prompt */
* @throws IOException if the manager is closed or could not read the prompt */
void print(String text) throws IOException;
/** Prints an end of line.
*
* @throws IOException if the manager is closed or could not read the
* prompt */
* @throws IOException if the manager is closed or could not read the prompt */
void println() throws IOException;
/** Print a string followed by an end of line.
@@ -102,8 +100,7 @@ public interface ConsoleOutput extends AutoCloseable {
* {@link #println()}.
*
* @param message the message to print
* @throws IOException if the manager is closed or could not read the
* prompt */
* @throws IOException if the manager is closed or could not read the prompt */
void println(String message) throws IOException;
}

View File

@@ -70,6 +70,7 @@ package net.bigeon.gclc.prompt;
* #L%
*/
import java.io.IOException;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
@@ -86,25 +87,25 @@ import net.bigeon.gclc.manager.ConsoleOutput;
public final class CLIPrompter {
/** The zero integer. */
private static final Integer ZERO = Integer.valueOf(0);
private static final Integer ZERO = Integer.valueOf(0);
/** message key for format error in prompting a choice. */
private static final String PROMPTCHOICE_FORMATERR = "promptchoice.formaterr"; //$NON-NLS-1$
private static final String PROMPTCHOICE_FORMATERR = "promptchoice.formaterr"; //$NON-NLS-1$
/** message key for out of bound error in prompting a choice. */
private static final String PROMPTCHOICE_OUTOFBOUNDS = "promptchoice.outofbounds"; //$NON-NLS-1$
private static final String PROMPTCHOICE_OUTOFBOUNDS = "promptchoice.outofbounds"; //$NON-NLS-1$
/** message key for first form of no in prompting a choice. */
private static final String PROMPTBOOL_CHOICES_NO1 = "promptbool.choices.no1"; //$NON-NLS-1$
private static final String PROMPTBOOL_CHOICES_NO1 = "promptbool.choices.no1"; //$NON-NLS-1$
/** message key for first form of yes in prompting a choice. */
private static final String PROMPTBOOL_CHOICES_YES1 = "promptbool.choices.yes1"; //$NON-NLS-1$
private static final String PROMPTBOOL_CHOICES_YES1 = "promptbool.choices.yes1"; //$NON-NLS-1$
/** Message key for boolean choosing. */
private static final String BOOL_CHOICES = "promptbool.choices"; //$NON-NLS-1$
private static final String BOOL_CHOICES = "promptbool.choices"; //$NON-NLS-1$
/** Message key for the list end of prompt symbol. */
private static final String LIST_DISP_KEY = "promptlist.exit.dispkey"; //$NON-NLS-1$
private static final String LIST_DISP_KEY = "promptlist.exit.dispkey"; //$NON-NLS-1$
/** Message key for the line prompt. */
private static final String PROMPT = "prompt.lineprompt"; //$NON-NLS-1$
private static final String PROMPT = "prompt.lineprompt"; //$NON-NLS-1$
/** Message key for the separation of choices selection. */
private static final String LIST_CHOICE_SEP = "promptlist.multi.sepkey"; //$NON-NLS-1$
private static final String LIST_CHOICE_SEP = "promptlist.multi.sepkey"; //$NON-NLS-1$
/** The class logger. */
private static final Logger LOGGER = Logger
private static final Logger LOGGER = Logger
.getLogger(CLIPrompter.class.getName());
/** Utility class. */
@@ -118,9 +119,8 @@ public final class CLIPrompter {
* @param chs the list of integers
* @param index the max index of choice
* @return if the parsing was done correctly */
private static boolean addUserChoice(final String val,
final List<Integer> chs,
final int index) {
private static boolean addUserChoice(final String val, final List<Integer> chs,
final int index) {
if (val.isEmpty()) {
return true;
}
@@ -138,18 +138,18 @@ public final class CLIPrompter {
* @param output the manager
* @param choices the choices
* @param cancel the cancel option if it exists
* @return the number of choices plus one (or the number of choices if there
* is a cancel)
* @return the index of last choice
* @throws IOException if the manager was closed */
private static <U> Integer listChoices(final ConsoleOutput output,
final List<U> choices,
final String cancel) throws IOException {
final List<U> choices, final String cancel) throws IOException {
int index = 0;
for (final U u : choices) {
output.println(index++ + ") " + u); //$NON-NLS-1$
output.println(index + ") " + u); //$NON-NLS-1$
index++;
}
if (cancel != null) {
output.println(index++ + ") " + cancel); //$NON-NLS-1$
output.println(index + ") " + cancel); //$NON-NLS-1$
index++;
}
return Integer.valueOf(index - 1);
}
@@ -162,36 +162,28 @@ public final class CLIPrompter {
* @return the choice
* @throws IOException if the manager was closed */
public static boolean promptBoolean(final ConsoleOutput manager,
final ConsoleInput input,
final String message) throws IOException {
String result = input
.prompt(message + CLIPrompterMessages.getString(BOOL_CHOICES));
final ConsoleInput input, final String message) throws IOException {
String booleanChoices = message + CLIPrompterMessages.getString(BOOL_CHOICES);
String result = input.prompt(booleanChoices);
boolean first = true;
final String choices = CLIPrompterMessages
.getString(PROMPTBOOL_CHOICES_YES1) + ", " + //$NON-NLS-1$
CLIPrompterMessages
.getString(PROMPTBOOL_CHOICES_NO1);
while (!(result.equalsIgnoreCase(
CLIPrompterMessages.getString(PROMPTBOOL_CHOICES_YES1)) ||
CLIPrompterMessages.getString(PROMPTBOOL_CHOICES_NO1)
.equalsIgnoreCase(result) ||
CLIPrompterMessages.getString("promptbool.choices.no2") //$NON-NLS-1$
.equalsIgnoreCase(result) ||
CLIPrompterMessages.getString("promptbool.choices.yes2") //$NON-NLS-1$
.equalsIgnoreCase(result))) {
String booleanYesChoice = CLIPrompterMessages.getString(PROMPTBOOL_CHOICES_YES1);
String booleanNoChoice = CLIPrompterMessages.getString(PROMPTBOOL_CHOICES_NO1);
final String choices = MessageFormat.format("{0}, {1}", booleanYesChoice,
booleanNoChoice);
String yes2 = CLIPrompterMessages.getString("promptbool.choices.yes2");
String no2 = CLIPrompterMessages.getString("promptbool.choices.no2");
while (!(result.equalsIgnoreCase(booleanYesChoice)
|| booleanNoChoice.equalsIgnoreCase(result)
|| no2.equalsIgnoreCase(result) || yes2.equalsIgnoreCase(result))) {
if (!first) {
manager.println(CLIPrompterMessages
.getString("promptbool.choices.invalid", choices)); //$NON-NLS-1$
result = input.prompt(
message + CLIPrompterMessages.getString(BOOL_CHOICES));
result = input.prompt(booleanChoices);
}
first = false;
}
return result.equalsIgnoreCase(
CLIPrompterMessages.getString(PROMPTBOOL_CHOICES_YES1)) ||
result.equalsIgnoreCase(CLIPrompterMessages
.getString("promptbool.choices.yes2")); //$NON-NLS-1$
return result.equalsIgnoreCase(booleanYesChoice) || result.equalsIgnoreCase(yes2); // $NON-NLS-1$
}
/** Prompt for a choice.
@@ -206,13 +198,9 @@ public final class CLIPrompter {
* @return the choice
* @throws IOException if the manager was closed */
public static <U> U promptChoice(final ConsoleOutput manager,
final ConsoleInput input,
final List<String> keys,
final List<U> choices,
final String message,
final String cancel) throws IOException {
final Integer index = promptChoice(manager, input, keys, message,
cancel);
final ConsoleInput input, final List<String> keys, final List<U> choices,
final String message, final String cancel) throws IOException {
final Integer index = promptChoice(manager, input, keys, message, cancel);
if (index == null) {
return null;
}
@@ -232,13 +220,9 @@ public final class CLIPrompter {
* @return the chosen object
* @throws IOException if the manager was closed */
public static <U, T> T promptChoice(final ConsoleOutput manager,
final ConsoleInput input,
final List<U> choices,
final Map<U, T> choicesMap,
final String message,
final String cancel) throws IOException {
final Integer res = promptChoice(manager, input, choices, message,
cancel);
final ConsoleInput input, final List<U> choices, final Map<U, T> choicesMap,
final String message, final String cancel) throws IOException {
final Integer res = promptChoice(manager, input, choices, message, cancel);
if (res == null) {
return null;
}
@@ -256,10 +240,8 @@ public final class CLIPrompter {
* @return the index of the choice
* @throws IOException if the manager was closed */
public static <U> Integer promptChoice(final ConsoleOutput manager,
final ConsoleInput input,
final List<U> choices,
final String message,
final String cancel) throws IOException {
final ConsoleInput input, final List<U> choices, final String message,
final String cancel) throws IOException {
manager.println(message);
final Integer index = listChoices(manager, choices, cancel);
String result;
@@ -271,13 +253,12 @@ public final class CLIPrompter {
if (r >= 0 && r <= index.intValue()) {
break;
}
manager.println(CLIPrompterMessages
.getString(PROMPTCHOICE_OUTOFBOUNDS, ZERO, index));
manager.println(CLIPrompterMessages.getString(PROMPTCHOICE_OUTOFBOUNDS,
ZERO, index));
} catch (final NumberFormatException e) {
LOGGER.log(Level.FINER,
"Unrecognized number. Prompting user again.", e); //$NON-NLS-1$
manager.println(CLIPrompterMessages
.getString(PROMPTCHOICE_FORMATERR, ZERO, index));
LOGGER.log(Level.FINER, "Unrecognized number. Prompting user again.", e); //$NON-NLS-1$
manager.println(CLIPrompterMessages.getString(PROMPTCHOICE_FORMATERR,
ZERO, index));
}
listChoices(manager, choices, cancel);
}
@@ -299,13 +280,10 @@ public final class CLIPrompter {
* @return the chosen object
* @throws IOException if the manager was closed */
public static <U, T> T promptChoice(final ConsoleOutput manager,
final ConsoleInput input,
final Map<U, T> choicesMap,
final String message,
final String cancel) throws IOException {
return promptChoice(manager, input,
new ArrayList<>(choicesMap.keySet()), choicesMap, message,
cancel);
final ConsoleInput input, final Map<U, T> choicesMap, final String message,
final String cancel) throws IOException {
return promptChoice(manager, input, new ArrayList<>(choicesMap.keySet()),
choicesMap, message, cancel);
}
/** Prompt for an integer.
@@ -314,8 +292,8 @@ public final class CLIPrompter {
* @param message the prompt message
* @return the integer
* @throws IOException if the manager was closed */
public static int promptInteger(final ConsoleInput manager,
final String message) throws IOException {
public static int promptInteger(final ConsoleInput manager, final String message)
throws IOException {
boolean still = true;
int r = 0;
while (still) {
@@ -344,8 +322,7 @@ public final class CLIPrompter {
* @return the list of user inputs
* @throws IOException if the manager was closed */
public static List<String> promptList(final ConsoleOutput manager,
final ConsoleInput input,
final String message) throws IOException {
final ConsoleInput input, final String message) throws IOException {
return promptList(manager, input, message,
CLIPrompterMessages.getString("promptlist.exit.defaultkey")); //$NON-NLS-1$
}
@@ -359,12 +336,10 @@ public final class CLIPrompter {
* @return the list of user inputs
* @throws IOException if the manager was closed */
public static List<String> promptList(final ConsoleOutput manager,
final ConsoleInput input,
final String message,
final String ender) throws IOException {
final ConsoleInput input, final String message, final String ender)
throws IOException {
final List<String> strings = new ArrayList<>();
manager.println(
message + CLIPrompterMessages.getString(LIST_DISP_KEY, ender));
manager.println(message + CLIPrompterMessages.getString(LIST_DISP_KEY, ender));
String res = null;
while (!ender.equals(res)) {
res = input.prompt(CLIPrompterMessages.getString(PROMPT));
@@ -383,10 +358,9 @@ public final class CLIPrompter {
* @return the text
* @throws IOException if the manager was closed */
public static String promptLongText(final ConsoleOutput manager,
final ConsoleInput input,
final String message) throws IOException {
return promptLongText(manager, input, message, CLIPrompterMessages
.getString("promptlongtext.exit.defaultkey")); //$NON-NLS-1$
final ConsoleInput input, final String message) throws IOException {
return promptLongText(manager, input, message,
CLIPrompterMessages.getString("promptlongtext.exit.defaultkey")); //$NON-NLS-1$
}
/** Prompt for a text with several lines.
@@ -398,11 +372,10 @@ public final class CLIPrompter {
* @return the text
* @throws IOException if the manager was closed */
public static String promptLongText(final ConsoleOutput manager,
final ConsoleInput input,
final String message,
final String ender) throws IOException {
manager.println(message + CLIPrompterMessages
.getString("promptlongtext.exit.dispkey", ender)); //$NON-NLS-1$
final ConsoleInput input, final String message, final String ender)
throws IOException {
manager.println(message
+ CLIPrompterMessages.getString("promptlongtext.exit.dispkey", ender)); //$NON-NLS-1$
final StringBuilder res = new StringBuilder();
String line;
do {
@@ -426,13 +399,10 @@ public final class CLIPrompter {
* @return the choice
* @throws IOException if the manager was closed */
public static <U> List<U> promptMultiChoice(final ConsoleOutput manager,
final ConsoleInput input,
final List<String> keys,
final List<U> choices,
final String message) throws IOException {
final List<Integer> indices = promptMultiChoice(manager, input, keys,
message);
final List<U> userChoices = new ArrayList<>();
final ConsoleInput input, final List<String> keys, final List<U> choices,
final String message) throws IOException {
final List<Integer> indices = promptMultiChoice(manager, input, keys, message);
final List<U> userChoices = new ArrayList<>(indices.size());
for (final Integer integer : indices) {
userChoices.add(choices.get(integer.intValue()));
}
@@ -451,13 +421,10 @@ public final class CLIPrompter {
* @return the chosen objects (or an empty list)
* @throws IOException if the manager was closed */
public static <U, T> List<T> promptMultiChoice(final ConsoleOutput manager,
final ConsoleInput input,
final List<U> choices,
final Map<U, T> choicesMap,
final String message) throws IOException {
final List<Integer> chs = promptMultiChoice(manager, input, choices,
message);
final List<T> userChoices = new ArrayList<>();
final ConsoleInput input, final List<U> choices, final Map<U, T> choicesMap,
final String message) throws IOException {
final List<Integer> chs = promptMultiChoice(manager, input, choices, message);
final List<T> userChoices = new ArrayList<>(chs.size());
for (final Integer integer : chs) {
userChoices.add(choicesMap.get(choices.get(integer.intValue())));
}
@@ -474,9 +441,8 @@ public final class CLIPrompter {
* @return the indices of the choices
* @throws IOException if the manager was closed */
public static <U> List<Integer> promptMultiChoice(final ConsoleOutput manager,
final ConsoleInput input,
final List<U> choices,
final String message) throws IOException {
final ConsoleInput input, final List<U> choices, final String message)
throws IOException {
manager.println(message);
final Integer index = listChoices(manager, choices, null);
String result;
@@ -492,11 +458,11 @@ public final class CLIPrompter {
try {
added = addUserChoice(val, chs, index.intValue());
} catch (final NumberFormatException e) {
LOGGER.log(Level.FINER,
"Unrecognized number. Prompting user again.", e); //$NON-NLS-1$
LOGGER.log(Level.FINER, "Unrecognized number. Prompting user again.", //$NON-NLS-1$
e);
keepOn = true;
manager.println(CLIPrompterMessages
.getString(PROMPTCHOICE_FORMATERR, ZERO, index));
manager.println(CLIPrompterMessages.getString(PROMPTCHOICE_FORMATERR,
ZERO, index));
listChoices(manager, choices, null);
break;
}
@@ -522,11 +488,10 @@ public final class CLIPrompter {
* @return the chosen objects
* @throws IOException if the manager was closed */
public static <U, T> List<T> promptMultiChoice(final ConsoleOutput manager,
final ConsoleInput input,
final Map<U, T> choicesMap,
final String message) throws IOException {
return promptMultiChoice(manager, input,
new ArrayList<>(choicesMap.keySet()), choicesMap, message);
final ConsoleInput input, final Map<U, T> choicesMap, final String message)
throws IOException {
return promptMultiChoice(manager, input, new ArrayList<>(choicesMap.keySet()),
choicesMap, message);
}
/** Prompt the user for a non empty text.
@@ -536,9 +501,8 @@ public final class CLIPrompter {
* @param reprompt the prompting message after empty input
* @return the non empty input
* @throws IOException if the manager was closed */
public static String promptNonEmpty(final ConsoleInput manager,
final String prompt,
final String reprompt) throws IOException {
public static String promptNonEmpty(final ConsoleInput manager, final String prompt,
final String reprompt) throws IOException {
String res = manager.prompt(prompt);
while (res.isEmpty()) {
res = manager.prompt(reprompt);

View File

@@ -82,12 +82,12 @@ import java.util.logging.Logger;
* @author Emmanuel BIGEON */
public final class CLIPrompterMessages {
/** The resource name. */
private static final String BUNDLE_NAME = "net.bigeon.gclc.messages"; //$NON-NLS-1$
private static final String BUNDLE_NAME = "net.bigeon.gclc.messages"; //$NON-NLS-1$
/** The resource. */
private static final ResourceBundle RESOURCE_BUNDLE = ResourceBundle
.getBundle(BUNDLE_NAME);
/** The logger. */
private static final Logger LOGGER = Logger
private static final Logger LOGGER = Logger
.getLogger(CLIPrompterMessages.class.getName());
/** Utility class. */

View File

@@ -74,17 +74,17 @@ package net.bigeon.gclc.tools;
public class ConstantString implements StringProvider {
private final String string;
/* (non-Javadoc)
* @see net.bigeon.gclc.tools.StringProvider#apply() */
@Override
public String apply() {
return string;
}
/** Create a provider for a string.
*
* @param string the string */
public ConstantString(String string) {
this.string = string;
}
/* (non-Javadoc)
* @see net.bigeon.gclc.tools.StringProvider#apply() */
@Override
public String apply() {
return string;
}
}

View File

@@ -80,27 +80,27 @@ import java.util.List;
public final class PrintUtils {
/** The continuation dot string. */
private static final String CONT_DOT = "..."; //$NON-NLS-1$
private static final String CONT_DOT = "..."; //$NON-NLS-1$
/** The continuation dot string length. */
private static final int CONT_DOT_LENGTH = CONT_DOT.length();
private static final int CONT_DOT_LENGTH = CONT_DOT.length();
/** The empty string constant. */
private static final String EMPTY = ""; //$NON-NLS-1$
private static final String EMPTY = ""; //$NON-NLS-1$
/** Utility class. */
private PrintUtils() {
// Utility class
}
/** Print the text possibly cutting it if it goes over the authorized length
* and adding a mark of continuation.
/** Print the text possibly cutting it if it goes over the authorized length and
* adding a mark of continuation.
*
* @param text the text to print
* @param nbCharacters the number of characters of the resulting text
* @param indicateTooLong if an indication shell be given that the text
* didn't fit
* @param indicateTooLong if an indication shell be given that the text didn't
* fit
* @return the text to print (will be of exactly nbCharacters). */
public static String print(final String text, final int nbCharacters,
final boolean indicateTooLong) {
final boolean indicateTooLong) {
StringBuilder res = new StringBuilder(text);
if (res.length() > nbCharacters) {
// Cut
@@ -125,8 +125,7 @@ public final class PrintUtils {
* @param i the length of the wrap
* @return the list of resulting strings */
public static List<String> wrap(final String description, final int i) {
final String[] originalLines = description
.split(System.lineSeparator());
final String[] originalLines = description.split(System.lineSeparator());
final List<String> result = new ArrayList<>();
for (final String string : originalLines) {
String toCut = string;

View File

@@ -83,14 +83,14 @@ import java.util.logging.Logger;
public abstract class AOutputForwardRunnable implements Runnable {
/** The class logger. */
private static final Logger LOGGER = Logger
private static final Logger LOGGER = Logger
.getLogger(AOutputForwardRunnable.class.getName());
/** The default timeout (one tenth of second). */
private static final long DEFAULT_TIMEOUT = 100;
private static final long DEFAULT_TIMEOUT = 100;
/** The manager. */
private final PipedConsoleOutput manager;
/** The timeout. */
private final long timeout;
private final long timeout;
/** Create a forwarding runnable.
*
@@ -103,19 +103,18 @@ public abstract class AOutputForwardRunnable implements Runnable {
/** Create a forward runnable with the given timeout.
* <p>
* Short timeout will be very responsive to the application actual messages,
* but may use computation time if the application is not verbose. Long
* timeout will save computation time, but will read batches of messages at
* once if the application is verbose. The right length for the timeout is
* likely to depend on the application and the use of it.
* Short timeout will be very responsive to the application actual messages, but
* may use computation time if the application is not verbose. Long timeout will
* save computation time, but will read batches of messages at once if the
* application is verbose. The right length for the timeout is likely to depend
* on the application and the use of it.
* <p>
* If you do not know what timeout length to use, please use the
* {@link #AOutputForwardRunnable(PipedConsoleOutput)} constructor.
*
* @param manager the manager
* @param timeout the timeout between message requests. */
public AOutputForwardRunnable(final PipedConsoleOutput manager,
final long timeout) {
public AOutputForwardRunnable(final PipedConsoleOutput manager, final long timeout) {
super();
this.manager = manager;
this.timeout = timeout;

View File

@@ -36,7 +36,9 @@
* gclc:net.bigeon.gclc.manager.EmptyInput.java
* Created on: Nov 13, 2017
*/
package net.bigeon.gclc.manager;
package net.bigeon.gclc.utils;
import net.bigeon.gclc.manager.ConsoleInput;
/*-
* #%L
@@ -80,12 +82,15 @@ import net.bigeon.gclc.tools.StringProvider;
* @author Emmanuel Bigeon */
public final class EmptyInput implements ConsoleInput {
private static final ConstantString CONSTANT_STRING = new ConstantString("");
/** The empty prompter. */
public static final ConsoleInput INSTANCE = new EmptyInput();
/** The empty input. */
private EmptyInput() {
//
}
/* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleInput#close() */
@Override
@@ -97,7 +102,7 @@ public final class EmptyInput implements ConsoleInput {
* @see net.bigeon.gclc.manager.ConsoleInput#getPrompt() */
@Override
public StringProvider getPrompt() {
return new ConstantString(""); //$NON-NLS-1$
return CONSTANT_STRING; //$NON-NLS-1$
}
/* (non-Javadoc)
@@ -136,11 +141,9 @@ public final class EmptyInput implements ConsoleInput {
}
/* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String,
* long) */
* @see net.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, long) */
@Override
public String prompt(final String message,
final long timeout) {
public String prompt(final String message, final long timeout) {
return ""; //$NON-NLS-1$
}
@@ -153,6 +156,6 @@ public final class EmptyInput implements ConsoleInput {
@Override
public void setPrompt(StringProvider string) {
//
//
}
}

View File

@@ -87,17 +87,16 @@ import net.bigeon.gclc.tools.StringProvider;
* used to test application behavior.
*
* @author Emmanuel Bigeon */
public final class PipedConsoleInput
implements ConsoleInput {
public final class PipedConsoleInput implements ConsoleInput {
/** THe inner manager. */
private final StreamConsoleInput innerManager;
/** The stream to pipe commands into. */
private final PipedOutputStream commandInput;
private final PipedOutputStream commandInput;
/** The stream for the application to read commands from. */
private final PipedInputStream in;
private final PipedInputStream in;
/** The writing thread. */
private final WritingRunnable writing;
private final WritingRunnable writing;
/** Create a manager that will write and read through piped stream.
*
@@ -106,11 +105,9 @@ public final class PipedConsoleInput
public PipedConsoleInput(final PrintStream outPrint) throws IOException {
commandInput = new PipedOutputStream();
in = new PipedInputStream(commandInput);
innerManager = new StreamConsoleInput(outPrint, in,
StandardCharsets.UTF_8);
innerManager = new StreamConsoleInput(outPrint, in, StandardCharsets.UTF_8);
writing = new WritingRunnable(commandInput, StandardCharsets.UTF_8);
final Thread th = new Thread(writing,
"GCLC console piped input stream"); //$NON-NLS-1$
final Thread th = new Thread(writing, "GCLC console piped input stream"); //$NON-NLS-1$
th.start();
}
@@ -145,8 +142,7 @@ public final class PipedConsoleInput
* @see net.bigeon.gclc.manager.ConsoleInput#prompt() */
@Override
public String prompt() throws IOException {
return innerManager
.prompt(innerManager.getPrompt() + System.lineSeparator());
return innerManager.prompt(innerManager.getPrompt() + System.lineSeparator());
}
/* (non-Javadoc)
@@ -164,8 +160,7 @@ public final class PipedConsoleInput
}
/* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String,
* long) */
* @see net.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, long) */
@Override
public String prompt(final String message, final long timeout) throws IOException {
return innerManager.prompt(message + System.lineSeparator(), timeout);
@@ -180,7 +175,7 @@ public final class PipedConsoleInput
@Override
public void setPrompt(StringProvider string) {
innerManager.setPrompt(string);
innerManager.setPrompt(string);
}
/** Type a message in the input.

View File

@@ -87,21 +87,20 @@ import net.bigeon.gclc.manager.ConsoleOutput;
* used to test application behavior.
*
* @author Emmanuel Bigeon */
public final class PipedConsoleOutput
implements ConsoleOutput {
public final class PipedConsoleOutput implements ConsoleOutput {
/** The encoding between streams. */
private static final String UTF_8 = "UTF-8"; //$NON-NLS-1$
private static final String UTF_8 = "UTF-8"; //$NON-NLS-1$
/** THe inner manager. */
private final StreamConsoleOutput innerManager;
/** The reader to get application return from. */
private final BufferedReader commandBuffOutput;
private final BufferedReader commandBuffOutput;
/** The stream to get application return from. */
private final PipedInputStream commandOutput;
private final PipedInputStream commandOutput;
/** The print writer for application to write return to. */
private final PrintStream outPrint;
private final PrintStream outPrint;
/** The reading thread. */
private final ReadingRunnable reading;
private final ReadingRunnable reading;
/** Create a manager that will write and read through piped stream.
*
@@ -140,14 +139,14 @@ public final class PipedConsoleOutput
/** Wait for a specific message to arrive.
* <p>
* When this method returns, the message was appended to the data, it
* <em>may or may not</em> be the next line of data.
* When this method returns, the message was appended to the data, it <em>may or
* may not</em> be the next line of data.
*
* @param message the message
* @return the thread to join to wait for message delivery
* @see net.bigeon.gclc.utils.ReadingRunnable#getWaitForDelivery(java.lang.String) */
public Thread getWaitForDelivery(final String message) {
return reading.getWaitForDelivery(message);
* @throws InterruptedException if the wait on the message was interrupted
* @see net.bigeon.gclc.utils.ReadingRunnable#waitForDelivery(String) */
public void waitForDelivery(final String message) throws InterruptedException {
reading.waitForDelivery(message);
}
/* (non-Javadoc)

View File

@@ -76,8 +76,8 @@ import java.io.IOException;
import java.io.InterruptedIOException;
import java.util.ArrayDeque;
import java.util.Deque;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.logging.Level;
import java.util.logging.Logger;
@@ -86,91 +86,31 @@ import java.util.logging.Logger;
* @author Emmanuel Bigeon */
public final class ReadingRunnable implements Runnable {
/** The runnable to wait for arrival of a message in the queue.
*
* @author Emmanuel Bigeon */
private final class ToWaitRunnable implements Runnable {
/** The Object. */
private final Object obj;
/** The locking object. */
private final Object start;
/** The message. */
private final String message;
/** The started status. */
private boolean started = false;
/** Create the waiting runnable.
*
* @param obj the object to lock on
* @param start the object to notify when ready to wait
* @param message the message to wait for */
public ToWaitRunnable(final Object obj, final Object start,
final String message) {
this.obj = obj;
this.start = start;
this.message = message;
}
/** Test if the waiting runnable is started.
*
* @return the started */
public boolean isStarted() {
synchronized (start) {
return started;
}
}
/* (non-Javadoc)
* @see java.lang.Runnable#run() */
@Override
public void run() {
synchronized (obj) {
synchronized (start) {
started = true;
start.notifyAll();
}
while (isRunning()) {
try {
obj.wait();
if (delivering.equals(message)) {
return;
}
} catch (final InterruptedException e) {
LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION,
e);
Thread.currentThread().interrupt();
}
}
}
}
}
/** The thread intteruption logging message. */
private static final String THREAD_INTERRUPTION_EXCEPTION = "Thread interruption exception."; //$NON-NLS-1$
/** The closed pipe message. */
private static final String CLOSED_PIPE = "Closed pipe"; //$NON-NLS-1$
private static final String CLOSED_PIPE = "Closed pipe"; //$NON-NLS-1$
/** Wait timeout. */
private static final long TIMEOUT = 1000;
private static final long TIMEOUT = 1000;
/** Class logger. */
private static final Logger LOGGER = Logger
private static final Logger LOGGER = Logger
.getLogger(ReadingRunnable.class.getName());
/** Read messages. */
private final Deque<String> messages = new ArrayDeque<>();
/** the reader. */
private final BufferedReader reader;
/** the state of this runnable. */
private boolean running = true;
/** Synchro object. */
private final Object lock = new Object();
/** The waiting status for a message. */
private boolean waiting;
/** The blocker for a given message. */
private final Map<String, Object> messageBlocker = new HashMap<>();
/** The lock. */
private final Object messageBlockerLock = new Object();
/** The message being delivered. */
private String delivering;
/** the reader. */
private final BufferedReader reader;
/** the state of this runnable. */
private boolean running = true;
/** Synchro object. */
private final Object lock = new Object();
/** The waiting status for a message. */
private boolean waiting;
/** The blocker for a given message. */
private final Map<String, Object> messageBlocker = new ConcurrentHashMap<>();
/** The lock. */
private final Object messageBlockerLock = new Object();
/** Create a reading runnable.
*
* @param reader the input to read from */
@@ -179,28 +119,17 @@ public final class ReadingRunnable implements Runnable {
this.reader = reader;
}
/** Strip the string from head NULL characters.
/** Do wait for a message.
* <p>
* This method should only be called inside a loop.
*
* @param line the line to strip the null character from
* @return the resulting string */
private static String stripNull(final String line) {
String res = line;
while (res.length() > 0 && res.charAt(0) == 0) {
LOGGER.severe(
"NULL character heading the result of the read. This is a stream problem..."); //$NON-NLS-1$
res = res.substring(1);
}
return res;
}
/** do wait for a message.
* <p>This method should only be called inside a loop.
* @param timeout the timeout of the wait.
* @throws IOException if the runnable was stopped and no essage was found.
*/
* @throws IOException if the runnable was stopped and no essage was found. */
private void doWaitMessage(final long timeout) throws IOException {
try {
lock.wait(timeout);
synchronized (lock) {
lock.wait(timeout);
}
} catch (final InterruptedException e) {
LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION, e);
Thread.currentThread().interrupt();
@@ -221,7 +150,7 @@ public final class ReadingRunnable implements Runnable {
}
waiting = true;
waitMessage(TIMEOUT);
LOGGER.finest("Polled: " + messages.peek()); //$NON-NLS-1$
LOGGER.log(Level.FINEST, "Polled: {0}", messages.peek()); //$NON-NLS-1$
waiting = false;
notifyMessage(messages.peek());
return messages.poll();
@@ -248,34 +177,16 @@ public final class ReadingRunnable implements Runnable {
}
}
/** Get a waiting thread for a specific message delivery.
*
* @param message the message
* @return the thread to join to wait for message delivery */
public Thread getWaitForDelivery(final String message) {
public void waitForDelivery(String message) throws InterruptedException {
Object mLock;
synchronized (messageBlockerLock) {
if (!messageBlocker.containsKey(message)) {
messageBlocker.put(message, new Object());
}
final Object obj = messageBlocker.get(message);
final Object start = new Object();
final ToWaitRunnable waitRunn = new ToWaitRunnable(obj, start,
message);
final Thread th = new Thread(waitRunn);
synchronized (start) {
th.start();
while (!waitRunn.isStarted()) {
try {
start.wait(TIMEOUT);
} catch (final InterruptedException e) {
LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION,
e);
Thread.currentThread().interrupt();
}
}
}
return th;
mLock = messageBlocker.get(message);
}
synchronized (mLock) {
mLock.wait();
}
}
@@ -292,8 +203,7 @@ public final class ReadingRunnable implements Runnable {
}
}
/** Interrupts the wait on the next message by providing an empty
* message. */
/** Interrupts the wait on the next message by providing an empty message. */
public void interrupt() {
synchronized (lock) {
if (waiting) {
@@ -317,9 +227,8 @@ public final class ReadingRunnable implements Runnable {
* @param message the message */
private void notifyMessage(final String message) {
synchronized (messageBlockerLock) {
delivering = message;
if (messageBlocker.containsKey(message)) {
final Object mLock = messageBlocker.get(message);
final Object mLock = messageBlocker.get(message);
if (mLock!=null) {
synchronized (mLock) {
mLock.notifyAll();
}
@@ -332,32 +241,41 @@ public final class ReadingRunnable implements Runnable {
* @see java.lang.Runnable#run() */
@Override
public void run() {
while (running) {
while (true) {
synchronized (lock) {
if (!running) {
break;
}
}
try {
String line = reader.readLine();
if (line == null) {
// Buffer end
running = false;
setRunning(false);
return;
}
LOGGER.finer("Read: " + line); //$NON-NLS-1$
LOGGER.log(Level.FINER, "Read: {0}", line); //$NON-NLS-1$
line = stripNull(line);
synchronized (lock) {
messages.add(line);
lock.notifyAll();
}
} catch (final InterruptedIOException e) {
if (running) {
LOGGER.info("Reading interrupted"); //$NON-NLS-1$
synchronized (lock) {
if (running) {
LOGGER.info("Reading interrupted"); //$NON-NLS-1$
}
}
LOGGER.log(Level.FINER,
"Read interruption was caused by an exception", e); //$NON-NLS-1$
LOGGER.log(Level.FINER, "Read interruption was caused by an exception", //$NON-NLS-1$
e);
} catch (final IOException e) {
LOGGER.log(Level.FINE, "The stream reading threw an exception", //$NON-NLS-1$
e);
if (running) {
LOGGER.severe("Unable to read from stream"); //$NON-NLS-1$
running = false;
synchronized (lock) {
if (running) {
LOGGER.severe("Unable to read from stream"); //$NON-NLS-1$
setRunning(false);
}
}
return;
}
@@ -373,14 +291,28 @@ public final class ReadingRunnable implements Runnable {
}
}
/** Wait for the next message to be integratted.
/** Wait for the next message to be integrated.
*
* @param timeout the timeout to wait
* @throws IOException if the next message was not delivered and the
* runnable stopped. */
* @throws IOException if the next message was not delivered and the runnable
* stopped. */
private void waitMessage(final long timeout) throws IOException {
while (messages.isEmpty()) {
doWaitMessage(timeout);
}
}
/** Strip the string from head NULL characters.
*
* @param line the line to strip the null character from
* @return the resulting string */
private static String stripNull(final String line) {
String res = line;
while (res.length() > 0 && res.charAt(0) == 0) {
LOGGER.severe(
"NULL character heading the result of the read. This is a stream problem..."); //$NON-NLS-1$
res = res.substring(1);
}
return res;
}
}

View File

@@ -85,6 +85,7 @@ public final class SinkOutput implements ConsoleOutput {
private SinkOutput() {
//
}
/* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleOutput#close() */
@Override
@@ -114,8 +115,7 @@ public final class SinkOutput implements ConsoleOutput {
}
/* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String)
*/
* @see net.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String) */
@Override
public void println(final String message) {
//

View File

@@ -96,12 +96,12 @@ public final class StreamConsoleInput implements ConsoleInput {
private StringProvider prompt = DEFAULT_PROMPT;
/** The print stream. */
private final PrintStream out;
private final PrintStream out;
/** The input stream. */
private final BufferedReader in;
/** If the manager is closed. */
private boolean closed = false;
private boolean closed;
/** The prompting thread. */
private final Thread promptThread;
@@ -109,8 +109,8 @@ public final class StreamConsoleInput implements ConsoleInput {
/** The reading runnable. */
private final ReadingRunnable reading;
/** This default constructor relies on the system defined standart output
* and input stream. */
/** This default constructor relies on the system defined standart output and
* input stream. */
public StreamConsoleInput() {
this(System.out, System.in, Charset.defaultCharset());
}
@@ -121,7 +121,7 @@ public final class StreamConsoleInput implements ConsoleInput {
* @param in the input stream
* @param charset the charset for the input */
public StreamConsoleInput(final PrintStream out, final InputStream in,
final Charset charset) {
final Charset charset) {
super();
this.out = out;
this.in = new BufferedReader(new InputStreamReader(in, charset));
@@ -143,7 +143,7 @@ public final class StreamConsoleInput implements ConsoleInput {
/* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleManager#close() */
@Override
public void close() throws IOException {
public void close() {
closed = true;
reading.setRunning(false);
promptThread.interrupt();
@@ -200,8 +200,7 @@ public final class StreamConsoleInput implements ConsoleInput {
/* (non-Javadoc)
* @see net.bigeon.gclc.ConsoleManager#prompt(java.lang.String) */
@Override
public String prompt(final String message,
final long timeout) throws IOException {
public String prompt(final String message, final long timeout) throws IOException {
checkOpen();
if (out != null) {
out.print(message);
@@ -219,6 +218,6 @@ public final class StreamConsoleInput implements ConsoleInput {
@Override
public void setPrompt(StringProvider string) {
this.prompt = string;
prompt = string;
}
}

View File

@@ -85,10 +85,10 @@ public final class StreamConsoleOutput implements ConsoleOutput {
/** The print stream. */
private final PrintStream out;
/** If the manager is closed. */
private boolean closed = false;
private boolean closed;
/** This default constructor relies on the system defined standart output
* and input stream. */
/** This default constructor relies on the system defined standart output and
* input stream. */
public StreamConsoleOutput() {
this(System.out);
}

View File

@@ -88,18 +88,18 @@ import java.util.logging.Logger;
public final class WritingRunnable implements Runnable {
/** Wait timeout. */
private static final long TIMEOUT = 1000;
private static final long TIMEOUT = 1000;
/** Class logger. */
private static final Logger LOGGER = Logger
private static final Logger LOGGER = Logger
.getLogger(WritingRunnable.class.getName());
/** Messages to write. */
private final Deque<String> messages = new ArrayDeque<>();
/** Stream to write to. */
private final OutputStream outPrint;
private final OutputStream outPrint;
/** The charset. */
private final Charset charset;
private final Charset charset;
/** Runnable state. */
private boolean running = true;
private boolean running = true;
/** Synchro object. */
private final Object lock = new Object();
@@ -143,15 +143,14 @@ public final class WritingRunnable implements Runnable {
public void run() {
while (running) {
synchronized (lock) {
while (messages.isEmpty()) {
waitNextMessage();
if (!running) {
return;
}
waitNextMessage();
if (!running) {
return;
}
writeMessage();
}
}
}
/** Set the running status.
@@ -166,11 +165,16 @@ public final class WritingRunnable implements Runnable {
/** Wait for next message. */
private void waitNextMessage() {
try {
lock.wait(TIMEOUT);
synchronized (lock) {
while (running && messages.isEmpty()) {
lock.wait(TIMEOUT);
}
}
} catch (final InterruptedException e) {
if (running) {
LOGGER.log(Level.SEVERE,
"Thread interruption exception.", e); //$NON-NLS-1$
synchronized (lock) {
if (running) {
LOGGER.log(Level.SEVERE, "Thread interruption exception.", e); //$NON-NLS-1$
}
}
Thread.currentThread().interrupt();
}
@@ -179,8 +183,7 @@ public final class WritingRunnable implements Runnable {
/** Write next message to output. */
private void writeMessage() {
final String message = messages.poll();
final ByteBuffer buff = charset
.encode(message + System.lineSeparator());
final ByteBuffer buff = charset.encode(message + System.lineSeparator());
if (buff.hasArray()) {
try {
outPrint.write(buff.array());

View File

@@ -1,7 +1,4 @@
/**
* @author Emmanuel Bigeon
*
*/
/** @author Emmanuel Bigeon */
package net.bigeon.gclc.utils;
/*-

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 685 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.0 KiB

View File

@@ -73,7 +73,6 @@ package net.bigeon.gclc;
*/
import java.io.IOException;
import net.bigeon.gclc.ConsoleApplication;
import net.bigeon.gclc.command.ICommand;
import net.bigeon.gclc.exception.InvalidCommandName;
import net.bigeon.gclc.utils.PipedConsoleInput;
@@ -83,16 +82,14 @@ import net.bigeon.gclc.utils.PipedConsoleOutput;
* <p>
* TODO
*
* @author Emmanuel Bigeon
*
*/
* @author Emmanuel Bigeon */
@SuppressWarnings("javadoc")
public class CommandTestingApplication implements AutoCloseable {
private final ConsoleApplication application;
private final Thread th;
private final Thread th;
private final PipedConsoleOutput out;
private final PipedConsoleInput in;
private final PipedConsoleInput in;
/** @throws IOException if the streams cannot be build */
public CommandTestingApplication() throws IOException {

View File

@@ -87,8 +87,6 @@ import java.nio.charset.StandardCharsets;
import org.junit.Test;
import net.bigeon.gclc.CommandRequestListener;
import net.bigeon.gclc.ConsoleApplication;
import net.bigeon.gclc.command.ICommand;
import net.bigeon.gclc.command.base.ExitCommand;
import net.bigeon.gclc.exception.CommandRunException;
@@ -103,7 +101,7 @@ import net.bigeon.gclc.utils.PipedConsoleOutput;
/** Test class for ConsoleApplication
*
* @author Emmanuel Bigeon */
@SuppressWarnings({"javadoc", "nls", "static-method"})
@SuppressWarnings({ "javadoc", "nls", "static-method" })
public class ConsoleApplicationTest {
/** 3 seconds in milliseconds */
@@ -114,13 +112,11 @@ public class ConsoleApplicationTest {
public void testConsoleApplication() {
try (PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(
new PrintStream(pout))) {
final ConsoleApplication app = new ConsoleApplication(null, in,
"", "");
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(new PrintStream(pout))) {
final ConsoleApplication app = new ConsoleApplication(null, in, "", "");
app.exit();
} catch (final IOException e) {
fail("System Console Manager failed");
@@ -129,14 +125,13 @@ public class ConsoleApplicationTest {
}
@Test
public void testExecution() throws IOException, InterruptedException,
InvalidCommandName {
public void testExecution()
throws IOException, InterruptedException, InvalidCommandName {
try (CommandTestingApplication application = new CommandTestingApplication()) {
// remove welcome
assertEquals("Header should be preserved",
application.getApplication().header,
application.readNextLine());
application.getApplication().header, application.readNextLine());
// Remove first prompt
application.sendCommand("");
application.sendCommand("test");
@@ -146,15 +141,13 @@ public class ConsoleApplicationTest {
assertEquals("Command fail should dispaly appropriate message",
Messages.getString("ConsoleApplication.cmd.failed", "toto"),
application.readNextLine());
assertEquals(
"Unrecognized comment should result in a specific message.",
assertEquals("Unrecognized comment should result in a specific message.",
Messages.getString("CommandProvider.unrecognized", "toto"),
application.readNextLine());
application.sendCommand("long");
assertEquals("Before wait should receive message", "Waita minute",
application.readNextLine());
assertEquals("Unexpected message", "done!",
application.readNextLine());
assertEquals("Unexpected message", "done!", application.readNextLine());
final CommandRequestListener crl = new CommandRequestListener() {
@@ -184,22 +177,20 @@ public class ConsoleApplicationTest {
application.sendCommand("exit");
assertEquals("Footer should be preserved",
application.getApplication().footer,
application.readNextLine());
application.getApplication().footer, application.readNextLine());
assertFalse("Stopped application should not be running",
application.getApplication().isRunning());
}
ConsoleApplication appli = null;
try (PipedConsoleOutput manager = new PipedConsoleOutput();
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(
new PrintStream(pout))) {
final ConsoleApplication app = new ConsoleApplication(manager, in,
null, null);
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(new PrintStream(pout))) {
final ConsoleApplication app = new ConsoleApplication(manager, in, null,
null);
appli = app;
app.add(new ExitCommand("exit", app));
@@ -219,17 +210,15 @@ public class ConsoleApplicationTest {
"Application should still exist even if the console input and output are closed.",
appli);
appli.start();
assertFalse(
"Application should not start on closed console input and output",
assertFalse("Application should not start on closed console input and output",
appli.isRunning());
}
@Test
public void testInterpretCommand() throws InvalidCommandName, IOException {
try (PipedConsoleInput test = new PipedConsoleInput(null);
PipedConsoleOutput out = new PipedConsoleOutput()) {
final ConsoleApplication appl = new ConsoleApplication(out, test,
"", "");
PipedConsoleOutput out = new PipedConsoleOutput()) {
final ConsoleApplication appl = new ConsoleApplication(out, test, "", "");
appl.interpretCommand("invalid cmd \"due to misplaced\"quote");
assertEquals("Specific error message expected",
@@ -245,11 +234,9 @@ public class ConsoleApplicationTest {
* manager.ConsoleOutput, net.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out,
final ConsoleInput in,
final String... args) throws CommandRunException {
throw new CommandRunException(CommandRunExceptionType.USAGE,
message);
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
throw new CommandRunException(CommandRunExceptionType.USAGE, message);
}
@Override
@@ -258,8 +245,8 @@ public class ConsoleApplicationTest {
}
@Override
public void help(final ConsoleOutput manager,
final String... args) throws IOException {
public void help(final ConsoleOutput manager, final String... args)
throws IOException {
manager.println(message);
}

View File

@@ -69,12 +69,10 @@ package net.bigeon.gclc;
*/
import java.io.IOException;
import net.bigeon.gclc.ApplicationAttachement;
import net.bigeon.gclc.ConsoleApplication;
import net.bigeon.gclc.command.Command;
import net.bigeon.gclc.command.HelpExecutor;
import net.bigeon.gclc.command.ICommandProvider;
import net.bigeon.gclc.command.base.ExitCommand;
import net.bigeon.gclc.command.base.HelpExecutor;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.InvalidCommandName;
import net.bigeon.gclc.manager.ConsoleInput;

View File

@@ -79,13 +79,12 @@ import java.util.List;
import org.junit.Test;
import net.bigeon.gclc.GCLCConstants;
import net.bigeon.gclc.exception.CommandParsingException;
/** Test class for {@link GCLCConstants}
*
* @author Emmanuel Bigeon */
@SuppressWarnings({"nls", "static-method"})
@SuppressWarnings({ "nls", "static-method" })
public class GCLCConstantsTest {
/** Test method for
@@ -96,63 +95,47 @@ public class GCLCConstantsTest {
public void testSplitCommand() throws CommandParsingException {
List<String> res;
res = GCLCConstants.splitCommand("aCommand");
assertTrue("single word command should have one element",
res.size() == 1);
assertTrue("Command should be preserved",
res.get(0).equals("aCommand"));
assertTrue("single word command should have one element", res.size() == 1);
assertTrue("Command should be preserved", res.get(0).equals("aCommand"));
res = GCLCConstants.splitCommand("aCommand with some arguments");
assertEquals("Command size", 4, res.size());
assertEquals("Elements should be preserved", "aCommand", res.get(0));
assertTrue("Elements should be preserved", res.get(1).equals("with"));
assertTrue("Elements should be preserved", res.get(2).equals("some"));
assertTrue("Elements should be preserved",
res.get(3).equals("arguments"));
assertTrue("Elements should be preserved", res.get(3).equals("arguments"));
res = GCLCConstants.splitCommand("aCommand with some arguments");
assertEquals("Command size", 4, res.size());
assertTrue("Elements should be preserved",
res.get(0).equals("aCommand"));
assertTrue("Elements should be preserved", res.get(0).equals("aCommand"));
assertTrue("Elements should be preserved", res.get(1).equals("with"));
assertTrue("Elements should be preserved", res.get(2).equals("some"));
assertTrue("Elements should be preserved",
res.get(3).equals("arguments"));
assertTrue("Elements should be preserved", res.get(3).equals("arguments"));
res = GCLCConstants.splitCommand("aCommand \"with some\" arguments");
assertEquals("Command size", 3, res.size());
assertTrue("Elements should be preserved",
res.get(0).equals("aCommand"));
assertTrue("Elements should be preserved",
res.get(1).equals("with some"));
assertTrue("Elements should be preserved",
res.get(2).equals("arguments"));
assertTrue("Elements should be preserved", res.get(0).equals("aCommand"));
assertTrue("Elements should be preserved", res.get(1).equals("with some"));
assertTrue("Elements should be preserved", res.get(2).equals("arguments"));
res = GCLCConstants.splitCommand("aCommand with\\ some arguments");
assertEquals("Command size", 3, res.size());
assertTrue("Elements should be preserved",
res.get(0).equals("aCommand"));
assertTrue("Elements should be preserved",
res.get(1).equals("with some"));
assertTrue("Elements should be preserved",
res.get(2).equals("arguments"));
assertTrue("Elements should be preserved", res.get(0).equals("aCommand"));
assertTrue("Elements should be preserved", res.get(1).equals("with some"));
assertTrue("Elements should be preserved", res.get(2).equals("arguments"));
res = GCLCConstants.splitCommand("aCommand wi\\\"th some arguments");
assertEquals("Command size", 4, res.size());
assertTrue("Elements should be preserved",
res.get(0).equals("aCommand"));
assertTrue("Elements should be preserved", res.get(0).equals("aCommand"));
assertTrue("Elements should be preserved", res.get(1).equals("wi\"th"));
assertTrue("Elements should be preserved", res.get(2).equals("some"));
assertTrue("Elements should be preserved",
res.get(3).equals("arguments"));
assertTrue("Elements should be preserved", res.get(3).equals("arguments"));
res = GCLCConstants.splitCommand("aCommand with \"some arguments\"");
assertEquals("Command size", 3, res.size());
assertTrue("Elements should be preserved",
res.get(0).equals("aCommand"));
assertTrue("Elements should be preserved", res.get(0).equals("aCommand"));
assertTrue("Elements should be preserved", res.get(1).equals("with"));
assertTrue("Elements should be preserved",
res.get(2).equals("some arguments"));
assertTrue("Elements should be preserved", res.get(2).equals("some arguments"));
try {
// Wrong lines?
res = GCLCConstants
.splitCommand("aCommand with \"some ar\"guments");
res = GCLCConstants.splitCommand("aCommand with \"some ar\"guments");
fail("Misplaced quotes should fail");
} catch (final CommandParsingException e) {
// ok

View File

@@ -82,7 +82,6 @@ import java.util.Set;
import org.junit.Test;
import net.bigeon.gclc.command.CommandParameters;
import net.bigeon.gclc.exception.CommandParsingException;
/**
@@ -90,7 +89,7 @@ import net.bigeon.gclc.exception.CommandParsingException;
* TODO
*
* @author Emmanuel Bigeon */
@SuppressWarnings({"static-method", "nls"})
@SuppressWarnings({ "static-method", "nls" })
public class CommandParametersTest {
/** Test method for
@@ -101,8 +100,7 @@ public class CommandParametersTest {
public final void testCommandParameters() throws CommandParsingException {
final Set<String> strings = new HashSet<>();
final Set<String> bools = new HashSet<>();
CommandParameters parameters = new CommandParameters(bools, strings,
true);
CommandParameters parameters = new CommandParameters(bools, strings, true);
try {
parameters.parseArgs("-ungivenFlag");
@@ -127,8 +125,7 @@ public class CommandParametersTest {
bools.add("boolFlag");
strings.add("str");
final CommandParameters parameters = new CommandParameters(bools,
strings, true);
final CommandParameters parameters = new CommandParameters(bools, strings, true);
assertNull(parameters.get("ungiven"));
assertNull(parameters.get("str"));
@@ -157,7 +154,8 @@ public class CommandParametersTest {
}
/** Test method for
* {@link net.bigeon.gclc.command.CommandParameters#getAdditionals()}. */
* {@link net.bigeon.gclc.command.CommandParameters#getAdditionals()}.
* @throws CommandParsingException if the parameter parsing failed*/
@Test
public final void testGetAdditionals() throws CommandParsingException {
final Set<String> strings = new HashSet<>();
@@ -166,8 +164,7 @@ public class CommandParametersTest {
bools.add("boolFlag");
strings.add("str");
CommandParameters parameters = new CommandParameters(bools, strings,
true);
CommandParameters parameters = new CommandParameters(bools, strings, true);
parameters.parseArgs("-boolFlag");
assertTrue(parameters.getAdditionals().isEmpty());
@@ -191,7 +188,7 @@ public class CommandParametersTest {
}
/** Test method for
* {@link net.bigeon.gclc.command.CommandParameters#getBool(java.lang.String)}.
* {@link net.bigeon.gclc.command.CommandParameters#isActive(String)}.
*
* @throws CommandParsingException if a command parsing failed */
@Test
@@ -202,15 +199,14 @@ public class CommandParametersTest {
bools.add("boolFlag");
strings.add("str");
CommandParameters parameters = new CommandParameters(bools, strings,
true);
CommandParameters parameters = new CommandParameters(bools, strings, true);
assertFalse(parameters.getBool("ungiven"));
assertFalse(parameters.getBool("boolFlag"));
assertFalse(parameters.isActive("ungiven"));
assertFalse(parameters.isActive("boolFlag"));
parameters.parseArgs("-boolFlag");
assertTrue(parameters.getBool("boolFlag"));
assertFalse(parameters.getBool("ungiven"));
assertTrue(parameters.isActive("boolFlag"));
assertFalse(parameters.isActive("ungiven"));
try {
parameters.parseArgs("-ungiven");
@@ -218,29 +214,29 @@ public class CommandParametersTest {
} catch (final CommandParsingException e) {
// ok
}
assertFalse(parameters.getBool("ungiven"));
assertTrue(parameters.getBool("boolFlag"));
assertFalse(parameters.isActive("ungiven"));
assertTrue(parameters.isActive("boolFlag"));
parameters = new CommandParameters(bools, strings, false);
assertFalse(parameters.getBool("ungiven"));
assertFalse(parameters.getBool("boolFlag"));
assertFalse(parameters.isActive("ungiven"));
assertFalse(parameters.isActive("boolFlag"));
try {
parameters.parseArgs("-boolFlag");
} catch (final CommandParsingException e) {
// ok
}
assertTrue(parameters.getBool("boolFlag"));
assertFalse(parameters.getBool("ungiven"));
assertTrue(parameters.isActive("boolFlag"));
assertFalse(parameters.isActive("ungiven"));
try {
parameters.parseArgs("-ungiven");
} catch (final CommandParsingException e) {
// ok
}
assertFalse(parameters.getBool("ungiven"));
assertTrue(parameters.getBool("boolFlag"));
assertFalse(parameters.isActive("ungiven"));
assertTrue(parameters.isActive("boolFlag"));
}
/** Test method for
@@ -255,8 +251,7 @@ public class CommandParametersTest {
bools.add("boolFlag");
strings.add("str");
final CommandParameters parameters = new CommandParameters(bools,
strings, true);
final CommandParameters parameters = new CommandParameters(bools, strings, true);
try {
parameters.parseArgs("-ungivenFlag");
@@ -285,32 +280,31 @@ public class CommandParametersTest {
bools.add("boolFlag");
strings.add("str");
CommandParameters parameters = new CommandParameters(bools, strings,
true);
CommandParameters parameters = new CommandParameters(bools, strings, true);
assertFalse(parameters.getBool("ungiven"));
assertFalse(parameters.getBool("boolFlag"));
assertFalse(parameters.isActive("ungiven"));
assertFalse(parameters.isActive("boolFlag"));
parameters.set("boolFlag", true);
assertTrue(parameters.getBool("boolFlag"));
assertFalse(parameters.getBool("ungiven"));
assertTrue(parameters.isActive("boolFlag"));
assertFalse(parameters.isActive("ungiven"));
parameters.set("ungiven", true);
assertFalse(parameters.getBool("ungiven"));
assertTrue(parameters.getBool("boolFlag"));
assertFalse(parameters.isActive("ungiven"));
assertTrue(parameters.isActive("boolFlag"));
parameters = new CommandParameters(bools, strings, false);
assertFalse(parameters.getBool("ungiven"));
assertFalse(parameters.getBool("boolFlag"));
assertFalse(parameters.isActive("ungiven"));
assertFalse(parameters.isActive("boolFlag"));
parameters.set("boolFlag", true);
assertTrue(parameters.getBool("boolFlag"));
assertFalse(parameters.getBool("ungiven"));
assertTrue(parameters.isActive("boolFlag"));
assertFalse(parameters.isActive("ungiven"));
parameters.set("ungiven", true);
assertFalse(parameters.getBool("ungiven"));
assertTrue(parameters.getBool("boolFlag"));
assertFalse(parameters.isActive("ungiven"));
assertTrue(parameters.isActive("boolFlag"));
}
/** Test method for
@@ -323,8 +317,7 @@ public class CommandParametersTest {
bools.add("boolFlag");
strings.add("str");
CommandParameters parameters = new CommandParameters(bools, strings,
true);
CommandParameters parameters = new CommandParameters(bools, strings, true);
assertNull(parameters.get("ungiven"));
assertNull(parameters.get("str"));

View File

@@ -75,8 +75,6 @@ import static org.junit.Assert.fail;
import org.junit.Test;
import net.bigeon.gclc.command.CommandProvider;
import net.bigeon.gclc.command.ICommand;
import net.bigeon.gclc.command.base.MockCommand;
import net.bigeon.gclc.exception.InvalidCommandName;

View File

@@ -79,13 +79,13 @@ import java.io.IOException;
import org.junit.Test;
import net.bigeon.gclc.command.Command;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
import net.bigeon.gclc.utils.PipedConsoleOutput;
/** <p>
/**
* <p>
* TODO
*
* @author Emmanuel Bigeon */
@@ -98,9 +98,8 @@ public class CommandTest {
cmd = new Command("name") {
@Override
public void execute(final ConsoleOutput out,
final ConsoleInput in,
final String... args) throws CommandRunException {
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
//
}
@@ -134,9 +133,8 @@ public class CommandTest {
cmd = new Command("name") {
@Override
public void execute(final ConsoleOutput out,
final ConsoleInput in,
final String... args) throws CommandRunException {
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
//
}
@@ -176,9 +174,8 @@ public class CommandTest {
}
@Override
public void execute(final ConsoleOutput out,
final ConsoleInput in,
final String... args) throws CommandRunException {
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
//
}
@@ -218,9 +215,8 @@ public class CommandTest {
}
@Override
public void execute(final ConsoleOutput out,
final ConsoleInput in,
final String... args) throws CommandRunException {
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
//
}
@@ -253,9 +249,8 @@ public class CommandTest {
cmd = new Command("name") {
@Override
public void execute(final ConsoleOutput out,
final ConsoleInput in,
final String... args) throws CommandRunException {
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
//
}
@@ -290,9 +285,8 @@ public class CommandTest {
cmd = new Command("name") {
@Override
public void execute(final ConsoleOutput out,
final ConsoleInput in,
final String... args) throws CommandRunException {
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
//
}
@@ -330,9 +324,8 @@ public class CommandTest {
cmd = new Command("name") {
@Override
public void execute(final ConsoleOutput out,
final ConsoleInput in,
final String... args) throws CommandRunException {
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
//
}
@@ -369,9 +362,8 @@ public class CommandTest {
cmd = new Command("name") {
@Override
public void execute(final ConsoleOutput out,
final ConsoleInput in,
final String... args) throws CommandRunException {
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
//
}

View File

@@ -78,9 +78,7 @@ import java.io.IOException;
import org.junit.Test;
import net.bigeon.gclc.command.Command;
import net.bigeon.gclc.command.HelpExecutor;
import net.bigeon.gclc.command.SubedCommand;
import net.bigeon.gclc.command.base.HelpExecutor;
import net.bigeon.gclc.command.base.MockCommand;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.manager.ConsoleInput;
@@ -95,7 +93,7 @@ import net.bigeon.gclc.utils.PipedConsoleOutput;
public class HelpExecutorTest {
/** Test method for
* {@link net.bigeon.gclc.command.HelpExecutor#execute(ConsoleOutput, ConsoleInput, String...)}.
* {@link net.bigeon.gclc.command.base.HelpExecutor#execute(ConsoleOutput, ConsoleInput, String...)}.
*
* @throws CommandRunException if the test failed
* @throws IOException if the test failed */
@@ -106,7 +104,7 @@ public class HelpExecutorTest {
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
final String... args) throws CommandRunException {
//
}
@@ -133,14 +131,13 @@ public class HelpExecutorTest {
}
}
/** Test method for {@link net.bigeon.gclc.command.HelpExecutor#tip()}.
/** Test method for {@link net.bigeon.gclc.command.base.HelpExecutor#tip()}.
*
* @throws IOException if the test failed */
@Test
public final void testTip() throws IOException {
try (PipedConsoleOutput test = new PipedConsoleOutput()) {
final HelpExecutor help = new HelpExecutor("?",
new MockCommand("mock"));
final HelpExecutor help = new HelpExecutor("?", new MockCommand("mock"));
assertNotNull("Tip should be provided", help.tip());
help.help(test);
}

View File

@@ -0,0 +1,29 @@
package net.bigeon.gclc.command;
import static org.junit.Assert.*;
import org.junit.Test;
import net.bigeon.gclc.exception.InvalidParameterException;
public class ParametrizedCommandDataTest {
@Test
public void testAddParameter() throws InvalidParameterException {
ParametrizedCommandData data = new ParametrizedCommandData();
data.addBooleanParameter("flag");
data.addStringParameter("arg", false);
try {
data.addBooleanParameter("arg");
fail("String parameter cannot be converted to flag");
} catch (InvalidParameterException e) {
// ok
}
try {
data.addStringParameter("flag", false);
fail("Flag parameter cannot be converted to string");
} catch (InvalidParameterException e) {
// ok
}
}
}

View File

@@ -87,8 +87,6 @@ import java.nio.charset.StandardCharsets;
import org.junit.Test;
import net.bigeon.gclc.command.CommandParameters;
import net.bigeon.gclc.command.ParametrizedCommand;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.InvalidParameterException;
import net.bigeon.gclc.manager.ConsoleInput;
@@ -112,9 +110,8 @@ public class ParametrizedCommandTest {
ParametrizedCommand cmd = new ParametrizedCommand("name") {
@Override
protected void doExecute(final ConsoleOutput out,
final ConsoleInput in,
final CommandParameters parameters) {
protected void doExecute(final ConsoleOutput out, final ConsoleInput in,
final CommandParameters parameters) {
//
}
@@ -131,9 +128,8 @@ public class ParametrizedCommandTest {
cmd = new ParametrizedCommand("name", true) {
@Override
protected void doExecute(final ConsoleOutput out,
final ConsoleInput in,
final CommandParameters parameters) {
protected void doExecute(final ConsoleOutput out, final ConsoleInput in,
final CommandParameters parameters) {
//
}
@@ -179,8 +175,8 @@ public class ParametrizedCommandTest {
* @throws InterruptedException if the test failed
* @throws IOException if the test failed */
@Test
public final void testExecute() throws CommandRunException,
InterruptedException, IOException {
public final void testExecute()
throws CommandRunException, InterruptedException, IOException {
final String addParam = "additional";
final String str1 = "str1";
final String str2 = "str2";
@@ -192,9 +188,8 @@ public class ParametrizedCommandTest {
private boolean evenCall = true;
@Override
protected void doExecute(final ConsoleOutput out,
final ConsoleInput in,
final CommandParameters parameters) {
protected void doExecute(final ConsoleOutput out, final ConsoleInput in,
final CommandParameters parameters) {
assertTrue(parameters.getBooleanArgumentKeys().isEmpty());
assertTrue(parameters.getStringArgumentKeys().isEmpty());
if (evenCall) {
@@ -235,9 +230,8 @@ public class ParametrizedCommandTest {
}
@Override
protected void doExecute(final ConsoleOutput out,
final ConsoleInput in,
final CommandParameters parameters) {
protected void doExecute(final ConsoleOutput out, final ConsoleInput in,
final CommandParameters parameters) {
assertEquals(2, parameters.getBooleanArgumentKeys().size());
assertEquals(2, parameters.getStringArgumentKeys().size());
switch (call) {
@@ -247,22 +241,22 @@ public class ParametrizedCommandTest {
case 3:
assertNull(parameters.get(str1));
assertNull(parameters.get(str2));
assertFalse(parameters.getBool(bool1));
assertFalse(parameters.getBool(bool2));
assertFalse(parameters.isActive(bool1));
assertFalse(parameters.isActive(bool2));
call++;
break;
case 4:
assertEquals(str2, parameters.get(str1));
assertNull(parameters.get(str2));
assertFalse(parameters.getBool(bool1));
assertFalse(parameters.getBool(bool2));
assertFalse(parameters.isActive(bool1));
assertFalse(parameters.isActive(bool2));
call++;
break;
case 5:
assertEquals(str2, parameters.get(str1));
assertNull(parameters.get(str2));
assertTrue(parameters.getBool(bool1));
assertFalse(parameters.getBool(bool2));
assertTrue(parameters.isActive(bool1));
assertFalse(parameters.isActive(bool2));
call = 0;
break;
default:
@@ -302,31 +296,30 @@ public class ParametrizedCommandTest {
}
@Override
protected void doExecute(final ConsoleOutput out,
final ConsoleInput in,
final CommandParameters parameters) {
protected void doExecute(final ConsoleOutput out, final ConsoleInput in,
final CommandParameters parameters) {
assertEquals(2, parameters.getBooleanArgumentKeys().size());
assertEquals(2, parameters.getStringArgumentKeys().size());
switch (call) {
case 0:
assertNull(parameters.get(str1));
assertNull(parameters.get(str2));
assertFalse(parameters.getBool(bool1));
assertFalse(parameters.getBool(bool2));
assertFalse(parameters.isActive(bool1));
assertFalse(parameters.isActive(bool2));
call++;
break;
case 1:
assertEquals(str2, parameters.get(str1));
assertNull(parameters.get(str2));
assertFalse(parameters.getBool(bool1));
assertFalse(parameters.getBool(bool2));
assertFalse(parameters.isActive(bool1));
assertFalse(parameters.isActive(bool2));
call++;
break;
case 2:
assertEquals(str2, parameters.get(str1));
assertNull(parameters.get(str2));
assertTrue(parameters.getBool(bool1));
assertFalse(parameters.getBool(bool2));
assertTrue(parameters.isActive(bool1));
assertFalse(parameters.isActive(bool2));
call = 0;
break;
default:
@@ -376,9 +369,8 @@ public class ParametrizedCommandTest {
}
@Override
protected void doExecute(final ConsoleOutput out,
final ConsoleInput in,
final CommandParameters parameters) {
protected void doExecute(final ConsoleOutput out, final ConsoleInput in,
final CommandParameters parameters) {
assertEquals(str2, parameters.get(str1));
}
@@ -419,9 +411,8 @@ public class ParametrizedCommandTest {
}
@Override
protected void doExecute(final ConsoleOutput out,
final ConsoleInput in,
final CommandParameters parameters) {
protected void doExecute(final ConsoleOutput out, final ConsoleInput in,
final CommandParameters parameters) {
//
assertEquals(str2, parameters.get(str1));
}
@@ -466,9 +457,8 @@ public class ParametrizedCommandTest {
}
@Test
public void testExecuteInteractive() throws IOException,
CommandRunException,
InterruptedException {
public void testExecuteInteractive()
throws IOException, CommandRunException, InterruptedException {
ParametrizedCommand cmd;
final String addParam = "additional";
final String str1 = "str1";
@@ -490,9 +480,8 @@ public class ParametrizedCommandTest {
}
@Override
protected void doExecute(final ConsoleOutput out,
final ConsoleInput in,
final CommandParameters parameters) throws CommandRunException {
protected void doExecute(final ConsoleOutput out, final ConsoleInput in,
final CommandParameters parameters) throws CommandRunException {
if (!str2.equals(parameters.get(str1))) {
throw new CommandRunException("Expected other argument");
}
@@ -509,12 +498,11 @@ public class ParametrizedCommandTest {
}
};
try (PipedConsoleOutput out = new PipedConsoleOutput();
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(
new PrintStream(pout))) {
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(new PrintStream(pout))) {
cmd.execute(out, in, "-" + str1, str2);
cmd.execute(out, in, "-" + str1, str2, "-" + bool1);
cmd.execute(out, in, "-" + str1, str2, addParam);
@@ -528,12 +516,10 @@ public class ParametrizedCommandTest {
try {
assertEquals("value of " + str1 + "? ", buf.readLine());
in.type("");
assertEquals(
"value of " + str1 + "? (cannot be empty) ",
assertEquals("value of " + str1 + "? (cannot be empty) ",
buf.readLine());
in.type("");
assertEquals(
"value of " + str1 + "? (cannot be empty) ",
assertEquals("value of " + str1 + "? (cannot be empty) ",
buf.readLine());
in.type(str2);
} catch (final IOException e) {
@@ -548,12 +534,11 @@ public class ParametrizedCommandTest {
th.join();
}
try (PipedConsoleOutput out = new PipedConsoleOutput();
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(
new PrintStream(pout))) {
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(new PrintStream(pout))) {
final Thread th = new Thread(new Runnable() {
@@ -593,9 +578,8 @@ public class ParametrizedCommandTest {
ParametrizedCommand cmd = new ParametrizedCommand("name") {
@Override
protected void doExecute(final ConsoleOutput out,
final ConsoleInput in,
final CommandParameters parameters) {
protected void doExecute(final ConsoleOutput out, final ConsoleInput in,
final CommandParameters parameters) {
//
}
@@ -612,9 +596,8 @@ public class ParametrizedCommandTest {
assertTrue(cmd.isStrict());
cmd = new ParametrizedCommand("name") {
@Override
protected void doExecute(final ConsoleOutput out,
final ConsoleInput in,
final CommandParameters parameters) {
protected void doExecute(final ConsoleOutput out, final ConsoleInput in,
final CommandParameters parameters) {
//
}
@@ -631,9 +614,8 @@ public class ParametrizedCommandTest {
assertTrue(cmd.isStrict());
cmd = new ParametrizedCommand("name") {
@Override
protected void doExecute(final ConsoleOutput out,
final ConsoleInput in,
final CommandParameters parameters) {
protected void doExecute(final ConsoleOutput out, final ConsoleInput in,
final CommandParameters parameters) {
//
}
@@ -656,9 +638,8 @@ public class ParametrizedCommandTest {
public final void testParametrizedCommandConsoleManagerStringBoolean() {
ParametrizedCommand cmd = new ParametrizedCommand("name", false) {
@Override
protected void doExecute(final ConsoleOutput out,
final ConsoleInput in,
final CommandParameters parameters) {
protected void doExecute(final ConsoleOutput out, final ConsoleInput in,
final CommandParameters parameters) {
//
}
@@ -675,9 +656,8 @@ public class ParametrizedCommandTest {
assertFalse(cmd.isStrict());
cmd = new ParametrizedCommand("name", false) {
@Override
protected void doExecute(final ConsoleOutput out,
final ConsoleInput in,
final CommandParameters parameters) {
protected void doExecute(final ConsoleOutput out, final ConsoleInput in,
final CommandParameters parameters) {
//
}
@@ -694,9 +674,8 @@ public class ParametrizedCommandTest {
assertFalse(cmd.isStrict());
cmd = new ParametrizedCommand("name", false) {
@Override
protected void doExecute(final ConsoleOutput out,
final ConsoleInput in,
final CommandParameters parameters) {
protected void doExecute(final ConsoleOutput out, final ConsoleInput in,
final CommandParameters parameters) {
//
}

View File

@@ -88,7 +88,8 @@ import net.bigeon.gclc.exception.CommandRunExceptionType;
import net.bigeon.gclc.utils.PipedConsoleInput;
import net.bigeon.gclc.utils.PipedConsoleOutput;
/** <p>
/**
* <p>
* Test class for {@link ScriptExecution}
*
* @author Emmanuel Bigeon */
@@ -108,8 +109,7 @@ public class ScriptExecutionTest {
fail("creation of console manager failed"); //$NON-NLS-1$
return;
}
final ConsoleApplication app = new ConsoleApplication(
test, in, "", "");
final ConsoleApplication app = new ConsoleApplication(test, in, "", "");
new ConsoleTestApplication().attach(app);
final ScriptExecution exec = new ScriptExecution("script", app, "#", //$NON-NLS-1$ //$NON-NLS-2$
Charset.forName("UTF-8"));
@@ -122,8 +122,7 @@ public class ScriptExecutionTest {
}
try {
exec.execute(test, in,
"src/test/resources/scripts/withprependSpace.txt"); //$NON-NLS-1$
exec.execute(test, in, "src/test/resources/scripts/withprependSpace.txt"); //$NON-NLS-1$
fail("execution of script with lines begining with space should fail"); //$NON-NLS-1$
} catch (final CommandRunException e1) {
// ok
@@ -131,8 +130,7 @@ public class ScriptExecutionTest {
}
try {
exec.execute(test, in,
"src/test/resources/scripts/invalidCmdParse.txt"); //$NON-NLS-1$
exec.execute(test, in, "src/test/resources/scripts/invalidCmdParse.txt"); //$NON-NLS-1$
fail("execution of script with invalid command line should fail"); //$NON-NLS-1$
} catch (final CommandRunException e1) {
// ok
@@ -140,8 +138,7 @@ public class ScriptExecutionTest {
}
try {
exec.execute(test, in,
"src/test/resources/scripts/invalidCmd.txt"); //$NON-NLS-1$
exec.execute(test, in, "src/test/resources/scripts/invalidCmd.txt"); //$NON-NLS-1$
fail("execution of script with invalid command should fail"); //$NON-NLS-1$
} catch (final CommandRunException e1) {
// ok
@@ -149,8 +146,7 @@ public class ScriptExecutionTest {
}
try {
exec.execute(test, in,
"src/test/resources/scripts/failingCmdInvoc.txt"); //$NON-NLS-1$
exec.execute(test, in, "src/test/resources/scripts/failingCmdInvoc.txt"); //$NON-NLS-1$
fail("execution of script with failing command should fail"); //$NON-NLS-1$
} catch (final CommandRunException e1) {
// ok
@@ -158,8 +154,7 @@ public class ScriptExecutionTest {
}
try {
exec.execute(test, in,
"src/test/resources/scripts/someNonExisting.file"); //$NON-NLS-1$
exec.execute(test, in, "src/test/resources/scripts/someNonExisting.file"); //$NON-NLS-1$
fail("execution of script with unexisting file should fail"); //$NON-NLS-1$
} catch (final CommandRunException e1) {
// ok
@@ -199,7 +194,8 @@ public class ScriptExecutionTest {
}
}
/** Test method for {@link net.bigeon.gclc.command.base.ScriptExecution#tip()}. */
/** Test method for
* {@link net.bigeon.gclc.command.base.ScriptExecution#tip()}. */
@Test
public void testTip() {
final ScriptExecution exec = new ScriptExecution("script", null, "#", //$NON-NLS-1$ //$NON-NLS-2$

View File

@@ -80,9 +80,6 @@ import java.io.IOException;
import org.junit.Test;
import net.bigeon.gclc.command.Command;
import net.bigeon.gclc.command.ICommand;
import net.bigeon.gclc.command.SubedCommand;
import net.bigeon.gclc.command.base.MockCommand;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.InvalidCommandName;
@@ -136,9 +133,8 @@ public class SubedCommandTest {
cmd.add(new Command("fail") {
@Override
public void execute(final ConsoleOutput out,
final ConsoleInput in,
final String... args) throws CommandRunException {
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
throw new CommandRunException("Failing command", null);
}
@@ -182,9 +178,8 @@ public class SubedCommandTest {
cmd.add(new Command("fail") {
@Override
public void execute(final ConsoleOutput out,
final ConsoleInput in,
final String... args) throws CommandRunException {
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
throw new CommandRunException("Failing command");
}
@@ -235,9 +230,8 @@ public class SubedCommandTest {
cmd.add(new Command("fail") {
@Override
public void execute(final ConsoleOutput out,
final ConsoleInput in,
final String... args) throws CommandRunException {
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
throw new CommandRunException("Failing command");
}
@@ -257,7 +251,7 @@ public class SubedCommandTest {
}
try {
cmd.executeSub(null, null,"id");
cmd.executeSub(null, null, "id");
} catch (final CommandRunException e) {
fail("Unexpected exception when running mock command");
assertNotNull(e);
@@ -349,7 +343,7 @@ public class SubedCommandTest {
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
final String... args) throws CommandRunException {
//
}
@@ -359,8 +353,8 @@ public class SubedCommandTest {
}
@Override
public void help(final ConsoleOutput manager,
final String... args) throws IOException {
public void help(final ConsoleOutput manager, final String... args)
throws IOException {
//
}

View File

@@ -77,28 +77,23 @@ import org.junit.Test;
import net.bigeon.gclc.command.ICommand;
import net.bigeon.gclc.command.base.MockCommand;
import net.bigeon.gclc.exception.CommandRunException;
/**
* <p>
* TODO
*
* @author Emmanuel Bigeon
*
*/
* @author Emmanuel Bigeon */
public class CommandRunExceptionTest {
/**
* Test method for {@link net.bigeon.gclc.exception.CommandRunException#getLocalizedMessage()}.
*/
/** Test method for
* {@link net.bigeon.gclc.exception.CommandRunException#getLocalizedMessage()}. */
@Test
public final void testGetLocalizedMessage() {
CommandRunException e;
final ICommand cmd = new MockCommand("name");
final String messageInner = "inner";
final String message = "message";
e = new CommandRunException(message,
new CommandRunException(messageInner));
e = new CommandRunException(message, new CommandRunException(messageInner));
assertEquals(message + ": " + messageInner, e.getLocalizedMessage());
e = new CommandRunException(message);

View File

@@ -97,7 +97,8 @@ public class ReadingRunnableTest {
/**
*/
@Before
public void setUp() {}
public void setUp() {
}
/** Test method for
* {@link net.bigeon.gclc.utils.ReadingRunnable#getMessage()}. */
@@ -117,24 +118,35 @@ public class ReadingRunnableTest {
}
/** Test method for
* {@link net.bigeon.gclc.utils.ReadingRunnable#getWaitForDelivery(java.lang.String)}.
* {@link net.bigeon.gclc.utils.ReadingRunnable#waitForDelivery(String)}.
*
* @throws InterruptedException if the test failed
* @throws IOException if the test failed */
@Test
public final void testGetWaitForDelivery() throws InterruptedException,
IOException {
public final void testGetWaitForDelivery() throws InterruptedException, IOException {
try (PipedOutputStream out = new PipedOutputStream();
InputStream piped = new PipedInputStream(out);
BufferedReader reader = new BufferedReader(
new InputStreamReader(piped, "UTF-8"))) {
InputStream piped = new PipedInputStream(out);
BufferedReader reader = new BufferedReader(
new InputStreamReader(piped, "UTF-8"))) {
final ReadingRunnable runnable = new ReadingRunnable(reader);
final Thread th0 = new Thread(runnable, "read");
th0.start();
final Thread th = runnable.getWaitForDelivery("msg");
Thread th = new Thread(new Runnable() {
out.write(Charset.forName("UTF-8")
.encode("msg" + System.lineSeparator()).array());
@Override
public void run() {
try {
runnable.waitForDelivery("msg");
} catch (InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
});
th.start();
out.write(Charset.forName("UTF-8").encode("msg" + System.lineSeparator())
.array());
final Thread th2 = new Thread(new Runnable() {

View File

@@ -104,8 +104,8 @@ public class SystemConsoleManagerTest {
final InputStream in = new PipedInputStream(outStream);
final PrintStream out = new PrintStream(outStream);
final String test = "test";
final StreamConsoleInput manager = new StreamConsoleInput(System.out,
in, Charset.forName("UTF-8"));
final StreamConsoleInput manager = new StreamConsoleInput(System.out, in,
Charset.forName("UTF-8"));
final Thread th = new Thread(new Runnable() {
@@ -139,10 +139,10 @@ public class SystemConsoleManagerTest {
final String test = "test";
try (PipedOutputStream outStream = new PipedOutputStream();
InputStream in = new PipedInputStream(outStream);
final PrintStream out = new PrintStream(outStream);
StreamConsoleInput manager = new StreamConsoleInput(System.out, in,
Charset.forName("UTF-8"))) {
InputStream in = new PipedInputStream(outStream);
final PrintStream out = new PrintStream(outStream);
StreamConsoleInput manager = new StreamConsoleInput(System.out, in,
Charset.forName("UTF-8"))) {
final Thread th = new Thread(new Runnable() {
@@ -167,10 +167,10 @@ public class SystemConsoleManagerTest {
@Test
public final void testSetPrompt() throws IOException {
try (PipedOutputStream outStream = new PipedOutputStream();
InputStream in = new PipedInputStream(outStream);
final PrintStream out = new PrintStream(outStream);
StreamConsoleInput manager = new StreamConsoleInput(System.out, in,
Charset.forName("UTF-8"))) {
InputStream in = new PipedInputStream(outStream);
final PrintStream out = new PrintStream(outStream);
StreamConsoleInput manager = new StreamConsoleInput(System.out, in,
Charset.forName("UTF-8"))) {
final String prt = "++";
manager.setPrompt(prt);

View File

@@ -75,26 +75,20 @@ import static org.junit.Assert.assertEquals;
import org.junit.Test;
import net.bigeon.gclc.prompt.CLIPrompterMessages;
/**
* <p>
* TODO
*
* @author Emmanuel Bigeon
*
*/
* @author Emmanuel Bigeon */
public class CLIPrompterMessagesTest {
/**
* Test method for {@link net.bigeon.gclc.prompt.CLIPrompterMessages#getString(java.lang.String, java.lang.Object[])}.
*/
/** Test method for
* {@link net.bigeon.gclc.prompt.CLIPrompterMessages#getString(java.lang.String, java.lang.Object[])}. */
@Test
public final void testGetString() {
String key = "bad.key";
assertEquals('!' + key + '!', CLIPrompterMessages.getString(key));
assertEquals('!' + key + '!',
CLIPrompterMessages.getString(key, "some arg"));
assertEquals('!' + key + '!', CLIPrompterMessages.getString(key, "some arg"));
assertEquals('!' + key + '!',
CLIPrompterMessages.getString(key, new Object[] {}));
}

View File

@@ -92,8 +92,6 @@ import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import net.bigeon.gclc.prompt.CLIPrompter;
import net.bigeon.gclc.prompt.CLIPrompterMessages;
import net.bigeon.gclc.utils.PipedConsoleInput;
import net.bigeon.gclc.utils.PipedConsoleOutput;
@@ -121,25 +119,20 @@ public class CLIPrompterTest {
@Test
public final void testPromptBoolean() {
try (final PipedConsoleOutput out = new PipedConsoleOutput();
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(
new PrintStream(pout))) {
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(new PrintStream(pout))) {
final Thread th = new Thread(new Runnable() {
@Override
public void run() {
try {
assertTrue(CLIPrompter.promptBoolean(out, in,
"My message")); //$NON-NLS-1$
assertTrue(CLIPrompter.promptBoolean(out, in,
"My message")); //$NON-NLS-1$
assertFalse(CLIPrompter.promptBoolean(out, in,
"My message")); //$NON-NLS-1$
assertFalse(CLIPrompter.promptBoolean(out, in,
"My message")); //$NON-NLS-1$
assertTrue(CLIPrompter.promptBoolean(out, in, "My message")); //$NON-NLS-1$
assertTrue(CLIPrompter.promptBoolean(out, in, "My message")); //$NON-NLS-1$
assertFalse(CLIPrompter.promptBoolean(out, in, "My message")); //$NON-NLS-1$
assertFalse(CLIPrompter.promptBoolean(out, in, "My message")); //$NON-NLS-1$
} catch (final IOException e) {
fail("Unexpected io excpetion"); //$NON-NLS-1$
e.printStackTrace();
@@ -171,12 +164,11 @@ public class CLIPrompterTest {
@Test
public final void testPromptChoiceConsoleManagerListOfStringListOfUStringString() {
try (final PipedConsoleOutput out = new PipedConsoleOutput();
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(
new PrintStream(pout))) {
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(new PrintStream(pout))) {
final List<String> keys = new ArrayList<>();
final List<Object> choices = new ArrayList<>();
keys.add("A choice"); //$NON-NLS-1$
@@ -192,14 +184,14 @@ public class CLIPrompterTest {
public void run() {
try {
assertEquals("Asserted provided value to be retrieved",
choices.get(0), CLIPrompter.promptChoice(out,
in, keys, choices, message, cancel));
assertEquals("Asserted provided value to be retrieved",
choices.get(0), CLIPrompter.promptChoice(out,
in, keys, choices, message, null));
assertEquals("Asserted provided value to be retrieved",
null, CLIPrompter.promptChoice(out, in, keys,
choices.get(0), CLIPrompter.promptChoice(out, in, keys,
choices, message, cancel));
assertEquals("Asserted provided value to be retrieved",
choices.get(0), CLIPrompter.promptChoice(out, in, keys,
choices, message, null));
assertEquals("Asserted provided value to be retrieved", null,
CLIPrompter.promptChoice(out, in, keys, choices, message,
cancel));
} catch (final IOException e) {
fail("Unexpected io excpetion"); //$NON-NLS-1$
e.printStackTrace();
@@ -215,8 +207,7 @@ public class CLIPrompterTest {
buf.readLine());
in.type("yoyo"); //$NON-NLS-1$
// fail, reprompt
final String msg = CLIPrompterMessages.getString(
"promptchoice.formaterr", //$NON-NLS-1$
final String msg = CLIPrompterMessages.getString("promptchoice.formaterr", //$NON-NLS-1$
0, keys.size());
for (final String line : msg.split(System.lineSeparator())) {
assertEquals(line, out.readNextLine());
@@ -235,10 +226,8 @@ public class CLIPrompterTest {
buf.readLine());
in.type("2"); //$NON-NLS-1$
// fail, reprompt
assertEquals(
CLIPrompterMessages.getString("promptchoice.outofbounds", 0, //$NON-NLS-1$
keys.size() - 1),
out.readNextLine());
assertEquals(CLIPrompterMessages.getString("promptchoice.outofbounds", 0, //$NON-NLS-1$
keys.size() - 1), out.readNextLine());
assertTrue(out.readNextLine().contains(keys.get(0)));
assertTrue(out.readNextLine().contains(keys.get(1)));
assertEquals(CLIPrompterMessages.getString("prompt.lineprompt"), //$NON-NLS-1$
@@ -262,12 +251,11 @@ public class CLIPrompterTest {
@Test
public final void testPromptChoiceConsoleManagerListOfUMapOfUTStringString() {
try (final PipedConsoleOutput out = new PipedConsoleOutput();
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(
new PrintStream(pout))) {
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(new PrintStream(pout))) {
final List<Object> keys = new ArrayList<>();
final Map<Object, Object> choices = new HashMap<>();
keys.add("A choice"); //$NON-NLS-1$
@@ -283,16 +271,14 @@ public class CLIPrompterTest {
public void run() {
try {
assertEquals("Asserted provided value to be retrieved",
choices.get(keys.get(0)),
CLIPrompter.promptChoice(out, in, keys, choices,
message, cancel));
choices.get(keys.get(0)), CLIPrompter.promptChoice(out,
in, keys, choices, message, cancel));
assertEquals("Asserted provided value to be retrieved",
choices.get(keys.get(0)),
CLIPrompter.promptChoice(out, in, keys, choices,
message, null));
assertEquals("Asserted provided value to be retrieved",
null, CLIPrompter.promptChoice(out, in, keys,
choices, message, cancel));
choices.get(keys.get(0)), CLIPrompter.promptChoice(out,
in, keys, choices, message, null));
assertEquals("Asserted provided value to be retrieved", null,
CLIPrompter.promptChoice(out, in, keys, choices, message,
cancel));
} catch (final IOException e) {
fail("Unexpected io excpetion"); //$NON-NLS-1$
e.printStackTrace();
@@ -308,8 +294,7 @@ public class CLIPrompterTest {
buf.readLine());
in.type("yoyo"); //$NON-NLS-1$
// fail, reprompt
final String msg = CLIPrompterMessages.getString(
"promptchoice.formaterr", //$NON-NLS-1$
final String msg = CLIPrompterMessages.getString("promptchoice.formaterr", //$NON-NLS-1$
0, keys.size());
for (final String line : msg.split(System.lineSeparator())) {
assertEquals(line, out.readNextLine());
@@ -328,10 +313,8 @@ public class CLIPrompterTest {
buf.readLine());
in.type("2"); //$NON-NLS-1$
// fail, reprompt
assertEquals(
CLIPrompterMessages.getString("promptchoice.outofbounds", 0, //$NON-NLS-1$
keys.size() - 1),
out.readNextLine());
assertEquals(CLIPrompterMessages.getString("promptchoice.outofbounds", 0, //$NON-NLS-1$
keys.size() - 1), out.readNextLine());
assertTrue(out.readNextLine().contains(keys.get(0).toString()));
assertTrue(out.readNextLine().contains(keys.get(1).toString()));
assertEquals(CLIPrompterMessages.getString("prompt.lineprompt"), //$NON-NLS-1$
@@ -355,12 +338,11 @@ public class CLIPrompterTest {
@Test
public final void testPromptChoiceConsoleManagerListOfUStringString() {
try (final PipedConsoleOutput out = new PipedConsoleOutput();
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(
new PrintStream(pout))) {
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(new PrintStream(pout))) {
final List<Object> keys = new ArrayList<>();
keys.add("A choice"); //$NON-NLS-1$
keys.add("An other"); //$NON-NLS-1$
@@ -373,17 +355,16 @@ public class CLIPrompterTest {
public void run() {
try {
assertEquals("Asserted provided value to be retrieved",
Integer.valueOf(0), CLIPrompter.promptChoice(
out, in, keys, message, cancel));
Integer.valueOf(0),
CLIPrompter.promptChoice(out, in, keys, message, cancel));
assertEquals("Asserted provided value to be retrieved",
Integer.valueOf(0), CLIPrompter.promptChoice(
out, in, keys, message, null));
Integer.valueOf(0),
CLIPrompter.promptChoice(out, in, keys, message, null));
assertEquals("Asserted provided value to be retrieved",
Integer.valueOf(1), CLIPrompter.promptChoice(
out, in, keys, message, null));
assertEquals("Asserted provided value to be retrieved",
null, CLIPrompter.promptChoice(out, in, keys,
message, cancel));
Integer.valueOf(1),
CLIPrompter.promptChoice(out, in, keys, message, null));
assertEquals("Asserted provided value to be retrieved", null,
CLIPrompter.promptChoice(out, in, keys, message, cancel));
} catch (final IOException e) {
fail("Unexpected io excpetion"); //$NON-NLS-1$
e.printStackTrace();
@@ -399,8 +380,7 @@ public class CLIPrompterTest {
buf.readLine());
in.type("yoyo"); //$NON-NLS-1$
// fail, reprompt
final String msg = CLIPrompterMessages.getString(
"promptchoice.formaterr", //$NON-NLS-1$
final String msg = CLIPrompterMessages.getString("promptchoice.formaterr", //$NON-NLS-1$
0, keys.size());
for (final String line : msg.split(System.lineSeparator())) {
assertEquals(line, out.readNextLine());
@@ -419,10 +399,8 @@ public class CLIPrompterTest {
buf.readLine());
in.type("2"); //$NON-NLS-1$
// fail, reprompt
assertEquals(
CLIPrompterMessages.getString("promptchoice.outofbounds", 0, //$NON-NLS-1$
keys.size() - 1),
out.readNextLine());
assertEquals(CLIPrompterMessages.getString("promptchoice.outofbounds", 0, //$NON-NLS-1$
keys.size() - 1), out.readNextLine());
assertTrue(out.readNextLine().contains(keys.get(0).toString()));
assertTrue(out.readNextLine().contains(keys.get(1).toString()));
assertEquals(CLIPrompterMessages.getString("prompt.lineprompt"), //$NON-NLS-1$
@@ -455,12 +433,11 @@ public class CLIPrompterTest {
@Test
public final void testPromptChoiceConsoleManagerMapOfUTStringString() {
try (final PipedConsoleOutput out = new PipedConsoleOutput();
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(
new PrintStream(pout))) {
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(new PrintStream(pout))) {
final List<Object> keys = new ArrayList<>();
final Map<Object, Object> choices = new HashMap<>();
keys.add("A choice"); //$NON-NLS-1$
@@ -476,16 +453,14 @@ public class CLIPrompterTest {
public void run() {
try {
assertEquals("Asserted provided value to be retrieved",
choices.get(keys.get(0)),
CLIPrompter.promptChoice(out, in, keys, choices,
message, cancel));
choices.get(keys.get(0)), CLIPrompter.promptChoice(out,
in, keys, choices, message, cancel));
assertEquals("Asserted provided value to be retrieved",
choices.get(keys.get(0)),
CLIPrompter.promptChoice(out, in, keys, choices,
message, null));
assertEquals("Asserted provided value to be retrieved",
null, CLIPrompter.promptChoice(out, in, keys,
choices, message, cancel));
choices.get(keys.get(0)), CLIPrompter.promptChoice(out,
in, keys, choices, message, null));
assertEquals("Asserted provided value to be retrieved", null,
CLIPrompter.promptChoice(out, in, keys, choices, message,
cancel));
} catch (final IOException e) {
fail("Unexpected io excpetion"); //$NON-NLS-1$
e.printStackTrace();
@@ -503,8 +478,7 @@ public class CLIPrompterTest {
buf.readLine());
in.type("yoyo"); //$NON-NLS-1$
// fail, reprompt
final String msg = CLIPrompterMessages.getString(
"promptchoice.formaterr", //$NON-NLS-1$
final String msg = CLIPrompterMessages.getString("promptchoice.formaterr", //$NON-NLS-1$
0, keys.size());
for (final String line : msg.split(System.lineSeparator())) {
assertEquals(line, out.readNextLine());
@@ -523,10 +497,8 @@ public class CLIPrompterTest {
buf.readLine());
in.type("2"); //$NON-NLS-1$
// fail, reprompt
assertEquals(
CLIPrompterMessages.getString("promptchoice.outofbounds", 0, //$NON-NLS-1$
keys.size() - 1),
out.readNextLine());
assertEquals(CLIPrompterMessages.getString("promptchoice.outofbounds", 0, //$NON-NLS-1$
keys.size() - 1), out.readNextLine());
assertTrue(out.readNextLine().contains(keys.get(0).toString()));
assertTrue(out.readNextLine().contains(keys.get(1).toString()));
assertEquals(CLIPrompterMessages.getString("prompt.lineprompt"), //$NON-NLS-1$
@@ -552,21 +524,18 @@ public class CLIPrompterTest {
@Test
public final void testPromptInteger() {
try (PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(
new PrintStream(pout))) {
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(new PrintStream(pout))) {
final Thread th = new Thread(new Runnable() {
@Override
public void run() {
try {
assertEquals("Asserted provided value to be retrieved",
10,
assertEquals("Asserted provided value to be retrieved", 10,
CLIPrompter.promptInteger(in, "My message")); //$NON-NLS-1$
assertEquals("Asserted provided value to be retrieved",
-15,
assertEquals("Asserted provided value to be retrieved", -15,
CLIPrompter.promptInteger(in, "My message")); //$NON-NLS-1$
} catch (final IOException e) {
fail("Unexpected io excpetion"); //$NON-NLS-1$
@@ -596,12 +565,11 @@ public class CLIPrompterTest {
@Test
public final void testPromptListConsoleManagerString() {
try (final PipedConsoleOutput out = new PipedConsoleOutput();
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(
new PrintStream(pout))) {
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(new PrintStream(pout))) {
final List<String> keys = new ArrayList<>();
keys.add("A choice"); //$NON-NLS-1$
keys.add("An other"); //$NON-NLS-1$
@@ -615,8 +583,8 @@ public class CLIPrompterTest {
assertEquals("Asserted provided value to be retrieved",
new ArrayList<String>(),
CLIPrompter.promptList(out, in, message));
assertEquals("Asserted provided value to be retrieved",
keys, CLIPrompter.promptList(out, in, message));
assertEquals("Asserted provided value to be retrieved", keys,
CLIPrompter.promptList(out, in, message));
} catch (final IOException e) {
fail("Unexpected io excpetion"); //$NON-NLS-1$
e.printStackTrace();
@@ -631,8 +599,7 @@ public class CLIPrompterTest {
.getString("promptlist.exit.defaultkey")))); //$NON-NLS-1$
assertEquals(CLIPrompterMessages.getString("prompt.lineprompt"), //$NON-NLS-1$
buf.readLine());
in.type(CLIPrompterMessages
.getString("promptlist.exit.defaultkey")); //$NON-NLS-1$
in.type(CLIPrompterMessages.getString("promptlist.exit.defaultkey")); //$NON-NLS-1$
// enter keys list
nLine = out.readNextLine();
assertTrue(nLine.startsWith(message));
@@ -646,8 +613,7 @@ public class CLIPrompterTest {
assertEquals(CLIPrompterMessages.getString("prompt.lineprompt"), //$NON-NLS-1$
buf.readLine());
}
in.type(CLIPrompterMessages
.getString("promptlist.exit.defaultkey")); //$NON-NLS-1$
in.type(CLIPrompterMessages.getString("promptlist.exit.defaultkey")); //$NON-NLS-1$
th.join();
} catch (IOException | InterruptedException e) {
fail("Unexpected excpetion"); //$NON-NLS-1$
@@ -660,12 +626,11 @@ public class CLIPrompterTest {
@Test
public final void testPromptListConsoleManagerStringString() {
try (final PipedConsoleOutput out = new PipedConsoleOutput();
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(
new PrintStream(pout))) {
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(new PrintStream(pout))) {
final List<String> keys = new ArrayList<>();
keys.add("A choice"); //$NON-NLS-1$
keys.add("An other"); //$NON-NLS-1$
@@ -678,11 +643,10 @@ public class CLIPrompterTest {
public void run() {
try {
assertEquals("Asserted provided value to be retrieved",
new ArrayList<String>(), CLIPrompter
.promptList(out, in, message, ender));
assertEquals("Asserted provided value to be retrieved",
keys, CLIPrompter.promptList(out, in, message,
ender));
new ArrayList<String>(),
CLIPrompter.promptList(out, in, message, ender));
assertEquals("Asserted provided value to be retrieved", keys,
CLIPrompter.promptList(out, in, message, ender));
} catch (final IOException e) {
fail("Unexpected io excpetion"); //$NON-NLS-1$
e.printStackTrace();
@@ -692,16 +656,16 @@ public class CLIPrompterTest {
th.start();
String nLine = out.readNextLine();
assertTrue(nLine.startsWith(message));
assertTrue(nLine.endsWith(CLIPrompterMessages
.getString("promptlist.exit.dispkey", ender))); //$NON-NLS-1$
assertTrue(nLine.endsWith(
CLIPrompterMessages.getString("promptlist.exit.dispkey", ender))); //$NON-NLS-1$
assertEquals(CLIPrompterMessages.getString("prompt.lineprompt"), //$NON-NLS-1$
buf.readLine());
in.type(ender);
// enter keys list
nLine = out.readNextLine();
assertTrue(nLine.startsWith(message));
assertTrue(nLine.endsWith(CLIPrompterMessages
.getString("promptlist.exit.dispkey", ender))); //$NON-NLS-1$
assertTrue(nLine.endsWith(
CLIPrompterMessages.getString("promptlist.exit.dispkey", ender))); //$NON-NLS-1$
assertEquals(CLIPrompterMessages.getString("prompt.lineprompt"), //$NON-NLS-1$
buf.readLine());
for (int i = 0; i < keys.size(); i++) {
@@ -722,26 +686,22 @@ public class CLIPrompterTest {
@Test
public final void testPromptLongTextConsoleManagerString() {
try (final PipedConsoleOutput out = new PipedConsoleOutput();
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(
new PrintStream(pout))) {
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(new PrintStream(pout))) {
final String message = "My message";
final String longText = "Some text with" + System.lineSeparator() +
"line feeds and other" +
System.lineSeparator() +
System.lineSeparator() +
" \tspecial characters";
final String longText = "Some text with" + System.lineSeparator()
+ "line feeds and other" + System.lineSeparator()
+ System.lineSeparator() + " \tspecial characters";
final Thread th = new Thread(new Runnable() {
@Override
public void run() {
try {
assertEquals("Asserted provided value to be retrieved",
"",
assertEquals("Asserted provided value to be retrieved", "",
CLIPrompter.promptLongText(out, in, message));
assertEquals("Asserted provided value to be retrieved",
longText + System.lineSeparator(),
@@ -756,18 +716,17 @@ public class CLIPrompterTest {
String nLine = out.readNextLine();
assertTrue(nLine.startsWith(message));
assertTrue(nLine.endsWith(CLIPrompterMessages.getString(
"promptlongtext.exit.dispkey", CLIPrompterMessages
.getString("promptlongtext.exit.defaultkey"))));
"promptlongtext.exit.dispkey",
CLIPrompterMessages.getString("promptlongtext.exit.defaultkey"))));
assertEquals(CLIPrompterMessages.getString("prompt.lineprompt"),
buf.readLine());
in.type(CLIPrompterMessages
.getString("promptlongtext.exit.defaultkey"));
in.type(CLIPrompterMessages.getString("promptlongtext.exit.defaultkey"));
// enter long text
nLine = out.readNextLine();
assertTrue(nLine.startsWith(message));
assertTrue(nLine.endsWith(CLIPrompterMessages.getString(
"promptlongtext.exit.dispkey", CLIPrompterMessages
.getString("promptlongtext.exit.defaultkey"))));
"promptlongtext.exit.dispkey",
CLIPrompterMessages.getString("promptlongtext.exit.defaultkey"))));
assertEquals(CLIPrompterMessages.getString("prompt.lineprompt"),
buf.readLine());
final String[] text = longText.split(System.lineSeparator());
@@ -776,8 +735,7 @@ public class CLIPrompterTest {
assertEquals(CLIPrompterMessages.getString("prompt.lineprompt"),
buf.readLine());
}
in.type(CLIPrompterMessages
.getString("promptlongtext.exit.defaultkey"));
in.type(CLIPrompterMessages.getString("promptlongtext.exit.defaultkey"));
th.join();
} catch (IOException | InterruptedException e) {
fail("Unexpected excpetion"); //$NON-NLS-1$
@@ -790,18 +748,17 @@ public class CLIPrompterTest {
@Test
public final void testPromptLongTextConsoleManagerStringString() {
try (final PipedConsoleOutput out = new PipedConsoleOutput();
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(
new PrintStream(pout))) {
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(new PrintStream(pout))) {
final String message = "My message";
final String ender = "\\quit";
final String[] text = new String[] {"Some text with",
"feeds and other", " \tspecial characters"};
final String longText = text[0] + System.lineSeparator() + text[1] +
System.lineSeparator() + text[2];
final String[] text = new String[] { "Some text with", "feeds and other",
" \tspecial characters" };
final String longText = text[0] + System.lineSeparator() + text[1]
+ System.lineSeparator() + text[2];
final Thread th = new Thread(new Runnable() {
@@ -809,12 +766,10 @@ public class CLIPrompterTest {
public void run() {
try {
assertEquals("Asserted provided value to be retrieved", //$NON-NLS-1$
"", CLIPrompter.promptLongText(out, in, message,
ender));
"", CLIPrompter.promptLongText(out, in, message, ender));
assertEquals("Asserted provided value to be retrieved",
longText + System.lineSeparator(),
CLIPrompter.promptLongText(out, in, message,
ender));
CLIPrompter.promptLongText(out, in, message, ender));
} catch (final IOException e) {
fail("Unexpected io excpetion"); //$NON-NLS-1$
e.printStackTrace();
@@ -824,16 +779,16 @@ public class CLIPrompterTest {
th.start();
String nLine = out.readNextLine();
assertTrue(nLine.startsWith(message));
assertTrue(nLine.endsWith(CLIPrompterMessages
.getString("promptlongtext.exit.dispkey", ender)));
assertTrue(nLine.endsWith(
CLIPrompterMessages.getString("promptlongtext.exit.dispkey", ender)));
assertEquals(CLIPrompterMessages.getString("prompt.lineprompt"),
buf.readLine());
in.type(ender);
// enter long text
nLine = out.readNextLine();
assertTrue(nLine.startsWith(message));
assertTrue(nLine.endsWith(CLIPrompterMessages
.getString("promptlongtext.exit.dispkey", ender)));
assertTrue(nLine.endsWith(
CLIPrompterMessages.getString("promptlongtext.exit.dispkey", ender)));
assertEquals(CLIPrompterMessages.getString("prompt.lineprompt"),
buf.readLine());
for (final String element : text) {
@@ -854,12 +809,11 @@ public class CLIPrompterTest {
@Test
public final void testPromptMultiChoiceConsoleManagerListOfStringListOfUString() {
try (final PipedConsoleOutput out = new PipedConsoleOutput();
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(
new PrintStream(pout))) {
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(new PrintStream(pout))) {
final List<String> keys = new ArrayList<>();
final List<Object> choices = new ArrayList<>();
keys.add("A choice"); //$NON-NLS-1$
@@ -873,18 +827,18 @@ public class CLIPrompterTest {
@Override
public void run() {
try {
assertTrue("Asserted provided value to be retrieved",
CLIPrompter.promptMultiChoice(out, in, keys,
choices, message).isEmpty());
assertTrue("Asserted provided value to be retrieved", CLIPrompter
.promptMultiChoice(out, in, keys, choices, message)
.isEmpty());
final ArrayList<Object> l = new ArrayList<>();
l.add(choices.get(0));
assertEquals("Asserted provided value to be retrieved",
l, CLIPrompter.promptMultiChoice(out, in, keys,
choices, message));
assertEquals("Asserted provided value to be retrieved", l,
CLIPrompter.promptMultiChoice(out, in, keys, choices,
message));
l.add(choices.get(1));
assertEquals("Asserted provided value to be retrieved",
l, CLIPrompter.promptMultiChoice(out, in, keys,
choices, message));
assertEquals("Asserted provided value to be retrieved", l,
CLIPrompter.promptMultiChoice(out, in, keys, choices,
message));
} catch (final IOException e) {
fail("Unexpected io excpetion"); //$NON-NLS-1$
e.printStackTrace();
@@ -899,8 +853,7 @@ public class CLIPrompterTest {
buf.readLine());
in.type("yoyo"); //$NON-NLS-1$
// fail, reprompt
final String msg = CLIPrompterMessages.getString(
"promptchoice.formaterr", //$NON-NLS-1$
final String msg = CLIPrompterMessages.getString("promptchoice.formaterr", //$NON-NLS-1$
0, keys.size() - 1);
for (final String line : msg.split(System.lineSeparator())) {
assertEquals(line, out.readNextLine());
@@ -918,10 +871,8 @@ public class CLIPrompterTest {
buf.readLine());
in.type("2"); //$NON-NLS-1$
// fail, reprompt
assertEquals(
CLIPrompterMessages.getString("promptchoice.outofbounds", 0, //$NON-NLS-1$
keys.size() - 1),
out.readNextLine());
assertEquals(CLIPrompterMessages.getString("promptchoice.outofbounds", 0, //$NON-NLS-1$
keys.size() - 1), out.readNextLine());
assertTrue(out.readNextLine().contains(keys.get(0)));
assertTrue(out.readNextLine().contains(keys.get(1)));
assertEquals(CLIPrompterMessages.getString("prompt.lineprompt"), //$NON-NLS-1$
@@ -946,12 +897,11 @@ public class CLIPrompterTest {
@Test
public final void testPromptMultiChoiceConsoleManagerListOfUMapOfUTString() {
try (final PipedConsoleOutput out = new PipedConsoleOutput();
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(
new PrintStream(pout))) {
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(new PrintStream(pout))) {
final List<Object> keys = new ArrayList<>();
final Map<Object, Object> choices = new HashMap<>();
keys.add("A choice"); //$NON-NLS-1$
@@ -965,18 +915,18 @@ public class CLIPrompterTest {
@Override
public void run() {
try {
assertTrue("Asserted provided value to be retrieved",
CLIPrompter.promptMultiChoice(out, in, keys,
choices, message).isEmpty());
assertTrue("Asserted provided value to be retrieved", CLIPrompter
.promptMultiChoice(out, in, keys, choices, message)
.isEmpty());
final ArrayList<Object> l = new ArrayList<>();
l.add(choices.get(keys.get(0)));
assertEquals("Asserted provided value to be retrieved",
l, CLIPrompter.promptMultiChoice(out, in, keys,
choices, message));
assertEquals("Asserted provided value to be retrieved", l,
CLIPrompter.promptMultiChoice(out, in, keys, choices,
message));
l.add(choices.get(keys.get(1)));
assertEquals("Asserted provided value to be retrieved",
l, CLIPrompter.promptMultiChoice(out, in, keys,
choices, message));
assertEquals("Asserted provided value to be retrieved", l,
CLIPrompter.promptMultiChoice(out, in, keys, choices,
message));
} catch (final IOException e) {
fail("Unexpected io excpetion"); //$NON-NLS-1$
e.printStackTrace();
@@ -991,8 +941,7 @@ public class CLIPrompterTest {
buf.readLine());
in.type("yoyo"); //$NON-NLS-1$
// fail, reprompt
final String msg = CLIPrompterMessages.getString(
"promptchoice.formaterr", //$NON-NLS-1$
final String msg = CLIPrompterMessages.getString("promptchoice.formaterr", //$NON-NLS-1$
0, keys.size() - 1);
for (final String line : msg.split(System.lineSeparator())) {
assertEquals(line, out.readNextLine());
@@ -1010,10 +959,8 @@ public class CLIPrompterTest {
buf.readLine());
in.type("2"); //$NON-NLS-1$
// fail, reprompt
assertEquals(
CLIPrompterMessages.getString("promptchoice.outofbounds", 0, //$NON-NLS-1$
keys.size() - 1),
out.readNextLine());
assertEquals(CLIPrompterMessages.getString("promptchoice.outofbounds", 0, //$NON-NLS-1$
keys.size() - 1), out.readNextLine());
assertTrue(out.readNextLine().contains(keys.get(0).toString()));
assertTrue(out.readNextLine().contains(keys.get(1).toString()));
assertEquals(CLIPrompterMessages.getString("prompt.lineprompt"), //$NON-NLS-1$
@@ -1038,12 +985,11 @@ public class CLIPrompterTest {
@Test
public final void testPromptMultiChoiceConsoleManagerListOfUString() {
try (final PipedConsoleOutput out = new PipedConsoleOutput();
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(
new PrintStream(pout))) {
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(new PrintStream(pout))) {
final List<Object> keys = new ArrayList<>();
keys.add("A choice"); //$NON-NLS-1$
keys.add("An other"); //$NON-NLS-1$
@@ -1054,18 +1000,15 @@ public class CLIPrompterTest {
@Override
public void run() {
try {
assertTrue("Asserted provided value to be retrieved",
CLIPrompter.promptMultiChoice(out, in, keys,
message).isEmpty());
assertTrue("Asserted provided value to be retrieved", CLIPrompter
.promptMultiChoice(out, in, keys, message).isEmpty());
final ArrayList<Integer> l = new ArrayList<>();
l.add(0);
assertEquals("Asserted provided value to be retrieved",
l, CLIPrompter.promptMultiChoice(out, in, keys,
message));
assertEquals("Asserted provided value to be retrieved", l,
CLIPrompter.promptMultiChoice(out, in, keys, message));
l.add(1);
assertEquals("Asserted provided value to be retrieved",
l, CLIPrompter.promptMultiChoice(out, in, keys,
message));
assertEquals("Asserted provided value to be retrieved", l,
CLIPrompter.promptMultiChoice(out, in, keys, message));
} catch (final IOException e) {
fail("Unexpected io excpetion"); //$NON-NLS-1$
e.printStackTrace();
@@ -1080,8 +1023,7 @@ public class CLIPrompterTest {
buf.readLine());
in.type("yoyo"); //$NON-NLS-1$
// fail, reprompt
final String msg = CLIPrompterMessages.getString(
"promptchoice.formaterr", //$NON-NLS-1$
final String msg = CLIPrompterMessages.getString("promptchoice.formaterr", //$NON-NLS-1$
0, keys.size() - 1);
for (final String line : msg.split(System.lineSeparator())) {
assertEquals(line, out.readNextLine());
@@ -1099,10 +1041,8 @@ public class CLIPrompterTest {
buf.readLine());
in.type("2"); //$NON-NLS-1$
// fail, reprompt
assertEquals(
CLIPrompterMessages.getString("promptchoice.outofbounds", 0, //$NON-NLS-1$
keys.size() - 1),
out.readNextLine());
assertEquals(CLIPrompterMessages.getString("promptchoice.outofbounds", 0, //$NON-NLS-1$
keys.size() - 1), out.readNextLine());
assertTrue(out.readNextLine().contains(keys.get(0).toString()));
assertTrue(out.readNextLine().contains(keys.get(1).toString()));
assertEquals(CLIPrompterMessages.getString("prompt.lineprompt"), //$NON-NLS-1$
@@ -1127,12 +1067,11 @@ public class CLIPrompterTest {
@Test
public final void testPromptMultiChoiceConsoleManagerMapOfUTString() {
try (final PipedConsoleOutput out = new PipedConsoleOutput();
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(
new PrintStream(pout))) {
PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(new PrintStream(pout))) {
final List<Object> keys = new ArrayList<>();
final Map<Object, Object> choices = new HashMap<>();
keys.add("A choice"); //$NON-NLS-1$
@@ -1146,18 +1085,18 @@ public class CLIPrompterTest {
@Override
public void run() {
try {
assertTrue("Asserted provided value to be retrieved",
CLIPrompter.promptMultiChoice(out, in, keys,
choices, message).isEmpty());
assertTrue("Asserted provided value to be retrieved", CLIPrompter
.promptMultiChoice(out, in, keys, choices, message)
.isEmpty());
final ArrayList<Object> l = new ArrayList<>();
l.add(choices.get(keys.get(0)));
assertEquals("Asserted provided value to be retrieved",
l, CLIPrompter.promptMultiChoice(out, in, keys,
choices, message));
assertEquals("Asserted provided value to be retrieved", l,
CLIPrompter.promptMultiChoice(out, in, keys, choices,
message));
l.add(choices.get(keys.get(1)));
assertEquals("Asserted provided value to be retrieved",
l, CLIPrompter.promptMultiChoice(out, in, keys,
choices, message));
assertEquals("Asserted provided value to be retrieved", l,
CLIPrompter.promptMultiChoice(out, in, keys, choices,
message));
} catch (final IOException e) {
fail("Unexpected io excpetion"); //$NON-NLS-1$
e.printStackTrace();
@@ -1172,8 +1111,7 @@ public class CLIPrompterTest {
assertTrue(out.readNextLine().contains(keys.get(1).toString()));
in.type("yoyo"); //$NON-NLS-1$
// fail, reprompt
final String msg = CLIPrompterMessages.getString(
"promptchoice.formaterr", //$NON-NLS-1$
final String msg = CLIPrompterMessages.getString("promptchoice.formaterr", //$NON-NLS-1$
0, keys.size() - 1);
for (final String line : msg.split(System.lineSeparator())) {
assertEquals(line, out.readNextLine());
@@ -1187,10 +1125,8 @@ public class CLIPrompterTest {
assertTrue(out.readNextLine().contains(keys.get(1).toString()));
in.type("2"); //$NON-NLS-1$
// fail, reprompt
assertEquals(
CLIPrompterMessages.getString("promptchoice.outofbounds", 0, //$NON-NLS-1$
keys.size() - 1),
out.readNextLine());
assertEquals(CLIPrompterMessages.getString("promptchoice.outofbounds", 0, //$NON-NLS-1$
keys.size() - 1), out.readNextLine());
assertTrue(out.readNextLine().contains(keys.get(0).toString()));
assertTrue(out.readNextLine().contains(keys.get(1).toString()));
in.type("0"); //$NON-NLS-1$
@@ -1211,20 +1147,19 @@ public class CLIPrompterTest {
@Test
public final void testPromptNonEmpty() {
try (PipedOutputStream pout = new PipedOutputStream();
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(
new PrintStream(pout))) {
PipedInputStream pis = new PipedInputStream(pout);
BufferedReader buf = new BufferedReader(
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(new PrintStream(pout))) {
final String res = "some content"; //$NON-NLS-1$
final Thread th = new Thread(new Runnable() {
@Override
public void run() {
try {
assertEquals("Expected provided message to be returned",
res, CLIPrompter.promptNonEmpty(in,
"My message", "my reprompt")); //$NON-NLS-1$ //$NON-NLS-2$
assertEquals("Expected provided message to be returned", res,
CLIPrompter.promptNonEmpty(in, "My message", //$NON-NLS-1$
"my reprompt")); //$NON-NLS-1$
} catch (final IOException e) {
fail("Unexpected io excpetion"); //$NON-NLS-1$
e.printStackTrace();

View File

@@ -80,19 +80,20 @@ import org.junit.Test;
import net.bigeon.gclc.utils.AOutputForwardRunnable;
import net.bigeon.gclc.utils.PipedConsoleOutput;
/** <p>
/**
* <p>
* TODO
*
* @author Emmanuel Bigeon */
public class AOutputForwardRunnableTest {
/** <p>
/**
* <p>
* TODO
*
* @author Emmanuel Bigeon */
private final class AOutputForwardTestRunnable
extends AOutputForwardRunnable {
private int count = 2;
private final class AOutputForwardTestRunnable extends AOutputForwardRunnable {
private int count = 2;
private String message;
private AOutputForwardTestRunnable(final PipedConsoleOutput manager) {

View File

@@ -77,9 +77,8 @@ import java.util.Arrays;
import org.junit.Test;
import net.bigeon.gclc.tools.PrintUtils;
/** <p>
/**
* <p>
* TODO
*
* @author Emmanuel Bigeon */
@@ -93,37 +92,30 @@ public class PrintUtilsTest {
String longText = text + " that may be abbreviated";
assertEquals(text, PrintUtils.print(text, text.length(), true));
assertEquals(text, PrintUtils.print(text, text.length(), false));
assertEquals(text + " ",
PrintUtils.print(text, text.length() + 3, false));
assertEquals(text + " ",
PrintUtils.print(text, text.length() + 3, true));
assertEquals(text + " ", PrintUtils.print(text, text.length() + 3, false));
assertEquals(text + " ", PrintUtils.print(text, text.length() + 3, true));
assertEquals(text, PrintUtils.print(longText, text.length(), false));
assertEquals(text + "...",
PrintUtils.print(longText, text.length() + 3, true));
assertEquals(text + "...", PrintUtils.print(longText, text.length() + 3, true));
}
/** Test method for
* {@link net.bigeon.gclc.tools.PrintUtils#wrap(java.lang.String, int)}. */
@Test
public final void testWrap() {
String[] line = {"A text separated", "on several lines", "with cuts at",
"whitespace", "characters"};
String text = line[0] + " " + line[1] + " " + line[2] + " " + line[3] +
" " + line[4];
assertEquals(Arrays.asList(line),
PrintUtils.wrap(text, line[0].length() + 1));
assertEquals(Arrays.asList(line),
PrintUtils.wrap(text, line[0].length()));
String[] line = { "A text separated", "on several lines", "with cuts at",
"whitespace", "characters" };
String text = line[0] + " " + line[1] + " " + line[2] + " " + line[3] + " "
+ line[4];
assertEquals(Arrays.asList(line), PrintUtils.wrap(text, line[0].length() + 1));
assertEquals(Arrays.asList(line), PrintUtils.wrap(text, line[0].length()));
// test with split word
line = new String[] {"A text separated", "on several lines", "",
"with cuts at", "whitespacecharac", "ters"};
text = line[0] + " " + line[1] + System.lineSeparator() + line[3] +
" " + line[4] + line[5];
assertEquals(Arrays.asList(line),
PrintUtils.wrap(text, line[0].length()));
assertEquals(Arrays.asList(""),
PrintUtils.wrap("", line[0].length()));
line = new String[] { "A text separated", "on several lines", "", "with cuts at",
"whitespacecharac", "ters" };
text = line[0] + " " + line[1] + System.lineSeparator() + line[3] + " " + line[4]
+ line[5];
assertEquals(Arrays.asList(line), PrintUtils.wrap(text, line[0].length()));
assertEquals(Arrays.asList(""), PrintUtils.wrap("", line[0].length()));
}
}

View File

@@ -0,0 +1,67 @@
package net.bigeon.gclc.utils;
import static org.junit.Assert.*;
import java.io.IOException;
import org.junit.Test;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.tools.ConstantString;
import net.bigeon.gclc.utils.EmptyInput;
public class EmptyInputTest {
@Test
public void testClose() throws IOException {
ConsoleInput input = EmptyInput.INSTANCE;
// several close operation shold create no error
input.close();
input.close();
assertFalse("This source input should never be closed", input.isClosed());
}
@Test
public void testGetPrompt() {
ConsoleInput input = EmptyInput.INSTANCE;
String init = input.getPrompt().apply();
input.setPrompt("some prompt different from "+init);
assertEquals("Prompts should not be changed", init, input.getPrompt().apply());
input.setPrompt(new ConstantString("some other prompt different from "+init));
assertEquals("Prompts should not be changed", init, input.getPrompt().apply());
}
@Test
public void testInterruptPrompt() {
// Nothing to test, really...
ConsoleInput input = EmptyInput.INSTANCE;
// several close operation shold create no error
input.interruptPrompt();
assertFalse("This source input should never be closed", input.isClosed());
}
@Test
public void testIsClosed() throws IOException {
ConsoleInput input = EmptyInput.INSTANCE;
// several close operation shold create no error
assertFalse("This source input should never be closed", input.isClosed());
input.close();
assertFalse("This source input should never be closed", input.isClosed());
input.close();
assertFalse("This source input should never be closed", input.isClosed());
}
@Test
public void testPrompt() throws IOException {
ConsoleInput input = EmptyInput.INSTANCE;
// several close operation shold create no error
assertEquals("Any prompt should return the empty value", "", input.prompt());
assertEquals("Any prompt should return the empty value", "", input.prompt(0));
assertEquals("Any prompt should return the empty value", "", input.prompt(12));
assertEquals("Any prompt should return the empty value", "", input.prompt("Test"));
assertEquals("Any prompt should return the empty value", "", input.prompt("Test", 0));
assertEquals("Any prompt should return the empty value", "", input.prompt("Test", 12));
}
}

View File

@@ -0,0 +1,31 @@
package net.bigeon.gclc.utils;
import static org.junit.Assert.assertFalse;
import java.io.IOException;
import org.junit.Test;
import net.bigeon.gclc.manager.ConsoleOutput;
public class SinkOutputTest {
@Test
public void testClose() throws Exception {
ConsoleOutput output = SinkOutput.INSTANCE;
// several close operation shold create no error
output.close();
output.close();
assertFalse("This source input should never be closed", output.isClosed());
}
@Test
public void testPrint() throws IOException {
ConsoleOutput output = SinkOutput.INSTANCE;
// several close operation shold create no error
output.print("Anything");
output.println("Anything");
output.println();
assertFalse("This source input should never be closed", output.isClosed());
}
}