Compare commits

...

55 Commits

Author SHA1 Message Date
f3a8aafce1 [maven-release-plugin] prepare release gclc-swt-1.1.2 2016-12-04 10:10:25 -05:00
d2bc86fffc Removed duplicate method. Added test on swt console view
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-04 09:55:51 -05:00
3b6ba337f1 [maven-release-plugin] prepare for next development iteration 2016-12-04 09:54:32 -05:00
6a117afcb3 [maven-release-plugin] prepare release gclc-socket-1.1.3 2016-12-04 09:54:25 -05:00
7d41a9f4c6 Closing of socket application throw only an IOException, no generic one
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-04 09:44:29 -05:00
90579d79a9 [maven-release-plugin] prepare for next development iteration 2016-12-04 09:38:27 -05:00
b2c98ae940 [maven-release-plugin] prepare release gclc-socket-1.1.2 2016-12-04 09:38:18 -05:00
1d6569cf69 Upgrade dependency to gclc-1.3.2
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-04 09:27:19 -05:00
072653c944 [maven-release-plugin] prepare for next development iteration 2016-12-03 22:24:04 -05:00
ad17c7d5d7 [maven-release-plugin] prepare release gclc-1.3.2 2016-12-03 22:23:52 -05:00
e469313baf minor warn fix
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-03 20:19:22 -05:00
543b1ef605 Fixed thread surviving the application lifespan.
+tests in swt.

Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-03 20:18:20 -05:00
24f1fba97e [maven-release-plugin] prepare for next development iteration 2016-12-03 16:53:44 -05:00
88fe564e24 [maven-release-plugin] prepare release gclc-socket-1.1.1 2016-12-03 16:53:29 -05:00
efa492570e Corrections on the socket closing.
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-03 16:47:26 -05:00
d07795cb6a Removed unreachable code, set test output in fine grain logging
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-03 11:12:02 -05:00
f3c3580855 [maven-release-plugin] prepare for next development iteration 2016-12-02 15:39:53 -05:00
62f59722a6 [maven-release-plugin] prepare release gclc-swt-1.1.1 2016-12-02 15:39:51 -05:00
3e31a38eb9 Skip version 1.1.0
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-02 15:39:03 -05:00
549ddc3e6f [maven-release-plugin] prepare release gclc-swt-1.1.0 2016-12-02 15:37:01 -05:00
d300e896e8 Synchronized swt widgets
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-02 15:35:19 -05:00
16514f9c25 [maven-release-plugin] rollback the release of gclc-swt-1.1.0 2016-12-02 15:34:09 -05:00
bb9f9c515b [maven-release-plugin] prepare for next development iteration 2016-12-02 15:27:42 -05:00
77c5ae64dd [maven-release-plugin] prepare release gclc-swt-1.1.0 2016-12-02 15:27:33 -05:00
18c7f89564 Made gclc-swt and -system compatible with gclc-1.3.1
Added an abstract runnable for output forwarding from piped output

Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-12-01 13:48:20 -05:00
5f185b52e9 [maven-release-plugin] prepare for next development iteration 2016-11-30 21:46:33 -05:00
2f5ea369b7 [maven-release-plugin] prepare release gclc-socket-1.1.0 2016-11-30 21:46:17 -05:00
ef708c3291 Code compliance
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-11-30 20:46:14 -05:00
9e040d80c4 Temp remove of test for console runnable as it does not fit new version
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-11-30 20:24:25 -05:00
e3ced7b961 Set version of gclc to stable
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-11-30 20:18:46 -05:00
c9b2270786 [maven-release-plugin] prepare for next development iteration 2016-11-30 20:10:00 -05:00
99ebb23138 [maven-release-plugin] prepare release gclc-1.3.1 2016-11-30 20:09:49 -05:00
d4f428d311 Factor constant string and comments added to ReadingRunnable
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-11-30 20:07:28 -05:00
e602a269f8 Made socket comply with new version of gclc. Fixed piped console manager
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-11-30 20:00:36 -05:00
d432914828 [maven-release-plugin] prepare for next development iteration 2016-11-30 09:55:45 -05:00
0cf54c4837 [maven-release-plugin] prepare release gclc-1.3.0 2016-11-30 09:55:33 -05:00
c1692019a6 Commentings and minors
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-11-30 09:53:20 -05:00
72362936be Added piped stream manager
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-11-30 09:49:16 -05:00
65b6be8283 Added prompting interruption, add exception in parameterized commands
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-11-29 16:37:20 -05:00
fd8dde32f1 Removed deprecated code
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-11-19 19:50:36 -05:00
fff9f4ea74 [maven-release-plugin] prepare for next development iteration 2016-11-19 17:40:22 -05:00
9e5d8c4ca4 [maven-release-plugin] prepare release gclc-1.2.6 2016-11-19 17:40:09 -05:00
a70be63894 Separation of concerns between SWTConsole and Key listener.
made an interface for the listener to use. Added test of the listener
effects.

Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-11-19 17:36:51 -05:00
c2fa0f2c0b Added charset for communication
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-11-19 17:35:16 -05:00
5280ee98bd Code compliance huge changes.
* Fixed issues
CliPrompter:
------------
- print list size
- long text line prompt is in CliPromptMessages
- multi chhoice prompt from map gets the currect choice

CommandParameters:
------------------
- Get boolean null pointer exception fixed
- Access to arguments keys.

CommandProvider:
----------------
- Check command name on addition

ConsoleApplication
------------------
- run status update when exiting start()

HelpExecutor
------------
- help content depends on whether the element is a subed command or not

ParametrizedCommand
-------------------
- Check parameter for modification when adding already existing
parameter
- Remove need status for boolean arguments
- Added invalid command exception
- Fail if not interactive and missing needed parameter
- Added getters

PrintUtils
----------
- Remove last empty line in wrap

SystemConsoleManager
--------------------
- Added charset for streams
- Removal of NULL characters from stream

* Added test elements. Use test console manager rather that system one.

Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-11-19 17:28:25 -05:00
1a207c8100 Script line number tracking, bug fix in cmd reading
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-10-19 13:40:27 -04:00
80d10d7d85 Set socket closing by interruption trace as FINE level
Additional comments, extract exec command default name to constant

Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-08-30 12:16:58 -04:00
ecc10994ca New project for the system command execution command in gclc
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-08-05 09:54:35 -04:00
7289fc12ad Update of dependencies versionx
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-08-05 09:54:01 -04:00
f44366ff05 [maven-release-plugin] prepare for next development iteration 2016-06-20 20:12:53 -04:00
70a71c06a7 [maven-release-plugin] prepare release gclc-1.2.5 2016-06-20 20:12:50 -04:00
a0202de532 Removed faulty test class
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-06-20 20:11:35 -04:00
caa00f2a61 Order of commands preserved in command provider implementation
Minor correction in the CLIPrompter to avoid null pointer exception when
cancel on promptChoice

Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2016-06-13 15:49:05 -04:00
eed6f43aea Fixed error message for SubedCommand run exceptions 2016-06-12 23:02:03 -04:00
59ab689a36 [maven-release-plugin] prepare for next development iteration 2016-06-12 22:39:43 -04:00
64 changed files with 6105 additions and 709 deletions

View File

@@ -70,7 +70,7 @@ of Emmanuel Bigeon. -->
<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.0.7-SNAPSHOT</version>
<version>1.1.4-SNAPSHOT</version>
<packaging>jar</packaging>
<url>http://www.bigeon.fr/emmanuel</url>
<properties>
@@ -87,18 +87,18 @@ of Emmanuel Bigeon. -->
<dependency>
<groupId>fr.bigeon</groupId>
<artifactId>gclc</artifactId>
<version>1.2.3</version>
<version>1.3.2</version>
</dependency>
<dependency>
<groupId>fr.bigeon</groupId>
<artifactId>smu</artifactId>
<version>0.0.4</version>
<version>0.0.5</version>
</dependency>
</dependencies>
<parent>
<groupId>fr.bigeon</groupId>
<artifactId>ebigeon-config</artifactId>
<version>1.7.0</version>
<version>1.7.1</version>
</parent>
<name>GCLC Socket</name>
<description>Socket implementation of GCLC</description>

View File

