Compare commits

...

94 Commits

Author SHA1 Message Date
999c97dbf8 [maven-release-plugin] prepare release gclc-2.1.5 2022-02-05 10:53:55 +01:00
a9916eacab [chore] Update pom scm. Skip gclc-2.1.4
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2022-02-05 10:51:39 +01:00
fe942533cd [maven-release-plugin] prepare release gclc-2.1.4 2022-02-05 10:47:50 +01:00
a31c13ef1b [chore] Pom update scm. skip gclc 2.1.3 release.
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2022-02-05 10:45:42 +01:00
c7c53d15c5 [maven-release-plugin] prepare release gclc-2.1.3 2022-02-05 10:42:37 +01:00
d86a254604 Merge branch 'master' into dev 2022-02-05 10:39:23 +01:00
3d9b0d039a [Jenkins] Dependency Updates 2022-01-27 12:20:02 +01:00
39ae13e01a [Jenkins] Dependency Updates 2022-01-27 04:39:08 +01:00
eeea0148f6 Merge branch 'master' into dev 2022-01-05 17:14:28 +01:00
a25360f50f [Jenkins] Dependency Updates 2021-12-23 12:19:02 +01:00
4212776bb9 [Jenkins] Dependency Updates 2021-12-23 04:38:08 +01:00
4d42dff80a [Jenkins] Dependency Updates 2021-11-25 12:19:02 +01:00
d680694d0a [Jenkins] Dependency Updates 2021-11-25 04:38:07 +01:00
c174e90562 [test] Remove use of deprecated code in test
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2021-11-22 08:20:51 +01:00
6bb3ad2354 [test] Fix invalid cast
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2021-11-22 08:19:53 +01:00
0f731270d5 [test] Fix the test of history text listener
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2021-11-13 19:13:00 +01:00
45fa90c75e Merge branch 'master' into dev 2021-11-13 19:00:38 +01:00
da107f0a40 [doc] Added comments on a brain overloading method.
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2021-11-12 10:06:48 +01:00
14007f4d9a [fix] Remove use of deprecated code
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2021-11-12 10:00:06 +01:00
c500c3c046 [fix] Specify command type
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2021-11-12 09:53:35 +01:00
0c1cfe3946 [style] Set abstract class constructor as protected
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2021-11-12 09:52:11 +01:00
66d25697a8 [fix] Set waits inside loops
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2021-11-12 09:50:51 +01:00
a9c97a7ebc [chore] Remove commented out code
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2021-11-12 09:31:49 +01:00
0acc900a7c [Jenkins] Dependency Updates 2021-11-11 12:19:03 +01:00
8025122906 [test] Complete tests.
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2021-11-10 11:14:08 +01:00
c8804fcd74 [Jenkins] Dependency Updates 2021-11-10 05:36:03 +01:00
80b8993e1f [Jenkins] Dependency Updates 2021-11-08 10:09:38 +01:00
625cacb198 [fix] Fix use of computeIfPresent with HashMap with possible null values
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2021-11-07 12:22:11 +01:00
ea01d346d3 [test] Use assert equals
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2021-11-07 12:13:13 +01:00
b38980eeb5 [chore] Move InterruptedIOException full name into documentation.
This avoids unnecessarily importing it.

Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2021-11-07 11:59:32 +01:00
7b7d0e6747 [style] protected context for constructor of abstract classes
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2021-11-07 11:57:13 +01:00
8643b69054 [refactor] Use mapping computeIfPresent/Absent for conditional branch
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2021-11-07 11:55:21 +01:00
d726312341 [fix] Use string concatenation in delegated function for logging
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2021-11-07 11:45:29 +01:00
2ece273148 [fix] Put wait in while loops to consider spurious interruptions.
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2021-11-07 11:44:20 +01:00
63de5448de [refactor] Reduced complexity of argument reading by one by refactoring
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2021-11-07 11:32:33 +01:00
51d8caa51e [fix] Unclosed stream wrapped in delegating stream.
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2021-11-07 11:22:40 +01:00
72f768e6de [fix] Bug in Test for interactive
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2021-11-07 11:20:38 +01:00
8f386b4abd [tests] Add test on input contract
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2020-04-10 15:58:30 -04:00
1454938db8 [fix] Fix imports in new version of tests
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2020-04-10 15:53:39 -04:00
2f24c30d44 [jenkins] Update configuration and dependency 2020-04-06 06:25:29 -04:00
c97e5de32e [chore] update dependencies
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2020-04-04 12:45:33 -04:00
3df6482a64 [tests] Fix failing test because of incoherent assertion
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2020-04-04 11:48:53 -04:00
5c7635f550 Fix cycle
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2019-06-09 12:13:41 -04:00
54a267092d Moved util class to the right package
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2019-06-08 20:13:39 -04:00
c1ce1277d3 Extract interface as method return
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2019-06-08 20:09:03 -04:00
ba61efaa4a Add test with long execution command
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2019-06-08 19:59:26 -04:00
7a2991acc1 Reduce line duplication due to moved class
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2019-06-08 12:05:50 -04:00
fe8f0212ea [maven-release-plugin] prepare for next development iteration 2019-06-08 11:34:22 -04:00
a0a1dfe91e [maven-release-plugin] prepare release gclc-2.1.2 2019-06-08 11:34:17 -04:00
04902c9868 Remove unecessary method call
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2019-06-08 11:27:20 -04:00
9cf30ef7d2 #4 #5 Update exception of script command
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2019-06-08 10:55:35 -04:00
3960b10e8e #3 Add null chack for command name
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2019-06-08 10:50:51 -04:00
d3bb6fa5a0 Add eof new line
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2019-05-07 09:08:23 -04:00
b6b6ab9d36 Cut cycle
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2019-05-06 21:19:42 -04:00
92a664d193 Fix javadoc
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2019-05-06 21:14:26 -04:00
c230a23f81 Fix toString ternary operator presence
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2019-05-06 21:14:18 -04:00
e5c3bb0152 Replace ConstantString by lambda expression
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2019-05-06 20:51:12 -04:00
24e57eca2f Adding shell start up wait method.
Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
2019-05-06 20:31:37 -04:00
da8765dd7b [maven-release-plugin] prepare for next development iteration 2019-05-06 20:00:30 -04:00
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
74 changed files with 1216 additions and 647 deletions

View File

@@ -3,12 +3,12 @@
<parent>
<groupId>net.bigeon.config</groupId>
<artifactId>ebigeon-config</artifactId>
<version>1.8.21</version>
<version>1.8.29</version>
</parent>
<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>
@@ -38,7 +38,7 @@
</developers>
<scm>
<tag>HEAD</tag>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<developerConnection>scm:git:gitea@git.code.bigeon.net:emmanuel/gclc-core.git</developerConnection>
</scm>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@@ -49,12 +49,12 @@
<dependency>
<groupId>net.bigeon</groupId>
<artifactId>gclc</artifactId>
<version>2.0.12</version>
<version>2.1.2</version>
</dependency>
<dependency>
<groupId>net.bigeon.test</groupId>
<artifactId>junitmt</artifactId>
<version>1.0.2</version>
<version>1.0.4</version>
<scope>test</scope>
</dependency>
</dependencies>

View File

