Compare commits

..

66 Commits

Author SHA1 Message Date
ce4254941a [maven-release-plugin] prepare release gclc-2.1.1 2019-05-06 20:00:25 -04:00
f459f78a75 #2 add removal of escaped character from last argument in line.
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2019-05-06 19:53:55 -04:00
8cd0b01490 [maven-release-plugin] prepare for next development iteration 2019-04-22 17:52:41 -04:00
698b3d0e5e [maven-release-plugin] prepare release socket-1.1.18 2019-04-22 17:52:38 -04:00
9ad4a1e456 Add accesses to the listener list
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2019-04-22 17:52:18 -04:00
e560fcb92d [maven-release-plugin] prepare for next development iteration 2019-04-22 17:46:19 -04:00
56f3d604a1 [maven-release-plugin] prepare release socket-1.1.17 2019-04-22 17:46:16 -04:00
73317186df Update tests
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2019-04-22 17:45:40 -04:00
80bd7c0ac9 Add listener for brutal disconnection
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2019-04-22 17:44:23 -04:00
dc71070dab [maven-release-plugin] prepare for next development iteration 2019-04-22 16:07:42 -04:00
78b5926af1 [maven-release-plugin] prepare release socket-1.1.16 2019-04-22 16:07:39 -04:00
a3d2c2c07e Update disconnection
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2019-04-22 16:04:40 -04:00
9df812273c [maven-release-plugin] prepare for next development iteration 2019-04-22 15:33:47 -04:00
e953c2e659 [maven-release-plugin] prepare release socket-1.1.15 2019-04-22 15:33:44 -04:00
0f4fd6109d Stop console closing on client dirty disconnection
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2019-04-22 15:29:11 -04:00
69a8fd2533 [maven-release-plugin] prepare for next development iteration 2019-04-14 17:20:28 -04:00
0b772ddeb3 [maven-release-plugin] prepare release swt-1.2.0 2019-04-14 17:20:24 -04:00
55f13ae004 Use public configuration
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2019-04-14 17:19:44 -04:00
295075ca37 Update versions and configuration
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2019-04-14 17:14:04 -04:00
75bbba9884 [maven-release-plugin] prepare for next development iteration 2019-04-14 17:10:09 -04:00
82daa84bdf [maven-release-plugin] prepare release socket-1.1.14 2019-04-14 17:10:05 -04:00
10a0858d81 Update configuration
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2019-04-14 17:07:04 -04:00
dfd3645497 Update configuration
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2019-04-14 17:03:57 -04:00
bd2da741f2 [maven-release-plugin] prepare for next development iteration 2019-04-02 09:41:05 -04:00
314db5b82f [maven-release-plugin] prepare release process-0.0.6 2019-04-02 09:40:56 -04:00
981668d3a7 Update dependency on collections
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2019-02-13 13:19:11 -05:00
9c8866827d Reduce prompting method complexity
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-12-03 11:25:01 -05:00
43c9faaee7 Added test for interruption and task failure
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-12-03 11:12:23 -05:00
8436e8926c Factor prompting methods code
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-12-03 11:12:13 -05:00
0cef23e17b Reduce branching depth
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-12-02 14:19:54 -05:00
6b2a25674d Fix interruption mechanic
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-12-02 13:57:48 -05:00
eec660e089 Improved message to test failure
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-12-02 13:57:21 -05:00
901469792d Added interruption flag
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-12-02 13:33:15 -05:00
79ee5394d4 Move inner classes into tool package
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-12-02 13:32:29 -05:00
acf4484eb3 [maven-release-plugin] prepare for next development iteration 2018-12-01 12:04:16 -05:00
012ef6e668 [maven-release-plugin] prepare release gclc-2.1.0 2018-12-01 12:04:13 -05:00
583f3146fd Removed declaration of runtime exception
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-12-01 12:01:44 -05:00
8b52ba5d49 Licensing
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-12-01 11:48:34 -05:00
a3051c6f03 Update next release version.
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-12-01 11:48:07 -05:00
18b98997d3 Move console IO implemetations. #1 fixed
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-12-01 11:45:16 -05:00
0e1c69dab7 Moved output forward runnable
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-12-01 11:38:53 -05:00
c206b5b22c Changed prompt interruption contract
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-12-01 10:54:51 -05:00
c4bbfd8434 Moved console input/output implementations
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-12-01 10:54:30 -05:00
b671474f64 Added a delai for the task initialization
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-11-30 22:56:51 -05:00
6443790532 Change port for test server
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-11-30 22:35:38 -05:00
2df99debf8 Added test. removed implementation of shell
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-11-30 22:31:45 -05:00
d87aabd465 Change internal classes as private definitions
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-11-30 22:03:43 -05:00
0562faad70 Javadoc
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-11-30 22:02:44 -05:00
bb06b2a799 Removed suppress warning
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-11-30 21:56:08 -05:00
626f557aa0 Warning removal
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-11-30 21:47:10 -05:00
185d19bfcf Added documentation
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-11-30 21:35:17 -05:00
7fd1bf90bd Remove unused attributes
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-11-30 21:32:20 -05:00
1fa1f168c8 Added documentation
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-11-30 21:30:13 -05:00
09e9c69fe0 Use inet address rather than host name
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-11-30 16:02:22 -05:00
9f273f7595 Fix host name in test
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-11-30 14:18:50 -05:00
143eb7036a Added junit dependency, added input contract
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-11-30 12:18:16 -05:00
9c64c708eb Removed uneeded line
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-11-30 12:17:53 -05:00
8449eddab8 Extract model of view from graphics of view
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-11-30 12:17:38 -05:00
d0a286d45a Allow access to output forward to subclasses
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-11-30 10:44:05 -05:00
d6698a22fb Initial sharing of test. Moved gitignore to global ignore
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-11-30 09:21:46 -05:00
5e1050a9d7 Update test server to use getLocalHost rather than loopback.
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-11-30 09:05:40 -05:00
9374c5a681 Added message notifications.
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-11-26 10:40:40 -05:00
4c1e28b04f Update gclc version
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-11-25 12:07:04 -05:00
80933bb636 Update test
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-11-25 12:03:06 -05:00
48b4375565 removed logger
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2018-11-25 12:03:00 -05:00
ba7b80689c [maven-release-plugin] prepare for next development iteration 2018-11-25 12:00:44 -05:00
77 changed files with 2291 additions and 1378 deletions

6
.gitignore vendored Normal file
View File

@@ -0,0 +1,6 @@
# maven files
target/
# Eclipse files
.settings/
.classpath
.project

View File

@@ -8,7 +8,7 @@
<groupId>net.bigeon.gclc</groupId>
<artifactId>process</artifactId>
<version>0.0.6-SNAPSHOT</version>
<version>0.0.7-SNAPSHOT</version>
<packaging>jar</packaging>
<name>process</name>
@@ -49,7 +49,7 @@
<dependency>
<groupId>net.bigeon</groupId>
<artifactId>gclc</artifactId>
<version>2.0.11</version>
<version>2.1.0</version>
</dependency>
<dependency>
<groupId>net.bigeon.test</groupId>

View File