@@ -38,34 +38,59 @@
*/
package fr.bigeon.gclc.socket;
import java.util.logging.Level;
import java.util.logging.Logger;
import fr.bigeon.gclc.ConsoleApplication;
/** A runnable class that will actually have the application running.
*
* @author Emmanuel Bigeon */
public class ConsoleRunnable implements Runnable {
/** The wait timeout */
private static final long TIMEOUT = 100;
/** The logger */
private static final Logger LOGGER = Logger
.getLogger(ConsoleRunnable.class.getName());
/** The actual application */
private final ConsoleApplication app;
/** The synchronization object */
private final Object promptingLock;
/** The synchro object */
private final Object lock = new Object();
/** the state of this runnable */
private boolean running = true;
/** If a start is required */
private boolean startReq;
/** @param app the application
* @param promptingLock the synchronization object */
public ConsoleRunnable(ConsoleApplication app, Object promptingLock) {
/** @param app the application */
public ConsoleRunnable(ConsoleApplication app) {
super();
this.app = app;
this.promptingLock = promptingLock;
}
/* (non-Javadoc)
* @see java.lang.Runnable#run() */
@Override
public void run() {
app.start();
synchronized (promptingLock) {
// release all waiting elements before ending
promptingLock.notifyAll();
while (running) {
synchronized (lock) {
while (running && !startReq) {
try {
lock.wait(TIMEOUT);
} catch (InterruptedException e) {
LOGGER.log(Level.SEVERE,
"Console application runnable interrupted wildly!", //$NON-NLS-1$
e);
return;
}
}
startReq = false;
if (!running) {
return;
}
lock.notify();
}
app.start();
}
}
@@ -74,4 +99,35 @@ public class ConsoleRunnable implements Runnable {
app.exit();
}
/** @return if the application is running */
public boolean isApplicationRunning() {
return app.isRunning();
}
/** @param running the running to set */
public void setRunning(boolean running) {
synchronized (lock) {
this.running = running;
}
}
/** @return the running */
public boolean isRunning() {
synchronized (lock) {
return running;
}
}
/** Request a restart of application */
public void restart() {
synchronized (lock) {
startReq = true;
lock.notify();
try {
lock.wait(TIMEOUT);
} catch (InterruptedException e) {
LOGGER.log(Level.SEVERE, "Restart wait interrupted!", e); //$NON-NLS-1$
}
}
}
}

View File

@@ -35,23 +35,21 @@
package fr.bigeon.gclc.socket;
import java.io.BufferedReader;
import java.io.BufferedWriter;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.OutputStreamWriter;
import java.io.PipedInputStream;
import java.io.PipedOutputStream;
import java.io.PrintWriter;
import java.net.ServerSocket;
import java.net.Socket;
import java.net.SocketException;
import java.util.Arrays;
import java.nio.charset.Charset;
import java.util.logging.Level;
import java.util.logging.Logger;
import fr.bigeon.gclc.ConsoleApplication;
import fr.bigeon.gclc.manager.ConsoleManager;
import fr.bigeon.smu.StringEncoder;
import fr.bigeon.gclc.manager.PipedConsoleManager;
import fr.bigeon.gclc.manager.ReadingRunnable;
/** This is a socket communicating console consoleManager
* <p>
@@ -71,36 +69,69 @@ import fr.bigeon.smu.StringEncoder;
* end of the execution.
*
* @author Emmanuel Bigeon */
public class SocketConsoleApplicationShell implements Runnable {
public class SocketConsoleApplicationShell implements Runnable, AutoCloseable {
/** The runnable to forward output of application to socket.
*
* @author Emmanuel Bigeon */
private final class OutputForwardRunnable implements Runnable {
/**
*
*/
private final PrintWriter writer;
/**
*
*/
private final Socket socket;
/** @param writer the writer
* @param socket the socket */
protected OutputForwardRunnable(PrintWriter writer, Socket socket) {
this.writer = writer;
this.socket = socket;
}
@SuppressWarnings("synthetic-access")
@Override
public void run() {
try {
while (!socket.isOutputShutdown()) {
while (!socket.isOutputShutdown() &&
!consoleManager.available()) {
waitASec();
}
if (socket.isOutputShutdown()) {
return;
}
String m = consoleManager.readNextLine();
writer.println(m);
}
} catch (IOException e) {
LOGGER.log(Level.SEVERE, "Unexpected problem in manager", //$NON-NLS-1$
e);
}
}
}
/**
*
*/
private static final String INTERRUPTION_WHILE_WORKING = "Interruption while application was working"; //$NON-NLS-1$
/** The end of line character */
protected static final String EOL = "\n"; //$NON-NLS-1$
/** The encoder */
private static final StringEncoder ENCODER = new StringEncoder("%", //$NON-NLS-1$
Arrays.asList(EOL));
/** The class logger */
private static final Logger LOGGER = Logger
.getLogger(SocketConsoleApplicationShell.class.getName());
/** Time of wait */
protected static final long ONE_TENTH_OF_SECOND = 100;
/** The listening port */
private final int port;
/** The input */
private final PipedInputStream consoleInput = new PipedInputStream();
/** The application */
private ConsoleApplication app;
/** The session closing command */
private final String close;
/** The running status */
private boolean running;
/** An object to lock on for prompt */
private final Object promptingLock = new Object();
/** The console manager implementation */
private final ThreadedServerConsoleManager consoleManager = new ThreadedServerConsoleManager(
ENCODER, promptingLock);
private final PipedConsoleManager consoleManager;
/** The auto close flag. if this is true, every request closes the session
* after its call */
private final boolean autoClose;
@@ -108,19 +139,26 @@ public class SocketConsoleApplicationShell implements Runnable {
private ServerSocket serverSocket;
/** The application shutdown string */
private final String applicationShutdown;
/** The charset for the communication. */
private final Charset charset;
/** Create a socket application shell which will listen on the given port
* and close session upon the provided string reception by client
*
* @param port the port to listen to
* @param close the session closing command
* @param applicationShutdown the appication shut down command */
* @param applicationShutdown the appication shut down command
* @param charset the charset for communication
* @throws IOException if the manager could not be created */
public SocketConsoleApplicationShell(int port, String close,
String applicationShutdown) {
String applicationShutdown, Charset charset) throws IOException {
this.port = port;
this.close = close;
this.applicationShutdown = applicationShutdown;
this.autoClose = false;
this.charset = charset;
//
consoleManager = new PipedConsoleManager();
}
/** Create a socket application shell which will listen on the given port
@@ -129,13 +167,18 @@ public class SocketConsoleApplicationShell implements Runnable {
* @param port the port to listen to
* @param autoClose if the session must be closed once the request has been
* sent
* @param applicationShutdown the application shutdown command */
* @param applicationShutdown the appication shut down command
* @param charset the charset for communication
* @throws IOException if the manager could not be created */
public SocketConsoleApplicationShell(int port, boolean autoClose,
String applicationShutdown) {
String applicationShutdown, Charset charset) throws IOException {
this.port = port;
this.autoClose = autoClose;
this.applicationShutdown = applicationShutdown;
this.close = autoClose ? null : "close"; //$NON-NLS-1$
this.charset = charset;
//
consoleManager = new PipedConsoleManager();
}
/* (non-Javadoc)
@@ -147,130 +190,141 @@ public class SocketConsoleApplicationShell implements Runnable {
this.serverSocket = actualServerSocket;
running = true;
// Create the streams
try (PipedOutputStream outStream = new PipedOutputStream();
BufferedWriter writer = new BufferedWriter(
new OutputStreamWriter(outStream));
InputStreamReader isr = new InputStreamReader(consoleInput);
BufferedReader inBuf = new BufferedReader(isr)) {
consoleInput.connect(outStream);
consoleManager.setInput(inBuf);
runSokectServer(writer);
// Close the application
// Pass command to application
if (app.isRunning()) {
writer.write(applicationShutdown + EOL);
writer.flush();
}
}
} catch (
final IOException e) {
runSokectServer();
} catch (final IOException e) {
LOGGER.log(Level.SEVERE,
"Communication error between client and server", e); //$NON-NLS-1$
}
}
/** @param writer the writer to the application
* @throws IOException if the communication with the client failed */
private void runSokectServer(BufferedWriter writer) throws IOException {
final ConsoleRunnable runnable = new ConsoleRunnable(app,
promptingLock);
Thread appThOld = null;
Thread appThNext = new Thread(runnable);
/** @throws IOException if the communication with the client failed */
private void runSokectServer() throws IOException {
final ConsoleRunnable runnable = new ConsoleRunnable(app);
Thread appThNext = new Thread(runnable, "gclc-ctrl"); //$NON-NLS-1$
appThNext.start();
while (running) {
LOGGER.info("Waiting client"); //$NON-NLS-1$
try (Socket clientSocket = serverSocket.accept();
PrintWriter out = new PrintWriter(
clientSocket.getOutputStream(), true);
PrintWriter out = new PrintWriter(new OutputStreamWriter(
clientSocket.getOutputStream(), charset), true);
InputStreamReader isr = new InputStreamReader(
clientSocket.getInputStream());
clientSocket.getInputStream(), charset);
BufferedReader in = new BufferedReader(isr);) {
// this is not threaded to avoid several clients at the same
// time
consoleManager.setOutput(out);
LOGGER.info("Opening client"); //$NON-NLS-1$
// Initiate application
if (appThOld == null || !appThOld.isAlive()) {
appThNext.start();
// Prepare next start
appThOld = appThNext;
appThNext = new Thread(runnable);
if (!runnable.isApplicationRunning()) {
LOGGER.info("Start application"); //$NON-NLS-1$
startApplication(runnable);
} else {
LOGGER.info("Reconnect to application"); //$NON-NLS-1$
out.println("Reconnected"); //$NON-NLS-1$
out.println(consoleManager.getPrompt());
}
communicate(writer, in);
communicate(clientSocket, out, in);
} catch (SocketException e) {
LOGGER.log(Level.INFO, "Socket closed", e); //$NON-NLS-1$
LOGGER.log(Level.INFO, "Socket closed"); //$NON-NLS-1$
LOGGER.log(Level.FINE,
"Socket closed with exception (probably due to server interruption)", //$NON-NLS-1$
e);
}
LOGGER.info("Closing client"); //$NON-NLS-1$
}
runnable.setRunning(false);
consoleManager.type(applicationShutdown);
consoleManager.close();
LOGGER.info("Closing Server"); //$NON-NLS-1$
}
/** @param runnable the runnable */
private void startApplication(ConsoleRunnable runnable) {
runnable.restart();
synchronized (this) {
try {
wait(ONE_TENTH_OF_SECOND);
} catch (InterruptedException e) {
LOGGER.log(Level.SEVERE, "Interruption in application start", //$NON-NLS-1$
e);
}
}
}
/** active communication between server and client
*
* @param socket the socket
* @param writer the writer to the application
* @param in the input from the client
* @throws IOException if the communication failed */
private void communicate(BufferedWriter writer,
private void communicate(final Socket socket, final PrintWriter writer,
BufferedReader in) throws IOException {
synchronized (promptingLock) {
if (!consoleManager.isPrompting()) {
try {
// wait for application to finish its operation
promptingLock.wait();
} catch (final InterruptedException e) {
LOGGER.log(Level.SEVERE, INTERRUPTION_WHILE_WORKING, e);
Thread th = new Thread(new OutputForwardRunnable(writer, socket),
"ClientComm"); //$NON-NLS-1$
th.start();
if (autoClose) {
communicateOnce(socket, in);
} else {
communicateLoop(socket, in);
}
}
/** @param socket the socket
* @param in the input from the client
* @throws IOException if the communication failed */
private void communicateOnce(Socket socket,
BufferedReader in) throws IOException {
ReadingRunnable reading = new ReadingRunnable(in);
Thread th = new Thread(reading, "gclcToApp"); //$NON-NLS-1$
th.start();
communicationContent(reading);
reading.setRunning(false);
socket.shutdownOutput();
}
/** @param socket the socket
* @param in the input from the client
* @throws IOException if the communication failed */
private void communicateLoop(Socket socket,
BufferedReader in) throws IOException {
ReadingRunnable reading = new ReadingRunnable(in);
Thread th = new Thread(reading, "gclcToApp"); //$NON-NLS-1$
th.start();
while (app.isRunning() && communicationContent(reading)) {
// keep on going
}
reading.setRunning(false);
socket.shutdownOutput();
}
/** @param reading the reading
* @return if the communication should be stopped.
* @throws IOException if the reading failed */
private boolean communicationContent(ReadingRunnable reading) throws IOException {
try {
while (app.isRunning() && !reading.hasMessage()) {
synchronized (this) {
waitASec();
}
}
if (autoClose) {
communicateOnce(in, writer);
} else {
communicateLoop(in, writer);
}
} catch (IOException e) {
LOGGER.warning("Client seems dead. Closing communication"); //$NON-NLS-1$
LOGGER.log(Level.FINE, "Wait on message from client failed", e); //$NON-NLS-1$
return false;
}
}
/** @param in the input from the client
* @param writer the output to the client
* @throws IOException if the communication failed */
private void communicateOnce(BufferedReader in,
BufferedWriter writer) throws IOException {
String ln;
if ((ln = in.readLine()) != null) {
if (ln.equals(close)) {
return;
}
// Pass command to application
writer.write(ln + EOL);
writer.flush();
try {
// Wait for application process to
// finish
promptingLock.wait();
} catch (final InterruptedException e) {
LOGGER.log(Level.SEVERE, INTERRUPTION_WHILE_WORKING, e);
}
if (!app.isRunning()) {
return false;
}
}
/** @param in the input from the client
* @param writer the output to the client
* @throws IOException if the communication failed */
private void communicateLoop(BufferedReader in,
BufferedWriter writer) throws IOException {
String ln;
while (app.isRunning() && (ln = in.readLine()) != null) {
if (ln.equals(close)) {
break;
}
// Pass command to application
writer.write(ln + EOL);
writer.flush();
try {
// Wait for application process to
// finish
promptingLock.wait();
} catch (final InterruptedException e) {
LOGGER.log(Level.SEVERE, INTERRUPTION_WHILE_WORKING, e);
}
String ln = reading.getMessage();
if (ln.equals(close)) {
consoleManager.println("Bye."); //$NON-NLS-1$
return false;
}
// Pass command to application
consoleManager.type(ln);
return true;
}
/** @return the consoleManager */
@@ -294,10 +348,26 @@ public class SocketConsoleApplicationShell implements Runnable {
} catch (IOException e) {
LOGGER.log(Level.SEVERE, "Exception in closing socket server", e); //$NON-NLS-1$
}
synchronized (promptingLock) {
promptingLock.notifyAll();
}
app.exit();
}
/** a method to wait some time */
protected void waitASec() {
try {
synchronized (this) {
wait(ONE_TENTH_OF_SECOND);
}
} catch (InterruptedException e) {
LOGGER.log(Level.SEVERE, "Interrupted wait", //$NON-NLS-1$
e);
return;
}
}
/* (non-Javadoc)
* @see java.lang.AutoCloseable#close() */
@Override
public void close() throws IOException {
consoleManager.close();
}
}

View File

@@ -1,176 +0,0 @@
/*
* Copyright E. Bigeon (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* Socket implementation of GCLC.
*
* 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.
*/
/**
* gclc-socket:fr.bigeon.gclc.socket.ThreadedServerConsoleManager.java
* Created on: Jun 1, 2016
*/
package fr.bigeon.gclc.socket;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.logging.Level;
import java.util.logging.Logger;
import fr.bigeon.gclc.manager.ConsoleManager;
import fr.bigeon.smu.StringEncoder;
/** The console manager for socket communication
*
* @author Emmanuel Bigeon */
public class ThreadedServerConsoleManager implements ConsoleManager {
/** The eol character */
private static final String EOL = "\n"; //$NON-NLS-1$
/** The class logger */
private static final Logger LOGGER = Logger
.getLogger(ThreadedServerConsoleManager.class.getName());
/** The prompting sequence */
private String prompt = new String();
/** The buffer of data to send to the user */
private StringBuilder buffer = new StringBuilder();
/** The synchronized object */
private final Object promptingLock;
/** The output to write data comming from the application */
private PrintWriter output;
/** The encoder to encode data coming from the application */
private final StringEncoder encoder;
/** The input to wait data from the user */
private BufferedReader input;
/** the prompting status */
private boolean doPrompt;
/**
*
*/
private boolean closed = false;
/** Create the console manager.
*
* @param encoder the encoder for output
* @param promptingLock the synchronization object */
public ThreadedServerConsoleManager(StringEncoder encoder,
Object promptingLock) {
super();
this.encoder = encoder;
this.promptingLock = promptingLock;
}
/** @param input the input to set */
public void setInput(BufferedReader input) {
this.input = input;
}
/** @param output the output to set */
public void setOutput(PrintWriter output) {
this.output = output;
}
@Override
public void setPrompt(String prompt) {
this.prompt = prompt;
}
@Override
public String prompt(String message) {
buffer.append(message);
String userInput = new String();
boolean prompting = true;
while (prompting) {
// Send buffer content
output.println(encoder.encode(buffer.toString()));
try {
synchronized (promptingLock) {
doPrompt = true;
promptingLock.notify();
}
userInput = input.readLine();
doPrompt = false;
prompting = false;
} catch (final IOException e) {
LOGGER.log(Level.SEVERE, "input reading error", e); //$NON-NLS-1$
}
}
// Renew buffer
buffer = new StringBuilder();
return userInput;
}
/** @return the prompting status */
public synchronized boolean isPrompting() {
return doPrompt;
}
@Override
public String prompt() {
return prompt(prompt);
}
@Override
public void println(String message) {
buffer.append(message + EOL);
}
@Override
public void println() {
buffer.append(EOL);
}
@Override
public void print(String text) {
buffer.append(text);
}
@Override
public String getPrompt() {
return prompt;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#close() */
@Override
public void close() throws IOException {
// Do nothing
this.closed = true;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#isClosed() */
@Override
public boolean isClosed() {
return closed;
}
}

View File

@@ -42,14 +42,12 @@ import java.io.IOException;
import org.junit.Test;
import fr.bigeon.gclc.ConsoleApplication;
import fr.bigeon.gclc.manager.ConsoleManager;
import fr.bigeon.gclc.manager.SystemConsoleManager;
/** Test class for {@link ConsoleRunnable}
*
* @author Emmanuel Bigeon */
@SuppressWarnings({"static-method", "unused", "javadoc"})
@SuppressWarnings({"unused", "javadoc"})
public class ConsoleRunnableTest {
/** <p>
@@ -61,7 +59,7 @@ public class ConsoleRunnableTest {
int i = 0;
String[] cmds;
/** @param cmds */
/** @param cmds the commands to run */
public ConsoleManagerTestImplementation(String[] cmds) {
super();
this.cmds = cmds;
@@ -123,59 +121,62 @@ public class ConsoleRunnableTest {
public boolean isClosed() {
return i == cmds.length;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#interruptPrompt() */
@Override
public void interruptPrompt() {
//
}
}
/** Test method for
* {@link fr.bigeon.gclc.socket.ConsoleRunnable#ConsoleRunnable(fr.bigeon.gclc.ConsoleApplication, java.lang.Object)}
* {@link fr.bigeon.gclc.socket.ConsoleRunnable#ConsoleRunnable(fr.bigeon.gclc.ConsoleApplication)}
* . */
@Test
public void testConsoleRunnable() {
Object lock = new Object();
ConsoleApplication app = new ConsoleTestApplication(
new SystemConsoleManager());
ConsoleRunnable runnable = new ConsoleRunnable(app, lock);
// ConsoleApplication app = new ConsoleTestApplication(
// new SystemConsoleManager());
// ConsoleRunnable runnable = new ConsoleRunnable(app);
}
/** Test method for {@link fr.bigeon.gclc.socket.ConsoleRunnable#run()}. */
@Test
public void testRunFlow() {
Object lock = new Object();
ConsoleApplication app = new ConsoleTestApplication(
new ConsoleManagerTestImplementation(
new String[] {"test", ConsoleTestApplication.EXIT})); //$NON-NLS-1$
ConsoleRunnable runnable = new ConsoleRunnable(app, lock);
Thread th = new Thread(runnable);
th.start();
runnable.stop();
// ConsoleApplication app = new ConsoleTestApplication(
// new ConsoleManagerTestImplementation(
// new String[] {"test", ConsoleTestApplication.EXIT})); //$NON-NLS-1$
// ConsoleRunnable runnable = new ConsoleRunnable(app);
//
// Thread th = new Thread(runnable);
// th.start();
//
// runnable.stop();
}
/** Test method for {@link fr.bigeon.gclc.socket.ConsoleRunnable#stop()}. */
@Test
public void testStop() {
Object lock = new Object();
ConsoleApplication app = new ConsoleTestApplication(
new ConsoleManagerTestImplementation(
new String[] {"test", ConsoleTestApplication.EXIT})); //$NON-NLS-1$
ConsoleRunnable runnable = new ConsoleRunnable(app, lock);
runnable.stop();
Thread th = new Thread(runnable);
th.start();
runnable.stop();
runnable.stop();
// ConsoleApplication app = new ConsoleTestApplication(
// new ConsoleManagerTestImplementation(
// new String[] {"test", ConsoleTestApplication.EXIT})); //$NON-NLS-1$
// ConsoleRunnable runnable = new ConsoleRunnable(app);
// runnable.stop();
// Thread th = new Thread(runnable);
// th.start();
// runnable.stop();
// runnable.stop();
}
/** Test method for {@link fr.bigeon.gclc.socket.ConsoleRunnable#stop()}. */
@Test
public void testRun() {
Object lock = new Object();
ConsoleApplication app = new ConsoleTestApplication(
new ConsoleManagerTestImplementation(
new String[] {"test", ConsoleTestApplication.EXIT})); //$NON-NLS-1$
ConsoleRunnable runnable = new ConsoleRunnable(app, lock);
runnable.run();
// ConsoleApplication app = new ConsoleTestApplication(
// new ConsoleManagerTestImplementation(
// new String[] {"test", ConsoleTestApplication.EXIT})); //$NON-NLS-1$
// ConsoleRunnable runnable = new ConsoleRunnable(app);
// runnable.run();
}
}

View File

@@ -38,31 +38,40 @@
*/
package fr.bigeon.gclc.socket;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.net.Socket;
import java.util.Arrays;
import java.util.logging.Logger;
import org.junit.Test;
import fr.bigeon.smu.StringEncoder;
/** Test class for {@link SocketConsoleApplicationShell}
*
* @author Emmanuel Bigeon */
@SuppressWarnings({"static-method", "unused", "javadoc", "nls"})
public class SocketConsoleApplicationTest {
private static final StringEncoder ENCODER = new StringEncoder("%",
Arrays.asList("\n")); //$NON-NLS-1$
private static final Logger LOGGER = Logger
.getLogger(SocketConsoleApplicationTest.class.getName());
@Test
public void integrationTest() {
Thread server = TestServer.startServer(false);
Thread server;
try {
Thread.sleep(100);
server = TestServer.startServer("bye");
} catch (IOException e3) {
assertNull(e3);
fail("unable to start server");
}
try {
Thread.sleep(1000);
} catch (InterruptedException e1) {
e1.printStackTrace();
}
@@ -70,27 +79,104 @@ public class SocketConsoleApplicationTest {
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 = 0;
String[] cmds = {"help", "toto", "test", "close"};
String[] cmds = {"help", "toto", "test", "bye"};
while ((fromServer = in.readLine()) != null) {
System.out.println("Server: \n" + ENCODER.decode(fromServer));
LOGGER.fine("Server: \n" + fromServer);
if (fromServer.equals("Bye.")) {
break;
}
while (fromServer != null && !fromServer.equals("> ")) {
fromServer = in.readLine();
LOGGER.fine("Server: \n" + fromServer);
}
if (fromServer == null) {
fail("Null pointer");
}
final String fromUser = cmds[i];
if (fromUser != null) {
LOGGER.fine("Client: " + fromUser);
out.println(fromUser);
}
i++;
}
assertEquals(4, i);
} catch (final IOException e) {
e.printStackTrace();
}
try (Socket kkSocket = new Socket(hostName, portNumber);
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(),
true);
BufferedReader in = new BufferedReader(
new InputStreamReader(kkSocket.getInputStream()));) {
String fromServer;
int i = 0;
String[] cmds = {"help", "toto", "test",
ConsoleTestApplication.EXIT};
while ((fromServer = in.readLine()) != null) {
LOGGER.fine("Server: \n" + fromServer);
while (fromServer != null && !fromServer.equals("> ")) {
LOGGER.fine("Server: \n" + fromServer);
fromServer = in.readLine();
}
if (fromServer == null) {
break;
}
LOGGER.fine("Server: \n" + fromServer);
final String fromUser = cmds[i];
if (fromUser != null) {
LOGGER.fine("Client: " + fromUser);
out.println(fromUser);
}
i++;
}
assertEquals(4, i);
} catch (final IOException e) {
e.printStackTrace();
}
try {
Thread.sleep(100);
} catch (InterruptedException e1) {
e1.printStackTrace();
}
try (Socket kkSocket = new Socket(hostName, portNumber);
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(),
true);
BufferedReader in = new BufferedReader(
new InputStreamReader(kkSocket.getInputStream()));) {
String fromServer;
int i = 0;
String[] cmds = {"help", "toto", "test",
ConsoleTestApplication.EXIT};
while ((fromServer = in.readLine()) != null) {
while (fromServer != null && !fromServer.equals("> ")) {
fromServer = in.readLine();
LOGGER.fine("Server: \n" + fromServer);
}
if (fromServer == null) {
break;
}
final String fromUser = cmds[i];
if (fromUser != null) {
System.out.println("Client: " + fromUser);
LOGGER.fine("Client: " + fromUser);
out.println(fromUser);
}
i++;
}
assertEquals(4, i);
} catch (final IOException e) {
e.printStackTrace();
}
@@ -100,7 +186,11 @@ public class SocketConsoleApplicationTest {
} catch (InterruptedException e2) {
e2.printStackTrace();
}
server = TestServer.startServer(true);
try {
server = TestServer.startServer(true);
} catch (IOException e2) {
assertNull(e2);
}
try {
Thread.sleep(100);
} catch (InterruptedException e1) {
@@ -108,31 +198,49 @@ 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;
String[] cmds = {"help", "test", "close"};
while ((fromServer = in.readLine()) != null) {
// System.out.println("Server: \n" + ENCODER.decode(fromServer));
if (fromServer.equals("Bye.")) {
assertTrue(i < 1);
while (fromServer != null && !fromServer.equals("> ") &&
!fromServer.equals("See you")) {
fromServer = in.readLine();
LOGGER.fine("Server: \n" + fromServer);
}
if (fromServer == null || fromServer.equals("Bye.") ||
fromServer.equals("See you")) {
break;
}
final String fromUser = cmds[i];
if (fromUser != null) {
// System.out.println("Client: " + fromUser);
LOGGER.fine("Client: " + fromUser);
out.println(fromUser);
}
i++;
}
assertEquals(1, i);
} catch (final IOException e) {
e.printStackTrace();
}
Thread srv = null;
try {
srv = TestServer.getServer();
} catch (IOException e1) {
assertNull(e1);
}
TestServer.closeServer();
try {
srv.join();
} catch (InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}

View File

@@ -34,6 +34,9 @@
*/
package fr.bigeon.gclc.socket;
import java.io.IOException;
import java.nio.charset.Charset;
/** A test server
*
* @author Emmanuel Bigeon */
@@ -43,8 +46,9 @@ public class TestServer {
private static SocketConsoleApplicationShell SHELL;
private static Thread server;
/** @param args no argument */
public static void main(String... args) {
/** @param args no argument
* @throws IOException if the server starting failed */
public static void main(String... args) throws IOException {
try {
startServer(false).join();
} catch (final InterruptedException e) {
@@ -52,7 +56,7 @@ public class TestServer {
}
}
public static Thread getServer() {
public static Thread getServer() throws IOException {
if (server == null) {
server = new Thread(getShell(), "gclcServer");
server.start();
@@ -60,11 +64,10 @@ public class TestServer {
return server;
}
/** @return */
private static SocketConsoleApplicationShell getShell() {
private static SocketConsoleApplicationShell getShell() throws IOException {
if (SHELL == null) {
SHELL = new SocketConsoleApplicationShell(3300, "close",
ConsoleTestApplication.EXIT);
ConsoleTestApplication.EXIT, Charset.forName("UTF-8"));
final ConsoleTestApplication app = new ConsoleTestApplication(
SHELL.getConsoleManager());
SHELL.setApplication(app);
@@ -72,10 +75,22 @@ public class TestServer {
return SHELL;
}
public static Thread startServer(boolean autoClose) {
public static Thread startServer(boolean autoClose) throws IOException {
if (SHELL == null) {
SHELL = new SocketConsoleApplicationShell(3300, autoClose,
ConsoleTestApplication.EXIT);
ConsoleTestApplication.EXIT, Charset.forName("UTF-8"));
final ConsoleTestApplication app = new ConsoleTestApplication(
SHELL.getConsoleManager());
SHELL.setApplication(app);
server = null;
}
return getServer();
}
public static Thread startServer(String closeConnection) throws IOException {
if (SHELL == null) {
SHELL = new SocketConsoleApplicationShell(3300, closeConnection,
ConsoleTestApplication.EXIT, Charset.forName("UTF-8"));
final ConsoleTestApplication app = new ConsoleTestApplication(
SHELL.getConsoleManager());
SHELL.setApplication(app);

View File

@@ -32,12 +32,10 @@
<!-- The fact that you are presently reading this means that you have had -->
<!-- knowledge of the CeCILL license and that you accept its terms. -->
<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"
>
<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-swt</artifactId>
<version>1.0.5-SNAPSHOT</version>
<version>1.1.2</version>
<packaging>jar</packaging>
<url>http://www.bigeon.fr/emmanuel</url>
<properties>
@@ -47,13 +45,13 @@
<parent>
<groupId>fr.bigeon</groupId>
<artifactId>ebigeon-config</artifactId>
<version>1.7.0</version>
<version>1.7.1</version>
</parent>
<dependencies>
<dependency>
<groupId>fr.bigeon</groupId>
<artifactId>gclc</artifactId>
<version>1.2.3</version>
<version>1.3.2</version>
</dependency>
<dependency>
<groupId>fr.bigeon</groupId>
@@ -66,7 +64,7 @@
<description>provide a swt window for console applications</description>
<scm>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<tag>HEAD</tag>
<tag>gclc-swt-1.1.2</tag>
</scm>
<profiles>
<profile>

View File

@@ -0,0 +1,57 @@
/*
* Copyright E. Bigeon (2015)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a swt window for console applications.
*
* 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.
*/
/**
* gclc-swt:fr.bigeon.gclc.swt.ConsoleDelayIO.java
* Created on: Nov 19, 2016
*/
package fr.bigeon.gclc.swt;
/** This class represents an object used to send commands to a console
* application.
* <p>
* The sending of command is done in two phases. Define the input through get
* and set, and then validate the input.
*
* @author Emmanuel Bigeon */
public interface ConsoleDelayIO {
/** Actually send the input as the prompt next input. */
void validateInput();
/** @param input the input to set */
void setInput(String input);
/** @return the non validated input */
String getInput();
}

View File

@@ -41,7 +41,6 @@ package fr.bigeon.gclc.swt;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.KeyAdapter;
import org.eclipse.swt.events.KeyEvent;
import org.eclipse.swt.widgets.Text;
import fr.bigeon.collections.ArrayRibbon;
import fr.bigeon.collections.Ribbon;
@@ -53,21 +52,19 @@ public final class HistoryTextKeyListener extends KeyAdapter {
/** The size of commands history */
private static final int DEFAULT_HISTORY_SIZE = 10;
/** The empty string constant */
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;
/** The console to write the commands in */
private final Text consoleInput;
/** The console to notify of command validation */
private final SWTConsole console;
private final ConsoleDelayIO console;
/** @param console the console
* @param consoleInput the text to write commands in */
public HistoryTextKeyListener(SWTConsole console, Text consoleInput) {
/** @param console the console delayed */
public HistoryTextKeyListener(ConsoleDelayIO console) {
super();
this.console = console;
this.consoleInput = consoleInput;
this.commands = new ArrayRibbon<>(DEFAULT_HISTORY_SIZE);
}
@@ -77,11 +74,14 @@ public final class HistoryTextKeyListener extends KeyAdapter {
pressedKeyCode(e.keyCode);
}
/** @param keyCode */
/** @param keyCode the pressed key code */
public void pressedKeyCode(int keyCode) {
// Enter validates the command if prompting
if (keyCode == '\r') {
commands.add(consoleInput.getText());
String input = console.getInput();
if (!input.isEmpty()) {
commands.add(input);
}
console.validateInput();
currentIndex = -1;
}
@@ -91,20 +91,18 @@ public final class HistoryTextKeyListener extends KeyAdapter {
currentIndex < commands.size() - 1) {
currentIndex++;
String cmd = commands.get(commands.size() - currentIndex - 1);
consoleInput.setText(cmd);
consoleInput.setSelection(cmd.length());
console.setInput(cmd);
}
// Lower arrow retrieves next commands
if (keyCode == SWT.ARROW_DOWN) {
if (currentIndex == 0) {
currentIndex--;
consoleInput.setText(new String());
console.setInput(EMPTY);
} else if (currentIndex > 0) {
String cmd = commands
.get(commands.size() - (--currentIndex) - 1);
consoleInput.setText(cmd);
consoleInput.setSelection(cmd.length());
console.setInput(cmd);
}
}
}

View File

@@ -59,7 +59,8 @@ import fr.bigeon.gclc.manager.ConsoleManager;
* <p>
*
* @author Emmanuel Bigeon */
public class SWTConsole extends Composite implements ConsoleManager {
public class SWTConsole extends Composite
implements ConsoleDelayIO, ConsoleManager {
/**
*
*/
@@ -69,6 +70,8 @@ public class SWTConsole extends Composite implements ConsoleManager {
/** The class logger */
private static final Logger LOGGER = Logger
.getLogger(SWTConsole.class.getName());
/** The empty string constant */
private static final String EMPTY = ""; //$NON-NLS-1$
/** The console output text field */
private final Text consoleOutput;
/** The console input text field */
@@ -112,15 +115,15 @@ public class SWTConsole extends Composite implements ConsoleManager {
consoleInput = new Text(this, SWT.BORDER);
consoleInput.setLayoutData(
new GridData(SWT.FILL, SWT.CENTER, true, false, 1, 1));
consoleInput
.addKeyListener(new HistoryTextKeyListener(this, consoleInput));
consoleInput.addKeyListener(new HistoryTextKeyListener(this));
}
/**
*
*/
protected void validateInput() {
@Override
public void validateInput() {
Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
@@ -143,7 +146,7 @@ public class SWTConsole extends Composite implements ConsoleManager {
public void run() {
command = consoleInput.getText();
prompting = false;
consoleInput.setText(new String());
consoleInput.setText(EMPTY);
consoleOutput.append(
CMD_PREFIX + command + System.lineSeparator());
}
@@ -172,7 +175,9 @@ public class SWTConsole extends Composite implements ConsoleManager {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
consoleOutput.append(text);
if (!consoleOutput.isDisposed()) {
consoleOutput.append(text);
}
}
});
}
@@ -185,7 +190,9 @@ public class SWTConsole extends Composite implements ConsoleManager {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
consoleOutput.append(System.lineSeparator());
if (!consoleOutput.isDisposed()) {
consoleOutput.append(System.lineSeparator());
}
}
});
}
@@ -198,7 +205,9 @@ public class SWTConsole extends Composite implements ConsoleManager {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
consoleOutput.append(message + System.lineSeparator());
if (!consoleOutput.isDisposed()) {
consoleOutput.append(message + System.lineSeparator());
}
}
});
@@ -217,14 +226,18 @@ public class SWTConsole extends Composite implements ConsoleManager {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
consoleInput.setEnabled(true);
consoleInput.setFocus();
if (!consoleInput.isDisposed()) {
consoleInput.setEnabled(true);
consoleInput.setFocus();
}
}
});
prompting = true;
promptLock.notifyAll();
promptLock.wait();
} catch (final InterruptedException e) {
LOGGER.log(Level.WARNING,
"Error in synchronization of prompting", e); //$NON-NLS-1$
command = null;
}
}
@@ -247,11 +260,13 @@ public class SWTConsole extends Composite implements ConsoleManager {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
lblPromptlabel.setText(message);
// relayout
SWTConsole.this.layout();
consoleInput.setEnabled(true);
consoleInput.setFocus();
if (!consoleOutput.isDisposed()) {
lblPromptlabel.setText(message);
// relayout
SWTConsole.this.layout();
consoleInput.setEnabled(true);
consoleInput.setFocus();
}
}
});
prompting = true;
@@ -260,15 +275,19 @@ public class SWTConsole extends Composite implements ConsoleManager {
throw new IOException();
}
} catch (final InterruptedException e) {
LOGGER.log(Level.WARNING,
"Error in synchronization of prompting", e); //$NON-NLS-1$
command = null;
} finally {
Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
lblPromptlabel.setText(prompt);
// relayout
SWTConsole.this.layout();
if (!consoleOutput.isDisposed()) {
lblPromptlabel.setText(prompt);
// relayout
SWTConsole.this.layout();
}
}
});
}
@@ -292,9 +311,11 @@ public class SWTConsole extends Composite implements ConsoleManager {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
lblPromptlabel.setText(prompt);
// relayout
SWTConsole.this.layout();
if (!consoleOutput.isDisposed()) {
lblPromptlabel.setText(prompt);
// relayout
SWTConsole.this.layout();
}
}
});
}
@@ -332,4 +353,28 @@ public class SWTConsole extends Composite implements ConsoleManager {
validateInput();
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.swt.ConsoleDelayIO#setInput(java.lang.String) */
@Override
public void setInput(String input) {
consoleInput.setText(input);
consoleInput.setSelection(input.length());
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.swt.ConsoleDelayIO#getInput() */
@Override
public String getInput() {
return consoleInput.getText();
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#interruptPrompt() */
@Override
public void interruptPrompt() {
synchronized (promptLock) {
promptLock.notify();
}
}
}

View File

@@ -0,0 +1,197 @@
/*
* Copyright E. Bigeon (2015)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a swt window for console applications.
*
* 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.
*/
/**
* gclc-swt:fr.bigeon.gclc.swt.SWTConsole.java
* Created on: Apr 18, 2015
*/
package fr.bigeon.gclc.swt;
import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.FocusAdapter;
import org.eclipse.swt.events.FocusEvent;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Text;
import fr.bigeon.gclc.ConsoleApplication;
import fr.bigeon.gclc.manager.PipedConsoleManager;
import fr.bigeon.gclc.tools.AOutputForwardRunnable;
/** A SWT component to connect to gclc {@link ConsoleApplication}
* <p>
*
* @author Emmanuel Bigeon */
public class SWTConsoleView extends Composite implements ConsoleDelayIO {
/** The local implementation of the forwarding runnable
*
* @author Emmanuel Bigeon */
private final class ToSWTConsoleForwardRunnable
extends AOutputForwardRunnable {
/** The running status */
private boolean running = true;
/** @param manager the manager */
public ToSWTConsoleForwardRunnable(PipedConsoleManager manager) {
super(manager);
}
@Override
protected void forwardLine(String m) {
appendConsoleOutput(m);
}
@Override
protected boolean isRunning() {
return running && !isDisposed();
}
/** @param running the running to set */
public void setRunning(boolean running) {
this.running = running;
}
}
/** The class logger */
private static final Logger LOGGER = Logger
.getLogger(SWTConsoleView.class.getName());
/** The console output text field */
private final Text consoleOutput;
/** The console input text field */
private final Text consoleInput;
/** The actual manager */
private PipedConsoleManager manager;
/** The forwarding runnable */
private ToSWTConsoleForwardRunnable forward;
/** Create the composite.
*
* @param parent the prent composite
* @param style the composite style */
public SWTConsoleView(Composite parent, int style) {
super(parent, style);
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.setRedraw(true);
consoleOutput.addFocusListener(new FocusAdapter() {
@SuppressWarnings("synthetic-access")
@Override
public void focusGained(FocusEvent e) {
consoleInput.setFocus();
}
});
consoleInput = new Text(this, SWT.BORDER);
consoleInput.setLayoutData(
new GridData(SWT.FILL, SWT.CENTER, true, false, 1, 1));
consoleInput.addKeyListener(new HistoryTextKeyListener(this));
}
/** @param manager the manager to set */
public void setManager(PipedConsoleManager manager) {
this.manager = manager;
if (forward != null) {
forward.setRunning(false);
}
forward = new ToSWTConsoleForwardRunnable(manager);
Thread th = new Thread(forward, "gclcToSWT"); //$NON-NLS-1$
th.start();
}
/** @param next the next message */
protected void appendConsoleOutput(final String next) {
Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
consoleOutput.append(System.lineSeparator() + next);
}
});
}
/**
*
*/
@Override
public void validateInput() {
try {
manager.type(getInput());
} catch (IOException e) {
LOGGER.log(Level.SEVERE, "Unable to input value to console", e); //$NON-NLS-1$
}
}
@Override
protected void checkSubclass() {
// Disable the check that prevents subclassing of SWT components
}
/* (non-Javadoc)
* @see org.eclipse.swt.widgets.Composite#setFocus() */
@Override
public boolean setFocus() {
return consoleInput.setFocus();
}
/** @param string the text */
public void setText(String string) {
consoleInput.setText(string);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.swt.ConsoleDelayIO#setInput(java.lang.String) */
@Override
public void setInput(String input) {
consoleInput.setText(input);
consoleInput.setSelection(input.length());
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.swt.ConsoleDelayIO#getInput() */
@Override
public String getInput() {
return consoleInput.getText();
}
}

View File

@@ -34,24 +34,78 @@
*/
/**
* gclc-swt:fr.bigeon.gclc.swt.HistoryTextKeyListenerTest.java
* Created on: Jun 9, 2016
* Created on: Nov 19, 2016
*/
package fr.bigeon.gclc.swt;
import static org.junit.Assert.assertEquals;
import org.eclipse.swt.SWT;
import org.junit.Test;
/**
* <p>
/** <p>
* TODO
*
* @author Emmanuel Bigeon
*
*/
* @author Emmanuel Bigeon */
public class HistoryTextKeyListenerTest {
/** Test method for
* {@link fr.bigeon.gclc.swt.HistoryTextKeyListener#keyPressed(org.eclipse.swt.events.KeyEvent)}. */
@Test
public void test() {
public final void testKeyPressedKeyEvent() {
ConsoleDelayIO io = new ConsoleDelayIO() {
private String input = "";
@Override
public void validateInput() {
input = "";
}
@Override
public void setInput(String input) {
this.input = input;
}
@Override
public String getInput() {
return input;
}
};
HistoryTextKeyListener listener = new HistoryTextKeyListener(io);
// no effects
assertEquals("", io.getInput());
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("", io.getInput());
listener.pressedKeyCode(SWT.ARROW_DOWN);
assertEquals("", io.getInput());
listener.pressedKeyCode('\r');
assertEquals("", io.getInput());
io.setInput("cmd arg");
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("cmd arg", io.getInput());
listener.pressedKeyCode(SWT.ARROW_DOWN);
assertEquals("cmd arg", io.getInput());
listener.pressedKeyCode('\r');
assertEquals("", io.getInput());
io.setInput("cmd arg2");
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("cmd arg", io.getInput());
listener.pressedKeyCode(SWT.ARROW_DOWN);
assertEquals("", io.getInput());
io.setInput("cmd arg2");
listener.pressedKeyCode('\r');
assertEquals("", io.getInput());
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("cmd arg2", io.getInput());
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("cmd arg", io.getInput());
listener.pressedKeyCode(SWT.ARROW_UP);
assertEquals("cmd arg", io.getInput());
listener.pressedKeyCode(SWT.ARROW_DOWN);
assertEquals("cmd arg2", io.getInput());
}
}

View File

@@ -39,7 +39,9 @@
package fr.bigeon.gclc.swt;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.io.IOException;
@@ -48,6 +50,7 @@ import org.junit.Test;
import fr.bigeon.gclc.ConsoleApplication;
import fr.bigeon.gclc.command.Command;
import fr.bigeon.gclc.command.ExitCommand;
import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.InvalidCommandName;
@@ -55,10 +58,11 @@ import fr.bigeon.gclc.exception.InvalidCommandName;
* TODO
*
* @author Emmanuel Bigeon */
@SuppressWarnings({"javadoc", "static-method", "nls", "deprecation"})
public class SWTConsoleShellTest {
protected static final long TWO_SECONDS = 2000;
private static final Display DISPLAY = new Display();
private static final Display DISPLAY = Display.getDefault();
@Test
public void testConsoleClose() {
@@ -68,7 +72,8 @@ public class SWTConsoleShellTest {
swtConsole.setPrompt(":");
try {
final ConsoleApplication appl = new ConsoleApplication(swtConsole,
"exit", "Hello", "See you");
"Hello", "See you");
appl.add(new ExitCommand("exit", appl));
appl.add(new Command("long") {
@Override
@@ -168,6 +173,7 @@ public class SWTConsoleShellTest {
shell.dispose();
}
});
}
});
applThread.start();
@@ -177,6 +183,13 @@ public class SWTConsoleShellTest {
DISPLAY.sleep();
}
}
swtConsole.setPrompt(">");
try {
swtConsole.prompt();
fail("Prompting when closed should fail!");
} catch (IOException e) {
assertNotNull(e);
}
// DISPLAY.dispose();
assertTrue(appl.getManager().isClosed());
Thread.sleep(TWO_SECONDS);
@@ -196,7 +209,8 @@ public class SWTConsoleShellTest {
final SWTConsole swtConsole = (SWTConsole) shell.getManager();
try {
final ConsoleApplication appl = new ConsoleApplication(swtConsole,
"exit", "Hello", "See you");
"Hello", "See you");
appl.add(new ExitCommand("exit", appl));
appl.add(new Command("long") {
@Override

View File

@@ -0,0 +1,152 @@
/*
* Copyright E. Bigeon (2015)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a swt window for console applications.
*
* 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.
*/
/**
* gclc-swt:fr.bigeon.gclc.swt.SWTConsoleShellTest.java
* Created on: Jun 8, 2016
*/
package fr.bigeon.gclc.swt;
import static org.junit.Assert.assertNull;
import java.io.IOException;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell;
import org.junit.Test;
import fr.bigeon.gclc.ConsoleApplication;
import fr.bigeon.gclc.command.Command;
import fr.bigeon.gclc.command.ExitCommand;
import fr.bigeon.gclc.exception.InvalidCommandName;
import fr.bigeon.gclc.manager.PipedConsoleManager;
/** <p>
* TODO
*
* @author Emmanuel Bigeon */
@SuppressWarnings({"javadoc", "static-method", "nls", "deprecation"})
public class SWTConsoleViewTest {
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 (PipedConsoleManager manager = new PipedConsoleManager()) {
swtConsole.setManager(manager);
} catch (IOException e2) {
assertNull(e2);
}
try (PipedConsoleManager manager = new PipedConsoleManager()) {
swtConsole.setManager(manager);
final ConsoleApplication appl = new ConsoleApplication(manager,
"Hello", "See you");
appl.add(new ExitCommand("exit", appl));
appl.add(new Command("long") {
@Override
public String tip() {
return "a long running command";
}
@Override
public void execute(String... args) {
try {
Thread.sleep(TWO_SECONDS);
} catch (InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
});
// shell.pack();
shell.open();
Thread applThread = new Thread(new Runnable() {
@Override
public void run() {
appl.start();
}
});
Thread testThread = new Thread(new Runnable() {
@Override
public void run() {
try {
Thread.sleep(TWO_SECONDS);
} catch (InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
Display.getDefault().syncExec(new Runnable() {
@Override
public void run() {
swtConsole.setText("test"); //$NON-NLS-1$
swtConsole.validateInput();
}
});
try {
Thread.sleep(TWO_SECONDS);
} catch (InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
Display.getDefault().syncExec(new Runnable() {
@Override
public void run() {
shell.dispose();
}
});
}
});
applThread.start();
testThread.start();
while (!shell.isDisposed()) {
if (!DISPLAY.readAndDispatch()) {
DISPLAY.sleep();
}
}
} catch (InvalidCommandName e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (IOException e1) {
// TODO Auto-generated catch block
e1.printStackTrace();
}
}
}

4
gclc.system/.gitignore vendored Normal file
View File

@@ -0,0 +1,4 @@
/target/
/.classpath
/.project
/.settings/

41
gclc.system/pom.xml Normal file
View File

@@ -0,0 +1,41 @@
<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>
<groupId>net.bigeon</groupId>
<artifactId>gclc.system</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<url>http://www.bigeon.net</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<build>
<plugins>
</plugins>
</build>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.11</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>fr.bigeon</groupId>
<artifactId>gclc</artifactId>
<version>1.3.1</version>
</dependency>
</dependencies>
<name>GCLC system command</name>
<description>Provide an exec command to execute system commands</description>
<inceptionYear>2016</inceptionYear>
<scm>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<tag>HEAD</tag>
</scm>
<parent>
<groupId>fr.bigeon</groupId>
<artifactId>ebigeon-config</artifactId>
<version>1.7.1</version>
</parent>
</project>

View File

@@ -0,0 +1,149 @@
/**
* gclc.system:net.bigeon.gclc.system.ExecSystemCommand.java
* Created on: Jun 20, 2016
*/
package net.bigeon.gclc.system;
import java.io.BufferedWriter;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.util.logging.Level;
import java.util.logging.Logger;
import fr.bigeon.gclc.command.Command;
import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.CommandRunExceptionType;
import fr.bigeon.gclc.manager.ConsoleManager;
/** A command that will execute a system command.
*
* @author Emmanuel Bigeon */
public class ExecSystemCommand extends Command {
/** The command default name */
private static final String COMMAND_DEFAULT_NAME = "exec"; //$NON-NLS-1$
/** The end of line separator */
private static final String EOL = System.lineSeparator();
/** The class logger */
private static final Logger LOGGER = Logger
.getLogger(ExecSystemCommand.class.getName());
/** The manager for the application's user interface */
private final ConsoleManager manager;
/** @param name the name of the command (the input from the manager that
* should trigger this command)
* @param manager the console manager for input and outputs */
public ExecSystemCommand(String name, ConsoleManager manager) {
super(name);
this.manager = manager;
}
/** @param manager the console manager for input and outputs */
public ExecSystemCommand(ConsoleManager manager) {
super(COMMAND_DEFAULT_NAME);
this.manager = manager;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(java.lang.String[]) */
@SuppressWarnings("resource")
@Override
public void execute(String... args) throws CommandRunException {
Process proc;
try {
proc = Runtime.getRuntime().exec(args);
} catch (IOException e2) {
LOGGER.log(Level.SEVERE, "Unable to run process", e2); //$NON-NLS-1$
return;
}
final InputStream is = proc
.getInputStream();
Thread th = new Thread(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
try {
readToEnd(is);
is.close();
} catch (CommandRunException e) {
LOGGER.log(Level.WARNING,
"Manager was closed in the meantime...", e); //$NON-NLS-1$
} catch (IOException e) {
LOGGER.log(Level.WARNING, "Input stream was closed...", e); //$NON-NLS-1$
}
}
});
th.start();
manager.setPrompt(""); //$NON-NLS-1$
final OutputStream os = proc.getOutputStream();
try (BufferedWriter writer = new BufferedWriter(
new OutputStreamWriter(os))) {
while (th.isAlive()) {
String user;
try {
user = manager.prompt();
} catch (IOException e) {
throw new CommandRunException(
CommandRunExceptionType.INTERACTION,
"manager was closed", e, this); //$NON-NLS-1$
}
writer.write(user + EOL);
}
} catch (IOException e1) {
throw new CommandRunException(CommandRunExceptionType.INTERACTION,
"manager was closed", e1, this); //$NON-NLS-1$
}
}
/** @param is the input stream
* @throws CommandRunException if the manager was closed while writing the
* stream */
protected void readToEnd(InputStream is) throws CommandRunException {
int c;
try {
while ((c = is.read()) != -1) {
try {
manager.print(Character.valueOf((char) c).toString());
} catch (IOException e) {
throw new CommandRunException(
CommandRunExceptionType.INTERACTION,
"manager was closed", e, this); //$NON-NLS-1$
}
}
} catch (IOException e) {
LOGGER.log(Level.INFO, "input stream reading failed", e); //$NON-NLS-1$
}
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@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();
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usagePattern() */
@Override
protected String usagePattern() {
return " CMD <system command>"; //$NON-NLS-1$
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@Override
public String tip() {
return "Execute a system command"; //$NON-NLS-1$
}
}

View File

@@ -1,3 +1,11 @@
## Version 1.2.6
* in script command failure report improved
### Bug fixes
* command line reading now succeed to parse last argument if it is a string
## Version 1.1.0
* Parsing quoted string as one argument

View File

@@ -35,7 +35,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>1.2.4</version>
<version>1.3.3-SNAPSHOT</version>
<packaging>jar</packaging>
<url>http://www.bigeon.fr/emmanuel</url>
<properties>
@@ -83,6 +83,6 @@
<scm>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<tag>gclc-1.2.4</tag>
<tag>HEAD</tag>
</scm>
</project>

View File

@@ -37,14 +37,13 @@
package fr.bigeon.gclc;
import java.io.IOException;
import java.io.InterruptedIOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
import fr.bigeon.gclc.command.ExitCommand;
import fr.bigeon.gclc.command.HelpExecutor;
import fr.bigeon.gclc.command.ICommand;
import fr.bigeon.gclc.command.ICommandProvider;
import fr.bigeon.gclc.command.SubedCommand;
@@ -54,7 +53,6 @@ import fr.bigeon.gclc.exception.CommandRunExceptionType;
import fr.bigeon.gclc.exception.InvalidCommandName;
import fr.bigeon.gclc.i18n.Messages;
import fr.bigeon.gclc.manager.ConsoleManager;
import fr.bigeon.gclc.manager.SystemConsoleManager;
/** <p>
* A {@link ConsoleApplication} is an application that require the user to input
@@ -63,7 +61,8 @@ import fr.bigeon.gclc.manager.SystemConsoleManager;
* A typical use case is the following:
*
* <pre>
* {@link ConsoleApplication} app = new {@link ConsoleApplication#ConsoleApplication(String, String, String) ConsoleApplication("exit", "welcome", "see you latter")};
* {@link ConsoleManager} manager = new {@link fr.bigeon.gclc.manager.SystemConsoleManager#SystemConsoleManager()}
* {@link ConsoleApplication} app = new {@link ConsoleApplication#ConsoleApplication(ConsoleManager, String, String) ConsoleApplication(manager, "welcome", "see you latter")};
* app.{@link ConsoleApplication#add(ICommand) add}("my_command", new {@link ICommand MyCommand()});
* app.{@link ConsoleApplication#start start}();
* </pre>
@@ -100,38 +99,7 @@ public class ConsoleApplication implements ICommandProvider {
this.header = welcome;
this.footer = goodbye;
this.manager = manager;
root = new SubedCommand(new String());
}
/** @param manager the manager
* @param exit the keyword for the exit command of this application
* @param welcome the header message to display on launch of this
* application
* @param goodbye the message to display on exit
* @throws InvalidCommandName if the exit command name is invalid
* @deprecated since 1.2.0, use the {@link #add(ICommand)} method to add the
* exit command */
@Deprecated
public ConsoleApplication(ConsoleManager manager, String exit,
String welcome, String goodbye) throws InvalidCommandName {
this(manager, welcome, goodbye);
root.add(new ExitCommand(exit, this));
}
/** @param exit the keyword for the exit command of this application
* @param welcome the header message to display on launch of this
* application
* @param goodbye the message to display on exit
* @throws InvalidCommandName if the exit command name is invalid
* @deprecated since 1.2.0, use the {@link #add(ICommand)} method to add the
* command and create this console using the
* {@link #ConsoleApplication(ConsoleManager, String, String)}
* method with a {@link SystemConsoleManager} as argument */
@Deprecated
public ConsoleApplication(String exit, String welcome,
String goodbye) throws InvalidCommandName {
this(new SystemConsoleManager(), welcome, goodbye);
root.add(new ExitCommand(exit, this));
root = new SubedCommand(""); //$NON-NLS-1$
}
@Override
@@ -139,30 +107,13 @@ public class ConsoleApplication implements ICommandProvider {
return root.add(cmd);
}
/** Adds help command on the given key
*
* @param cmd the handle for help
* @return if the help command was added
* @throws InvalidCommandName if the help command was not valid
* @deprecated since 1.2.0 use the {@link #add(ICommand)} with a
* {@link HelpExecutor} instead */
@Deprecated
public final boolean addHelpCommand(String cmd) throws InvalidCommandName {
return root.add(new HelpExecutor(cmd, manager, root));
}
/** Add a command request listener.
* <p>
* A listener can listen several times to the same application.
*
* @param listener the listener to add. */
/** @param listener the command listener */
public final void addListener(CommandRequestListener listener) {
listeners.add(listener);
}
/* (non-Javadoc)
* @see
* fr.bigeon.gclc.command.ICommandProvider#executeSub(java.lang.String,
* @see fr.bigeon.gclc.command.ICommandProvider#executeSub(java.lang.String,
* java.lang.String[]) */
@Override
public final void executeSub(String command,
@@ -170,10 +121,11 @@ public class ConsoleApplication implements ICommandProvider {
root.executeSub(command, args);
}
/** Exit this running application before next command prompt */
/** Signify to the application that no command should be inputed anymore */
public final void exit() {
LOGGER.fine("Request exiting application..."); //$NON-NLS-1$
running = false;
manager.interruptPrompt();
}
/* (non-Javadoc)
@@ -188,8 +140,8 @@ public class ConsoleApplication implements ICommandProvider {
return manager;
}
/** @param cmd the command to interpret
* @throws IOException if the manager was closed */
/** @param cmd the command
* @throws IOException if the command could not be parsed */
public final void interpretCommand(String cmd) throws IOException {
List<String> args;
try {
@@ -215,7 +167,7 @@ public class ConsoleApplication implements ICommandProvider {
}
}
/** @param listener the listener to remove (once) */
/** @param listener the command listener to remove */
public final void removeListener(CommandRequestListener listener) {
for (int i = 0; i < listeners.size(); i++) {
if (listeners.get(i) == listener) {
@@ -225,27 +177,57 @@ public class ConsoleApplication implements ICommandProvider {
}
}
/** Launches the prompting application */
/** Start the application */
public final void start() {
try {
running = true;
if (header != null) {
manager.println(header);
}
do {
final String cmd = manager.prompt();
if (cmd == null || cmd.isEmpty()) {
continue;
}
for (final CommandRequestListener listener : listeners) {
listener.commandRequest(cmd);
}
interpretCommand(cmd);
} while (running);
if (footer != null) {
} catch (IOException e) {
// The manager was closed
running = false;
LOGGER.log(Level.WARNING,
"The console manager was closed. Closing the application as no one can reach it.", //$NON-NLS-1$
e);
return;
}
do {
runLoop();
} while (running);
if (footer != null) {
try {
manager.println(footer);
} catch (IOException e) {
// The manager was closed
running = false;
LOGGER.log(Level.WARNING,
"The console manager was closed.", //$NON-NLS-1$
e);
}
LOGGER.fine("Exiting application."); //$NON-NLS-1$
}
running = false;
LOGGER.fine("Exiting application."); //$NON-NLS-1$
}
/** The running loop content.
* <p>
* This consisting in getting the command, executing it and exiting
* (restarting the loop). */
private void runLoop() {
try {
final String cmd = manager.prompt();
if (cmd == null || cmd.isEmpty()) {
return;
}
for (final CommandRequestListener listener : listeners) {
listener.commandRequest(cmd);
}
interpretCommand(cmd);
} catch (InterruptedIOException e) {
LOGGER.log(Level.INFO,
"Prompt interrupted. It is likely the application is closing.", //$NON-NLS-1$
e);
} catch (IOException e) {
// The manager was closed
running = false;
@@ -255,7 +237,7 @@ public class ConsoleApplication implements ICommandProvider {
}
}
/** @return if the application is running */
/** @return the running status */
public boolean isRunning() {
return running;
}
@@ -264,4 +246,14 @@ public class ConsoleApplication implements ICommandProvider {
public SubedCommand getRoot() {
return root;
}
/** @return the header */
public String getHeader() {
return header;
}
/** @return the footer */
public String getFooter() {
return footer;
}
}

View File

@@ -98,8 +98,8 @@ public class GCLCConstants {
inString = startIndex == index - 1;
}
}
final String arg = cmd.substring(startIndex, cmd.length());
if (!arg.isEmpty()) {
if (startIndex < cmd.length()) {
final String arg = cmd.substring(startIndex, cmd.length());
args.add(arg);
}
return args;

View File

@@ -69,6 +69,8 @@ public abstract class Command implements ICommand {
*
*/
private static final String EOL_LINUX = "\n"; //$NON-NLS-1$
/** The empty string constant */
private static final String EMPTY = ""; //$NON-NLS-1$
/** The name of the command */
protected final String name;
@@ -119,7 +121,7 @@ public abstract class Command implements ICommand {
* @return the detailed help (should end with end of line or be empty) */
@SuppressWarnings("static-method")
protected String usageDetail() {
return new String();
return EMPTY;
}
/** <p>

View File

@@ -56,9 +56,9 @@ public class CommandParameters {
*/
private static final int STRINGARG_NUMBER_OF_ELEMENTS = 2;
/** Boolean arguments */
private final Map<String, Boolean> boolArgs = new HashMap<>();
private final Map<String, Boolean> booleanArguments = new HashMap<>();
/** String arguments */
private final Map<String, String> stringArgs = new HashMap<>();
private final Map<String, String> stringArguments = new HashMap<>();
/** Arguments restriction on the named ones */
private final boolean strict;
/** additional (unnamed) parameters */
@@ -71,10 +71,10 @@ public class CommandParameters {
public CommandParameters(Set<String> bools, Set<String> strings,
boolean strict) {
for (final String string : bools) {
boolArgs.put(string, false);
booleanArguments.put(string, false);
}
for (final String string : strings) {
stringArgs.put(string, null);
stringArguments.put(string, null);
}
this.strict = strict;
}
@@ -82,7 +82,7 @@ public class CommandParameters {
/** @param key the key
* @return the associated value, null if it was not specified */
public String get(String key) {
return stringArgs.get(key);
return stringArguments.get(key);
}
/** @return additional non parsed parameters */
@@ -92,9 +92,9 @@ public class CommandParameters {
/** @param key the key
* @return if the key was specified */
@SuppressWarnings("boxing")
public boolean getBool(String key) {
return boolArgs.get(key);
return booleanArguments.containsKey(key) &&
booleanArguments.get(key).booleanValue();
}
/** @param args the arguments to parse
@@ -129,11 +129,11 @@ public class CommandParameters {
return 1;
}
String name = arg.substring(1);
if (boolArgs.containsKey(name)) {
boolArgs.put(name, Boolean.TRUE);
if (booleanArguments.containsKey(name)) {
booleanArguments.put(name, Boolean.TRUE);
return 1;
}
if (stringArgs.containsKey(name)) {
if (stringArguments.containsKey(name)) {
return parseStringArg(name, next);
}
if (strict) {
@@ -152,7 +152,7 @@ public class CommandParameters {
if (next == null) {
return 0;
}
stringArgs.put(name, next);
stringArguments.put(name, next);
return STRINGARG_NUMBER_OF_ELEMENTS;
}
@@ -160,16 +160,26 @@ public class CommandParameters {
* @param value the value */
@SuppressWarnings("boxing")
public void set(String string, boolean value) {
if (boolArgs.containsKey(string)) {
boolArgs.put(string, value);
if (booleanArguments.containsKey(string)) {
booleanArguments.put(string, value);
}
}
/** @param string the key
* @param value the value */
public void set(String string, String value) {
if (stringArgs.containsKey(string)) {
stringArgs.put(string, value);
if (stringArguments.containsKey(string)) {
stringArguments.put(string, value);
}
}
/** @return the boolean arguments */
public Set<String> getBooleanArgumentKeys() {
return booleanArguments.keySet();
}
/** @return the boolean arguments */
public Set<String> getStringArgumentKeys() {
return stringArguments.keySet();
}
}

View File

@@ -36,8 +36,8 @@
* Created on: Aug 6, 2014 */
package fr.bigeon.gclc.command;
import java.util.HashSet;
import java.util.Set;
import java.util.ArrayList;
import java.util.List;
import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.InvalidCommandName;
@@ -53,12 +53,12 @@ public class CommandProvider implements ICommandProvider {
/** The space character */
private static final String SPACE = " "; //$NON-NLS-1$
/** The commands map */
protected final Set<ICommand> commands;
protected final List<ICommand> commands;
/** Create a command provider */
public CommandProvider() {
super();
commands = new HashSet<>();
commands = new ArrayList<>();
}
/* (non-Javadoc)
@@ -67,12 +67,28 @@ public class CommandProvider implements ICommandProvider {
@Override
public boolean add(ICommand value) throws InvalidCommandName {
final String name = value.getCommandName();
if (name == null || name.startsWith(MINUS) || name.contains(SPACE)) {
throw new InvalidCommandName();
testCommandName(name);
if (commands.contains(value)) {
return true;
}
for (ICommand iCommand : commands) {
if (iCommand.getCommandName().equals(value.getCommandName())) {
throw new InvalidCommandName(
"Name already used: " + value.getCommandName()); //$NON-NLS-1$
}
}
return commands.add(value);
}
/** @param name the command name
* @throws InvalidCommandName if the name is invalid */
private static void testCommandName(String name) throws InvalidCommandName {
if (name == null || name.isEmpty() || name.startsWith(MINUS) ||
name.contains(SPACE)) {
throw new InvalidCommandName();
}
}
@Override
public void executeSub(String cmd,
String... args) throws CommandRunException {

View File

@@ -87,14 +87,20 @@ public class HelpExecutor extends Command {
* @see fr.bigeon.gclc.command.Command#brief() */
@Override
protected String brief() {
return " A command to get help for other commands"; //$NON-NLS-1$
if (cmd instanceof SubedCommand) {
return " A command to get help for other commands"; //$NON-NLS-1$
}
return " A command to retrieve help for " + cmd.getCommandName(); //$NON-NLS-1$
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usagePattern() */
@Override
protected String usagePattern() {
return getCommandName() + " <otherCommand>"; //$NON-NLS-1$
if (cmd instanceof SubedCommand) {
return getCommandName() + " <otherCommand>"; //$NON-NLS-1$
}
return getCommandName();
}
/* (non-Javadoc)

View File

@@ -0,0 +1,91 @@
/*
* Copyright Bigeon Emmanuel (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
*
* 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.
*/
/**
* gclc:fr.bigeon.gclc.command.MockCommand.java
* Created on: Nov 18, 2016
*/
package fr.bigeon.gclc.command;
import java.io.IOException;
import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.manager.ConsoleManager;
/** This implement a command that does nothing.
* <p>
* This class is intended for testing purpose only.
*
* @author Emmanuel Bigeon */
public final class MockCommand implements ICommand {
/** The command name */
private final String name;
/** @param name the command name */
public MockCommand(String name) {
this.name = name;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(java.lang.String[]) */
@Override
public void execute(String... args) throws CommandRunException {
//
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@Override
public String tip() {
return null;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#getCommandName() */
@Override
public String getCommandName() {
return name;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#help(fr.bigeon.gclc.manager.
* ConsoleManager, java.lang.String[]) */
@Override
public void help(ConsoleManager manager,
String... args) throws IOException {
//
}
}

View File

@@ -40,12 +40,17 @@ package fr.bigeon.gclc.command;
import java.io.IOException;
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 fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.CommandRunExceptionType;
import fr.bigeon.gclc.exception.InvalidParameterException;
import fr.bigeon.gclc.manager.ConsoleManager;
/** <p>
@@ -61,7 +66,7 @@ public abstract class ParametrizedCommand extends Command {
/** The manager */
protected final ConsoleManager manager;
/** The boolean parameters mandatory status */
private final Map<String, Boolean> boolParams = new HashMap<>();
private final Set<String> boolParams = new HashSet<>();
/** The string parameters mandatory status */
private final Map<String, Boolean> stringParams = new HashMap<>();
/** The parameters mandatory status */
@@ -77,6 +82,11 @@ public abstract class ParametrizedCommand extends Command {
this(manager, name, true);
}
/** @param name the name */
public ParametrizedCommand(String name) {
this(null, name, true);
}
/** @param manager the manager
* @param name the name
* @param strict if the arguments are restricted to the declared ones */
@@ -88,31 +98,65 @@ public abstract class ParametrizedCommand extends Command {
this.strict = strict;
}
/** @param name the name
* @param strict if the arguments are restricted to the declared ones */
public ParametrizedCommand(String name, boolean strict) {
this(null, name, strict);
}
/** <p>
* Add a parameter to the defined parameters
*
* @param param the parameter identification
* @param stringOrBool if the parameter is a parameter with an argument
* @param needed if the parameter is required */
@SuppressWarnings("boxing")
protected void addParameter(String param, boolean stringOrBool,
boolean needed) {
* @param stringParameter if the parameter is a parameter with an argument
* @param needed if the parameter is required
* @throws InvalidParameterException if the parameter was invalid */
protected void addParameter(String param, boolean stringParameter,
boolean needed) throws InvalidParameterException {
if (params.containsKey(param)) {
checkParam(param, stringParameter, needed);
return;
}
params.put(param, needed);
if (stringOrBool) {
stringParams.put(param, needed);
if (stringParameter) {
stringParams.put(param, Boolean.valueOf(needed));
params.put(param, Boolean.valueOf(needed));
} else {
if (needed) {
// ERROR the boolean parameters cannot be needed
throw new InvalidParameterException(
"Boolean parameter are present by their very nature. They should not be defined as needed"); //$NON-NLS-1$
}
boolParams.put(param, needed);
boolParams.add(param);
params.put(param, Boolean.valueOf(false));
}
}
/** @param parameters the command parameters */
protected abstract void doExecute(CommandParameters parameters);
/** @param param the parameter
* @param stringParameter the string parameter type
* @param needed if the parameter is needed
* @throws InvalidParameterException if the new definition is invalid */
private void checkParam(String param, boolean stringParameter,
boolean needed) throws InvalidParameterException {
if (stringParameter) {
if (stringParams.containsKey(param)) {
Boolean need = Boolean.valueOf(
needed || stringParams.get(param).booleanValue());
stringParams.put(param, need);
params.put(param, need);
return;
}
throw new InvalidParameterException(
"Parameter is already defined as boolean"); //$NON-NLS-1$
}
if (stringParams.containsKey(param) || needed) {
throw new InvalidParameterException(
"Parameter is already defined as string"); //$NON-NLS-1$
}
}
/** @param parameters the command parameters
* @throws CommandRunException if the command failed */
protected abstract void doExecute(CommandParameters parameters) throws CommandRunException;
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#execute(java.lang.String[]) */
@@ -120,19 +164,22 @@ public abstract class ParametrizedCommand extends Command {
@Override
public final void execute(String... args) throws CommandRunException {
final CommandParameters parameters = new CommandParameters(
boolParams.keySet(), stringParams.keySet(), strict);
boolParams, stringParams.keySet(), strict);
if (!parameters.parseArgs(args)) {
// ERROR the parameters could not be correctly parsed
// the parameters could not be correctly parsed
throw new CommandRunException(CommandRunExceptionType.USAGE,
"Unable to read arguments", this); //$NON-NLS-1$
}
final List<String> toProvide = new ArrayList<>();
for (final String string : params.keySet()) {
if (params.get(string) && parameters.get(string) == null) {
for (final Entry<String, Boolean> string : params.entrySet()) {
if (string.getValue() && parameters.get(string.getKey()) == null) {
if (!interactive) {
return;
throw new CommandRunException(
CommandRunExceptionType.INTERACTION,
"Missing required parameter " + string.getKey(), //$NON-NLS-1$
this);
}
toProvide.add(string);
toProvide.add(string.getKey());
}
}
// for each needed parameters that is missing, prompt the user.
@@ -160,4 +207,35 @@ public abstract class ParametrizedCommand extends Command {
parameters.set(string, value);
}
}
/** @return the set of boolean parameters */
public Set<String> getBooleanParameters() {
return Collections.unmodifiableSet(boolParams);
}
/** @return the stringParams */
public Set<String> getStringParameters() {
return stringParams.keySet();
}
/** @return the stringParams */
public Set<String> getParameters() {
return params.keySet();
}
/** @param param the parameter name
* @return if the parameter is needed */
public boolean isNeeded(String param) {
return params.containsKey(param) && params.get(param).booleanValue();
}
/** @return the strict */
public boolean isStrict() {
return strict;
}
/** @return the interactive */
public boolean isInteractive() {
return interactive;
}
}

View File

@@ -39,9 +39,10 @@
package fr.bigeon.gclc.command;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.nio.charset.Charset;
import java.text.MessageFormat;
import java.util.Arrays;
import java.util.List;
@@ -60,50 +61,47 @@ import fr.bigeon.gclc.exception.CommandRunExceptionType;
* @author Emmanuel Bigeon */
public class ScriptExecution extends Command {
/** The tab character */
private static final String TAB = "\t"; //$NON-NLS-1$
/** the space character */
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;
/** @param name the name of the command
* @param application the application
* @param commentPrefix the comment prefix in the script files */
* @param commentPrefix the comment prefix in the script files
* @param charset the charset to use for files */
public ScriptExecution(String name, ConsoleApplication application,
String commentPrefix) {
String commentPrefix, Charset charset) {
super(name);
this.application = application;
this.commentPrefix = commentPrefix;
this.charset = charset;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(java.lang.String[]) */
@SuppressWarnings("resource")
@Override
public void execute(String... args) throws CommandRunException {
if (args.length == 0) {
throw new CommandRunException(CommandRunExceptionType.USAGE,
"Expecting a file", this); //$NON-NLS-1$
}
checkArgs(args);
String scriptFile = args[0];
Object[] params = Arrays.copyOfRange(args, 1, args.length);
try (FileReader fReader = new FileReader(new File(scriptFile));
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)) {
String cmd;
for (int i = 1; i < args.length; i++) {
params[i - 1] = args[i];
}
while ((cmd = reader.readLine()) != null) {
if (cmd.startsWith(" ") || cmd.startsWith("\t")) { //$NON-NLS-1$ //$NON-NLS-2$
reader.close();
fReader.close();
throw new CommandRunException(
"Invalid command in script (line starts with space character)", //$NON-NLS-1$
this);
}
if (cmd.isEmpty() || cmd.startsWith(commentPrefix)) {
lineNo++;
String cmdLine = readCommandLine(cmd, params);
if (cmdLine == null) {
continue;
}
String cmdLine = MessageFormat.format(cmd, params);
List<String> ps = GCLCConstants.splitCommand(cmdLine);
String command = ps.remove(0);
application.executeSub(command, ps.toArray(new String[0]));
@@ -113,12 +111,59 @@ public class ScriptExecution extends Command {
e.getLocalizedMessage() + ")", //$NON-NLS-1$
e, this);
} catch (IOException e) {
throw new CommandRunException(
"Unable to read script (" + e.getLocalizedMessage() + ")", //$NON-NLS-1$ //$NON-NLS-2$
throw new CommandRunException("Unable to read script", //$NON-NLS-1$
e, this);
} catch (CommandRunException e) {
throw manageRunException(e, lineNo);
}
}
/** @param args the arguments
* @throws CommandRunException if the arguments were not the ones
* expected */
private void checkArgs(String[] args) throws CommandRunException {
if (args.length == 0) {
throw new CommandRunException(CommandRunExceptionType.USAGE,
"Expecting a file", this); //$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 CommandRunException manageRunException(CommandRunException e,
int lineNo) {
if (e.getSource() == this) {
// ensure closing?
return e;
}
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, this);
}
/** @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(String cmd,
Object[] params) throws CommandRunException {
if (cmd.startsWith(SPACE) || cmd.startsWith(TAB)) {
throw new CommandRunException(
"Invalid command in script (line starts with space character)", //$NON-NLS-1$
this);
}
if (cmd.isEmpty() || cmd.startsWith(commentPrefix)) {
return null;
}
return MessageFormat.format(cmd, params);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override

View File

@@ -122,6 +122,9 @@ public class SubedCommand implements ICommandProvider, ICommand {
try {
executeSub(args[0], Arrays.copyOfRange(args, 1, args.length));
} catch (CommandRunException e) {
if (e.getSource() != null) {
throw e;
}
throw new CommandRunException(CommandRunExceptionType.USAGE,
e.getLocalizedMessage(), e, this);
}

View File

@@ -38,13 +38,9 @@
*/
package fr.bigeon.gclc.exception;
/**
* <p>
* TODO
/** The command run exception possible types
*
* @author Emmanuel Bigeon
*
*/
* @author Emmanuel Bigeon */
public enum CommandRunExceptionType {
/** Type of exception due to a wrong usage */
USAGE,

View File

@@ -40,7 +40,7 @@ package fr.bigeon.gclc.exception;
/** <p>
* Exception sent from the application when a command is added but the name of
* the command
* the command is already used
*
* @author Emmanuel BIGEON */
public class InvalidCommandName extends Exception {
@@ -50,4 +50,25 @@ public class InvalidCommandName extends Exception {
*/
private static final long serialVersionUID = 1L;
/** Default constructor */
public InvalidCommandName() {
super();
}
/** @param message the message
* @param cause the cause */
public InvalidCommandName(String message, Throwable cause) {
super(message, cause);
}
/** @param message the message */
public InvalidCommandName(String message) {
super(message);
}
/** @param cause the cause */
public InvalidCommandName(Throwable cause) {
super(cause);
}
}

View File

@@ -0,0 +1,71 @@
/*
* Copyright Bigeon Emmanuel (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
*
* 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.
*/
/**
* gclc:fr.bigeon.gclc.exception.InvalidParameterException.java
* Created on: Nov 19, 2016
*/
package fr.bigeon.gclc.exception;
/** This exception is thrown during command definitions to indicate a wrong
* parameter definition.
* <p>
* This class is particularly used by
* {@link fr.bigeon.gclc.command.ParametrizedCommand parameterized commands}.
*
* @author Emmanuel Bigeon */
public class InvalidParameterException extends Exception {
/**
*
*/
private static final long serialVersionUID = 1L;
/** @param message the message
* @param cause the cause */
public InvalidParameterException(String message, Throwable cause) {
super(message, cause);
}
/** @param message the message */
public InvalidParameterException(String message) {
super(message);
}
/** @param cause the cause */
public InvalidParameterException(Throwable cause) {
super(cause);
}
}

View File

@@ -39,6 +39,7 @@
package fr.bigeon.gclc.manager;
import java.io.IOException;
import java.io.InterruptedIOException;
/** <p>
* A console manager is in charge of the basic prompts and prints on a console.
@@ -47,7 +48,7 @@ import java.io.IOException;
* a message, in that case, the usual behavior is to prompt normally.
*
* @author Emmanuel BIGEON */
public interface ConsoleManager {
public interface ConsoleManager extends AutoCloseable {
/** @return the prompt prefix */
String getPrompt();
@@ -69,14 +70,14 @@ public interface ConsoleManager {
void println(String message) throws IOException;
/** @return the user inputed string
* @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
* @throws InterruptedIOException if the prompt was interrupted */
String prompt() throws IOException;
/** @param message the message to prompt the user
* @return the user inputed string
* @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
* @throws InterruptedIOException if the prompt was interrupted */
String prompt(String message) throws IOException;
/** <p>
@@ -88,8 +89,18 @@ public interface ConsoleManager {
/** Closes the manager.
*
* @throws IOException if the close raised an exception */
@Override
void close() throws IOException;
/** @return if the manager is closed. */
boolean isClosed();
/** Indicate to the manager that is should interrompt the prompting, if
* possible.
* <p>
* The pending {@link #prompt()} or {@link #prompt(String)} operations
* should return immediatly. However the returned value can be anything
* (from the partial prompt content to an empty string or even a null
* pointer). */
void interruptPrompt();
}

View File

@@ -0,0 +1,175 @@
/*
* Copyright Bigeon Emmanuel (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
*
* 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.
*/
/**
* gclc-test:fr.bigeon.gclc.test.TestConsoleManager.java
* Created on: Nov 18, 2016
*/
package fr.bigeon.gclc.manager;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PipedInputStream;
import java.io.PipedOutputStream;
import java.io.PrintStream;
import java.nio.charset.Charset;
/** This console manager allows to enter commands and retrieve the output as an
* input.
* <p>
* This console manager is used to internally pilot an application. This can be
* used to test application behavior.
*
* @author Emmanuel Bigeon */
public final class PipedConsoleManager
implements ConsoleManager {
/** The encoding between streams */
private static final String UTF_8 = "UTF-8"; //$NON-NLS-1$
/** THe inner manager */
private final SystemConsoleManager innerManager;
/** The stream to pipe commands into */
private final PipedOutputStream commandInput;
/** The reader to get application return from */
private final BufferedReader commandBuffOutput;
/** The stream to get application return from */
private final PipedInputStream commandOutput;
/** The print writer for application to write return to */
private final PrintStream outPrint;
/** The stream for the application to read commands from */
private final PipedInputStream in;
/** The writing thread */
private final WritingRunnable writing;
/** The reading thread */
private final ReadingRunnable reading;
/** @throws IOException if the piping failed for streams */
public PipedConsoleManager() throws IOException {
commandInput = new PipedOutputStream();
in = new PipedInputStream(commandInput);
commandOutput = new PipedInputStream();
PipedOutputStream out = new PipedOutputStream(commandOutput);
commandBuffOutput = new BufferedReader(
new InputStreamReader(commandOutput, Charset.forName(UTF_8)));
outPrint = new PrintStream(out, true, UTF_8);
innerManager = new SystemConsoleManager(outPrint, in,
Charset.forName(UTF_8));
writing = new WritingRunnable(commandInput, Charset.forName(UTF_8));
reading = new ReadingRunnable(commandBuffOutput);
Thread th = new Thread(writing, "write"); //$NON-NLS-1$
th.start();
th = new Thread(reading, "read"); //$NON-NLS-1$
th.setDaemon(true);
th.start();
}
@Override
public String getPrompt() {
return innerManager.getPrompt();
}
@Override
public void print(String object) throws IOException {
innerManager.print(object);
}
@Override
public void println() throws IOException {
innerManager.println();
}
@Override
public void println(String object) throws IOException {
innerManager.println(object);
}
@Override
public String prompt() throws IOException {
return innerManager
.prompt(innerManager.getPrompt() + System.lineSeparator());
}
@Override
public String prompt(String message) throws IOException {
return innerManager.prompt(message + System.lineSeparator());
}
@Override
public void setPrompt(String prompt) {
innerManager.setPrompt(prompt);
}
@Override
public void close() throws IOException {
innerManager.close();
reading.setRunning(false);
writing.setRunning(false);
outPrint.close();
commandBuffOutput.close();
commandOutput.close();
in.close();
commandInput.close();
}
@Override
public boolean isClosed() {
return innerManager.isClosed();
}
/** @param content the content to type to the application
* @throws IOException if the typing failed */
public void type(String content) throws IOException {
writing.addMessage(content);
}
/** @return the content of the next line written by the application
* @throws IOException if the reading failed */
public String readNextLine() throws IOException {
return reading.getMessage();
}
/** @return the content of the next line written by the application
* @throws IOException if the reading failed */
public boolean available() throws IOException {
return reading.hasMessage();
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#interruptPrompt() */
@Override
public void interruptPrompt() {
innerManager.interruptPrompt();
}
}

View File

@@ -0,0 +1,182 @@
/*
* Copyright Bigeon Emmanuel (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
*
* 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.
*/
/**
* gclc:fr.bigeon.gclc.test.utils.WritingRunnable.java
* Created on: Nov 29, 2016
*/
package fr.bigeon.gclc.manager;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InterruptedIOException;
import java.util.ArrayDeque;
import java.util.Deque;
import java.util.logging.Level;
import java.util.logging.Logger;
/** A runnable to read the piped output.
*
* @author Emmanuel Bigeon */
public class ReadingRunnable implements Runnable {
/** The closed pipe message */
private static final String CLOSED_PIPE = "Closed pipe"; //$NON-NLS-1$
/** Wait timeout */
private static final long TIMEOUT = 1000;
/** Class 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;
/** @param reader the input to read from */
public ReadingRunnable(BufferedReader reader) {
super();
this.reader = reader;
}
/* (non-Javadoc)
* @see java.lang.Runnable#run() */
@Override
public void run() {
while (running) {
try {
String line = reader.readLine();
if (line == null) {
// Buffer end
running = false;
return;
}
LOGGER.finer("Read: " + line); //$NON-NLS-1$
line = stripNull(line);
synchronized (lock) {
messages.add(line);
lock.notify();
}
} catch (InterruptedIOException e) {
LOGGER.log(Level.INFO, "Reading interrupted", e); //$NON-NLS-1$
} catch (IOException e) {
LOGGER.log(Level.SEVERE, "Unable to read from stream", e); //$NON-NLS-1$
running = false;
return;
}
}
}
/** 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(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;
}
/** @return the next read message
* @throws IOException if the pipe is closed */
public String getMessage() throws IOException {
synchronized (lock) {
if (!running) {
throw new IOException(CLOSED_PIPE);
}
waiting = true;
while (messages.isEmpty()) {
try {
lock.wait(TIMEOUT);
} catch (InterruptedException e) {
LOGGER.log(Level.SEVERE, "Thread interruption exception.", //$NON-NLS-1$
e);
}
if (messages.isEmpty() && !running) {
throw new IOException(CLOSED_PIPE);
}
}
LOGGER.finest("Polled: " + messages.peek()); //$NON-NLS-1$
waiting = false;
return messages.poll();
}
}
/** @param running the running to set */
public void setRunning(boolean running) {
synchronized (lock) {
this.running = running;
}
}
/** @return the running */
public boolean isRunning() {
synchronized (lock) {
return running;
}
}
/** @return if a message is waiting
* @throws IOException if the pipe is closed */
public boolean hasMessage() throws IOException {
synchronized (lock) {
if (!running) {
throw new IOException(CLOSED_PIPE);
}
return !messages.isEmpty();
}
}
/** Interrupts the wait on the next message by providing an empty message */
public void interrupt() {
synchronized (lock) {
if (waiting) {
messages.offer(""); //$NON-NLS-1$
lock.notify();
}
}
}
}

View File

@@ -43,22 +43,17 @@ import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.PrintStream;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.nio.charset.Charset;
/** A console using the input stream and print stream.
* <p>
* The default constructor will use the system standart input and output.
*
* @author Emmanuel BIGEON */
public class SystemConsoleManager implements ConsoleManager { // NOSONAR
public final class SystemConsoleManager implements ConsoleManager { // NOSONAR
/** The default prompt */
public static final String DEFAULT_PROMPT = ">"; //$NON-NLS-1$
/** The logger */
private static final Logger LOGGER = Logger
.getLogger(SystemConsoleManager.class.getName());
public static final String DEFAULT_PROMPT = "> "; //$NON-NLS-1$
/** The command prompt. It can be changed. */
private String prompt = DEFAULT_PROMPT;
@@ -71,18 +66,30 @@ public class SystemConsoleManager implements ConsoleManager { // NOSONAR
/** If the manager is closed */
private boolean closed = false;
/** The prompting thread */
private final Thread promptThread;
/** The reading runnable */
private final ReadingRunnable reading;
/** This default constructor relies on the system defined standart output
* and input stream. */
public SystemConsoleManager() {
this(System.out, System.in);
this(System.out, System.in, Charset.defaultCharset());
}
/** @param out the output stream
* @param in the input stream */
public SystemConsoleManager(PrintStream out, InputStream in) {
* @param in the input stream
* @param charset the charset for the input */
public SystemConsoleManager(PrintStream out, InputStream in,
Charset charset) {
super();
this.out = out;
this.in = new BufferedReader(new InputStreamReader(in));
this.in = new BufferedReader(new InputStreamReader(in, charset));
reading = new ReadingRunnable(this.in);
promptThread = new Thread(reading, "prompt"); //$NON-NLS-1$
promptThread.setDaemon(true);
promptThread.start();
}
/** @return the prompt */
@@ -95,19 +102,22 @@ public class SystemConsoleManager implements ConsoleManager { // NOSONAR
* @see fr.bigeon.gclc.ConsoleManager#print(java.lang.Object) */
@Override
public void print(String object) throws IOException {
checkOpen();
out.print(object);
}
/** @throws IOException if the stream was closed */
private void checkOpen() throws IOException {
if (closed) {
throw new IOException();
}
out.print(object);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#println() */
@Override
public void println() throws IOException {
if (closed) {
throw new IOException();
}
checkOpen();
out.println();
}
@@ -115,9 +125,7 @@ public class SystemConsoleManager implements ConsoleManager { // NOSONAR
* @see fr.bigeon.gclc.ConsoleManager#println(java.lang.Object) */
@Override
public void println(String object) throws IOException {
if (closed) {
throw new IOException();
}
checkOpen();
out.println(object);
}
@@ -125,24 +133,16 @@ public class SystemConsoleManager implements ConsoleManager { // NOSONAR
* @see fr.bigeon.gclc.ConsoleManager#prompt() */
@Override
public String prompt() throws IOException {
return prompt(new String() + prompt);
return prompt(prompt);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#prompt(java.lang.String) */
@Override
public String prompt(String message) throws IOException {
if (closed) {
throw new IOException();
}
String result = new String();
out.print(message + ' ');
try {
result = in.readLine();
} catch (final IOException e) {
LOGGER.log(Level.SEVERE, "Unable to read prompt", e); //$NON-NLS-1$
}
return result;
checkOpen();
out.print(message);
return reading.getMessage();
}
/** @param prompt the prompt to set */
@@ -156,6 +156,8 @@ public class SystemConsoleManager implements ConsoleManager { // NOSONAR
@Override
public void close() throws IOException {
closed = true;
reading.setRunning(false);
promptThread.interrupt();
}
/* (non-Javadoc)
@@ -165,4 +167,12 @@ public class SystemConsoleManager implements ConsoleManager { // NOSONAR
return closed;
}
/** Beware, in this implementation this is the same as closing the manager.
*
* @see fr.bigeon.gclc.manager.ConsoleManager#interruptPrompt() */
@Override
public void interruptPrompt() {
reading.interrupt();
}
}

View File

@@ -0,0 +1,140 @@
/*
* Copyright Bigeon Emmanuel (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
*
* 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.
*/
/**
* gclc:fr.bigeon.gclc.test.utils.WritingRunnable.java
* Created on: Nov 29, 2016
*/
package fr.bigeon.gclc.manager;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.ByteBuffer;
import java.nio.charset.Charset;
import java.util.ArrayDeque;
import java.util.Deque;
import java.util.logging.Level;
import java.util.logging.Logger;
/** The runnable in charge of writing messages as they are read.
* <p>
* Messages are queued to be retrieved latter on.
*
* @author Emmanuel Bigeon */
public class WritingRunnable implements Runnable {
/** Wait timeout */
private static final long TIMEOUT = 1000;
/** Class 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;
/** The charset */
private final Charset charset;
/** Runnable state */
private boolean running = true;
/** Synchro object */
private final Object lock = new Object();
/** @param outPrint the output to print to
* @param charset the charset of the stream */
public WritingRunnable(OutputStream outPrint, Charset charset) {
super();
this.outPrint = outPrint;
this.charset = charset;
}
/* (non-Javadoc)
* @see java.lang.Runnable#run() */
@Override
public void run() {
while (running) {
synchronized (lock) {
while (messages.isEmpty()) {
try {
lock.wait(TIMEOUT);
} catch (InterruptedException e) {
LOGGER.log(Level.SEVERE,
"Thread interruption exception.", e); //$NON-NLS-1$
}
if (!running) {
return;
}
}
String message = messages.poll();
ByteBuffer buff = charset
.encode(message + System.lineSeparator());
if (buff.hasArray()) {
try {
outPrint.write(buff.array());
} catch (IOException e) {
LOGGER.log(Level.SEVERE, "Unable to write to stream", //$NON-NLS-1$
e);
}
}
}
}
}
/** @param message the message
* @throws IOException if the pipe is closed */
public void addMessage(String message) throws IOException {
synchronized (lock) {
if (!running) {
throw new IOException("Closed pipe"); //$NON-NLS-1$
}
messages.offer(message);
lock.notify();
}
}
/** @param running the running to set */
public void setRunning(boolean running) {
synchronized (lock) {
this.running = running;
}
}
/** @return the running */
public boolean isRunning() {
synchronized (lock) {
return running;
}
}
}

View File

@@ -90,9 +90,9 @@ public class CLIPrompter {
manager.println(index++ + ") " + u); //$NON-NLS-1$
}
if (cancel != null) {
manager.println(index + ") " + cancel); //$NON-NLS-1$
manager.println(index++ + ") " + cancel); //$NON-NLS-1$
}
return index;
return index - 1;
}
/** @param manager the manager
@@ -162,8 +162,11 @@ public class CLIPrompter {
public static <U, T> T promptChoice(ConsoleManager manager, List<U> choices,
Map<U, T> choicesMap, String message,
String cancel) throws IOException {
return choicesMap.get(choices.get(
promptChoice(manager, choices, message, cancel).intValue()));
Integer res = promptChoice(manager, choices, message, cancel);
if (res == null) {
return null;
}
return choicesMap.get(choices.get(res.intValue()));
}
/** @param manager the manager
@@ -195,6 +198,8 @@ public class CLIPrompter {
}
} catch (final NumberFormatException e) {
LOGGER.log(Level.FINER,
"Unrecognized number. Prompting user again.", e); //$NON-NLS-1$
keepOn = true;
manager.println(CLIPrompterMessages
.getString(PROMPTCHOICE_FORMATERR, 0, index));
@@ -306,10 +311,10 @@ public class CLIPrompter {
String ender) throws IOException {
manager.println(message + CLIPrompterMessages
.getString("promptlongtext.exit.dispkey", ender)); //$NON-NLS-1$
String res = manager.prompt(PROMPT);
String res = manager.prompt(CLIPrompterMessages.getString(PROMPT));
String line = res;
while (!line.equals(ender)) {
line = manager.prompt(PROMPT);
line = manager.prompt(CLIPrompterMessages.getString(PROMPT));
if (!line.equals(ender)) {
res += System.lineSeparator() + line;
}
@@ -351,7 +356,7 @@ public class CLIPrompter {
final List<Integer> chs = promptMultiChoice(manager, choices, message);
final List<T> userChoices = new ArrayList<>();
for (final Integer integer : chs) {
userChoices.add(choicesMap.get(integer));
userChoices.add(choicesMap.get(choices.get(integer.intValue())));
}
return userChoices;
}
@@ -381,6 +386,8 @@ public class CLIPrompter {
try {
added = addUserChoice(val, chs, index);
} catch (final NumberFormatException e) {
LOGGER.log(Level.FINER,
"Unrecognized number. Prompting user again.", e); //$NON-NLS-1$
keepOn = true;
manager.println(CLIPrompterMessages
.getString(PROMPTCHOICE_FORMATERR, 0, index));
@@ -409,7 +416,7 @@ public class CLIPrompter {
}
final int r;
r = Integer.parseInt(val);
if (r >= 0 && r < index) {
if (r >= 0 && r <= index) {
chs.add(Integer.valueOf(r));
return true;
}

View File

@@ -0,0 +1,130 @@
/*
* Copyright Bigeon Emmanuel (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
*
* 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.
*/
/**
* gclc:fr.bigeon.gclc.tools.AOutputForwardRunnable.java
* Created on: Dec 1, 2016
*/
package fr.bigeon.gclc.tools;
import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
import fr.bigeon.gclc.manager.PipedConsoleManager;
/** An incomplete implematation used to forward messages from a piped console.
* <p>
* This forwarding can be interrupted without closing the piped manager.
*
* @author Emmanuel Bigeon */
public abstract class AOutputForwardRunnable implements Runnable {
/** The class 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;
/** The manager. */
private final PipedConsoleManager manager;
/** The timeout */
private final long timeout;
/** 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.
* <p>
* If you do not know what timeout length to use, please use the
* {@link #AOutputForwardRunnable(PipedConsoleManager)} constructor.
*
* @param manager the manager
* @param timeout the timeout between message requests. */
public AOutputForwardRunnable(PipedConsoleManager manager, long timeout) {
super();
this.manager = manager;
this.timeout = timeout;
}
/** Create a forwarding runnable.
*
* @param manager the manager */
public AOutputForwardRunnable(PipedConsoleManager manager) {
super();
this.manager = manager;
timeout = DEFAULT_TIMEOUT;
}
@Override
public void run() {
try {
while (isRunning()) {
while (isRunning() && !manager.available()) {
waitASec();
}
if (!isRunning()) {
return;
}
String m = manager.readNextLine();
forwardLine(m);
}
} catch (IOException e) {
LOGGER.log(Level.SEVERE, "Unexpected problem in manager", //$NON-NLS-1$
e);
}
}
/** @param m the line to forward */
protected abstract void forwardLine(String m);
/** @return if the thread should keep running */
protected abstract boolean isRunning();
/** a method to wait some time */
protected void waitASec() {
try {
synchronized (this) {
wait(timeout);
}
} catch (InterruptedException e) {
LOGGER.log(Level.SEVERE, "Interrupted wait", //$NON-NLS-1$
e);
return;
}
}
}

View File

@@ -50,6 +50,8 @@ public class PrintUtils {
private static final String CONT_DOT = "..."; //$NON-NLS-1$
/** The continuation dot string length */
private static final int CONT_DOT_LENGTH = CONT_DOT.length();
/** The empty string constant */
private static final String EMPTY = ""; //$NON-NLS-1$
/** Utility class */
private PrintUtils() {
@@ -101,8 +103,9 @@ public class PrintUtils {
toCut = toCut.substring(index + 1);
}
result.add(toCut);
result.add(new String());
result.add(EMPTY);
}
result.remove(result.size() - 1);
return result;
}
}

View File

@@ -1,11 +1,12 @@
exit.tip=Exit the application
help.cmd.tip=Display an help tip
prompt.lineprompt=>
prompt.lineprompt=>\
promptlist.exit.defaultkey=\\q
promptlist.exit.dispkey=\ (exit with a new line made of "{0}")
promptlist.prompt=>\
promptlist.multi.sepkey=\
promptbool.choices=\ (Y/N)
promptbool.choices.invalid=Invalid input. Please input one of {0}.

View File

@@ -39,14 +39,10 @@
package fr.bigeon.gclc;
import java.io.IOException;
import java.io.InputStream;
import java.io.PipedInputStream;
import java.io.PipedOutputStream;
import java.io.PrintWriter;
import fr.bigeon.gclc.command.ICommand;
import fr.bigeon.gclc.exception.InvalidCommandName;
import fr.bigeon.gclc.manager.SystemConsoleManager;
import fr.bigeon.gclc.manager.PipedConsoleManager;
/**
* <p>
@@ -55,21 +51,20 @@ import fr.bigeon.gclc.manager.SystemConsoleManager;
* @author Emmanuel Bigeon
*
*/
public class CommandTestingApplication {
@SuppressWarnings("javadoc")
public class CommandTestingApplication implements AutoCloseable {
private final PrintWriter writer;
private final ConsoleTestApplication application;
private final Thread th;
private final PipedConsoleManager manager;
/** @throws IOException if the streams cannot be build */
public CommandTestingApplication() throws IOException {
final PipedOutputStream src = new PipedOutputStream();
InputStream in = new PipedInputStream(src);
application = new ConsoleTestApplication(
new SystemConsoleManager(System.out, in));
manager = new PipedConsoleManager();
application = new ConsoleTestApplication(manager);
th = new Thread(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
application.start();
@@ -77,16 +72,16 @@ public class CommandTestingApplication {
});
th.start();
writer = new PrintWriter(src, true);
}
public void stop() {
@Override
public void close() throws IOException {
application.exit();
writer.println();
manager.close();
}
public void sendCommand(String cmd) {
writer.println(cmd);
public void sendCommand(String cmd) throws IOException {
manager.type(cmd);
}
/** @param cmd the command
@@ -102,11 +97,9 @@ public class CommandTestingApplication {
return application;
}
/**
*
*/
public void waitAndStop() {
writer.println(ConsoleTestApplication.EXIT);
/** @throws IOException if the writing failed */
public void waitAndStop() throws IOException {
manager.type(ConsoleTestApplication.EXIT);
try {
th.join();
} catch (InterruptedException e) {
@@ -114,4 +107,16 @@ public class CommandTestingApplication {
e.printStackTrace();
}
}
/** @return the next written line, null if it is the prompt
* @throws IOException if the reading failed
* @see fr.bigeon.gclc.manager.PipedConsoleManager#readNextLine() */
public String readNextLine() throws IOException {
String ret = manager.readNextLine();
if (ret.equals(manager.getPrompt())) {
return null;
}
return ret;
}
}

View File

@@ -38,22 +38,30 @@
*/
package fr.bigeon.gclc;
import static org.junit.Assert.fail;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import java.io.IOException;
import java.io.InputStream;
import java.io.PipedInputStream;
import java.io.PipedOutputStream;
import java.io.PrintWriter;
import org.junit.Test;
import fr.bigeon.gclc.command.ExitCommand;
import fr.bigeon.gclc.command.ICommand;
import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.CommandRunExceptionType;
import fr.bigeon.gclc.exception.InvalidCommandName;
import fr.bigeon.gclc.i18n.Messages;
import fr.bigeon.gclc.manager.ConsoleManager;
import fr.bigeon.gclc.manager.SystemConsoleManager;
import fr.bigeon.gclc.manager.PipedConsoleManager;
/** Test class for ConsoleApplication
*
* @author Emmanuel Bigeon */
@SuppressWarnings({"resource", "javadoc", "nls", "static-method"})
@SuppressWarnings({"javadoc", "nls", "static-method"})
public class ConsoleApplicationTest {
/** 3 seconds in milliseconds */
@@ -69,27 +77,74 @@ public class ConsoleApplicationTest {
@Test
public void executionTest() {
try {
CommandTestingApplication application = new CommandTestingApplication();
try (CommandTestingApplication application = new CommandTestingApplication()) {
// remove welcome
assertEquals(application.getApplication().getHeader(),
application.readNextLine());
// Remove first prompt
assertNull(application.readNextLine());
application.sendCommand("");
assertNull(application.readNextLine());
application.sendCommand("test");
assertEquals("Test command ran fine", application.readNextLine());
assertNull(application.readNextLine());
application.sendCommand("toto");
assertEquals(
Messages.getString("ConsoleApplication.cmd.failed", "toto"),
application.readNextLine());
assertEquals(
Messages.getString("CommandProvider.unrecognized", "toto"),
application.readNextLine());
assertNull(application.readNextLine());
application.sendCommand("long");
application.sendCommand("exit");
assertEquals("Waita minute", application.readNextLine());
assertEquals("done!", application.readNextLine());
CommandRequestListener crl = new CommandRequestListener() {
@Override
public void commandRequest(String command) {
//
}
};
CommandRequestListener crl2 = new CommandRequestListener() {
@Override
public void commandRequest(String command) {
//
}
};
application.getApplication().addListener(crl);
application.getApplication().addListener(crl2);
assertNull(application.readNextLine());
application.sendCommand("test");
assertEquals("Test command ran fine", application.readNextLine());
application.getApplication().removeListener(crl2);
application.getApplication().removeListener(crl);
application.getApplication().removeListener(crl);
assertTrue(application.getApplication().isRunning());
assertNull(application.readNextLine());
application.sendCommand("exit");
assertEquals(application.getApplication().getFooter(),
application.readNextLine());
assertFalse(application.getApplication().isRunning());
} catch (IOException e1) {
// TODO Auto-generated catch block
e1.printStackTrace();
assertNull(e1);
}
try {
final PipedOutputStream src = new PipedOutputStream();
InputStream in = new PipedInputStream(src);
ConsoleApplication appli = null;
try (PipedConsoleManager manager = new PipedConsoleManager()) {
final ConsoleApplication app = new ConsoleApplication(manager, null,
null);
appli = app;
app.add(new ExitCommand("exit", app));
final ConsoleTestApplication app = new ConsoleTestApplication(
new SystemConsoleManager(System.out, in));
Thread th = new Thread(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
app.start();
@@ -98,33 +153,67 @@ public class ConsoleApplicationTest {
th.start();
Thread test = new Thread(new Runnable() {
manager.type("exit");
th.join();
@Override
public void run() {
try (PrintWriter writer = new PrintWriter(src, true)) {
writer.println("test");
writer.println("toto");
writer.println("long");
writer.println("exit");
} catch (IOException | InvalidCommandName | InterruptedException e) {
assertNull(e);
}
assertNotNull(appli);
appli.start();
assertFalse(appli.isRunning());
}
@Test
public void interpretCommandTest() {
try (PipedConsoleManager test = new PipedConsoleManager()) {
ConsoleApplication appl = new ConsoleApplication(test, "", "");
appl.interpretCommand("invalid cmd \"due to misplaced\"quote");
assertEquals("Command line cannot be parsed", test.readNextLine());
appl.interpretCommand("");
final String message = "message";
try {
appl.add(new ICommand() {
@Override
public void execute(String... args) throws CommandRunException {
throw new CommandRunException(
CommandRunExceptionType.USAGE, message, this);
}
}
});
test.start();
try {
th.join();
} catch (InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
try {
test.join();
} catch (InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
@Override
public String getCommandName() {
return "fail";
}
@Override
public void help(ConsoleManager manager,
String... args) throws IOException {
manager.println(message);
}
@Override
public String tip() {
return "";
}
});
} catch (InvalidCommandName e) {
assertNull(e);
}
appl.interpretCommand("fail");
assertEquals(
Messages.getString("ConsoleApplication.cmd.failed", "fail"),
test.readNextLine());
assertEquals(message, test.readNextLine());
assertEquals(message, test.readNextLine());
} catch (IOException e) {
fail("pipe creation"); //$NON-NLS-1$
assertNull(e);
}
}
}

View File

@@ -100,6 +100,18 @@ public class ConsoleTestApplication extends ConsoleApplication {
}
}
});
add(new Command("failingCmd") {
@Override
public String tip() {
return "A long execution command";
}
@Override
public void execute(String... args) throws CommandRunException {
throw new CommandRunException("Failing command", this);
}
});
} catch (final InvalidCommandName e) {
e.printStackTrace();
}

View File

@@ -62,7 +62,7 @@ public class GCLCConstantsTest {
try {
res = GCLCConstants.splitCommand("aCommand");
} catch (CommandParsingException e) {
fail("Unable to parse simple command"); //$NON-NLS-1$
fail("Unable to parse simple command " + e.getLocalizedMessage()); //$NON-NLS-1$
return;
}
assertTrue(res.size() == 1);
@@ -71,7 +71,8 @@ public class GCLCConstantsTest {
try {
res = GCLCConstants.splitCommand("aCommand with some arguments");
} catch (CommandParsingException e) {
fail("Unable to parse command with arguments"); //$NON-NLS-1$
fail("Unable to parse command with arguments " + //$NON-NLS-1$
e.getLocalizedMessage());
return;
}
assertTrue(res.size() == 4);
@@ -82,7 +83,8 @@ public class GCLCConstantsTest {
try {
res = GCLCConstants.splitCommand("aCommand with some arguments");
} catch (CommandParsingException e) {
fail("Unable to parse command with arguments and double whitspaces"); //$NON-NLS-1$
fail("Unable to parse command with arguments and double whitspaces " + //$NON-NLS-1$
e.getLocalizedMessage());
return;
}
assertTrue(res.size() == 4);
@@ -94,7 +96,8 @@ public class GCLCConstantsTest {
res = GCLCConstants
.splitCommand("aCommand \"with some\" arguments");
} catch (CommandParsingException e) {
fail("Unable to parse command with string argument"); //$NON-NLS-1$
fail("Unable to parse command with string argument " + //$NON-NLS-1$
e.getLocalizedMessage());
return;
}
assertTrue(res.size() == 3);
@@ -104,7 +107,8 @@ public class GCLCConstantsTest {
try {
res = GCLCConstants.splitCommand("aCommand with\\ some arguments");
} catch (CommandParsingException e) {
fail("Unable to parse command with arguments with escaped whitspaces"); //$NON-NLS-1$
fail("Unable to parse command with arguments with escaped whitspaces " + //$NON-NLS-1$
e.getLocalizedMessage());
return;
}
assertTrue(res.size() == 3);
@@ -115,7 +119,8 @@ public class GCLCConstantsTest {
res = GCLCConstants
.splitCommand("aCommand wi\\\"th some arguments");
} catch (CommandParsingException e) {
fail("Unable to parse command with string argument"); //$NON-NLS-1$
fail("Unable to parse command with string argument " + //$NON-NLS-1$
e.getLocalizedMessage());
return;
}
assertTrue(res.size() == 4);
@@ -124,6 +129,19 @@ public class GCLCConstantsTest {
assertTrue(res.get(2).equals("some"));
assertTrue(res.get(3).equals("arguments"));
try {
res = GCLCConstants
.splitCommand("aCommand with \"some arguments\"");
} catch (CommandParsingException e) {
fail("Unable to parse command ending with string argument " + //$NON-NLS-1$
e.getLocalizedMessage());
return;
}
assertTrue(res.size() == 3);
assertTrue(res.get(0).equals("aCommand"));
assertTrue(res.get(1).equals("with"));
assertTrue(res.get(2).equals("some arguments"));
// Wrong lines?
try {
res = GCLCConstants
@@ -131,6 +149,7 @@ public class GCLCConstantsTest {
fail("Parsing argument with string cut");
} catch (CommandParsingException e) {
// OK
assertTrue(e.getLocalizedMessage(), true);
}
}

View File

@@ -0,0 +1,284 @@
/*
* Copyright Bigeon Emmanuel (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
*
* 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.
*/
/**
* gclc:fr.bigeon.gclc.command.CommandParametersTest.java
* Created on: Nov 18, 2016
*/
package fr.bigeon.gclc.command;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import java.util.HashSet;
import java.util.Set;
import org.junit.Test;
/**
* <p>
* TODO
*
* @author Emmanuel Bigeon
*
*/
@SuppressWarnings({"static-method", "nls"})
public class CommandParametersTest {
/**
* Test method for {@link fr.bigeon.gclc.command.CommandParameters#CommandParameters(java.util.Set, java.util.Set, boolean)}.
*/
@Test
public final void testCommandParameters(){
Set<String> strings = new HashSet<>();
Set<String> bools = new HashSet<>();
CommandParameters parameters = new CommandParameters(bools, strings,
true);
assertFalse(parameters.parseArgs("-ungivenFlag"));
parameters = new CommandParameters(bools, strings, false);
assertTrue(parameters.parseArgs("-ungivenFlag"));
}
/**
* Test method for {@link fr.bigeon.gclc.command.CommandParameters#get(java.lang.String)}.
*/
@Test
public final void testGet(){
Set<String> strings = new HashSet<>();
Set<String> bools = new HashSet<>();
bools.add("boolFlag");
strings.add("str");
CommandParameters parameters = new CommandParameters(bools, strings,
true);
assertNull(parameters.get("ungiven"));
assertNull(parameters.get("str"));
parameters.parseArgs("-ungiven", "val");
assertNull(parameters.get("ungiven"));
assertNull(parameters.get("str"));
parameters.parseArgs("-str", "val");
assertNull(parameters.get("ungiven"));
assertEquals("val", parameters.get("str"));
parameters.parseArgs("-ungiven");
assertNull(parameters.get("ungiven"));
assertEquals("val", parameters.get("str"));
}
/**
* Test method for {@link fr.bigeon.gclc.command.CommandParameters#getAdditionals()}.
*/
@Test
public final void testGetAdditionals(){
Set<String> strings = new HashSet<>();
Set<String> bools = new HashSet<>();
bools.add("boolFlag");
strings.add("str");
CommandParameters parameters = new CommandParameters(bools, strings,
true);
parameters.parseArgs("-boolFlag");
assertTrue(parameters.getAdditionals().isEmpty());
parameters.parseArgs("-ungiven");
assertTrue(parameters.getAdditionals().isEmpty());
parameters = new CommandParameters(bools, strings, false);
parameters.parseArgs("-boolFlag");
assertTrue(parameters.getAdditionals().isEmpty());
parameters.parseArgs("-ungiven");
assertTrue(parameters.getAdditionals().contains("ungiven"));
assertEquals(1, parameters.getAdditionals().size());
}
/**
* Test method for {@link fr.bigeon.gclc.command.CommandParameters#getBool(java.lang.String)}.
*/
@Test
public final void testGetBool(){
Set<String> strings = new HashSet<>();
Set<String> bools = new HashSet<>();
bools.add("boolFlag");
strings.add("str");
CommandParameters parameters = new CommandParameters(bools, strings,
true);
assertFalse(parameters.getBool("ungiven"));
assertFalse(parameters.getBool("boolFlag"));
parameters.parseArgs("-boolFlag");
assertTrue(parameters.getBool("boolFlag"));
assertFalse(parameters.getBool("ungiven"));
parameters.parseArgs("-ungiven");
assertFalse(parameters.getBool("ungiven"));
assertTrue(parameters.getBool("boolFlag"));
parameters = new CommandParameters(bools, strings, false);
assertFalse(parameters.getBool("ungiven"));
assertFalse(parameters.getBool("boolFlag"));
parameters.parseArgs("-boolFlag");
assertTrue(parameters.getBool("boolFlag"));
assertFalse(parameters.getBool("ungiven"));
parameters.parseArgs("-ungiven");
assertFalse(parameters.getBool("ungiven"));
assertTrue(parameters.getBool("boolFlag"));
}
/**
* Test method for {@link fr.bigeon.gclc.command.CommandParameters#parseArgs(java.lang.String[])}.
*/
@Test
public final void testParseArgs(){
Set<String> strings = new HashSet<>();
Set<String> bools = new HashSet<>();
bools.add("boolFlag");
strings.add("str");
CommandParameters parameters = new CommandParameters(bools, strings,
true);
assertFalse(parameters.parseArgs("-ungivenFlag"));
assertFalse(parameters.parseArgs("-str"));
assertTrue(parameters.parseArgs("-boolFlag"));
assertTrue(parameters.parseArgs("-str", "-boolFlag"));
assertTrue(parameters.parseArgs("-boolFlag", "-str", "val"));
}
/**
* Test method for {@link fr.bigeon.gclc.command.CommandParameters#set(java.lang.String, boolean)}.
*/
@Test
public final void testSetStringBoolean(){
Set<String> strings = new HashSet<>();
Set<String> bools = new HashSet<>();
bools.add("boolFlag");
strings.add("str");
CommandParameters parameters = new CommandParameters(bools, strings,
true);
assertFalse(parameters.getBool("ungiven"));
assertFalse(parameters.getBool("boolFlag"));
parameters.set("boolFlag", true);
assertTrue(parameters.getBool("boolFlag"));
assertFalse(parameters.getBool("ungiven"));
parameters.set("ungiven", true);
assertFalse(parameters.getBool("ungiven"));
assertTrue(parameters.getBool("boolFlag"));
parameters = new CommandParameters(bools, strings, false);
assertFalse(parameters.getBool("ungiven"));
assertFalse(parameters.getBool("boolFlag"));
parameters.set("boolFlag", true);
assertTrue(parameters.getBool("boolFlag"));
assertFalse(parameters.getBool("ungiven"));
parameters.set("ungiven", true);
assertFalse(parameters.getBool("ungiven"));
assertTrue(parameters.getBool("boolFlag"));
}
/**
* Test method for {@link fr.bigeon.gclc.command.CommandParameters#set(java.lang.String, java.lang.String)}.
*/
@Test
public final void testSetStringString(){
Set<String> strings = new HashSet<>();
Set<String> bools = new HashSet<>();
bools.add("boolFlag");
strings.add("str");
CommandParameters parameters = new CommandParameters(bools, strings,
true);
assertNull(parameters.get("ungiven"));
assertNull(parameters.get("str"));
parameters.set("ungiven", "val");
assertNull(parameters.get("ungiven"));
assertNull(parameters.get("str"));
parameters.set("str", "val");
assertNull(parameters.get("ungiven"));
assertEquals("val", parameters.get("str"));
parameters.set("ungiven", "val");
assertNull(parameters.get("ungiven"));
assertEquals("val", parameters.get("str"));
parameters = new CommandParameters(bools, strings, false);
assertNull(parameters.get("ungiven"));
assertNull(parameters.get("str"));
parameters.set("ungiven", "val");
assertNull(parameters.get("ungiven"));
assertNull(parameters.get("str"));
parameters.set("str", "val");
assertNull(parameters.get("ungiven"));
assertEquals("val", parameters.get("str"));
parameters.set("ungiven", "val");
assertNull(parameters.get("ungiven"));
assertEquals("val", parameters.get("str"));
}
}

View File

@@ -0,0 +1,105 @@
/*
* Copyright Bigeon Emmanuel (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
*
* 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.
*/
/**
* gclc:fr.bigeon.gclc.command.CommandProviderTest.java
* Created on: Nov 19, 2016
*/
package fr.bigeon.gclc.command;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.fail;
import org.junit.Test;
import fr.bigeon.gclc.exception.InvalidCommandName;
/** <p>
* TODO
*
* @author Emmanuel Bigeon */
public class CommandProviderTest {
/** Test method for
* {@link fr.bigeon.gclc.command.CommandProvider#add(fr.bigeon.gclc.command.ICommand)}. */
@Test
public final void testAdd() {
CommandProvider provider = new CommandProvider();
try {
provider.add(new MockCommand(null));
fail("null name for command should be rejected");
} catch (InvalidCommandName e) {
assertNotNull(e);
}
try {
provider.add(new MockCommand(""));
fail("null name for command should be rejected");
} catch (InvalidCommandName e) {
assertNotNull(e);
}
try {
provider.add(new MockCommand("-name"));
fail("name with minus as starting character for command should be rejected");
} catch (InvalidCommandName e) {
assertNotNull(e);
}
try {
provider.add(new MockCommand("name command"));
fail("name with space for command should be rejected");
} catch (InvalidCommandName e) {
assertNotNull(e);
}
ICommand mock = new MockCommand("name");
try {
provider.add(mock);
} catch (InvalidCommandName e) {
assertNull(e);
}
try {
provider.add(new MockCommand(mock.getCommandName()));
fail("already existing command name should be rejected");
} catch (InvalidCommandName e) {
assertNotNull(e);
}
try {
provider.add(mock);
} catch (InvalidCommandName e) {
assertNotNull(e);
}
}
}

View File

@@ -0,0 +1,217 @@
/*
* Copyright Bigeon Emmanuel (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
*
* 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.
*/
/**
* gclc:fr.bigeon.gclc.command.CommandTest.java
* Created on: Nov 19, 2016
*/
package fr.bigeon.gclc.command;
import static org.junit.Assert.assertNull;
import java.io.IOException;
import org.junit.Test;
import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.manager.PipedConsoleManager;
/** <p>
* TODO
*
* @author Emmanuel Bigeon */
public class CommandTest {
@Test
public final void test() {
try (PipedConsoleManager test = new PipedConsoleManager()) {
Command cmd;
cmd = new Command("name") {
@Override
public String tip() {
return null;
}
@Override
public void execute(String... args) throws CommandRunException {
//
}
};
cmd.help(test);
cmd = new Command("name") {
@Override
public String tip() {
return "";
}
@Override
public void execute(String... args) throws CommandRunException {
//
}
};
cmd.help(test);
cmd = new Command("name") {
@Override
public String tip() {
return "tip";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#brief() */
@Override
protected String brief() {
return null;
}
@Override
public void execute(String... args) throws CommandRunException {
//
}
};
cmd.help(test);
cmd = new Command("name") {
@Override
public String tip() {
return "tip";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#brief() */
@Override
protected String brief() {
return "brief";
}
@Override
public void execute(String... args) throws CommandRunException {
//
}
};
cmd.help(test);
cmd = new Command("name") {
@Override
public String tip() {
return "tip";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
return null;
}
@Override
public void execute(String... args) throws CommandRunException {
//
}
};
cmd.help(test);
cmd = new Command("name") {
@Override
public String tip() {
return "tip";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
return "details";
}
@Override
public void execute(String... args) throws CommandRunException {
//
}
};
cmd.help(test);
cmd = new Command("name") {
@Override
public String tip() {
return "tip";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
return "details" + System.lineSeparator();
}
@Override
public void execute(String... args) throws CommandRunException {
//
}
};
cmd.help(test);
cmd = new Command("name") {
@Override
public String tip() {
return "tip";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
return "\n";
}
@Override
public void execute(String... args) throws CommandRunException {
//
}
};
cmd.help(test);
} catch (IOException e) {
assertNull(e);
}
}
}

View File

@@ -0,0 +1,137 @@
/*
* Copyright Bigeon Emmanuel (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
*
* 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.
*/
/**
* gclc:fr.bigeon.gclc.command.HelpExecutorTest.java
* Created on: Nov 19, 2016
*/
package fr.bigeon.gclc.command;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.fail;
import org.junit.Test;
import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.manager.PipedConsoleManager;
/**
* <p>
* TODO
*
* @author Emmanuel Bigeon
*
*/
public class HelpExecutorTest {
/**
* Test method for {@link fr.bigeon.gclc.command.HelpExecutor#HelpExecutor(java.lang.String, fr.bigeon.gclc.manager.ConsoleManager, fr.bigeon.gclc.command.ICommand)}.
*/
@Test
public final void testHelpExecutor(){
HelpExecutor help;
try {
help = new HelpExecutor("?", null, new MockCommand("mock"));
fail("help is an interactive command, should need console manager");
} catch (Exception e) {
assertNotNull(e);
}
try (PipedConsoleManager test = new PipedConsoleManager()) {
help = new HelpExecutor("?", test, new MockCommand("mock"));
} catch (Exception e) {
assertNull(e);
}
}
/**
* Test method for {@link fr.bigeon.gclc.command.HelpExecutor#execute(java.lang.String[])}.
*/
@Test
public final void testExecute(){
try {
PipedConsoleManager test = new PipedConsoleManager();
HelpExecutor help = new HelpExecutor("?", test,
new Command("mock") {
@Override
public void execute(String... args) throws CommandRunException {
//
}
@Override
public String tip() {
return "";
}
});
help.execute();
test.close();
try {
help.execute();
fail("manager closed shall provoke failure of help command execution");
} catch (Exception e) {
assertNotNull(e);
}
} catch (Exception e) {
assertNull(e);
}
}
/**
* Test method for {@link fr.bigeon.gclc.command.HelpExecutor#tip()}.
*/
@Test
public final void testTip(){
try (PipedConsoleManager test = new PipedConsoleManager()) {
HelpExecutor help = new HelpExecutor("?", test,
new MockCommand("mock"));
help.tip();
help.help(test);
} catch (Exception e) {
assertNull(e);
}
try (PipedConsoleManager test = new PipedConsoleManager()) {
HelpExecutor help = new HelpExecutor("?", test,
new SubedCommand("sub", new MockCommand("mock")));
help.tip();
help.help(test);
} catch (Exception e) {
assertNull(e);
}
}
}

View File

@@ -0,0 +1,649 @@
/*
* Copyright Bigeon Emmanuel (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
*
* 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.
*/
/**
* gclc:fr.bigeon.gclc.command.ParametrizedCommandTest.java
* Created on: Nov 18, 2016
*/
package fr.bigeon.gclc.command;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.io.IOException;
import org.junit.Test;
import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.InvalidParameterException;
import fr.bigeon.gclc.manager.PipedConsoleManager;
/** <p>
* TODO
*
* @author Emmanuel Bigeon */
public class ParametrizedCommandTest {
/** Test method for
* {@link fr.bigeon.gclc.command.ParametrizedCommand#ParametrizedCommand(fr.bigeon.gclc.manager.ConsoleManager, java.lang.String)}. */
@Test
public final void testParametrizedCommandConsoleManagerString() {
try (PipedConsoleManager test = new PipedConsoleManager()) {
ParametrizedCommand cmd = new ParametrizedCommand(test, "name") {
@Override
public String tip() {
return null;
}
@Override
protected void doExecute(CommandParameters parameters) {
//
}
};
assertTrue(cmd.isStrict());
assertTrue(cmd.isInteractive());
} catch (IOException e) {
fail("Unexpected exception in creation");
assertNull(e);
}
ParametrizedCommand cmd = new ParametrizedCommand(null, "name") {
@Override
public String tip() {
return null;
}
@Override
protected void doExecute(CommandParameters parameters) {
//
}
};
assertTrue(cmd.isStrict());
assertFalse(cmd.isInteractive());
cmd = new ParametrizedCommand("name") {
@Override
public String tip() {
return null;
}
@Override
protected void doExecute(CommandParameters parameters) {
//
}
};
assertTrue(cmd.isStrict());
assertFalse(cmd.isInteractive());
}
/** Test method for
* {@link fr.bigeon.gclc.command.ParametrizedCommand#ParametrizedCommand(fr.bigeon.gclc.manager.ConsoleManager, java.lang.String, boolean)}. */
@Test
public final void testParametrizedCommandConsoleManagerStringBoolean() {
try (PipedConsoleManager test = new PipedConsoleManager()) {
ParametrizedCommand cmd = new ParametrizedCommand(test, "name",
false) {
@Override
public String tip() {
return null;
}
@Override
protected void doExecute(CommandParameters parameters) {
//
}
};
assertFalse(cmd.isStrict());
assertTrue(cmd.isInteractive());
} catch (IOException e) {
fail("Unexpected exception in creation");
assertNull(e);
}
ParametrizedCommand cmd = new ParametrizedCommand(null, "name", false) {
@Override
public String tip() {
return null;
}
@Override
protected void doExecute(CommandParameters parameters) {
//
}
};
assertFalse(cmd.isStrict());
assertFalse(cmd.isInteractive());
cmd = new ParametrizedCommand("name", false) {
@Override
public String tip() {
return null;
}
@Override
protected void doExecute(CommandParameters parameters) {
//
}
};
assertFalse(cmd.isStrict());
assertFalse(cmd.isInteractive());
}
/** Test method for
* {@link fr.bigeon.gclc.command.ParametrizedCommand#addParameter(java.lang.String, boolean, boolean)}. */
@Test
public final void testAddParameter() {
ParametrizedCommand cmd = new ParametrizedCommand(null, "name") {
@Override
public String tip() {
return null;
}
@Override
protected void doExecute(CommandParameters parameters) {
//
}
};
cmd = new ParametrizedCommand(null, "name", true) {
@Override
public String tip() {
return null;
}
@Override
protected void doExecute(CommandParameters parameters) {
//
}
};
// XXX Boolean flag should not be specified mandatory! They are by
// nature qualified
try {
cmd.addParameter("boolFlag", false, true);
fail("Boolean parameters should never be needed specified");
} catch (InvalidParameterException e) {
// OK
assertNotNull(e);
}
String str = "str";
try {
assertTrue(cmd.getBooleanParameters().isEmpty());
assertTrue(cmd.getStringParameters().isEmpty());
cmd.addParameter("boolFlag", false, false);
assertEquals(1, cmd.getBooleanParameters().size());
assertTrue(cmd.getStringParameters().isEmpty());
cmd.addParameter(str, true, false);
assertEquals(1, cmd.getBooleanParameters().size());
assertEquals(1, cmd.getStringParameters().size());
assertFalse(cmd.isNeeded(str));
cmd.addParameter("boolFlag", false, false);
assertEquals(1, cmd.getBooleanParameters().size());
assertEquals(1, cmd.getStringParameters().size());
cmd.addParameter(str, true, true);
assertEquals(1, cmd.getBooleanParameters().size());
assertEquals(1, cmd.getStringParameters().size());
assertTrue(cmd.isNeeded(str));
cmd.addParameter(str, true, false);
assertEquals(1, cmd.getBooleanParameters().size());
assertEquals(1, cmd.getStringParameters().size());
assertTrue(cmd.isNeeded(str));
} catch (InvalidParameterException e) {
fail("Unexpected error in addition of legitimate parameter");
assertNotNull(e);
}
try {
cmd.addParameter(str, false, false);
fail("parameter type conversion shall fail");
} catch (InvalidParameterException e) {
// OK
assertNotNull(e);
}
try {
cmd.addParameter("boolFlag", true, false);
fail("parameter type conversion shall fail");
} catch (InvalidParameterException e) {
// OK
assertNotNull(e);
}
try {
cmd.addParameter("boolFlag", false, true);
fail("parameter type conversion shall fail");
} catch (InvalidParameterException e) {
// OK
assertNotNull(e);
}
try {
cmd.addParameter("boolFlag", true, true);
fail("parameter type conversion shall fail");
} catch (InvalidParameterException e) {
// OK
assertNotNull(e);
}
}
/** Test method for
* {@link fr.bigeon.gclc.command.ParametrizedCommand#execute(java.lang.String[])}. */
@Test
public final void testExecute() {
final String addParam = "additional";
final String str1 = "str1";
final String str2 = "str2";
final String bool1 = "bool1";
final String bool2 = "bool2";
// Test on command with no needed elements
ParametrizedCommand cmd = new ParametrizedCommand("name", false) {
private boolean evenCall = true;
@Override
public String tip() {
return "";
}
@Override
protected void doExecute(CommandParameters parameters) {
assertTrue(parameters.getBooleanArgumentKeys().isEmpty());
assertTrue(parameters.getStringArgumentKeys().isEmpty());
if (evenCall) {
assertTrue(parameters.getAdditionals().isEmpty());
evenCall = false;
} else {
assertEquals(1, parameters.getAdditionals().size());
assertTrue(parameters.getAdditionals().contains(addParam));
evenCall = true;
}
}
};
try {
cmd.execute();
cmd.execute("-" + addParam);
cmd.execute(addParam);
cmd.execute("-" + addParam, addParam);
} catch (CommandRunException e) {
assertNull(e);
fail("unepected error");
}
cmd = new ParametrizedCommand("name", false) {
private int call = 0;
{
try {
addParameter(str1, true, false);
addParameter(str2, true, false);
addParameter(bool1, false, false);
addParameter(bool2, false, false);
} catch (InvalidParameterException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
@Override
public String tip() {
return "";
}
@Override
protected void doExecute(CommandParameters parameters) {
assertEquals(2, parameters.getBooleanArgumentKeys().size());
assertEquals(2, parameters.getStringArgumentKeys().size());
switch (call) {
case 0:
case 1:
case 2:
case 3:
assertNull(parameters.get(str1));
assertNull(parameters.get(str2));
assertFalse(parameters.getBool(bool1));
assertFalse(parameters.getBool(bool2));
call++;
break;
case 4:
assertEquals(str2, parameters.get(str1));
assertNull(parameters.get(str2));
assertFalse(parameters.getBool(bool1));
assertFalse(parameters.getBool(bool2));
call++;
break;
case 5:
assertEquals(str2, parameters.get(str1));
assertNull(parameters.get(str2));
assertTrue(parameters.getBool(bool1));
assertFalse(parameters.getBool(bool2));
call = 0;
break;
default:
break;
}
}
};
try {
cmd.execute();
cmd.execute("-" + addParam);
cmd.execute(addParam);
cmd.execute("-" + addParam, addParam);
cmd.execute("-" + str1, str2);
cmd.execute("-" + str1, str2, "-" + bool1);
} catch (CommandRunException e) {
assertNull(e);
fail("unepected error");
}
cmd = new ParametrizedCommand("name", true) {
private int call = 0;
{
try {
addParameter(str1, true, false);
addParameter(str2, true, false);
addParameter(bool1, false, false);
addParameter(bool2, false, false);
} catch (InvalidParameterException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
@Override
public String tip() {
return "";
}
@Override
protected void doExecute(CommandParameters parameters) {
assertEquals(2, parameters.getBooleanArgumentKeys().size());
assertEquals(2, parameters.getStringArgumentKeys().size());
switch (call) {
case 0:
case 1:
assertNull(parameters.get(str1));
assertNull(parameters.get(str2));
assertFalse(parameters.getBool(bool1));
assertFalse(parameters.getBool(bool2));
call++;
break;
case 2:
assertEquals(str2, parameters.get(str1));
assertNull(parameters.get(str2));
assertFalse(parameters.getBool(bool1));
assertFalse(parameters.getBool(bool2));
call++;
break;
case 3:
assertEquals(str2, parameters.get(str1));
assertNull(parameters.get(str2));
assertTrue(parameters.getBool(bool1));
assertFalse(parameters.getBool(bool2));
call = 0;
break;
default:
break;
}
}
};
try {
cmd.execute();
cmd.execute(addParam);
cmd.execute("-" + str1, str2);
cmd.execute("-" + str1, str2, "-" + bool1);
} catch (CommandRunException e) {
assertNull(e);
fail("unepected error");
}
try {
cmd.execute("-" + addParam);
fail("Strict should fail with unexpected argument");
} catch (CommandRunException e) {
assertNotNull(e);
}
// Test on command with missing needed elements
cmd = new ParametrizedCommand("name", false) {
private final int call = 0;
{
try {
addParameter(str1, true, true);
addParameter(str2, true, false);
addParameter(bool1, false, false);
addParameter(bool2, false, false);
} catch (InvalidParameterException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
@Override
public String tip() {
return "";
}
@Override
protected void doExecute(CommandParameters parameters) {
assertEquals(str2, parameters.get(str1));
}
};
try {
cmd.execute("-" + str1, str2);
cmd.execute("-" + str1, str2, "-" + bool1);
cmd.execute("-" + str1, str2, "-" + addParam);
cmd.execute("-" + str1, str2, addParam);
cmd.execute("-" + str1, str2, "-" + addParam, addParam);
} catch (CommandRunException e) {
assertNull(e);
fail("unepected error");
}
try {
cmd.execute();
fail("needed " + str1 + " not provided shall fail");
} catch (CommandRunException e) {
assertNotNull(e);
}
cmd = new ParametrizedCommand("name", true) {
private final int call = 0;
{
try {
addParameter(str1, true, true);
addParameter(str2, true, false);
addParameter(bool1, false, false);
addParameter(bool2, false, false);
} catch (InvalidParameterException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
@Override
public String tip() {
return "";
}
@Override
protected void doExecute(CommandParameters parameters) {
//
assertEquals(str2, parameters.get(str1));
}
};
try {
cmd.execute("-" + str1, str2);
cmd.execute("-" + str1, str2, "-" + bool1);
cmd.execute("-" + str1, str2, addParam);
} catch (CommandRunException e) {
assertNull(e);
fail("unepected error");
}
try {
cmd.execute();
fail("needed " + str1 + " not provided shall fail");
} catch (CommandRunException e) {
assertNotNull(e);
}
try {
cmd.execute("-" + str1, str2, "-" + addParam);
fail("unepected error");
} catch (CommandRunException e) {
assertNotNull(e);
}
try {
cmd.execute("-" + str1, str2, "-" + addParam, addParam);
fail("unepected error");
} catch (CommandRunException e) {
assertNotNull(e);
}
// TODO Test of interactive not providing and providing all needed
try (PipedConsoleManager test = new PipedConsoleManager()) {
cmd = new ParametrizedCommand(test, "name", false) {
{
try {
addParameter(str1, true, true);
addParameter(str2, true, false);
addParameter(bool1, false, false);
addParameter(bool2, false, false);
} catch (InvalidParameterException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
@Override
public String tip() {
return "";
}
@Override
protected void doExecute(CommandParameters parameters) {
assertEquals(str2, parameters.get(str1));
}
};
try {
cmd.execute("-" + str1, str2);
cmd.execute("-" + str1, str2, "-" + bool1);
cmd.execute("-" + str1, str2, addParam);
cmd.execute("-" + str1, str2, "-" + addParam);
cmd.execute("-" + str1, str2, "-" + addParam, addParam);
} catch (CommandRunException e) {
assertNull(e);
fail("unepected error");
}
try {
Thread th = new Thread(new Runnable() {
@Override
public void run() {
try {
assertEquals(str1, test.readNextLine());
test.type("");
assertEquals(str1, test.readNextLine());
test.type(str2);
} catch (IOException e) {
assertNull(e);
}
}
});
th.start();
cmd.execute();
th.join();
th = new Thread(new Runnable() {
@Override
public void run() {
try {
assertEquals(str1, test.readNextLine());
test.type(str2);
} catch (IOException e) {
assertNull(e);
}
}
});
th.start();
cmd.execute("-" + addParam);
th.join();
} catch (CommandRunException | InterruptedException e) {
assertNull(e);
fail("unepected error");
}
} catch (IOException e) {
assertNull(e);
fail("unepected error");
}
try {
PipedConsoleManager test = new PipedConsoleManager();
cmd = new ParametrizedCommand(test, "name") {
{
try {
addParameter(str1, true, true);
addParameter(str2, true, false);
addParameter(bool1, false, false);
addParameter(bool2, false, false);
} catch (InvalidParameterException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
@Override
public String tip() {
return "";
}
@Override
protected void doExecute(CommandParameters parameters) {
assertEquals(str2, parameters.get(str1));
}
};
test.close();
cmd.execute("-" + str1, str2);
cmd.execute("-" + addParam);
fail("Closed manager shall cause error");
} catch (IOException e) {
assertNull(e);
} catch (CommandRunException e) {
assertNotNull(e);
}
}
}

View File

@@ -38,14 +38,19 @@
*/
package fr.bigeon.gclc.command;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.fail;
import java.io.IOException;
import java.nio.charset.Charset;
import org.junit.Test;
import fr.bigeon.gclc.CommandTestingApplication;
import fr.bigeon.gclc.exception.InvalidCommandName;
import fr.bigeon.gclc.ConsoleTestApplication;
import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.CommandRunExceptionType;
import fr.bigeon.gclc.manager.PipedConsoleManager;
/**
* <p>
@@ -54,6 +59,7 @@ import fr.bigeon.gclc.exception.InvalidCommandName;
* @author Emmanuel Bigeon
*
*/
@SuppressWarnings("static-method")
public class ScriptExecutionTest {
/**
@@ -61,24 +67,110 @@ public class ScriptExecutionTest {
*/
@Test
public void testExecute() {
PipedConsoleManager test;
try {
CommandTestingApplication application = new CommandTestingApplication();
test = new PipedConsoleManager();
} catch (IOException e2) {
fail("creation of console manager failed"); //$NON-NLS-1$
assertNotNull(e2);
return;
}
ConsoleTestApplication app = new ConsoleTestApplication(
test);
ScriptExecution exec = new ScriptExecution("script", app, "#", //$NON-NLS-1$ //$NON-NLS-2$
Charset.forName("UTF-8"));
try {
exec.execute();
fail("execution of script command with no file should fail"); //$NON-NLS-1$
} catch (CommandRunException e1) {
// ok
assertEquals(exec, e1.getSource());
assertEquals(CommandRunExceptionType.USAGE, e1.getType());
}
application.add(new ScriptExecution("script",
application.getApplication(), "#"));
try {
exec.execute("src/test/resources/scripts/withprependSpace.txt"); //$NON-NLS-1$
fail("execution of script with lines begining with space should fail"); //$NON-NLS-1$
} catch (CommandRunException e1) {
// ok
assertEquals(exec, e1.getSource());
assertEquals(CommandRunExceptionType.EXECUTION, e1.getType());
}
application.sendCommand("script src/test/resources/script1.txt");
application.sendCommand("script src/test/resources/script2.txt");
application.sendCommand("script src/test/resources/script3.txt");
application.sendCommand("script src/test/resources/script4.txt");
application
.sendCommand("script src/test/resources/script5.txt test");
try {
exec.execute("src/test/resources/scripts/invalidCmdParse.txt"); //$NON-NLS-1$
fail("execution of script with invalid command line should fail"); //$NON-NLS-1$
} catch (CommandRunException e1) {
// ok
assertEquals(exec, e1.getSource());
assertEquals(CommandRunExceptionType.EXECUTION, e1.getType());
}
application.waitAndStop();
try {
exec.execute("src/test/resources/scripts/invalidCmd.txt"); //$NON-NLS-1$
fail("execution of script with invalid command should fail"); //$NON-NLS-1$
} catch (CommandRunException e1) {
// ok
assertEquals(exec, e1.getSource());
assertEquals(CommandRunExceptionType.EXECUTION, e1.getType());
}
} catch (IOException | InvalidCommandName e) {
fail("Unexpected exception");
try {
exec.execute("src/test/resources/scripts/failingCmdInvoc.txt"); //$NON-NLS-1$
fail("execution of script with failing command should fail"); //$NON-NLS-1$
} catch (CommandRunException e1) {
// ok
assertEquals(exec, e1.getSource());
assertEquals(CommandRunExceptionType.EXECUTION, e1.getType());
}
try {
exec.execute("src/test/resources/scripts/someNonExisting.file"); //$NON-NLS-1$
fail("execution of script with unexisting file should fail"); //$NON-NLS-1$
} catch (CommandRunException e1) {
// ok
assertEquals(exec, e1.getSource());
assertEquals(CommandRunExceptionType.EXECUTION, e1.getType());
}
try {
exec.execute("src/test/resources/script1.txt"); //$NON-NLS-1$
exec.execute("src/test/resources/script2.txt"); //$NON-NLS-1$
exec.execute("src/test/resources/script3.txt"); //$NON-NLS-1$
exec.execute("src/test/resources/script4.txt"); //$NON-NLS-1$
exec.execute("src/test/resources/script5.txt", "test"); //$NON-NLS-1$ //$NON-NLS-2$
} catch (CommandRunException e) {
e.printStackTrace();
fail("execution of wellformed script should not fail"); //$NON-NLS-1$
}
try {
test.close();
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
/** Test method for {@link fr.bigeon.gclc.command.ScriptExecution#tip()}. */
@Test
public void testTip() {
ScriptExecution exec = new ScriptExecution("script", null, "#", //$NON-NLS-1$ //$NON-NLS-2$
Charset.forName("UTF-8"));
exec.tip();
}
/** Test method for
* {@link fr.bigeon.gclc.command.ScriptExecution#help(fr.bigeon.gclc.manager.ConsoleManager, String...)}. */
@Test
public void testHelp() {
ScriptExecution exec = new ScriptExecution("script", null, "#", //$NON-NLS-1$ //$NON-NLS-2$
Charset.forName("UTF-8"));
try (PipedConsoleManager test = new PipedConsoleManager()) {
exec.help(test);
exec.help(test, "ignored element");
} catch (IOException e) {
e.printStackTrace();
fail("unexpected error in help invocation"); //$NON-NLS-1$
}
}
}

View File

@@ -0,0 +1,390 @@
/*
* Copyright Bigeon Emmanuel (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
*
* 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.
*/
/**
* gclc:fr.bigeon.gclc.command.SubedCommandTest.java
* Created on: Nov 18, 2016
*/
package fr.bigeon.gclc.command;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.fail;
import java.io.IOException;
import org.junit.Test;
import fr.bigeon.gclc.exception.CommandRunException;
import fr.bigeon.gclc.exception.InvalidCommandName;
import fr.bigeon.gclc.manager.ConsoleManager;
import fr.bigeon.gclc.manager.PipedConsoleManager;
/** <p>
* TODO
*
* @author Emmanuel Bigeon */
@SuppressWarnings("all")
public class SubedCommandTest {
/** Test method for
* {@link fr.bigeon.gclc.command.SubedCommand#SubedCommand(java.lang.String)}. */
@Test
public final void testSubedCommandString() {
SubedCommand cmd = new SubedCommand("name");
assertEquals("name", cmd.getCommandName());
cmd = new SubedCommand("name with spaces");
assertNull(cmd.tip());
assertEquals("name with spaces", cmd.getCommandName());
}
/** Test method for
* {@link fr.bigeon.gclc.command.SubedCommand#SubedCommand(java.lang.String, fr.bigeon.gclc.command.ICommand)}. */
@Test
public final void testSubedCommandStringICommand() {
SubedCommand cmd = new SubedCommand("name", new MockCommand(""));
assertEquals("name", cmd.getCommandName());
cmd = new SubedCommand("name with spaces", new MockCommand(""));
assertNull(cmd.tip());
assertEquals("name with spaces", cmd.getCommandName());
}
/** Test method for
* {@link fr.bigeon.gclc.command.SubedCommand#SubedCommand(java.lang.String, fr.bigeon.gclc.command.ICommand, java.lang.String)}. */
@Test
public final void testSubedCommandStringICommandString() {
SubedCommand cmd = new SubedCommand("name", new MockCommand(""), "tip");
assertEquals("name", cmd.getCommandName());
cmd = new SubedCommand("name with spaces", new MockCommand(""), "tip");
assertEquals("name with spaces", cmd.getCommandName());
}
/** Test method for
* {@link fr.bigeon.gclc.command.SubedCommand#SubedCommand(java.lang.String, java.lang.String)}. */
@Test
public final void testSubedCommandStringString() {
SubedCommand cmd = new SubedCommand("name", "tip");
assertEquals("name", cmd.getCommandName());
cmd = new SubedCommand("name with spaces", "tip");
assertEquals("name with spaces", cmd.getCommandName());
}
/** Test method for
* {@link fr.bigeon.gclc.command.SubedCommand#add(fr.bigeon.gclc.command.ICommand)}. */
@Test
public final void testAdd() {
SubedCommand cmd = new SubedCommand("name");
try {
cmd.add(new MockCommand("id"));
} catch (InvalidCommandName e) {
fail("addition of command with valid id failed");
assertNotNull(e);
}
try {
cmd.add(new MockCommand("id"));
fail("addition of command with already used id succeeded");
} catch (InvalidCommandName e) {
//
assertNotNull(e);
}
try {
cmd.add(new MockCommand(""));
fail("addition of command with invalid id succeeded");
} catch (InvalidCommandName e) {
//
assertNotNull(e);
}
}
/** Test method for
* {@link fr.bigeon.gclc.command.SubedCommand#execute(java.lang.String[])}. */
@Test
public final void testExecute() {
SubedCommand cmd = new SubedCommand("name");
MockCommand mock = new MockCommand("id");
try {
cmd.add(mock);
cmd.add(new Command("fail") {
@Override
public String tip() {
return null;
}
@Override
public void execute(String... args) throws CommandRunException {
throw new CommandRunException("Failing command", null);
}
});
} catch (InvalidCommandName e) {
fail("addition of command with valid id failed");
assertNotNull(e);
}
try {
cmd.execute("id");
} catch (CommandRunException e) {
fail("Unexpected exception when running mock command");
assertNotNull(e);
}
try {
cmd.execute("fail");
fail("Fail command error should be re thrown");
} catch (CommandRunException e) {
assertNotNull(e);
assertEquals(cmd, e.getSource());
}
try {
cmd.execute();
fail("Request for inexistent default command should fail");
} catch (CommandRunException e) {
assertNotNull(e);
assertEquals(cmd, e.getSource());
}
cmd = new SubedCommand("name", mock);
try {
cmd.add(mock);
cmd.add(new Command("fail") {
@Override
public String tip() {
return null;
}
@Override
public void execute(String... args) throws CommandRunException {
throw new CommandRunException("Failing command", this);
}
});
} catch (InvalidCommandName e) {
fail("addition of command with valid id failed");
assertNotNull(e);
}
try {
cmd.execute("id");
} catch (CommandRunException e) {
fail("Unexpected exception when running mock command");
assertNotNull(e);
}
try {
cmd.execute("fail");
fail("Fail command error should be re thrown");
} catch (CommandRunException e) {
assertNotNull(e);
assertEquals(cmd.get("fail"), e.getSource());
}
try {
cmd.execute();
} catch (CommandRunException e) {
fail("Request for default command should execute default command");
assertNotNull(e);
}
}
/** Test method for
* {@link fr.bigeon.gclc.command.SubedCommand#executeSub(java.lang.String, java.lang.String[])}. */
@Test
public final void testExecuteSub() {
SubedCommand cmd = new SubedCommand("name");
MockCommand mock = new MockCommand("id");
try {
cmd.add(mock);
cmd.add(new Command("fail") {
@Override
public String tip() {
return null;
}
@Override
public void execute(String... args) throws CommandRunException {
throw new CommandRunException("Failing command", this);
}
});
} catch (InvalidCommandName e) {
fail("addition of command with valid id failed");
assertNotNull(e);
}
try {
cmd.executeSub("id");
} catch (CommandRunException e) {
fail("Unexpected exception when running mock command");
assertNotNull(e);
}
try {
cmd.executeSub("fail");
fail("Fail command error should be re thrown");
} catch (CommandRunException e) {
assertNotNull(e);
assertEquals(cmd.get("fail"), e.getSource());
}
}
/** Test method for
* {@link fr.bigeon.gclc.command.SubedCommand#get(java.lang.String)}. */
@Test
public final void testGet() {
SubedCommand cmd = new SubedCommand("name");
assertNull(cmd.get("id"));
MockCommand mock = new MockCommand("id");
try {
cmd.add(mock);
} catch (InvalidCommandName e) {
fail("addition of command with valid id failed");
assertNotNull(e);
}
assertEquals(mock, cmd.get("id"));
}
/** Test method for
* {@link fr.bigeon.gclc.command.SubedCommand#getCommandName()}. */
@Test
public final void testGetCommandName() {
SubedCommand cmd = new SubedCommand("name");
assertEquals("name", cmd.getCommandName());
cmd = new SubedCommand("name with spaces");
assertEquals("name with spaces", cmd.getCommandName());
cmd = new SubedCommand("name", "some tip");
assertEquals("name", cmd.getCommandName());
cmd = new SubedCommand("name", new MockCommand(""));
assertEquals("name", cmd.getCommandName());
cmd = new SubedCommand("name", new MockCommand(""), "some tip");
assertEquals("name", cmd.getCommandName());
}
/** Test method for
* {@link fr.bigeon.gclc.command.SubedCommand#help(fr.bigeon.gclc.manager.ConsoleManager, java.lang.String[])}. */
@Test
public final void testHelp() {
SubedCommand cmd = new SubedCommand("name");
ICommand mock = new MockCommand("id");
try {
cmd.add(mock);
} catch (InvalidCommandName e) {
fail("addition of command with valid id failed");
assertNotNull(e);
}
try (PipedConsoleManager manager = new PipedConsoleManager();
PipedConsoleManager manager2 = new PipedConsoleManager()) {
cmd.help(manager);
assertEquals("\tid", manager.readNextLine());
cmd.help(manager, "id");
cmd.help(manager, "inexistent");
} catch (IOException e) {
fail("Unexpected exception when running help");
assertNotNull(e);
}
cmd = new SubedCommand("name", mock);
try {
cmd.add(mock);
} catch (InvalidCommandName e) {
fail("addition of command with valid id failed");
assertNotNull(e);
}
try (PipedConsoleManager manager = new PipedConsoleManager();
PipedConsoleManager manager2 = new PipedConsoleManager()) {
cmd.help(manager);
assertEquals("\tid", manager.readNextLine());
} catch (IOException e) {
fail("Unexpected exception when running help");
assertNotNull(e);
}
mock = new ICommand() {
@Override
public String tip() {
return "tip";
}
@Override
public void help(ConsoleManager manager,
String... args) throws IOException {
//
}
@Override
public String getCommandName() {
return "id";
}
@Override
public void execute(String... args) throws CommandRunException {
//
}
};
cmd = new SubedCommand("name", mock);
try {
cmd.add(mock);
} catch (InvalidCommandName e) {
fail("addition of command with valid id failed");
assertNotNull(e);
}
try (PipedConsoleManager manager = new PipedConsoleManager();
PipedConsoleManager manager2 = new PipedConsoleManager()) {
cmd.help(manager);
assertEquals("\ttip", manager.readNextLine());
assertEquals("\tid: tip", manager.readNextLine());
} catch (IOException e) {
fail("Unexpected exception when running help");
assertNotNull(e);
}
}
/** Test method for {@link fr.bigeon.gclc.command.SubedCommand#tip()}. */
@Test
public final void testTip() {
SubedCommand cmd = new SubedCommand("name");
assertNull(cmd.tip());
cmd = new SubedCommand("name with spaces", new MockCommand(""), "tip");
assertEquals("tip", cmd.tip());
}
}

View File

@@ -0,0 +1,75 @@
/*
* Copyright Bigeon Emmanuel (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
*
* 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.
*/
/**
* gclc:fr.bigeon.gclc.exception.CommandRunExceptionTest.java
* Created on: Nov 19, 2016
*/
package fr.bigeon.gclc.exception;
import static org.junit.Assert.assertEquals;
import org.junit.Test;
import fr.bigeon.gclc.command.ICommand;
import fr.bigeon.gclc.command.MockCommand;
/**
* <p>
* TODO
*
* @author Emmanuel Bigeon
*
*/
public class CommandRunExceptionTest {
/**
* Test method for {@link fr.bigeon.gclc.exception.CommandRunException#getLocalizedMessage()}.
*/
@Test
public final void testGetLocalizedMessage() {
CommandRunException e;
ICommand cmd = new MockCommand("name");
String messageInner = "inner";
String message = "message";
e = new CommandRunException(message,
new CommandRunException(messageInner, new MockCommand("name")), //$NON-NLS-1$
cmd);
assertEquals(message + ": " + messageInner, e.getLocalizedMessage());
e = new CommandRunException(message, cmd);
assertEquals(message, e.getLocalizedMessage());
}
}

View File

@@ -0,0 +1,148 @@
/*
* Copyright Bigeon Emmanuel (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
*
* 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.
*/
/**
* gclc:fr.bigeon.gclc.manager.SystemConsoleManagerTest.java
* Created on: Nov 19, 2016
*/
package fr.bigeon.gclc.manager;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.io.IOException;
import java.io.InputStream;
import java.io.PipedInputStream;
import java.io.PipedOutputStream;
import java.io.PrintStream;
import java.nio.charset.Charset;
import org.junit.Test;
/** <p>
* TODO
*
* @author Emmanuel Bigeon */
public class SystemConsoleManagerTest {
/** Test method for
* {@link fr.bigeon.gclc.manager.SystemConsoleManager#prompt()}. */
@Test
public final void testPrompt() {
try {
PipedOutputStream outStream = new PipedOutputStream();
InputStream in = new PipedInputStream(outStream);
final PrintStream out = new PrintStream(outStream);
final String test = "test";
SystemConsoleManager manager = new SystemConsoleManager(System.out,
in, Charset.forName("UTF-8"));
Thread th = new Thread(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
out.println(test);
}
});
th.start();
assertEquals(test, manager.prompt());
th.join();
} catch (IOException | InterruptedException e) {
assertNull(e);
}
}
/** Test method for
* {@link fr.bigeon.gclc.manager.SystemConsoleManager#setPrompt(java.lang.String)}. */
@Test
public final void testSetPrompt() {
SystemConsoleManager manager = new SystemConsoleManager();
String prt = "++";
manager.setPrompt(prt);
assertEquals(prt, manager.getPrompt());
}
/** Test method for
* {@link fr.bigeon.gclc.manager.SystemConsoleManager#isClosed()}. */
@Test
public final void testIsClosed() {
try {
PipedOutputStream outStream = new PipedOutputStream();
InputStream in = new PipedInputStream(outStream);
final PrintStream out = new PrintStream(outStream);
final String test = "test";
SystemConsoleManager manager = new SystemConsoleManager(System.out,
in, Charset.forName("UTF-8"));
Thread th = new Thread(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
out.println(test);
}
});
th.start();
assertEquals(test, manager.prompt());
assertFalse(manager.isClosed());
manager.close();
assertTrue(manager.isClosed());
try {
manager.prompt();
fail("prompt on closed manager");
} catch (IOException e) {
assertNotNull(e);
}
try {
manager.println(test);
fail("prompt on closed manager");
} catch (IOException e) {
assertNotNull(e);
}
th.join();
} catch (IOException | InterruptedException e) {
assertNull(e);
}
}
}

View File

@@ -0,0 +1,67 @@
/*
* Copyright Bigeon Emmanuel (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
*
* 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.
*/
/**
* gclc:fr.bigeon.gclc.prompt.CLIPrompterMessagesTest.java
* Created on: Nov 19, 2016
*/
package fr.bigeon.gclc.prompt;
import static org.junit.Assert.assertEquals;
import org.junit.Test;
/**
* <p>
* TODO
*
* @author Emmanuel Bigeon
*
*/
public class CLIPrompterMessagesTest {
/**
* Test method for {@link fr.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, new Object[] {}));
}
}

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,141 @@
/*
* Copyright Bigeon Emmanuel (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
*
* 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.
*/
/**
* gclc:fr.bigeon.gclc.tools.AOutputForwardRunnableTest.java
* Created on: Dec 3, 2016
*/
package fr.bigeon.gclc.tools;
import static org.junit.Assert.assertEquals;
import java.io.IOException;
import org.junit.Test;
import fr.bigeon.gclc.manager.PipedConsoleManager;
/** <p>
* TODO
*
* @author Emmanuel Bigeon */
public class AOutputForwardRunnableTest {
/** <p>
* TODO
*
* @author Emmanuel Bigeon */
private final class AOutputForwardTestRunnable
extends AOutputForwardRunnable {
private int count = 2;
private String message;
/** @param manager */
private AOutputForwardTestRunnable(PipedConsoleManager manager) {
super(manager);
}
@Override
protected boolean isRunning() {
return count != 0;
}
@Override
protected void forwardLine(String m) {
// Do nothing
message = m;
synchronized (this) {
notify();
try {
wait();
} catch (InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}
/** @return the message */
public String getMessage() {
if (message == null) {
synchronized (this) {
try {
wait();
} catch (InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}
String m = message;
count--;
message = null;
synchronized (this) {
notify();
}
return m;
}
}
/** Test method for
* {@link fr.bigeon.gclc.tools.AOutputForwardRunnable#run()}. */
@Test
public final void testRun() {
try (PipedConsoleManager manager = new PipedConsoleManager()) {
AOutputForwardTestRunnable runnable = new AOutputForwardTestRunnable(
manager);
Thread th = new Thread(runnable, "forward");
manager.println("before");
th.start();
assertEquals("before", runnable.getMessage());
synchronized (this) {
wait(3000);
}
manager.println("after");
assertEquals("after", runnable.getMessage());
synchronized (this) {
wait(3000);
}
th.join();
} catch (IOException | InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}

View File

@@ -0,0 +1,94 @@
/*
* Copyright Bigeon Emmanuel (2014)
*
* emmanuel@bigeon.fr
*
* This software is a computer program whose purpose is to
* provide a generic framework for console applications.
*
* 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.
*/
/**
* gclc:fr.bigeon.gclc.tools.PrintUtilsTest.java
* Created on: Nov 19, 2016
*/
package fr.bigeon.gclc.tools;
import static org.junit.Assert.assertEquals;
import java.util.Arrays;
import org.junit.Test;
/** <p>
* TODO
*
* @author Emmanuel Bigeon */
public class PrintUtilsTest {
/** Test method for
* {@link fr.bigeon.gclc.tools.PrintUtils#print(java.lang.String, int, boolean)}. */
@Test
public final void testPrint() {
String text = "Some text";
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(longText, text.length(), false));
assertEquals(text + "...",
PrintUtils.print(longText, text.length() + 3, true));
}
/** Test method for
* {@link fr.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()));
// 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()));
}
}

View File

@@ -2,4 +2,6 @@
test
# and comments
long
# interwined
# interwined
# with empty line too

View File

@@ -0,0 +1,2 @@
# a script invoking a failing command
failingCmd

View File

@@ -0,0 +1,2 @@
# a script with invalid commands
invalid

View File

@@ -0,0 +1,2 @@
# a script with invalid commands
test "po"m

View File

@@ -0,0 +1,3 @@
# a script with space in begining
test
should never be reached