@@ -100,7 +100,7 @@ public abstract class ForkTask implements Task {
/** Create the task.
*
* @param lines the number of print to store in the output */
public ForkTask(final int lines) {
protected ForkTask(final int lines) {
out = new ConnectingConsoleOutput(ConnectingConsoleOutput.PERSIST, lines);
}
@@ -142,15 +142,18 @@ public abstract class ForkTask implements Task {
* @param timeout the maximal time to join for (0 for ever) */
public final void join(final ConsoleOutput out, final ConsoleInput in,
final long timeout) {
final long tic = System.currentTimeMillis();
synchronized (runLock) {
this.out.connect(out);
this.in.connect(in);
try {
if (running) {
long tac = System.currentTimeMillis() - tic;
while (running && tac < timeout) {
try {
runLock.wait(timeout);
} catch (final InterruptedException e) {
Thread.currentThread().interrupt();
}
} catch (final InterruptedException e) {
Thread.currentThread().interrupt();
tac = System.currentTimeMillis() - tic;
}
this.out.disconnect();
this.in.disconnect();

View File

@@ -84,8 +84,8 @@ public abstract class TaskSpawner extends Command {
private final ExecutorService threadPool;
/** @param name the command name
* @param pool the pool */
public TaskSpawner(final String name, final TaskPool pool,
* @param threadPool the pool */
protected TaskSpawner(final String name, final TaskPool pool,
final ExecutorService threadPool) {
super(name);
this.pool = pool;

View File

@@ -68,39 +68,38 @@ package net.bigeon.gclc.process.io;
* #L%
*/
import java.io.IOException;
import java.io.InterruptedIOException;
import java.util.function.Supplier;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.tools.ConstantString;
/** A console input that can be connected to and diconnected from.
*
* @author Emmanuel Bigeon */
public final class ConnectingConsoleInput implements ConsoleInput {
/** The empty string provider. */
private static final ConstantString EMPTY_STRING = new ConstantString("");
/** If the input is closed. */
private boolean close = false;
private boolean close = false;
/** The prompt string. */
private Supplier<String> prompt = EMPTY_STRING;
private Supplier<String> prompt = () -> "";
/** 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() */
@@ -149,6 +148,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();
@@ -187,32 +189,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)
@@ -222,52 +199,114 @@ 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);
}
/** Actually do the prompting
*
* @param message the prompt message
* @param timeout the time to wait for an answer
* @param tic the moment the wait started
* @return the message provided through the prompting
* @throws IOException if an IO error occurred while prompting. */
private String doPrompt(final String message, final long timeout, final long tic)
throws IOException {
do {
synchronized (promptLock) {
if (!prompting) {
break;
}
if (!checkPrompt()) {
// We are not prompting... lets stop here.
break;
}
getConnection(timeout);
getConnection(getTimeoutLeft(tic, timeout));
boolean connect;
ConsoleInput actualConnected;
synchronized (connectionLock) {
connect = connected != null;
actualConnected = connected;
}
if (connect) {
if (!connect) {
// There is no provide of input... So lets start again, until we actually
// DO get a provider of input.
continue;
}
try {
final String res = actualPrompt(message, timeout, tic, actualConnected);
// We got something from the prompting
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) {
boolean connect;
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 {
final long tic = System.currentTimeMillis();
synchronized (connectionLock) {
connect = connected != null;
if (!connect) {
while ((connected == null || !interrupting)
&& (tic + timeout) > System.currentTimeMillis()) {
try {
connectionLock.wait(timeout);
} catch (final InterruptedException e) {
Thread.currentThread().interrupt();
}
}
if (interrupting) {
interrupting = false;
throw new InterruptedIOException("Prompt ws interrupted");
}
}
}
@@ -275,7 +314,7 @@ public final class ConnectingConsoleInput implements ConsoleInput {
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */
@Override
public void setPrompt(final String prompt) {
this.prompt = new ConstantString(prompt);
this.prompt = () -> prompt;
}
/* (non-Javadoc)

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,15 +39,11 @@ 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);
@@ -55,14 +54,103 @@ public class ForkTaskTest {
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

@@ -1,25 +1,23 @@
package net.bigeon.gclc.process.io;
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.*;
import java.io.IOException;
import java.io.InterruptedIOException;
import java.io.PipedInputStream;
import java.io.PipedOutputStream;
import java.nio.charset.StandardCharsets;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.function.Supplier;
import org.junit.Test;
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.gclc.manager.PipedConsoleInput;
import net.bigeon.gclc.manager.StreamConsoleInput;
import net.bigeon.test.junitmt.FunctionalTestRunnable;
import net.bigeon.test.junitmt.TestFunction;
import net.bigeon.test.junitmt.ThreadTest;
import net.bigeon.test.junitmt.api.ATestRunnable;
import net.bigeon.test.junitmt.api.TestFunction;
public class ConnectingConsoleInputTest {
@@ -65,9 +63,8 @@ public class ConnectingConsoleInputTest {
public void testCoveragePrompt() {
final ConnectingConsoleInput in = new ConnectingConsoleInput();
in.setPrompt("test");
assertEquals("Prompt should be set correctly", "test",
((ConstantString) in.getPrompt()).get());
final ConstantString prompt = new ConstantString("other");
assertEquals("Prompt should be set correctly", "test", in.getPrompt().get());
final Supplier<String> prompt = () -> "other";
in.setPrompt(prompt);
assertEquals("Prompt should be set correctly", prompt, in.getPrompt());
}
@@ -77,30 +74,44 @@ public class ConnectingConsoleInputTest {
final ConnectingConsoleInput in = new ConnectingConsoleInput();
// Unconnected
final AtomicBoolean ended = new AtomicBoolean(false);
final TestFunction one = new TestFunction() {
@Override
public void apply() throws Exception {
assertNull("Interrupted should return null", in.prompt("m1", -1));
assertNull("Interrupted should return null", in.prompt("m2", 5000));
final TestFunction one = () -> {
try {
final String res1 = in.prompt("m1", -1);
fail("interruption of infinite waiting prompt should cause error, but was "
+ res1);
} catch (final InterruptedIOException e1) {
// ok
}
try {
final String res2 = in.prompt("m2", 25000);
fail("interruption of finite waiting prompt should cause error, but was "
+ res2);
} catch (final InterruptedIOException e2) {
// ok
}
synchronized (ended) {
ended.set(true);
assertNull("Overtime should return null", in.prompt("m3", 200));
try {
assertNull("Overtime should return null", in.prompt("m3", 200));
} catch (final InterruptedIOException e3) {
fail("Unexpected interruption error in overtime");
}
}
};
final ATestRunnable runnable = new FunctionalTestRunnable(one);
final Thread th = new Thread(runnable);
final Thread inter = new Thread(new Runnable() {
@Override
public void run() {
while (!ended.get()) {
try {
th.join(500);
} catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
final Thread th = new Thread(runnable, "TestPromptSequence");
final Thread inter = new Thread(() -> {
while (!ended.get()) {
try {
th.join(100);
} catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
synchronized (ended) {
if (!ended.get()) {
in.interruptPrompt();
}
in.interruptPrompt();
}
}
});
@@ -112,21 +123,21 @@ 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() {
@Override
public void run() {
while (!ended.get()) {
try {
th2.join(500);
} catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
final Thread inter2 = new Thread(() -> {
while (!ended.get()) {
try {
th2.join(100);
} catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
synchronized (ended) {
if (!ended.get()) {
in.interruptPrompt();
}
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.12</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>
@@ -35,7 +35,7 @@
</developer>
</developers>
<scm>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<developerConnection>scm:git:gitea@git.code.bigeon.net:emmanuel/gclc-core.git</developerConnection>
<tag>HEAD</tag>
</scm>
<properties>
@@ -46,17 +46,17 @@
<dependency>
<groupId>net.bigeon</groupId>
<artifactId>gclc</artifactId>
<version>2.0.12</version>
<version>2.1.2</version>
</dependency>
<dependency>
<groupId>net.bigeon</groupId>
<artifactId>smu</artifactId>
<version>1.0.6</version>
<version>1.1.2</version>
</dependency>
<dependency>
<groupId>net.bigeon.test</groupId>
<artifactId>junitmt</artifactId>
<version>1.0.0</version>
<version>1.0.4</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,16 @@ 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.utils.ReadingRunnable;
/** A console input where the stream can be plugged.
@@ -75,7 +77,7 @@ public final class PluggableConsoleInput implements ConsoleInput {
/** If the element is closed. */
private boolean closed = false;
/** The default prompt. */
private Supplier<String> prompt = new ConstantString("> "); //$NON-NLS-1$
private Supplier<String> prompt = () -> "> "; //$NON-NLS-1$
/** If the input is plugged or buffering. */
private boolean connected = false;
/** The current connexion (if any). */
@@ -87,6 +89,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 +123,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,
@@ -257,7 +262,7 @@ public final class PluggableConsoleInput implements ConsoleInput {
* @see net.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */
@Override
public void setPrompt(final String prompt) {
setPrompt(new ConstantString(prompt));
setPrompt(() -> prompt);
}
/* (non-Javadoc)
@@ -279,10 +284,50 @@ 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();
}
}
while (!connected) {
connexionLock.wait(connexionTimeout);
}
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

@@ -4,60 +4,21 @@
*/
package net.bigeon.gclc.socket;
/*-
* #%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;
/** 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. */
private final ConnexionManager<T> manager;
/** If all connexion should be disconnected when no argument have been
* specified. */
private final boolean all;
private final net.bigeon.gclc.socket.cmd.RemoteDisconnectCommand<T> real;
/** Create the disconnection command.
*
@@ -68,8 +29,8 @@ public final class RemoteDisconnectCommand<T> extends Command {
public RemoteDisconnectCommand(final String name, final ConnexionManager<T> manager,
final boolean all) {
super(name);
this.manager = manager;
this.all = all;
real = new net.bigeon.gclc.socket.cmd.RemoteDisconnectCommand<>(name, manager,
all);
}
/* (non-Javadoc)
@@ -78,52 +39,20 @@ public final class RemoteDisconnectCommand<T> extends Command {
@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$
}
}
real.execute(out, in, args);
}
/* (non-Javadoc)
* @see fr.bigeon.gclc.command.ICommand#tip() */
@Override
public String tip() {
return "Close a connexion."; //$NON-NLS-1$
return real.tip();
}
/* (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");
return "";
}
}

View File

@@ -77,6 +77,8 @@ public final class SocketConsoleApplicationShell implements Runnable {
/** The application. */
private ConsoleApplication app;
private final Object initLock = new Object();
/** The server socket. */
private ServerSocket serverSocket;
/** THe server address. */
@@ -123,7 +125,10 @@ public final class SocketConsoleApplicationShell implements Runnable {
// Create the server
try (ServerSocket actualServerSocket = new ServerSocket(port, 1, addr)) {
serverSocket = actualServerSocket;
running = true;
synchronized (initLock) {
running = true;
initLock.notifyAll();
}
// Create the streams
runSokectServer();
} catch (final IOException e) {
@@ -194,4 +199,23 @@ public final class SocketConsoleApplicationShell implements Runnable {
LOGGER.log(Level.SEVERE, "Exception in closing socket server", e); //$NON-NLS-1$
}
}
/** A method to wait for the socket server initialization.
*
* @param timeout the timeout */
public void waitStartUp(final long timeout) {
synchronized (initLock) {
final long tic = System.currentTimeMillis() + timeout;
long tac;
while (!running && (tac = System.currentTimeMillis()) < tic) {
final long idle = tic - tac;
try {
initLock.wait(idle);
} catch (final InterruptedException e) {
LOGGER.log(Level.INFO, "Thread interruption", e);
Thread.currentThread().interrupt();
}
}
}
}
}

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,136 @@
/**
* 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() {
final StringBuilder builder = new StringBuilder(
" If arguments are provided the corresponding connexions are closed, otherwise\n");
if (all) {
builder.append("all connections");
} else {
builder.append("none");
}
builder.append(" are.");
return builder.toString();
}
}

View File

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

View File

@@ -66,6 +66,7 @@ public class TestServer {
if (server == null) {
server = new Thread(getShell(), "gclcServer");
server.start();
getShell().waitStartUp(500);
}
return server;
}
@@ -82,13 +83,7 @@ public class TestServer {
SHELL.setInterface(new SocketConsoleInterface(input, output));
SHELL.setConnexionManager(manager);
SHELL.setApplication(app);
final Thread th = new Thread(new Runnable() {
@Override
public void run() {
app.start();
}
});
final Thread th = new Thread(() -> app.start());
th.start();
try {
final Object waiting = new Object();

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 */

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.2</version>
</parent>
<groupId>net.bigeon.gclc</groupId>
<artifactId>swt</artifactId>
<version>1.2.0-SNAPSHOT</version>
<version>1.2.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>GCLC swt</name>
<description>A swt window for console applications</description>
@@ -35,7 +35,7 @@
</developer>
</developers>
<scm>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<developerConnection>scm:git:gitea@git.code.bigeon.net:emmanuel/gclc-core.git</developerConnection>
<tag>HEAD</tag>
</scm>
<properties>
@@ -48,27 +48,26 @@
<dependency>
<groupId>net.bigeon</groupId>
<artifactId>gclc</artifactId>
<version>2.0.12</version>
<version>2.1.2</version>
</dependency>
<dependency>
<groupId>net.bigeon</groupId>
<artifactId>collections</artifactId>
<version>1.1.6</version>
<version>1.3.5</version>
</dependency>
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-core</artifactId>
<version>2.23.0</version>
<version>4.3.1</version>
<scope>test</scope>
</dependency>
</dependencies>
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.3</version>
<version>3.0.1</version>
</plugin>
<plugin>
<groupId>com.github.sevntu-checkstyle</groupId>

View File

@@ -77,8 +77,13 @@ import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Text;
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.gclc.swt.api.ConsoleDelayIO;
import net.bigeon.gclc.swt.api.ConsoleOutputDisplay;
import net.bigeon.gclc.swt.io.ConsoleInputManager;
import net.bigeon.gclc.swt.io.ConsoleOutputManager;
import net.bigeon.gclc.swt.io.ConsolePromptManager;
/** A shell containing a {@link SWTConsoleView}
* <p>
@@ -128,12 +133,12 @@ public final class SWTConsole extends Composite {
}
/** @return the inputManager */
public ConsoleInputManager getInputManager() {
public ConsoleDelayIO getInputManager() {
return inputManager;
}
/** @return the outputManager */
public ConsoleOutputManager getOutputManager() {
public ConsoleOutputDisplay getOutputManager() {
return outputManager;
}

View File

@@ -76,8 +76,13 @@ import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Text;
import net.bigeon.gclc.ConsoleApplication;
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.gclc.swt.api.ConsoleDelayIO;
import net.bigeon.gclc.swt.api.ConsoleOutputDisplay;
import net.bigeon.gclc.swt.io.ConsoleInputManager;
import net.bigeon.gclc.swt.io.ConsoleOutputManager;
import net.bigeon.gclc.swt.tools.HistoryTextKeyListener;
/** A SWT component to connect to gclc {@link ConsoleApplication}.
*
@@ -129,14 +134,14 @@ public final class SWTConsoleView extends Composite {
/** Get the manager of console input.
*
* @return the input manager */
public ConsoleInputManager getInputManager() {
public ConsoleDelayIO getInputManager() {
return inManager;
}
/** Get the manager of console output.
*
* @return the output manager */
public ConsoleOutputManager getOutputManager() {
public ConsoleOutputDisplay getOutputManager() {
return outManager;
}
}

View File

@@ -33,7 +33,7 @@
* gclc-swt:net.bigeon.gclc.swt.ConsoleDelayIO.java
* Created on: Nov 19, 2016
*/
package net.bigeon.gclc.swt;
package net.bigeon.gclc.swt.api;
import java.io.IOException;

View File

@@ -1,7 +1,7 @@
/**
*
*/
package net.bigeon.gclc.swt;
package net.bigeon.gclc.swt.api;
/*-
* #%L

View File

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

View File

@@ -1,7 +1,7 @@
/**
*
*/
package net.bigeon.gclc.swt;
package net.bigeon.gclc.swt.io;
/*-
* #%L
@@ -41,7 +41,8 @@ import java.io.IOException;
import org.eclipse.swt.widgets.Text;
import net.bigeon.gclc.utils.PipedConsoleInput;
import net.bigeon.gclc.manager.PipedConsoleInput;
import net.bigeon.gclc.swt.api.ConsoleDelayIO;
/** The object managing the console input.
*

View File

@@ -1,7 +1,7 @@
/**
*
*/
package net.bigeon.gclc.swt;
package net.bigeon.gclc.swt.io;
/*-
* #%L
@@ -38,103 +38,16 @@ package net.bigeon.gclc.swt;
*/
import org.eclipse.swt.widgets.Text;
import org.eclipse.swt.widgets.Widget;
import net.bigeon.gclc.utils.AOutputForwardRunnable;
import net.bigeon.gclc.utils.PipedConsoleOutput;
import net.bigeon.gclc.manager.PipedConsoleOutput;
import net.bigeon.gclc.swt.api.ConsoleOutputDisplay;
import net.bigeon.gclc.swt.tools.TextAppendingRunnable;
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 {
/** A runnable appending text to the content of a {@link Text} component.
*
* @author Emmanuel Bigeon */
private static 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);
}
}
/** The local implementation of the forwarding runnable.
*
* @author Emmanuel Bigeon */
private static 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;
}
}
/** The SWT component displaying the output content. */
private final Text text;
/** The forwarding runnable. */
@@ -183,4 +96,12 @@ public final class ConsoleOutputManager implements ConsoleOutputDisplay {
public Thread getForwardThread() {
return forwardThread;
}
/** @return the output consumer */
public PipedConsoleOutput getManager() {
if (forward == null) {
return null;
}
return forward.getOuput();
}
}

View File

@@ -1,7 +1,7 @@
/**
*
*/
package net.bigeon.gclc.swt;
package net.bigeon.gclc.swt.io;
/*-
* #%L
@@ -41,6 +41,8 @@ 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 */

View File

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

View File

@@ -33,7 +33,7 @@
* gclc-swt:net.bigeon.gclc.swt.HistoryTextKeyListener.java
* Created on: Jun 9, 2016
*/
package net.bigeon.gclc.swt;
package net.bigeon.gclc.swt.tools;
import java.io.IOException;
import java.util.logging.Level;
@@ -76,8 +76,9 @@ 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;
import net.bigeon.gclc.swt.api.ConsoleDelayIO;
/** A key listener to validate commands and manage the history of commands.
*

View File

@@ -1,7 +1,7 @@
/**
*
*/
package net.bigeon.gclc.swt;
package net.bigeon.gclc.swt.tools;
/*-
* #%L

View File

@@ -0,0 +1,36 @@
/**
*
*/
package net.bigeon.gclc.swt.tools;
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,67 @@
/**
*
*/
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.api.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

@@ -39,17 +39,15 @@ package net.bigeon.gclc.swt;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.fail;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import static org.mockito.Mockito.*;
import java.io.IOException;
import org.eclipse.swt.widgets.Text;
import org.junit.Test;
import net.bigeon.gclc.utils.PipedConsoleInput;
import net.bigeon.gclc.manager.PipedConsoleInput;
import net.bigeon.gclc.swt.io.ConsoleInputManager;
/** @author Emmanuel Bigeon */
public class ConsoleInputManagerTest {
@@ -58,7 +56,7 @@ public class ConsoleInputManagerTest {
private final ConsoleInputManager cim = new ConsoleInputManager(text);
/** Test method for
* {@link net.bigeon.gclc.swt.ConsoleInputManager#setInput(java.lang.String)}. */
* {@link net.bigeon.gclc.swt.io.ConsoleInputManager#setInput(java.lang.String)}. */
@Test
public void testSetText() {
cim.setInput("Text");
@@ -66,7 +64,7 @@ public class ConsoleInputManagerTest {
}
/** Test method for
* {@link net.bigeon.gclc.swt.ConsoleInputManager#validateInput()}.
* {@link net.bigeon.gclc.swt.io.ConsoleInputManager#validateInput()}.
*
* @throws IOException if an error occurred */
@Test
@@ -104,7 +102,7 @@ public class ConsoleInputManagerTest {
}
/** Test method for
* {@link net.bigeon.gclc.swt.ConsoleInputManager#getText()}. */
* {@link net.bigeon.gclc.swt.io.ConsoleInputManager#getText()}. */
@Test
public void testGetText() {
assertEquals("Text component should be preserved", text, cim.getText());

View File

@@ -38,10 +38,7 @@ package net.bigeon.gclc.swt;
*/
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.doAnswer;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import static org.mockito.Mockito.*;
import java.io.IOException;
@@ -51,7 +48,8 @@ import org.junit.Test;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;
import net.bigeon.gclc.utils.PipedConsoleOutput;
import net.bigeon.gclc.manager.PipedConsoleOutput;
import net.bigeon.gclc.swt.io.ConsoleOutputManager;
/** @author Emmanuel Bigeon */
public class ConsoleOutputManagerTest {
@@ -74,7 +72,7 @@ public class ConsoleOutputManagerTest {
}
/** Test method for
* {@link net.bigeon.gclc.swt.ConsoleOutputManager#appendLine(java.lang.String)}. */
* {@link net.bigeon.gclc.swt.io.ConsoleOutputManager#appendLine(java.lang.String)}. */
@Test
public void testAppendConsoleOutput() {
when(text.getText()).thenReturn("", "abc",

View File

@@ -3,6 +3,7 @@
*/
package net.bigeon.gclc.swt;
import static org.mockito.ArgumentMatchers.any;
/*-
* #%L
* GCLC swt
@@ -36,46 +37,128 @@ package net.bigeon.gclc.swt;
* 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 static org.mockito.Mockito.*;
import java.io.BufferedReader;
import java.io.IOException;
import java.util.concurrent.atomic.AtomicInteger;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Label;
import org.junit.Test;
import org.mockito.Mockito;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;
/**
* @author Emmanuel Bigeon
*
*/
import net.bigeon.gclc.swt.io.ConsolePromptManager;
/** @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 method for
* {@link net.bigeon.gclc.swt.io.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 method for
* {@link net.bigeon.gclc.swt.io.ConsolePromptManager#setStream(java.io.BufferedReader)}.
*
* @throws IOException if error */
@Test
public void testSetStream() {
public void testSetStream() throws IOException {
// Create the dispaly, in case...
final Display d = mock(Display.class);
when(label.getDisplay()).thenReturn(d);
Mockito.doAnswer(invocation -> {
((Runnable) invocation.getArgument(0)).run();
return null;
}).when(d).asyncExec(any(Runnable.class));
Mockito.doAnswer(invocation -> {
((Runnable) invocation.getArgument(0)).run();
return null;
}).when(d).syncExec(any(Runnable.class));
// Test.
BufferedReader output = mock(BufferedReader.class);
final Object lock = new Object();
final AtomicInteger calls = new AtomicInteger(0);
Mockito.when(output.readLine()).then(new Answer<String>() {
String[] ans = { "A line" };
@Override
public String answer(final InvocationOnMock invocation) throws Throwable {
synchronized (lock) {
if (calls.get() >= ans.length) {
calls.incrementAndGet();
lock.notify();
return null;
}
lock.notify();
return ans[calls.getAndIncrement()];
}
}
});
manager.setStream(output);
manager.setStream(output);
synchronized (lock) {
while (calls.get() < 2) {
try {
lock.wait(10);
} catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}
verify(output, times(2)).readLine();
output = mock(BufferedReader.class);
calls.set(0);
Mockito.when(output.readLine()).then(new Answer<String>() {
String[] ans = { "A line" };
@Override
public String answer(final InvocationOnMock invocation) throws Throwable {
synchronized (lock) {
if (calls.get() >= ans.length) {
calls.incrementAndGet();
lock.notify();
return null;
}
lock.notify();
return ans[calls.getAndIncrement()];
}
}
});
manager.setStream(output);
while (calls.get() < 2) {
synchronized (lock) {
try {
lock.wait(10);
} catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}
manager.setStream(null);
manager.setStream(output);
while (calls.get() < 3) {
synchronized (lock) {
try {
lock.wait(10);
} catch (final InterruptedException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}
verify(output, times(3)).readLine();
verify(label, times(2)).setText("A line");
}
}

View File

@@ -69,11 +69,17 @@ package net.bigeon.gclc.swt;
* #L%
*/
import static org.junit.Assert.assertEquals;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.*;
import java.io.IOException;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.KeyEvent;
import org.junit.Test;
import org.mockito.Mockito;
import net.bigeon.gclc.swt.api.ConsoleDelayIO;
import net.bigeon.gclc.swt.tools.HistoryTextKeyListener;
/**
* <p>
@@ -83,7 +89,7 @@ import org.junit.Test;
public class HistoryTextKeyListenerTest {
/** Test method for
* {@link net.bigeon.gclc.swt.HistoryTextKeyListener#keyPressed(org.eclipse.swt.events.KeyEvent)}. */
* {@link net.bigeon.gclc.swt.tools.HistoryTextKeyListener#keyPressed(org.eclipse.swt.events.KeyEvent)}. */
@Test
public final void testKeyPressedKeyEvent() {
final ConsoleDelayIO io = new ConsoleDelayIO() {
@@ -142,11 +148,23 @@ public class HistoryTextKeyListenerTest {
}
@Test
public void testKeyPressed() {
public void testKeyPressedA() throws IOException {
final ConsoleDelayIO io = mock(ConsoleDelayIO.class);
final KeyEvent event = mock(KeyEvent.class);
event.keyCode = 'a';
final HistoryTextKeyListener listener = new HistoryTextKeyListener(io);
listener.keyPressed(event);
verifyNoInteractions(io);
}
@Test
public void testKeyPressedReturn() throws IOException {
final ConsoleDelayIO io = mock(ConsoleDelayIO.class);
Mockito.when(io.getInput()).thenReturn("Alpha");
final KeyEvent event = mock(KeyEvent.class);
event.keyCode = '\r';
final HistoryTextKeyListener listener = new HistoryTextKeyListener(io);
listener.keyPressed(event);
verify(io, times(1)).validateInput();
}
}

View File

@@ -50,8 +50,9 @@ 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 org.mockito.Mockito;
import net.bigeon.gclc.swt.tools.PromptReadingRunnable;
/** @author Emmanuel Bigeon */
public class PromptReadingRunnableTest {
@@ -59,20 +60,14 @@ public class PromptReadingRunnableTest {
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;
}
doAnswer(invocation -> {
final Runnable runnable = invocation.getArgument(0);
runnable.run();
return null;
}).when(display).syncExec(any(Runnable.class));
}
/** Test method for {@link net.bigeon.gclc.swt.PromptReadingRunnable#run()}.
/** Test method for {@link net.bigeon.gclc.swt.tools.PromptReadingRunnable#run()}.
*
* @throws IOException if an error occurred */
@Test
@@ -83,9 +78,10 @@ public class PromptReadingRunnableTest {
final PromptReadingRunnable runnable = new PromptReadingRunnable(reader, view);
runnable.run();
Mockito.verify(reader, Mockito.times(3)).readLine();
}
/** Test method for {@link net.bigeon.gclc.swt.PromptReadingRunnable#run()}.
/** Test method for {@link net.bigeon.gclc.swt.tools.PromptReadingRunnable#run()}.
*
* @throws IOException if an error occurred */
@Test
@@ -100,6 +96,7 @@ public class PromptReadingRunnableTest {
runnable.run();
logger.setLevel(back);
Mockito.verify(reader, Mockito.times(1)).readLine();
}
}

View File

@@ -38,12 +38,17 @@ package net.bigeon.gclc.swt;
*/
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Shell;
import org.junit.Test;
import net.bigeon.gclc.manager.PipedConsoleInput;
import net.bigeon.gclc.manager.PipedConsoleOutput;
import net.bigeon.gclc.swt.io.ConsoleOutputManager;
/** @author Emmanuel Bigeon */
public class SWTConsoleShellTest {
@@ -61,12 +66,14 @@ public class SWTConsoleShellTest {
}
/** Test method for
* {@link net.bigeon.gclc.swt.SWTConsole#connect(net.bigeon.gclc.utils.PipedConsoleInput, net.bigeon.gclc.utils.PipedConsoleOutput, java.io.BufferedReader)}. */
* {@link net.bigeon.gclc.swt.SWTConsole#connect(PipedConsoleInput, PipedConsoleOutput, java.io.BufferedReader)}. */
@Test
public void testConnect() {
final SWTConsole console = new SWTConsole(new Shell(), SWT.NONE);
// Disconnection should work.
console.connect(null, null, null);
assertNull("Console should disconnect",
((ConsoleOutputManager) console.getOutputManager()).getManager());
}
}

View File

@@ -39,11 +39,16 @@ package net.bigeon.gclc.swt;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Shell;
import org.junit.Test;
import net.bigeon.gclc.manager.PipedConsoleInput;
import net.bigeon.gclc.manager.PipedConsoleOutput;
import net.bigeon.gclc.swt.io.ConsoleOutputManager;
/** @author Emmanuel Bigeon */
public class SWTConsoleViewTest {
@@ -65,11 +70,13 @@ public class SWTConsoleViewTest {
}
/** Test method for
* {@link net.bigeon.gclc.swt.SWTConsoleView#setManager(net.bigeon.gclc.utils.PipedConsoleOutput, net.bigeon.gclc.utils.PipedConsoleInput)}. */
* {@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);
assertNull("Disconnection should replace the input.",
((ConsoleOutputManager) view.getOutputManager()).getManager());
}
}

View File

@@ -5,7 +5,7 @@
<parent>
<groupId>net.bigeon.config</groupId>
<artifactId>ebigeon-config</artifactId>
<version>1.8.21</version>
<version>1.8.29</version>
</parent>
<groupId>net.bigeon.gclc</groupId>
<artifactId>test</artifactId>
@@ -37,7 +37,7 @@
</developer>
</developers>
<scm>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<developerConnection>scm:git:gitea@git.code.bigeon.net:emmanuel/gclc-core.git</developerConnection>
<tag>HEAD</tag>
</scm>
<properties>
@@ -49,17 +49,17 @@
<dependency>
<groupId>net.bigeon</groupId>
<artifactId>gclc</artifactId>
<version>2.0.12</version>
<version>2.1.2</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<version>4.13.2</version>
</dependency>
<dependency>
<groupId>net.bigeon.test</groupId>
<artifactId>junitmt</artifactId>
<version>1.0.2</version>
<version>1.0.4</version>
</dependency>
</dependencies>
<reporting>
@@ -67,7 +67,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.3</version>
<version>3.0.1</version>
</plugin>
<plugin>
<groupId>com.github.sevntu-checkstyle</groupId>

View File

@@ -13,7 +13,6 @@ 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 */
@@ -38,24 +37,17 @@ public final class InputContract {
// 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
}
() -> {
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

@@ -0,0 +1,52 @@
/** gclc-test: InputContractTest
* Created on Apr. 6, 2020
*/
package net.bigeon.gclc.test;
import static org.junit.Assert.fail;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.PipedInputStream;
import java.io.PipedOutputStream;
import java.io.PrintStream;
import java.nio.charset.StandardCharsets;
import org.junit.After;
import org.junit.Test;
import net.bigeon.gclc.manager.EmptyInput;
import net.bigeon.gclc.manager.StreamConsoleInput;
/** @author Emmanuel Bigeon */
public class InputContractTest {
/** Test method for
* {@link net.bigeon.gclc.test.InputContract#testInputContract(java.util.function.Supplier)}. */
@Test
public void testTestInputContract() throws IOException, InterruptedException {
final InputContract contract = new InputContract();
try (InputStream in = new PipedInputStream(new PipedOutputStream());
PrintStream out = new PrintStream("temp.txt")) {
contract.testInputContract(
() -> new StreamConsoleInput(out, in, StandardCharsets.UTF_8));
}
try {
contract.testInputContract(() -> EmptyInput.INSTANCE);
fail("Empty input does not fit the contract for inputs since it cannot be closed.");
} catch (final AssertionError e) {
// ok
}
}
@After
public void tearDown() {
final File f = new File("temp.txt");
if (f.exists()) {
f.delete();
}
}
}

View File

@@ -3,7 +3,7 @@
<parent>
<groupId>net.bigeon.config</groupId>
<artifactId>ebigeon-config</artifactId>
<version>1.8.21</version>
<version>1.8.29</version>
</parent>
<groupId>net.bigeon.gclc</groupId>
<artifactId>system</artifactId>
@@ -35,7 +35,7 @@
</developer>
</developers>
<scm>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<developerConnection>scm:git:gitea@git.code.bigeon.net:emmanuel/gclc-core.git</developerConnection>
<tag>HEAD</tag>
</scm>
<properties>
@@ -48,12 +48,12 @@
<dependency>
<groupId>net.bigeon</groupId>
<artifactId>gclc</artifactId>
<version>2.0.11</version>
<version>2.1.2</version>
</dependency>
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-core</artifactId>
<version>2.23.0</version>
<version>4.3.1</version>
<scope>test</scope>
</dependency>
</dependencies>
@@ -67,7 +67,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.3</version>
<version>3.0.1</version>
</plugin>
<plugin>
<groupId>com.github.sevntu-checkstyle</groupId>

View File

@@ -101,7 +101,7 @@ public class ExecSystemCommand extends Command {
try (BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(os))) {
while (th.isAlive()) {
final String user = in.prompt();
// Avoid interruption being sent to process.
// Forward to process if not empty.
if (!user.isEmpty()) {
writer.write(user + EOL);
}

View File

@@ -42,8 +42,8 @@ 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.EmptyInput;
import net.bigeon.gclc.utils.SinkOutput;
import net.bigeon.gclc.manager.EmptyInput;
import net.bigeon.gclc.manager.SinkOutput;
public class ExecSystemCommandTest {
@@ -79,4 +79,26 @@ public class ExecSystemCommandTest {
}
}
/** Test the execution of the command.
*
* @throws CommandRunException if the command fails */
@Test
public void testLongExecute() throws CommandRunException {
final ConsoleOutput out = SinkOutput.INSTANCE;
final ConsoleInput in = EmptyInput.INSTANCE;
final ExecSystemCommand cmd = new ExecSystemCommand();
if (System.getProperty("os.name").contains("indows")) {
cmd.execute(out, in, "cmd", "/C", "dir", "/s");
} else if (System.getProperty("os.name").contains("inux")) {
cmd.execute(out, in, "ls", "-R");
}
try {
cmd.execute(out, in, "inexistent");
fail("Able to execute inexistent command in system");
} catch (final CommandRunException e) {
// ok
}
}
}

View File

@@ -13,8 +13,8 @@ import org.junit.Test;
import org.mockito.Mockito;
import net.bigeon.gclc.exception.CommandRunException;
import net.bigeon.gclc.utils.SinkOutput;
import net.bigeon.gclc.utils.StreamConsoleOutput;
import net.bigeon.gclc.manager.SinkOutput;
import net.bigeon.gclc.manager.StreamConsoleOutput;
/** @author Emmanuel Bigeon */
public class ForwardingRunnableTest {

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.12</version>
</parent>
<groupId>net.bigeon</groupId>
<artifactId>gclc</artifactId>
<version>2.1.0</version>
<version>2.1.5</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>
@@ -36,8 +36,8 @@
</developer>
</developers>
<scm>
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
<tag>gclc-2.1.0</tag>
<developerConnection>scm:git:gitea@git.code.bigeon.net:emmanuel/gclc-core.git</developerConnection>
<tag>gclc-2.1.5</tag>
</scm>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@@ -49,7 +49,7 @@
<dependency>
<groupId>net.bigeon.test</groupId>
<artifactId>junitmt</artifactId>
<version>1.0.2</version>
<version>1.0.4</version>
<scope>test</scope>
</dependency>
</dependencies>

View File

@@ -191,7 +191,7 @@ public final class ConsoleApplication implements ICommandProvider {
args = GCLCConstants.splitCommand(cmd);
} catch (final CommandParsingException e) {
out.println("Command line cannot be parsed"); //$NON-NLS-1$
LOGGER.log(Level.FINE, "Invalid user command " + cmd, e); //$NON-NLS-1$
LOGGER.log(Level.FINE, e, () -> "Invalid user command " + cmd); //$NON-NLS-1$
return;
}
if (!args.isEmpty()) {
@@ -199,7 +199,7 @@ public final class ConsoleApplication implements ICommandProvider {
executeSub(out, in, args.get(0),
Arrays.copyOfRange(args.toArray(new String[0]), 1, args.size()));
} catch (final CommandRunException e) {
LOGGER.log(Level.FINE, "Command failed: " + cmd, e); //$NON-NLS-1$
LOGGER.log(Level.FINE, e, () -> "Command failed: " + cmd); //$NON-NLS-1$
out.println(Messages.getString("ConsoleApplication.cmd.failed", cmd)); //$NON-NLS-1$
out.println(e.getLocalizedMessage());
if (e.getType() == CommandRunExceptionType.USAGE) {

View File

@@ -146,10 +146,7 @@ public final class GCLCConstants {
continue;
}
if (c == ' ' && !inString) {
final String arg = cmd.substring(startIndex, index - 1);
if (!arg.isEmpty()) {
args.add(removeEscaped(arg));
}
addArgument(args, cmd.substring(startIndex, index - 1));
startIndex = index;
} else if (c == '"') {
if (inString) {
@@ -164,9 +161,18 @@ 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;
}
/** Add an argument to the list of arguments if it is not an empty string.
*
* @param args the list of argument
* @param arg the candidate argument */
private static void addArgument(final List<String> args, final String arg) {
if (!arg.isEmpty()) {
args.add(removeEscaped(arg));
}
}
}

View File

@@ -73,8 +73,11 @@ public abstract class Command implements ICommand {
/** Create the command.
*
* @param name the command name */
public Command(final String name) {
protected Command(final String name) {
super();
if (name == null) {
throw new IllegalArgumentException("The command name is mandatory");
}
this.name = name;
}

View File

@@ -103,7 +103,7 @@ public final class CommandParameters {
* @param key the key
* @return if the key was specified */
public boolean isActive(final String key) {
Boolean val = booleanArguments.get(key);
final Boolean val = booleanArguments.get(key);
return val != null && val.booleanValue();
}
@@ -198,9 +198,8 @@ public final class CommandParameters {
* @param string the key
* @param value the value */
public void set(final String string, final boolean value) {
if (booleanArguments.containsKey(string)) {
booleanArguments.put(string, Boolean.valueOf(value));
}
booleanArguments.computeIfPresent(string,
(final String k, final Boolean v) -> Boolean.valueOf(value));
}
/** Set a string parameter value.
@@ -208,6 +207,9 @@ public final class CommandParameters {
* @param string the key
* @param value the value */
public void set(final String string, final String value) {
// DO NOT USE computeIfPresent. This is a HashMap, not a ConcurrentHashMap and
// keys can be associated to null, but computeIfPresent will consider them as
// absent!
if (stringArguments.containsKey(string)) {
stringArguments.put(string, value);
}

View File

@@ -94,7 +94,7 @@ public abstract class ParametrizedCommand extends Command {
* parameters.
*
* @param name the name */
public ParametrizedCommand(final String name) {
protected ParametrizedCommand(final String name) {
this(name, true);
}
@@ -106,7 +106,7 @@ public abstract class ParametrizedCommand extends Command {
*
* @param name the name
* @param strict if the arguments are restricted to the declared ones */
public ParametrizedCommand(final String name, final boolean strict) {
protected ParametrizedCommand(final String name, final boolean strict) {
super(name);
data = new ParametrizedCommandData(strict);
}

View File

@@ -149,14 +149,16 @@ public final class ParametrizedCommandData {
* @param needed if the parameter is needed
* @throws InvalidParameterException if the new definition is invalid */
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);
final Boolean val = stringParams.computeIfPresent(param,
(final String k, final Boolean v) -> {
final Boolean need = Boolean.valueOf(needed || v.booleanValue());
params.put(param, need);
return;
return need;
});
if (val == null) {
throw new InvalidParameterException(
"Parameter is already defined as boolean"); //$NON-NLS-1$
}
throw new InvalidParameterException("Parameter is already defined as boolean"); //$NON-NLS-1$
}
/** Retrieve the boolean parameters (aka flags).

View File

@@ -139,7 +139,7 @@ public final class ScriptExecution extends Command {
try (InputStreamReader fReader = new InputStreamReader(
Files.newInputStream(Paths.get(scriptFile)), charset);
BufferedReader reader = new BufferedReader(fReader)) {
String[] emptyArray = new String[0];
final String[] emptyArray = new String[0];
while ((cmd = reader.readLine()) != null) {
lineNo++;
final String cmdLine = readCommandLine(cmd, params);
@@ -237,10 +237,16 @@ public final class ScriptExecution extends Command {
* @return the exception to actually throw */
private static CommandRunException manageRunException(final CommandRunException e,
final int lineNo) {
final StringBuilder builder = new StringBuilder(e.getLocalizedMessage());
int index = builder.indexOf("\n");
while (index > 0) {
builder.insert(index + 1, " ");
index = builder.indexOf("\n", index + 1);
}
return new CommandRunException(CommandRunExceptionType.EXECUTION,
MessageFormat.format(
"The script could not complete due to command failure at line {0} ({1})", //$NON-NLS-1$
Integer.valueOf(lineNo), e.getLocalizedMessage()),
"The script could not complete due to command failure at line {0}\n {1})", //$NON-NLS-1$
Integer.valueOf(lineNo + 1), builder),
e);
}

View File

@@ -105,8 +105,8 @@ public final class Messages {
try {
return MessageFormat.format(RESOURCE_BUNDLE.getString(key), args);
} catch (final MissingResourceException e) {
LOGGER.log(Level.WARNING,
"Unrecognized internationalization message key: " + key, e); //$NON-NLS-1$
LOGGER.log(Level.WARNING, e,
() -> "Unrecognized internationalization message key: " + key); //$NON-NLS-1$
return '!' + key + '!';
}
}

View File

@@ -72,7 +72,6 @@ package net.bigeon.gclc.manager;
* #L%
*/
import java.io.IOException;
import java.io.InterruptedIOException;
import java.util.function.Supplier;
/** A console application input.
@@ -94,7 +93,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 immediately by throwing an InterruptedIOException. */
* return immediately by throwing an java.io.InterruptedIOException. */
void interruptPrompt();
/** Test if the input is closed.
@@ -109,7 +108,7 @@ public interface ConsoleInput extends AutoCloseable {
*
* @return the user inputed string
* @throws IOException if the manager is closed or could not read the prompt
* @throws InterruptedIOException if the prompt was interrupted */
* @throws java.io.InterruptedIOException if the prompt was interrupted */
String prompt() throws IOException;
/** Prompt the user, with an allotated time to answer.
@@ -117,7 +116,7 @@ public interface ConsoleInput extends AutoCloseable {
* @param timeout the time to wait in milliseconds
* @return the user inputed string, null if the timeout was reached
* @throws IOException if the manager is closed or could not read the prompt
* @throws InterruptedIOException if the prompt was interrupted */
* @throws java.io.InterruptedIOException if the prompt was interrupted */
String prompt(long timeout) throws IOException;
/** Prompt the user, with a hint on what is prompted.
@@ -125,7 +124,7 @@ public interface ConsoleInput extends AutoCloseable {
* @param message the message to prompt the user
* @return the user inputed string
* @throws IOException if the manager is closed or could not read the prompt
* @throws InterruptedIOException if the prompt was interrupted */
* @throws java.io.InterruptedIOException if the prompt was interrupted */
String prompt(String message) throws IOException;
/** Prompt the user, with a hint on what is prompted and an allotated time to
@@ -135,7 +134,7 @@ public interface ConsoleInput extends AutoCloseable {
* @param message the message to prompt the user
* @return the user inputed string, null if the timeout was reached
* @throws IOException if the manager is closed or could not read the prompt
* @throws InterruptedIOException if the prompt was interrupted */
* @throws java.io.InterruptedIOException if the prompt was interrupted */
String prompt(String message, long timeout) throws IOException;
/** Set a prompting prefix.

View File

@@ -40,48 +40,12 @@ package net.bigeon.gclc.manager;
import java.util.function.Supplier;
/*-
* #%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 net.bigeon.gclc.tools.ConstantString;
/** A console input that return empty to all prompting.
*
* @author Emmanuel Bigeon */
public final class EmptyInput implements ConsoleInput {
private static final ConstantString CONSTANT_STRING = new ConstantString("");
private static final Supplier<String> CONSTANT_STRING = () -> "";
/** The empty prompter. */
public static final ConsoleInput INSTANCE = new EmptyInput();

View File

@@ -101,13 +101,14 @@ public final class PipedConsoleOutput implements ConsoleOutput {
private final PrintStream outPrint;
/** The reading thread. */
private final ReadingRunnable reading;
private final PipedOutputStream out;
/** Create a manager that will write and read through piped stream.
*
* @throws IOException if the piping failed for streams */
public PipedConsoleOutput() throws IOException {
commandOutput = new PipedInputStream();
final PipedOutputStream out = new PipedOutputStream(commandOutput);
out = new PipedOutputStream(commandOutput);
commandBuffOutput = new BufferedReader(
new InputStreamReader(commandOutput, StandardCharsets.UTF_8));
outPrint = new PrintStream(out, true, UTF_8);
@@ -133,6 +134,7 @@ public final class PipedConsoleOutput implements ConsoleOutput {
reading.setRunning(false);
innerManager.close();
outPrint.close();
out.close();
commandBuffOutput.close();
commandOutput.close();
}

View File

@@ -79,7 +79,6 @@ import java.io.PrintStream;
import java.nio.charset.Charset;
import java.util.function.Supplier;
import net.bigeon.gclc.tools.ConstantString;
import net.bigeon.gclc.utils.ReadingRunnable;
/** A console using the input stream and print stream.
@@ -90,7 +89,7 @@ import net.bigeon.gclc.utils.ReadingRunnable;
public final class StreamConsoleInput implements ConsoleInput {
/** The default prompt. */
public static final Supplier<String> DEFAULT_PROMPT = new ConstantString("> "); //$NON-NLS-1$
public static final Supplier<String> DEFAULT_PROMPT = () -> ("> "); //$NON-NLS-1$
/** The command prompt. It can be changed. */
private Supplier<String> prompt = DEFAULT_PROMPT;
@@ -213,7 +212,7 @@ public final class StreamConsoleInput implements ConsoleInput {
* @see net.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */
@Override
public void setPrompt(final String prompt) {
this.prompt = new ConstantString(prompt);
this.prompt = () -> (prompt);
}
@Override

View File

@@ -1,43 +0,0 @@
/**
*
*/
/** 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

@@ -36,7 +36,7 @@
* gclc:net.bigeon.gclc.tools.AOutputForwardRunnable.java
* Created on: Dec 1, 2016
*/
package net.bigeon.gclc.manager.forwarding;
package net.bigeon.gclc.tools;
/*-
* #%L
@@ -97,7 +97,7 @@ public abstract class AOutputForwardRunnable implements Runnable {
/** Create a forwarding runnable.
*
* @param manager the manager */
public AOutputForwardRunnable(final PipedConsoleOutput manager) {
protected AOutputForwardRunnable(final PipedConsoleOutput manager) {
super();
this.manager = manager;
timeout = DEFAULT_TIMEOUT;
@@ -116,7 +116,8 @@ public abstract class AOutputForwardRunnable implements Runnable {
*
* @param manager the manager
* @param timeout the timeout between message requests. */
public AOutputForwardRunnable(final PipedConsoleOutput manager, final long timeout) {
protected AOutputForwardRunnable(final PipedConsoleOutput manager,
final long timeout) {
super();
this.manager = manager;
this.timeout = timeout;
@@ -156,8 +157,11 @@ public abstract class AOutputForwardRunnable implements Runnable {
/** a method to wait some time. */
protected final void waitASec() {
try {
final long tic = System.currentTimeMillis();
synchronized (this) {
wait(timeout);
while (System.currentTimeMillis() - tic < timeout) {
wait(timeout + tic - System.currentTimeMillis());
}
}
} catch (final InterruptedException e) {
LOGGER.log(Level.SEVERE, "Interrupted wait", //$NON-NLS-1$

View File

@@ -73,7 +73,9 @@ import java.util.function.Supplier;
/** A supplier of string that hold a constant string.
*
* @author Emmanuel Bigeon */
* @author Emmanuel Bigeon
* @deprecated since 2.1.2, use a lambda expression instead */
@Deprecated
public class ConstantString implements Supplier<String> {
private final String string;

View File

@@ -128,8 +128,11 @@ public final class ReadingRunnable implements Runnable {
* @throws IOException if the runnable was stopped and no essage was found. */
private void doWaitMessage(final long timeout) throws IOException {
try {
final long tic = System.currentTimeMillis();
synchronized (lock) {
lock.wait(timeout);
while (System.currentTimeMillis() - tic < timeout && messages.isEmpty()) {
lock.wait(timeout);
}
}
} catch (final InterruptedException e) {
LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION, e);
@@ -199,13 +202,13 @@ public final class ReadingRunnable implements Runnable {
public void waitForDelivery(final String message) throws InterruptedException {
Object mLock;
synchronized (messageBlockerLock) {
if (!messageBlocker.containsKey(message)) {
messageBlocker.put(message, new Object());
}
messageBlocker.computeIfAbsent(message, (final String k) -> new Object());
mLock = messageBlocker.get(message);
}
synchronized (mLock) {
mLock.wait();
while (messageBlocker.containsKey(message)) {
mLock.wait();
}
}
}
@@ -251,9 +254,9 @@ public final class ReadingRunnable implements Runnable {
final Object mLock = messageBlocker.get(message);
if (mLock!=null) {
synchronized (mLock) {
messageBlocker.remove(message);
mLock.notifyAll();
}
messageBlocker.remove(message);
}
}
}

View File

@@ -71,11 +71,7 @@ package net.bigeon.gclc;
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import static org.junit.Assert.*;
import java.io.BufferedReader;
import java.io.IOException;

View File

@@ -72,7 +72,6 @@ package net.bigeon.gclc;
* #L%
*/
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.util.List;
@@ -87,52 +86,77 @@ import net.bigeon.gclc.exception.CommandParsingException;
@SuppressWarnings({ "nls", "static-method" })
public class GCLCConstantsTest {
@Test
public void testSplitCommandSingle() throws CommandParsingException {
List<String> res;
res = GCLCConstants.splitCommand("aCommand");
assertEquals("single word command should have one element", 1, res.size());
assertEquals("Command should be preserved", "aCommand", res.get(0));
}
@Test
public void testSplitCommandSeveral() throws CommandParsingException {
List<String> res;
res = GCLCConstants.splitCommand("aCommand with some arguments");
assertEquals("Command size", 4, res.size());
assertEquals("Elements should be preserved", "aCommand", res.get(0));
assertEquals("Command should be preserved", "with", res.get(1));
assertEquals("Command should be preserved", "some", res.get(2));
assertEquals("Command should be preserved", "arguments", res.get(3));
}
/** Test method for
* {@link net.bigeon.gclc.GCLCConstants#splitCommand(java.lang.String)}.
*
* @throws CommandParsingException if an error occured */
@Test
public void testSplitCommand() throws CommandParsingException {
public void testSplitCommandMultiSpaces() throws CommandParsingException {
List<String> res;
res = GCLCConstants.splitCommand("aCommand");
assertTrue("single word command should have one element", res.size() == 1);
assertTrue("Command should be preserved", res.get(0).equals("aCommand"));
res = GCLCConstants.splitCommand("aCommand with some arguments");
assertEquals("Command size", 4, res.size());
assertEquals("Elements should be preserved", "aCommand", res.get(0));
assertTrue("Elements should be preserved", res.get(1).equals("with"));
assertTrue("Elements should be preserved", res.get(2).equals("some"));
assertTrue("Elements should be preserved", res.get(3).equals("arguments"));
res = GCLCConstants.splitCommand("aCommand with some arguments");
assertEquals("Command size", 4, res.size());
assertTrue("Elements should be preserved", res.get(0).equals("aCommand"));
assertTrue("Elements should be preserved", res.get(1).equals("with"));
assertTrue("Elements should be preserved", res.get(2).equals("some"));
assertTrue("Elements should be preserved", res.get(3).equals("arguments"));
assertEquals("Command should be preserved", "aCommand", res.get(0));
assertEquals("Command should be preserved", "with", res.get(1));
assertEquals("Command should be preserved", "some", res.get(2));
assertEquals("Command should be preserved", "arguments", res.get(3));
}
public void testSplitCommandWithString() throws CommandParsingException {
List<String> res;
res = GCLCConstants.splitCommand("aCommand \"with some\" arguments");
assertEquals("Command size", 3, res.size());
assertTrue("Elements should be preserved", res.get(0).equals("aCommand"));
assertTrue("Elements should be preserved", res.get(1).equals("with some"));
assertTrue("Elements should be preserved", res.get(2).equals("arguments"));
res = GCLCConstants.splitCommand("aCommand with\\ some arguments");
assertEquals("Command size", 3, res.size());
assertTrue("Elements should be preserved", res.get(0).equals("aCommand"));
assertTrue("Elements should be preserved", res.get(1).equals("with some"));
assertTrue("Elements should be preserved", res.get(2).equals("arguments"));
res = GCLCConstants.splitCommand("aCommand wi\\\"th some arguments");
assertEquals("Command size", 4, res.size());
assertTrue("Elements should be preserved", res.get(0).equals("aCommand"));
assertTrue("Elements should be preserved", res.get(1).equals("wi\"th"));
assertTrue("Elements should be preserved", res.get(2).equals("some"));
assertTrue("Elements should be preserved", res.get(3).equals("arguments"));
assertEquals("Command should be preserved", "aCommand", res.get(0));
assertEquals("Command should be preserved", "with some", res.get(1));
assertEquals("Command should be preserved", "arguments", res.get(2));
res = GCLCConstants.splitCommand("aCommand with \"some arguments\"");
assertEquals("Command size", 3, res.size());
assertTrue("Elements should be preserved", res.get(0).equals("aCommand"));
assertTrue("Elements should be preserved", res.get(1).equals("with"));
assertTrue("Elements should be preserved", res.get(2).equals("some arguments"));
assertEquals("Command should be preserved", "aCommand", res.get(0));
assertEquals("Command should be preserved", "with", res.get(1));
assertEquals("Command should be preserved", "some arguments", res.get(2));
}
public void testSplitCommandWithEscape() throws CommandParsingException {
List<String> res;
res = GCLCConstants.splitCommand("aCommand with\\ some arguments");
assertEquals("Command size", 3, res.size());
assertEquals("Command should be preserved", "aCommand", res.get(0));
assertEquals("Command should be preserved", "with some", res.get(1));
assertEquals("Command should be preserved", "arguments", res.get(2));
}
public void testSplitCommandWithQuoteInString() throws CommandParsingException {
List<String> res;
res = GCLCConstants.splitCommand("aCommand wi\\\"th some arguments");
assertEquals("Command size", 4, res.size());
assertEquals("Command should be preserved", "aCommand", res.get(0));
assertEquals("Command should be preserved", "wi\"th", res.get(1));
assertEquals("Command should be preserved", "some", res.get(2));
assertEquals("Command should be preserved", "arguments", res.get(3));
}
public void testSplitCommandInvalidQuoting() throws CommandParsingException {
List<String> res;
try {
// Wrong lines?
res = GCLCConstants.splitCommand("aCommand with \"some ar\"guments");

View File

@@ -71,11 +71,7 @@ package net.bigeon.gclc.command;
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
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 static org.junit.Assert.*;
import java.util.HashSet;
import java.util.Set;

View File

@@ -33,8 +33,7 @@ package net.bigeon.gclc.command;
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import static org.junit.Assert.*;
import static org.junit.Assert.fail;
import org.junit.Test;

View File

@@ -71,11 +71,7 @@ package net.bigeon.gclc.command;
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
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 static org.junit.Assert.*;
import java.io.BufferedReader;
import java.io.IOException;
@@ -93,10 +89,10 @@ import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.manager.ConsoleOutput;
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;
import net.bigeon.test.junitmt.ThreadTest;
import net.bigeon.test.junitmt.api.ATestRunnable;
import net.bigeon.test.junitmt.api.TestFunction;
/**
* <p>
@@ -513,21 +509,18 @@ public class ParametrizedCommandTest {
cmd.execute(out, in, "-" + str1, str2, "-" + addParam);
cmd.execute(out, in, "-" + str1, str2, "-" + addParam, addParam);
final TestFunction function = new TestFunction() {
@Override
public void apply() throws Exception {
assertEquals("value of " + str1 + "? ", buf.readLine());
in.type("");
assertEquals("value of " + str1 + "? (cannot be empty) ",
buf.readLine());
in.type("");
assertEquals("value of " + str1 + "? (cannot be empty) ",
buf.readLine());
in.type(str2);
}
final TestFunction function = () -> {
assertEquals("value of " + str1 + "? ", buf.readLine());
in.type("");
assertEquals("value of " + str1 + "? (cannot be empty) ",
buf.readLine());
in.type("");
assertEquals("value of " + str1 + "? (cannot be empty) ",
buf.readLine());
in.type(str2);
};
final ATestRunnable testConsole = new FunctionalTestRunnable(function);
final FunctionalTestRunnable testConsole = new FunctionalTestRunnable(
function);
final Thread th = new Thread(testConsole);
th.start();
@@ -543,13 +536,9 @@ public class ParametrizedCommandTest {
new InputStreamReader(pis, StandardCharsets.UTF_8));
PipedConsoleInput in = new PipedConsoleInput(new PrintStream(pout))) {
final TestFunction function = new TestFunction() {
@Override
public void apply() throws Exception {
assertEquals("value of " + str1 + "? ", buf.readLine());
in.type(str2);
}
final TestFunction function = () -> {
assertEquals("value of " + str1 + "? ", buf.readLine());
in.type(str2);
};
final ATestRunnable testConsole = new FunctionalTestRunnable(function);
@@ -565,7 +554,6 @@ public class ParametrizedCommandTest {
final PipedConsoleInput test = new PipedConsoleInput(null);
test.close();
out.close();
cmd.execute(out, test, "-" + str1, str2);
cmd.execute(out, test, "-" + addParam);
fail("Closed manager shall cause error");
} catch (final CommandRunException e) {

View File

@@ -71,10 +71,7 @@ package net.bigeon.gclc.command;
* 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.assertNull;
import static org.junit.Assert.fail;
import static org.junit.Assert.*;
import java.io.IOException;

View File

@@ -92,8 +92,8 @@ 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;
import net.bigeon.test.junitmt.api.TestFunction;
/**
* <p>

View File

@@ -71,10 +71,7 @@ package net.bigeon.gclc.manager;
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import static org.junit.Assert.*;
import java.io.IOException;
import java.io.InputStream;

View File

@@ -71,10 +71,7 @@ package net.bigeon.gclc.prompt;
* knowledge of the CeCILL license and that you accept its terms.
* #L%
*/
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import static org.junit.Assert.*;
import java.io.BufferedReader;
import java.io.IOException;
@@ -94,10 +91,10 @@ import org.junit.Test;
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;
import net.bigeon.test.junitmt.ThreadTest;
import net.bigeon.test.junitmt.api.ATestRunnable;
import net.bigeon.test.junitmt.api.TestFunction;
/**
* <p>

View File

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