@@ -68,11 +68,11 @@ package net.bigeon.gclc.process.io;
* #L%
*/
import java.io.IOException;
import java.util.logging.Logger;
import java.io.InterruptedIOException;
import java.util.function.Supplier;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.tools.ConstantString;
import net.bigeon.gclc.tools.StringProvider;
/** A console input that can be connected to and diconnected from.
*
@@ -81,30 +81,29 @@ public final class ConnectingConsoleInput implements ConsoleInput {
/** The empty string provider. */
private static final ConstantString EMPTY_STRING = new ConstantString("");
/** The logger. */
private static final Logger LOGGER = Logger
.getLogger(ConnectingConsoleInput.class.getName());
/** If the input is closed. */
private boolean close = false;
private boolean close = false;
/** The prompt string. */
private StringProvider prompt = EMPTY_STRING;
private Supplier<String> prompt = EMPTY_STRING;
/** If the input is currently in prompting state.
* <p>
* To change it you should be in a promptLock. */
private boolean prompting = false;
private boolean prompting = false;
/** The synchronization lock for the prompting status. */
private final Object promptLock = new Object();
private final Object promptLock = new Object();
/** The synchronization lock for the connection status. */
private final Object connectionLock = new Object();
private final Object connectionLock = new Object();
/** The connected console input.
* <p>
* To use it, you should be in a promptLock and connectionLock. */
private ConsoleInput connected = null;
private ConsoleInput connected = null;
/** The connection state.
* <p>
* To read or modify it, you should be in a connectionLock synchronize block. */
private boolean disconnection = false;
private boolean disconnection = false;
private boolean interrupting = false;
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#close() */
@@ -143,7 +142,7 @@ public final class ConnectingConsoleInput implements ConsoleInput {
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#getPrompt() */
@Override
public StringProvider getPrompt() {
public Supplier<String> getPrompt() {
return prompt;
}
@@ -153,6 +152,9 @@ public final class ConnectingConsoleInput implements ConsoleInput {
public void interruptPrompt() {
synchronized (connectionLock) {
synchronized (promptLock) {
if (prompting) {
interrupting = true;
}
connectionLock.notifyAll();
if (connected != null) {
connected.interruptPrompt();
@@ -174,14 +176,14 @@ public final class ConnectingConsoleInput implements ConsoleInput {
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt() */
@Override
public String prompt() throws IOException {
return prompt(prompt.apply());
return prompt(prompt.get());
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(long) */
@Override
public String prompt(final long timeout) throws IOException {
return prompt(prompt.apply(), timeout);
return prompt(prompt.get(), timeout);
}
/* (non-Javadoc)
@@ -191,32 +193,7 @@ public final class ConnectingConsoleInput implements ConsoleInput {
synchronized (promptLock) {
prompting = true;
}
while (true) {
synchronized (promptLock) {
if (!prompting) {
return null;
}
}
getConnection(0);
boolean connect;
ConsoleInput actualConnected;
synchronized (connectionLock) {
connect = connected != null;
actualConnected = connected;
}
if (connect) {
final String res = actualConnected.prompt(message);
synchronized (promptLock) {
if (disconnection) {
disconnection = false;
} else if (prompting) {
return res;
} else {
// prompt interrupted, lose the result.
}
}
}
}
return doPrompt(message, 0, 0);
}
/* (non-Javadoc)
@@ -226,42 +203,89 @@ public final class ConnectingConsoleInput implements ConsoleInput {
if (timeout <= 0) {
return prompt(message);
}
final long end = System.currentTimeMillis() + timeout;
synchronized (promptLock) {
prompting = true;
}
final long tic = System.currentTimeMillis();
return doPrompt(message, timeout, tic);
}
private String doPrompt(final String message, final long timeout, final long tic)
throws IOException {
do {
synchronized (promptLock) {
if (!prompting) {
break;
}
if (!checkPrompt()) {
break;
}
getConnection(timeout);
getConnection(getTimeoutLeft(tic, timeout));
boolean connect;
ConsoleInput actualConnected;
synchronized (connectionLock) {
connect = connected != null;
actualConnected = connected;
}
if (connect) {
if (!connect) {
continue;
}
try {
final String res = actualPrompt(message, timeout, tic, actualConnected);
synchronized (promptLock) {
final String res = actualConnected.prompt(message,
end - System.currentTimeMillis());
if (disconnection) {
disconnection = false;
} else if (prompting) {
if (prompting) {
prompting = false;
return res;
} else {
// prompt interrupted, lose the result.
}
}
} catch (final InterruptedIOException e) {
// The inner console was interrupted. This can mean we are
// disconnecting or actually interrupted.
if (disconnection) {
disconnection = false;
} else {
interrupting = false;
throw e;
}
}
} while (System.currentTimeMillis() < end);
} while (checkTimeout(tic, timeout));
return null;
}
private void getConnection(final long timeout) {
private static String actualPrompt(final String message, final long timeout,
final long tic, final ConsoleInput actualConnected) throws IOException {
final long timeoutLeft = getTimeoutLeft(tic, timeout);
if (timeoutLeft == 0) {
return actualConnected.prompt(message);
}
return actualConnected.prompt(message, timeoutLeft);
}
private static boolean checkTimeout(final long tic, final long timeout) {
return timeout <= 0 || tic + timeout > System.currentTimeMillis();
}
private static long getTimeoutLeft(final long tic, final long timeout) {
if (timeout > 0) {
return Math.max(timeout + tic - System.currentTimeMillis(), 1);
}
if (timeout < 0) {
return 1;
}
return 0;
}
/** Test if we are in prompting state.
*
* @return if the process is currently in prompting state.
* @throws InterruptedIOException if the prompting state has been interrupted */
private boolean checkPrompt() throws InterruptedIOException {
synchronized (promptLock) {
if (!prompting && interrupting) {
interrupting = false;
throw new InterruptedIOException("Prompt was interrupted");
}
return prompting;
}
}
private void getConnection(final long timeout) throws InterruptedIOException {
boolean connect;
synchronized (connectionLock) {
connect = connected != null;
@@ -272,6 +296,10 @@ public final class ConnectingConsoleInput implements ConsoleInput {
Thread.currentThread().interrupt();
}
}
if (interrupting) {
interrupting = false;
throw new InterruptedIOException("Prompt ws interrupted");
}
}
}
@@ -286,7 +314,7 @@ public final class ConnectingConsoleInput implements ConsoleInput {
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(fr.bigeon.gclc.tools.
* StringProvider) */
@Override
public void setPrompt(final StringProvider string) {
public void setPrompt(final Supplier<String> string) {
prompt = string;
}
}

View File

@@ -5,15 +5,18 @@ package net.bigeon.gclc.process;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import java.io.IOException;
import java.util.concurrent.atomic.AtomicBoolean;
import org.junit.Test;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.CommandRunExceptionType;
import net.bigeon.gclc.utils.PipedConsoleInput;
import net.bigeon.gclc.utils.PipedConsoleOutput;
import net.bigeon.gclc.manager.PipedConsoleInput;
import net.bigeon.gclc.manager.PipedConsoleOutput;
/** @author Emmanuel Bigeon */
public class ForkTaskTest {
@@ -36,27 +39,118 @@ public class ForkTaskTest {
throw new CommandRunException(CommandRunExceptionType.INTERACTION,
"Unable to prompt user");
}
if ("ok".equals(msg)) {
out.println("Message");
} else {
out.println("fail");
}
out.println(msg);
}
};
final Thread execThread = new Thread(task);
final Thread execThread = new Thread(task, "Task");
execThread.start();
try {
execThread.join(100);
} catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
try (PipedConsoleOutput pco = new PipedConsoleOutput();
PipedConsoleInput pci = new PipedConsoleInput(null)) {
pci.type("ok");
while (!pco.available()) {
pci.type("ok");
task.join(pco, pci, 1000);
}
assertEquals("Execution should work", "Message", pco.readNextLine());
assertEquals("Positive execution", "ok", pco.readNextLine());
}
assertFalse("Running state should be updated by task on its completion",
task.isRunning());
}
@Test
public void testTaskInterruption() throws IOException, InterruptedException {
final ForkTask task = new ForkTask(5) {
@Override
public String getName() {
return "name";
}
@Override
protected void doRun() throws CommandRunException {
while (isRunning()) {
String msg;
try {
msg = in.prompt(1000);
} catch (final IOException e) {
throw new CommandRunException(CommandRunExceptionType.INTERACTION,
"Unable to prompt user");
}
if (msg != null) {
out.println(msg);
}
}
}
};
final Thread execThread = new Thread(task, "Task");
execThread.start();
execThread.join(100);
final AtomicBoolean interrupted = new AtomicBoolean(false);
final AtomicBoolean interrupted2 = new AtomicBoolean(false);
final InterruptionListener listener = new InterruptionListener() {
@Override
public void interrupted() {
interrupted.set(true);
}
};
final InterruptionListener listener2 = new InterruptionListener() {
@Override
public void interrupted() {
interrupted2.set(true);
}
};
task.addInterruptionListener(listener);
task.addInterruptionListener(listener2);
task.rmInterruptionListener(listener2);
assertFalse("Interruption should not be notified before actual interruption",
interrupted.get());
assertTrue("Task should be started", task.isStarted());
task.setRunning(false);
try (PipedConsoleOutput pco = new PipedConsoleOutput();
PipedConsoleInput pci = new PipedConsoleInput(null)) {
task.join(pco, pci, 2000);
}
execThread.join();
assertTrue("Interruption should be notified to listeners", interrupted.get());
assertFalse("Running state should be updated by task on its completion",
task.isRunning());
assertFalse("Interruption should not be notified to removed listeners",
interrupted2.get());
task.rmInterruptionListener(listener);
}
@Test
public void testFailingTask() throws InterruptedException {
final ForkTask task = new ForkTask(5) {
@Override
public String getName() {
return "name";
}
@Override
protected void doRun() throws CommandRunException {
throw new CommandRunException("Error");
}
};
final Thread execThread = new Thread(task, "Task");
execThread.start();
execThread.join();
assertNotNull("Exception should be forwarded", task.getException());
}
}

View File

@@ -14,8 +14,8 @@ import org.junit.Test;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.CommandRunExceptionType;
import net.bigeon.gclc.manager.PipedConsoleOutput;
import net.bigeon.gclc.process.mocks.TaskMock;
import net.bigeon.gclc.utils.PipedConsoleOutput;
/** @author Emmanuel Bigeon */
public class ProcessListTest {

View File

@@ -4,8 +4,10 @@ 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 static org.junit.Assert.fail;
import java.io.IOException;
import java.io.InterruptedIOException;
import java.io.PipedInputStream;
import java.io.PipedOutputStream;
import java.nio.charset.StandardCharsets;
@@ -13,9 +15,9 @@ import java.util.concurrent.atomic.AtomicBoolean;
import org.junit.Test;
import net.bigeon.gclc.manager.PipedConsoleInput;
import net.bigeon.gclc.manager.StreamConsoleInput;
import net.bigeon.gclc.tools.ConstantString;
import net.bigeon.gclc.utils.PipedConsoleInput;
import net.bigeon.gclc.utils.StreamConsoleInput;
import net.bigeon.test.junitmt.ATestRunnable;
import net.bigeon.test.junitmt.FunctionalTestRunnable;
import net.bigeon.test.junitmt.TestFunction;
@@ -66,7 +68,7 @@ public class ConnectingConsoleInputTest {
final ConnectingConsoleInput in = new ConnectingConsoleInput();
in.setPrompt("test");
assertEquals("Prompt should be set correctly", "test",
((ConstantString) in.getPrompt()).apply());
((ConstantString) in.getPrompt()).get());
final ConstantString prompt = new ConstantString("other");
in.setPrompt(prompt);
assertEquals("Prompt should be set correctly", prompt, in.getPrompt());
@@ -81,10 +83,28 @@ public class ConnectingConsoleInputTest {
@Override
public void apply() throws Exception {
assertNull("Interrupted should return null", in.prompt("m1", -1));
assertNull("Interrupted should return null", in.prompt("m2", 5000));
ended.set(true);
assertNull("Overtime should return null", in.prompt("m3", 200));
try {
final String res = in.prompt("m1", -1);
fail("interruption of infinite waiting prompt should cause error, but was "
+ res);
} catch (final InterruptedIOException e) {
// ok
}
try {
final String res = in.prompt("m2", 25000);
fail("interruption of finite waiting prompt should cause error, but was "
+ res);
} catch (final InterruptedIOException e) {
// ok
}
synchronized (ended) {
ended.set(true);
try {
assertNull("Overtime should return null", in.prompt("m3", 200));
} catch (final InterruptedIOException e) {
fail("Unexpected interruption error in overtime");
}
}
}
};
final ATestRunnable runnable = new FunctionalTestRunnable(one);
@@ -95,12 +115,16 @@ public class ConnectingConsoleInputTest {
public void run() {
while (!ended.get()) {
try {
th.join(500);
th.join(100);
} catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
in.interruptPrompt();
synchronized (ended) {
if (!ended.get()) {
in.interruptPrompt();
}
}
}
}
});
@@ -112,7 +136,7 @@ public class ConnectingConsoleInputTest {
final PipedOutputStream os = new PipedOutputStream();
final PipedInputStream pis = new PipedInputStream(os);
in.connect(new StreamConsoleInput(System.out, pis, StandardCharsets.UTF_8));
in.connect(new StreamConsoleInput(null, pis, StandardCharsets.UTF_8));
final ATestRunnable runnable2 = new FunctionalTestRunnable(one);
final Thread th2 = new Thread(runnable2);
final Thread inter2 = new Thread(new Runnable() {
@@ -121,12 +145,16 @@ public class ConnectingConsoleInputTest {
public void run() {
while (!ended.get()) {
try {
th2.join(500);
th2.join(100);
} catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
in.interruptPrompt();
synchronized (ended) {
if (!ended.get()) {
in.interruptPrompt();
}
}
}
}
});

View File

@@ -8,7 +8,7 @@ import java.io.IOException;
import org.junit.Test;
import net.bigeon.gclc.utils.PipedConsoleOutput;
import net.bigeon.gclc.manager.PipedConsoleOutput;
public class ConnectingConsoleOutputTest {

View File

@@ -2,12 +2,12 @@
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>net.bigeon.config</groupId>
<artifactId>ebigeon-config</artifactId>
<version>1.8.21</version>
<artifactId>ebigeon-public-conf</artifactId>
<version>1.0.10</version>
</parent>
<groupId>net.bigeon.gclc</groupId>
<artifactId>socket</artifactId>
<version>1.1.14-SNAPSHOT</version>
<version>1.1.19-SNAPSHOT</version>
<packaging>jar</packaging>
<name>GCLC Socket</name>
<description>Socket implementation of GCLC</description>
@@ -40,24 +40,23 @@
</scm>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.scm.id>git.code.bigeon.net</project.scm.id>
<license.licenseName>cecill_2.1</license.licenseName>
</properties>
<dependencies>
<dependency>
<groupId>net.bigeon</groupId>
<artifactId>gclc</artifactId>
<version>2.0.11</version>
<version>2.1.0</version>
</dependency>
<dependency>
<groupId>net.bigeon</groupId>
<artifactId>smu</artifactId>
<version>1.0.6</version>
<version>1.0.7</version>
</dependency>
<dependency>
<groupId>net.bigeon.test</groupId>
<artifactId>junitmt</artifactId>
<version>1.0.0</version>
<version>1.0.2</version>
<scope>test</scope>
</dependency>
</dependencies>

View File

@@ -0,0 +1,14 @@
/**
*
*/
package net.bigeon.gclc.socket;
/** Interface for listener of brutal disconnection from a pluggable
* input/output.
*
* @author Emmanuel Bigeon */
@FunctionalInterface
public interface DisconnexionListener {
/** Indicate a brutal disconnection */
void disconnected();
}

View File

@@ -41,14 +41,17 @@ import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.InterruptedIOException;
import java.io.PrintStream;
import java.nio.charset.StandardCharsets;
import java.util.HashSet;
import java.util.Set;
import java.util.function.Supplier;
import java.util.logging.Level;
import java.util.logging.Logger;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.tools.ConstantString;
import net.bigeon.gclc.tools.StringProvider;
import net.bigeon.gclc.utils.ReadingRunnable;
/** A console input where the stream can be plugged.
@@ -75,7 +78,7 @@ public final class PluggableConsoleInput implements ConsoleInput {
/** If the element is closed. */
private boolean closed = false;
/** The default prompt. */
private StringProvider prompt = new ConstantString("> "); //$NON-NLS-1$
private Supplier<String> prompt = new ConstantString("> "); //$NON-NLS-1$
/** If the input is plugged or buffering. */
private boolean connected = false;
/** The current connexion (if any). */
@@ -87,6 +90,8 @@ public final class PluggableConsoleInput implements ConsoleInput {
/** The output for hints. */
private PrintStream output;
private final Set<DisconnexionListener> listeners = new HashSet<>();
// Locks
/** The lock for connexion and disconnexion of actual streams. */
private final Object connexionLock = new Object();
@@ -119,6 +124,7 @@ public final class PluggableConsoleInput implements ConsoleInput {
if (prompting) {
// print the hint, to indicate we are waiting for a user input.
out.print(hint);
out.println();
out.flush();
}
final InputStreamReader streamReader = new InputStreamReader(stream,
@@ -146,7 +152,7 @@ public final class PluggableConsoleInput implements ConsoleInput {
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#getPrompt() */
@Override
public StringProvider getPrompt() {
public Supplier<String> getPrompt() {
return prompt;
}
@@ -175,14 +181,14 @@ public final class PluggableConsoleInput implements ConsoleInput {
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt() */
@Override
public String prompt() throws IOException {
return prompt(prompt.apply());
return prompt(prompt.get());
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(long) */
@Override
public String prompt(final long timeout) throws IOException {
return prompt(prompt.apply(), timeout);
return prompt(prompt.get(), timeout);
}
/* (non-Javadoc)
@@ -264,7 +270,7 @@ public final class PluggableConsoleInput implements ConsoleInput {
* @see net.bigeon.gclc.manager.ConsoleInput#setPrompt(net.bigeon.gclc.tools.
* StringProvider) */
@Override
public void setPrompt(final StringProvider prompt) {
public void setPrompt(final Supplier<String> prompt) {
this.prompt = prompt;
}
@@ -279,10 +285,48 @@ public final class PluggableConsoleInput implements ConsoleInput {
final long connexionTimeout) throws IOException, InterruptedException {
synchronized (connexionLock) {
if (connected) {
return connexion.getNextMessage(messageTimeout);
try {
return connexion.getNextMessage(messageTimeout);
} catch (final InterruptedIOException e) {
throw e;
} catch (final IOException e) {
LOGGER.log(Level.INFO, "Communication was abrubptly interrupted", e);
brutalDisconnection();
}
}
connexionLock.wait(connexionTimeout);
}
return null;
}
/**
*
*/
private void brutalDisconnection() {
// clean up the disconnection
disconnect();
// notify listeners
for (final DisconnexionListener listener : listeners) {
listener.disconnected();
}
}
/** Add a listener to the list of listeners.
*
* @param e the listener
* @return if the listener was added
* @see java.util.Set#add(java.lang.Object) */
public boolean add(final DisconnexionListener e) {
return listeners.add(e);
}
/** Remove a listener from the list of listeners.
*
* @param o the listener
* @return if the listener was removed
* @see java.util.Set#remove(java.lang.Object) */
public boolean remove(final DisconnexionListener o) {
return listeners.remove(o);
}
}

View File

@@ -50,7 +50,10 @@ import net.bigeon.gclc.manager.ConsoleOutput;
/** A {@link Command} to disconnect elements from a {@link ConnexionManager}.
*
* @author Emmanuel Bigeon
* @param <T> the type of connected object */
* @param <T> the type of connected object
* @deprecated since 1.1.17, this has been moved to
* {@link RemoteDisconnectCommand}. */
@Deprecated
public final class RemoteDisconnectCommand<T> extends Command {
/** The connexion manager. */

View File

@@ -0,0 +1,98 @@
/**
* gclc-socket:net.bigeon.gclc.socket.RemoteDisconnectCommand.java
* Created on: Nov 18, 2017
*/
package net.bigeon.gclc.socket.cmd;
/*-
* #%L
* GCLC Socket
* %%
* Copyright (C) 2016 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.IOException;
import java.util.Collection;
import net.bigeon.gclc.command.Command;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.CommandRunExceptionType;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
import net.bigeon.gclc.socket.ConnexionManager;
/** A {@link Command} to disconnect elements from a {@link ConnexionManager}.
*
* @author Emmanuel Bigeon
* @param <T> the type of connected object */
public final class ConnexionListCommand<T> extends Command {
/** The connexion manager. */
private final ConnexionManager<T> manager;
/** Create the connexion listing command.
*
* @param name the command name
* @param manager the manager */
public ConnexionListCommand(final String name, final ConnexionManager<T> manager) {
super(name);
this.manager = manager;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
final Collection<String> coll = manager.getConnected();
try {
for (final String string : coll) {
out.println(string);
}
} catch (final IOException e) {
throw new CommandRunException(CommandRunExceptionType.INTERACTION,
"User cannot be notified", e);
}
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@Override
public String tip() {
return "List current connexions."; //$NON-NLS-1$
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
return "";
}
}

View File

@@ -0,0 +1,130 @@
/**
* gclc-socket:net.bigeon.gclc.socket.RemoteDisconnectCommand.java
* Created on: Nov 18, 2017
*/
package net.bigeon.gclc.socket.cmd;
/*-
* #%L
* GCLC Socket
* %%
* Copyright (C) 2016 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.IOException;
import java.text.MessageFormat;
import java.util.Collection;
import net.bigeon.gclc.command.Command;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.CommandRunExceptionType;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
import net.bigeon.gclc.socket.ConnexionManager;
/** A {@link Command} to disconnect elements from a {@link ConnexionManager}.
*
* @author Emmanuel Bigeon
* @param <T> the type of connected object */
public final class RemoteDisconnectCommand<T> extends Command {
/** The connexion manager. */
private final ConnexionManager<T> manager;
/** If all connexion should be disconnected when no argument have been
* specified. */
private final boolean all;
/** Create the disconnection command.
*
* @param name the command name
* @param manager the manager
* @param all if all elements should be disconnected when no argument is
* provided */
public RemoteDisconnectCommand(final String name, final ConnexionManager<T> manager,
final boolean all) {
super(name);
this.manager = manager;
this.all = all;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
if (args.length == 0 && all) {
final Collection<String> coll = manager.getConnected();
for (final String string : coll) {
manager.disconnect(string);
}
}
for (final String string : args) {
if (manager.isConnected(string)) {
manager.disconnect(string);
} else {
print(out,
MessageFormat.format("[WARNING] {0} is not connected", string)); //$NON-NLS-1$
}
}
}
/** Print a message if the output is defined.
*
* @param out the output
* @param string the message
* @throws CommandRunException if the output exists but cannot be printed to */
private static void print(final ConsoleOutput out, final String string)
throws CommandRunException {
if (out != null) {
try {
out.println(string);
} catch (final IOException e) {
throw new CommandRunException(CommandRunExceptionType.INTERACTION,
"Unable to print to existing output", e); //$NON-NLS-1$
}
}
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@Override
public String tip() {
return "Close a connexion."; //$NON-NLS-1$
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
return MessageFormat.format(
" If arguments are provided the corresponding connexions are closed, otherwise\n{0} are.",
all ? "all connexions" : "none");
}
}

View File

@@ -0,0 +1,8 @@
/**
*
*/
/**
* @author Emmanuel Bigeon
*
*/
package net.bigeon.gclc.socket.cmd;

View File

@@ -90,7 +90,7 @@ public class PluggableConsoleInputTest {
}
try {
Object obj = new Object();
final Object obj = new Object();
synchronized (obj) {
obj.wait(100);
}
@@ -115,7 +115,7 @@ public class PluggableConsoleInputTest {
@Override
public void run() {
try {
Object obj = new Object();
final Object obj = new Object();
synchronized (obj) {
obj.wait(200);
}
@@ -168,7 +168,7 @@ public class PluggableConsoleInputTest {
});
th.start();
Object obj = new Object();
final Object obj = new Object();
synchronized (obj) {
while (!input.isPrompting()) {
obj.wait(10);
@@ -211,8 +211,8 @@ public class PluggableConsoleInputTest {
@Test
public final void testGetPrompt() {
final PluggableConsoleInput input = new PluggableConsoleInput();
assertEquals("Default prompt invalid", "> ", input.getPrompt().apply());
assertEquals("Default prompt invalid", "> ", input.getPrompt().get());
input.setPrompt("test");
assertEquals("Prompt setting failed", "test", input.getPrompt().apply());
assertEquals("Prompt setting failed", "test", input.getPrompt().get());
}
}

View File

@@ -43,6 +43,7 @@ import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.net.InetAddress;
import java.net.Socket;
import java.util.logging.Logger;
@@ -76,8 +77,8 @@ public class SocketConsoleApplicationTest {
public void testIntegration() throws IOException, InterruptedException {
Thread server;
server = TestServer.getServer();
final String hostName = "127.0.0.1";
final int portNumber = 12345;
final InetAddress hostName = InetAddress.getLocalHost();
final int portNumber = TestServer.PORT;
try (Socket kkSocket = new Socket(hostName, portNumber);
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(), true);

View File

@@ -46,7 +46,7 @@ import net.bigeon.gclc.ConsoleApplication;
@SuppressWarnings({ "javadoc", "nls" })
public class TestServer {
public static final int PORT = 3300;
public static final int PORT = 12343;
private static SocketConsoleApplicationShell SHELL;
private static ConnexionManager<Socket> manager;
@@ -76,8 +76,7 @@ public class TestServer {
input.setPrompt("> \n");
output = new PluggableConsoleOutput();
manager = new DConnexionManager<>();
SHELL = new SocketConsoleApplicationShell(PORT,
InetAddress.getByName("127.0.0.1"));
SHELL = new SocketConsoleApplicationShell(PORT, InetAddress.getLocalHost());
final ConsoleApplication app = ConsoleTestApplication.create(output, input,
manager);
SHELL.setInterface(new SocketConsoleInterface(input, output));

View File

@@ -2,7 +2,7 @@
* gclc-socket:net.bigeon.gclc.socket.RemoteDisconnectCommandTest.java
* Created on: Nov 18, 2017
*/
package net.bigeon.gclc.socket;
package net.bigeon.gclc.socket.cmd;
/*-
* #%L
@@ -46,7 +46,8 @@ import java.io.IOException;
import org.junit.Test;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.utils.PipedConsoleOutput;
import net.bigeon.gclc.manager.PipedConsoleOutput;
import net.bigeon.gclc.socket.DConnexionManager;
/**
* <p>
@@ -56,7 +57,7 @@ import net.bigeon.gclc.utils.PipedConsoleOutput;
public class RemoteDisconnectCommandTest {
/** Test method for
* {@link net.bigeon.gclc.socket.RemoteDisconnectCommand#execute(net.bigeon.gclc.manager.ConsoleOutput, net.bigeon.gclc.manager.ConsoleInput, java.lang.String[])}.
* {@link net.bigeon.gclc.socket.cmd.RemoteDisconnectCommand#execute(net.bigeon.gclc.manager.ConsoleOutput, net.bigeon.gclc.manager.ConsoleInput, java.lang.String[])}.
*
* @throws CommandRunException if the command unexpectedly failed.
* @throws IOException if the output could not be written to */

4
gclc-swt/.gitignore vendored
View File

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

View File

@@ -2,12 +2,12 @@
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>net.bigeon.config</groupId>
<artifactId>swt-config</artifactId>
<version>1.8.11</version>
<artifactId>swt-public-conf</artifactId>
<version>1.0.1</version>
</parent>
<groupId>net.bigeon.gclc</groupId>
<artifactId>swt</artifactId>
<version>1.1.7-SNAPSHOT</version>
<version>1.2.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>GCLC swt</name>
<description>A swt window for console applications</description>
@@ -48,12 +48,18 @@
<dependency>
<groupId>net.bigeon</groupId>
<artifactId>gclc</artifactId>
<version>2.0.11</version>
<version>2.1.0</version>
</dependency>
<dependency>
<groupId>net.bigeon</groupId>
<artifactId>collections</artifactId>
<version>1.1.6</version>
<version>1.2.6</version>
</dependency>
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-core</artifactId>
<version>2.27.0</version>
<scope>test</scope>
</dependency>
</dependencies>

View File

@@ -35,6 +35,8 @@
*/
package net.bigeon.gclc.swt;
import java.io.IOException;
/*-
* #%L
* GCLC swt
@@ -86,6 +88,8 @@ public interface ConsoleDelayIO {
* @param input the input to set */
void setInput(String input);
/** Actually send the input as the prompt next input. */
void validateInput();
/** Actually send the input as the prompt next input.
*
* @throws IOException if an error occurred */
void validateInput() throws IOException;
}

View File

@@ -0,0 +1,97 @@
/**
*
*/
package net.bigeon.gclc.swt;
/*-
* #%L
* GCLC swt
* %%
* Copyright (C) 2015 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.IOException;
import org.eclipse.swt.widgets.Text;
import net.bigeon.gclc.manager.PipedConsoleInput;
/** The object managing the console input.
*
* @author Emmanuel Bigeon */
public final class ConsoleInputManager implements ConsoleDelayIO {
private final Text text;
private PipedConsoleInput input;
/** Create a managing object.
*
* @param text the text */
public ConsoleInputManager(final Text text) {
super();
this.text = text;
}
/* (non-Javadoc)
* @see net.bigeon.gclc.swt.ConsoleDelayIO#setInput(java.lang.String) */
@Override
public void setInput(final String string) {
text.setText(string);
text.setSelection(string.length());
}
/* (non-Javadoc)
* @see net.bigeon.gclc.swt.ConsoleDelayIO#getInput() */
@Override
public String getInput() {
return text.getText();
}
/* (non-Javadoc)
* @see net.bigeon.gclc.swt.ConsoleDelayIO#validateInput() */
@Override
public void validateInput() throws IOException {
input.type(text.getText());
}
/** Set the input to control.
*
* @param input the input */
public void setManager(final PipedConsoleInput input) {
this.input = input;
}
/** Get the text component containing the currently set input.
*
* @return the text */
public Text getText() {
return text;
}
}

View File

@@ -0,0 +1,50 @@
/**
*
*/
package net.bigeon.gclc.swt;
/*-
* #%L
* GCLC swt
* %%
* Copyright (C) 2015 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
/** The common interface for console display.
*
* @author Emmanuel Bigeon */
public interface ConsoleOutputDisplay {
/** Append a line to the display.
*
* @param m the line content */
void appendLine(String m);
}

View File

@@ -0,0 +1,97 @@
/**
*
*/
package net.bigeon.gclc.swt;
/*-
* #%L
* GCLC swt
* %%
* Copyright (C) 2015 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import org.eclipse.swt.widgets.Text;
import net.bigeon.gclc.manager.PipedConsoleOutput;
import net.bigeon.gclc.swt.tools.ToSWTConsoleForwardRunnable;
/** The manager for console output to insert in a text.
*
* @author Emmanuel Bigeon */
public final class ConsoleOutputManager implements ConsoleOutputDisplay {
/** The SWT component displaying the output content. */
private final Text text;
/** The forwarding runnable. */
private ToSWTConsoleForwardRunnable forward;
/** The forwarding thread. */
private Thread forwardThread;
/** Create the manager.
*
* @param text the text to display the output in. */
public ConsoleOutputManager(final Text text) {
super();
this.text = text;
}
/* (non-Javadoc)
* @see net.bigeon.gclc.swt.ConsoleOutputDisplay#appendLine(java.lang.String) */
@Override
public void appendLine(final String next) {
text.getDisplay().syncExec(new TextAppendingRunnable(text, next));
}
/** Set the output.
*
* @param output the output to set */
public void setManager(final PipedConsoleOutput output) {
if (forward != null) {
if (forward.getOuput() == output) {
return;
}
forward.setRunning(false);
}
if (output == null) {
forward = null;
forwardThread = null;
return;
}
forward = new ToSWTConsoleForwardRunnable(output, this, text);
forwardThread = new Thread(forward, "gclcToSWT"); //$NON-NLS-1$
forwardThread.start();
}
/** Get the current thread forwarding the console output to the SWT components.
*
* @return the forwardThread */
public Thread getForwardThread() {
return forwardThread;
}
}

View File

@@ -0,0 +1,93 @@
/**
*
*/
package net.bigeon.gclc.swt;
/*-
* #%L
* GCLC swt
* %%
* Copyright (C) 2015 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.BufferedReader;
import org.eclipse.swt.widgets.Label;
import net.bigeon.gclc.swt.tools.PromptReadingRunnable;
/** The manager for the console prompt updates.
*
* @author Emmanuel Bigeon */
public final class ConsolePromptManager {
/** The label to set the prompts at. */
private final Label label;
/** The current prompt reading runnable. */
private PromptReadingRunnable promptRead;
/** Create the manager.
*
* @param label the label to update with prompts */
public ConsolePromptManager(final Label label) {
super();
this.label = label;
}
/** Set the prompt.
* <p>
* This method sets the prompt on the label as requested, without changing the
* actual prompt of the console input.
*
* @param string the text */
public void setPrompt(final String string) {
label.setText(string);
}
/** Set the input to control.
*
* @param promptStream the input */
public void setStream(final BufferedReader promptStream) {
if (promptRead != null) {
if (promptRead.getReader() == promptStream) {
return;
}
promptRead.setRunning(false);
}
if (promptStream == null) {
promptRead = null;
return;
}
promptRead = new PromptReadingRunnable(promptStream, label);
final Thread th = new Thread(promptRead, "Prompt To Label");
th.start();
}
}

View File

@@ -35,6 +35,10 @@
*/
package net.bigeon.gclc.swt;
import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
/*-
* #%L
* GCLC swt
@@ -72,8 +76,8 @@ import org.eclipse.swt.SWT;
import org.eclipse.swt.events.KeyAdapter;
import org.eclipse.swt.events.KeyEvent;
import net.bigeon.collections.ArrayRibbon;
import net.bigeon.collections.Ribbon;
import net.bigeon.collections.ribbon.ArrayRibbon;
/** A key listener to validate commands and manage the history of commands.
*
@@ -83,7 +87,9 @@ 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$
private static final String EMPTY = ""; //$NON-NLS-1$
private static final Logger LOGGER = Logger
.getLogger(HistoryTextKeyListener.class.getName());
/** The history ribbon. */
private final Ribbon<String> commands;
/** The current index in history search. */
@@ -118,7 +124,11 @@ public final class HistoryTextKeyListener extends KeyAdapter {
if (!input.isEmpty()) {
commands.add(input);
}
console.validateInput();
try {
console.validateInput();
} catch (final IOException e) {
LOGGER.log(Level.SEVERE, "Unable to write to console", e);
}
currentIndex = -1;
}

View File

@@ -30,11 +30,13 @@
* knowledge of the CeCILL license and that you accept its terms.
*/
/**
* gclc-swt:net.bigeon.gclc.swt.SWTConsole.java
* gclc-swt:net.bigeon.gclc.swt.SWTConsoleShell.java
* Created on: Apr 18, 2015
*/
package net.bigeon.gclc.swt;
import java.io.BufferedReader;
/*-
* #%L
* GCLC swt
@@ -68,411 +70,75 @@ package net.bigeon.gclc.swt;
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.eclipse.swt.SWT;
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.Label;
import org.eclipse.swt.widgets.Text;
import net.bigeon.gclc.ConsoleApplication;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
import net.bigeon.gclc.tools.ConstantString;
import net.bigeon.gclc.tools.StringProvider;
import net.bigeon.gclc.manager.PipedConsoleInput;
import net.bigeon.gclc.manager.PipedConsoleOutput;
/** A SWT component to connect to gclc {@link ConsoleApplication}.
/** A shell containing a {@link SWTConsoleView}
* <p>
*
* @author Emmanuel Bigeon */
public final class SWTConsole extends Composite
implements ConsoleDelayIO, ConsoleInput, ConsoleOutput {
private static final int TWO = 2;
private static final String ERROR_SYNCHRO_PROMPT = "Error in synchronization of prompting";
/** The number of columns of the layout. */
private static final int LAYOUT_NB_COLUMNS = 2;
/** The cmd prefix in the output console. */
private static final String CMD_PREFIX = "[CMD] "; //$NON-NLS-1$
/** 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$
public final class SWTConsole extends Composite {
/** The console output text field. */
private final Text consoleOutput;
/** The console input text field. */
private final Text consoleInput;
/** The prompt label. */
private final Label lblPromptlabel;
/** The prompt text. */
private StringProvider prompt = new ConstantString("> "); //$NON-NLS-1$
/** The command entered by the user. */
private String command = null;
/** If the prompt should be active. */
private boolean prompting = false;
/** The object for thread synchronization with the prompt. */
private final Object promptLock = new Object();
private ConsoleInputManager inputManager;
private ConsoleOutputManager outputManager;
private ConsolePromptManager promptManager;
/** Create the composite.
/** Create the shell.
*
* @param parent the prent composite
* @param style the composite style */
* @param parent the containing composite
* @param style the shell style */
public SWTConsole(final Composite parent, final int style) {
super(parent, style);
setLayout(new GridLayout(LAYOUT_NB_COLUMNS, 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, LAYOUT_NB_COLUMNS, 1));
consoleOutput.setRedraw(true);
lblPromptlabel = new Label(this, SWT.NONE);
lblPromptlabel.setText(prompt.apply());
consoleInput = new Text(this, SWT.BORDER);
consoleInput.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false, 1, 1));
consoleInput.addKeyListener(new HistoryTextKeyListener(this));
setLayout(new GridLayout(2, false));
createContents();
}
/* (non-Javadoc)
* @see org.eclipse.swt.widgets.Composite#checkSubclass() */
@Override
protected void checkSubclass() {
// Disable the check that prevents subclassing of SWT components
/** Create contents of the shell. */
private void createContents() {
final Text output = new Text(this,
SWT.WRAP | SWT.READ_ONLY | SWT.MULTI | SWT.V_SCROLL);
output.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true, 2, 1));
final Label prompt = new Label(this, SWT.NONE);
prompt.setLayoutData(new GridData(SWT.LEFT, SWT.CENTER, false, false));
final Text input = new Text(this, SWT.NONE);
input.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false));
inputManager = new ConsoleInputManager(input);
outputManager = new ConsoleOutputManager(output);
promptManager = new ConsolePromptManager(prompt);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#close() */
@Override
public void close() {
synchronized (promptLock) {
prompting = false;
promptLock.notifyAll();
}
if (consoleInput.isDisposed()) {
return;
}
consoleInput.setEnabled(false);
consoleOutput.setEnabled(false);
}
/* (non-Javadoc)
* @see net.bigeon.gclc.swt.ConsoleDelayIO#getInput() */
@Override
public String getInput() {
return consoleInput.getText();
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#getPrompt() */
@Override
public StringProvider getPrompt() {
return prompt;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#interruptPrompt() */
@Override
public void interruptPrompt() {
synchronized (promptLock) {
promptLock.notifyAll();
}
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleManager#isClosed() */
@Override
public boolean isClosed() {
return isDisposed();
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#print(java.lang.String) */
@Override
public void print(final String text) throws IOException {
if (isDisposed()) {
throw new IOException();
}
Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
if (!consoleOutput.isDisposed()) {
consoleOutput.append(text);
}
}
});
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#println() */
@Override
public void println() throws IOException {
if (isDisposed()) {
throw new IOException();
}
Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
if (!consoleOutput.isDisposed()) {
consoleOutput.append(System.lineSeparator());
}
}
});
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#println(java.lang.String) */
@Override
public void println(final String message) throws IOException {
if (isDisposed()) {
throw new IOException();
}
Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
if (!consoleOutput.isDisposed()) {
consoleOutput.append(message + System.lineSeparator());
}
}
});
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#prompt() */
@Override
public String prompt() throws IOException {
synchronized (promptLock) {
initPrompt(prompt.apply());
promptLock.notifyAll();
try {
while (prompting) {
promptLock.wait();
}
} catch (final InterruptedException e) {
LOGGER.log(Level.WARNING, ERROR_SYNCHRO_PROMPT, e);
command = null;
Thread.currentThread().interrupt();
}
}
if (isDisposed()) {
throw new IOException("Input closed"); //$NON-NLS-1$
}
return command;
}
/** Initialize the prompting.
/** Connect the console parts to the shell.
*
* @param message the prompt message
* @throws IOException if the console is disposed */
private void initPrompt(final String message) throws IOException {
if (isDisposed()) {
throw new IOException();
}
Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
if (!consoleOutput.isDisposed()) {
lblPromptlabel.setText(message);
// relayout
SWTConsole.this.layout();
consoleInput.setEnabled(true);
consoleInput.setFocus();
}
}
});
prompting = true;
command = null;
* @param input the input
* @param output the output
* @param promptStream the stream where the prompts are forwarded. */
public void connect(final PipedConsoleInput input, final PipedConsoleOutput output,
final BufferedReader promptStream) {
inputManager.setManager(input);
outputManager.setManager(output);
promptManager.setStream(promptStream);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(long) */
@Override
public String prompt(final long timeout) throws IOException {
synchronized (promptLock) {
initPrompt(prompt.apply());
promptLock.notifyAll();
try {
waitPromptResolution(timeout);
} catch (final InterruptedException e) {
LOGGER.log(Level.WARNING, ERROR_SYNCHRO_PROMPT, e);
command = null;
Thread.currentThread().interrupt();
}
}
return command;
/** @return the inputManager */
public ConsoleInputManager getInputManager() {
return inputManager;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#prompt(java.lang.String) */
@Override
public String prompt(final String message) throws IOException {
synchronized (promptLock) {
initPrompt(message);
promptLock.notifyAll();
try {
while (prompting) {
promptLock.wait();
}
if (isDisposed()) {
throw new IOException();
}
} catch (final InterruptedException e) {
LOGGER.log(Level.WARNING, ERROR_SYNCHRO_PROMPT, e);
command = null;
Thread.currentThread().interrupt();
} finally {
resetPrompt();
}
}
return command;
/** @return the outputManager */
public ConsoleOutputManager getOutputManager() {
return outputManager;
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, long) */
@Override
public String prompt(final String message, final long timeout) throws IOException {
synchronized (promptLock) {
initPrompt(message);
promptLock.notifyAll();
try {
waitPromptResolution(timeout);
} catch (final InterruptedException e) {
LOGGER.log(Level.WARNING, ERROR_SYNCHRO_PROMPT, e);
command = null;
Thread.currentThread().interrupt();
} finally {
resetPrompt();
}
}
return command;
/** @return the promptManager */
public ConsolePromptManager getPromptManager() {
return promptManager;
}
/** Wait the prompt resolution by user.
*
* @param timeout the timeout for the wait
* @throws InterruptedException if the thread is interrupted
* @throws IOException if the console is disposed. */
private void waitPromptResolution(final long timeout)
throws InterruptedException, IOException {
final long start = System.currentTimeMillis();
long cur = start;
while (prompting && start + timeout > cur) {
promptLock.wait((cur - start - timeout) / TWO);
cur = System.currentTimeMillis();
}
if (isDisposed()) {
throw new IOException();
}
}
/** Reset the prompt message. */
private void resetPrompt() {
Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
if (!consoleOutput.isDisposed()) {
lblPromptlabel.setText(prompt.apply());
// relayout
SWTConsole.this.layout();
}
}
});
}
/* (non-Javadoc)
* @see org.eclipse.swt.widgets.Composite#setFocus() */
@Override
public boolean setFocus() {
return consoleInput.setFocus();
}
/* (non-Javadoc)
* @see net.bigeon.gclc.swt.ConsoleDelayIO#setInput(java.lang.String) */
@Override
public void setInput(final String input) {
consoleInput.setText(input);
consoleInput.setSelection(input.length());
}
/* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */
@Override
public void setPrompt(final String prompt) {
setPrompt(new ConstantString(prompt));
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.ConsoleManager#setPrompt(java.lang.String) */
@Override
public void setPrompt(final StringProvider prompt) {
this.prompt = prompt;
Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
if (!consoleOutput.isDisposed()) {
lblPromptlabel.setText(prompt.apply());
// relayout
SWTConsole.this.layout();
}
}
});
}
/** Set the input text.
*
* @param string the text */
public void setText(final String string) {
consoleInput.setText(string);
}
/* (non-Javadoc)
* @see net.bigeon.gclc.swt.ConsoleDelayIO#validateInput() */
@Override
public void validateInput() {
Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
consoleInput.setEnabled(false);
}
});
synchronized (promptLock) {
while (!prompting) {
try {
promptLock.wait();
} catch (final InterruptedException e) {
LOGGER.log(Level.SEVERE, "Interruption while waiting prompt", e); //$NON-NLS-1$
Thread.currentThread().interrupt();
}
}
Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
command = consoleInput.getText();
prompting = false;
consoleInput.setText(EMPTY);
consoleOutput.append(CMD_PREFIX + command + System.lineSeparator());
}
});
promptLock.notifyAll();
}
}
}

View File

@@ -1,118 +0,0 @@
/*
* GCLC swt, provide a swt window for console applications
* Copyright (C) 2015-2017 E. Bigeon
* mailto:emmanuel@bigeon.fr
*
* 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:net.bigeon.gclc.swt.SWTConsoleShell.java
* Created on: Apr 18, 2015
*/
package net.bigeon.gclc.swt;
/*-
* #%L
* GCLC swt
* %%
* Copyright (C) 2015 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.FillLayout;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell;
/** A shell containing a {@link SWTConsole}
* <p>
*
* @author Emmanuel Bigeon */
public final class SWTConsoleShell extends Shell {
/** The console component */
private SWTConsole console;
/** Create the shell.
*
* @param display the display */
public SWTConsoleShell(final Display display, final int style) {
super(display, style);
setLayout(new FillLayout(SWT.HORIZONTAL));
createContents();
}
@Override
protected void checkSubclass() {
// Disable the check that prevents subclassing of SWT components
}
/** Create contents of the shell. */
private void createContents() {
console = new SWTConsole(this, SWT.NONE);
setText("Console Application"); //$NON-NLS-1$
}
/* (non-Javadoc)
* @see org.eclipse.swt.widgets.Shell#dispose() */
@Override
public void dispose() {
super.dispose();
console.close();
}
/** @return the input and output. */
public SWTConsole getManager() {
return console;
}
}

View File

@@ -46,13 +46,13 @@ package net.bigeon.gclc.swt;
* 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,
@@ -63,71 +63,30 @@ package net.bigeon.gclc.swt;
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.eclipse.swt.SWT;
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 net.bigeon.gclc.ConsoleApplication;
import net.bigeon.gclc.utils.AOutputForwardRunnable;
import net.bigeon.gclc.utils.PipedConsoleInput;
import net.bigeon.gclc.utils.PipedConsoleOutput;
import net.bigeon.gclc.manager.PipedConsoleInput;
import net.bigeon.gclc.manager.PipedConsoleOutput;
/** A SWT component to connect to gclc {@link ConsoleApplication}
* <p>
/** A SWT component to connect to gclc {@link ConsoleApplication}.
*
* @author Emmanuel Bigeon */
public final 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(final PipedConsoleOutput manager) {
super(manager);
}
@Override
protected void forwardLine(final String m) {
appendConsoleOutput(System.lineSeparator() + m);
}
@Override
protected boolean isRunning() {
return running && !isDisposed();
}
/** @param running the running to set */
public void setRunning(final 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 input. */
private PipedConsoleInput input;
/** The forwarding runnable */
private ToSWTConsoleForwardRunnable forward;
public final class SWTConsoleView extends Composite {
/** The input manager. */
private final ConsoleInputManager inManager;
/** The output manager. */
private final ConsoleOutputManager outManager;
/** Create the composite.
*
@@ -138,52 +97,23 @@ public final class SWTConsoleView extends Composite implements ConsoleDelayIO {
setLayout(new GridLayout(1, false));
consoleOutput = new Text(this,
final Text 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);
outManager = new ConsoleOutputManager(consoleOutput);
consoleInput = new Text(this, SWT.BORDER);
final Text consoleInput = new Text(this, SWT.BORDER);
consoleInput.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false, 1, 1));
consoleInput.addKeyListener(new HistoryTextKeyListener(this));
}
/** @param next the next message */
public void appendConsoleOutput(final String next) {
Display.getDefault().syncExec(new Runnable() {
@SuppressWarnings("synthetic-access")
@Override
public void run() {
consoleOutput.append(next);
}
});
}
@Override
protected void checkSubclass() {
// Disable the check that prevents subclassing of SWT components
}
/* (non-Javadoc)
* @see net.bigeon.gclc.swt.ConsoleDelayIO#getInput() */
@Override
public String getInput() {
return consoleInput.getText();
inManager = new ConsoleInputManager(consoleInput);
consoleInput.addKeyListener(new HistoryTextKeyListener(inManager));
}
/* (non-Javadoc)
* @see org.eclipse.swt.widgets.Composite#setFocus() */
@Override
public boolean setFocus() {
return consoleInput.setFocus();
}
/* (non-Javadoc)
* @see net.bigeon.gclc.swt.ConsoleDelayIO#setInput(java.lang.String) */
@Override
public void setInput(final String input) {
consoleInput.setText(input);
consoleInput.setSelection(input.length());
return inManager.getText().setFocus();
}
/** Set the input and output.
@@ -192,29 +122,21 @@ public final class SWTConsoleView extends Composite implements ConsoleDelayIO {
* @param input the input */
public void setManager(final PipedConsoleOutput manager,
final PipedConsoleInput input) {
this.input = input;
if (forward != null) {
forward.setRunning(false);
}
forward = new ToSWTConsoleForwardRunnable(manager);
final Thread th = new Thread(forward, "gclcToSWT"); //$NON-NLS-1$
th.start();
outManager.setManager(manager);
inManager.setManager(input);
}
/** @param string the text */
public void setText(final String string) {
consoleInput.setText(string);
/** Get the manager of console input.
*
* @return the input manager */
public ConsoleInputManager getInputManager() {
return inManager;
}
/**
*
*/
@Override
public void validateInput() {
try {
input.type(getInput());
} catch (final IOException e) {
LOGGER.log(Level.SEVERE, "Unable to input value to console", e); //$NON-NLS-1$
}
/** Get the manager of console output.
*
* @return the output manager */
public ConsoleOutputManager getOutputManager() {
return outManager;
}
}

View File

@@ -0,0 +1,36 @@
/**
*
*/
package net.bigeon.gclc.swt;
import org.eclipse.swt.widgets.Text;
/** A runnable appending text to the content of a {@link Text} component.
*
* @author Emmanuel Bigeon */
public class TextAppendingRunnable implements Runnable {
/** The text to append on a line (possibly new). */
private final String next;
/** The {@link Text} component. */
private final Text text;
/** Create the appending runnable.
*
* @param text the component to update
* @param next the text to append */
public TextAppendingRunnable(final Text text, final String next) {
this.text = text;
this.next = next;
}
/* (non-Javadoc)
* @see java.lang.Runnable#run() */
@Override
public void run() {
final String initialText = text.getText();
if (initialText != null && !initialText.isEmpty()) {
text.append(System.lineSeparator());
}
text.append(next);
}
}

View File

@@ -0,0 +1,134 @@
/**
*
*/
package net.bigeon.gclc.swt.tools;
/*-
* #%L
* GCLC swt
* %%
* Copyright (C) 2015 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.BufferedReader;
import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.eclipse.swt.widgets.Label;
/** The runnable forwarding prompts from a buffered input to a label.
*
* @author Emmanuel Bigeon */
public class PromptReadingRunnable implements Runnable {
/** The logger for this class. */
private static final Logger LOGGER = Logger
.getLogger(PromptReadingRunnable.class.getName());
/** The reader providing the succession of prompts */
private final BufferedReader reader;
/** The label. */
private final Label view;
/** The running status. */
private boolean running = true;
/** The updating runnable implementation.
*
* @author Emmanuel Bigeon */
private static class LabelUpdater implements Runnable {
/** The label to update. */
private final Label label;
/** The text to set. */
private final String content;
/** Create the updating runnable.
*
* @param label the label
* @param content the content */
public LabelUpdater(final Label label, final String content) {
super();
this.label = label;
this.content = content;
}
/* (non-Javadoc)
* @see java.lang.Runnable#run() */
@Override
public void run() {
label.setText(content);
}
}
/** Create the prompt flow updating runnable.
*
* @param reader the reader
* @param view the view to update on lines. */
public PromptReadingRunnable(final BufferedReader reader, final Label view) {
super();
this.reader = reader;
this.view = view;
}
/* (non-Javadoc)
* @see java.lang.Runnable#run() */
@Override
public void run() {
String prompt;
try {
while (isRunning() && (prompt = reader.readLine()) != null) {
view.getDisplay().syncExec(new LabelUpdater(view, prompt));
}
} catch (final IOException e) {
LOGGER.log(Level.INFO, "Prompt cannot be read, or was prematuraly closed", e);
}
}
/** Get the running state.
*
* @return the running */
public synchronized boolean isRunning() {
return running;
}
/** Set the running state.
*
* @param running the running to set */
public synchronized void setRunning(final boolean running) {
this.running = running;
}
/** Get the prompt flow.
*
* @return the reader */
public BufferedReader getReader() {
return reader;
}
}

View File

@@ -0,0 +1,68 @@
/**
*
*/
package net.bigeon.gclc.swt.tools;
import org.eclipse.swt.widgets.Widget;
import net.bigeon.gclc.manager.PipedConsoleOutput;
import net.bigeon.gclc.manager.forwarding.AOutputForwardRunnable;
import net.bigeon.gclc.swt.ConsoleOutputDisplay;
/** The local implementation of the forwarding runnable.
*
* @author Emmanuel Bigeon */
public final class ToSWTConsoleForwardRunnable
extends AOutputForwardRunnable {
/** The running status. */
private boolean running = true;
/** The console output. */
private final PipedConsoleOutput out;
/** The console output display. */
private final ConsoleOutputDisplay display;
/** The actual SWT component. */
private final Widget element;
/** Create the forwarding runnable.
*
* @param manager the manager
* @param display the display
* @param element the composite */
public ToSWTConsoleForwardRunnable(final PipedConsoleOutput manager,
final ConsoleOutputDisplay display,
final Widget element) {
super(manager);
out = manager;
this.display = display;
this.element = element;
}
/* (non-Javadoc)
* @see
* net.bigeon.gclc.utils.AOutputForwardRunnable#forwardLine(java.lang.String) */
@Override
protected void forwardLine(final String m) {
display.appendLine(m);
}
/* (non-Javadoc)
* @see net.bigeon.gclc.utils.AOutputForwardRunnable#isRunning() */
@Override
protected boolean isRunning() {
return running && !element.isDisposed();
}
/** Set the running status.
*
* @param running the running to set */
public void setRunning(final boolean running) {
this.running = running;
}
/** Get the output.
*
* @return the currently forwarded output */
public PipedConsoleOutput getOuput() {
return out;
}
}

View File

@@ -0,0 +1,9 @@
/**
*
*/
/** Tool classes for the library. External code should not rely on classes in
* there as they can be removed without notice.
*
* @author Emmanuel Bigeon */
package net.bigeon.gclc.swt.tools;

View File

@@ -0,0 +1,116 @@
/**
*
*/
package net.bigeon.gclc.swt;
/*-
* #%L
* GCLC swt
* %%
* Copyright (C) 2015 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.fail;
import static org.mockito.Mockito.*;
import java.io.IOException;
import org.eclipse.swt.widgets.Text;
import org.junit.Test;
import net.bigeon.gclc.manager.PipedConsoleInput;
/** @author Emmanuel Bigeon */
public class ConsoleInputManagerTest {
private final Text text = mock(Text.class);
private final ConsoleInputManager cim = new ConsoleInputManager(text);
/** Test method for
* {@link net.bigeon.gclc.swt.ConsoleInputManager#setInput(java.lang.String)}. */
@Test
public void testSetText() {
cim.setInput("Text");
verify(text).setText("Text");
}
/** Test method for
* {@link net.bigeon.gclc.swt.ConsoleInputManager#validateInput()}.
*
* @throws IOException if an error occurred */
@Test
public void testValidateInput() throws IOException {
// Expected calls
when(text.getText()).thenReturn("abc");
try {
cim.validateInput();
fail("No input should cause exception for input validation");
} catch (final Exception e) {
// ok
}
final PipedConsoleInput input = mock(PipedConsoleInput.class);
cim.setManager(input);
cim.validateInput();
verify(input).type("abc");
}
@Test
public void testValidateInputWithError() throws IOException {
final PipedConsoleInput input = mock(PipedConsoleInput.class);
cim.setManager(input);
// Expected calls
when(text.getText()).thenReturn("abc");
doThrow(new IOException()).when(input).type("abc");
try {
cim.validateInput();
fail("IO exception should be forwarded");
} catch (final IOException e) {
// ok
}
}
/** Test method for
* {@link net.bigeon.gclc.swt.ConsoleInputManager#getText()}. */
@Test
public void testGetText() {
assertEquals("Text component should be preserved", text, cim.getText());
}
@Test
public void testGetInput() {
when(text.getText()).thenReturn("abc");
assertEquals("Text component should be preserved", "abc", cim.getInput());
}
}

View File

@@ -0,0 +1,102 @@
/**
*
*/
package net.bigeon.gclc.swt;
/*-
* #%L
* GCLC swt
* %%
* Copyright (C) 2015 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.*;
import java.io.IOException;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Text;
import org.junit.Test;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;
import net.bigeon.gclc.manager.PipedConsoleOutput;
/** @author Emmanuel Bigeon */
public class ConsoleOutputManagerTest {
private final Text text = mock(Text.class);
private final ConsoleOutputManager com = new ConsoleOutputManager(text);
private final Display display = mock(Display.class);
{
when(text.getDisplay()).thenReturn(display);
doAnswer(new Answer<Object>() {
/* (non-Javadoc)
* @see
* org.mockito.stubbing.Answer#answer(org.mockito.invocation.InvocationOnMock) */
@Override
public Object answer(final InvocationOnMock invocation) throws Throwable {
final Runnable runnable = invocation.getArgument(0);
runnable.run();
return null;
}
}).when(display).syncExec(any(Runnable.class));
}
/** Test method for
* {@link net.bigeon.gclc.swt.ConsoleOutputManager#appendLine(java.lang.String)}. */
@Test
public void testAppendConsoleOutput() {
when(text.getText()).thenReturn("", "abc",
"abc" + System.lineSeparator() + "def");
com.appendLine("abc");
verify(text).append("abc");
com.appendLine("def");
verify(text).append(System.lineSeparator());
verify(text).append("def");
}
@Test
public void testSetManager() throws IOException, InterruptedException {
final PipedConsoleOutput output = mock(PipedConsoleOutput.class);
com.setManager(output);
com.setManager(output);
try (PipedConsoleOutput output2 = new PipedConsoleOutput()) {
com.setManager(output2);
output2.println("line");
final Thread forwardThread = com.getForwardThread();
forwardThread.join(500);
com.setManager(null);
forwardThread.join();
verify(text).append("line");
}
}
}

View File

@@ -0,0 +1,81 @@
/**
*
*/
package net.bigeon.gclc.swt;
/*-
* #%L
* GCLC swt
* %%
* Copyright (C) 2015 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import java.io.BufferedReader;
import org.eclipse.swt.widgets.Label;
import org.junit.Test;
/**
* @author Emmanuel Bigeon
*
*/
public class ConsolePromptManagerTest {
private final Label label = mock(Label.class);
private final ConsolePromptManager manager = new ConsolePromptManager(label);
/**
* Test method for {@link net.bigeon.gclc.swt.ConsolePromptManager#setPrompt(java.lang.String)}.
*/
@Test
public void testSetPrompt() {
manager.setPrompt("abc");
verify(label).setText("abc");
}
/**
* Test method for {@link net.bigeon.gclc.swt.ConsolePromptManager#setStream(java.io.BufferedReader)}.
*/
@Test
public void testSetStream() {
BufferedReader output = mock(BufferedReader.class);
manager.setStream(output);
manager.setStream(output);
output = mock(BufferedReader.class);
manager.setStream(output);
manager.setStream(null);
manager.setStream(output);
}
}

View File

@@ -69,8 +69,10 @@ package net.bigeon.gclc.swt;
* #L%
*/
import static org.junit.Assert.assertEquals;
import static org.mockito.Mockito.mock;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.KeyEvent;
import org.junit.Test;
/**
@@ -84,7 +86,7 @@ public class HistoryTextKeyListenerTest {
* {@link net.bigeon.gclc.swt.HistoryTextKeyListener#keyPressed(org.eclipse.swt.events.KeyEvent)}. */
@Test
public final void testKeyPressedKeyEvent() {
ConsoleDelayIO io = new ConsoleDelayIO() {
final ConsoleDelayIO io = new ConsoleDelayIO() {
private String input = "";
@Override
@@ -93,7 +95,7 @@ public class HistoryTextKeyListenerTest {
}
@Override
public void setInput(String input) {
public void setInput(final String input) {
this.input = input;
}
@@ -102,7 +104,7 @@ public class HistoryTextKeyListenerTest {
input = "";
}
};
HistoryTextKeyListener listener = new HistoryTextKeyListener(io);
final HistoryTextKeyListener listener = new HistoryTextKeyListener(io);
// no effects
assertEquals("", io.getInput());
@@ -139,4 +141,12 @@ public class HistoryTextKeyListenerTest {
assertEquals("cmd arg2", io.getInput());
}
@Test
public void testKeyPressed() {
final ConsoleDelayIO io = mock(ConsoleDelayIO.class);
final KeyEvent event = mock(KeyEvent.class);
event.keyCode = 'a';
final HistoryTextKeyListener listener = new HistoryTextKeyListener(io);
listener.keyPressed(event);
}
}

View File

@@ -0,0 +1,107 @@
/**
*
*/
package net.bigeon.gclc.swt;
/*-
* #%L
* GCLC swt
* %%
* Copyright (C) 2015 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import java.io.BufferedReader;
import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Label;
import org.junit.Test;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;
import net.bigeon.gclc.swt.tools.PromptReadingRunnable;
/** @author Emmanuel Bigeon */
public class PromptReadingRunnableTest {
private final Label view = mock(Label.class);
private final Display display = mock(Display.class);
{
when(view.getDisplay()).thenReturn(display);
doAnswer(new Answer<Object>() {
/* (non-Javadoc)
* @see
* org.mockito.stubbing.Answer#answer(org.mockito.invocation.InvocationOnMock) */
@Override
public Object answer(final InvocationOnMock invocation) throws Throwable {
final Runnable runnable = invocation.getArgument(0);
runnable.run();
return null;
}
}).when(display).syncExec(any(Runnable.class));
}
/** Test method for {@link net.bigeon.gclc.swt.tools.PromptReadingRunnable#run()}.
*
* @throws IOException if an error occurred */
@Test
public void testRun() throws IOException {
final BufferedReader reader = mock(BufferedReader.class);
when(reader.readLine()).thenReturn("abc", "def", null);
final PromptReadingRunnable runnable = new PromptReadingRunnable(reader, view);
runnable.run();
}
/** Test method for {@link net.bigeon.gclc.swt.tools.PromptReadingRunnable#run()}.
*
* @throws IOException if an error occurred */
@Test
public void testRunWithIO() throws IOException {
final BufferedReader reader = mock(BufferedReader.class);
when(reader.readLine()).thenThrow(new IOException());
final PromptReadingRunnable runnable = new PromptReadingRunnable(reader, view);
final Logger logger = Logger.getLogger(PromptReadingRunnable.class.getName());
final Level back = logger.getLevel();
logger.setLevel(Level.OFF);
runnable.run();
logger.setLevel(back);
}
}

View File

@@ -1,37 +1,5 @@
/*
* GCLC swt, provide a swt window for console applications
* Copyright (C) 2015-2017 E. Bigeon
* mailto:emmanuel@bigeon.fr
*
* 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:net.bigeon.gclc.swt.SWTConsoleShellTest.java
* Created on: Jun 8, 2016
*
*/
package net.bigeon.gclc.swt;
@@ -46,13 +14,13 @@ package net.bigeon.gclc.swt;
* 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,
@@ -63,304 +31,45 @@ package net.bigeon.gclc.swt;
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
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;
import static org.junit.Assert.assertNotNull;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Shell;
import org.junit.Test;
import net.bigeon.gclc.ConsoleApplication;
import net.bigeon.gclc.command.Command;
import net.bigeon.gclc.command.base.ExitCommand;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.InvalidCommandName;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
import net.bigeon.gclc.manager.PipedConsoleInput;
import net.bigeon.gclc.manager.PipedConsoleOutput;
/**
* <p>
* TODO
*
* @author Emmanuel Bigeon */
@SuppressWarnings({ "javadoc", "static-method", "nls", "deprecation" })
/** @author Emmanuel Bigeon */
public class SWTConsoleShellTest {
protected static final long TWO_SECONDS = 2000;
private static final Display DISPLAY = Display.getDefault();
/** Test method for
* {@link net.bigeon.gclc.swt.SWTConsole#SWTConsole(Composite, int)}. */
@Test
public void testGeneric() {
final SWTConsoleShell shell = new SWTConsoleShell(DISPLAY, SWT.SHELL_TRIM);
final SWTConsole swtConsole = shell.getManager();
try {
final ConsoleApplication appl = new ConsoleApplication(swtConsole, swtConsole,
"Hello", "See you");
appl.add(new ExitCommand("exit", appl));
appl.add(new Command("long") {
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
try {
Thread.sleep(TWO_SECONDS);
} catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
@Override
public String tip() {
return "a long running command";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
// TODO Auto-generated method stub
// return null;
throw new RuntimeException("Not implemented yet");
}
});
// shell.pack();
shell.open();
shell.setVisible(false);
final Thread applThread = new Thread(new Runnable() {
@Override
public void run() {
appl.start();
}
});
final Thread testThread = new Thread(new Runnable() {
@Override
public void run() {
try {
Thread.sleep(TWO_SECONDS);
} catch (final 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 (final 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();
}
}
// DISPLAY.dispose();
assertTrue(swtConsole.isClosed());
Thread.sleep(TWO_SECONDS);
assertFalse(appl.isRunning());
} catch (final InvalidCommandName e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
public void testSWTConsoleShell() {
final SWTConsole console = new SWTConsole(new Shell(), SWT.NONE);
assertNotNull("View should be initialized with managers",
console.getInputManager());
assertNotNull("View should be initialized with managers",
console.getOutputManager());
assertNotNull("View should be initialized with managers",
console.getPromptManager());
}
/** Test method for
* {@link net.bigeon.gclc.swt.SWTConsole#connect(PipedConsoleInput, PipedConsoleOutput, java.io.BufferedReader)}. */
@Test
public void testConsoleClose() {
final SWTConsoleShell shell = new SWTConsoleShell(DISPLAY, SWT.SHELL_TRIM);
final SWTConsole swtConsole = shell.getManager();
swtConsole.close();
swtConsole.setPrompt(":");
try {
final ConsoleApplication appl = new ConsoleApplication(swtConsole, swtConsole,
"Hello", "See you");
appl.add(new ExitCommand("exit", appl));
appl.add(new Command("long") {
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
try {
Thread.sleep(TWO_SECONDS);
} catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
@Override
public String tip() {
return "a long running command";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
// TODO Auto-generated method stub
// return null;
throw new RuntimeException("Not implemented yet");
}
});
appl.add(new Command("test") {
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
try {
swtConsole.prompt("Test");
} catch (final IOException e) {
throw new CommandRunException("No input", e);
}
}
@Override
public String tip() {
return "a prompting running command";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
// TODO Auto-generated method stub
// return null;
throw new RuntimeException("Not implemented yet");
}
});
// shell.pack();
shell.open();
shell.setVisible(false);
final Thread applThread = new Thread(new Runnable() {
@Override
public void run() {
appl.start();
}
});
final Thread testThread = new Thread(new Runnable() {
@Override
public void run() {
try {
Thread.sleep(TWO_SECONDS);
} catch (final 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();
}
});
Display.getDefault().syncExec(new Runnable() {
@Override
public void run() {
swtConsole.setText("ok"); //$NON-NLS-1$
}
});
swtConsole.validateInput();
Display.getDefault().syncExec(new Runnable() {
@Override
public void run() {
swtConsole.setText("long"); //$NON-NLS-1$
}
});
swtConsole.validateInput();
Display.getDefault().syncExec(new Runnable() {
@Override
public void run() {
swtConsole.setText("test"); //$NON-NLS-1$
}
});
swtConsole.validateInput();
Display.getDefault().syncExec(new Runnable() {
@Override
public void run() {
swtConsole.setText("test"); //$NON-NLS-1$
}
});
swtConsole.validateInput();
try {
Thread.sleep(TWO_SECONDS);
} catch (final 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();
}
}
swtConsole.setPrompt(">");
try {
swtConsole.prompt();
fail("Prompting when closed should fail!");
} catch (final IOException e) {
assertNotNull(e);
}
// DISPLAY.dispose();
assertTrue(swtConsole.isClosed());
Thread.sleep(TWO_SECONDS);
assertFalse(appl.isRunning());
} catch (final InvalidCommandName e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
public void testConnect() {
final SWTConsole console = new SWTConsole(new Shell(), SWT.NONE);
// Disconnection should work.
console.connect(null, null, null);
}
}

View File

@@ -1,37 +1,5 @@
/*
* GCLC swt, provide a swt window for console applications
* Copyright (C) 2015-2017 E. Bigeon
* mailto:emmanuel@bigeon.fr
*
* 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:net.bigeon.gclc.swt.SWTConsoleShellTest.java
* Created on: Jun 8, 2016
*
*/
package net.bigeon.gclc.swt;
@@ -46,13 +14,13 @@ package net.bigeon.gclc.swt;
* 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,
@@ -63,142 +31,48 @@ package net.bigeon.gclc.swt;
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import static org.junit.Assert.assertNull;
import java.io.IOException;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell;
import org.junit.Test;
import net.bigeon.gclc.ConsoleApplication;
import net.bigeon.gclc.command.Command;
import net.bigeon.gclc.command.base.ExitCommand;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.InvalidCommandName;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
import net.bigeon.gclc.utils.PipedConsoleInput;
import net.bigeon.gclc.utils.PipedConsoleOutput;
import net.bigeon.gclc.manager.PipedConsoleInput;
import net.bigeon.gclc.manager.PipedConsoleOutput;
/**
* <p>
* TODO
*
* @author Emmanuel Bigeon */
@SuppressWarnings({ "javadoc", "static-method", "nls", "deprecation" })
/** @author Emmanuel Bigeon */
public class SWTConsoleViewTest {
protected static final long TWO_SECONDS = 2000;
private static final Display DISPLAY = Display.getDefault();
/** Test method for {@link net.bigeon.gclc.swt.SWTConsoleView#setFocus()}. */
@Test
public void testGeneric() {
final Shell shell = new Shell(DISPLAY);
final SWTConsoleView swtConsole = new SWTConsoleView(shell, SWT.NONE);
try (PipedConsoleOutput manager = new PipedConsoleOutput();
PipedConsoleInput input = new PipedConsoleInput(System.out)) {
swtConsole.setManager(manager, input);
} catch (final IOException e2) {
assertNull(e2);
}
try (PipedConsoleOutput manager = new PipedConsoleOutput();
PipedConsoleInput input = new PipedConsoleInput(System.out)) {
swtConsole.setManager(manager, input);
final ConsoleApplication appl = new ConsoleApplication(manager, input,
"Hello", "See you");
appl.add(new ExitCommand("exit", appl));
appl.add(new Command("long") {
public void testSetFocus() {
final SWTConsoleView view = new SWTConsoleView(new Shell(), SWT.NONE);
assertFalse("Non visible component set focus should fail", view.setFocus());
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
* java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
try {
Thread.sleep(TWO_SECONDS);
} catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
/** Test method for
* {@link net.bigeon.gclc.swt.SWTConsoleView#SWTConsoleView(org.eclipse.swt.widgets.Composite, int)}. */
@Test
public void testSWTConsoleView() {
final SWTConsoleView view = new SWTConsoleView(new Shell(), SWT.NONE);
assertNotNull("View should be initialized with managers", view.getInputManager());
assertNotNull("View should be initialized with managers",
view.getOutputManager());
}
@Override
public String tip() {
return "a long running command";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
// TODO Auto-generated method stub
// return null;
throw new RuntimeException("Not implemented yet");
}
});
// shell.pack();
shell.open();
shell.setVisible(false);
final Thread applThread = new Thread(new Runnable() {
@Override
public void run() {
appl.start();
}
});
final Thread testThread = new Thread(new Runnable() {
@Override
public void run() {
try {
Thread.sleep(TWO_SECONDS);
} catch (final 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 (final 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 (final InvalidCommandName e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (final IOException e1) {
// TODO Auto-generated catch block
e1.printStackTrace();
}
/** Test method for
* {@link net.bigeon.gclc.swt.SWTConsoleView#setManager(PipedConsoleOutput, PipedConsoleInput)}. */
@Test
public void testSetManager() {
final SWTConsoleView view = new SWTConsoleView(new Shell(), SWT.NONE);
// Disconnection should work.
view.setManager(null, null);
}
}

View File

@@ -0,0 +1 @@
mock-maker-inline

79
gclc-test/pom.xml Normal file
View File

@@ -0,0 +1,79 @@
<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/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>net.bigeon.config</groupId>
<artifactId>ebigeon-config</artifactId>
<version>1.8.21</version>
</parent>
<groupId>net.bigeon.gclc</groupId>
<artifactId>test</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>GCLC Tests</name>
<description>Test utilities for GCLC applications and extensions</description>
<inceptionYear>2018</inceptionYear>
<organization>
<name>Bigeon</name>
<url>https://bigeon.net</url>
</organization>
<licenses>
<license>
<distribution>manual</distribution>
<name>CeCILL 2.1</name>
<url>https://cecill.info/licences/Licence_CeCILL_V2.1-en.html</url>
</license>
</licenses>
<developers>
<developer>
<email>emmanuel@bigeon.fr</email>
<name>Emmanuel Bigeon</name>
<url>bigeon.net</url>
<roles>
<role>PM</role>
</roles>
</developer>
</developers>
<scm>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<tag>HEAD</tag>
</scm>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<license.licenseName>cecill_2.1</license.licenseName>
</properties>
<dependencies>
<dependency>
<groupId>net.bigeon</groupId>
<artifactId>gclc</artifactId>
<version>2.0.12</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
</dependency>
<dependency>
<groupId>net.bigeon.test</groupId>
<artifactId>junitmt</artifactId>
<version>1.0.2</version>
</dependency>
</dependencies>
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.3</version>
</plugin>
<plugin>
<groupId>com.github.sevntu-checkstyle</groupId>
<artifactId>dsm-maven-plugin</artifactId>
<version>2.2.0</version>
</plugin>
</plugins>
</reporting>
</project>

View File

@@ -0,0 +1,62 @@
/**
*
*/
package net.bigeon.gclc.test;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.io.IOException;
import java.io.InterruptedIOException;
import java.util.function.Supplier;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.test.junitmt.FunctionalTestRunnable;
import net.bigeon.test.junitmt.TestFunction;
import net.bigeon.test.junitmt.ThreadTest;
/** @author Emmanuel Bigeon */
public final class InputContract {
public void testInputContract(final Supplier<ConsoleInput> inputs)
throws IOException, InterruptedException {
// Test close contract
final ConsoleInput input = inputs.get();
assertFalse("An input should not initially be closed", input.isClosed());
input.close();
assertTrue("An input should close", input.isClosed());
input.close();
assertTrue("A closed input should stay closed", input.isClosed());
try {
input.prompt();
fail("Closed input prompting should fail");
} catch (final IOException e) {
// ok
}
// Test interruption contract
final ConsoleInput input2 = inputs.get();
final FunctionalTestRunnable prompting = new FunctionalTestRunnable(
new TestFunction() {
@Override
public void apply() throws Exception {
try {
input2.prompt();
fail("Interrupted prompt should throw INterruptedIOException");
} catch (final InterruptedIOException e) {
// ok
}
}
});
final Thread th = new Thread(prompting);
th.start();
// while (!input2.isPrompting()) {
th.join(200);
//
// }
input2.interruptPrompt();
ThreadTest.assertRuns(th, prompting);
}
}

View File

@@ -3,12 +3,12 @@
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>net.bigeon.config</groupId>
<artifactId>ebigeon-config</artifactId>
<version>1.8.21</version>
<artifactId>ebigeon-public-conf</artifactId>
<version>1.0.10</version>
</parent>
<groupId>net.bigeon</groupId>
<artifactId>gclc</artifactId>
<version>2.0.12</version>
<version>2.1.1</version>
<packaging>jar</packaging>
<name>Generic Command Ligne console</name>
<description>A generic framework for console applications, with customized command input and output streams.</description>
@@ -37,7 +37,7 @@
</developers>
<scm>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<tag>gclc-2.0.12</tag>
<tag>gclc-2.1.1</tag>
</scm>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

View File

@@ -95,8 +95,8 @@ import net.bigeon.gclc.manager.ConsoleOutput;
* A typical use case is the following:
*
* <pre>
* {@link ConsoleOutput} out = new {@link net.bigeon.gclc.utils.StreamConsoleOutput StreamConsoleOutput}();
* {@link ConsoleInput} in = new {@link net.bigeon.gclc.utils.StreamConsoleInput StreamConsoleInput}();
* {@link ConsoleOutput} out = new {@link net.bigeon.gclc.manager.StreamConsoleOutput StreamConsoleOutput}();
* {@link ConsoleInput} in = new {@link net.bigeon.gclc.manager.StreamConsoleInput StreamConsoleInput}();
* {@link ConsoleApplication} app = new {@link ConsoleApplication}(out, in, "welcome", "see you latter")};
* app.{@link ConsoleApplication#add(ICommand) add}("my_command", new {@link ICommand MyCommand()});
* app.{@link ConsoleApplication#start() start()};

View File

@@ -164,7 +164,7 @@ public final class GCLCConstants {
}
if (startIndex < cmd.length()) {
final String arg = cmd.substring(startIndex, cmd.length());
args.add(arg);
args.add(removeEscaped(arg));
}
return args;
}

View File

@@ -116,8 +116,7 @@ public abstract class ParametrizedCommand extends Command {
* @param flag the boolean flag
* @throws InvalidParameterException if the parameter is already defined as a
* string parameter */
protected final void addBooleanParameter(final String flag)
throws InvalidParameterException {
protected final void addBooleanParameter(final String flag) {
data.addBooleanParameter(flag);
}
@@ -127,8 +126,7 @@ public abstract class ParametrizedCommand extends Command {
* @param needed if the parameter's absence should cause an exception
* @throws InvalidParameterException if the parameter is already defined as a
* boolean parameter */
protected final void addStringParameter(final String flag, final boolean needed)
throws InvalidParameterException {
protected final void addStringParameter(final String flag, final boolean needed) {
data.addStringParameter(flag, needed);
}

View File

@@ -85,7 +85,7 @@ import java.util.concurrent.ConcurrentHashMap;
import net.bigeon.gclc.exception.CommandParsingException;
import net.bigeon.gclc.exception.InvalidParameterException;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.utils.EmptyInput;
import net.bigeon.gclc.manager.EmptyInput;
/** An object to handle standardized command parameters.
*
@@ -120,7 +120,7 @@ public final class ParametrizedCommandData {
* @param flag the boolean flag
* @throws InvalidParameterException if the parameter is already defined as a
* string parameter */
public void addBooleanParameter(final String flag) throws InvalidParameterException {
public void addBooleanParameter(final String flag) {
if (params.containsKey(flag) && stringParams.containsKey(flag)) {
throw new InvalidParameterException("Parameter is already defined as string"); //$NON-NLS-1$
}
@@ -134,8 +134,7 @@ public final class ParametrizedCommandData {
* @param needed if the parameter's absence should cause an exception
* @throws InvalidParameterException if the parameter is already defined as a
* boolean parameter */
public void addStringParameter(final String flag, final boolean needed)
throws InvalidParameterException {
public void addStringParameter(final String flag, final boolean needed) {
if (params.containsKey(flag)) {
checkParam(flag, needed);
return;
@@ -149,9 +148,8 @@ public final class ParametrizedCommandData {
* @param param the string parameter
* @param needed if the parameter is needed
* @throws InvalidParameterException if the new definition is invalid */
private void checkParam(final String param, final boolean needed)
throws InvalidParameterException {
Boolean val = stringParams.get(param);
private void checkParam(final String param, final boolean needed) {
final Boolean val = stringParams.get(param);
if (val != null) {
final Boolean need = Boolean.valueOf(needed || val.booleanValue());
stringParams.put(param, need);
@@ -217,7 +215,7 @@ public final class ParametrizedCommandData {
* @param param the parameter name
* @return if the parameter is needed */
public boolean isNeeded(final String param) {
Boolean val = params.get(param);
final Boolean val = params.get(param);
return val != null && val.booleanValue();
}

View File

@@ -1,100 +1,133 @@
/*
* ralph.runner, Runs RALPH (belongs to IREQ) in sequence for several days
* Copyright (C) 2016-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr
*
* 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.
*/
/**
*
*/
package net.bigeon.gclc.command.base;
import java.io.IOException;
import java.text.MessageFormat;
import java.util.Arrays;
import net.bigeon.gclc.command.Command;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
/** A command printing test to the console.
* <p>
* This command mimics the effect of the echo command in linux system. The
* difference is this command accepts java like formatting.
*
* <pre>
* echo.execute(out, in, "My Formatted {0}, with {1}", "message", "short arguments");
* </pre>
*
* @author Emmanuel Bigeon */
public class EchoCommand extends Command {
/** Create the command.
*
* @param name the command name */
public EchoCommand(final String name) {
super(name);
}
/* (non-Javadoc)
* @see
* fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.ConsoleOutput,
* fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
try {
if (args.length == 1) {
out.print(args[0]);
}
if (args.length > 1) {
out.print(MessageFormat.format(args[0],
(Object[]) Arrays.copyOfRange(args, 1, args.length)));
}
out.println();
} catch (final IOException e) {
throw new CommandRunException("Printing failed", e);
}
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@Override
public String tip() {
return "Print the message";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
return "A formatted message can be used";
}
}
/*
* ralph.runner, Runs RALPH (belongs to IREQ) in sequence for several days
* Copyright (C) 2016-2018 E. Bigeon
* mailto:emmanuel@bigeon.fr
*
* 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.
*/
/**
*
*/
package net.bigeon.gclc.command.base;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import java.io.IOException;
import java.text.MessageFormat;
import java.util.Arrays;
import net.bigeon.gclc.command.Command;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
/** A command printing test to the console.
* <p>
* This command mimics the effect of the echo command in linux system. The
* difference is this command accepts java like formatting.
*
* <pre>
* echo.execute(out, in, "My Formatted {0}, with {1}", "message", "short arguments");
* </pre>
*
* @author Emmanuel Bigeon */
public class EchoCommand extends Command {
/** Create the command.
*
* @param name the command name */
public EchoCommand(final String name) {
super(name);
}
/* (non-Javadoc)
* @see
* fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.ConsoleOutput,
* fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[]) */
@Override
public void execute(final ConsoleOutput out, final ConsoleInput in,
final String... args) throws CommandRunException {
try {
if (args.length == 1) {
out.print(args[0]);
}
if (args.length > 1) {
out.print(MessageFormat.format(args[0],
(Object[]) Arrays.copyOfRange(args, 1, args.length)));
}
out.println();
} catch (final IOException e) {
throw new CommandRunException("Printing failed", e);
}
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@Override
public String tip() {
return "Print the message";
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.Command#usageDetail() */
@Override
protected String usageDetail() {
return "A formatted message can be used";
}
}

View File

@@ -74,7 +74,7 @@ package net.bigeon.gclc.exception;
/** An exception raised during command parsing.
*
* @author Emmanuel Bigeon */
public class CommandParsingException extends Exception {
public final class CommandParsingException extends Exception {
/** svuid. */
private static final long serialVersionUID = 1L;

View File

@@ -75,7 +75,7 @@ package net.bigeon.gclc.exception;
* the command is already used.
*
* @author Emmanuel BIGEON */
public class InvalidCommandName extends Exception {
public final class InvalidCommandName extends Exception {
/** the SVUID. */
private static final long serialVersionUID = 1L;

View File

@@ -75,7 +75,7 @@ package net.bigeon.gclc.exception;
* parameter definition.
*
* @author Emmanuel Bigeon */
public class InvalidParameterException extends Exception {
public final class InvalidParameterException extends RuntimeException {
/** the SVUID. */
private static final long serialVersionUID = 1L;

View File

@@ -94,8 +94,7 @@ public interface ConsoleInput extends AutoCloseable {
/** Indicate to the input 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). */
* return immediately by throwing an InterruptedIOException. */
void interruptPrompt();
/** Test if the input is closed.

View File

@@ -36,12 +36,10 @@
* gclc:net.bigeon.gclc.manager.EmptyInput.java
* Created on: Nov 13, 2017
*/
package net.bigeon.gclc.utils;
package net.bigeon.gclc.manager;
import java.util.function.Supplier;
import net.bigeon.gclc.manager.ConsoleInput;
/*-
* #%L
* Generic Command Ligne console

View File

@@ -36,7 +36,7 @@
* gclc-test:net.bigeon.gclc.test.TestConsoleManager.java
* Created on: Nov 18, 2016
*/
package net.bigeon.gclc.utils;
package net.bigeon.gclc.manager;
/*-
* #%L
@@ -78,7 +78,7 @@ import java.io.PrintStream;
import java.nio.charset.StandardCharsets;
import java.util.function.Supplier;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.utils.WritingRunnable;
/** This console input allows to enter commands and retrieve the output as an
* input.

View File

@@ -36,7 +36,7 @@
* gclc-test:net.bigeon.gclc.test.TestConsoleManager.java
* Created on: Nov 18, 2016
*/
package net.bigeon.gclc.utils;
package net.bigeon.gclc.manager;
/*-
* #%L
@@ -79,7 +79,7 @@ import java.io.PipedOutputStream;
import java.io.PrintStream;
import java.nio.charset.StandardCharsets;
import net.bigeon.gclc.manager.ConsoleOutput;
import net.bigeon.gclc.utils.ReadingRunnable;
/** This console output allows to retrieve the output as an input.
* <p>

View File

@@ -36,9 +36,7 @@
* gclc:net.bigeon.gclc.manager.SinkOutput.java
* Created on: Nov 13, 2017
*/
package net.bigeon.gclc.utils;
import net.bigeon.gclc.manager.ConsoleOutput;
package net.bigeon.gclc.manager;
/*-
* #%L

View File

@@ -36,7 +36,7 @@
* gclc:net.bigeon.gclc.system.SystemConsoleManager.java
* Created on: Dec 19, 2014
*/
package net.bigeon.gclc.utils;
package net.bigeon.gclc.manager;
/*-
* #%L
@@ -79,8 +79,8 @@ import java.io.PrintStream;
import java.nio.charset.Charset;
import java.util.function.Supplier;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.tools.ConstantString;
import net.bigeon.gclc.utils.ReadingRunnable;
/** A console using the input stream and print stream.
* <p>

View File

@@ -36,7 +36,7 @@
* gclc:net.bigeon.gclc.system.SystemConsoleManager.java
* Created on: Dec 19, 2014
*/
package net.bigeon.gclc.utils;
package net.bigeon.gclc.manager;
/*-
* #%L
@@ -74,8 +74,6 @@ package net.bigeon.gclc.utils;
import java.io.IOException;
import java.io.PrintStream;
import net.bigeon.gclc.manager.ConsoleOutput;
/** A console using the input stream and print stream.
* <p>
* The default constructor will use the system standart input and output.

View File

@@ -36,7 +36,7 @@
* gclc:net.bigeon.gclc.tools.AOutputForwardRunnable.java
* Created on: Dec 1, 2016
*/
package net.bigeon.gclc.utils;
package net.bigeon.gclc.manager.forwarding;
/*-
* #%L
@@ -75,6 +75,8 @@ import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
import net.bigeon.gclc.manager.PipedConsoleOutput;
/** An incomplete implematation used to forward messages from a piped console.
* <p>
* This forwarding can be interrupted without closing the piped manager.
@@ -88,9 +90,9 @@ public abstract class AOutputForwardRunnable implements Runnable {
/** The default timeout (one tenth of second). */
private static final long DEFAULT_TIMEOUT = 100;
/** The manager. */
private final PipedConsoleOutput manager;
protected final PipedConsoleOutput manager;
/** The timeout. */
private final long timeout;
protected final long timeout;
/** Create a forwarding runnable.
*

View File

@@ -0,0 +1,43 @@
/**
*
*/
/** This package contains the {@link java.lang.Runnable} implementations used to
* forward messages to or from console output or input.
*
* @author Emmanuel Bigeon */
package net.bigeon.gclc.manager.forwarding;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/

View File

@@ -111,6 +111,7 @@ public final class ReadingRunnable implements Runnable {
private final Map<String, Object> messageBlocker = new ConcurrentHashMap<>();
/** The lock. */
private final Object messageBlockerLock = new Object();
private boolean interrupting = false;
/** Create a reading runnable.
*
* @param reader the input to read from */
@@ -146,7 +147,7 @@ public final class ReadingRunnable implements Runnable {
public String getMessage() throws IOException {
synchronized (lock) {
if (!messages.isEmpty()) {
return messages.poll();
return pollMessage();
}
if (!running) {
throw new IOException(CLOSED_PIPE);
@@ -155,8 +156,7 @@ public final class ReadingRunnable implements Runnable {
waitMessage(TIMEOUT);
LOGGER.log(Level.FINEST, "Polled: {0}", messages.peek()); //$NON-NLS-1$
waiting = false;
notifyMessage(messages.peek());
return messages.poll();
return pollMessage();
}
}
@@ -168,7 +168,7 @@ public final class ReadingRunnable implements Runnable {
public String getNextMessage(final long timeout) throws IOException {
synchronized (lock) {
if (!messages.isEmpty()) {
return messages.poll();
return pollMessage();
}
if (!running) {
throw new IOException(CLOSED_PIPE);
@@ -179,10 +179,23 @@ public final class ReadingRunnable implements Runnable {
if (messages.isEmpty()) {
return null;
}
return messages.poll();
return pollMessage();
}
}
private String pollMessage() throws InterruptedIOException {
final String msg = messages.poll();
if (msg.isEmpty() && interrupting) {
throw new InterruptedIOException();
}
notifyMessage(msg);
return msg;
}
/** Wait for a message to be delivered.
*
* @param message the message
* @throws InterruptedException if the wait was interrupted */
public void waitForDelivery(final String message) throws InterruptedException {
Object mLock;
synchronized (messageBlockerLock) {
@@ -214,7 +227,8 @@ public final class ReadingRunnable implements Runnable {
public void interrupt() {
synchronized (lock) {
if (waiting) {
messages.offer(""); //$NON-NLS-1$
messages.offer("");
interrupting = true;
lock.notifyAll();
}
}

View File

@@ -75,8 +75,8 @@ import java.io.IOException;
import net.bigeon.gclc.command.ICommand;
import net.bigeon.gclc.exception.InvalidCommandName;
import net.bigeon.gclc.utils.PipedConsoleInput;
import net.bigeon.gclc.utils.PipedConsoleOutput;
import net.bigeon.gclc.manager.PipedConsoleInput;
import net.bigeon.gclc.manager.PipedConsoleOutput;
/**
* <p>

View File

@@ -95,8 +95,8 @@ import net.bigeon.gclc.exception.InvalidCommandName;
import net.bigeon.gclc.i18n.Messages;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
import net.bigeon.gclc.utils.PipedConsoleInput;
import net.bigeon.gclc.utils.PipedConsoleOutput;
import net.bigeon.gclc.manager.PipedConsoleInput;
import net.bigeon.gclc.manager.PipedConsoleOutput;
/** Test class for ConsoleApplication
*

View File

@@ -82,7 +82,7 @@ import org.junit.Test;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
import net.bigeon.gclc.utils.PipedConsoleOutput;
import net.bigeon.gclc.manager.PipedConsoleOutput;
/**
* <p>

View File

@@ -83,7 +83,7 @@ import net.bigeon.gclc.command.base.MockCommand;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
import net.bigeon.gclc.utils.PipedConsoleOutput;
import net.bigeon.gclc.manager.PipedConsoleOutput;
/**
* <p>

View File

@@ -1,5 +1,39 @@
package net.bigeon.gclc.command;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import static org.junit.Assert.*;
import org.junit.Test;

View File

@@ -91,8 +91,8 @@ import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.InvalidParameterException;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
import net.bigeon.gclc.utils.PipedConsoleInput;
import net.bigeon.gclc.utils.PipedConsoleOutput;
import net.bigeon.gclc.manager.PipedConsoleInput;
import net.bigeon.gclc.manager.PipedConsoleOutput;
import net.bigeon.test.junitmt.ATestRunnable;
import net.bigeon.test.junitmt.FunctionalTestRunnable;
import net.bigeon.test.junitmt.TestFunction;

View File

@@ -85,8 +85,8 @@ import net.bigeon.gclc.ConsoleTestApplication;
import net.bigeon.gclc.command.base.ScriptExecution;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.CommandRunExceptionType;
import net.bigeon.gclc.utils.PipedConsoleInput;
import net.bigeon.gclc.utils.PipedConsoleOutput;
import net.bigeon.gclc.manager.PipedConsoleInput;
import net.bigeon.gclc.manager.PipedConsoleOutput;
/**
* <p>

View File

@@ -85,7 +85,7 @@ import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.exception.InvalidCommandName;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
import net.bigeon.gclc.utils.PipedConsoleOutput;
import net.bigeon.gclc.manager.PipedConsoleOutput;
/**
* <p>

View File

@@ -1,5 +1,39 @@
package net.bigeon.gclc.command.base;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.fail;
@@ -9,7 +43,7 @@ import java.io.IOException;
import org.junit.Test;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.utils.PipedConsoleOutput;
import net.bigeon.gclc.manager.PipedConsoleOutput;
public class EchoCommandTest {

View File

@@ -80,6 +80,7 @@ import java.io.BufferedWriter;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.InterruptedIOException;
import java.io.OutputStreamWriter;
import java.io.PipedInputStream;
import java.io.PipedOutputStream;
@@ -90,6 +91,9 @@ import org.junit.Before;
import org.junit.Test;
import net.bigeon.gclc.utils.ReadingRunnable;
import net.bigeon.test.junitmt.FunctionalTestRunnable;
import net.bigeon.test.junitmt.TestFunction;
import net.bigeon.test.junitmt.ThreadTest;
/**
* <p>
@@ -198,9 +202,11 @@ public class ReadingRunnableTest {
public final void testGetPendingMessages() throws IOException, InterruptedException {
final PipedOutputStream out = new PipedOutputStream();
final BufferedReader reader = new BufferedReader(new InputStreamReader(new PipedInputStream(out), StandardCharsets.UTF_8));
final BufferedReader reader = new BufferedReader(
new InputStreamReader(new PipedInputStream(out), StandardCharsets.UTF_8));
final ReadingRunnable runnable = new ReadingRunnable(reader);
final BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(out, StandardCharsets.UTF_8));
final BufferedWriter writer = new BufferedWriter(
new OutputStreamWriter(out, StandardCharsets.UTF_8));
writer.write("one");
writer.newLine();
writer.write("two");
@@ -222,4 +228,30 @@ public class ReadingRunnableTest {
// ok
}
}
@Test
public void testInterruption() throws IOException, InterruptedException {
final PipedOutputStream out = new PipedOutputStream();
final BufferedReader reader = new BufferedReader(
new InputStreamReader(new PipedInputStream(out), StandardCharsets.UTF_8));
final ReadingRunnable runnable = new ReadingRunnable(reader);
final FunctionalTestRunnable test = new FunctionalTestRunnable(
new TestFunction() {
@Override
public void apply() throws IOException {
try {
runnable.getMessage();
fail("Message interruption should cause an exception");
} catch (final InterruptedIOException e) {
// ok
}
}
});
final Thread th = new Thread(test, "Prompt wait");
th.start();
th.join(200);
runnable.interrupt();
ThreadTest.assertRuns(th, test);
}
}

View File

@@ -85,8 +85,6 @@ import java.nio.charset.Charset;
import org.junit.Test;
import net.bigeon.gclc.utils.StreamConsoleInput;
/**
* <p>
* TODO

View File

@@ -92,8 +92,8 @@ import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import net.bigeon.gclc.utils.PipedConsoleInput;
import net.bigeon.gclc.utils.PipedConsoleOutput;
import net.bigeon.gclc.manager.PipedConsoleInput;
import net.bigeon.gclc.manager.PipedConsoleOutput;
import net.bigeon.test.junitmt.ATestRunnable;
import net.bigeon.test.junitmt.FunctionalTestRunnable;
import net.bigeon.test.junitmt.TestFunction;

View File

@@ -77,8 +77,8 @@ import java.io.IOException;
import org.junit.Test;
import net.bigeon.gclc.utils.AOutputForwardRunnable;
import net.bigeon.gclc.utils.PipedConsoleOutput;
import net.bigeon.gclc.manager.PipedConsoleOutput;
import net.bigeon.gclc.manager.forwarding.AOutputForwardRunnable;
/**
* <p>
@@ -143,7 +143,7 @@ public class AOutputForwardRunnableTest {
}
/** Test method for
* {@link net.bigeon.gclc.utils.AOutputForwardRunnable#run()}. */
* {@link net.bigeon.gclc.manager.forwarding.AOutputForwardRunnable#run()}. */
@Test
public final void testRun() {
try (PipedConsoleOutput manager = new PipedConsoleOutput()) {

View File

@@ -1,5 +1,39 @@
package net.bigeon.gclc.utils;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
@@ -8,6 +42,7 @@ import java.io.IOException;
import org.junit.Test;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.EmptyInput;
import net.bigeon.gclc.tools.ConstantString;
public class EmptyInputTest {

View File

@@ -1,5 +1,39 @@
package net.bigeon.gclc.utils;
/*-
* #%L
* Generic Command Ligne console
* %%
* Copyright (C) 2014 - 2018 Bigeon
* %%
* This software is governed by the CeCILL license under French law and
* abiding by the rules of distribution of free software. You can use,
* modify and/ or redistribute the software under the terms of the CeCILL
* license as circulated by CEA, CNRS and INRIA at the following URL
* "http://www.cecill.info".
*
* As a counterpart to the access to the source code and rights to copy,
* modify and redistribute granted by the license, users are provided only
* with a limited warranty and the software's author, the holder of the
* economic rights, and the successive licensors have only limited
* liability.
*
* In this respect, the user's attention is drawn to the risks associated
* with loading, using, modifying and/or developing or reproducing the
* software by the user in light of its specific status of free software,
* that may mean that it is complicated to manipulate, and that also
* therefore means that it is reserved for developers and experienced
* professionals having in-depth computer knowledge. Users are therefore
* encouraged to load and test the software's suitability as regards their
* requirements in conditions enabling the security of their systems and/or
* data to be ensured and, more generally, to use and operate it in the
* same conditions as regards security.
*
* The fact that you are presently reading this means that you have had
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import static org.junit.Assert.assertFalse;
import java.io.IOException;
@@ -7,6 +41,7 @@ import java.io.IOException;
import org.junit.Test;
import net.bigeon.gclc.manager.ConsoleOutput;
import net.bigeon.gclc.manager.SinkOutput;
public class SinkOutputTest {