Compare commits
156 Commits
gclc-2.0.8
...
socket-1.1
| Author | SHA1 | Date | |
|---|---|---|---|
| e953c2e659 | |||
| 0f4fd6109d | |||
| 69a8fd2533 | |||
| 0b772ddeb3 | |||
| 55f13ae004 | |||
| 295075ca37 | |||
| 75bbba9884 | |||
| 82daa84bdf | |||
| 10a0858d81 | |||
| dfd3645497 | |||
| bd2da741f2 | |||
| 314db5b82f | |||
| 981668d3a7 | |||
| 9c8866827d | |||
| 43c9faaee7 | |||
| 8436e8926c | |||
| 0cef23e17b | |||
| 6b2a25674d | |||
| eec660e089 | |||
| 901469792d | |||
| 79ee5394d4 | |||
| acf4484eb3 | |||
| 012ef6e668 | |||
| 583f3146fd | |||
| 8b52ba5d49 | |||
| a3051c6f03 | |||
| 18b98997d3 | |||
| 0e1c69dab7 | |||
| c206b5b22c | |||
| c4bbfd8434 | |||
| b671474f64 | |||
| 6443790532 | |||
| 2df99debf8 | |||
| d87aabd465 | |||
| 0562faad70 | |||
| bb06b2a799 | |||
| 626f557aa0 | |||
| 185d19bfcf | |||
| 7fd1bf90bd | |||
| 1fa1f168c8 | |||
| 09e9c69fe0 | |||
| 9f273f7595 | |||
| 143eb7036a | |||
| 9c64c708eb | |||
| 8449eddab8 | |||
| d0a286d45a | |||
| d6698a22fb | |||
| 5e1050a9d7 | |||
| 9374c5a681 | |||
| 4c1e28b04f | |||
| 80933bb636 | |||
| 48b4375565 | |||
| ba7b80689c | |||
| bd311d185e | |||
| aa26173f26 | |||
| df688b1a85 | |||
| bcd0faceef | |||
| 5e5cc2a1cd | |||
| b24b72f3e2 | |||
| ad79e3ccb6 | |||
| ddd818d93b | |||
| 6993513f38 | |||
| b9a7142c5c | |||
| 85ef68f6ae | |||
| dfca63b179 | |||
| 787f951ff7 | |||
| a364b6442b | |||
| 211b965e9e | |||
| e1d030c6c5 | |||
| 8bc2b13a92 | |||
| c1050b1b4f | |||
| a3e4758d1b | |||
| c436b5af2f | |||
| 3272261be1 | |||
| f82f0b9f16 | |||
| 1fa9ca213e | |||
| 265f90526a | |||
| 71b325508f | |||
| 98857e425a | |||
| 8c6b1d8884 | |||
| 2972e82f4a | |||
| 0ab39b24f6 | |||
| 171f79518d | |||
| 0e422a81ce | |||
| ea4164fbfb | |||
| e2f45c77d9 | |||
| 55bb54ca43 | |||
| cf29eb37cc | |||
| 579e85dcb3 | |||
| 7e36a378c4 | |||
| 80242c79e8 | |||
| ab9a4c474b | |||
| b8e5ea0b78 | |||
| 2637d99bce | |||
| cfd3450afe | |||
| 20d5a84269 | |||
| 637cfb8f43 | |||
| d7fbdfb66b | |||
| 22741104f5 | |||
| 45c5375118 | |||
| d01b1608f3 | |||
| 674333a42c | |||
| af0c8e91f8 | |||
| 461dec8894 | |||
| f590542b3f | |||
| c21517a53d | |||
| 7e3b727024 | |||
| bd5b67c312 | |||
| 216cd41dc8 | |||
| 1df33afdbe | |||
| 8d51733590 | |||
| d49a2474e0 | |||
| d7ecd75678 | |||
| 31ad72567a | |||
| 99134c1831 | |||
| dc988a07ac | |||
| 4d31bbacbf | |||
| 2145473706 | |||
| 3f8cee20e1 | |||
| 977c9a8ec8 | |||
| 889433d800 | |||
| 89847738e5 | |||
| cd76d438c1 | |||
| fa46939c54 | |||
| fe4851053a | |||
| 6a7d0b11a0 | |||
| 93589c750e | |||
| c23af20b17 | |||
| c7625c8006 | |||
| ad65165169 | |||
| 0814ab5740 | |||
| ba26a70daa | |||
| 4301f2a15e | |||
| 2a05366e31 | |||
| bd44b5bf85 | |||
| 4e804325e6 | |||
| ae5dc1aeba | |||
| d5a7d4a16f | |||
| de593c00a1 | |||
| 50ac6eec06 | |||
| 74c66dcbdd | |||
| 7c94dea7b5 | |||
| a580133945 | |||
| 38fe457f47 | |||
| 159805701c | |||
| f7876dc964 | |||
| c4db9f43fb | |||
| 67abd91f72 | |||
| 7934ab7435 | |||
| 761d640f0b | |||
| 98d22782c1 | |||
| f8da1c0119 | |||
| 438727e7b9 | |||
| a2a87eb0d7 | |||
| 7ba8b38624 | |||
| 6bcf2b0c91 |
6
.gitignore
vendored
Normal file
6
.gitignore
vendored
Normal file
@@ -0,0 +1,6 @@
|
||||
# maven files
|
||||
target/
|
||||
# Eclipse files
|
||||
.settings/
|
||||
.classpath
|
||||
.project
|
||||
65
Jenkinsfile
vendored
Normal file
65
Jenkinsfile
vendored
Normal file
@@ -0,0 +1,65 @@
|
||||
pipeline {
|
||||
agent any
|
||||
stages {
|
||||
stage('Site GCLC') {
|
||||
when {
|
||||
tag "gclc-*"
|
||||
}
|
||||
steps {
|
||||
dir('gclc') {
|
||||
sh 'mvn site:site'
|
||||
sh 'mkdir -p /home/maven-sites/net/bigeon/gclc'
|
||||
sh 'cp -r target/site /home/maven-sites/net/bigeon/gclc/gclc'
|
||||
}
|
||||
}
|
||||
}
|
||||
stage('Site GCLC-Socket') {
|
||||
when {
|
||||
tag "socket-*"
|
||||
}
|
||||
steps {
|
||||
dir('gclc-socket') {
|
||||
sh 'mvn site:site'
|
||||
sh 'mkdir -p /home/maven-sites/net/bigeon/gclc'
|
||||
sh 'cp -r target/site /home/maven-sites/net/bigeon/gclc/gclc-socket'
|
||||
}
|
||||
}
|
||||
}
|
||||
stage('Site GCLC-Swt') {
|
||||
when {
|
||||
tag "swt-*"
|
||||
}
|
||||
steps {
|
||||
dir('gclc-swt') {
|
||||
sh 'mvn site:site'
|
||||
sh 'mkdir -p /home/maven-sites/net/bigeon/gclc'
|
||||
sh 'cp -r target/site /home/maven-sites/net/bigeon/gclc/gclc-swt'
|
||||
}
|
||||
}
|
||||
}
|
||||
stage('Site GCLC-Processes') {
|
||||
when {
|
||||
tag "process-*"
|
||||
}
|
||||
steps {
|
||||
dir('gclc-process') {
|
||||
sh 'mvn site:site'
|
||||
sh 'mkdir -p /home/maven-sites/net/bigeon/gclc'
|
||||
sh 'cp -r target/site /home/maven-sites/net/bigeon/gclc/gclc-process'
|
||||
}
|
||||
}
|
||||
}
|
||||
stage('Site GCLC-System') {
|
||||
when {
|
||||
tag "system-*"
|
||||
}
|
||||
steps {
|
||||
dir('gclc.system') {
|
||||
sh 'mvn site:site'
|
||||
sh 'mkdir -p /home/maven-sites/net/bigeon/gclc'
|
||||
sh 'cp -r target/site /home/maven-sites/net/bigeon/gclc/gclc-system'
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,64 +1,23 @@
|
||||
|
||||
<!-- process, Distribution repositories and basic setup for Emmanuel Bigeon projects -->
|
||||
<!-- Copyright (C) 2014-2018 E. Bigeon -->
|
||||
<!-- mailto:emmanuel@bigeon.fr -->
|
||||
<!-- -->
|
||||
<!-- This software is governed by the CeCILL license under French law and -->
|
||||
<!-- abiding by the rules of distribution of free software. You can use, -->
|
||||
<!-- modify and/or redistribute the software under the terms of the CeCILL -->
|
||||
<!-- license as circulated by CEA, CNRS and INRIA at the following URL -->
|
||||
<!-- "http://www.cecill.info". -->
|
||||
<!-- -->
|
||||
<!-- As a counterpart to the access to the source code and rights to copy, -->
|
||||
<!-- modify and redistribute granted by the license, users are provided only -->
|
||||
<!-- with a limited warranty and the software's author, the holder of the -->
|
||||
<!-- economic rights, and the successive licensors have only limited -->
|
||||
<!-- liability. -->
|
||||
<!-- -->
|
||||
<!-- In this respect, the user's attention is drawn to the risks associated -->
|
||||
<!-- with loading, using, modifying and/or developing or reproducing the -->
|
||||
<!-- software by the user in light of its specific status of free software, -->
|
||||
<!-- that may mean that it is complicated to manipulate, and that also -->
|
||||
<!-- therefore means that it is reserved for developers and experienced -->
|
||||
<!-- professionals having in-depth computer knowledge. Users are therefore -->
|
||||
<!-- encouraged to load and test the software's suitability as regards their -->
|
||||
<!-- requirements in conditions enabling the security of their systems and/or -->
|
||||
<!-- data to be ensured and, more generally, to use and operate it in the -->
|
||||
<!-- same conditions as regards security. -->
|
||||
<!-- -->
|
||||
<!-- The fact that you are presently reading this means that you have had -->
|
||||
<!-- knowledge of the CeCILL license and that you accept its terms. -->
|
||||
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<parent>
|
||||
<groupId>net.bigeon.config</groupId>
|
||||
<artifactId>ebigeon-config</artifactId>
|
||||
<version>1.8.21</version>
|
||||
</parent>
|
||||
|
||||
<groupId>net.bigeon.gclc</groupId>
|
||||
<artifactId>process</artifactId>
|
||||
<version>0.0.4-SNAPSHOT</version>
|
||||
<packaging>jar</packaging>
|
||||
|
||||
<name>process</name>
|
||||
<url>http://maven.apache.org</url>
|
||||
|
||||
<properties>
|
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||
<copyright.email>emmanuel@bigeon.fr</copyright.email>
|
||||
<license.licenseName>cecill_2.1</license.licenseName>
|
||||
</properties>
|
||||
|
||||
<parent>
|
||||
<groupId>net.bigeon.config</groupId>
|
||||
<artifactId>ebigeon-config</artifactId>
|
||||
<version>1.8.9</version>
|
||||
</parent>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>net.bigeon</groupId>
|
||||
<artifactId>gclc</artifactId>
|
||||
<version>2.0.7</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
<groupId>net.bigeon.gclc</groupId>
|
||||
<artifactId>process</artifactId>
|
||||
<version>0.0.7-SNAPSHOT</version>
|
||||
<packaging>jar</packaging>
|
||||
|
||||
<name>process</name>
|
||||
<description>A library to handle processes in a generic console application.</description><url>https://bigeon.net/projects/gclc.html</url>
|
||||
<inceptionYear>2017</inceptionYear>
|
||||
<organization>
|
||||
<name>Bigeon</name>
|
||||
<url>https://bigeon.net</url>
|
||||
</organization>
|
||||
<licenses>
|
||||
<license>
|
||||
<distribution>manual</distribution>
|
||||
@@ -66,6 +25,39 @@
|
||||
<url>https://cecill.info/licences/Licence_CeCILL_V2.1-en.html</url>
|
||||
</license>
|
||||
</licenses>
|
||||
|
||||
<developers>
|
||||
<developer>
|
||||
<email>emmanuel@bigeon.fr</email>
|
||||
<name>Emmanuel Bigeon</name>
|
||||
<url>bigeon.net</url>
|
||||
<roles>
|
||||
<role>PM</role>
|
||||
</roles>
|
||||
</developer>
|
||||
</developers>
|
||||
<scm>
|
||||
<tag>HEAD</tag>
|
||||
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
|
||||
</scm>
|
||||
<properties>
|
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||
<copyright.email>emmanuel@bigeon.fr</copyright.email>
|
||||
<license.licenseName>cecill_2.1</license.licenseName>
|
||||
</properties>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>net.bigeon</groupId>
|
||||
<artifactId>gclc</artifactId>
|
||||
<version>2.1.0</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>net.bigeon.test</groupId>
|
||||
<artifactId>junitmt</artifactId>
|
||||
<version>1.0.2</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
<reporting>
|
||||
<plugins>
|
||||
<plugin>
|
||||
@@ -80,19 +72,5 @@
|
||||
</plugin>
|
||||
</plugins>
|
||||
</reporting>
|
||||
<developers>
|
||||
<developer>
|
||||
<email>emmanuel@bigeon.fr</email>
|
||||
<name>Emmanuel Bigeon</name>
|
||||
<url>bigeon.net</url>
|
||||
<roles>
|
||||
<role>PM</role>
|
||||
</roles>
|
||||
</developer>
|
||||
</developers>
|
||||
|
||||
<scm>
|
||||
<tag>process-0.0.1</tag>
|
||||
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
|
||||
</scm>
|
||||
</project>
|
||||
|
||||
@@ -69,6 +69,8 @@ package net.bigeon.gclc.process;
|
||||
* #L%
|
||||
*/
|
||||
import java.util.List;
|
||||
import java.util.logging.Level;
|
||||
import java.util.logging.Logger;
|
||||
|
||||
import net.bigeon.gclc.command.CommandParameters;
|
||||
import net.bigeon.gclc.command.ParametrizedCommand;
|
||||
@@ -92,28 +94,33 @@ import net.bigeon.gclc.manager.ConsoleOutput;
|
||||
* @author Emmanuel Bigeon */
|
||||
public class CommandForeground extends ParametrizedCommand {
|
||||
|
||||
/** Number of milliseconds in a second. */
|
||||
private static final int MILLIS_IN_A_SEC = 1000;
|
||||
/** The class logger. */
|
||||
private static final Logger LOGGER = Logger
|
||||
.getLogger(CommandForeground.class.getName());
|
||||
|
||||
/** The task pool to fetch task from. */
|
||||
private final TaskPool pool;
|
||||
|
||||
/** Add the fork command.
|
||||
*
|
||||
* @param name the command name
|
||||
* @param pool The pool to get joinable tasks from */
|
||||
public CommandForeground(final String name, TaskPool pool) {
|
||||
public CommandForeground(final String name, final TaskPool pool) {
|
||||
super(name, false);
|
||||
this.pool = pool;
|
||||
addParameters();
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
*/
|
||||
/** Add the parameters of the command. */
|
||||
private void addParameters() {
|
||||
try {
|
||||
addStringParameter("pid", false);
|
||||
addStringParameter("delai", false);
|
||||
} catch (final InvalidParameterException e) {
|
||||
// TODO Auto-generated catch block
|
||||
e.printStackTrace();
|
||||
// Cannot be reached unless GCLC base framework has an error
|
||||
LOGGER.log(Level.SEVERE, "unexpected parameter error!", e);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -125,26 +132,34 @@ public class CommandForeground extends ParametrizedCommand {
|
||||
protected void doExecute(final ConsoleOutput out, final ConsoleInput in,
|
||||
final CommandParameters parameters) throws CommandRunException {
|
||||
String string = parameters.get("pid");
|
||||
final List<String> additionals = parameters.getAdditionals();
|
||||
if (string == null && !additionals.isEmpty()) {
|
||||
if (string == null) {
|
||||
final List<String> additionals = parameters.getAdditionals();
|
||||
if (additionals.isEmpty()) {
|
||||
throw new CommandRunException(CommandRunExceptionType.USAGE,
|
||||
"Missing process id");
|
||||
}
|
||||
string = additionals.get(0);
|
||||
}
|
||||
if (string == null) {
|
||||
Integer pid;
|
||||
try {
|
||||
pid = Integer.valueOf(string);
|
||||
} catch (final NumberFormatException e) {
|
||||
throw new CommandRunException(CommandRunExceptionType.USAGE,
|
||||
"Missing process id");
|
||||
"PID should be an integer");
|
||||
}
|
||||
// Join the command.
|
||||
final Task cmd = pool.get(string);
|
||||
final Task cmd = pool.get(pid);
|
||||
if (!(cmd instanceof ForkTask)) {
|
||||
throw new CommandRunException("No such forked process");
|
||||
}
|
||||
long delai = 0;
|
||||
final String delaiOpt = parameters.get("delai");
|
||||
if (delaiOpt != null) {
|
||||
delai = Long.parseLong(delaiOpt) * 1000;
|
||||
delai = Long.parseLong(delaiOpt) * MILLIS_IN_A_SEC;
|
||||
}
|
||||
if (delai < 0) {
|
||||
throw new CommandRunException("Join delai cannot be negative");
|
||||
throw new CommandRunException(CommandRunExceptionType.USAGE,
|
||||
"Join delai cannot be negative");
|
||||
}
|
||||
((ForkTask) cmd).join(out, in, delai);
|
||||
}
|
||||
|
||||
@@ -1,40 +1,10 @@
|
||||
/*
|
||||
* process, Distribution repositories and basic setup for Emmanuel Bigeon projects
|
||||
* Copyright (C) 2014-2018 E. Bigeon
|
||||
* mailto:emmanuel@bigeon.fr
|
||||
*
|
||||
* This software is governed by the CeCILL license under French law and
|
||||
* abiding by the rules of distribution of free software. You can use,
|
||||
* modify and/or redistribute the software under the terms of the CeCILL
|
||||
* license as circulated by CEA, CNRS and INRIA at the following URL
|
||||
* "http://www.cecill.info".
|
||||
*
|
||||
* As a counterpart to the access to the source code and rights to copy,
|
||||
* modify and redistribute granted by the license, users are provided only
|
||||
* with a limited warranty and the software's author, the holder of the
|
||||
* economic rights, and the successive licensors have only limited
|
||||
* liability.
|
||||
*
|
||||
* In this respect, the user's attention is drawn to the risks associated
|
||||
* with loading, using, modifying and/or developing or reproducing the
|
||||
* software by the user in light of its specific status of free software,
|
||||
* that may mean that it is complicated to manipulate, and that also
|
||||
* therefore means that it is reserved for developers and experienced
|
||||
* professionals having in-depth computer knowledge. Users are therefore
|
||||
* encouraged to load and test the software's suitability as regards their
|
||||
* requirements in conditions enabling the security of their systems and/or
|
||||
* data to be ensured and, more generally, to use and operate it in the
|
||||
* same conditions as regards security.
|
||||
*
|
||||
* The fact that you are presently reading this means that you have had
|
||||
* knowledge of the CeCILL license and that you accept its terms.
|
||||
*/
|
||||
/**
|
||||
* gclc-process:net.bigeon.gclc.process.CommandFork.java
|
||||
* Created on: Nov 13, 2017
|
||||
*/
|
||||
package net.bigeon.gclc.process;
|
||||
|
||||
import java.text.MessageFormat;
|
||||
/*-
|
||||
* #%L
|
||||
* process
|
||||
@@ -74,6 +44,7 @@ import net.bigeon.gclc.command.Command;
|
||||
import net.bigeon.gclc.command.ICommand;
|
||||
import net.bigeon.gclc.command.ICommandProvider;
|
||||
import net.bigeon.gclc.exception.CommandRunException;
|
||||
import net.bigeon.gclc.exception.CommandRunExceptionType;
|
||||
import net.bigeon.gclc.manager.ConsoleInput;
|
||||
import net.bigeon.gclc.manager.ConsoleOutput;
|
||||
|
||||
@@ -91,15 +62,19 @@ import net.bigeon.gclc.manager.ConsoleOutput;
|
||||
* @author Emmanuel Bigeon */
|
||||
public class CommandFork extends Command {
|
||||
|
||||
/** The task pool containing the tasks. */
|
||||
private final TaskPool pool;
|
||||
/** The command provider. */
|
||||
private final ICommandProvider provider;
|
||||
/** The number of lines stored in the commands. */
|
||||
private final int lines;
|
||||
|
||||
/** Add the fork command.
|
||||
*
|
||||
* @param name the command name
|
||||
* @param provider the allowed command collection */
|
||||
public CommandFork(final String name, ICommandProvider provider, TaskPool pool) {
|
||||
public CommandFork(final String name, final ICommandProvider provider,
|
||||
final TaskPool pool) {
|
||||
this(name, provider, pool, -1);
|
||||
}
|
||||
|
||||
@@ -107,24 +82,33 @@ public class CommandFork extends Command {
|
||||
*
|
||||
* @param name the command name
|
||||
* @param provider the allowed command collection */
|
||||
public CommandFork(final String name, ICommandProvider provider, TaskPool pool,
|
||||
int lines) {
|
||||
public CommandFork(final String name, final ICommandProvider provider,
|
||||
final TaskPool pool, final int lines) {
|
||||
super(name);
|
||||
this.provider = provider;
|
||||
this.pool = pool;
|
||||
this.lines = lines;
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.command.ICommand#execute(net.bigeon.gclc.manager.
|
||||
* ConsoleOutput, net.bigeon.gclc.manager.ConsoleInput, java.lang.String[]) */
|
||||
@Override
|
||||
public void execute(final ConsoleOutput out, final ConsoleInput in, String... args)
|
||||
throws CommandRunException {
|
||||
public void execute(final ConsoleOutput out, final ConsoleInput in,
|
||||
final String... args) throws CommandRunException {
|
||||
if (args.length < 1) {
|
||||
throw new CommandRunException("No command to fork");
|
||||
throw new CommandRunException(CommandRunExceptionType.USAGE,
|
||||
"No command to fork");
|
||||
}
|
||||
final String string = args[0];
|
||||
final ICommand cmd = provider.get(string);
|
||||
if (cmd == null) {
|
||||
throw new CommandRunException(CommandRunExceptionType.USAGE,
|
||||
MessageFormat.format("No such command {0}", string));
|
||||
}
|
||||
final ICommand cmd = provider.get(args[0]);
|
||||
final String[] inner = Arrays.copyOfRange(args, 1, args.length);
|
||||
final ForkTask task = new ForkCommandTask(cmd, inner, lines);
|
||||
final Thread th = new Thread(task);
|
||||
final Thread th = new Thread(task, MessageFormat.format("fork [{0}]", string));
|
||||
pool.add(task);
|
||||
th.start();
|
||||
}
|
||||
|
||||
@@ -72,13 +72,10 @@ import java.util.Arrays;
|
||||
import net.bigeon.gclc.command.ICommand;
|
||||
import net.bigeon.gclc.exception.CommandRunException;
|
||||
|
||||
/**
|
||||
* @author Emmanuel Bigeon
|
||||
*
|
||||
*/
|
||||
/** @author Emmanuel Bigeon */
|
||||
public class ForkCommandTask extends ForkTask {
|
||||
private final ICommand command;
|
||||
private final String[] args;
|
||||
private final ICommand command;
|
||||
private final String[] args;
|
||||
|
||||
/** @param cmd the command
|
||||
* @param args the arguements
|
||||
@@ -89,13 +86,6 @@ public class ForkCommandTask extends ForkTask {
|
||||
this.args = Arrays.copyOf(args, args.length);
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.process.Task#getName() */
|
||||
@Override
|
||||
public String getName() {
|
||||
return command.getCommandName();
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.process.ForkTask#doRun() */
|
||||
@Override
|
||||
@@ -103,4 +93,11 @@ public class ForkCommandTask extends ForkTask {
|
||||
command.execute(out, in, args);
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.process.Task#getName() */
|
||||
@Override
|
||||
public String getName() {
|
||||
return command.getCommandName();
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@@ -77,23 +77,30 @@ import net.bigeon.gclc.manager.ConsoleOutput;
|
||||
import net.bigeon.gclc.process.io.ConnectingConsoleInput;
|
||||
import net.bigeon.gclc.process.io.ConnectingConsoleOutput;
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* TODO
|
||||
/** A task that is made to run into a thread.
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
public abstract class ForkTask implements Task {
|
||||
|
||||
/** THe listeners. */
|
||||
private final Set<InterruptionListener> listeners = new HashSet<>();
|
||||
private boolean running = false;
|
||||
|
||||
protected final ConnectingConsoleInput in = new ConnectingConsoleInput();
|
||||
/** The running state. */
|
||||
private boolean running = true;
|
||||
/** The running state. */
|
||||
private boolean started = false;
|
||||
/** The connecting input for this task */
|
||||
protected final ConnectingConsoleInput in = new ConnectingConsoleInput();
|
||||
/** The connecting output for this task */
|
||||
protected final ConnectingConsoleOutput out;
|
||||
private CommandRunException exception;
|
||||
private final Object runLock = new Object();
|
||||
/** The exception of the run. */
|
||||
private CommandRunException exception;
|
||||
/** The synchronization lock. */
|
||||
private final Object runLock = new Object();
|
||||
|
||||
/** @param lines the number of print to store in the output */
|
||||
public ForkTask(int lines) {
|
||||
/** Create the task.
|
||||
*
|
||||
* @param lines the number of print to store in the output */
|
||||
public ForkTask(final int lines) {
|
||||
out = new ConnectingConsoleOutput(ConnectingConsoleOutput.PERSIST, lines);
|
||||
}
|
||||
|
||||
@@ -105,6 +112,20 @@ public abstract class ForkTask implements Task {
|
||||
listeners.add(listener);
|
||||
}
|
||||
|
||||
/** Actually run the fork. */
|
||||
protected abstract void doRun() throws CommandRunException;
|
||||
|
||||
/** Get the excepion that caused a failure.
|
||||
*
|
||||
* @return the exception */
|
||||
public final CommandRunException getException() {
|
||||
return exception;
|
||||
}
|
||||
|
||||
protected final Object getRunningLock() {
|
||||
return runLock;
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.process.Task#isRunning() */
|
||||
@Override
|
||||
@@ -114,10 +135,13 @@ public abstract class ForkTask implements Task {
|
||||
}
|
||||
}
|
||||
|
||||
/** @param out the console output
|
||||
/** Join the task.
|
||||
*
|
||||
* @param out the console output
|
||||
* @param in the console input
|
||||
* @param timeout the maximal wait (0 for ever) */
|
||||
public final void join(final ConsoleOutput out, final ConsoleInput in, long timeout) {
|
||||
* @param timeout the maximal time to join for (0 for ever) */
|
||||
public final void join(final ConsoleOutput out, final ConsoleInput in,
|
||||
final long timeout) {
|
||||
synchronized (runLock) {
|
||||
this.out.connect(out);
|
||||
this.in.connect(in);
|
||||
@@ -126,7 +150,6 @@ public abstract class ForkTask implements Task {
|
||||
runLock.wait(timeout);
|
||||
}
|
||||
} catch (final InterruptedException e) {
|
||||
// TODO log.
|
||||
Thread.currentThread().interrupt();
|
||||
}
|
||||
this.out.disconnect();
|
||||
@@ -148,7 +171,7 @@ public abstract class ForkTask implements Task {
|
||||
@Override
|
||||
public final void run() {
|
||||
synchronized (runLock) {
|
||||
running = true;
|
||||
started = true;
|
||||
}
|
||||
try {
|
||||
doRun();
|
||||
@@ -162,16 +185,6 @@ public abstract class ForkTask implements Task {
|
||||
}
|
||||
}
|
||||
|
||||
/** Actually run the fork. */
|
||||
protected abstract void doRun() throws CommandRunException;
|
||||
|
||||
/** Get the excepion that caused a failure.
|
||||
*
|
||||
* @return the exception */
|
||||
public final CommandRunException getException() {
|
||||
return exception;
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.process.Task#setRunning(boolean) */
|
||||
@Override
|
||||
@@ -182,7 +195,10 @@ public abstract class ForkTask implements Task {
|
||||
}
|
||||
}
|
||||
|
||||
protected final Object getRunningLock() {
|
||||
return runLock;
|
||||
/** @return the started */
|
||||
public boolean isStarted() {
|
||||
synchronized (runLock) {
|
||||
return started;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -68,9 +68,10 @@ package net.bigeon.gclc.process;
|
||||
* knowledge of the CeCILL license and that you accept its terms.
|
||||
* #L%
|
||||
*/
|
||||
/** A listener for interruption
|
||||
/** A listener for interruption.
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
@FunctionalInterface
|
||||
public interface InterruptionListener {
|
||||
/** Notification of an interuption of a listened object */
|
||||
void interrupted();
|
||||
|
||||
@@ -71,10 +71,7 @@ import net.bigeon.gclc.ApplicationAttachement;
|
||||
import net.bigeon.gclc.command.ICommandProvider;
|
||||
import net.bigeon.gclc.exception.InvalidCommandName;
|
||||
|
||||
/**
|
||||
* @author Emmanuel Bigeon
|
||||
*
|
||||
*/
|
||||
/** @author Emmanuel Bigeon */
|
||||
public class ProcessAttachement implements ApplicationAttachement {
|
||||
|
||||
private final TaskPool pool;
|
||||
@@ -86,8 +83,8 @@ public class ProcessAttachement implements ApplicationAttachement {
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.ApplicationAttachement#attach(fr.bigeon.gclc.ConsoleApplication)
|
||||
*/
|
||||
* @see fr.bigeon.gclc.ApplicationAttachement#attach(fr.bigeon.gclc.
|
||||
* ConsoleApplication) */
|
||||
@Override
|
||||
public void attach(ICommandProvider application) throws InvalidCommandName {
|
||||
application.add(new ProcessKill("kill", pool));
|
||||
|
||||
@@ -69,7 +69,6 @@ package net.bigeon.gclc.process;
|
||||
* #L%
|
||||
*/
|
||||
import net.bigeon.gclc.command.Command;
|
||||
import net.bigeon.gclc.exception.CommandRunException;
|
||||
import net.bigeon.gclc.manager.ConsoleInput;
|
||||
import net.bigeon.gclc.manager.ConsoleOutput;
|
||||
|
||||
@@ -89,32 +88,30 @@ public final class ProcessClear extends Command {
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
|
||||
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
|
||||
* java.lang.String[]) */
|
||||
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[]) */
|
||||
@Override
|
||||
public void execute(final ConsoleOutput out, final ConsoleInput in,
|
||||
final String... args) throws CommandRunException {
|
||||
for (final String id : pool.getPIDs()) {
|
||||
final String... args) {
|
||||
for (final Integer id : pool.getPIDs()) {
|
||||
if (!pool.get(id).isRunning()) {
|
||||
pool.remove(id);
|
||||
}
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.command.ICommand#tip() */
|
||||
@SuppressWarnings("nls")
|
||||
@Override
|
||||
public String tip() {
|
||||
return "Request a process to stop (softly)";
|
||||
return "Remove non running processes from pool";
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.command.Command#usageDetail() */
|
||||
@Override
|
||||
protected String usageDetail() {
|
||||
return null;
|
||||
return " All processes in the pool have their running status checked and the "
|
||||
+ "non running ones are removed from the list of tasks.";
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@@ -70,6 +70,7 @@ package net.bigeon.gclc.process;
|
||||
*/
|
||||
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;
|
||||
|
||||
@@ -89,17 +90,19 @@ public final class ProcessKill extends Command {
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
|
||||
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
|
||||
* java.lang.String[]) */
|
||||
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[]) */
|
||||
@Override
|
||||
public void execute(final ConsoleOutput out, final ConsoleInput in,
|
||||
final String... args) throws CommandRunException {
|
||||
pool.get(args[0]).setRunning(false);
|
||||
final String... args) throws CommandRunException {
|
||||
if (args.length < 1) {
|
||||
throw new CommandRunException(CommandRunExceptionType.USAGE,
|
||||
"A pid should be specified.");
|
||||
}
|
||||
pool.get(Integer.parseInt(args[0])).setRunning(false);
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.command.ICommand#tip() */
|
||||
@SuppressWarnings("nls")
|
||||
@Override
|
||||
public String tip() {
|
||||
return "Request a process to stop (softly)";
|
||||
@@ -109,7 +112,13 @@ public final class ProcessKill extends Command {
|
||||
* @see fr.bigeon.gclc.command.Command#usageDetail() */
|
||||
@Override
|
||||
protected String usageDetail() {
|
||||
return null;
|
||||
return " <pid> is the identification of the process to request the stop to in the pool";
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.command.Command#usagePattern() */
|
||||
@Override
|
||||
protected String usagePattern() {
|
||||
return super.usagePattern() + " <pid>";
|
||||
}
|
||||
}
|
||||
|
||||
@@ -95,20 +95,18 @@ public final class ProcessList extends Command {
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
|
||||
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
|
||||
* java.lang.String[]) */
|
||||
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[]) */
|
||||
@Override
|
||||
public void execute(final ConsoleOutput out, final ConsoleInput in,
|
||||
final String... args) throws CommandRunException {
|
||||
final ArrayList<String> pids = new ArrayList<>(pool.getPIDs());
|
||||
final String... args) throws CommandRunException {
|
||||
final ArrayList<Integer> pids = new ArrayList<>(pool.getPIDs());
|
||||
Collections.sort(pids);
|
||||
for (final String string : pids) {
|
||||
for (final Integer string : pids) {
|
||||
try {
|
||||
out.println(MessageFormat.format("{0}\t{1}", string, //$NON-NLS-1$
|
||||
pool.get(string).getName()));
|
||||
} catch (final IOException e) {
|
||||
throw new CommandRunException(
|
||||
CommandRunExceptionType.INTERACTION,
|
||||
throw new CommandRunException(CommandRunExceptionType.INTERACTION,
|
||||
"Unable to communicate with user", e); //$NON-NLS-1$
|
||||
}
|
||||
}
|
||||
@@ -117,7 +115,6 @@ public final class ProcessList extends Command {
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.command.ICommand#tip() */
|
||||
@SuppressWarnings("nls")
|
||||
@Override
|
||||
public String tip() {
|
||||
return "List all processes";
|
||||
@@ -127,7 +124,7 @@ public final class ProcessList extends Command {
|
||||
* @see fr.bigeon.gclc.command.Command#usageDetail() */
|
||||
@Override
|
||||
protected String usageDetail() {
|
||||
return null;
|
||||
return " No argument is considered by this command";
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@@ -103,8 +103,8 @@ public interface Task extends Runnable {
|
||||
/** Set the running state.
|
||||
* <p>
|
||||
* This method should be only called by external objects with the false
|
||||
* argument. Calling this method with true has unspecified behavior and
|
||||
* could do nothing as well as restart the command for example.
|
||||
* argument. Calling this method with true has unspecified behavior and could do
|
||||
* nothing as well as restart the command for example.
|
||||
*
|
||||
* @param running the running state */
|
||||
void setRunning(boolean running);
|
||||
|
||||
@@ -78,7 +78,7 @@ import java.util.Map;
|
||||
* @author Emmanuel Bigeon */
|
||||
public final class TaskPool {
|
||||
/** The running processes. */
|
||||
private final Map<String, Task> running = new HashMap<>();
|
||||
private final Map<Integer, Task> running = new HashMap<>();
|
||||
/** The count for process id. */
|
||||
private int count = 0;
|
||||
/** The lock for pid attribution synchronization. */
|
||||
@@ -91,41 +91,28 @@ public final class TaskPool {
|
||||
}
|
||||
|
||||
/** Default constructor. */
|
||||
public TaskPool(boolean autoClear) {
|
||||
public TaskPool(final boolean autoClear) {
|
||||
this.autoClear = autoClear;
|
||||
}
|
||||
|
||||
/** Remove a task from the pool
|
||||
*
|
||||
* @param pid the task id */
|
||||
public void remove(String pid) {
|
||||
synchronized (lock) {
|
||||
running.remove(pid);
|
||||
count = Math.min(count, Integer.parseInt(pid));
|
||||
}
|
||||
}
|
||||
|
||||
/** Add a process in the pool.
|
||||
*
|
||||
* @param cmd the process
|
||||
* @return the pid */
|
||||
public String add(final Task cmd) {
|
||||
public int add(final Task cmd) {
|
||||
if (cmd == null) {
|
||||
throw new IllegalArgumentException("Task cannot be null"); //$NON-NLS-1$
|
||||
}
|
||||
final String pid;
|
||||
final int pid;
|
||||
synchronized (lock) {
|
||||
pid = getPID();
|
||||
running.put(pid, cmd);
|
||||
}
|
||||
if (autoClear) {
|
||||
cmd.addInterruptionListener(new InterruptionListener() {
|
||||
@SuppressWarnings("synthetic-access")
|
||||
@Override
|
||||
public void interrupted() {
|
||||
synchronized (lock) {
|
||||
remove(pid);
|
||||
}
|
||||
remove(pid);
|
||||
cmd.rmInterruptionListener(this);
|
||||
}
|
||||
});
|
||||
@@ -137,21 +124,21 @@ public final class TaskPool {
|
||||
*
|
||||
* @param pid the task id
|
||||
* @return the task, if any, associated to this id */
|
||||
public Task get(final String pid) {
|
||||
public Task get(final int pid) {
|
||||
synchronized (lock) {
|
||||
return running.get(pid);
|
||||
return running.get(Integer.valueOf(pid));
|
||||
}
|
||||
}
|
||||
|
||||
/** Get the next process id.
|
||||
*
|
||||
* @return the process id */
|
||||
private String getPID() {
|
||||
private int getPID() {
|
||||
synchronized (lock) {
|
||||
String pid;
|
||||
int pid;
|
||||
do {
|
||||
pid = Integer.toString(count++);
|
||||
} while (running.containsKey(pid));
|
||||
pid = count++;
|
||||
} while (running.containsKey(Integer.valueOf(pid)));
|
||||
return pid;
|
||||
}
|
||||
}
|
||||
@@ -159,7 +146,7 @@ public final class TaskPool {
|
||||
/** Get the running processes' identifiers.
|
||||
*
|
||||
* @return the pids */
|
||||
public Collection<String> getPIDs() {
|
||||
public Collection<Integer> getPIDs() {
|
||||
return new HashSet<>(running.keySet());
|
||||
}
|
||||
|
||||
@@ -168,6 +155,16 @@ public final class TaskPool {
|
||||
return autoClear;
|
||||
}
|
||||
|
||||
/** Remove a task from the pool
|
||||
*
|
||||
* @param pid the task id */
|
||||
public void remove(final int pid) {
|
||||
synchronized (lock) {
|
||||
running.remove(Integer.valueOf(pid));
|
||||
count = Math.min(count, (pid));
|
||||
}
|
||||
}
|
||||
|
||||
/** Request all task to stop running.
|
||||
* <p>
|
||||
* This call does not guaranty end of execution, it is up to the task
|
||||
|
||||
@@ -80,13 +80,13 @@ import net.bigeon.gclc.manager.ConsoleOutput;
|
||||
* @author Emmanuel Bigeon */
|
||||
public abstract class TaskSpawner extends Command {
|
||||
/** The process pool */
|
||||
private final TaskPool pool;
|
||||
private final TaskPool pool;
|
||||
private final ExecutorService threadPool;
|
||||
|
||||
/** @param name the command name
|
||||
* @param pool the pool */
|
||||
public TaskSpawner(final String name, final TaskPool pool,
|
||||
ExecutorService threadPool) {
|
||||
final ExecutorService threadPool) {
|
||||
super(name);
|
||||
this.pool = pool;
|
||||
this.threadPool = threadPool;
|
||||
@@ -97,19 +97,17 @@ public abstract class TaskSpawner extends Command {
|
||||
* @param args the arguments
|
||||
* @return the process to start and add to the pool
|
||||
* @throws CommandRunException if the task creation failed */
|
||||
protected abstract Task createTask(ConsoleOutput out, ConsoleInput in,
|
||||
String... args) throws CommandRunException;
|
||||
protected abstract Task createTask(ConsoleOutput out, ConsoleInput in, String... args)
|
||||
throws CommandRunException;
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
|
||||
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
|
||||
* java.lang.String[]) */
|
||||
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[]) */
|
||||
@Override
|
||||
public final void execute(final ConsoleOutput out, final ConsoleInput in,
|
||||
final String... args) throws CommandRunException {
|
||||
final String... args) throws CommandRunException {
|
||||
final Task task = createTask(out, in, args);
|
||||
final Thread th = new Thread(task);
|
||||
pool.add(task);
|
||||
threadPool.execute(th);
|
||||
threadPool.execute(task);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -68,36 +68,81 @@ package net.bigeon.gclc.process.io;
|
||||
* #L%
|
||||
*/
|
||||
import java.io.IOException;
|
||||
import java.util.logging.Level;
|
||||
import java.util.logging.Logger;
|
||||
import java.io.InterruptedIOException;
|
||||
import java.util.function.Supplier;
|
||||
|
||||
import net.bigeon.gclc.manager.ConsoleInput;
|
||||
import net.bigeon.gclc.tools.StringProvider;
|
||||
import net.bigeon.gclc.tools.ConstantString;
|
||||
|
||||
/** @author Emmanuel Bigeon */
|
||||
/** A console input that can be connected to and diconnected from.
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
public final class ConnectingConsoleInput implements ConsoleInput {
|
||||
|
||||
private static final Logger LOGGER = Logger
|
||||
.getLogger(ConnectingConsoleInput.class.getName());
|
||||
private boolean close = false;
|
||||
private StringProvider prompt;
|
||||
private boolean prompting;
|
||||
private final Object promptLock = new Object();
|
||||
private final Object connectionLock = new Object();
|
||||
private ConsoleInput connected;
|
||||
private boolean disconnection;
|
||||
/** The empty string provider. */
|
||||
private static final ConstantString EMPTY_STRING = new ConstantString("");
|
||||
|
||||
/** If the input is closed. */
|
||||
private boolean close = false;
|
||||
/** The prompt string. */
|
||||
private Supplier<String> prompt = EMPTY_STRING;
|
||||
/** If the input is currently in prompting state.
|
||||
* <p>
|
||||
* To change it you should be in a promptLock. */
|
||||
private boolean prompting = false;
|
||||
/** The synchronization lock for the prompting status. */
|
||||
private final Object promptLock = new Object();
|
||||
/** The synchronization lock for the connection status. */
|
||||
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;
|
||||
/** The connection state.
|
||||
* <p>
|
||||
* To read or modify it, you should be in a connectionLock synchronize block. */
|
||||
private boolean disconnection = false;
|
||||
|
||||
private boolean interrupting = false;
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.manager.ConsoleInput#close() */
|
||||
@Override
|
||||
public void close() throws IOException {
|
||||
public void close() {
|
||||
close = true;
|
||||
}
|
||||
|
||||
/** Connect an input.
|
||||
*
|
||||
* @param input the input to connect */
|
||||
public void connect(final ConsoleInput input) {
|
||||
disconnect();
|
||||
synchronized (promptLock) {
|
||||
promptLock.notifyAll();
|
||||
synchronized (connectionLock) {
|
||||
connected = input;
|
||||
connectionLock.notifyAll();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/** Disconnect the current input. */
|
||||
public void disconnect() {
|
||||
synchronized (connectionLock) {
|
||||
synchronized (promptLock) {
|
||||
if (connected != null) {
|
||||
disconnection = true;
|
||||
connected.interruptPrompt();
|
||||
connected = null;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.manager.ConsoleInput#getPrompt() */
|
||||
@Override
|
||||
public StringProvider getPrompt() {
|
||||
public Supplier<String> getPrompt() {
|
||||
return prompt;
|
||||
}
|
||||
|
||||
@@ -105,12 +150,18 @@ public final class ConnectingConsoleInput implements ConsoleInput {
|
||||
* @see fr.bigeon.gclc.manager.ConsoleInput#interruptPrompt() */
|
||||
@Override
|
||||
public void interruptPrompt() {
|
||||
synchronized (promptLock) {
|
||||
prompting = false;
|
||||
if (connected != null) {
|
||||
connected.interruptPrompt();
|
||||
synchronized (connectionLock) {
|
||||
synchronized (promptLock) {
|
||||
if (prompting) {
|
||||
interrupting = true;
|
||||
}
|
||||
connectionLock.notifyAll();
|
||||
if (connected != null) {
|
||||
connected.interruptPrompt();
|
||||
}
|
||||
prompting = false;
|
||||
promptLock.notifyAll();
|
||||
}
|
||||
promptLock.notifyAll();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -125,120 +176,145 @@ public final class ConnectingConsoleInput implements ConsoleInput {
|
||||
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt() */
|
||||
@Override
|
||||
public String prompt() throws IOException {
|
||||
return prompt(prompt.apply());
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(fr.bigeon.gclc.tools.
|
||||
* StringProvider) */
|
||||
@Override
|
||||
public void setPrompt(StringProvider string) {
|
||||
prompt = string;
|
||||
return prompt(prompt.get());
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(long) */
|
||||
@Override
|
||||
public String prompt(long timeout) throws IOException {
|
||||
return prompt(prompt.apply(), timeout);
|
||||
public String prompt(final long timeout) throws IOException {
|
||||
return prompt(prompt.get(), timeout);
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String) */
|
||||
@Override
|
||||
public String prompt(String message) throws IOException {
|
||||
public String prompt(final String message) throws IOException {
|
||||
synchronized (promptLock) {
|
||||
prompting = true;
|
||||
}
|
||||
while (prompting) {
|
||||
synchronized (promptLock) {
|
||||
if (connected == null) {
|
||||
try {
|
||||
promptLock.wait();
|
||||
} catch (final InterruptedException e) {
|
||||
LOGGER.log(Level.WARNING, "Inerruption of console thread", e);
|
||||
Thread.currentThread().interrupt();
|
||||
}
|
||||
} else {
|
||||
final String res = connected.prompt(message);
|
||||
synchronized (connectionLock) {
|
||||
if (disconnection) {
|
||||
disconnection = false;
|
||||
} else if (prompting) {
|
||||
return res;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
return null;
|
||||
return doPrompt(message, 0, 0);
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, long) */
|
||||
@Override
|
||||
public String prompt(String message, long timeout) throws IOException {
|
||||
public String prompt(final String message, final long timeout) throws IOException {
|
||||
if (timeout <= 0) {
|
||||
return prompt(message);
|
||||
}
|
||||
final long end = System.currentTimeMillis() + timeout;
|
||||
synchronized (promptLock) {
|
||||
prompting = true;
|
||||
}
|
||||
while (prompting) {
|
||||
synchronized (promptLock) {
|
||||
if (connected == null) {
|
||||
try {
|
||||
promptLock.wait();
|
||||
} catch (final InterruptedException e) {
|
||||
LOGGER.log(Level.WARNING, "Inerruption of console thread", e);
|
||||
Thread.currentThread().interrupt();
|
||||
}
|
||||
} else {
|
||||
final String res = connected.prompt(message,
|
||||
end - System.currentTimeMillis());
|
||||
synchronized (connectionLock) {
|
||||
if (disconnection) {
|
||||
disconnection = false;
|
||||
} else if (prompting) {
|
||||
return res;
|
||||
}
|
||||
final long tic = System.currentTimeMillis();
|
||||
return doPrompt(message, timeout, tic);
|
||||
}
|
||||
|
||||
private String doPrompt(final String message, final long timeout, final long tic)
|
||||
throws IOException {
|
||||
do {
|
||||
if (!checkPrompt()) {
|
||||
break;
|
||||
}
|
||||
getConnection(getTimeoutLeft(tic, timeout));
|
||||
boolean connect;
|
||||
ConsoleInput actualConnected;
|
||||
synchronized (connectionLock) {
|
||||
connect = connected != null;
|
||||
actualConnected = connected;
|
||||
}
|
||||
if (!connect) {
|
||||
continue;
|
||||
}
|
||||
try {
|
||||
final String res = actualPrompt(message, timeout, tic, actualConnected);
|
||||
synchronized (promptLock) {
|
||||
if (prompting) {
|
||||
prompting = false;
|
||||
return res;
|
||||
}
|
||||
}
|
||||
} 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 (checkTimeout(tic, timeout));
|
||||
return null;
|
||||
}
|
||||
|
||||
private static String actualPrompt(final String message, final long timeout,
|
||||
final long tic, final ConsoleInput actualConnected) throws IOException {
|
||||
final long timeoutLeft = getTimeoutLeft(tic, timeout);
|
||||
if (timeoutLeft == 0) {
|
||||
return actualConnected.prompt(message);
|
||||
}
|
||||
return actualConnected.prompt(message, timeoutLeft);
|
||||
}
|
||||
|
||||
private static boolean checkTimeout(final long tic, final long timeout) {
|
||||
return timeout <= 0 || tic + timeout > System.currentTimeMillis();
|
||||
}
|
||||
|
||||
private static long getTimeoutLeft(final long tic, final long timeout) {
|
||||
if (timeout > 0) {
|
||||
return Math.max(timeout + tic - System.currentTimeMillis(), 1);
|
||||
}
|
||||
if (timeout < 0) {
|
||||
return 1;
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
/** Test if we are in prompting state.
|
||||
*
|
||||
* @return if the process is currently in prompting state.
|
||||
* @throws InterruptedIOException if the prompting state has been interrupted */
|
||||
private boolean checkPrompt() throws InterruptedIOException {
|
||||
synchronized (promptLock) {
|
||||
if (!prompting && interrupting) {
|
||||
interrupting = false;
|
||||
throw new InterruptedIOException("Prompt was interrupted");
|
||||
}
|
||||
return prompting;
|
||||
}
|
||||
}
|
||||
|
||||
private void getConnection(final long timeout) throws InterruptedIOException {
|
||||
boolean connect;
|
||||
synchronized (connectionLock) {
|
||||
connect = connected != null;
|
||||
if (!connect) {
|
||||
try {
|
||||
connectionLock.wait(timeout);
|
||||
} catch (final InterruptedException e) {
|
||||
Thread.currentThread().interrupt();
|
||||
}
|
||||
}
|
||||
if (interrupting) {
|
||||
interrupting = false;
|
||||
throw new InterruptedIOException("Prompt ws interrupted");
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */
|
||||
@Override
|
||||
public void setPrompt(final String prompt) {
|
||||
this.prompt = new StringProvider() {
|
||||
@Override
|
||||
public String apply() {
|
||||
return prompt;
|
||||
}
|
||||
};
|
||||
this.prompt = new ConstantString(prompt);
|
||||
}
|
||||
|
||||
public void connect(ConsoleInput input) {
|
||||
disconnect();
|
||||
synchronized (promptLock) {
|
||||
connected = input;
|
||||
promptLock.notifyAll();
|
||||
}
|
||||
}
|
||||
|
||||
public void disconnect() {
|
||||
synchronized (connectionLock) {
|
||||
if (connected != null) {
|
||||
disconnection = true;
|
||||
synchronized (promptLock) {
|
||||
connected.interruptPrompt();
|
||||
}
|
||||
connected = null;
|
||||
}
|
||||
}
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(fr.bigeon.gclc.tools.
|
||||
* StringProvider) */
|
||||
@Override
|
||||
public void setPrompt(final Supplier<String> string) {
|
||||
prompt = string;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -75,26 +75,37 @@ import java.util.logging.Logger;
|
||||
|
||||
import net.bigeon.gclc.manager.ConsoleOutput;
|
||||
|
||||
/** @author Emmanuel Bigeon */
|
||||
/** A console output that can be connected and disconnected from.
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
public class ConnectingConsoleOutput implements ConsoleOutput {
|
||||
|
||||
/** The logger. */
|
||||
private static final Logger LOGGER = Logger
|
||||
.getLogger(ConnectingConsoleOutput.class.getName());
|
||||
/** If the undelivered message should be stored. */
|
||||
/** The flag indicating that the un-delivered message should be stored. */
|
||||
public static final int QUEUE = 1;
|
||||
/** If the messages should be stored in all cases. */
|
||||
/** The flag indicating that the messages should be stored in all cases. */
|
||||
public static final int PERSIST = 1 << 1;
|
||||
/** The connected output console */
|
||||
private ConsoleOutput output;
|
||||
/** If the console is closed */
|
||||
private boolean close = false;
|
||||
|
||||
/** If the messages should be stored. */
|
||||
private final boolean persistent;
|
||||
/** If the message should be stored until delivery. */
|
||||
private final boolean queued;
|
||||
/** The messages. */
|
||||
private final Deque<String> messages;
|
||||
/** The number of stored messages. */
|
||||
private final int lines;
|
||||
|
||||
/** @param style the type of redirected output
|
||||
/** Create the console output.
|
||||
*
|
||||
* @param style the type of redirected output
|
||||
* @param lines the number of lines to store */
|
||||
public ConnectingConsoleOutput(int style, int lines) {
|
||||
public ConnectingConsoleOutput(final int style, final int lines) {
|
||||
super();
|
||||
this.lines = lines;
|
||||
queued = (style & QUEUE) != 0;
|
||||
@@ -106,7 +117,10 @@ public class ConnectingConsoleOutput implements ConsoleOutput {
|
||||
}
|
||||
}
|
||||
|
||||
private synchronized void addMessage(String text) {
|
||||
/** Add a message.
|
||||
*
|
||||
* @param text the message */
|
||||
private synchronized void addMessage(final String text) {
|
||||
if (persistent || queued && output == null) {
|
||||
if (messages.size() == lines) {
|
||||
messages.poll();
|
||||
@@ -130,35 +144,10 @@ public class ConnectingConsoleOutput implements ConsoleOutput {
|
||||
close = true;
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.manager.ConsoleOutput#isClosed() */
|
||||
@Override
|
||||
public boolean isClosed() {
|
||||
return close;
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.manager.ConsoleOutput#print(java.lang.String) */
|
||||
@Override
|
||||
public void print(String text) {
|
||||
addMessage(text);
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.manager.ConsoleOutput#println() */
|
||||
@Override
|
||||
public void println() {
|
||||
addMessage(System.lineSeparator());
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String) */
|
||||
@Override
|
||||
public void println(String message) {
|
||||
addMessage(message + System.lineSeparator());
|
||||
}
|
||||
|
||||
public synchronized void connect(ConsoleOutput output) {
|
||||
/** Connect an output.
|
||||
*
|
||||
* @param output the output */
|
||||
public synchronized void connect(final ConsoleOutput output) {
|
||||
this.output = output;
|
||||
for (final String string : messages) {
|
||||
try {
|
||||
@@ -173,7 +162,36 @@ public class ConnectingConsoleOutput implements ConsoleOutput {
|
||||
}
|
||||
}
|
||||
|
||||
/** Disconnect the currently connected output. */
|
||||
public synchronized void disconnect() {
|
||||
output = null;
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.manager.ConsoleOutput#isClosed() */
|
||||
@Override
|
||||
public boolean isClosed() {
|
||||
return close;
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.manager.ConsoleOutput#print(java.lang.String) */
|
||||
@Override
|
||||
public void print(final String text) {
|
||||
addMessage(text);
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.manager.ConsoleOutput#println() */
|
||||
@Override
|
||||
public void println() {
|
||||
addMessage(System.lineSeparator());
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String) */
|
||||
@Override
|
||||
public void println(final String message) {
|
||||
addMessage(message + System.lineSeparator());
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
/** Connecting Input and Output related classes.
|
||||
* <p>
|
||||
* This package groups the Connecting classes that are used to be able to put
|
||||
* the tasks in background and foreground and reattach the actual console input
|
||||
* and outputs to the tasks' ones.
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
package net.bigeon.gclc.process.io;
|
||||
|
||||
/*-
|
||||
* #%L
|
||||
* process
|
||||
* %%
|
||||
* 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%
|
||||
*/
|
||||
@@ -0,0 +1,48 @@
|
||||
/** This package defines elements for processes inside a console application.
|
||||
* <p>
|
||||
* Processes are tasks that are run in background of the application. One may
|
||||
* want to temporarily connect to such a task (through
|
||||
* {@link net.bigeon.gclc.process.CommandForeground}), or verify it's actual
|
||||
* running status (through {@link net.bigeon.gclc.process.ProcessList}. One may
|
||||
* also want to start such a process (through
|
||||
* {@link net.bigeon.gclc.process.ForkCommandTask}) or close it (through
|
||||
* {@link net.bigeon.gclc.process.ProcessKill}).
|
||||
* <p>
|
||||
* The task list can be managed by several commands to list or clear it.
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
package net.bigeon.gclc.process;
|
||||
|
||||
/*-
|
||||
* #%L
|
||||
* process
|
||||
* %%
|
||||
* 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%
|
||||
*/
|
||||
@@ -0,0 +1,90 @@
|
||||
/**
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.process;
|
||||
|
||||
import static org.junit.Assert.assertEquals;
|
||||
import static org.junit.Assert.assertNotNull;
|
||||
import static org.junit.Assert.fail;
|
||||
|
||||
import org.junit.Test;
|
||||
|
||||
import net.bigeon.gclc.exception.CommandRunException;
|
||||
import net.bigeon.gclc.exception.CommandRunExceptionType;
|
||||
import net.bigeon.gclc.process.mocks.ForkTaskMock;
|
||||
|
||||
/**
|
||||
* @author Emmanuel Bigeon
|
||||
*
|
||||
*/
|
||||
public class CommandForegroundTest {
|
||||
|
||||
/**
|
||||
* Test method for {@link net.bigeon.gclc.process.CommandForeground#CommandForeground(java.lang.String, net.bigeon.gclc.process.TaskPool)}.
|
||||
*/
|
||||
@Test
|
||||
public void testCommandForeground() {
|
||||
final CommandForeground pl = new CommandForeground("fg", new TaskPool());
|
||||
assertEquals("Command name should be kept as specified", "fg",
|
||||
pl.getCommandName());
|
||||
}
|
||||
|
||||
/** Test method for
|
||||
* {@link net.bigeon.gclc.process.CommandForeground#doExecute(net.bigeon.gclc.manager.ConsoleOutput, net.bigeon.gclc.manager.ConsoleInput, net.bigeon.gclc.command.CommandParameters)}.
|
||||
*
|
||||
* @throws CommandRunException if a valid command failed */
|
||||
@Test
|
||||
public void testDoExecuteConsoleOutputConsoleInputCommandParameters()
|
||||
throws CommandRunException {
|
||||
final TaskPool pool = new TaskPool(false);
|
||||
final CommandForeground pl = new CommandForeground("fg", pool);
|
||||
|
||||
try {
|
||||
pl.execute(null, null, "-delai", "1");
|
||||
fail("PID should be mandatory");
|
||||
} catch (final CommandRunException e) {
|
||||
assertEquals("No pid specified is a usage error",
|
||||
CommandRunExceptionType.USAGE, e.getType());
|
||||
}
|
||||
try {
|
||||
pl.execute(null, null, "-pid", "invalid", "-delai", "1");
|
||||
fail("PID should be a number");
|
||||
} catch (final CommandRunException e) {
|
||||
assertEquals("Invalid pid specified is a usage error",
|
||||
CommandRunExceptionType.USAGE, e.getType());
|
||||
}
|
||||
try {
|
||||
pl.execute(null, null, "-pid", "2", "-delai", "1");
|
||||
fail("PID should exist");
|
||||
} catch (final CommandRunException e) {
|
||||
assertEquals("Inexistent pid specified is a run error",
|
||||
CommandRunExceptionType.EXECUTION, e.getType());
|
||||
}
|
||||
|
||||
final ForkTaskMock cmd = new ForkTaskMock();
|
||||
final int id = pool.add(cmd);
|
||||
pl.execute(null, null, "-pid", Integer.toString(id), "-delai", "1");
|
||||
|
||||
try {
|
||||
pl.execute(null, null, "-pid", Integer.toString(id), "-delai", "-1");
|
||||
fail("delai should be a posistive number");
|
||||
} catch (final CommandRunException e) {
|
||||
assertEquals("Negative delai specified is a usage error",
|
||||
CommandRunExceptionType.USAGE, e.getType());
|
||||
}
|
||||
|
||||
assert cmd.getRunCall() == 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Test method for {@link net.bigeon.gclc.process.CommandForeground#tip()}.
|
||||
*/
|
||||
@Test
|
||||
public void testTip() {
|
||||
final CommandForeground pl = new CommandForeground("fg", new TaskPool());
|
||||
assertNotNull("Command tip should be defined", pl.tip());
|
||||
assertNotNull("Command usage should be defined", pl.usagePattern());
|
||||
assertNotNull("Command usage should be defined", pl.usageDetail());
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,86 @@
|
||||
/**
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.process;
|
||||
|
||||
import static org.junit.Assert.assertEquals;
|
||||
import static org.junit.Assert.assertNotNull;
|
||||
import static org.junit.Assert.fail;
|
||||
|
||||
import org.junit.Test;
|
||||
|
||||
import net.bigeon.gclc.command.ICommandProvider;
|
||||
import net.bigeon.gclc.command.SubedCommand;
|
||||
import net.bigeon.gclc.exception.CommandRunException;
|
||||
import net.bigeon.gclc.exception.CommandRunExceptionType;
|
||||
import net.bigeon.gclc.exception.InvalidCommandName;
|
||||
import net.bigeon.gclc.process.mocks.CommandMock;
|
||||
|
||||
/**
|
||||
* @author Emmanuel Bigeon
|
||||
*
|
||||
*/
|
||||
public class CommandForkTest {
|
||||
|
||||
/**
|
||||
* Test method for {@link net.bigeon.gclc.process.CommandFork#CommandFork(java.lang.String, net.bigeon.gclc.command.ICommandProvider, net.bigeon.gclc.process.TaskPool)}.
|
||||
*/
|
||||
@Test
|
||||
public void testCommandForkStringICommandProviderTaskPool() {
|
||||
final TaskPool pool = new TaskPool();
|
||||
final ICommandProvider provider = new SubedCommand("test");
|
||||
final CommandFork pl = new CommandFork("fork", provider, pool);
|
||||
assertEquals("Command name should be preserved", "fork", pl.getCommandName());
|
||||
}
|
||||
|
||||
/** Test method for
|
||||
* {@link net.bigeon.gclc.process.CommandFork#execute(net.bigeon.gclc.manager.ConsoleOutput, net.bigeon.gclc.manager.ConsoleInput, java.lang.String[])}.
|
||||
*
|
||||
* @throws InvalidCommandName if the test init failed
|
||||
* @throws CommandRunException if the command execution failed in the test */
|
||||
@Test
|
||||
public void testExecute() throws InvalidCommandName, CommandRunException {
|
||||
final TaskPool pool = new TaskPool(false);
|
||||
final ICommandProvider provider = new SubedCommand("test");
|
||||
final CommandFork pl = new CommandFork("fork", provider, pool);
|
||||
|
||||
try {
|
||||
pl.execute(null, null);
|
||||
fail("No command specified should through an exception");
|
||||
} catch (final CommandRunException e) {
|
||||
assertEquals("No command specified is a usage error",
|
||||
CommandRunExceptionType.USAGE, e.getType());
|
||||
}
|
||||
try {
|
||||
pl.execute(null, null, "invalid");
|
||||
fail("Invalid command specified should through an exception");
|
||||
} catch (final CommandRunException e) {
|
||||
assertEquals("Invalid command specified is a usage error",
|
||||
CommandRunExceptionType.USAGE, e.getType());
|
||||
}
|
||||
|
||||
final CommandMock mock = new CommandMock();
|
||||
provider.add(mock);
|
||||
|
||||
pl.execute(null, null, mock.getCommandName());
|
||||
|
||||
final ForkTask task = (ForkTask) pool.get(pool.getPIDs().iterator().next());
|
||||
task.join(null, null, 1000);
|
||||
|
||||
assertEquals("Command should be executed when forked", 1, mock.getExecuteCall());
|
||||
}
|
||||
|
||||
/**
|
||||
* Test method for {@link net.bigeon.gclc.process.CommandFork#tip()}.
|
||||
*/
|
||||
@Test
|
||||
public void testTip() {
|
||||
final TaskPool pool = new TaskPool();
|
||||
final ICommandProvider provider = new SubedCommand("test");
|
||||
final CommandFork pl = new CommandFork("fork", provider, pool);
|
||||
assertNotNull("Command tip should be defined", pl.tip());
|
||||
assertNotNull("Command usage should be defined", pl.usagePattern());
|
||||
assertNotNull("Command usage should be defined", pl.usageDetail());
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,35 @@
|
||||
/**
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.process;
|
||||
|
||||
import static org.junit.Assert.assertEquals;
|
||||
|
||||
import org.junit.Test;
|
||||
|
||||
import net.bigeon.gclc.process.mocks.CommandMock;
|
||||
|
||||
/**
|
||||
* @author Emmanuel Bigeon
|
||||
*
|
||||
*/
|
||||
public class ForkCommandTaskTest {
|
||||
|
||||
/** Test method for
|
||||
* {@link net.bigeon.gclc.process.ForkCommandTask#ForkCommandTask(net.bigeon.gclc.command.ICommand, java.lang.String[], int)}.
|
||||
*
|
||||
* @throws InterruptedException if there is an error in the thread join */
|
||||
@Test
|
||||
public void testForkCommandTask() throws InterruptedException {
|
||||
final CommandMock cmd = new CommandMock();
|
||||
final ForkCommandTask task = new ForkCommandTask(cmd, new String[0], 1);
|
||||
|
||||
final Thread th = new Thread(task);
|
||||
th.start();
|
||||
th.join();
|
||||
|
||||
assertEquals("Task should be executed once", 1, cmd.getExecuteCall());
|
||||
assertEquals("Names should be consistent between task and command",
|
||||
cmd.getCommandName(), task.getName());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,156 @@
|
||||
/**
|
||||
*
|
||||
*/
|
||||
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.manager.PipedConsoleInput;
|
||||
import net.bigeon.gclc.manager.PipedConsoleOutput;
|
||||
|
||||
/** @author Emmanuel Bigeon */
|
||||
public class ForkTaskTest {
|
||||
|
||||
@Test
|
||||
public void testGenericForkTask() throws IOException {
|
||||
final ForkTask task = new ForkTask(5) {
|
||||
|
||||
@Override
|
||||
public String getName() {
|
||||
return "name";
|
||||
}
|
||||
|
||||
@Override
|
||||
protected void doRun() throws CommandRunException {
|
||||
String msg;
|
||||
try {
|
||||
msg = in.prompt();
|
||||
} catch (final IOException e) {
|
||||
throw new CommandRunException(CommandRunExceptionType.INTERACTION,
|
||||
"Unable to prompt user");
|
||||
}
|
||||
out.println(msg);
|
||||
}
|
||||
};
|
||||
|
||||
final Thread execThread = new Thread(task, "Task");
|
||||
execThread.start();
|
||||
try {
|
||||
execThread.join(100);
|
||||
} catch (final InterruptedException e) {
|
||||
// TODO Auto-generated catch block
|
||||
e.printStackTrace();
|
||||
}
|
||||
|
||||
try (PipedConsoleOutput pco = new PipedConsoleOutput();
|
||||
PipedConsoleInput pci = new PipedConsoleInput(null)) {
|
||||
while (!pco.available()) {
|
||||
pci.type("ok");
|
||||
task.join(pco, pci, 1000);
|
||||
}
|
||||
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());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,34 @@
|
||||
/**
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.process;
|
||||
|
||||
import static org.junit.Assert.assertNotNull;
|
||||
|
||||
import org.junit.Test;
|
||||
|
||||
import net.bigeon.gclc.command.SubedCommand;
|
||||
import net.bigeon.gclc.exception.InvalidCommandName;
|
||||
|
||||
/**
|
||||
* @author Emmanuel Bigeon
|
||||
*
|
||||
*/
|
||||
public class ProcessAttachementTest {
|
||||
|
||||
/** Test method for
|
||||
* {@link net.bigeon.gclc.process.ProcessAttachement#attach(net.bigeon.gclc.command.ICommandProvider)}.
|
||||
*
|
||||
* @throws InvalidCommandName if the command has already some subcommand that is
|
||||
* incompatible */
|
||||
@Test
|
||||
public void testAttach() throws InvalidCommandName {
|
||||
final TaskPool pool = new TaskPool();
|
||||
final ProcessAttachement attachement = new ProcessAttachement(pool);
|
||||
final SubedCommand testPoint = new SubedCommand("test");
|
||||
attachement.attach(testPoint);
|
||||
assertNotNull("Commands should be added", testPoint.get("kill"));
|
||||
assertNotNull("Commands should be added", testPoint.get("list"));
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,53 @@
|
||||
/**
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.process;
|
||||
|
||||
import static org.junit.Assert.assertEquals;
|
||||
import static org.junit.Assert.assertNotNull;
|
||||
import static org.junit.Assert.assertTrue;
|
||||
|
||||
import org.junit.Test;
|
||||
|
||||
import net.bigeon.gclc.process.mocks.TaskMock;
|
||||
|
||||
/**
|
||||
* @author Emmanuel Bigeon
|
||||
*
|
||||
*/
|
||||
public class ProcessClearTest {
|
||||
|
||||
/**
|
||||
* Test method for {@link net.bigeon.gclc.process.ProcessClear#ProcessClear(java.lang.String, net.bigeon.gclc.process.TaskPool)}.
|
||||
*/
|
||||
@Test
|
||||
public void testProcessClear() {
|
||||
final ProcessClear pl = new ProcessClear("clear", new TaskPool());
|
||||
assertEquals("Command name should be kept as specified", "clear",
|
||||
pl.getCommandName());
|
||||
}
|
||||
|
||||
/**
|
||||
* Test method for {@link net.bigeon.gclc.process.ProcessClear#execute(net.bigeon.gclc.manager.ConsoleOutput, net.bigeon.gclc.manager.ConsoleInput, java.lang.String[])}.
|
||||
*/
|
||||
@Test
|
||||
public void testExecute() {
|
||||
final TaskPool pool = new TaskPool();
|
||||
final TaskMock task = new TaskMock();
|
||||
pool.add(task);
|
||||
final ProcessClear pl = new ProcessClear("clear", pool);
|
||||
pl.execute(null, null);
|
||||
assertTrue("cleared pool should be empty", pool.getPIDs().isEmpty());
|
||||
}
|
||||
|
||||
/**
|
||||
* Test method for {@link net.bigeon.gclc.process.ProcessClear#tip()}.
|
||||
*/
|
||||
@Test
|
||||
public void testTip() {
|
||||
final ProcessClear pl = new ProcessClear("clear", new TaskPool());
|
||||
assertNotNull("Command tip should be defined", pl.tip());
|
||||
assertNotNull("Command usage should be defined", pl.usageDetail());
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,62 @@
|
||||
/**
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.process;
|
||||
|
||||
import static org.junit.Assert.assertEquals;
|
||||
import static org.junit.Assert.assertNotNull;
|
||||
import static org.junit.Assert.fail;
|
||||
|
||||
import org.junit.Test;
|
||||
|
||||
import net.bigeon.gclc.exception.CommandRunException;
|
||||
import net.bigeon.gclc.exception.CommandRunExceptionType;
|
||||
import net.bigeon.gclc.process.mocks.TaskMock;
|
||||
|
||||
/** @author Emmanuel Bigeon */
|
||||
public class ProcessKillTest {
|
||||
|
||||
/** Test method for
|
||||
* {@link net.bigeon.gclc.process.ProcessKill#ProcessKill(java.lang.String, net.bigeon.gclc.process.TaskPool)}. */
|
||||
@Test
|
||||
public void testProcessKill() {
|
||||
final ProcessList pl = new ProcessList("kill", new TaskPool());
|
||||
assertEquals("Command name should be kept as specified", "kill",
|
||||
pl.getCommandName());
|
||||
}
|
||||
|
||||
/** Test method for
|
||||
* {@link net.bigeon.gclc.process.ProcessKill#execute(net.bigeon.gclc.manager.ConsoleOutput, net.bigeon.gclc.manager.ConsoleInput, java.lang.String[])}.
|
||||
*
|
||||
* @throws CommandRunException if an error occured in test */
|
||||
@Test
|
||||
public void testExecute() throws CommandRunException {
|
||||
final TaskPool pool = new TaskPool();
|
||||
final TaskMock task = new TaskMock();
|
||||
final int id = pool.add(task);
|
||||
final ProcessKill pl = new ProcessKill("kill", pool);
|
||||
task.reset();
|
||||
try {
|
||||
pl.execute(null, null);
|
||||
fail("Execution with no pid should raise exception");
|
||||
} catch (final CommandRunException e) {
|
||||
assertEquals("Usage exception expected", CommandRunExceptionType.USAGE,
|
||||
e.getType());
|
||||
}
|
||||
pl.execute(null, null, Integer.toString(id));
|
||||
assertEquals("Task should be shutdown", 1, task.getNumberSetRunning());
|
||||
task.reset();
|
||||
pl.execute(null, null, Integer.toString(id));
|
||||
assertEquals("Task should be shutdown", 1, task.getNumberSetRunning());
|
||||
}
|
||||
|
||||
/** Test method for {@link net.bigeon.gclc.process.ProcessKill#tip()}. */
|
||||
@Test
|
||||
public void testTip() {
|
||||
final ProcessKill pl = new ProcessKill("kill", new TaskPool());
|
||||
assertNotNull("Command tip should be defined", pl.tip());
|
||||
assertNotNull("Command usage should be defined", pl.usagePattern());
|
||||
assertNotNull("Command usage should be defined", pl.usageDetail());
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,67 @@
|
||||
/**
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.process;
|
||||
|
||||
import static org.junit.Assert.assertEquals;
|
||||
import static org.junit.Assert.assertNotNull;
|
||||
import static org.junit.Assert.assertTrue;
|
||||
import static org.junit.Assert.fail;
|
||||
|
||||
import java.io.IOException;
|
||||
|
||||
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;
|
||||
|
||||
/** @author Emmanuel Bigeon */
|
||||
public class ProcessListTest {
|
||||
|
||||
/** Test method for
|
||||
* {@link net.bigeon.gclc.process.ProcessList#ProcessList(java.lang.String, net.bigeon.gclc.process.TaskPool)}. */
|
||||
@Test
|
||||
public void testProcessList() {
|
||||
final ProcessList pl = new ProcessList("list", new TaskPool());
|
||||
assertEquals("Command name should be kept as specified", "list",
|
||||
pl.getCommandName());
|
||||
}
|
||||
|
||||
/** Test method for
|
||||
* {@link net.bigeon.gclc.process.ProcessList#execute(net.bigeon.gclc.manager.ConsoleOutput, net.bigeon.gclc.manager.ConsoleInput, java.lang.String[])}.
|
||||
*
|
||||
* @throws CommandRunException if an error occured
|
||||
* @throws IOException if an error in initialization of console occured */
|
||||
@Test
|
||||
public void testExecute() throws CommandRunException, IOException {
|
||||
final TaskPool pool = new TaskPool();
|
||||
final TaskMock task = new TaskMock();
|
||||
pool.add(task);
|
||||
final ProcessList pl = new ProcessList("list", pool);
|
||||
final PipedConsoleOutput out = new PipedConsoleOutput();
|
||||
pl.execute(out, null);
|
||||
|
||||
assertTrue("Task should be contained in list",
|
||||
out.readNextLine().contains(task.getName()));
|
||||
|
||||
out.close();
|
||||
|
||||
try {
|
||||
pl.execute(out, null);
|
||||
fail("Printing element to closed console should raise interaction exception");
|
||||
} catch (final CommandRunException e) {
|
||||
assertEquals("Console printing error should be an interaction error",
|
||||
CommandRunExceptionType.INTERACTION, e.getType());
|
||||
}
|
||||
}
|
||||
|
||||
/** Test method for {@link net.bigeon.gclc.process.ProcessList#tip()}. */
|
||||
@Test
|
||||
public void testTip() {
|
||||
final ProcessList pl = new ProcessList("list", new TaskPool());
|
||||
assertNotNull("Command tip should be defined", pl.tip());
|
||||
assertNotNull("Command usage should be defined", pl.usageDetail());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
/**
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.process;
|
||||
|
||||
import static org.junit.Assert.assertNotNull;
|
||||
|
||||
import org.junit.Test;
|
||||
|
||||
import net.bigeon.gclc.command.SubedCommand;
|
||||
import net.bigeon.gclc.exception.InvalidCommandName;
|
||||
|
||||
/** @author Emmanuel Bigeon */
|
||||
public class ScreenAttachementTest {
|
||||
|
||||
/** Test method for
|
||||
* {@link net.bigeon.gclc.process.ScreenAttachement#attach(net.bigeon.gclc.command.ICommandProvider)}.
|
||||
*
|
||||
* @throws InvalidCommandName if an error occured in attachement */
|
||||
@Test
|
||||
public void testAttach() throws InvalidCommandName {
|
||||
final TaskPool pool = new TaskPool();
|
||||
final ScreenAttachement attachement = new ScreenAttachement(pool, 15);
|
||||
final SubedCommand testPoint = new SubedCommand("test");
|
||||
attachement.attach(testPoint);
|
||||
assertNotNull("Commands should be added", testPoint.get("terminate"));
|
||||
assertNotNull("Commands should be added", testPoint.get("list"));
|
||||
assertNotNull("Commands should be added", testPoint.get("clear"));
|
||||
assertNotNull("Commands should be added", testPoint.get("fg"));
|
||||
assertNotNull("Commands should be added", testPoint.get("fork"));
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,77 @@
|
||||
package net.bigeon.gclc.process;
|
||||
|
||||
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 org.junit.Test;
|
||||
|
||||
import net.bigeon.gclc.process.mocks.TaskMock;
|
||||
|
||||
public class TaskPoolTest {
|
||||
|
||||
public TaskMock task = new TaskMock();
|
||||
public TaskPool pool = new TaskPool(false);
|
||||
|
||||
@Test
|
||||
public void testTaskPool() {
|
||||
assertFalse("task pool should not auto clear if specified",
|
||||
pool.isAutoClearing());
|
||||
pool = new TaskPool();
|
||||
assertTrue("Default task pool should not auto clear", pool.isAutoClearing());
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testAdd() {
|
||||
final int id = pool.add(task);
|
||||
assertTrue("Added task pid should be in pool", pool.getPIDs().contains(id));
|
||||
assertEquals("Added task should be in pool", task, pool.get(id));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testGet() {
|
||||
assertNull("Inexistent task id should provide null as task in pool",
|
||||
pool.get(60));
|
||||
final int id = pool.add(task);
|
||||
assertEquals("Added task should be in pool at its id", task, pool.get(id));
|
||||
assertNull("Added task should be in pool at its id", pool.get(id + 1));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testGetPIDs() {
|
||||
assertTrue("new pool should be empty", pool.getPIDs().isEmpty());
|
||||
final int id = pool.add(task);
|
||||
assertNull("Added task should be in pool at its id", pool.get(id + 1));
|
||||
assertEquals(
|
||||
"Pool task addition should change the pid collection size accordingly", 1,
|
||||
pool.getPIDs().size());
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testRemove() {
|
||||
assertTrue("new pool should be empty", pool.getPIDs().isEmpty());
|
||||
pool.remove(60);
|
||||
assertTrue("removal of inexistent task should be NOP", pool.getPIDs().isEmpty());
|
||||
final int id = pool.add(task);
|
||||
assertEquals(
|
||||
"Pool task addition should change the pid collection size accordingly", 1,
|
||||
pool.getPIDs().size());
|
||||
pool.remove(id + 1);
|
||||
assertEquals("removal of inexistent task should be NOP", 1,
|
||||
pool.getPIDs().size());
|
||||
pool.remove(id);
|
||||
assertTrue("removal of task should reduce the number of tasks",
|
||||
pool.getPIDs().isEmpty());
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testShutdown() {
|
||||
final int id = pool.add(task);
|
||||
task.reset();
|
||||
pool.shutdown();
|
||||
assertEquals("Shutdown should request shut down of tasks, only once", 1,
|
||||
task.getNumberSetRunning());
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,80 @@
|
||||
/**
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.process;
|
||||
|
||||
import static org.junit.Assert.assertEquals;
|
||||
import static org.junit.Assert.assertTrue;
|
||||
|
||||
import java.util.concurrent.ExecutorService;
|
||||
import java.util.concurrent.Executors;
|
||||
|
||||
import org.junit.Test;
|
||||
|
||||
import net.bigeon.gclc.exception.CommandRunException;
|
||||
import net.bigeon.gclc.manager.ConsoleInput;
|
||||
import net.bigeon.gclc.manager.ConsoleOutput;
|
||||
|
||||
/** @author Emmanuel Bigeon */
|
||||
public class TaskSpawnerTest {
|
||||
|
||||
/** Test method for
|
||||
* {@link net.bigeon.gclc.process.TaskSpawner#execute(net.bigeon.gclc.manager.ConsoleOutput, net.bigeon.gclc.manager.ConsoleInput, java.lang.String[])}.
|
||||
*
|
||||
* @throws CommandRunException if an error occurred */
|
||||
@Test
|
||||
public void testExecute() throws CommandRunException {
|
||||
final Task task = new Task() {
|
||||
@Override
|
||||
public void run() {
|
||||
//
|
||||
}
|
||||
@Override
|
||||
public void setRunning(final boolean running) {
|
||||
//
|
||||
}
|
||||
@Override
|
||||
public void rmInterruptionListener(final InterruptionListener listener) {
|
||||
//
|
||||
}
|
||||
@Override
|
||||
public boolean isRunning() {
|
||||
return false;
|
||||
}
|
||||
@Override
|
||||
public String getName() {
|
||||
return "abc";
|
||||
}
|
||||
@Override
|
||||
public void addInterruptionListener(final InterruptionListener listener) {
|
||||
//
|
||||
}
|
||||
};
|
||||
final TaskPool pool = new TaskPool();
|
||||
assertTrue("Pool not empty", pool.getPIDs().isEmpty());
|
||||
final ExecutorService service = Executors.newSingleThreadExecutor();
|
||||
final TaskSpawner spawner = new TaskSpawner("name", pool, service) {
|
||||
|
||||
@Override
|
||||
public String tip() {
|
||||
return "tip";
|
||||
}
|
||||
|
||||
@Override
|
||||
protected String usageDetail() {
|
||||
return "no details";
|
||||
}
|
||||
|
||||
@Override
|
||||
protected Task createTask(final ConsoleOutput out, final ConsoleInput in,
|
||||
final String... args) throws CommandRunException {
|
||||
return task;
|
||||
}
|
||||
};
|
||||
spawner.execute(null, null);
|
||||
assertEquals("Added the task", 1, pool.getPIDs().size());
|
||||
final Integer id = pool.getPIDs().iterator().next();
|
||||
assertEquals("Added task is not the one", task, pool.get(id));
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,165 @@
|
||||
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.fail;
|
||||
|
||||
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 org.junit.Test;
|
||||
|
||||
import net.bigeon.gclc.manager.PipedConsoleInput;
|
||||
import net.bigeon.gclc.manager.StreamConsoleInput;
|
||||
import net.bigeon.gclc.tools.ConstantString;
|
||||
import net.bigeon.test.junitmt.ATestRunnable;
|
||||
import net.bigeon.test.junitmt.FunctionalTestRunnable;
|
||||
import net.bigeon.test.junitmt.TestFunction;
|
||||
import net.bigeon.test.junitmt.ThreadTest;
|
||||
|
||||
public class ConnectingConsoleInputTest {
|
||||
|
||||
@Test
|
||||
public void testConnect() throws IOException {
|
||||
final ConnectingConsoleInput in = new ConnectingConsoleInput();
|
||||
final PipedConsoleInput pci = new PipedConsoleInput(null);
|
||||
assertNull("Inputs should not transmit before connection", in.prompt(1000));
|
||||
in.connect(pci);
|
||||
pci.type("Some message");
|
||||
assertEquals("Messages should be buffered", "Some message", in.prompt());
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testDisconnect() throws IOException {
|
||||
final ConnectingConsoleInput in = new ConnectingConsoleInput();
|
||||
final PipedConsoleInput pci = new PipedConsoleInput(null);
|
||||
assertNull("Inputs should not transmit before connection", in.prompt(1000));
|
||||
in.connect(pci);
|
||||
pci.type("Some message");
|
||||
assertEquals("Messages should be buffered", "Some message", in.prompt());
|
||||
in.disconnect();
|
||||
assertNull("Disconnected inputs should not transmit anymore", in.prompt(1000));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testIsClosed() throws IOException {
|
||||
final ConnectingConsoleInput in = new ConnectingConsoleInput();
|
||||
assertFalse("New input should not be closed", in.isClosed());
|
||||
final PipedConsoleInput pci = new PipedConsoleInput(null);
|
||||
in.connect(pci);
|
||||
pci.close();
|
||||
assertFalse("Connected input closing should not close connecting", in.isClosed());
|
||||
final PipedConsoleInput pci2 = new PipedConsoleInput(null);
|
||||
in.connect(pci2);
|
||||
in.close();
|
||||
assertTrue("Input should close on request", in.isClosed());
|
||||
assertFalse("Connected input should not be closed by connecting closure",
|
||||
pci2.isClosed());
|
||||
}
|
||||
|
||||
@Test
|
||||
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");
|
||||
in.setPrompt(prompt);
|
||||
assertEquals("Prompt should be set correctly", prompt, in.getPrompt());
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testPromptSequence() throws IOException, InterruptedException {
|
||||
final ConnectingConsoleInput in = new ConnectingConsoleInput();
|
||||
// Unconnected
|
||||
final AtomicBoolean ended = new AtomicBoolean(false);
|
||||
final TestFunction one = new TestFunction() {
|
||||
|
||||
@Override
|
||||
public void apply() throws Exception {
|
||||
try {
|
||||
final String res = in.prompt("m1", -1);
|
||||
fail("interruption of infinite waiting prompt should cause error, but was "
|
||||
+ res);
|
||||
} catch (final InterruptedIOException e) {
|
||||
// ok
|
||||
}
|
||||
try {
|
||||
final String res = in.prompt("m2", 25000);
|
||||
fail("interruption of finite waiting prompt should cause error, but was "
|
||||
+ res);
|
||||
} catch (final InterruptedIOException e) {
|
||||
// ok
|
||||
}
|
||||
synchronized (ended) {
|
||||
ended.set(true);
|
||||
try {
|
||||
assertNull("Overtime should return null", in.prompt("m3", 200));
|
||||
} catch (final InterruptedIOException e) {
|
||||
fail("Unexpected interruption error in overtime");
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
final ATestRunnable runnable = new FunctionalTestRunnable(one);
|
||||
final Thread th = new Thread(runnable);
|
||||
final Thread inter = new Thread(new Runnable() {
|
||||
|
||||
@Override
|
||||
public void run() {
|
||||
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();
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
th.start();
|
||||
inter.start();
|
||||
ThreadTest.assertRuns(th, runnable);
|
||||
inter.join();
|
||||
ended.set(false);
|
||||
|
||||
final PipedOutputStream os = new PipedOutputStream();
|
||||
final PipedInputStream pis = new PipedInputStream(os);
|
||||
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(100);
|
||||
} catch (final InterruptedException e) {
|
||||
// TODO Auto-generated catch block
|
||||
e.printStackTrace();
|
||||
}
|
||||
synchronized (ended) {
|
||||
if (!ended.get()) {
|
||||
in.interruptPrompt();
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
th2.start();
|
||||
inter2.start();
|
||||
ThreadTest.assertRuns(th2, runnable2);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,88 @@
|
||||
package net.bigeon.gclc.process.io;
|
||||
|
||||
import static org.junit.Assert.assertEquals;
|
||||
import static org.junit.Assert.assertFalse;
|
||||
import static org.junit.Assert.assertTrue;
|
||||
|
||||
import java.io.IOException;
|
||||
|
||||
import org.junit.Test;
|
||||
|
||||
import net.bigeon.gclc.manager.PipedConsoleOutput;
|
||||
|
||||
public class ConnectingConsoleOutputTest {
|
||||
|
||||
@Test
|
||||
public void testConnect() throws IOException {
|
||||
final ConnectingConsoleOutput out = new ConnectingConsoleOutput(
|
||||
ConnectingConsoleOutput.QUEUE, 10);
|
||||
final PipedConsoleOutput output = new PipedConsoleOutput();
|
||||
out.println("Some message");
|
||||
assertFalse("Message should not be transmitted", output.available());
|
||||
// Connect
|
||||
out.connect(output);
|
||||
|
||||
// Connected outputs should receive data
|
||||
final String res = output.readNextLine();
|
||||
assertEquals("Message should be correctly transmitted", "Some message", res);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testDisconnect() throws IOException {
|
||||
final ConnectingConsoleOutput out = new ConnectingConsoleOutput(
|
||||
ConnectingConsoleOutput.QUEUE, 10);
|
||||
final PipedConsoleOutput output = new PipedConsoleOutput();
|
||||
// NOP disconnection when no connection
|
||||
out.disconnect();
|
||||
// Connect
|
||||
out.connect(output);
|
||||
|
||||
// Connected outputs should receive data
|
||||
out.println("Some message");
|
||||
final String res = output.readNextLine();
|
||||
assertEquals("Message should be correctly transmitted", "Some message", res);
|
||||
out.disconnect();
|
||||
out.println("Some message");
|
||||
assertFalse("Message should not be transmitted", output.available());
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testIsClosed() throws IOException {
|
||||
final ConnectingConsoleOutput out = new ConnectingConsoleOutput(
|
||||
ConnectingConsoleOutput.QUEUE, 10);
|
||||
final PipedConsoleOutput output = new PipedConsoleOutput();
|
||||
assertFalse("New output should not be closed", out.isClosed());
|
||||
// Connect
|
||||
out.connect(output);
|
||||
|
||||
output.close();
|
||||
|
||||
assertFalse("Output should not close when connected outputs do", out.isClosed());
|
||||
final PipedConsoleOutput output2 = new PipedConsoleOutput();
|
||||
out.connect(output2);
|
||||
out.close();
|
||||
assertTrue("Output should close on request", out.isClosed());
|
||||
assertFalse("Output should not close connected output when they do",
|
||||
output2.isClosed());
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testPrint() throws IOException {
|
||||
final ConnectingConsoleOutput out = new ConnectingConsoleOutput(
|
||||
ConnectingConsoleOutput.PERSIST, 10);
|
||||
|
||||
out.print("Some text");
|
||||
out.println();
|
||||
final PipedConsoleOutput output = new PipedConsoleOutput();
|
||||
out.connect(output);
|
||||
String res = output.readNextLine();
|
||||
assertEquals("Message should be correctly transmitted", "Some text", res);
|
||||
out.disconnect();
|
||||
|
||||
// Persist should be reprinted on any connect
|
||||
out.connect(output);
|
||||
res = output.readNextLine();
|
||||
assertEquals("Message should be correctly transmitted", "Some text", res);
|
||||
out.disconnect();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,60 @@
|
||||
/**
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.process.mocks;
|
||||
|
||||
import java.io.IOException;
|
||||
|
||||
import net.bigeon.gclc.command.ICommand;
|
||||
import net.bigeon.gclc.exception.CommandRunException;
|
||||
import net.bigeon.gclc.manager.ConsoleInput;
|
||||
import net.bigeon.gclc.manager.ConsoleOutput;
|
||||
|
||||
/** @author Emmanuel Bigeon */
|
||||
public class CommandMock implements ICommand {
|
||||
|
||||
private int executeCall = 0;
|
||||
private int tipCall = 0;
|
||||
private int helpCall = 0;
|
||||
private int commandNameCall = 0;
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.command.ICommand#execute(net.bigeon.gclc.manager.
|
||||
* ConsoleOutput, net.bigeon.gclc.manager.ConsoleInput, java.lang.String[]) */
|
||||
@Override
|
||||
public void execute(final ConsoleOutput out, final ConsoleInput in,
|
||||
final String... args) throws CommandRunException {
|
||||
executeCall++;
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.command.ICommand#getCommandName() */
|
||||
@Override
|
||||
public String getCommandName() {
|
||||
commandNameCall++;
|
||||
return "name";
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see
|
||||
* net.bigeon.gclc.command.ICommand#help(net.bigeon.gclc.manager.ConsoleOutput,
|
||||
* java.lang.String[]) */
|
||||
@Override
|
||||
public void help(final ConsoleOutput output, final String... args)
|
||||
throws IOException {
|
||||
helpCall++;
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.command.ICommand#tip() */
|
||||
@Override
|
||||
public String tip() {
|
||||
tipCall++;
|
||||
return "tip";
|
||||
}
|
||||
|
||||
/** @return the executeCall */
|
||||
public int getExecuteCall() {
|
||||
return executeCall;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,43 @@
|
||||
/**
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.process.mocks;
|
||||
|
||||
import net.bigeon.gclc.exception.CommandRunException;
|
||||
import net.bigeon.gclc.process.ForkTask;
|
||||
import net.bigeon.gclc.process.Task;
|
||||
|
||||
/**
|
||||
* @author Emmanuel Bigeon
|
||||
*
|
||||
*/
|
||||
public class ForkTaskMock extends ForkTask implements Task {
|
||||
|
||||
private int runCall = 0;
|
||||
|
||||
/** Default constructor. */
|
||||
public ForkTaskMock() {
|
||||
super(10);
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.process.Task#getName()
|
||||
*/
|
||||
@Override
|
||||
public String getName() {
|
||||
return "name";
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.process.ForkTask#doRun()
|
||||
*/
|
||||
@Override
|
||||
protected void doRun() throws CommandRunException {
|
||||
runCall++;
|
||||
}
|
||||
|
||||
/** @return the runCall */
|
||||
public int getRunCall() {
|
||||
return runCall;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,57 @@
|
||||
package net.bigeon.gclc.process.mocks;
|
||||
|
||||
import net.bigeon.gclc.process.InterruptionListener;
|
||||
import net.bigeon.gclc.process.Task;
|
||||
|
||||
public class TaskMock implements Task {
|
||||
|
||||
private int runCall = 0;
|
||||
private int setRunningCall = 0;
|
||||
|
||||
@Override
|
||||
public void run() {
|
||||
runCall++;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void addInterruptionListener(final InterruptionListener listener) {
|
||||
// TODO Auto-generated method stub
|
||||
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getName() {
|
||||
return "name";
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isRunning() {
|
||||
// TODO Auto-generated method stub
|
||||
return false;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void rmInterruptionListener(final InterruptionListener listener) {
|
||||
// TODO Auto-generated method stub
|
||||
|
||||
}
|
||||
|
||||
@Override
|
||||
public void setRunning(final boolean running) {
|
||||
setRunningCall++;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
*/
|
||||
public void reset() {
|
||||
runCall = 0;
|
||||
setRunningCall = 0;
|
||||
}
|
||||
|
||||
/** @return the number of calls to set running method */
|
||||
public int getNumberSetRunning() {
|
||||
return setRunningCall;
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,4 @@
|
||||
/** Mock definitions for testing.
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
package net.bigeon.gclc.process.mocks;
|
||||
@@ -1,64 +1,22 @@
|
||||
|
||||
<!-- GCLC Socket, Socket implementation of GCLC -->
|
||||
<!-- Copyright (C) 2014-2017 E. Bigeon -->
|
||||
<!-- mailto:emmanuel@bigeon.fr -->
|
||||
<!-- -->
|
||||
<!-- This software is governed by the CeCILL license under French law and -->
|
||||
<!-- abiding by the rules of distribution of free software. You can use, -->
|
||||
<!-- modify and/or redistribute the software under the terms of the CeCILL -->
|
||||
<!-- license as circulated by CEA, CNRS and INRIA at the following URL -->
|
||||
<!-- "http://www.cecill.info". -->
|
||||
<!-- -->
|
||||
<!-- As a counterpart to the access to the source code and rights to copy, -->
|
||||
<!-- modify and redistribute granted by the license, users are provided only -->
|
||||
<!-- with a limited warranty and the software's author, the holder of the -->
|
||||
<!-- economic rights, and the successive licensors have only limited -->
|
||||
<!-- liability. -->
|
||||
<!-- -->
|
||||
<!-- In this respect, the user's attention is drawn to the risks associated -->
|
||||
<!-- with loading, using, modifying and/or developing or reproducing the -->
|
||||
<!-- software by the user in light of its specific status of free software, -->
|
||||
<!-- that may mean that it is complicated to manipulate, and that also -->
|
||||
<!-- therefore means that it is reserved for developers and experienced -->
|
||||
<!-- professionals having in-depth computer knowledge. Users are therefore -->
|
||||
<!-- encouraged to load and test the software's suitability as regards their -->
|
||||
<!-- requirements in conditions enabling the security of their systems and/or -->
|
||||
<!-- data to be ensured and, more generally, to use and operate it in the -->
|
||||
<!-- same conditions as regards security. -->
|
||||
<!-- -->
|
||||
<!-- The fact that you are presently reading this means that you have had -->
|
||||
<!-- knowledge of the CeCILL license and that you accept its terms. -->
|
||||
|
||||
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<artifactId>gclc-socket</artifactId>
|
||||
<version>1.1.11-SNAPSHOT</version>
|
||||
<packaging>jar</packaging>
|
||||
<url>http://www.bigeon.net</url>
|
||||
<properties>
|
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||
<project.scm.id>git.code.bigeon.net</project.scm.id>
|
||||
<license.licenseName>cecill_2.1</license.licenseName>
|
||||
<copyright.email>emmanuel@bigeon.fr</copyright.email>
|
||||
</properties>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>net.bigeon</groupId>
|
||||
<artifactId>gclc</artifactId>
|
||||
<version>2.0.7</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>net.bigeon</groupId>
|
||||
<artifactId>smu</artifactId>
|
||||
<version>1.0.0</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
<parent>
|
||||
<groupId>net.bigeon.config</groupId>
|
||||
<artifactId>ebigeon-config</artifactId>
|
||||
<version>1.8.9</version>
|
||||
<artifactId>ebigeon-public-conf</artifactId>
|
||||
<version>1.0.10</version>
|
||||
</parent>
|
||||
<groupId>net.bigeon.gclc</groupId>
|
||||
<artifactId>socket</artifactId>
|
||||
<version>1.1.15</version>
|
||||
<packaging>jar</packaging>
|
||||
<name>GCLC Socket</name>
|
||||
<description>Socket implementation of GCLC</description>
|
||||
<url>https://bigeon.net/projects/gclc.html</url>
|
||||
<inceptionYear>2016</inceptionYear>
|
||||
<organization>
|
||||
<name>Bigeon</name>
|
||||
<url>https://bigeon.net/</url>
|
||||
</organization>
|
||||
<licenses>
|
||||
<license>
|
||||
<distribution>manual</distribution>
|
||||
@@ -66,6 +24,42 @@
|
||||
<url>https://cecill.info/licences/Licence_CeCILL_V2.1-en.html</url>
|
||||
</license>
|
||||
</licenses>
|
||||
<developers>
|
||||
<developer>
|
||||
<email>emmanuel@bigeon.fr</email>
|
||||
<name>Emmanuel Bigeon</name>
|
||||
<url>bigeon.net</url>
|
||||
<roles>
|
||||
<role>PM</role>
|
||||
</roles>
|
||||
</developer>
|
||||
</developers>
|
||||
<scm>
|
||||
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
|
||||
<tag>socket-1.1.15</tag>
|
||||
</scm>
|
||||
<properties>
|
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||
<license.licenseName>cecill_2.1</license.licenseName>
|
||||
</properties>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>net.bigeon</groupId>
|
||||
<artifactId>gclc</artifactId>
|
||||
<version>2.1.0</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>net.bigeon</groupId>
|
||||
<artifactId>smu</artifactId>
|
||||
<version>1.0.7</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>net.bigeon.test</groupId>
|
||||
<artifactId>junitmt</artifactId>
|
||||
<version>1.0.2</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
<reporting>
|
||||
<plugins>
|
||||
<plugin>
|
||||
@@ -80,22 +74,4 @@
|
||||
</plugin>
|
||||
</plugins>
|
||||
</reporting>
|
||||
<developers>
|
||||
<developer>
|
||||
<email>emmanuel@bigeon.fr</email>
|
||||
<name>Emmanuel Bigeon</name>
|
||||
<url>bigeon.net</url>
|
||||
<roles>
|
||||
<role>PM</role>
|
||||
</roles>
|
||||
</developer>
|
||||
</developers>
|
||||
<name>GCLC Socket</name>
|
||||
<description>Socket implementation of GCLC</description>
|
||||
<scm>
|
||||
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
|
||||
<tag>HEAD</tag>
|
||||
</scm>
|
||||
<groupId>net.bigeon.gclc</groupId>
|
||||
<inceptionYear>2016</inceptionYear>
|
||||
</project>
|
||||
|
||||
@@ -50,23 +50,24 @@ import java.util.logging.Logger;
|
||||
public final class DConnexionManager<T> implements ConnexionManager<T> {
|
||||
|
||||
/** Class logger. */
|
||||
private static final Logger LOGGER = Logger
|
||||
private static final Logger LOGGER = Logger
|
||||
.getLogger(DConnexionManager.class.getName());
|
||||
/** The connected objects. */
|
||||
private final Map<String, T> connecteds = new HashMap<>();
|
||||
private final Map<String, T> connecteds = new HashMap<>();
|
||||
/** The locks for the connexions. */
|
||||
private final Map<String, Object> locks = new HashMap<>();
|
||||
private final Map<String, Object> locks = new HashMap<>();
|
||||
/** The counter for the disconnexion locks. */
|
||||
private final Map<String, Integer> counters = new HashMap<>();
|
||||
private final Map<String, Integer> counters = new HashMap<>();
|
||||
/** The lock for modification of {@link #counters}. */
|
||||
private final Object counterLock = new Object();
|
||||
private final Object counterLock = new Object();
|
||||
/** The count of connexions. */
|
||||
private int count = 0;
|
||||
private int count;
|
||||
|
||||
/** Default.constructor. */
|
||||
public DConnexionManager() {
|
||||
//
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see
|
||||
* net.bigeon.gclc.socket.ConnexionManager#addConnexion(java.lang.Object) */
|
||||
@@ -80,29 +81,28 @@ public final class DConnexionManager<T> implements ConnexionManager<T> {
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see
|
||||
* net.bigeon.gclc.socket.ConnexionManager#disconnect(java.lang.String) */
|
||||
* @see net.bigeon.gclc.socket.ConnexionManager#disconnect(java.lang.String) */
|
||||
@Override
|
||||
public T disconnect(final String id) {
|
||||
if (connecteds.containsKey(id)) {
|
||||
final T disc = connecteds.remove(id);
|
||||
final Object lock = locks.get(id);
|
||||
synchronized (lock) {
|
||||
lock.notifyAll();
|
||||
}
|
||||
synchronized (counterLock) {
|
||||
while (counters.get(id).intValue() > 0) {
|
||||
try {
|
||||
counterLock.wait();
|
||||
} catch (final InterruptedException e) {
|
||||
LOGGER.log(Level.FINE, "Interruption of thread", e); //$NON-NLS-1$
|
||||
Thread.currentThread().interrupt();
|
||||
}
|
||||
if (!connecteds.containsKey(id)) {
|
||||
return null;
|
||||
}
|
||||
final T disc = connecteds.remove(id);
|
||||
final Object lock = locks.get(id);
|
||||
synchronized (lock) {
|
||||
lock.notifyAll();
|
||||
}
|
||||
synchronized (counterLock) {
|
||||
while (counters.get(id).intValue() > 0) {
|
||||
try {
|
||||
counterLock.wait();
|
||||
} catch (final InterruptedException e) {
|
||||
LOGGER.log(Level.FINE, "Interruption of thread", e); //$NON-NLS-1$
|
||||
Thread.currentThread().interrupt();
|
||||
}
|
||||
}
|
||||
return disc;
|
||||
}
|
||||
return null;
|
||||
return disc;
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
@@ -120,8 +120,7 @@ public final class DConnexionManager<T> implements ConnexionManager<T> {
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see
|
||||
* net.bigeon.gclc.socket.ConnexionManager#isConnected(java.lang.String) */
|
||||
* @see net.bigeon.gclc.socket.ConnexionManager#isConnected(java.lang.String) */
|
||||
@Override
|
||||
public boolean isConnected(final String id) {
|
||||
return connecteds.containsKey(id);
|
||||
@@ -144,7 +143,8 @@ public final class DConnexionManager<T> implements ConnexionManager<T> {
|
||||
*
|
||||
* @return a new ID */
|
||||
private String newID() {
|
||||
return "Client " + count++; //$NON-NLS-1$
|
||||
final int c = count++;
|
||||
return "Client " + c; //$NON-NLS-1$
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
@@ -154,8 +154,8 @@ public final class DConnexionManager<T> implements ConnexionManager<T> {
|
||||
@Override
|
||||
public void releaseDisconnexionLock(final String id) {
|
||||
synchronized (counterLock) {
|
||||
counters.put(id, Integer
|
||||
.valueOf(Math.max(counters.get(id).intValue() - 1, 0)));
|
||||
counters.put(id,
|
||||
Integer.valueOf(Math.max(counters.get(id).intValue() - 1, 0)));
|
||||
counterLock.notifyAll();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -41,48 +41,52 @@ 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.function.Supplier;
|
||||
import java.util.logging.Level;
|
||||
import java.util.logging.Logger;
|
||||
|
||||
import net.bigeon.gclc.manager.ConsoleInput;
|
||||
import net.bigeon.gclc.tools.ConstantString;
|
||||
import net.bigeon.gclc.tools.StringProvider;
|
||||
import net.bigeon.gclc.utils.ReadingRunnable;
|
||||
|
||||
/** A console input where the stream can be plugged.
|
||||
* <p>
|
||||
* This pluggable console input accepts an input and output to be connected to
|
||||
* it. The connexion cannot be concurrent, which mean that any connected stream
|
||||
* it. The connection cannot be concurrent, which mean that any connected stream
|
||||
* must be disconnected before a new call to
|
||||
* {@link #connect(InputStream, PrintStream)} is done.
|
||||
* <p>
|
||||
* On connection, if the prompt is in wait, this console input will provide the
|
||||
* prompting message.
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
public final class PluggableConsoleInput implements ConsoleInput {
|
||||
/** The ten constant. */
|
||||
private static final int TENTH = 10;
|
||||
private static final int TENTH = 10;
|
||||
/** Class logger. */
|
||||
private static final Logger LOGGER = Logger
|
||||
private static final Logger LOGGER = Logger
|
||||
.getLogger(PluggableConsoleInput.class.getName());
|
||||
/** The default time out. */
|
||||
private static final long TIMEOUT = 100;
|
||||
private static final long TIMEOUT = 100;
|
||||
/** The prompting. */
|
||||
private boolean prompting = false;
|
||||
private boolean prompting = false;
|
||||
/** If the element is closed. */
|
||||
private boolean closed = false;
|
||||
private boolean closed = false;
|
||||
/** The default prompt. */
|
||||
private StringProvider prompt = new ConstantString("> "); //$NON-NLS-1$
|
||||
private Supplier<String> prompt = new ConstantString("> "); //$NON-NLS-1$
|
||||
/** If the input is plugged or buffering. */
|
||||
private boolean connected = false;
|
||||
private boolean connected = false;
|
||||
/** The current connexion (if any). */
|
||||
private ReadingRunnable connexion;
|
||||
private ReadingRunnable connexion;
|
||||
/** The interrupted status for prompts. */
|
||||
private boolean interrupted = false;
|
||||
private boolean interrupted = false;
|
||||
/** The last hint hint. */
|
||||
private String hint;
|
||||
private String hint;
|
||||
/** The output for hints. */
|
||||
private PrintStream output;
|
||||
private PrintStream output;
|
||||
|
||||
// Locks
|
||||
/** The lock for connexion and disconnexion of actual streams. */
|
||||
@@ -100,28 +104,27 @@ public final class PluggableConsoleInput implements ConsoleInput {
|
||||
closed = true;
|
||||
}
|
||||
|
||||
/** Connect the given input stream to the input and output to the hints
|
||||
* writing.
|
||||
/** Connect the given input stream to the input and output to the hints writing.
|
||||
*
|
||||
* @param stream the input stream
|
||||
* @param out the output for hints.
|
||||
* @throws IOException if the input is already connected. */
|
||||
public void connect(final InputStream stream,
|
||||
final PrintStream out) throws IOException {
|
||||
public void connect(final InputStream stream, final PrintStream out)
|
||||
throws IOException {
|
||||
synchronized (connexionLock) {
|
||||
if (connected) {
|
||||
throw new IOException(
|
||||
"Input already connected to an input stream"); //$NON-NLS-1$
|
||||
// Cannot be connected to several sources
|
||||
throw new IOException("Input already connected to an input stream"); //$NON-NLS-1$
|
||||
}
|
||||
|
||||
output = out;
|
||||
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, StandardCharsets.UTF_8);
|
||||
final InputStreamReader streamReader = new InputStreamReader(stream,
|
||||
StandardCharsets.UTF_8);
|
||||
final BufferedReader reader = new BufferedReader(streamReader);
|
||||
connexion = new ReadingRunnable(reader);
|
||||
final Thread th = new Thread(connexion, "GCLC Socket - Read input"); //$NON-NLS-1$
|
||||
@@ -145,7 +148,7 @@ public final class PluggableConsoleInput implements ConsoleInput {
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.manager.ConsoleInput#getPrompt() */
|
||||
@Override
|
||||
public StringProvider getPrompt() {
|
||||
public Supplier<String> getPrompt() {
|
||||
return prompt;
|
||||
}
|
||||
|
||||
@@ -174,14 +177,14 @@ public final class PluggableConsoleInput implements ConsoleInput {
|
||||
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt() */
|
||||
@Override
|
||||
public String prompt() throws IOException {
|
||||
return prompt(prompt.apply());
|
||||
return prompt(prompt.get());
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(long) */
|
||||
@Override
|
||||
public String prompt(final long timeout) throws IOException {
|
||||
return prompt(prompt.apply(), timeout);
|
||||
return prompt(prompt.get(), timeout);
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
@@ -191,19 +194,11 @@ public final class PluggableConsoleInput implements ConsoleInput {
|
||||
if (closed) {
|
||||
throw new IOException();
|
||||
}
|
||||
prompting = true;
|
||||
hint = message;
|
||||
synchronized (connexionLock) {
|
||||
hint = message;
|
||||
if (connected) {
|
||||
output.print(message);
|
||||
output.flush();
|
||||
}
|
||||
}
|
||||
|
||||
preparePrompt(message);
|
||||
String res = null;
|
||||
while (res == null && !interrupted) {
|
||||
try {
|
||||
// Wait for a message or a connection with message
|
||||
res = waitMessageOrConnexion(TIMEOUT, TIMEOUT / TENTH);
|
||||
} catch (final InterruptedException e) {
|
||||
LOGGER.log(Level.FINE, "Interruption of thread", e); //$NON-NLS-1$
|
||||
@@ -217,31 +212,36 @@ public final class PluggableConsoleInput implements ConsoleInput {
|
||||
return res;
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String,
|
||||
* long) */
|
||||
@Override
|
||||
public String prompt(final String message,
|
||||
final long timeout) throws IOException {
|
||||
if (closed) {
|
||||
throw new IOException();
|
||||
}
|
||||
/** Prepare the new prompt.
|
||||
*
|
||||
* @param message the message to indicate request of prompt. */
|
||||
private void preparePrompt(final String message) {
|
||||
prompting = true;
|
||||
// hold the message
|
||||
synchronized (connexionLock) {
|
||||
hint = message;
|
||||
if (connected) {
|
||||
// print the message
|
||||
output.print(message);
|
||||
output.flush();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, long) */
|
||||
@Override
|
||||
public String prompt(final String message, final long timeout) throws IOException {
|
||||
if (closed) {
|
||||
throw new IOException();
|
||||
}
|
||||
preparePrompt(message);
|
||||
String res = null;
|
||||
final long tic = System.currentTimeMillis();
|
||||
long time = System.currentTimeMillis() - tic;
|
||||
while (res == null && !interrupted && time < timeout) {
|
||||
try {
|
||||
res = waitMessageOrConnexion(timeout - time,
|
||||
(timeout - time) / TENTH);
|
||||
res = waitMessageOrConnexion(timeout - time, (timeout - time) / TENTH);
|
||||
} catch (final InterruptedException e) {
|
||||
LOGGER.log(Level.FINE, "Interruption of thread", e); //$NON-NLS-1$
|
||||
Thread.currentThread().interrupt();
|
||||
@@ -255,29 +255,39 @@ public final class PluggableConsoleInput implements ConsoleInput {
|
||||
return res;
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */
|
||||
@Override
|
||||
public void setPrompt(final StringProvider prompt) {
|
||||
public void setPrompt(final String prompt) {
|
||||
setPrompt(new ConstantString(prompt));
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.manager.ConsoleInput#setPrompt(net.bigeon.gclc.tools.
|
||||
* StringProvider) */
|
||||
@Override
|
||||
public void setPrompt(final Supplier<String> prompt) {
|
||||
this.prompt = prompt;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void setPrompt(String prompt) {
|
||||
setPrompt(new ConstantString(prompt));
|
||||
}
|
||||
|
||||
/** Wait for a hint or connexion.
|
||||
/** Wait for a hint or connection.
|
||||
*
|
||||
* @param messageTimeout the timeout on the current connexion hint waiting
|
||||
* @param connexionTimeout the timeout on the new connexion wait
|
||||
* @param messageTimeout the timeout on the current connection hint waiting
|
||||
* @param connexionTimeout the timeout on the new connection wait
|
||||
* @return the hint, or null if not connected or timed out.
|
||||
* @throws IOException if the reading failed.
|
||||
* @throws InterruptedException if the wait was interrupted */
|
||||
private String waitMessageOrConnexion(final long messageTimeout,
|
||||
final long connexionTimeout) throws IOException,
|
||||
InterruptedException {
|
||||
final long connexionTimeout) throws IOException, InterruptedException {
|
||||
synchronized (connexionLock) {
|
||||
if (connected) {
|
||||
return connexion.getNextMessage(messageTimeout);
|
||||
try {
|
||||
return connexion.getNextMessage(messageTimeout);
|
||||
} catch (final InterruptedIOException e) {
|
||||
throw e;
|
||||
} catch (final IOException e) {
|
||||
LOGGER.log(Level.INFO, "Communication was abrubptly interrupted", e);
|
||||
}
|
||||
}
|
||||
connexionLock.wait(connexionTimeout);
|
||||
}
|
||||
|
||||
@@ -50,16 +50,17 @@ import net.bigeon.gclc.manager.ConsoleOutput;
|
||||
public final class PluggableConsoleOutput implements ConsoleOutput {
|
||||
|
||||
/** The actual output. */
|
||||
private PrintStream out;
|
||||
private PrintStream out;
|
||||
/** The buffered messages. */
|
||||
private final Deque<String> messages = new ArrayDeque<>();
|
||||
/** If this output is closed. */
|
||||
private boolean closed = false;
|
||||
private boolean closed = false;
|
||||
|
||||
/** Default constructor. */
|
||||
public PluggableConsoleOutput() {
|
||||
//
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see java.lang.AutoCloseable#close() */
|
||||
@Override
|
||||
|
||||
@@ -57,16 +57,16 @@ public final class RemoteDisconnectCommand<T> extends Command {
|
||||
private final ConnexionManager<T> manager;
|
||||
/** If all connexion should be disconnected when no argument have been
|
||||
* specified. */
|
||||
private final boolean all;
|
||||
private final boolean all;
|
||||
|
||||
/** Create the disconnection command.
|
||||
*
|
||||
* @param name the command name
|
||||
* @param manager the manager
|
||||
* @param all if all elements should be disconnected when no argument is
|
||||
* provided */
|
||||
public RemoteDisconnectCommand(final String name,
|
||||
final ConnexionManager<T> manager, final boolean all) {
|
||||
* provided */
|
||||
public RemoteDisconnectCommand(final String name, final ConnexionManager<T> manager,
|
||||
final boolean all) {
|
||||
super(name);
|
||||
this.manager = manager;
|
||||
this.all = all;
|
||||
@@ -74,11 +74,10 @@ public final class RemoteDisconnectCommand<T> extends Command {
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
|
||||
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
|
||||
* java.lang.String[]) */
|
||||
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[]) */
|
||||
@Override
|
||||
public void execute(final ConsoleOutput out, final ConsoleInput in,
|
||||
final String... args) throws CommandRunException {
|
||||
final String... args) throws CommandRunException {
|
||||
if (args.length == 0 && all) {
|
||||
final Collection<String> coll = manager.getConnected();
|
||||
for (final String string : coll) {
|
||||
@@ -89,8 +88,8 @@ public final class RemoteDisconnectCommand<T> extends Command {
|
||||
if (manager.isConnected(string)) {
|
||||
manager.disconnect(string);
|
||||
} else {
|
||||
print(out, MessageFormat
|
||||
.format("[WARNING] {0} is not connected", string)); //$NON-NLS-1$
|
||||
print(out,
|
||||
MessageFormat.format("[WARNING] {0} is not connected", string)); //$NON-NLS-1$
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -99,16 +98,14 @@ public final class RemoteDisconnectCommand<T> extends Command {
|
||||
*
|
||||
* @param out the output
|
||||
* @param string the message
|
||||
* @throws CommandRunException if the output exists but cannot be printed
|
||||
* to */
|
||||
private void print(final ConsoleOutput out,
|
||||
final String string) throws CommandRunException {
|
||||
* @throws CommandRunException if the output exists but cannot be printed to */
|
||||
private static void print(final ConsoleOutput out, final String string)
|
||||
throws CommandRunException {
|
||||
if (out != null) {
|
||||
try {
|
||||
out.println(string);
|
||||
} catch (final IOException e) {
|
||||
throw new CommandRunException(
|
||||
CommandRunExceptionType.INTERACTION,
|
||||
throw new CommandRunException(CommandRunExceptionType.INTERACTION,
|
||||
"Unable to print to existing output", e); //$NON-NLS-1$
|
||||
}
|
||||
}
|
||||
@@ -123,12 +120,10 @@ public final class RemoteDisconnectCommand<T> extends Command {
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.command.Command#usageDetail() */
|
||||
@SuppressWarnings("nls")
|
||||
@Override
|
||||
protected String usageDetail() {
|
||||
return MessageFormat.format(
|
||||
" If arguments are provided the corresponding connexions are closed, " +
|
||||
"otherwise{0}{1} are.",
|
||||
System.lineSeparator(), all ? "all connexions" : "none");
|
||||
" If arguments are provided the corresponding connexions are closed, otherwise\n{0} are.",
|
||||
all ? "all connexions" : "none");
|
||||
}
|
||||
}
|
||||
|
||||
@@ -64,31 +64,30 @@ import net.bigeon.gclc.ConsoleApplication;
|
||||
public final class SocketConsoleApplicationShell implements Runnable {
|
||||
|
||||
/** The class logger. */
|
||||
private static final Logger LOGGER = Logger
|
||||
private static final Logger LOGGER = Logger
|
||||
.getLogger(SocketConsoleApplicationShell.class.getName());
|
||||
/** The listening port. */
|
||||
private final int port;
|
||||
private final int port;
|
||||
/** The running status. */
|
||||
private boolean running;
|
||||
private boolean running;
|
||||
/** The socket console interface. */
|
||||
private SocketConsoleInterface sci;
|
||||
private SocketConsoleInterface sci;
|
||||
/** The remote disconnection command. */
|
||||
private ConnexionManager<Socket> rdc;
|
||||
/** The application. */
|
||||
private ConsoleApplication app;
|
||||
private ConsoleApplication app;
|
||||
|
||||
/** The server socket. */
|
||||
private ServerSocket serverSocket;
|
||||
private ServerSocket serverSocket;
|
||||
/** THe server address. */
|
||||
private final InetAddress addr;
|
||||
|
||||
/** Create a socket application shell which will listen on the given port
|
||||
* and network interface.
|
||||
/** Create a socket application shell which will listen on the given port and
|
||||
* network interface.
|
||||
*
|
||||
* @param port the part
|
||||
* @param addr the inet address */
|
||||
public SocketConsoleApplicationShell(final int port,
|
||||
final InetAddress addr) {
|
||||
public SocketConsoleApplicationShell(final int port, final InetAddress addr) {
|
||||
super();
|
||||
this.port = port;
|
||||
this.addr = addr;
|
||||
@@ -110,9 +109,9 @@ public final class SocketConsoleApplicationShell implements Runnable {
|
||||
}
|
||||
|
||||
/** If the port provided was 0, this allows to get the actual port.
|
||||
*
|
||||
* @return the local port
|
||||
* @see java.net.ServerSocket#getLocalPort()
|
||||
*/
|
||||
* @see java.net.ServerSocket#getLocalPort() */
|
||||
public int getLocalPort() {
|
||||
return serverSocket.getLocalPort();
|
||||
}
|
||||
@@ -122,16 +121,14 @@ public final class SocketConsoleApplicationShell implements Runnable {
|
||||
@Override
|
||||
public void run() {
|
||||
// Create the server
|
||||
try (ServerSocket actualServerSocket = new ServerSocket(port, 1,
|
||||
addr)) {
|
||||
try (ServerSocket actualServerSocket = new ServerSocket(port, 1, addr)) {
|
||||
serverSocket = actualServerSocket;
|
||||
running = true;
|
||||
// Create the streams
|
||||
runSokectServer();
|
||||
} catch (final IOException e) {
|
||||
LOGGER.severe("Communication error between client and server"); //$NON-NLS-1$
|
||||
LOGGER.log(Level.FINE,
|
||||
"Communication error between client and server", e); //$NON-NLS-1$
|
||||
LOGGER.log(Level.FINE, "Communication error between client and server", e); //$NON-NLS-1$
|
||||
}
|
||||
}
|
||||
|
||||
@@ -141,7 +138,7 @@ public final class SocketConsoleApplicationShell implements Runnable {
|
||||
private void runSokectServer() throws IOException {
|
||||
while (running && app.isRunning()) {
|
||||
LOGGER.info("Waiting client"); //$NON-NLS-1$
|
||||
try (Socket clientSocket = serverSocket.accept();) {
|
||||
try (Socket clientSocket = serverSocket.accept()) {
|
||||
|
||||
sci.connect(clientSocket);
|
||||
|
||||
|
||||
@@ -48,7 +48,7 @@ import java.nio.charset.StandardCharsets;
|
||||
public final class SocketConsoleInterface {
|
||||
|
||||
/** The application's input. */
|
||||
private final PluggableConsoleInput input;
|
||||
private final PluggableConsoleInput input;
|
||||
/** The application's output. */
|
||||
private final PluggableConsoleOutput output;
|
||||
|
||||
@@ -57,7 +57,7 @@ public final class SocketConsoleInterface {
|
||||
* @param input the input
|
||||
* @param output the output */
|
||||
public SocketConsoleInterface(final PluggableConsoleInput input,
|
||||
final PluggableConsoleOutput output) {
|
||||
final PluggableConsoleOutput output) {
|
||||
super();
|
||||
this.input = input;
|
||||
this.output = output;
|
||||
@@ -68,12 +68,10 @@ public final class SocketConsoleInterface {
|
||||
* @param socket the socket
|
||||
* @throws IOException if the connection failed */
|
||||
public void connect(final Socket socket) throws IOException {
|
||||
final PrintStream printStream = new PrintStream(
|
||||
socket.getOutputStream(), true,
|
||||
final PrintStream printStream = new PrintStream(socket.getOutputStream(), true,
|
||||
StandardCharsets.UTF_8.name());
|
||||
output.connect(printStream);
|
||||
input.connect(socket.getInputStream(),
|
||||
printStream);
|
||||
input.connect(socket.getInputStream(), printStream);
|
||||
}
|
||||
|
||||
/** Disconnect the input and output of the application from the socket's. */
|
||||
|
||||
44
gclc-socket/src/site/site.xml
Normal file
44
gclc-socket/src/site/site.xml
Normal file
@@ -0,0 +1,44 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!--
|
||||
#%L
|
||||
Generic Command Ligne console
|
||||
%%
|
||||
Copyright (C) 2014 - 2018 Bigeon
|
||||
%%
|
||||
This software is governed by the CeCILL license under French law and
|
||||
abiding by the rules of distribution of free software. You can use,
|
||||
modify and/ or redistribute the software under the terms of the CeCILL
|
||||
license as circulated by CEA, CNRS and INRIA at the following URL
|
||||
"http://www.cecill.info".
|
||||
|
||||
As a counterpart to the access to the source code and rights to copy,
|
||||
modify and redistribute granted by the license, users are provided only
|
||||
with a limited warranty and the software's author, the holder of the
|
||||
economic rights, and the successive licensors have only limited
|
||||
liability.
|
||||
|
||||
In this respect, the user's attention is drawn to the risks associated
|
||||
with loading, using, modifying and/or developing or reproducing the
|
||||
software by the user in light of its specific status of free software,
|
||||
that may mean that it is complicated to manipulate, and that also
|
||||
therefore means that it is reserved for developers and experienced
|
||||
professionals having in-depth computer knowledge. Users are therefore
|
||||
encouraged to load and test the software's suitability as regards their
|
||||
requirements in conditions enabling the security of their systems and/or
|
||||
data to be ensured and, more generally, to use and operate it in the
|
||||
same conditions as regards security.
|
||||
|
||||
The fact that you are presently reading this means that you have had
|
||||
knowledge of the CeCILL license and that you accept its terms.
|
||||
#L%
|
||||
-->
|
||||
|
||||
<project name="GCLC">
|
||||
<bannerRight>
|
||||
<src>https://bigeon.net/images/logo_48.png</src>
|
||||
<href>https://bigeon.net/</href>
|
||||
</bannerRight>
|
||||
<body>
|
||||
<menu ref="reports"/>
|
||||
</body>
|
||||
</project>
|
||||
@@ -39,14 +39,12 @@ import java.util.Collection;
|
||||
|
||||
import net.bigeon.gclc.ConsoleApplication;
|
||||
import net.bigeon.gclc.command.Command;
|
||||
import net.bigeon.gclc.command.HelpExecutor;
|
||||
import net.bigeon.gclc.command.base.ExitCommand;
|
||||
import net.bigeon.gclc.command.base.HelpExecutor;
|
||||
import net.bigeon.gclc.exception.CommandRunException;
|
||||
import net.bigeon.gclc.exception.InvalidCommandName;
|
||||
import net.bigeon.gclc.manager.ConsoleInput;
|
||||
import net.bigeon.gclc.manager.ConsoleOutput;
|
||||
import net.bigeon.gclc.socket.ConnexionManager;
|
||||
import net.bigeon.gclc.socket.RemoteDisconnectCommand;
|
||||
|
||||
/** A test-purpose application
|
||||
*
|
||||
@@ -64,13 +62,10 @@ public class ConsoleTestApplication {
|
||||
* @return create the application */
|
||||
@SuppressWarnings("nls")
|
||||
public static ConsoleApplication create(final ConsoleOutput output,
|
||||
final ConsoleInput input,
|
||||
final ConnexionManager<Socket> manager) {
|
||||
final ConsoleInput input, final ConnexionManager<Socket> manager) {
|
||||
try {
|
||||
final ConsoleApplication application = new ConsoleApplication(
|
||||
output, input,
|
||||
"Welcome to the test application. Type help or test.",
|
||||
"See you");
|
||||
final ConsoleApplication application = new ConsoleApplication(output, input,
|
||||
"Welcome to the test application. Type help or test.", "See you");
|
||||
application.add(new ExitCommand(EXIT, application) {
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.command.ExitCommand#beforeExit() */
|
||||
@@ -82,8 +77,7 @@ public class ConsoleTestApplication {
|
||||
}
|
||||
}
|
||||
});
|
||||
application
|
||||
.add(new HelpExecutor("help", application.root));
|
||||
application.add(new HelpExecutor("help", application.root));
|
||||
application.add(new Command("test") {
|
||||
|
||||
/* (non-Javadoc)
|
||||
@@ -91,9 +85,8 @@ public class ConsoleTestApplication {
|
||||
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
|
||||
* java.lang.String[]) */
|
||||
@Override
|
||||
public void execute(final ConsoleOutput out,
|
||||
final ConsoleInput in,
|
||||
final String... args) throws CommandRunException {
|
||||
public void execute(final ConsoleOutput out, final ConsoleInput in,
|
||||
final String... args) throws CommandRunException {
|
||||
try {
|
||||
output.println("Test command ran fine");
|
||||
} catch (final IOException e) {
|
||||
@@ -107,8 +100,7 @@ public class ConsoleTestApplication {
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.command.Command#usageDetail()
|
||||
*/
|
||||
* @see fr.bigeon.gclc.command.Command#usageDetail() */
|
||||
@Override
|
||||
protected String usageDetail() {
|
||||
// TODO Auto-generated method stub
|
||||
@@ -123,11 +115,13 @@ public class ConsoleTestApplication {
|
||||
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
|
||||
* java.lang.String[]) */
|
||||
@Override
|
||||
public void execute(final ConsoleOutput out,
|
||||
final ConsoleInput in,
|
||||
final String... args) throws CommandRunException {
|
||||
public void execute(final ConsoleOutput out, final ConsoleInput in,
|
||||
final String... args) throws CommandRunException {
|
||||
try {
|
||||
Thread.sleep(2000);
|
||||
Object obj = new Object();
|
||||
synchronized (obj) {
|
||||
obj.wait(2000);
|
||||
}
|
||||
output.println("Test command ran fine");
|
||||
} catch (IOException | InterruptedException e) {
|
||||
throw new CommandRunException("manager closed", e);
|
||||
@@ -140,8 +134,7 @@ public class ConsoleTestApplication {
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.command.Command#usageDetail()
|
||||
*/
|
||||
* @see fr.bigeon.gclc.command.Command#usageDetail() */
|
||||
@Override
|
||||
protected String usageDetail() {
|
||||
// TODO Auto-generated method stub
|
||||
@@ -149,8 +142,7 @@ public class ConsoleTestApplication {
|
||||
throw new RuntimeException("Not implemented yet");
|
||||
}
|
||||
});
|
||||
application.add(
|
||||
new RemoteDisconnectCommand<>("out", manager, true));
|
||||
application.add(new RemoteDisconnectCommand<>("out", manager, true));
|
||||
return application;
|
||||
} catch (final InvalidCommandName e) {
|
||||
e.printStackTrace();
|
||||
|
||||
@@ -39,6 +39,7 @@ package net.bigeon.gclc.socket;
|
||||
*/
|
||||
import static org.junit.Assert.assertEquals;
|
||||
import static org.junit.Assert.assertFalse;
|
||||
import static org.junit.Assert.assertNotNull;
|
||||
import static org.junit.Assert.assertTrue;
|
||||
import static org.junit.Assert.fail;
|
||||
|
||||
@@ -46,11 +47,10 @@ import java.io.IOException;
|
||||
import java.io.PipedInputStream;
|
||||
import java.io.PipedOutputStream;
|
||||
import java.io.PrintStream;
|
||||
import java.util.concurrent.atomic.AtomicReference;
|
||||
|
||||
import org.junit.Test;
|
||||
|
||||
import net.bigeon.gclc.socket.PluggableConsoleInput;
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* TODO
|
||||
@@ -90,7 +90,10 @@ public class PluggableConsoleInputTest {
|
||||
|
||||
}
|
||||
try {
|
||||
Thread.sleep(100);
|
||||
final Object obj = new Object();
|
||||
synchronized (obj) {
|
||||
obj.wait(100);
|
||||
}
|
||||
} catch (final InterruptedException e) {
|
||||
// TODO Auto-generated catch block
|
||||
e.printStackTrace();
|
||||
@@ -112,7 +115,10 @@ public class PluggableConsoleInputTest {
|
||||
@Override
|
||||
public void run() {
|
||||
try {
|
||||
Thread.sleep(200);
|
||||
final Object obj = new Object();
|
||||
synchronized (obj) {
|
||||
obj.wait(200);
|
||||
}
|
||||
} catch (final InterruptedException e) {
|
||||
// TODO Auto-generated catch block
|
||||
e.printStackTrace();
|
||||
@@ -135,11 +141,11 @@ public class PluggableConsoleInputTest {
|
||||
|
||||
input.disconnect();
|
||||
try (final PipedInputStream pis = new PipedInputStream();
|
||||
final PipedOutputStream pos = new PipedOutputStream();
|
||||
final PipedInputStream inner = new PipedInputStream(pos);
|
||||
final PipedOutputStream innerPos = new PipedOutputStream(pis);
|
||||
final PrintStream testIn = new PrintStream(innerPos, true, "UTF8");
|
||||
final PrintStream out = new PrintStream(pos)) {
|
||||
final PipedOutputStream pos = new PipedOutputStream();
|
||||
final PipedInputStream inner = new PipedInputStream(pos);
|
||||
final PipedOutputStream innerPos = new PipedOutputStream(pis);
|
||||
final PrintStream testIn = new PrintStream(innerPos, true, "UTF8");
|
||||
final PrintStream out = new PrintStream(pos)) {
|
||||
input.connect(pis, out);
|
||||
try {
|
||||
input.connect(pis, out);
|
||||
@@ -162,32 +168,40 @@ public class PluggableConsoleInputTest {
|
||||
});
|
||||
th.start();
|
||||
|
||||
while (!input.isPrompting()) {
|
||||
Thread.sleep(10);
|
||||
final Object obj = new Object();
|
||||
synchronized (obj) {
|
||||
while (!input.isPrompting()) {
|
||||
obj.wait(10);
|
||||
}
|
||||
}
|
||||
|
||||
input.connect(pis, out);
|
||||
testIn.println("tac");
|
||||
|
||||
final AtomicReference<IOException> ref = new AtomicReference<>();
|
||||
final Thread th2 = new Thread(new Runnable() {
|
||||
|
||||
@Override
|
||||
public void run() {
|
||||
try {
|
||||
input.prompt("Test", 5000);
|
||||
fail("Prompt should io");
|
||||
// fail("Prompt should io");
|
||||
} catch (final IOException e) {
|
||||
// ok
|
||||
ref.set(e);
|
||||
}
|
||||
}
|
||||
});
|
||||
th2.start();
|
||||
while (!input.isPrompting()) {
|
||||
Thread.sleep(10);
|
||||
synchronized (obj) {
|
||||
while (!input.isPrompting()) {
|
||||
obj.wait(10);
|
||||
}
|
||||
}
|
||||
|
||||
input.close();
|
||||
|
||||
th2.join();
|
||||
assertNotNull("Prompt should io", ref.get());
|
||||
|
||||
}
|
||||
}
|
||||
@@ -197,8 +211,8 @@ public class PluggableConsoleInputTest {
|
||||
@Test
|
||||
public final void testGetPrompt() {
|
||||
final PluggableConsoleInput input = new PluggableConsoleInput();
|
||||
assertEquals("Default prompt invalid", "> ", input.getPrompt().apply());
|
||||
assertEquals("Default prompt invalid", "> ", input.getPrompt().get());
|
||||
input.setPrompt("test");
|
||||
assertEquals("Prompt setting failed", "test", input.getPrompt().apply());
|
||||
assertEquals("Prompt setting failed", "test", input.getPrompt().get());
|
||||
}
|
||||
}
|
||||
|
||||
@@ -46,9 +46,7 @@ import java.io.IOException;
|
||||
import org.junit.Test;
|
||||
|
||||
import net.bigeon.gclc.exception.CommandRunException;
|
||||
import net.bigeon.gclc.socket.DConnexionManager;
|
||||
import net.bigeon.gclc.socket.RemoteDisconnectCommand;
|
||||
import net.bigeon.gclc.utils.PipedConsoleOutput;
|
||||
import net.bigeon.gclc.manager.PipedConsoleOutput;
|
||||
|
||||
/**
|
||||
* <p>
|
||||
@@ -65,10 +63,10 @@ public class RemoteDisconnectCommandTest {
|
||||
@Test
|
||||
public final void testExecute() throws CommandRunException, IOException {
|
||||
final DConnexionManager<String> manager = new DConnexionManager<>();
|
||||
final RemoteDisconnectCommand<String> cmd = new RemoteDisconnectCommand<>(
|
||||
"quit", manager, true);
|
||||
final RemoteDisconnectCommand<String> cmd2 = new RemoteDisconnectCommand<>(
|
||||
"quit", manager, false);
|
||||
final RemoteDisconnectCommand<String> cmd = new RemoteDisconnectCommand<>("quit",
|
||||
manager, true);
|
||||
final RemoteDisconnectCommand<String> cmd2 = new RemoteDisconnectCommand<>("quit",
|
||||
manager, false);
|
||||
manager.addConnexion("test");
|
||||
|
||||
cmd2.execute(null, null);
|
||||
|
||||
@@ -43,17 +43,16 @@ import java.io.BufferedReader;
|
||||
import java.io.IOException;
|
||||
import java.io.InputStreamReader;
|
||||
import java.io.PrintWriter;
|
||||
import java.net.InetAddress;
|
||||
import java.net.Socket;
|
||||
import java.util.logging.Logger;
|
||||
|
||||
import org.junit.Test;
|
||||
|
||||
import net.bigeon.gclc.socket.SocketConsoleApplicationShell;
|
||||
|
||||
/** Test class for {@link SocketConsoleApplicationShell}
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
@SuppressWarnings({"static-method", "javadoc", "nls"})
|
||||
@SuppressWarnings({ "static-method", "javadoc", "nls" })
|
||||
public class SocketConsoleApplicationTest {
|
||||
|
||||
private static final Logger LOGGER = Logger
|
||||
@@ -62,12 +61,12 @@ public class SocketConsoleApplicationTest {
|
||||
/** @param in the input
|
||||
* @return the string
|
||||
* @throws IOException if the input reading failed */
|
||||
private String consumeToPrompt(final String server,
|
||||
final BufferedReader in) throws IOException {
|
||||
private String consumeToPrompt(final String server, final BufferedReader in)
|
||||
throws IOException {
|
||||
String fromServer = server;
|
||||
LOGGER.fine("Server: \n" + fromServer);
|
||||
while (fromServer != null && !fromServer.equals("Bye.") &&
|
||||
!fromServer.equals("> ")) {
|
||||
while (fromServer != null && !fromServer.equals("Bye.")
|
||||
&& !fromServer.equals("> ")) {
|
||||
fromServer = in.readLine();
|
||||
LOGGER.fine("Server: \n" + fromServer);
|
||||
}
|
||||
@@ -78,19 +77,17 @@ public class SocketConsoleApplicationTest {
|
||||
public void testIntegration() throws IOException, InterruptedException {
|
||||
Thread server;
|
||||
server = TestServer.getServer();
|
||||
Thread.sleep(1000);
|
||||
final String hostName = "127.0.0.1";
|
||||
final int portNumber = 3300;
|
||||
final InetAddress hostName = InetAddress.getLocalHost();
|
||||
final int portNumber = TestServer.PORT;
|
||||
|
||||
try (Socket kkSocket = new Socket(hostName, portNumber);
|
||||
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(),
|
||||
true);
|
||||
BufferedReader in = new BufferedReader(
|
||||
new InputStreamReader(kkSocket.getInputStream()));) {
|
||||
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(), true);
|
||||
BufferedReader in = new BufferedReader(
|
||||
new InputStreamReader(kkSocket.getInputStream()));) {
|
||||
|
||||
String fromServer;
|
||||
int i = -1;
|
||||
final String[] cmds = {"help", "toto", "test", "out"};
|
||||
final String[] cmds = { "help", "toto", "test", "out" };
|
||||
while ((fromServer = in.readLine()) != null) {
|
||||
i++;
|
||||
fromServer = consumeToPrompt(fromServer, in);
|
||||
@@ -108,15 +105,13 @@ public class SocketConsoleApplicationTest {
|
||||
}
|
||||
|
||||
try (Socket kkSocket = new Socket(hostName, portNumber);
|
||||
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(),
|
||||
true);
|
||||
BufferedReader in = new BufferedReader(
|
||||
new InputStreamReader(kkSocket.getInputStream()));) {
|
||||
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(), true);
|
||||
BufferedReader in = new BufferedReader(
|
||||
new InputStreamReader(kkSocket.getInputStream()));) {
|
||||
|
||||
String fromServer;
|
||||
int i = 0;
|
||||
final String[] cmds = {"help", "toto", "test",
|
||||
ConsoleTestApplication.EXIT};
|
||||
final String[] cmds = { "help", "toto", "test", ConsoleTestApplication.EXIT };
|
||||
while ((fromServer = in.readLine()) != null) {
|
||||
fromServer = consumeToPrompt(fromServer, in);
|
||||
if (fromServer == null || fromServer.equals("Bye.")) {
|
||||
@@ -131,26 +126,20 @@ public class SocketConsoleApplicationTest {
|
||||
}
|
||||
i++;
|
||||
}
|
||||
assertEquals("Application exit command should close connection", 4,
|
||||
i);
|
||||
assertEquals("Application exit command should close connection", 4, i);
|
||||
}
|
||||
Thread.sleep(100);
|
||||
TestServer.closeServer();
|
||||
server.join();
|
||||
server = TestServer.getServer();
|
||||
Thread.sleep(1000);
|
||||
|
||||
|
||||
try (Socket kkSocket = new Socket(hostName, portNumber);
|
||||
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(),
|
||||
true);
|
||||
BufferedReader in = new BufferedReader(
|
||||
new InputStreamReader(kkSocket.getInputStream()));) {
|
||||
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(), true);
|
||||
BufferedReader in = new BufferedReader(
|
||||
new InputStreamReader(kkSocket.getInputStream()));) {
|
||||
|
||||
String fromServer;
|
||||
int i = 0;
|
||||
final String[] cmds = {"help", "toto", "test",
|
||||
ConsoleTestApplication.EXIT};
|
||||
final String[] cmds = { "help", "toto", "test", ConsoleTestApplication.EXIT };
|
||||
while ((fromServer = in.readLine()) != null) {
|
||||
fromServer = consumeToPrompt(fromServer, in);
|
||||
if (fromServer == null || fromServer.equals("Bye.")) {
|
||||
@@ -164,8 +153,7 @@ public class SocketConsoleApplicationTest {
|
||||
}
|
||||
i++;
|
||||
}
|
||||
assertEquals("Application exit command should close connection", 4,
|
||||
i);
|
||||
assertEquals("Application exit command should close connection", 4, i);
|
||||
}
|
||||
TestServer.closeServer();
|
||||
server.join();
|
||||
|
||||
@@ -44,9 +44,8 @@ import java.util.Collection;
|
||||
import net.bigeon.smu.StringEncoder;
|
||||
|
||||
/** TODO Describe TestConsoleClient.java
|
||||
* @author Emmanuel Bigeon
|
||||
*
|
||||
*/
|
||||
* @author Emmanuel Bigeon */
|
||||
@SuppressWarnings("nls")
|
||||
public class TestConsoleClient {
|
||||
@SuppressWarnings("javadoc")
|
||||
@@ -56,8 +55,7 @@ public class TestConsoleClient {
|
||||
}
|
||||
|
||||
@SuppressWarnings("javadoc")
|
||||
private static final StringEncoder ENCODER = new StringEncoder("%",
|
||||
TO_ENCODE);
|
||||
private static final StringEncoder ENCODER = new StringEncoder("%", TO_ENCODE);
|
||||
|
||||
@SuppressWarnings("javadoc")
|
||||
public static void main(String[] args) {
|
||||
@@ -65,10 +63,9 @@ public class TestConsoleClient {
|
||||
final int portNumber = 3300;
|
||||
|
||||
try (Socket kkSocket = new Socket(hostName, portNumber);
|
||||
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(),
|
||||
true);
|
||||
BufferedReader in = new BufferedReader(new InputStreamReader(
|
||||
kkSocket.getInputStream()));) {
|
||||
PrintWriter out = new PrintWriter(kkSocket.getOutputStream(), true);
|
||||
BufferedReader in = new BufferedReader(
|
||||
new InputStreamReader(kkSocket.getInputStream()));) {
|
||||
|
||||
String fromServer;
|
||||
while ((fromServer = in.readLine()) != null) {
|
||||
|
||||
@@ -39,24 +39,19 @@ import java.net.Socket;
|
||||
import java.net.UnknownHostException;
|
||||
|
||||
import net.bigeon.gclc.ConsoleApplication;
|
||||
import net.bigeon.gclc.socket.ConnexionManager;
|
||||
import net.bigeon.gclc.socket.DConnexionManager;
|
||||
import net.bigeon.gclc.socket.PluggableConsoleInput;
|
||||
import net.bigeon.gclc.socket.PluggableConsoleOutput;
|
||||
import net.bigeon.gclc.socket.SocketConsoleApplicationShell;
|
||||
import net.bigeon.gclc.socket.SocketConsoleInterface;
|
||||
|
||||
/** A test server
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
@SuppressWarnings({"javadoc", "nls"})
|
||||
@SuppressWarnings({ "javadoc", "nls" })
|
||||
public class TestServer {
|
||||
|
||||
public static final int PORT = 12343;
|
||||
private static SocketConsoleApplicationShell SHELL;
|
||||
private static ConnexionManager<Socket> manager;
|
||||
private static ConnexionManager<Socket> manager;
|
||||
|
||||
private static Thread server;
|
||||
private static PluggableConsoleInput input;
|
||||
private static Thread server;
|
||||
private static PluggableConsoleInput input;
|
||||
private static PluggableConsoleOutput output;
|
||||
|
||||
public static synchronized void closeServer() {
|
||||
@@ -81,10 +76,9 @@ public class TestServer {
|
||||
input.setPrompt("> \n");
|
||||
output = new PluggableConsoleOutput();
|
||||
manager = new DConnexionManager<>();
|
||||
SHELL = new SocketConsoleApplicationShell(3300,
|
||||
InetAddress.getByName("127.0.0.1"));
|
||||
final ConsoleApplication app = ConsoleTestApplication
|
||||
.create(output, input, manager);
|
||||
SHELL = new SocketConsoleApplicationShell(PORT, InetAddress.getLocalHost());
|
||||
final ConsoleApplication app = ConsoleTestApplication.create(output, input,
|
||||
manager);
|
||||
SHELL.setInterface(new SocketConsoleInterface(input, output));
|
||||
SHELL.setConnexionManager(manager);
|
||||
SHELL.setApplication(app);
|
||||
@@ -96,6 +90,16 @@ public class TestServer {
|
||||
}
|
||||
});
|
||||
th.start();
|
||||
try {
|
||||
final Object waiting = new Object();
|
||||
synchronized (waiting) {
|
||||
while (!input.isPrompting()) {
|
||||
waiting.wait(50);
|
||||
}
|
||||
}
|
||||
} catch (final InterruptedException e) {
|
||||
Thread.currentThread().interrupt();
|
||||
}
|
||||
}
|
||||
return SHELL;
|
||||
}
|
||||
|
||||
4
gclc-swt/.gitignore
vendored
4
gclc-swt/.gitignore
vendored
@@ -1,4 +0,0 @@
|
||||
/target/
|
||||
/.settings/
|
||||
/.classpath
|
||||
/.project
|
||||
137
gclc-swt/pom.xml
137
gclc-swt/pom.xml
@@ -1,69 +1,22 @@
|
||||
|
||||
<!-- GCLC swt, provide a swt window for console applications -->
|
||||
<!-- Copyright (C) 2015-2017 E. Bigeon -->
|
||||
<!-- mailto:emmanuel@bigeon.fr -->
|
||||
<!-- -->
|
||||
<!-- This software is governed by the CeCILL license under French law and -->
|
||||
<!-- abiding by the rules of distribution of free software. You can use, -->
|
||||
<!-- modify and/or redistribute the software under the terms of the CeCILL -->
|
||||
<!-- license as circulated by CEA, CNRS and INRIA at the following URL -->
|
||||
<!-- "http://www.cecill.info". -->
|
||||
<!-- -->
|
||||
<!-- As a counterpart to the access to the source code and rights to copy, -->
|
||||
<!-- modify and redistribute granted by the license, users are provided only -->
|
||||
<!-- with a limited warranty and the software's author, the holder of the -->
|
||||
<!-- economic rights, and the successive licensors have only limited -->
|
||||
<!-- liability. -->
|
||||
<!-- -->
|
||||
<!-- In this respect, the user's attention is drawn to the risks associated -->
|
||||
<!-- with loading, using, modifying and/or developing or reproducing the -->
|
||||
<!-- software by the user in light of its specific status of free software, -->
|
||||
<!-- that may mean that it is complicated to manipulate, and that also -->
|
||||
<!-- therefore means that it is reserved for developers and experienced -->
|
||||
<!-- professionals having in-depth computer knowledge. Users are therefore -->
|
||||
<!-- encouraged to load and test the software's suitability as regards their -->
|
||||
<!-- requirements in conditions enabling the security of their systems and/or -->
|
||||
<!-- data to be ensured and, more generally, to use and operate it in the -->
|
||||
<!-- same conditions as regards security. -->
|
||||
<!-- -->
|
||||
<!-- The fact that you are presently reading this means that you have had -->
|
||||
<!-- knowledge of the CeCILL license and that you accept its terms. -->
|
||||
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<groupId>net.bigeon.gclc</groupId>
|
||||
<artifactId>gclc-swt</artifactId>
|
||||
<version>1.1.6-SNAPSHOT</version>
|
||||
<packaging>jar</packaging>
|
||||
<inceptionYear>2015</inceptionYear>
|
||||
<name>GCLC swt</name>
|
||||
<description>A swt window for console applications</description>
|
||||
|
||||
<parent>
|
||||
<groupId>net.bigeon.config</groupId>
|
||||
<artifactId>swt-config</artifactId>
|
||||
<version>1.8.7</version>
|
||||
</parent>
|
||||
|
||||
<properties>
|
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||
<copyright.email>emmanuel@bigeon.fr</copyright.email>
|
||||
<license.licenseName>cecill_2.1</license.licenseName>
|
||||
</properties>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>net.bigeon</groupId>
|
||||
<artifactId>gclc</artifactId>
|
||||
<version>2.0.7</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>net.bigeon</groupId>
|
||||
<artifactId>collections</artifactId>
|
||||
<version>1.1.1</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<parent>
|
||||
<groupId>net.bigeon.config</groupId>
|
||||
<artifactId>swt-public-conf</artifactId>
|
||||
<version>1.0.1</version>
|
||||
</parent>
|
||||
<groupId>net.bigeon.gclc</groupId>
|
||||
<artifactId>swt</artifactId>
|
||||
<version>1.2.1-SNAPSHOT</version>
|
||||
<packaging>jar</packaging>
|
||||
<name>GCLC swt</name>
|
||||
<description>A swt window for console applications</description>
|
||||
<url>https://bigeon.net/projects/gclc.html</url>
|
||||
<inceptionYear>2015</inceptionYear>
|
||||
<organization>
|
||||
<name>Bigeon</name>
|
||||
<url>https://bigeon.net/</url>
|
||||
</organization>
|
||||
<licenses>
|
||||
<license>
|
||||
<distribution>manual</distribution>
|
||||
@@ -71,6 +24,45 @@
|
||||
<url>https://cecill.info/licences/Licence_CeCILL_V2.1-en.html</url>
|
||||
</license>
|
||||
</licenses>
|
||||
<developers>
|
||||
<developer>
|
||||
<email>emmanuel@bigeon.fr</email>
|
||||
<name>Emmanuel Bigeon</name>
|
||||
<url>bigeon.net</url>
|
||||
<roles>
|
||||
<role>PM</role>
|
||||
</roles>
|
||||
</developer>
|
||||
</developers>
|
||||
<scm>
|
||||
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
|
||||
<tag>HEAD</tag>
|
||||
</scm>
|
||||
<properties>
|
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||
<copyright.email>emmanuel@bigeon.fr</copyright.email>
|
||||
<license.licenseName>cecill_2.1</license.licenseName>
|
||||
</properties>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>net.bigeon</groupId>
|
||||
<artifactId>gclc</artifactId>
|
||||
<version>2.1.0</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>net.bigeon</groupId>
|
||||
<artifactId>collections</artifactId>
|
||||
<version>1.2.6</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.mockito</groupId>
|
||||
<artifactId>mockito-core</artifactId>
|
||||
<version>2.27.0</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
<reporting>
|
||||
<plugins>
|
||||
<plugin>
|
||||
@@ -85,19 +77,4 @@
|
||||
</plugin>
|
||||
</plugins>
|
||||
</reporting>
|
||||
<developers>
|
||||
<developer>
|
||||
<email>emmanuel@bigeon.fr</email>
|
||||
<name>Emmanuel Bigeon</name>
|
||||
<url>bigeon.net</url>
|
||||
<roles>
|
||||
<role>PM</role>
|
||||
</roles>
|
||||
</developer>
|
||||
</developers>
|
||||
|
||||
<scm>
|
||||
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
|
||||
<tag>HEAD</tag>
|
||||
</scm>
|
||||
</project>
|
||||
|
||||
@@ -35,6 +35,8 @@
|
||||
*/
|
||||
package net.bigeon.gclc.swt;
|
||||
|
||||
import java.io.IOException;
|
||||
|
||||
/*-
|
||||
* #%L
|
||||
* GCLC swt
|
||||
@@ -77,6 +79,7 @@ package net.bigeon.gclc.swt;
|
||||
* @author Emmanuel Bigeon */
|
||||
public interface ConsoleDelayIO {
|
||||
/** Get the input text.
|
||||
*
|
||||
* @return the non validated input */
|
||||
String getInput();
|
||||
|
||||
@@ -85,6 +88,8 @@ public interface ConsoleDelayIO {
|
||||
* @param input the input to set */
|
||||
void setInput(String input);
|
||||
|
||||
/** Actually send the input as the prompt next input. */
|
||||
void validateInput();
|
||||
/** Actually send the input as the prompt next input.
|
||||
*
|
||||
* @throws IOException if an error occurred */
|
||||
void validateInput() throws IOException;
|
||||
}
|
||||
|
||||
@@ -0,0 +1,97 @@
|
||||
/**
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.swt;
|
||||
|
||||
/*-
|
||||
* #%L
|
||||
* GCLC swt
|
||||
* %%
|
||||
* Copyright (C) 2015 - 2018 Bigeon
|
||||
* %%
|
||||
* This software is governed by the CeCILL license under French law and
|
||||
* abiding by the rules of distribution of free software. You can use,
|
||||
* modify and/ or redistribute the software under the terms of the CeCILL
|
||||
* license as circulated by CEA, CNRS and INRIA at the following URL
|
||||
* "http://www.cecill.info".
|
||||
*
|
||||
* As a counterpart to the access to the source code and rights to copy,
|
||||
* modify and redistribute granted by the license, users are provided only
|
||||
* with a limited warranty and the software's author, the holder of the
|
||||
* economic rights, and the successive licensors have only limited
|
||||
* liability.
|
||||
*
|
||||
* In this respect, the user's attention is drawn to the risks associated
|
||||
* with loading, using, modifying and/or developing or reproducing the
|
||||
* software by the user in light of its specific status of free software,
|
||||
* that may mean that it is complicated to manipulate, and that also
|
||||
* therefore means that it is reserved for developers and experienced
|
||||
* professionals having in-depth computer knowledge. Users are therefore
|
||||
* encouraged to load and test the software's suitability as regards their
|
||||
* requirements in conditions enabling the security of their systems and/or
|
||||
* data to be ensured and, more generally, to use and operate it in the
|
||||
* same conditions as regards security.
|
||||
*
|
||||
* The fact that you are presently reading this means that you have had
|
||||
* knowledge of the CeCILL license and that you accept its terms.
|
||||
* #L%
|
||||
*/
|
||||
|
||||
import java.io.IOException;
|
||||
|
||||
import org.eclipse.swt.widgets.Text;
|
||||
|
||||
import net.bigeon.gclc.manager.PipedConsoleInput;
|
||||
|
||||
/** The object managing the console input.
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
public final class ConsoleInputManager implements ConsoleDelayIO {
|
||||
|
||||
private final Text text;
|
||||
private PipedConsoleInput input;
|
||||
|
||||
/** Create a managing object.
|
||||
*
|
||||
* @param text the text */
|
||||
public ConsoleInputManager(final Text text) {
|
||||
super();
|
||||
this.text = text;
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.swt.ConsoleDelayIO#setInput(java.lang.String) */
|
||||
@Override
|
||||
public void setInput(final String string) {
|
||||
text.setText(string);
|
||||
text.setSelection(string.length());
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.swt.ConsoleDelayIO#getInput() */
|
||||
@Override
|
||||
public String getInput() {
|
||||
return text.getText();
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.swt.ConsoleDelayIO#validateInput() */
|
||||
@Override
|
||||
public void validateInput() throws IOException {
|
||||
input.type(text.getText());
|
||||
}
|
||||
|
||||
/** Set the input to control.
|
||||
*
|
||||
* @param input the input */
|
||||
public void setManager(final PipedConsoleInput input) {
|
||||
this.input = input;
|
||||
}
|
||||
|
||||
/** Get the text component containing the currently set input.
|
||||
*
|
||||
* @return the text */
|
||||
public Text getText() {
|
||||
return text;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,50 @@
|
||||
/**
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.swt;
|
||||
|
||||
/*-
|
||||
* #%L
|
||||
* GCLC swt
|
||||
* %%
|
||||
* Copyright (C) 2015 - 2018 Bigeon
|
||||
* %%
|
||||
* This software is governed by the CeCILL license under French law and
|
||||
* abiding by the rules of distribution of free software. You can use,
|
||||
* modify and/ or redistribute the software under the terms of the CeCILL
|
||||
* license as circulated by CEA, CNRS and INRIA at the following URL
|
||||
* "http://www.cecill.info".
|
||||
*
|
||||
* As a counterpart to the access to the source code and rights to copy,
|
||||
* modify and redistribute granted by the license, users are provided only
|
||||
* with a limited warranty and the software's author, the holder of the
|
||||
* economic rights, and the successive licensors have only limited
|
||||
* liability.
|
||||
*
|
||||
* In this respect, the user's attention is drawn to the risks associated
|
||||
* with loading, using, modifying and/or developing or reproducing the
|
||||
* software by the user in light of its specific status of free software,
|
||||
* that may mean that it is complicated to manipulate, and that also
|
||||
* therefore means that it is reserved for developers and experienced
|
||||
* professionals having in-depth computer knowledge. Users are therefore
|
||||
* encouraged to load and test the software's suitability as regards their
|
||||
* requirements in conditions enabling the security of their systems and/or
|
||||
* data to be ensured and, more generally, to use and operate it in the
|
||||
* same conditions as regards security.
|
||||
*
|
||||
* The fact that you are presently reading this means that you have had
|
||||
* knowledge of the CeCILL license and that you accept its terms.
|
||||
* #L%
|
||||
*/
|
||||
|
||||
/** The common interface for console display.
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
public interface ConsoleOutputDisplay {
|
||||
|
||||
/** Append a line to the display.
|
||||
*
|
||||
* @param m the line content */
|
||||
void appendLine(String m);
|
||||
|
||||
}
|
||||
@@ -0,0 +1,97 @@
|
||||
/**
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.swt;
|
||||
|
||||
/*-
|
||||
* #%L
|
||||
* GCLC swt
|
||||
* %%
|
||||
* Copyright (C) 2015 - 2018 Bigeon
|
||||
* %%
|
||||
* This software is governed by the CeCILL license under French law and
|
||||
* abiding by the rules of distribution of free software. You can use,
|
||||
* modify and/ or redistribute the software under the terms of the CeCILL
|
||||
* license as circulated by CEA, CNRS and INRIA at the following URL
|
||||
* "http://www.cecill.info".
|
||||
*
|
||||
* As a counterpart to the access to the source code and rights to copy,
|
||||
* modify and redistribute granted by the license, users are provided only
|
||||
* with a limited warranty and the software's author, the holder of the
|
||||
* economic rights, and the successive licensors have only limited
|
||||
* liability.
|
||||
*
|
||||
* In this respect, the user's attention is drawn to the risks associated
|
||||
* with loading, using, modifying and/or developing or reproducing the
|
||||
* software by the user in light of its specific status of free software,
|
||||
* that may mean that it is complicated to manipulate, and that also
|
||||
* therefore means that it is reserved for developers and experienced
|
||||
* professionals having in-depth computer knowledge. Users are therefore
|
||||
* encouraged to load and test the software's suitability as regards their
|
||||
* requirements in conditions enabling the security of their systems and/or
|
||||
* data to be ensured and, more generally, to use and operate it in the
|
||||
* same conditions as regards security.
|
||||
*
|
||||
* The fact that you are presently reading this means that you have had
|
||||
* knowledge of the CeCILL license and that you accept its terms.
|
||||
* #L%
|
||||
*/
|
||||
|
||||
import org.eclipse.swt.widgets.Text;
|
||||
|
||||
import net.bigeon.gclc.manager.PipedConsoleOutput;
|
||||
import net.bigeon.gclc.swt.tools.ToSWTConsoleForwardRunnable;
|
||||
|
||||
/** The manager for console output to insert in a text.
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
public final class ConsoleOutputManager implements ConsoleOutputDisplay {
|
||||
/** The SWT component displaying the output content. */
|
||||
private final Text text;
|
||||
/** The forwarding runnable. */
|
||||
private ToSWTConsoleForwardRunnable forward;
|
||||
/** The forwarding thread. */
|
||||
private Thread forwardThread;
|
||||
|
||||
/** Create the manager.
|
||||
*
|
||||
* @param text the text to display the output in. */
|
||||
public ConsoleOutputManager(final Text text) {
|
||||
super();
|
||||
this.text = text;
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.swt.ConsoleOutputDisplay#appendLine(java.lang.String) */
|
||||
@Override
|
||||
public void appendLine(final String next) {
|
||||
text.getDisplay().syncExec(new TextAppendingRunnable(text, next));
|
||||
}
|
||||
|
||||
/** Set the output.
|
||||
*
|
||||
* @param output the output to set */
|
||||
public void setManager(final PipedConsoleOutput output) {
|
||||
if (forward != null) {
|
||||
if (forward.getOuput() == output) {
|
||||
return;
|
||||
}
|
||||
forward.setRunning(false);
|
||||
}
|
||||
if (output == null) {
|
||||
forward = null;
|
||||
forwardThread = null;
|
||||
return;
|
||||
}
|
||||
forward = new ToSWTConsoleForwardRunnable(output, this, text);
|
||||
forwardThread = new Thread(forward, "gclcToSWT"); //$NON-NLS-1$
|
||||
forwardThread.start();
|
||||
}
|
||||
|
||||
/** Get the current thread forwarding the console output to the SWT components.
|
||||
*
|
||||
* @return the forwardThread */
|
||||
public Thread getForwardThread() {
|
||||
return forwardThread;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,93 @@
|
||||
/**
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.swt;
|
||||
|
||||
/*-
|
||||
* #%L
|
||||
* GCLC swt
|
||||
* %%
|
||||
* Copyright (C) 2015 - 2018 Bigeon
|
||||
* %%
|
||||
* This software is governed by the CeCILL license under French law and
|
||||
* abiding by the rules of distribution of free software. You can use,
|
||||
* modify and/ or redistribute the software under the terms of the CeCILL
|
||||
* license as circulated by CEA, CNRS and INRIA at the following URL
|
||||
* "http://www.cecill.info".
|
||||
*
|
||||
* As a counterpart to the access to the source code and rights to copy,
|
||||
* modify and redistribute granted by the license, users are provided only
|
||||
* with a limited warranty and the software's author, the holder of the
|
||||
* economic rights, and the successive licensors have only limited
|
||||
* liability.
|
||||
*
|
||||
* In this respect, the user's attention is drawn to the risks associated
|
||||
* with loading, using, modifying and/or developing or reproducing the
|
||||
* software by the user in light of its specific status of free software,
|
||||
* that may mean that it is complicated to manipulate, and that also
|
||||
* therefore means that it is reserved for developers and experienced
|
||||
* professionals having in-depth computer knowledge. Users are therefore
|
||||
* encouraged to load and test the software's suitability as regards their
|
||||
* requirements in conditions enabling the security of their systems and/or
|
||||
* data to be ensured and, more generally, to use and operate it in the
|
||||
* same conditions as regards security.
|
||||
*
|
||||
* The fact that you are presently reading this means that you have had
|
||||
* knowledge of the CeCILL license and that you accept its terms.
|
||||
* #L%
|
||||
*/
|
||||
|
||||
import java.io.BufferedReader;
|
||||
|
||||
import org.eclipse.swt.widgets.Label;
|
||||
|
||||
import net.bigeon.gclc.swt.tools.PromptReadingRunnable;
|
||||
|
||||
/** The manager for the console prompt updates.
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
public final class ConsolePromptManager {
|
||||
|
||||
/** The label to set the prompts at. */
|
||||
private final Label label;
|
||||
|
||||
/** The current prompt reading runnable. */
|
||||
private PromptReadingRunnable promptRead;
|
||||
|
||||
/** Create the manager.
|
||||
*
|
||||
* @param label the label to update with prompts */
|
||||
public ConsolePromptManager(final Label label) {
|
||||
super();
|
||||
this.label = label;
|
||||
}
|
||||
|
||||
/** Set the prompt.
|
||||
* <p>
|
||||
* This method sets the prompt on the label as requested, without changing the
|
||||
* actual prompt of the console input.
|
||||
*
|
||||
* @param string the text */
|
||||
public void setPrompt(final String string) {
|
||||
label.setText(string);
|
||||
}
|
||||
|
||||
/** Set the input to control.
|
||||
*
|
||||
* @param promptStream the input */
|
||||
public void setStream(final BufferedReader promptStream) {
|
||||
if (promptRead != null) {
|
||||
if (promptRead.getReader() == promptStream) {
|
||||
return;
|
||||
}
|
||||
promptRead.setRunning(false);
|
||||
}
|
||||
if (promptStream == null) {
|
||||
promptRead = null;
|
||||
return;
|
||||
}
|
||||
promptRead = new PromptReadingRunnable(promptStream, label);
|
||||
final Thread th = new Thread(promptRead, "Prompt To Label");
|
||||
th.start();
|
||||
}
|
||||
}
|
||||
@@ -35,6 +35,10 @@
|
||||
*/
|
||||
package net.bigeon.gclc.swt;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.util.logging.Level;
|
||||
import java.util.logging.Logger;
|
||||
|
||||
/*-
|
||||
* #%L
|
||||
* GCLC swt
|
||||
@@ -72,8 +76,8 @@ import org.eclipse.swt.SWT;
|
||||
import org.eclipse.swt.events.KeyAdapter;
|
||||
import org.eclipse.swt.events.KeyEvent;
|
||||
|
||||
import net.bigeon.collections.ArrayRibbon;
|
||||
import net.bigeon.collections.Ribbon;
|
||||
import net.bigeon.collections.ribbon.ArrayRibbon;
|
||||
|
||||
/** A key listener to validate commands and manage the history of commands.
|
||||
*
|
||||
@@ -81,13 +85,15 @@ import net.bigeon.collections.Ribbon;
|
||||
public final class HistoryTextKeyListener extends KeyAdapter {
|
||||
|
||||
/** The size of commands history. */
|
||||
private static final int DEFAULT_HISTORY_SIZE = 10;
|
||||
private static final int DEFAULT_HISTORY_SIZE = 10;
|
||||
/** The empty string constant. */
|
||||
private static final String EMPTY = ""; //$NON-NLS-1$
|
||||
private static final String EMPTY = ""; //$NON-NLS-1$
|
||||
private static final Logger LOGGER = Logger
|
||||
.getLogger(HistoryTextKeyListener.class.getName());
|
||||
/** The history ribbon. */
|
||||
private final Ribbon<String> commands;
|
||||
/** The current index in history search. */
|
||||
private int currentIndex = 0;
|
||||
private int currentIndex = 0;
|
||||
/** The console to notify of command validation. */
|
||||
private final ConsoleDelayIO console;
|
||||
|
||||
@@ -118,13 +124,16 @@ public final class HistoryTextKeyListener extends KeyAdapter {
|
||||
if (!input.isEmpty()) {
|
||||
commands.add(input);
|
||||
}
|
||||
console.validateInput();
|
||||
try {
|
||||
console.validateInput();
|
||||
} catch (final IOException e) {
|
||||
LOGGER.log(Level.SEVERE, "Unable to write to console", e);
|
||||
}
|
||||
currentIndex = -1;
|
||||
}
|
||||
|
||||
// Upper arrow retrieves previous commands
|
||||
if (keyCode == SWT.ARROW_UP &&
|
||||
currentIndex < commands.size() - 1) {
|
||||
if (keyCode == SWT.ARROW_UP && currentIndex < commands.size() - 1) {
|
||||
currentIndex++;
|
||||
final String cmd = commands.get(commands.size() - currentIndex - 1);
|
||||
console.setInput(cmd);
|
||||
@@ -132,12 +141,14 @@ public final class HistoryTextKeyListener extends KeyAdapter {
|
||||
|
||||
// Lower arrow retrieves next commands
|
||||
if (keyCode == SWT.ARROW_DOWN) {
|
||||
if (currentIndex == 0) {
|
||||
if (currentIndex <= 0) {
|
||||
if (currentIndex == 0) {
|
||||
console.setInput(EMPTY);
|
||||
}
|
||||
currentIndex = -1;
|
||||
} else {
|
||||
currentIndex--;
|
||||
console.setInput(EMPTY);
|
||||
} else if (currentIndex > 0) {
|
||||
final String cmd = commands
|
||||
.get(commands.size() - (--currentIndex) - 1);
|
||||
final String cmd = commands.get(commands.size() - currentIndex - 1);
|
||||
console.setInput(cmd);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -30,11 +30,13 @@
|
||||
* knowledge of the CeCILL license and that you accept its terms.
|
||||
*/
|
||||
/**
|
||||
* gclc-swt:net.bigeon.gclc.swt.SWTConsole.java
|
||||
* gclc-swt:net.bigeon.gclc.swt.SWTConsoleShell.java
|
||||
* Created on: Apr 18, 2015
|
||||
*/
|
||||
package net.bigeon.gclc.swt;
|
||||
|
||||
import java.io.BufferedReader;
|
||||
|
||||
/*-
|
||||
* #%L
|
||||
* GCLC swt
|
||||
@@ -68,402 +70,75 @@ package net.bigeon.gclc.swt;
|
||||
* knowledge of the CeCILL license and that you accept its terms.
|
||||
* #L%
|
||||
*/
|
||||
import java.io.IOException;
|
||||
import java.util.logging.Level;
|
||||
import java.util.logging.Logger;
|
||||
|
||||
import org.eclipse.swt.SWT;
|
||||
import org.eclipse.swt.layout.GridData;
|
||||
import org.eclipse.swt.layout.GridLayout;
|
||||
import org.eclipse.swt.widgets.Composite;
|
||||
import org.eclipse.swt.widgets.Display;
|
||||
import org.eclipse.swt.widgets.Label;
|
||||
import org.eclipse.swt.widgets.Text;
|
||||
|
||||
import net.bigeon.gclc.ConsoleApplication;
|
||||
import net.bigeon.gclc.manager.ConsoleInput;
|
||||
import net.bigeon.gclc.manager.ConsoleOutput;
|
||||
import net.bigeon.gclc.tools.ConstantString;
|
||||
import net.bigeon.gclc.tools.StringProvider;
|
||||
import net.bigeon.gclc.manager.PipedConsoleInput;
|
||||
import net.bigeon.gclc.manager.PipedConsoleOutput;
|
||||
|
||||
/** A SWT component to connect to gclc {@link ConsoleApplication}.
|
||||
/** A shell containing a {@link SWTConsoleView}
|
||||
* <p>
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
public final class SWTConsole extends Composite
|
||||
implements ConsoleDelayIO, ConsoleInput, ConsoleOutput {
|
||||
/** The number of columns of the layout. */
|
||||
private static final int LAYOUT_NB_COLUMNS = 2;
|
||||
/** The cmd prefix in the output console. */
|
||||
private static final String CMD_PREFIX = "[CMD] "; //$NON-NLS-1$
|
||||
/** The class logger. */
|
||||
private static final Logger LOGGER = Logger
|
||||
.getLogger(SWTConsole.class.getName());
|
||||
/** The empty string constant. */
|
||||
private static final String EMPTY = ""; //$NON-NLS-1$
|
||||
/** The console output text field. */
|
||||
private final Text consoleOutput;
|
||||
/** The console input text field. */
|
||||
private final Text consoleInput;
|
||||
/** The prompt label. */
|
||||
private final Label lblPromptlabel;
|
||||
/** The prompt text. */
|
||||
private StringProvider prompt = new ConstantString("> "); //$NON-NLS-1$
|
||||
/** The command entered by the user. */
|
||||
private String command = null;
|
||||
/** If the prompt should be active. */
|
||||
private boolean prompting = false;
|
||||
/** The object for thread synchronization with the prompt. */
|
||||
private final Object promptLock = new Object();
|
||||
public final class SWTConsole extends Composite {
|
||||
|
||||
/** Create the composite.
|
||||
private ConsoleInputManager inputManager;
|
||||
private ConsoleOutputManager outputManager;
|
||||
private ConsolePromptManager promptManager;
|
||||
|
||||
/** Create the shell.
|
||||
*
|
||||
* @param parent the prent composite
|
||||
* @param style the composite style */
|
||||
* @param parent the containing composite
|
||||
* @param style the shell style */
|
||||
public SWTConsole(final Composite parent, final int style) {
|
||||
super(parent, style);
|
||||
|
||||
setLayout(new GridLayout(LAYOUT_NB_COLUMNS, false));
|
||||
|
||||
consoleOutput = new Text(this,
|
||||
SWT.BORDER | SWT.READ_ONLY | SWT.WRAP | SWT.V_SCROLL | SWT.MULTI);
|
||||
consoleOutput.setLayoutData(
|
||||
new GridData(SWT.FILL, SWT.FILL, true, true, LAYOUT_NB_COLUMNS, 1));
|
||||
consoleOutput.setRedraw(true);
|
||||
|
||||
lblPromptlabel = new Label(this, SWT.NONE);
|
||||
lblPromptlabel.setText(prompt.apply());
|
||||
|
||||
consoleInput = new Text(this, SWT.BORDER);
|
||||
consoleInput.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false, 1, 1));
|
||||
consoleInput.addKeyListener(new HistoryTextKeyListener(this));
|
||||
|
||||
setLayout(new GridLayout(2, false));
|
||||
createContents();
|
||||
}
|
||||
|
||||
@Override
|
||||
protected void checkSubclass() {
|
||||
// Disable the check that prevents subclassing of SWT components
|
||||
/** Create contents of the shell. */
|
||||
private void createContents() {
|
||||
final Text output = new Text(this,
|
||||
SWT.WRAP | SWT.READ_ONLY | SWT.MULTI | SWT.V_SCROLL);
|
||||
output.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true, 2, 1));
|
||||
final Label prompt = new Label(this, SWT.NONE);
|
||||
prompt.setLayoutData(new GridData(SWT.LEFT, SWT.CENTER, false, false));
|
||||
final Text input = new Text(this, SWT.NONE);
|
||||
input.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false));
|
||||
|
||||
inputManager = new ConsoleInputManager(input);
|
||||
outputManager = new ConsoleOutputManager(output);
|
||||
promptManager = new ConsolePromptManager(prompt);
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.manager.ConsoleManager#close() */
|
||||
@Override
|
||||
public void close() {
|
||||
synchronized (promptLock) {
|
||||
prompting = false;
|
||||
promptLock.notifyAll();
|
||||
}
|
||||
if (consoleInput.isDisposed()) {
|
||||
return;
|
||||
}
|
||||
consoleInput.setEnabled(false);
|
||||
consoleOutput.setEnabled(false);
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.swt.ConsoleDelayIO#getInput() */
|
||||
@Override
|
||||
public String getInput() {
|
||||
return consoleInput.getText();
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.ConsoleManager#getPrompt() */
|
||||
@Override
|
||||
public StringProvider getPrompt() {
|
||||
return prompt;
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.manager.ConsoleManager#interruptPrompt() */
|
||||
@Override
|
||||
public void interruptPrompt() {
|
||||
synchronized (promptLock) {
|
||||
promptLock.notifyAll();
|
||||
}
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.manager.ConsoleManager#isClosed() */
|
||||
@Override
|
||||
public boolean isClosed() {
|
||||
return isDisposed();
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.ConsoleManager#print(java.lang.String) */
|
||||
@Override
|
||||
public void print(final String text) throws IOException {
|
||||
if (isDisposed()) {
|
||||
throw new IOException();
|
||||
}
|
||||
Display.getDefault().syncExec(new Runnable() {
|
||||
@SuppressWarnings("synthetic-access")
|
||||
@Override
|
||||
public void run() {
|
||||
if (!consoleOutput.isDisposed()) {
|
||||
consoleOutput.append(text);
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.ConsoleManager#println() */
|
||||
@Override
|
||||
public void println() throws IOException {
|
||||
if (isDisposed()) {
|
||||
throw new IOException();
|
||||
}
|
||||
Display.getDefault().syncExec(new Runnable() {
|
||||
@SuppressWarnings("synthetic-access")
|
||||
@Override
|
||||
public void run() {
|
||||
if (!consoleOutput.isDisposed()) {
|
||||
consoleOutput.append(System.lineSeparator());
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.ConsoleManager#println(java.lang.String) */
|
||||
@Override
|
||||
public void println(final String message) throws IOException {
|
||||
if (isDisposed()) {
|
||||
throw new IOException();
|
||||
}
|
||||
Display.getDefault().syncExec(new Runnable() {
|
||||
@SuppressWarnings("synthetic-access")
|
||||
@Override
|
||||
public void run() {
|
||||
if (!consoleOutput.isDisposed()) {
|
||||
consoleOutput.append(message + System.lineSeparator());
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.ConsoleManager#prompt() */
|
||||
@Override
|
||||
public String prompt() throws IOException {
|
||||
synchronized (promptLock) {
|
||||
if (isDisposed()) {
|
||||
throw new IOException();
|
||||
}
|
||||
try {
|
||||
Display.getDefault().syncExec(new Runnable() {
|
||||
@Override
|
||||
public void run() {
|
||||
if (!consoleInput.isDisposed()) {
|
||||
consoleInput.setEnabled(true);
|
||||
lblPromptlabel.setText(prompt.apply());
|
||||
// relayout
|
||||
SWTConsole.this.layout();
|
||||
consoleInput.setFocus();
|
||||
}
|
||||
}
|
||||
});
|
||||
prompting = true;
|
||||
promptLock.notifyAll();
|
||||
while (prompting) {
|
||||
promptLock.wait();
|
||||
}
|
||||
} catch (final InterruptedException e) {
|
||||
LOGGER.log(Level.WARNING, "Error in synchronization of prompting", e); //$NON-NLS-1$
|
||||
command = null;
|
||||
Thread.currentThread().interrupt();
|
||||
}
|
||||
}
|
||||
if (isDisposed()) {
|
||||
throw new IOException("Input closed"); //$NON-NLS-1$
|
||||
}
|
||||
return command;
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(long) */
|
||||
@Override
|
||||
public String prompt(final long timeout) throws IOException {
|
||||
synchronized (promptLock) {
|
||||
if (isDisposed()) {
|
||||
throw new IOException();
|
||||
}
|
||||
try {
|
||||
Display.getDefault().syncExec(new Runnable() {
|
||||
@Override
|
||||
public void run() {
|
||||
if (!consoleInput.isDisposed()) {
|
||||
consoleInput.setEnabled(true);
|
||||
lblPromptlabel.setText(prompt.apply());
|
||||
// relayout
|
||||
SWTConsole.this.layout();
|
||||
consoleInput.setFocus();
|
||||
}
|
||||
}
|
||||
});
|
||||
prompting = true;
|
||||
command = null;
|
||||
promptLock.notifyAll();
|
||||
final long start = System.currentTimeMillis();
|
||||
long cur = start;
|
||||
while (prompting && start + timeout>cur) {
|
||||
promptLock.wait((cur-start-timeout)/2);
|
||||
cur = System.currentTimeMillis();
|
||||
}
|
||||
} catch (final InterruptedException e) {
|
||||
LOGGER.log(Level.WARNING, "Error in synchronization of prompting", e); //$NON-NLS-1$
|
||||
command = null;
|
||||
Thread.currentThread().interrupt();
|
||||
}
|
||||
}
|
||||
if (isDisposed()) {
|
||||
throw new IOException("Input closed"); //$NON-NLS-1$
|
||||
}
|
||||
return command;
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.ConsoleManager#prompt(java.lang.String) */
|
||||
@Override
|
||||
public String prompt(final String message) throws IOException {
|
||||
synchronized (promptLock) {
|
||||
if (isDisposed()) {
|
||||
throw new IOException();
|
||||
}
|
||||
try {
|
||||
Display.getDefault().syncExec(new Runnable() {
|
||||
@SuppressWarnings("synthetic-access")
|
||||
@Override
|
||||
public void run() {
|
||||
if (!consoleOutput.isDisposed()) {
|
||||
lblPromptlabel.setText(message);
|
||||
// relayout
|
||||
SWTConsole.this.layout();
|
||||
consoleInput.setEnabled(true);
|
||||
consoleInput.setFocus();
|
||||
}
|
||||
}
|
||||
});
|
||||
prompting = true;
|
||||
promptLock.wait();
|
||||
if (isDisposed()) {
|
||||
throw new IOException();
|
||||
}
|
||||
} catch (final InterruptedException e) {
|
||||
LOGGER.log(Level.WARNING, "Error in synchronization of prompting", e); //$NON-NLS-1$
|
||||
command = null;
|
||||
Thread.currentThread().interrupt();
|
||||
} finally {
|
||||
Display.getDefault().syncExec(new Runnable() {
|
||||
@SuppressWarnings("synthetic-access")
|
||||
@Override
|
||||
public void run() {
|
||||
if (!consoleOutput.isDisposed()) {
|
||||
lblPromptlabel.setText(prompt.apply());
|
||||
// relayout
|
||||
SWTConsole.this.layout();
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
return command;
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String, long) */
|
||||
@Override
|
||||
public String prompt(final String message, final long timeout) throws IOException {
|
||||
// TODO Auto-generated method stub
|
||||
// return null;
|
||||
throw new RuntimeException("Not implemented yet");
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see org.eclipse.swt.widgets.Composite#setFocus() */
|
||||
@Override
|
||||
public boolean setFocus() {
|
||||
return consoleInput.setFocus();
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.swt.ConsoleDelayIO#setInput(java.lang.String) */
|
||||
@Override
|
||||
public void setInput(final String input) {
|
||||
consoleInput.setText(input);
|
||||
consoleInput.setSelection(input.length());
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.ConsoleManager#setPrompt(java.lang.String) */
|
||||
@Override
|
||||
public void setPrompt(final StringProvider prompt) {
|
||||
this.prompt = prompt;
|
||||
Display.getDefault().syncExec(new Runnable() {
|
||||
@SuppressWarnings("synthetic-access")
|
||||
@Override
|
||||
public void run() {
|
||||
if (!consoleOutput.isDisposed()) {
|
||||
lblPromptlabel.setText(prompt.apply());
|
||||
// relayout
|
||||
SWTConsole.this.layout();
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
@Override
|
||||
public void setPrompt(String prompt) {
|
||||
setPrompt(new ConstantString(prompt));
|
||||
}
|
||||
|
||||
/** @param string the text */
|
||||
public void setText(final String string) {
|
||||
consoleInput.setText(string);
|
||||
}
|
||||
|
||||
/**
|
||||
/** Connect the console parts to the shell.
|
||||
*
|
||||
*/
|
||||
public void validateCommand() {
|
||||
validateInput();
|
||||
* @param input the input
|
||||
* @param output the output
|
||||
* @param promptStream the stream where the prompts are forwarded. */
|
||||
public void connect(final PipedConsoleInput input, final PipedConsoleOutput output,
|
||||
final BufferedReader promptStream) {
|
||||
inputManager.setManager(input);
|
||||
outputManager.setManager(output);
|
||||
promptManager.setStream(promptStream);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
*/
|
||||
@Override
|
||||
public void validateInput() {
|
||||
Display.getDefault().syncExec(new Runnable() {
|
||||
@SuppressWarnings("synthetic-access")
|
||||
@Override
|
||||
public void run() {
|
||||
consoleInput.setEnabled(false);
|
||||
}
|
||||
});
|
||||
synchronized (promptLock) {
|
||||
while (!prompting) {
|
||||
try {
|
||||
promptLock.wait();
|
||||
} catch (final InterruptedException e) {
|
||||
LOGGER.log(Level.SEVERE, "Interruption while waiting prompt", e); //$NON-NLS-1$
|
||||
}
|
||||
}
|
||||
Display.getDefault().syncExec(new Runnable() {
|
||||
@SuppressWarnings("synthetic-access")
|
||||
@Override
|
||||
public void run() {
|
||||
command = consoleInput.getText();
|
||||
prompting = false;
|
||||
consoleInput.setText(EMPTY);
|
||||
consoleOutput.append(CMD_PREFIX + command + System.lineSeparator());
|
||||
}
|
||||
});
|
||||
promptLock.notifyAll();
|
||||
}
|
||||
/** @return the inputManager */
|
||||
public ConsoleInputManager getInputManager() {
|
||||
return inputManager;
|
||||
}
|
||||
|
||||
/** @return the outputManager */
|
||||
public ConsoleOutputManager getOutputManager() {
|
||||
return outputManager;
|
||||
}
|
||||
|
||||
/** @return the promptManager */
|
||||
public ConsolePromptManager getPromptManager() {
|
||||
return promptManager;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -68,67 +68,25 @@ package net.bigeon.gclc.swt;
|
||||
* knowledge of the CeCILL license and that you accept its terms.
|
||||
* #L%
|
||||
*/
|
||||
import java.io.IOException;
|
||||
import java.util.logging.Level;
|
||||
import java.util.logging.Logger;
|
||||
|
||||
import org.eclipse.swt.SWT;
|
||||
import org.eclipse.swt.layout.GridData;
|
||||
import org.eclipse.swt.layout.GridLayout;
|
||||
import org.eclipse.swt.widgets.Composite;
|
||||
import org.eclipse.swt.widgets.Display;
|
||||
import org.eclipse.swt.widgets.Text;
|
||||
|
||||
import net.bigeon.gclc.ConsoleApplication;
|
||||
import net.bigeon.gclc.utils.AOutputForwardRunnable;
|
||||
import net.bigeon.gclc.utils.PipedConsoleInput;
|
||||
import net.bigeon.gclc.utils.PipedConsoleOutput;
|
||||
import net.bigeon.gclc.manager.PipedConsoleInput;
|
||||
import net.bigeon.gclc.manager.PipedConsoleOutput;
|
||||
|
||||
/** A SWT component to connect to gclc {@link ConsoleApplication}
|
||||
* <p>
|
||||
/** A SWT component to connect to gclc {@link ConsoleApplication}.
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
public final class SWTConsoleView extends Composite implements ConsoleDelayIO {
|
||||
/** The local implementation of the forwarding runnable
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
private final class ToSWTConsoleForwardRunnable
|
||||
extends AOutputForwardRunnable {
|
||||
/** The running status */
|
||||
private boolean running = true;
|
||||
|
||||
/** @param manager the manager */
|
||||
public ToSWTConsoleForwardRunnable(final PipedConsoleOutput manager) {
|
||||
super(manager);
|
||||
}
|
||||
|
||||
@Override
|
||||
protected void forwardLine(final String m) {
|
||||
appendConsoleOutput(m);
|
||||
}
|
||||
|
||||
@Override
|
||||
protected boolean isRunning() {
|
||||
return running && !isDisposed();
|
||||
}
|
||||
|
||||
/** @param running the running to set */
|
||||
public void setRunning(final boolean running) {
|
||||
this.running = running;
|
||||
}
|
||||
}
|
||||
|
||||
/** The class logger */
|
||||
private static final Logger LOGGER = Logger
|
||||
.getLogger(SWTConsoleView.class.getName());
|
||||
/** The console output text field */
|
||||
private final Text consoleOutput;
|
||||
/** The console input text field */
|
||||
private final Text consoleInput;
|
||||
/** The input. */
|
||||
private PipedConsoleInput input;
|
||||
/** The forwarding runnable */
|
||||
private ToSWTConsoleForwardRunnable forward;
|
||||
public final class SWTConsoleView extends Composite {
|
||||
/** The input manager. */
|
||||
private final ConsoleInputManager inManager;
|
||||
/** The output manager. */
|
||||
private final ConsoleOutputManager outManager;
|
||||
|
||||
/** Create the composite.
|
||||
*
|
||||
@@ -139,54 +97,23 @@ public final class SWTConsoleView extends Composite implements ConsoleDelayIO {
|
||||
|
||||
setLayout(new GridLayout(1, false));
|
||||
|
||||
consoleOutput = new Text(this, SWT.BORDER | SWT.READ_ONLY | SWT.WRAP |
|
||||
SWT.V_SCROLL | SWT.MULTI);
|
||||
consoleOutput.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true,
|
||||
1, 1));
|
||||
final Text consoleOutput = new Text(this,
|
||||
SWT.BORDER | SWT.READ_ONLY | SWT.WRAP | SWT.V_SCROLL | SWT.MULTI);
|
||||
consoleOutput.setLayoutData(new GridData(SWT.FILL, SWT.FILL, true, true, 1, 1));
|
||||
consoleOutput.setRedraw(true);
|
||||
outManager = new ConsoleOutputManager(consoleOutput);
|
||||
|
||||
consoleInput = new Text(this, SWT.BORDER);
|
||||
consoleInput.setLayoutData(
|
||||
new GridData(SWT.FILL, SWT.CENTER, true, false, 1, 1));
|
||||
consoleInput.addKeyListener(new HistoryTextKeyListener(this));
|
||||
}
|
||||
|
||||
/** @param next the next message */
|
||||
protected void appendConsoleOutput(final String next) {
|
||||
Display.getDefault().syncExec(new Runnable() {
|
||||
@SuppressWarnings("synthetic-access")
|
||||
@Override
|
||||
public void run() {
|
||||
consoleOutput.append(System.lineSeparator() + next);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
@Override
|
||||
protected void checkSubclass() {
|
||||
// Disable the check that prevents subclassing of SWT components
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.swt.ConsoleDelayIO#getInput() */
|
||||
@Override
|
||||
public String getInput() {
|
||||
return consoleInput.getText();
|
||||
final Text consoleInput = new Text(this, SWT.BORDER);
|
||||
consoleInput.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false, 1, 1));
|
||||
inManager = new ConsoleInputManager(consoleInput);
|
||||
consoleInput.addKeyListener(new HistoryTextKeyListener(inManager));
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see org.eclipse.swt.widgets.Composite#setFocus() */
|
||||
@Override
|
||||
public boolean setFocus() {
|
||||
return consoleInput.setFocus();
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.swt.ConsoleDelayIO#setInput(java.lang.String) */
|
||||
@Override
|
||||
public void setInput(final String input) {
|
||||
consoleInput.setText(input);
|
||||
consoleInput.setSelection(input.length());
|
||||
return inManager.getText().setFocus();
|
||||
}
|
||||
|
||||
/** Set the input and output.
|
||||
@@ -194,30 +121,22 @@ public final class SWTConsoleView extends Composite implements ConsoleDelayIO {
|
||||
* @param manager the output to set
|
||||
* @param input the input */
|
||||
public void setManager(final PipedConsoleOutput manager,
|
||||
final PipedConsoleInput input) {
|
||||
this.input = input;
|
||||
if (forward != null) {
|
||||
forward.setRunning(false);
|
||||
}
|
||||
forward = new ToSWTConsoleForwardRunnable(manager);
|
||||
final Thread th = new Thread(forward, "gclcToSWT"); //$NON-NLS-1$
|
||||
th.start();
|
||||
final PipedConsoleInput input) {
|
||||
outManager.setManager(manager);
|
||||
inManager.setManager(input);
|
||||
}
|
||||
|
||||
/** @param string the text */
|
||||
public void setText(final String string) {
|
||||
consoleInput.setText(string);
|
||||
}
|
||||
|
||||
/**
|
||||
/** Get the manager of console input.
|
||||
*
|
||||
*/
|
||||
@Override
|
||||
public void validateInput() {
|
||||
try {
|
||||
input.type(getInput());
|
||||
} catch (final IOException e) {
|
||||
LOGGER.log(Level.SEVERE, "Unable to input value to console", e); //$NON-NLS-1$
|
||||
}
|
||||
* @return the input manager */
|
||||
public ConsoleInputManager getInputManager() {
|
||||
return inManager;
|
||||
}
|
||||
|
||||
/** Get the manager of console output.
|
||||
*
|
||||
* @return the output manager */
|
||||
public ConsoleOutputManager getOutputManager() {
|
||||
return outManager;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,36 @@
|
||||
/**
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.swt;
|
||||
|
||||
import org.eclipse.swt.widgets.Text;
|
||||
|
||||
/** A runnable appending text to the content of a {@link Text} component.
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
public class TextAppendingRunnable implements Runnable {
|
||||
/** The text to append on a line (possibly new). */
|
||||
private final String next;
|
||||
/** The {@link Text} component. */
|
||||
private final Text text;
|
||||
|
||||
/** Create the appending runnable.
|
||||
*
|
||||
* @param text the component to update
|
||||
* @param next the text to append */
|
||||
public TextAppendingRunnable(final Text text, final String next) {
|
||||
this.text = text;
|
||||
this.next = next;
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see java.lang.Runnable#run() */
|
||||
@Override
|
||||
public void run() {
|
||||
final String initialText = text.getText();
|
||||
if (initialText != null && !initialText.isEmpty()) {
|
||||
text.append(System.lineSeparator());
|
||||
}
|
||||
text.append(next);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,134 @@
|
||||
/**
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.swt.tools;
|
||||
|
||||
/*-
|
||||
* #%L
|
||||
* GCLC swt
|
||||
* %%
|
||||
* Copyright (C) 2015 - 2018 Bigeon
|
||||
* %%
|
||||
* This software is governed by the CeCILL license under French law and
|
||||
* abiding by the rules of distribution of free software. You can use,
|
||||
* modify and/ or redistribute the software under the terms of the CeCILL
|
||||
* license as circulated by CEA, CNRS and INRIA at the following URL
|
||||
* "http://www.cecill.info".
|
||||
*
|
||||
* As a counterpart to the access to the source code and rights to copy,
|
||||
* modify and redistribute granted by the license, users are provided only
|
||||
* with a limited warranty and the software's author, the holder of the
|
||||
* economic rights, and the successive licensors have only limited
|
||||
* liability.
|
||||
*
|
||||
* In this respect, the user's attention is drawn to the risks associated
|
||||
* with loading, using, modifying and/or developing or reproducing the
|
||||
* software by the user in light of its specific status of free software,
|
||||
* that may mean that it is complicated to manipulate, and that also
|
||||
* therefore means that it is reserved for developers and experienced
|
||||
* professionals having in-depth computer knowledge. Users are therefore
|
||||
* encouraged to load and test the software's suitability as regards their
|
||||
* requirements in conditions enabling the security of their systems and/or
|
||||
* data to be ensured and, more generally, to use and operate it in the
|
||||
* same conditions as regards security.
|
||||
*
|
||||
* The fact that you are presently reading this means that you have had
|
||||
* knowledge of the CeCILL license and that you accept its terms.
|
||||
* #L%
|
||||
*/
|
||||
|
||||
import java.io.BufferedReader;
|
||||
import java.io.IOException;
|
||||
import java.util.logging.Level;
|
||||
import java.util.logging.Logger;
|
||||
|
||||
import org.eclipse.swt.widgets.Label;
|
||||
|
||||
/** The runnable forwarding prompts from a buffered input to a label.
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
public class PromptReadingRunnable implements Runnable {
|
||||
|
||||
/** The logger for this class. */
|
||||
private static final Logger LOGGER = Logger
|
||||
.getLogger(PromptReadingRunnable.class.getName());
|
||||
|
||||
/** The reader providing the succession of prompts */
|
||||
private final BufferedReader reader;
|
||||
/** The label. */
|
||||
private final Label view;
|
||||
/** The running status. */
|
||||
private boolean running = true;
|
||||
|
||||
/** The updating runnable implementation.
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
private static class LabelUpdater implements Runnable {
|
||||
/** The label to update. */
|
||||
private final Label label;
|
||||
/** The text to set. */
|
||||
private final String content;
|
||||
|
||||
/** Create the updating runnable.
|
||||
*
|
||||
* @param label the label
|
||||
* @param content the content */
|
||||
public LabelUpdater(final Label label, final String content) {
|
||||
super();
|
||||
this.label = label;
|
||||
this.content = content;
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see java.lang.Runnable#run() */
|
||||
@Override
|
||||
public void run() {
|
||||
label.setText(content);
|
||||
}
|
||||
}
|
||||
|
||||
/** Create the prompt flow updating runnable.
|
||||
*
|
||||
* @param reader the reader
|
||||
* @param view the view to update on lines. */
|
||||
public PromptReadingRunnable(final BufferedReader reader, final Label view) {
|
||||
super();
|
||||
this.reader = reader;
|
||||
this.view = view;
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see java.lang.Runnable#run() */
|
||||
@Override
|
||||
public void run() {
|
||||
String prompt;
|
||||
try {
|
||||
while (isRunning() && (prompt = reader.readLine()) != null) {
|
||||
view.getDisplay().syncExec(new LabelUpdater(view, prompt));
|
||||
}
|
||||
} catch (final IOException e) {
|
||||
LOGGER.log(Level.INFO, "Prompt cannot be read, or was prematuraly closed", e);
|
||||
}
|
||||
}
|
||||
|
||||
/** Get the running state.
|
||||
*
|
||||
* @return the running */
|
||||
public synchronized boolean isRunning() {
|
||||
return running;
|
||||
}
|
||||
|
||||
/** Set the running state.
|
||||
*
|
||||
* @param running the running to set */
|
||||
public synchronized void setRunning(final boolean running) {
|
||||
this.running = running;
|
||||
}
|
||||
|
||||
/** Get the prompt flow.
|
||||
*
|
||||
* @return the reader */
|
||||
public BufferedReader getReader() {
|
||||
return reader;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,68 @@
|
||||
/**
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.swt.tools;
|
||||
|
||||
import org.eclipse.swt.widgets.Widget;
|
||||
|
||||
import net.bigeon.gclc.manager.PipedConsoleOutput;
|
||||
import net.bigeon.gclc.manager.forwarding.AOutputForwardRunnable;
|
||||
import net.bigeon.gclc.swt.ConsoleOutputDisplay;
|
||||
|
||||
/** The local implementation of the forwarding runnable.
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
public final class ToSWTConsoleForwardRunnable
|
||||
extends AOutputForwardRunnable {
|
||||
/** The running status. */
|
||||
private boolean running = true;
|
||||
/** The console output. */
|
||||
private final PipedConsoleOutput out;
|
||||
/** The console output display. */
|
||||
private final ConsoleOutputDisplay display;
|
||||
/** The actual SWT component. */
|
||||
private final Widget element;
|
||||
|
||||
/** Create the forwarding runnable.
|
||||
*
|
||||
* @param manager the manager
|
||||
* @param display the display
|
||||
* @param element the composite */
|
||||
public ToSWTConsoleForwardRunnable(final PipedConsoleOutput manager,
|
||||
final ConsoleOutputDisplay display,
|
||||
final Widget element) {
|
||||
super(manager);
|
||||
out = manager;
|
||||
this.display = display;
|
||||
this.element = element;
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see
|
||||
* net.bigeon.gclc.utils.AOutputForwardRunnable#forwardLine(java.lang.String) */
|
||||
@Override
|
||||
protected void forwardLine(final String m) {
|
||||
display.appendLine(m);
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.utils.AOutputForwardRunnable#isRunning() */
|
||||
@Override
|
||||
protected boolean isRunning() {
|
||||
return running && !element.isDisposed();
|
||||
}
|
||||
|
||||
/** Set the running status.
|
||||
*
|
||||
* @param running the running to set */
|
||||
public void setRunning(final boolean running) {
|
||||
this.running = running;
|
||||
}
|
||||
|
||||
/** Get the output.
|
||||
*
|
||||
* @return the currently forwarded output */
|
||||
public PipedConsoleOutput getOuput() {
|
||||
return out;
|
||||
}
|
||||
}
|
||||
@@ -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;
|
||||
|
||||
44
gclc-swt/src/site/site.xml
Normal file
44
gclc-swt/src/site/site.xml
Normal file
@@ -0,0 +1,44 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!--
|
||||
#%L
|
||||
Generic Command Ligne console
|
||||
%%
|
||||
Copyright (C) 2014 - 2018 Bigeon
|
||||
%%
|
||||
This software is governed by the CeCILL license under French law and
|
||||
abiding by the rules of distribution of free software. You can use,
|
||||
modify and/ or redistribute the software under the terms of the CeCILL
|
||||
license as circulated by CEA, CNRS and INRIA at the following URL
|
||||
"http://www.cecill.info".
|
||||
|
||||
As a counterpart to the access to the source code and rights to copy,
|
||||
modify and redistribute granted by the license, users are provided only
|
||||
with a limited warranty and the software's author, the holder of the
|
||||
economic rights, and the successive licensors have only limited
|
||||
liability.
|
||||
|
||||
In this respect, the user's attention is drawn to the risks associated
|
||||
with loading, using, modifying and/or developing or reproducing the
|
||||
software by the user in light of its specific status of free software,
|
||||
that may mean that it is complicated to manipulate, and that also
|
||||
therefore means that it is reserved for developers and experienced
|
||||
professionals having in-depth computer knowledge. Users are therefore
|
||||
encouraged to load and test the software's suitability as regards their
|
||||
requirements in conditions enabling the security of their systems and/or
|
||||
data to be ensured and, more generally, to use and operate it in the
|
||||
same conditions as regards security.
|
||||
|
||||
The fact that you are presently reading this means that you have had
|
||||
knowledge of the CeCILL license and that you accept its terms.
|
||||
#L%
|
||||
-->
|
||||
|
||||
<project name="GCLC">
|
||||
<bannerRight>
|
||||
<src>https://bigeon.net/images/logo_48.png</src>
|
||||
<href>https://bigeon.net/</href>
|
||||
</bannerRight>
|
||||
<body>
|
||||
<menu ref="reports"/>
|
||||
</body>
|
||||
</project>
|
||||
@@ -0,0 +1,116 @@
|
||||
/**
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.swt;
|
||||
|
||||
/*-
|
||||
* #%L
|
||||
* GCLC swt
|
||||
* %%
|
||||
* Copyright (C) 2015 - 2018 Bigeon
|
||||
* %%
|
||||
* This software is governed by the CeCILL license under French law and
|
||||
* abiding by the rules of distribution of free software. You can use,
|
||||
* modify and/ or redistribute the software under the terms of the CeCILL
|
||||
* license as circulated by CEA, CNRS and INRIA at the following URL
|
||||
* "http://www.cecill.info".
|
||||
*
|
||||
* As a counterpart to the access to the source code and rights to copy,
|
||||
* modify and redistribute granted by the license, users are provided only
|
||||
* with a limited warranty and the software's author, the holder of the
|
||||
* economic rights, and the successive licensors have only limited
|
||||
* liability.
|
||||
*
|
||||
* In this respect, the user's attention is drawn to the risks associated
|
||||
* with loading, using, modifying and/or developing or reproducing the
|
||||
* software by the user in light of its specific status of free software,
|
||||
* that may mean that it is complicated to manipulate, and that also
|
||||
* therefore means that it is reserved for developers and experienced
|
||||
* professionals having in-depth computer knowledge. Users are therefore
|
||||
* encouraged to load and test the software's suitability as regards their
|
||||
* requirements in conditions enabling the security of their systems and/or
|
||||
* data to be ensured and, more generally, to use and operate it in the
|
||||
* same conditions as regards security.
|
||||
*
|
||||
* The fact that you are presently reading this means that you have had
|
||||
* knowledge of the CeCILL license and that you accept its terms.
|
||||
* #L%
|
||||
*/
|
||||
|
||||
import static org.junit.Assert.assertEquals;
|
||||
import static org.junit.Assert.fail;
|
||||
import static org.mockito.Mockito.*;
|
||||
|
||||
import java.io.IOException;
|
||||
|
||||
import org.eclipse.swt.widgets.Text;
|
||||
import org.junit.Test;
|
||||
|
||||
import net.bigeon.gclc.manager.PipedConsoleInput;
|
||||
|
||||
/** @author Emmanuel Bigeon */
|
||||
public class ConsoleInputManagerTest {
|
||||
|
||||
private final Text text = mock(Text.class);
|
||||
private final ConsoleInputManager cim = new ConsoleInputManager(text);
|
||||
|
||||
/** Test method for
|
||||
* {@link net.bigeon.gclc.swt.ConsoleInputManager#setInput(java.lang.String)}. */
|
||||
@Test
|
||||
public void testSetText() {
|
||||
cim.setInput("Text");
|
||||
verify(text).setText("Text");
|
||||
}
|
||||
|
||||
/** Test method for
|
||||
* {@link net.bigeon.gclc.swt.ConsoleInputManager#validateInput()}.
|
||||
*
|
||||
* @throws IOException if an error occurred */
|
||||
@Test
|
||||
public void testValidateInput() throws IOException {
|
||||
// Expected calls
|
||||
when(text.getText()).thenReturn("abc");
|
||||
|
||||
try {
|
||||
cim.validateInput();
|
||||
fail("No input should cause exception for input validation");
|
||||
} catch (final Exception e) {
|
||||
// ok
|
||||
}
|
||||
final PipedConsoleInput input = mock(PipedConsoleInput.class);
|
||||
cim.setManager(input);
|
||||
|
||||
cim.validateInput();
|
||||
verify(input).type("abc");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testValidateInputWithError() throws IOException {
|
||||
final PipedConsoleInput input = mock(PipedConsoleInput.class);
|
||||
cim.setManager(input);
|
||||
// Expected calls
|
||||
when(text.getText()).thenReturn("abc");
|
||||
doThrow(new IOException()).when(input).type("abc");
|
||||
|
||||
try {
|
||||
cim.validateInput();
|
||||
fail("IO exception should be forwarded");
|
||||
} catch (final IOException e) {
|
||||
// ok
|
||||
}
|
||||
}
|
||||
|
||||
/** Test method for
|
||||
* {@link net.bigeon.gclc.swt.ConsoleInputManager#getText()}. */
|
||||
@Test
|
||||
public void testGetText() {
|
||||
assertEquals("Text component should be preserved", text, cim.getText());
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testGetInput() {
|
||||
when(text.getText()).thenReturn("abc");
|
||||
assertEquals("Text component should be preserved", "abc", cim.getInput());
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,102 @@
|
||||
/**
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.swt;
|
||||
|
||||
/*-
|
||||
* #%L
|
||||
* GCLC swt
|
||||
* %%
|
||||
* Copyright (C) 2015 - 2018 Bigeon
|
||||
* %%
|
||||
* This software is governed by the CeCILL license under French law and
|
||||
* abiding by the rules of distribution of free software. You can use,
|
||||
* modify and/ or redistribute the software under the terms of the CeCILL
|
||||
* license as circulated by CEA, CNRS and INRIA at the following URL
|
||||
* "http://www.cecill.info".
|
||||
*
|
||||
* As a counterpart to the access to the source code and rights to copy,
|
||||
* modify and redistribute granted by the license, users are provided only
|
||||
* with a limited warranty and the software's author, the holder of the
|
||||
* economic rights, and the successive licensors have only limited
|
||||
* liability.
|
||||
*
|
||||
* In this respect, the user's attention is drawn to the risks associated
|
||||
* with loading, using, modifying and/or developing or reproducing the
|
||||
* software by the user in light of its specific status of free software,
|
||||
* that may mean that it is complicated to manipulate, and that also
|
||||
* therefore means that it is reserved for developers and experienced
|
||||
* professionals having in-depth computer knowledge. Users are therefore
|
||||
* encouraged to load and test the software's suitability as regards their
|
||||
* requirements in conditions enabling the security of their systems and/or
|
||||
* data to be ensured and, more generally, to use and operate it in the
|
||||
* same conditions as regards security.
|
||||
*
|
||||
* The fact that you are presently reading this means that you have had
|
||||
* knowledge of the CeCILL license and that you accept its terms.
|
||||
* #L%
|
||||
*/
|
||||
|
||||
import static org.mockito.ArgumentMatchers.any;
|
||||
import static org.mockito.Mockito.*;
|
||||
|
||||
import java.io.IOException;
|
||||
|
||||
import org.eclipse.swt.widgets.Display;
|
||||
import org.eclipse.swt.widgets.Text;
|
||||
import org.junit.Test;
|
||||
import org.mockito.invocation.InvocationOnMock;
|
||||
import org.mockito.stubbing.Answer;
|
||||
|
||||
import net.bigeon.gclc.manager.PipedConsoleOutput;
|
||||
|
||||
/** @author Emmanuel Bigeon */
|
||||
public class ConsoleOutputManagerTest {
|
||||
private final Text text = mock(Text.class);
|
||||
private final ConsoleOutputManager com = new ConsoleOutputManager(text);
|
||||
private final Display display = mock(Display.class);
|
||||
{
|
||||
when(text.getDisplay()).thenReturn(display);
|
||||
doAnswer(new Answer<Object>() {
|
||||
/* (non-Javadoc)
|
||||
* @see
|
||||
* org.mockito.stubbing.Answer#answer(org.mockito.invocation.InvocationOnMock) */
|
||||
@Override
|
||||
public Object answer(final InvocationOnMock invocation) throws Throwable {
|
||||
final Runnable runnable = invocation.getArgument(0);
|
||||
runnable.run();
|
||||
return null;
|
||||
}
|
||||
}).when(display).syncExec(any(Runnable.class));
|
||||
}
|
||||
|
||||
/** Test method for
|
||||
* {@link net.bigeon.gclc.swt.ConsoleOutputManager#appendLine(java.lang.String)}. */
|
||||
@Test
|
||||
public void testAppendConsoleOutput() {
|
||||
when(text.getText()).thenReturn("", "abc",
|
||||
"abc" + System.lineSeparator() + "def");
|
||||
com.appendLine("abc");
|
||||
verify(text).append("abc");
|
||||
com.appendLine("def");
|
||||
verify(text).append(System.lineSeparator());
|
||||
verify(text).append("def");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testSetManager() throws IOException, InterruptedException {
|
||||
final PipedConsoleOutput output = mock(PipedConsoleOutput.class);
|
||||
com.setManager(output);
|
||||
com.setManager(output);
|
||||
|
||||
try (PipedConsoleOutput output2 = new PipedConsoleOutput()) {
|
||||
com.setManager(output2);
|
||||
output2.println("line");
|
||||
final Thread forwardThread = com.getForwardThread();
|
||||
forwardThread.join(500);
|
||||
com.setManager(null);
|
||||
forwardThread.join();
|
||||
verify(text).append("line");
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,81 @@
|
||||
/**
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.swt;
|
||||
|
||||
/*-
|
||||
* #%L
|
||||
* GCLC swt
|
||||
* %%
|
||||
* Copyright (C) 2015 - 2018 Bigeon
|
||||
* %%
|
||||
* This software is governed by the CeCILL license under French law and
|
||||
* abiding by the rules of distribution of free software. You can use,
|
||||
* modify and/ or redistribute the software under the terms of the CeCILL
|
||||
* license as circulated by CEA, CNRS and INRIA at the following URL
|
||||
* "http://www.cecill.info".
|
||||
*
|
||||
* As a counterpart to the access to the source code and rights to copy,
|
||||
* modify and redistribute granted by the license, users are provided only
|
||||
* with a limited warranty and the software's author, the holder of the
|
||||
* economic rights, and the successive licensors have only limited
|
||||
* liability.
|
||||
*
|
||||
* In this respect, the user's attention is drawn to the risks associated
|
||||
* with loading, using, modifying and/or developing or reproducing the
|
||||
* software by the user in light of its specific status of free software,
|
||||
* that may mean that it is complicated to manipulate, and that also
|
||||
* therefore means that it is reserved for developers and experienced
|
||||
* professionals having in-depth computer knowledge. Users are therefore
|
||||
* encouraged to load and test the software's suitability as regards their
|
||||
* requirements in conditions enabling the security of their systems and/or
|
||||
* data to be ensured and, more generally, to use and operate it in the
|
||||
* same conditions as regards security.
|
||||
*
|
||||
* The fact that you are presently reading this means that you have had
|
||||
* knowledge of the CeCILL license and that you accept its terms.
|
||||
* #L%
|
||||
*/
|
||||
|
||||
import static org.mockito.Mockito.mock;
|
||||
import static org.mockito.Mockito.verify;
|
||||
|
||||
import java.io.BufferedReader;
|
||||
|
||||
import org.eclipse.swt.widgets.Label;
|
||||
import org.junit.Test;
|
||||
|
||||
/**
|
||||
* @author Emmanuel Bigeon
|
||||
*
|
||||
*/
|
||||
public class ConsolePromptManagerTest {
|
||||
|
||||
private final Label label = mock(Label.class);
|
||||
|
||||
private final ConsolePromptManager manager = new ConsolePromptManager(label);
|
||||
|
||||
/**
|
||||
* Test method for {@link net.bigeon.gclc.swt.ConsolePromptManager#setPrompt(java.lang.String)}.
|
||||
*/
|
||||
@Test
|
||||
public void testSetPrompt() {
|
||||
manager.setPrompt("abc");
|
||||
verify(label).setText("abc");
|
||||
}
|
||||
|
||||
/**
|
||||
* Test method for {@link net.bigeon.gclc.swt.ConsolePromptManager#setStream(java.io.BufferedReader)}.
|
||||
*/
|
||||
@Test
|
||||
public void testSetStream() {
|
||||
BufferedReader output = mock(BufferedReader.class);
|
||||
manager.setStream(output);
|
||||
manager.setStream(output);
|
||||
output = mock(BufferedReader.class);
|
||||
manager.setStream(output);
|
||||
manager.setStream(null);
|
||||
manager.setStream(output);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -69,11 +69,14 @@ package net.bigeon.gclc.swt;
|
||||
* #L%
|
||||
*/
|
||||
import static org.junit.Assert.assertEquals;
|
||||
import static org.mockito.Mockito.mock;
|
||||
|
||||
import org.eclipse.swt.SWT;
|
||||
import org.eclipse.swt.events.KeyEvent;
|
||||
import org.junit.Test;
|
||||
|
||||
/** <p>
|
||||
/**
|
||||
* <p>
|
||||
* TODO
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
@@ -83,25 +86,25 @@ public class HistoryTextKeyListenerTest {
|
||||
* {@link net.bigeon.gclc.swt.HistoryTextKeyListener#keyPressed(org.eclipse.swt.events.KeyEvent)}. */
|
||||
@Test
|
||||
public final void testKeyPressedKeyEvent() {
|
||||
ConsoleDelayIO io = new ConsoleDelayIO() {
|
||||
final ConsoleDelayIO io = new ConsoleDelayIO() {
|
||||
private String input = "";
|
||||
|
||||
@Override
|
||||
public void validateInput() {
|
||||
input = "";
|
||||
}
|
||||
|
||||
@Override
|
||||
public void setInput(String input) {
|
||||
this.input = input;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getInput() {
|
||||
return input;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void setInput(final String input) {
|
||||
this.input = input;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void validateInput() {
|
||||
input = "";
|
||||
}
|
||||
};
|
||||
HistoryTextKeyListener listener = new HistoryTextKeyListener(io);
|
||||
final HistoryTextKeyListener listener = new HistoryTextKeyListener(io);
|
||||
|
||||
// no effects
|
||||
assertEquals("", io.getInput());
|
||||
@@ -138,4 +141,12 @@ public class HistoryTextKeyListenerTest {
|
||||
assertEquals("cmd arg2", io.getInput());
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testKeyPressed() {
|
||||
final ConsoleDelayIO io = mock(ConsoleDelayIO.class);
|
||||
final KeyEvent event = mock(KeyEvent.class);
|
||||
event.keyCode = 'a';
|
||||
final HistoryTextKeyListener listener = new HistoryTextKeyListener(io);
|
||||
listener.keyPressed(event);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,107 @@
|
||||
/**
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.swt;
|
||||
|
||||
/*-
|
||||
* #%L
|
||||
* GCLC swt
|
||||
* %%
|
||||
* Copyright (C) 2015 - 2018 Bigeon
|
||||
* %%
|
||||
* This software is governed by the CeCILL license under French law and
|
||||
* abiding by the rules of distribution of free software. You can use,
|
||||
* modify and/ or redistribute the software under the terms of the CeCILL
|
||||
* license as circulated by CEA, CNRS and INRIA at the following URL
|
||||
* "http://www.cecill.info".
|
||||
*
|
||||
* As a counterpart to the access to the source code and rights to copy,
|
||||
* modify and redistribute granted by the license, users are provided only
|
||||
* with a limited warranty and the software's author, the holder of the
|
||||
* economic rights, and the successive licensors have only limited
|
||||
* liability.
|
||||
*
|
||||
* In this respect, the user's attention is drawn to the risks associated
|
||||
* with loading, using, modifying and/or developing or reproducing the
|
||||
* software by the user in light of its specific status of free software,
|
||||
* that may mean that it is complicated to manipulate, and that also
|
||||
* therefore means that it is reserved for developers and experienced
|
||||
* professionals having in-depth computer knowledge. Users are therefore
|
||||
* encouraged to load and test the software's suitability as regards their
|
||||
* requirements in conditions enabling the security of their systems and/or
|
||||
* data to be ensured and, more generally, to use and operate it in the
|
||||
* same conditions as regards security.
|
||||
*
|
||||
* The fact that you are presently reading this means that you have had
|
||||
* knowledge of the CeCILL license and that you accept its terms.
|
||||
* #L%
|
||||
*/
|
||||
|
||||
import static org.mockito.ArgumentMatchers.any;
|
||||
import static org.mockito.Mockito.doAnswer;
|
||||
import static org.mockito.Mockito.mock;
|
||||
import static org.mockito.Mockito.when;
|
||||
|
||||
import java.io.BufferedReader;
|
||||
import java.io.IOException;
|
||||
import java.util.logging.Level;
|
||||
import java.util.logging.Logger;
|
||||
|
||||
import org.eclipse.swt.widgets.Display;
|
||||
import org.eclipse.swt.widgets.Label;
|
||||
import org.junit.Test;
|
||||
import org.mockito.invocation.InvocationOnMock;
|
||||
import org.mockito.stubbing.Answer;
|
||||
|
||||
import net.bigeon.gclc.swt.tools.PromptReadingRunnable;
|
||||
|
||||
/** @author Emmanuel Bigeon */
|
||||
public class PromptReadingRunnableTest {
|
||||
private final Label view = mock(Label.class);
|
||||
private final Display display = mock(Display.class);
|
||||
{
|
||||
when(view.getDisplay()).thenReturn(display);
|
||||
doAnswer(new Answer<Object>() {
|
||||
/* (non-Javadoc)
|
||||
* @see
|
||||
* org.mockito.stubbing.Answer#answer(org.mockito.invocation.InvocationOnMock) */
|
||||
@Override
|
||||
public Object answer(final InvocationOnMock invocation) throws Throwable {
|
||||
final Runnable runnable = invocation.getArgument(0);
|
||||
runnable.run();
|
||||
return null;
|
||||
}
|
||||
}).when(display).syncExec(any(Runnable.class));
|
||||
}
|
||||
|
||||
/** Test method for {@link net.bigeon.gclc.swt.tools.PromptReadingRunnable#run()}.
|
||||
*
|
||||
* @throws IOException if an error occurred */
|
||||
@Test
|
||||
public void testRun() throws IOException {
|
||||
final BufferedReader reader = mock(BufferedReader.class);
|
||||
when(reader.readLine()).thenReturn("abc", "def", null);
|
||||
|
||||
final PromptReadingRunnable runnable = new PromptReadingRunnable(reader, view);
|
||||
|
||||
runnable.run();
|
||||
}
|
||||
|
||||
/** Test method for {@link net.bigeon.gclc.swt.tools.PromptReadingRunnable#run()}.
|
||||
*
|
||||
* @throws IOException if an error occurred */
|
||||
@Test
|
||||
public void testRunWithIO() throws IOException {
|
||||
final BufferedReader reader = mock(BufferedReader.class);
|
||||
when(reader.readLine()).thenThrow(new IOException());
|
||||
|
||||
final PromptReadingRunnable runnable = new PromptReadingRunnable(reader, view);
|
||||
final Logger logger = Logger.getLogger(PromptReadingRunnable.class.getName());
|
||||
final Level back = logger.getLevel();
|
||||
logger.setLevel(Level.OFF);
|
||||
|
||||
runnable.run();
|
||||
logger.setLevel(back);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,37 +1,5 @@
|
||||
/*
|
||||
* GCLC swt, provide a swt window for console applications
|
||||
* Copyright (C) 2015-2017 E. Bigeon
|
||||
* mailto:emmanuel@bigeon.fr
|
||||
*
|
||||
* This software is governed by the CeCILL license under French law and
|
||||
* abiding by the rules of distribution of free software. You can use,
|
||||
* modify and/or redistribute the software under the terms of the CeCILL
|
||||
* license as circulated by CEA, CNRS and INRIA at the following URL
|
||||
* "http://www.cecill.info".
|
||||
*
|
||||
* As a counterpart to the access to the source code and rights to copy,
|
||||
* modify and redistribute granted by the license, users are provided only
|
||||
* with a limited warranty and the software's author, the holder of the
|
||||
* economic rights, and the successive licensors have only limited
|
||||
* liability.
|
||||
*
|
||||
* In this respect, the user's attention is drawn to the risks associated
|
||||
* with loading, using, modifying and/or developing or reproducing the
|
||||
* software by the user in light of its specific status of free software,
|
||||
* that may mean that it is complicated to manipulate, and that also
|
||||
* therefore means that it is reserved for developers and experienced
|
||||
* professionals having in-depth computer knowledge. Users are therefore
|
||||
* encouraged to load and test the software's suitability as regards their
|
||||
* requirements in conditions enabling the security of their systems and/or
|
||||
* data to be ensured and, more generally, to use and operate it in the
|
||||
* same conditions as regards security.
|
||||
*
|
||||
* The fact that you are presently reading this means that you have had
|
||||
* knowledge of the CeCILL license and that you accept its terms.
|
||||
*/
|
||||
/**
|
||||
* gclc-swt:net.bigeon.gclc.swt.SWTConsoleShellTest.java
|
||||
* Created on: Jun 8, 2016
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.swt;
|
||||
|
||||
@@ -68,299 +36,40 @@ package net.bigeon.gclc.swt;
|
||||
* knowledge of the CeCILL license and that you accept its terms.
|
||||
* #L%
|
||||
*/
|
||||
import static org.junit.Assert.assertFalse;
|
||||
|
||||
import static org.junit.Assert.assertNotNull;
|
||||
import static org.junit.Assert.assertTrue;
|
||||
import static org.junit.Assert.fail;
|
||||
|
||||
import java.io.IOException;
|
||||
|
||||
import org.eclipse.swt.widgets.Display;
|
||||
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.ConsoleApplication;
|
||||
import net.bigeon.gclc.command.Command;
|
||||
import net.bigeon.gclc.command.base.ExitCommand;
|
||||
import net.bigeon.gclc.exception.CommandRunException;
|
||||
import net.bigeon.gclc.exception.InvalidCommandName;
|
||||
import net.bigeon.gclc.manager.ConsoleInput;
|
||||
import net.bigeon.gclc.manager.ConsoleOutput;
|
||||
import net.bigeon.gclc.manager.PipedConsoleInput;
|
||||
import net.bigeon.gclc.manager.PipedConsoleOutput;
|
||||
|
||||
/**
|
||||
* <p>
|
||||
* TODO
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
@SuppressWarnings({"javadoc", "static-method", "nls", "deprecation"})
|
||||
/** @author Emmanuel Bigeon */
|
||||
public class SWTConsoleShellTest {
|
||||
|
||||
protected static final long TWO_SECONDS = 2000;
|
||||
private static final Display DISPLAY = Display.getDefault();
|
||||
|
||||
/** Test method for
|
||||
* {@link net.bigeon.gclc.swt.SWTConsole#SWTConsole(Composite, int)}. */
|
||||
@Test
|
||||
public void test() {
|
||||
final SWTConsoleShell shell = new SWTConsoleShell(DISPLAY);
|
||||
final SWTConsole swtConsole = shell.getManager();
|
||||
try {
|
||||
final ConsoleApplication appl = new ConsoleApplication(swtConsole,
|
||||
swtConsole, "Hello", "See you");
|
||||
appl.add(new ExitCommand("exit", appl));
|
||||
appl.add(new Command("long") {
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
|
||||
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
|
||||
* java.lang.String[]) */
|
||||
@Override
|
||||
public void execute(final ConsoleOutput out,
|
||||
final ConsoleInput in,
|
||||
final String... args) throws CommandRunException {
|
||||
try {
|
||||
Thread.sleep(TWO_SECONDS);
|
||||
} catch (final InterruptedException e) {
|
||||
// TODO Auto-generated catch block
|
||||
e.printStackTrace();
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public String tip() {
|
||||
return "a long running command";
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.command.Command#usageDetail() */
|
||||
@Override
|
||||
protected String usageDetail() {
|
||||
// TODO Auto-generated method stub
|
||||
// return null;
|
||||
throw new RuntimeException("Not implemented yet");
|
||||
}
|
||||
});
|
||||
// shell.pack();
|
||||
shell.open();
|
||||
final Thread applThread = new Thread(new Runnable() {
|
||||
|
||||
@Override
|
||||
public void run() {
|
||||
appl.start();
|
||||
}
|
||||
});
|
||||
final Thread testThread = new Thread(new Runnable() {
|
||||
|
||||
@Override
|
||||
public void run() {
|
||||
try {
|
||||
Thread.sleep(TWO_SECONDS);
|
||||
} catch (final InterruptedException e) {
|
||||
// TODO Auto-generated catch block
|
||||
e.printStackTrace();
|
||||
}
|
||||
Display.getDefault().syncExec(new Runnable() {
|
||||
@Override
|
||||
public void run() {
|
||||
swtConsole.setText("test"); //$NON-NLS-1$
|
||||
swtConsole.validateCommand();
|
||||
}
|
||||
});
|
||||
try {
|
||||
Thread.sleep(TWO_SECONDS);
|
||||
} catch (final InterruptedException e) {
|
||||
// TODO Auto-generated catch block
|
||||
e.printStackTrace();
|
||||
}
|
||||
Display.getDefault().syncExec(new Runnable() {
|
||||
@Override
|
||||
public void run() {
|
||||
shell.dispose();
|
||||
}
|
||||
});
|
||||
}
|
||||
});
|
||||
applThread.start();
|
||||
testThread.start();
|
||||
while (!shell.isDisposed()) {
|
||||
if (!DISPLAY.readAndDispatch()) {
|
||||
DISPLAY.sleep();
|
||||
}
|
||||
}
|
||||
// DISPLAY.dispose();
|
||||
assertTrue(swtConsole.isClosed());
|
||||
Thread.sleep(TWO_SECONDS);
|
||||
assertFalse(appl.isRunning());
|
||||
} catch (final InvalidCommandName e) {
|
||||
// TODO Auto-generated catch block
|
||||
e.printStackTrace();
|
||||
} catch (final InterruptedException e) {
|
||||
// TODO Auto-generated catch block
|
||||
e.printStackTrace();
|
||||
}
|
||||
public void testSWTConsoleShell() {
|
||||
final SWTConsole console = new SWTConsole(new Shell(), SWT.NONE);
|
||||
assertNotNull("View should be initialized with managers",
|
||||
console.getInputManager());
|
||||
assertNotNull("View should be initialized with managers",
|
||||
console.getOutputManager());
|
||||
assertNotNull("View should be initialized with managers",
|
||||
console.getPromptManager());
|
||||
}
|
||||
|
||||
/** Test method for
|
||||
* {@link net.bigeon.gclc.swt.SWTConsole#connect(PipedConsoleInput, PipedConsoleOutput, java.io.BufferedReader)}. */
|
||||
@Test
|
||||
public void testConsoleClose() {
|
||||
final SWTConsoleShell shell = new SWTConsoleShell(DISPLAY);
|
||||
final SWTConsole swtConsole = shell.getManager();
|
||||
swtConsole.close();
|
||||
swtConsole.setPrompt(":");
|
||||
try {
|
||||
final ConsoleApplication appl = new ConsoleApplication(swtConsole,
|
||||
swtConsole, "Hello", "See you");
|
||||
appl.add(new ExitCommand("exit", appl));
|
||||
appl.add(new Command("long") {
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
|
||||
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
|
||||
* java.lang.String[]) */
|
||||
@Override
|
||||
public void execute(final ConsoleOutput out,
|
||||
final ConsoleInput in,
|
||||
final String... args) throws CommandRunException {
|
||||
try {
|
||||
Thread.sleep(TWO_SECONDS);
|
||||
} catch (final InterruptedException e) {
|
||||
// TODO Auto-generated catch block
|
||||
e.printStackTrace();
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public String tip() {
|
||||
return "a long running command";
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.command.Command#usageDetail() */
|
||||
@Override
|
||||
protected String usageDetail() {
|
||||
// TODO Auto-generated method stub
|
||||
// return null;
|
||||
throw new RuntimeException("Not implemented yet");
|
||||
}
|
||||
});
|
||||
appl.add(new Command("test") {
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
|
||||
* manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
|
||||
* java.lang.String[]) */
|
||||
@Override
|
||||
public void execute(final ConsoleOutput out,
|
||||
final ConsoleInput in,
|
||||
final String... args) throws CommandRunException {
|
||||
try {
|
||||
swtConsole.prompt("Test");
|
||||
} catch (final IOException e) {
|
||||
throw new CommandRunException("No input", e);
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public String tip() {
|
||||
return "a prompting running command";
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.command.Command#usageDetail() */
|
||||
@Override
|
||||
protected String usageDetail() {
|
||||
// TODO Auto-generated method stub
|
||||
// return null;
|
||||
throw new RuntimeException("Not implemented yet");
|
||||
}
|
||||
});
|
||||
// shell.pack();
|
||||
shell.open();
|
||||
final Thread applThread = new Thread(new Runnable() {
|
||||
|
||||
@Override
|
||||
public void run() {
|
||||
appl.start();
|
||||
}
|
||||
});
|
||||
final Thread testThread = new Thread(new Runnable() {
|
||||
|
||||
@Override
|
||||
public void run() {
|
||||
try {
|
||||
Thread.sleep(TWO_SECONDS);
|
||||
} catch (final InterruptedException e) {
|
||||
// TODO Auto-generated catch block
|
||||
e.printStackTrace();
|
||||
}
|
||||
Display.getDefault().syncExec(new Runnable() {
|
||||
@Override
|
||||
public void run() {
|
||||
swtConsole.setText("test"); //$NON-NLS-1$
|
||||
swtConsole.validateCommand();
|
||||
}
|
||||
});
|
||||
Display.getDefault().syncExec(new Runnable() {
|
||||
@Override
|
||||
public void run() {
|
||||
swtConsole.setText("ok"); //$NON-NLS-1$
|
||||
}
|
||||
});
|
||||
swtConsole.validateCommand();
|
||||
Display.getDefault().syncExec(new Runnable() {
|
||||
@Override
|
||||
public void run() {
|
||||
swtConsole.setText("long"); //$NON-NLS-1$
|
||||
}
|
||||
});
|
||||
swtConsole.validateCommand();
|
||||
Display.getDefault().syncExec(new Runnable() {
|
||||
@Override
|
||||
public void run() {
|
||||
swtConsole.setText("test"); //$NON-NLS-1$
|
||||
}
|
||||
});
|
||||
swtConsole.validateCommand();
|
||||
Display.getDefault().syncExec(new Runnable() {
|
||||
@Override
|
||||
public void run() {
|
||||
swtConsole.setText("test"); //$NON-NLS-1$
|
||||
}
|
||||
});
|
||||
swtConsole.validateCommand();
|
||||
try {
|
||||
Thread.sleep(TWO_SECONDS);
|
||||
} catch (final InterruptedException e) {
|
||||
// TODO Auto-generated catch block
|
||||
e.printStackTrace();
|
||||
}
|
||||
Display.getDefault().syncExec(new Runnable() {
|
||||
@Override
|
||||
public void run() {
|
||||
shell.dispose();
|
||||
}
|
||||
});
|
||||
|
||||
}
|
||||
});
|
||||
applThread.start();
|
||||
testThread.start();
|
||||
while (!shell.isDisposed()) {
|
||||
if (!DISPLAY.readAndDispatch()) {
|
||||
DISPLAY.sleep();
|
||||
}
|
||||
}
|
||||
swtConsole.setPrompt(">");
|
||||
try {
|
||||
swtConsole.prompt();
|
||||
fail("Prompting when closed should fail!");
|
||||
} catch (final IOException e) {
|
||||
assertNotNull(e);
|
||||
}
|
||||
// DISPLAY.dispose();
|
||||
assertTrue(swtConsole.isClosed());
|
||||
Thread.sleep(TWO_SECONDS);
|
||||
assertFalse(appl.isRunning());
|
||||
} catch (final InvalidCommandName e) {
|
||||
// TODO Auto-generated catch block
|
||||
e.printStackTrace();
|
||||
} catch (final InterruptedException e) {
|
||||
// TODO Auto-generated catch block
|
||||
e.printStackTrace();
|
||||
}
|
||||
public void testConnect() {
|
||||
final SWTConsole console = new SWTConsole(new Shell(), SWT.NONE);
|
||||
// Disconnection should work.
|
||||
console.connect(null, null, null);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@@ -1,37 +1,5 @@
|
||||
/*
|
||||
* GCLC swt, provide a swt window for console applications
|
||||
* Copyright (C) 2015-2017 E. Bigeon
|
||||
* mailto:emmanuel@bigeon.fr
|
||||
*
|
||||
* This software is governed by the CeCILL license under French law and
|
||||
* abiding by the rules of distribution of free software. You can use,
|
||||
* modify and/or redistribute the software under the terms of the CeCILL
|
||||
* license as circulated by CEA, CNRS and INRIA at the following URL
|
||||
* "http://www.cecill.info".
|
||||
*
|
||||
* As a counterpart to the access to the source code and rights to copy,
|
||||
* modify and redistribute granted by the license, users are provided only
|
||||
* with a limited warranty and the software's author, the holder of the
|
||||
* economic rights, and the successive licensors have only limited
|
||||
* liability.
|
||||
*
|
||||
* In this respect, the user's attention is drawn to the risks associated
|
||||
* with loading, using, modifying and/or developing or reproducing the
|
||||
* software by the user in light of its specific status of free software,
|
||||
* that may mean that it is complicated to manipulate, and that also
|
||||
* therefore means that it is reserved for developers and experienced
|
||||
* professionals having in-depth computer knowledge. Users are therefore
|
||||
* encouraged to load and test the software's suitability as regards their
|
||||
* requirements in conditions enabling the security of their systems and/or
|
||||
* data to be ensured and, more generally, to use and operate it in the
|
||||
* same conditions as regards security.
|
||||
*
|
||||
* The fact that you are presently reading this means that you have had
|
||||
* knowledge of the CeCILL license and that you accept its terms.
|
||||
*/
|
||||
/**
|
||||
* gclc-swt:net.bigeon.gclc.swt.SWTConsoleShellTest.java
|
||||
* Created on: Jun 8, 2016
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.swt;
|
||||
|
||||
@@ -68,135 +36,43 @@ package net.bigeon.gclc.swt;
|
||||
* knowledge of the CeCILL license and that you accept its terms.
|
||||
* #L%
|
||||
*/
|
||||
import static org.junit.Assert.assertNull;
|
||||
|
||||
import java.io.IOException;
|
||||
import static org.junit.Assert.assertFalse;
|
||||
import static org.junit.Assert.assertNotNull;
|
||||
|
||||
import org.eclipse.swt.SWT;
|
||||
import org.eclipse.swt.widgets.Display;
|
||||
import org.eclipse.swt.widgets.Shell;
|
||||
import org.junit.Test;
|
||||
|
||||
import net.bigeon.gclc.ConsoleApplication;
|
||||
import net.bigeon.gclc.command.Command;
|
||||
import net.bigeon.gclc.command.base.ExitCommand;
|
||||
import net.bigeon.gclc.exception.CommandRunException;
|
||||
import net.bigeon.gclc.exception.InvalidCommandName;
|
||||
import net.bigeon.gclc.manager.ConsoleInput;
|
||||
import net.bigeon.gclc.manager.ConsoleOutput;
|
||||
import net.bigeon.gclc.utils.PipedConsoleInput;
|
||||
import net.bigeon.gclc.utils.PipedConsoleOutput;
|
||||
import net.bigeon.gclc.manager.PipedConsoleInput;
|
||||
import net.bigeon.gclc.manager.PipedConsoleOutput;
|
||||
|
||||
/** <p>
|
||||
* TODO
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
@SuppressWarnings({"javadoc", "static-method", "nls", "deprecation"})
|
||||
/** @author Emmanuel Bigeon */
|
||||
public class SWTConsoleViewTest {
|
||||
|
||||
protected static final long TWO_SECONDS = 2000;
|
||||
private static final Display DISPLAY = Display.getDefault();
|
||||
|
||||
/** Test method for {@link net.bigeon.gclc.swt.SWTConsoleView#setFocus()}. */
|
||||
@Test
|
||||
public void test() {
|
||||
final Shell shell = new Shell(DISPLAY);
|
||||
final SWTConsoleView swtConsole = new SWTConsoleView(shell, SWT.NONE);
|
||||
try (PipedConsoleOutput manager = new PipedConsoleOutput();
|
||||
PipedConsoleInput input = new PipedConsoleInput(System.out)) {
|
||||
swtConsole.setManager(manager, input);
|
||||
} catch (final IOException e2) {
|
||||
assertNull(e2);
|
||||
}
|
||||
try (PipedConsoleOutput manager = new PipedConsoleOutput();
|
||||
PipedConsoleInput input = new PipedConsoleInput(System.out)) {
|
||||
swtConsole.setManager(manager, input);
|
||||
final ConsoleApplication appl = new ConsoleApplication(manager,
|
||||
input,
|
||||
"Hello", "See you");
|
||||
appl.add(new ExitCommand("exit", appl));
|
||||
appl.add(new Command("long") {
|
||||
public void testSetFocus() {
|
||||
final SWTConsoleView view = new SWTConsoleView(new Shell(), SWT.NONE);
|
||||
assertFalse("Non visible component set focus should fail", view.setFocus());
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[])
|
||||
*/
|
||||
@Override
|
||||
public void execute(final ConsoleOutput out, final ConsoleInput in,
|
||||
final String... args) throws CommandRunException {
|
||||
try {
|
||||
Thread.sleep(TWO_SECONDS);
|
||||
} catch (final InterruptedException e) {
|
||||
// TODO Auto-generated catch block
|
||||
e.printStackTrace();
|
||||
}
|
||||
}
|
||||
/** Test method for
|
||||
* {@link net.bigeon.gclc.swt.SWTConsoleView#SWTConsoleView(org.eclipse.swt.widgets.Composite, int)}. */
|
||||
@Test
|
||||
public void testSWTConsoleView() {
|
||||
final SWTConsoleView view = new SWTConsoleView(new Shell(), SWT.NONE);
|
||||
assertNotNull("View should be initialized with managers", view.getInputManager());
|
||||
assertNotNull("View should be initialized with managers",
|
||||
view.getOutputManager());
|
||||
}
|
||||
|
||||
@Override
|
||||
public String tip() {
|
||||
return "a long running command";
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.command.Command#usageDetail() */
|
||||
@Override
|
||||
protected String usageDetail() {
|
||||
// TODO Auto-generated method stub
|
||||
// return null;
|
||||
throw new RuntimeException("Not implemented yet");
|
||||
}
|
||||
});
|
||||
// shell.pack();
|
||||
shell.open();
|
||||
final Thread applThread = new Thread(new Runnable() {
|
||||
|
||||
@Override
|
||||
public void run() {
|
||||
appl.start();
|
||||
}
|
||||
});
|
||||
final Thread testThread = new Thread(new Runnable() {
|
||||
|
||||
@Override
|
||||
public void run() {
|
||||
try {
|
||||
Thread.sleep(TWO_SECONDS);
|
||||
} catch (final InterruptedException e) {
|
||||
// TODO Auto-generated catch block
|
||||
e.printStackTrace();
|
||||
}
|
||||
Display.getDefault().syncExec(new Runnable() {
|
||||
@Override
|
||||
public void run() {
|
||||
swtConsole.setText("test"); //$NON-NLS-1$
|
||||
swtConsole.validateInput();
|
||||
}
|
||||
});
|
||||
try {
|
||||
Thread.sleep(TWO_SECONDS);
|
||||
} catch (final InterruptedException e) {
|
||||
// TODO Auto-generated catch block
|
||||
e.printStackTrace();
|
||||
}
|
||||
Display.getDefault().syncExec(new Runnable() {
|
||||
@Override
|
||||
public void run() {
|
||||
shell.dispose();
|
||||
}
|
||||
});
|
||||
}
|
||||
});
|
||||
applThread.start();
|
||||
testThread.start();
|
||||
while (!shell.isDisposed()) {
|
||||
if (!DISPLAY.readAndDispatch()) {
|
||||
DISPLAY.sleep();
|
||||
}
|
||||
}
|
||||
} catch (final InvalidCommandName e) {
|
||||
// TODO Auto-generated catch block
|
||||
e.printStackTrace();
|
||||
} catch (final IOException e1) {
|
||||
// TODO Auto-generated catch block
|
||||
e1.printStackTrace();
|
||||
}
|
||||
/** Test method for
|
||||
* {@link net.bigeon.gclc.swt.SWTConsoleView#setManager(PipedConsoleOutput, PipedConsoleInput)}. */
|
||||
@Test
|
||||
public void testSetManager() {
|
||||
final SWTConsoleView view = new SWTConsoleView(new Shell(), SWT.NONE);
|
||||
// Disconnection should work.
|
||||
view.setManager(null, null);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
mock-maker-inline
|
||||
79
gclc-test/pom.xml
Normal file
79
gclc-test/pom.xml
Normal file
@@ -0,0 +1,79 @@
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<parent>
|
||||
<groupId>net.bigeon.config</groupId>
|
||||
<artifactId>ebigeon-config</artifactId>
|
||||
<version>1.8.21</version>
|
||||
</parent>
|
||||
<groupId>net.bigeon.gclc</groupId>
|
||||
<artifactId>test</artifactId>
|
||||
<version>0.0.1-SNAPSHOT</version>
|
||||
<packaging>jar</packaging>
|
||||
|
||||
<name>GCLC Tests</name>
|
||||
<description>Test utilities for GCLC applications and extensions</description>
|
||||
<inceptionYear>2018</inceptionYear>
|
||||
<organization>
|
||||
<name>Bigeon</name>
|
||||
<url>https://bigeon.net</url>
|
||||
</organization>
|
||||
<licenses>
|
||||
<license>
|
||||
<distribution>manual</distribution>
|
||||
<name>CeCILL 2.1</name>
|
||||
<url>https://cecill.info/licences/Licence_CeCILL_V2.1-en.html</url>
|
||||
</license>
|
||||
</licenses>
|
||||
<developers>
|
||||
<developer>
|
||||
<email>emmanuel@bigeon.fr</email>
|
||||
<name>Emmanuel Bigeon</name>
|
||||
<url>bigeon.net</url>
|
||||
<roles>
|
||||
<role>PM</role>
|
||||
</roles>
|
||||
</developer>
|
||||
</developers>
|
||||
<scm>
|
||||
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
|
||||
<tag>HEAD</tag>
|
||||
</scm>
|
||||
<properties>
|
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||
<license.licenseName>cecill_2.1</license.licenseName>
|
||||
</properties>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>net.bigeon</groupId>
|
||||
<artifactId>gclc</artifactId>
|
||||
<version>2.0.12</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>junit</groupId>
|
||||
<artifactId>junit</artifactId>
|
||||
<version>4.12</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>net.bigeon.test</groupId>
|
||||
<artifactId>junitmt</artifactId>
|
||||
<version>1.0.2</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
<reporting>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-javadoc-plugin</artifactId>
|
||||
<version>2.10.3</version>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>com.github.sevntu-checkstyle</groupId>
|
||||
<artifactId>dsm-maven-plugin</artifactId>
|
||||
<version>2.2.0</version>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</reporting>
|
||||
</project>
|
||||
@@ -0,0 +1,62 @@
|
||||
/**
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.test;
|
||||
|
||||
import static org.junit.Assert.assertFalse;
|
||||
import static org.junit.Assert.assertTrue;
|
||||
import static org.junit.Assert.fail;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.io.InterruptedIOException;
|
||||
import java.util.function.Supplier;
|
||||
|
||||
import net.bigeon.gclc.manager.ConsoleInput;
|
||||
import net.bigeon.test.junitmt.FunctionalTestRunnable;
|
||||
import net.bigeon.test.junitmt.TestFunction;
|
||||
import net.bigeon.test.junitmt.ThreadTest;
|
||||
|
||||
/** @author Emmanuel Bigeon */
|
||||
public final class InputContract {
|
||||
|
||||
public void testInputContract(final Supplier<ConsoleInput> inputs)
|
||||
throws IOException, InterruptedException {
|
||||
// Test close contract
|
||||
final ConsoleInput input = inputs.get();
|
||||
assertFalse("An input should not initially be closed", input.isClosed());
|
||||
input.close();
|
||||
assertTrue("An input should close", input.isClosed());
|
||||
input.close();
|
||||
assertTrue("A closed input should stay closed", input.isClosed());
|
||||
try {
|
||||
input.prompt();
|
||||
fail("Closed input prompting should fail");
|
||||
} catch (final IOException e) {
|
||||
// ok
|
||||
}
|
||||
|
||||
// Test interruption contract
|
||||
final ConsoleInput input2 = inputs.get();
|
||||
final FunctionalTestRunnable prompting = new FunctionalTestRunnable(
|
||||
new TestFunction() {
|
||||
|
||||
@Override
|
||||
public void apply() throws Exception {
|
||||
try {
|
||||
input2.prompt();
|
||||
fail("Interrupted prompt should throw INterruptedIOException");
|
||||
} catch (final InterruptedIOException e) {
|
||||
// ok
|
||||
}
|
||||
}
|
||||
});
|
||||
final Thread th = new Thread(prompting);
|
||||
th.start();
|
||||
// while (!input2.isPrompting()) {
|
||||
th.join(200);
|
||||
//
|
||||
// }
|
||||
input2.interruptPrompt();
|
||||
ThreadTest.assertRuns(th, prompting);
|
||||
}
|
||||
}
|
||||
@@ -1,36 +1,22 @@
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<groupId>net.bigeon.gclc</groupId>
|
||||
<artifactId>system</artifactId>
|
||||
<version>0.0.2-SNAPSHOT</version>
|
||||
<packaging>jar</packaging>
|
||||
<url>http://www.bigeon.net</url>
|
||||
<properties>
|
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||
<copyright.email>emmanuel@bigeon.fr</copyright.email>
|
||||
<license.licenseName>cecill_2.1</license.licenseName>
|
||||
</properties>
|
||||
<build>
|
||||
<plugins>
|
||||
</plugins>
|
||||
</build>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>junit</groupId>
|
||||
<artifactId>junit</artifactId>
|
||||
<version>4.11</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>net.bigeon</groupId>
|
||||
<artifactId>gclc</artifactId>
|
||||
<version>2.0.7</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
<name>GCLC system command</name>
|
||||
<description>Provide an exec command to execute system commands</description>
|
||||
<inceptionYear>2016</inceptionYear>
|
||||
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<parent>
|
||||
<groupId>net.bigeon.config</groupId>
|
||||
<artifactId>ebigeon-config</artifactId>
|
||||
<version>1.8.21</version>
|
||||
</parent>
|
||||
<groupId>net.bigeon.gclc</groupId>
|
||||
<artifactId>system</artifactId>
|
||||
<version>0.0.3-SNAPSHOT</version>
|
||||
<packaging>jar</packaging>
|
||||
<name>GCLC system command</name>
|
||||
<description>Provide an exec command to execute system commands</description>
|
||||
<url>https://bigeon.net/projects/gclc.html</url>
|
||||
<inceptionYear>2016</inceptionYear>
|
||||
<organization>
|
||||
<name>Bigeon</name>
|
||||
<url>https://bigeon.net</url>
|
||||
</organization>
|
||||
<licenses>
|
||||
<license>
|
||||
<distribution>manual</distribution>
|
||||
@@ -38,15 +24,6 @@
|
||||
<url>https://cecill.info/licences/Licence_CeCILL_V2.1-en.html</url>
|
||||
</license>
|
||||
</licenses>
|
||||
<reporting>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>com.github.sevntu-checkstyle</groupId>
|
||||
<artifactId>dsm-maven-plugin</artifactId>
|
||||
<version>2.2.0</version>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</reporting>
|
||||
<developers>
|
||||
<developer>
|
||||
<email>emmanuel@bigeon.fr</email>
|
||||
@@ -57,14 +34,46 @@
|
||||
</roles>
|
||||
</developer>
|
||||
</developers>
|
||||
<scm>
|
||||
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
|
||||
<tag>HEAD</tag>
|
||||
</scm>
|
||||
<properties>
|
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||
<copyright.email>emmanuel@bigeon.fr</copyright.email>
|
||||
<license.licenseName>cecill_2.1</license.licenseName>
|
||||
</properties>
|
||||
|
||||
<scm>
|
||||
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
|
||||
<tag>HEAD</tag>
|
||||
</scm>
|
||||
<parent>
|
||||
<groupId>net.bigeon.config</groupId>
|
||||
<artifactId>ebigeon-config</artifactId>
|
||||
<version>1.8.9</version>
|
||||
</parent>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>net.bigeon</groupId>
|
||||
<artifactId>gclc</artifactId>
|
||||
<version>2.0.11</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.mockito</groupId>
|
||||
<artifactId>mockito-core</artifactId>
|
||||
<version>2.23.0</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
<build>
|
||||
<plugins>
|
||||
</plugins>
|
||||
</build>
|
||||
<reporting>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-javadoc-plugin</artifactId>
|
||||
<version>2.10.3</version>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>com.github.sevntu-checkstyle</groupId>
|
||||
<artifactId>dsm-maven-plugin</artifactId>
|
||||
<version>2.2.0</version>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</reporting>
|
||||
</project>
|
||||
|
||||
@@ -39,11 +39,8 @@ package net.bigeon.gclc.system;
|
||||
*/
|
||||
import java.io.BufferedWriter;
|
||||
import java.io.IOException;
|
||||
import java.io.InputStream;
|
||||
import java.io.OutputStream;
|
||||
import java.io.OutputStreamWriter;
|
||||
import java.util.logging.Level;
|
||||
import java.util.logging.Logger;
|
||||
|
||||
import net.bigeon.gclc.command.Command;
|
||||
import net.bigeon.gclc.exception.CommandRunException;
|
||||
@@ -51,103 +48,67 @@ import net.bigeon.gclc.exception.CommandRunExceptionType;
|
||||
import net.bigeon.gclc.manager.ConsoleInput;
|
||||
import net.bigeon.gclc.manager.ConsoleOutput;
|
||||
|
||||
/** A command that will execute a system command.
|
||||
/** A command that will execute system commands.
|
||||
* <p>
|
||||
* Note that this class may induce security issues in the code as it can execute
|
||||
* arbitrary system commands. It is recommended that it be used only in private
|
||||
* applications or application used by aware parties.
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
public class ExecSystemCommand extends Command {
|
||||
|
||||
/** Error message for the manager closed. */
|
||||
private static final String MANAGER_WAS_CLOSED = "manager was closed";
|
||||
/** The command default name */
|
||||
private static final String COMMAND_DEFAULT_NAME = "exec"; //$NON-NLS-1$
|
||||
private static final String COMMAND_DEFAULT_NAME = "exec"; //$NON-NLS-1$
|
||||
/** The end of line separator */
|
||||
private static final String EOL = System.lineSeparator();
|
||||
/** The class logger */
|
||||
private static final Logger LOGGER = Logger
|
||||
.getLogger(ExecSystemCommand.class.getName());
|
||||
private static final String EOL = System.lineSeparator();
|
||||
|
||||
/***/
|
||||
/** Create the command with the name 'exec'. */
|
||||
public ExecSystemCommand() {
|
||||
super(COMMAND_DEFAULT_NAME);
|
||||
}
|
||||
|
||||
/** @param name the name of the command (the input from the manager that
|
||||
* should trigger this command) */
|
||||
/** Create the command with a custom name.
|
||||
*
|
||||
* @param name the name of the command (the input from the manager that should
|
||||
* trigger this command) */
|
||||
public ExecSystemCommand(final String name) {
|
||||
super(name);
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.
|
||||
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
|
||||
* java.lang.String[]) */
|
||||
* ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[]) */
|
||||
@Override
|
||||
public void execute(final ConsoleOutput out, final ConsoleInput in,
|
||||
final String... args) throws CommandRunException {
|
||||
final String... args) throws CommandRunException {
|
||||
Process proc;
|
||||
try {
|
||||
proc = Runtime.getRuntime().exec(args);
|
||||
} catch (final IOException e2) {
|
||||
LOGGER.log(Level.SEVERE, "Unable to run process", e2); //$NON-NLS-1$
|
||||
return;
|
||||
throw new CommandRunException("Unable to run process", e2);
|
||||
}
|
||||
|
||||
final InputStream is = proc
|
||||
.getInputStream();
|
||||
final Thread th = new Thread(new Runnable() {
|
||||
|
||||
@SuppressWarnings("synthetic-access")
|
||||
@Override
|
||||
public void run() {
|
||||
try {
|
||||
readToEnd(out, is);
|
||||
is.close();
|
||||
} catch (final CommandRunException e) {
|
||||
LOGGER.log(Level.WARNING,
|
||||
"Manager was closed in the meantime...", e); //$NON-NLS-1$
|
||||
} catch (final IOException e) {
|
||||
LOGGER.log(Level.WARNING, "Input stream was closed...", e); //$NON-NLS-1$
|
||||
}
|
||||
}
|
||||
});
|
||||
th.start();
|
||||
// Stream forwarding to the application's console
|
||||
// This is started in a parallel thread.
|
||||
final Thread th = ForwardingRunnable.connect(proc.getInputStream(), out,
|
||||
"Command output");
|
||||
// Set the empty prompt for the processes promptings.
|
||||
in.setPrompt(""); //$NON-NLS-1$
|
||||
// Forward console input to the process, whether the process is waiting or not
|
||||
// for input.
|
||||
final OutputStream os = proc.getOutputStream();
|
||||
try (BufferedWriter writer = new BufferedWriter(
|
||||
new OutputStreamWriter(os))) {
|
||||
try (BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(os))) {
|
||||
while (th.isAlive()) {
|
||||
String user;
|
||||
try {
|
||||
user = in.prompt();
|
||||
} catch (final IOException e) {
|
||||
throw new CommandRunException(
|
||||
CommandRunExceptionType.INTERACTION,
|
||||
"manager was closed", e); //$NON-NLS-1$
|
||||
final String user = in.prompt();
|
||||
// Avoid interruption being sent to process.
|
||||
if (!user.isEmpty()) {
|
||||
writer.write(user + EOL);
|
||||
}
|
||||
writer.write(user + EOL);
|
||||
}
|
||||
} catch (final IOException e1) {
|
||||
throw new CommandRunException(CommandRunExceptionType.INTERACTION,
|
||||
"manager was closed", e1); //$NON-NLS-1$
|
||||
}
|
||||
}
|
||||
|
||||
/** @param is the input stream
|
||||
* @throws CommandRunException if the manager was closed while writing the
|
||||
* stream */
|
||||
protected void readToEnd(final ConsoleOutput out,
|
||||
final InputStream is) throws CommandRunException {
|
||||
int c;
|
||||
try {
|
||||
while ((c = is.read()) != -1) {
|
||||
try {
|
||||
out.print(Character.valueOf((char) c).toString());
|
||||
} catch (final IOException e) {
|
||||
throw new CommandRunException(
|
||||
CommandRunExceptionType.INTERACTION,
|
||||
"manager was closed", e); //$NON-NLS-1$
|
||||
}
|
||||
}
|
||||
} catch (final IOException e) {
|
||||
LOGGER.log(Level.INFO, "input stream reading failed", e); //$NON-NLS-1$
|
||||
MANAGER_WAS_CLOSED, e1); // $NON-NLS-1$
|
||||
}
|
||||
}
|
||||
|
||||
@@ -163,12 +124,11 @@ public class ExecSystemCommand extends Command {
|
||||
@Override
|
||||
protected String usageDetail() {
|
||||
return " The system command is a system dependend command like sh on linux or" + //$NON-NLS-1$
|
||||
System.lineSeparator() + "powershell on windows." + //$NON-NLS-1$
|
||||
System.lineSeparator() + System.lineSeparator() +
|
||||
" As an example if you give \"cat /etc/hostname\" as argument, on a linux" + //$NON-NLS-1$
|
||||
System.lineSeparator() +
|
||||
"system, you would get the computer name." + //$NON-NLS-1$
|
||||
System.lineSeparator();
|
||||
System.lineSeparator() + "powershell on windows." + //$NON-NLS-1$
|
||||
System.lineSeparator() + System.lineSeparator()
|
||||
+ " As an example if you give \"cat\", \"/etc/hostname\" as arguments, on a linux" //$NON-NLS-1$
|
||||
+ System.lineSeparator() + "system, you would get the computer name." + //$NON-NLS-1$
|
||||
System.lineSeparator();
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
@@ -177,5 +137,4 @@ public class ExecSystemCommand extends Command {
|
||||
protected String usagePattern() {
|
||||
return " CMD <system command>"; //$NON-NLS-1$
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@@ -0,0 +1,165 @@
|
||||
package net.bigeon.gclc.system;
|
||||
|
||||
/*-
|
||||
* #%L
|
||||
* GCLC system command
|
||||
* %%
|
||||
* 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.io.InputStream;
|
||||
import java.util.logging.Level;
|
||||
import java.util.logging.Logger;
|
||||
|
||||
import net.bigeon.gclc.exception.CommandRunException;
|
||||
import net.bigeon.gclc.exception.CommandRunExceptionType;
|
||||
import net.bigeon.gclc.manager.ConsoleOutput;
|
||||
|
||||
/** A class forwarding the content of a stream into a console output.
|
||||
* <p>
|
||||
* This class is useful for processes that run in a different environment than
|
||||
* the application but return an output. Such processes include command
|
||||
* processes and socket communications for example.
|
||||
* <p>
|
||||
* In the current library is is used to retrieve a system command output.
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
public final class ForwardingRunnable implements Runnable {
|
||||
/** Error message for the manager closed. */
|
||||
private static final String MANAGER_WAS_CLOSED = "manager was closed";
|
||||
/** The class logger */
|
||||
private static final Logger LOGGER = Logger
|
||||
.getLogger(ForwardingRunnable.class.getName());
|
||||
|
||||
/** The console output. */
|
||||
private final ConsoleOutput out;
|
||||
/** The input stream. */
|
||||
private final InputStream is;
|
||||
private Exception error;
|
||||
|
||||
/** Create the runnable.
|
||||
*
|
||||
* @param out the output console
|
||||
* @param is the input stream */
|
||||
public ForwardingRunnable(final ConsoleOutput out, final InputStream is) {
|
||||
this.out = out;
|
||||
this.is = is;
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see java.lang.Runnable#run() */
|
||||
@Override
|
||||
public void run() {
|
||||
try {
|
||||
readToEnd();
|
||||
} catch (final CommandRunException e) {
|
||||
LOGGER.log(Level.WARNING, "Manager was closed in the meantime...", e); //$NON-NLS-1$
|
||||
setError(e);
|
||||
}
|
||||
}
|
||||
|
||||
/** Read the input until its end.
|
||||
* <p>
|
||||
* This method actually perform a loop on the input stream to read the next
|
||||
* character and then print int on the screen.
|
||||
* <p>
|
||||
* When the stream returns a negative value, it will exit its loop and return.
|
||||
*
|
||||
* @throws CommandRunException if the manager was closed while writing the
|
||||
* stream */
|
||||
private void readToEnd() throws CommandRunException {
|
||||
int c;
|
||||
try {
|
||||
while ((c = is.read()) >= 0) {
|
||||
// Print the character in the output
|
||||
printCharacter(out, (char) c);
|
||||
}
|
||||
} catch (final IOException e) {
|
||||
LOGGER.log(Level.INFO, "input stream reading failed", e); //$NON-NLS-1$
|
||||
setError(e);
|
||||
}
|
||||
}
|
||||
|
||||
/** Print a character on the console.
|
||||
*
|
||||
* @param out the console
|
||||
* @param c the character
|
||||
* @throws CommandRunException if the console failed to print the character. */
|
||||
private static void printCharacter(final ConsoleOutput out, final char c)
|
||||
throws CommandRunException {
|
||||
try {
|
||||
out.print(Character.toString(c));
|
||||
} catch (final IOException e) {
|
||||
throw new CommandRunException(CommandRunExceptionType.INTERACTION,
|
||||
MANAGER_WAS_CLOSED, e); // $NON-NLS-1$
|
||||
}
|
||||
}
|
||||
|
||||
/** Tool method to connect an input stream to a console output.
|
||||
*
|
||||
* @param stream the stream
|
||||
* @param output the output
|
||||
* @param name the identification of the thread
|
||||
* @return the thread the forwarding runnable runs into. */
|
||||
public static Thread connect(final InputStream stream, final ConsoleOutput output,
|
||||
final String name) {
|
||||
final Thread th = new Thread(new ForwardingRunnable(output, stream), name);
|
||||
th.start();
|
||||
return th;
|
||||
}
|
||||
|
||||
/** Tool method to connect an input stream to a console output.
|
||||
*
|
||||
* @param stream the stream
|
||||
* @param output the output
|
||||
* @return the thread the forwarding runnable runs into. */
|
||||
public static Thread connect(final InputStream stream, final ConsoleOutput output) {
|
||||
return connect(stream, output, "Forwarding");
|
||||
}
|
||||
|
||||
/** Get the error in this runnable execution if any.
|
||||
* <p>
|
||||
* In the current implementation, this error can be an {@link IOException} if
|
||||
* the input stream failed or a {@link CommandRunException} if the output was
|
||||
* closed.
|
||||
*
|
||||
* @return the error */
|
||||
public synchronized Exception getError() {
|
||||
return error;
|
||||
}
|
||||
|
||||
/** Set the error that caused this runnable to stop executing.
|
||||
*
|
||||
* @param error the error to set */
|
||||
private synchronized void setError(final Exception error) {
|
||||
this.error = error;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,42 @@
|
||||
/** This package contains classes for command execution on the system.
|
||||
* <p>
|
||||
* The class {@link net.bigeon.gclc.system.ExecSystemCommand} is, in the current
|
||||
* version (0.0.1), a source of vulnerability and should probably be used only
|
||||
* in private projects where the user is aware of the dangers.
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
package net.bigeon.gclc.system;
|
||||
|
||||
/*-
|
||||
* #%L
|
||||
* GCLC system command
|
||||
* %%
|
||||
* 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%
|
||||
*/
|
||||
44
gclc.system/src/site/site.xml
Normal file
44
gclc.system/src/site/site.xml
Normal file
@@ -0,0 +1,44 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!--
|
||||
#%L
|
||||
Generic Command Ligne console
|
||||
%%
|
||||
Copyright (C) 2014 - 2018 Bigeon
|
||||
%%
|
||||
This software is governed by the CeCILL license under French law and
|
||||
abiding by the rules of distribution of free software. You can use,
|
||||
modify and/ or redistribute the software under the terms of the CeCILL
|
||||
license as circulated by CEA, CNRS and INRIA at the following URL
|
||||
"http://www.cecill.info".
|
||||
|
||||
As a counterpart to the access to the source code and rights to copy,
|
||||
modify and redistribute granted by the license, users are provided only
|
||||
with a limited warranty and the software's author, the holder of the
|
||||
economic rights, and the successive licensors have only limited
|
||||
liability.
|
||||
|
||||
In this respect, the user's attention is drawn to the risks associated
|
||||
with loading, using, modifying and/or developing or reproducing the
|
||||
software by the user in light of its specific status of free software,
|
||||
that may mean that it is complicated to manipulate, and that also
|
||||
therefore means that it is reserved for developers and experienced
|
||||
professionals having in-depth computer knowledge. Users are therefore
|
||||
encouraged to load and test the software's suitability as regards their
|
||||
requirements in conditions enabling the security of their systems and/or
|
||||
data to be ensured and, more generally, to use and operate it in the
|
||||
same conditions as regards security.
|
||||
|
||||
The fact that you are presently reading this means that you have had
|
||||
knowledge of the CeCILL license and that you accept its terms.
|
||||
#L%
|
||||
-->
|
||||
|
||||
<project name="GCLC">
|
||||
<bannerRight>
|
||||
<src>https://bigeon.net/images/logo_48.png</src>
|
||||
<href>https://bigeon.net/</href>
|
||||
</bannerRight>
|
||||
<body>
|
||||
<menu ref="reports"/>
|
||||
</body>
|
||||
</project>
|
||||
@@ -0,0 +1,82 @@
|
||||
package net.bigeon.gclc.system;
|
||||
|
||||
/*-
|
||||
* #%L
|
||||
* GCLC system command
|
||||
* %%
|
||||
* 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 static org.junit.Assert.assertEquals;
|
||||
import static org.junit.Assert.assertNotNull;
|
||||
import static org.junit.Assert.fail;
|
||||
|
||||
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;
|
||||
|
||||
public class ExecSystemCommandTest {
|
||||
|
||||
/** Test the help methods of the command. */
|
||||
@Test
|
||||
public void testExecSystemCommand() {
|
||||
final ExecSystemCommand cmd = new ExecSystemCommand("test");
|
||||
assertEquals("Name should be preserved", "test", cmd.getCommandName());
|
||||
assertNotNull("tip should be defined", cmd.tip());
|
||||
assertNotNull("usage should be defined", cmd.usagePattern());
|
||||
assertNotNull("usage should be defined", cmd.usageDetail());
|
||||
}
|
||||
|
||||
/** Test the execution of the command.
|
||||
*
|
||||
* @throws CommandRunException if the command fails */
|
||||
@Test
|
||||
public void testExecute() 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");
|
||||
} else if (System.getProperty("os.name").contains("inux")) {
|
||||
cmd.execute(out, in, "ls");
|
||||
}
|
||||
try {
|
||||
cmd.execute(out, in, "inexistent");
|
||||
fail("Able to execute inexistent command in system");
|
||||
} catch (final CommandRunException e) {
|
||||
// ok
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,44 @@
|
||||
/**
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.system;
|
||||
|
||||
import static org.junit.Assert.assertTrue;
|
||||
|
||||
import java.io.ByteArrayInputStream;
|
||||
import java.io.IOException;
|
||||
import java.io.InputStream;
|
||||
|
||||
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;
|
||||
|
||||
/** @author Emmanuel Bigeon */
|
||||
public class ForwardingRunnableTest {
|
||||
|
||||
public void testClosedOutput() {
|
||||
final StreamConsoleOutput out = new StreamConsoleOutput();
|
||||
out.close();
|
||||
final InputStream is = new ByteArrayInputStream(new byte[] { 1, 2, 3 });
|
||||
final ForwardingRunnable runnable = new ForwardingRunnable(out, is);
|
||||
// Runnable should close immediatly.
|
||||
runnable.run();
|
||||
|
||||
assertTrue("Error should be a CommandRunException",
|
||||
runnable.getError() instanceof CommandRunException);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testIOInInput() throws IOException {
|
||||
final InputStream is = Mockito.mock(InputStream.class);
|
||||
Mockito.when(is.read()).thenThrow(new IOException());
|
||||
final ForwardingRunnable runnable = new ForwardingRunnable(SinkOutput.INSTANCE,
|
||||
is);
|
||||
// Runnable should close immediatly.
|
||||
runnable.run();
|
||||
assertTrue("Error should be an IO", runnable.getError() instanceof IOException);
|
||||
}
|
||||
}
|
||||
84
gclc/pom.xml
84
gclc/pom.xml
@@ -1,10 +1,44 @@
|
||||
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<parent>
|
||||
<groupId>net.bigeon.config</groupId>
|
||||
<artifactId>ebigeon-public-conf</artifactId>
|
||||
<version>1.0.10</version>
|
||||
</parent>
|
||||
<groupId>net.bigeon</groupId>
|
||||
<artifactId>gclc</artifactId>
|
||||
<version>2.0.8</version>
|
||||
<version>2.1.1-SNAPSHOT</version>
|
||||
<packaging>jar</packaging>
|
||||
<url>http://bigeon.net</url>
|
||||
<name>Generic Command Ligne console</name>
|
||||
<description>A generic framework for console applications, with customized command input and output streams.</description>
|
||||
<url>https://bigeon.net/projects/gclc.html</url>
|
||||
<inceptionYear>2014</inceptionYear>
|
||||
<organization>
|
||||
<name>Bigeon</name>
|
||||
<url>https://bigeon.net/</url>
|
||||
</organization>
|
||||
<licenses>
|
||||
<license>
|
||||
<distribution>manual</distribution>
|
||||
<name>CeCILL 2.1</name>
|
||||
<url>https://cecill.info/licences/Licence_CeCILL_V2.1-en.html</url>
|
||||
</license>
|
||||
</licenses>
|
||||
<developers>
|
||||
<developer>
|
||||
<email>emmanuel@bigeon.fr</email>
|
||||
<name>Emmanuel Bigeon</name>
|
||||
<url>bigeon.net</url>
|
||||
<roles>
|
||||
<role>PM</role>
|
||||
</roles>
|
||||
</developer>
|
||||
</developers>
|
||||
<scm>
|
||||
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
|
||||
<tag>HEAD</tag>
|
||||
</scm>
|
||||
<properties>
|
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||
<project.scm.id>git.code.bigeon.net</project.scm.id>
|
||||
@@ -13,17 +47,12 @@
|
||||
</properties>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>junit</groupId>
|
||||
<artifactId>junit</artifactId>
|
||||
<version>4.11</version>
|
||||
<groupId>net.bigeon.test</groupId>
|
||||
<artifactId>junitmt</artifactId>
|
||||
<version>1.0.2</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
<parent>
|
||||
<groupId>net.bigeon.config</groupId>
|
||||
<artifactId>ebigeon-config</artifactId>
|
||||
<version>1.8.9</version>
|
||||
</parent>
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
@@ -38,43 +67,18 @@
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
<licenses>
|
||||
<license>
|
||||
<distribution>manual</distribution>
|
||||
<name>CeCILL 2.1</name>
|
||||
<url>https://cecill.info/licences/Licence_CeCILL_V2.1-en.html</url>
|
||||
</license>
|
||||
</licenses>
|
||||
<reporting>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-javadoc-plugin</artifactId>
|
||||
<version>2.10.3</version>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>com.github.sevntu-checkstyle</groupId>
|
||||
<artifactId>dsm-maven-plugin</artifactId>
|
||||
<version>2.2.0</version>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.codehaus.mojo</groupId>
|
||||
<artifactId>jdepend-maven-plugin</artifactId>
|
||||
<version>2.0</version>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</reporting>
|
||||
<developers>
|
||||
<developer>
|
||||
<email>emmanuel@bigeon.fr</email>
|
||||
<name>Emmanuel Bigeon</name>
|
||||
<url>bigeon.net</url>
|
||||
<roles>
|
||||
<role>PM</role>
|
||||
</roles>
|
||||
</developer>
|
||||
</developers>
|
||||
<inceptionYear>2014</inceptionYear>
|
||||
<name>Generic Command Ligne console</name>
|
||||
<description>A generic framework for console applications, with customized command input and output streams.</description>
|
||||
<scm>
|
||||
<developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
|
||||
<tag>gclc-2.0.8</tag>
|
||||
</scm>
|
||||
<groupId>net.bigeon</groupId>
|
||||
</project>
|
||||
|
||||
@@ -71,9 +71,10 @@ package net.bigeon.gclc;
|
||||
*/
|
||||
import java.io.IOException;
|
||||
import java.io.InterruptedIOException;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Arrays;
|
||||
import java.util.LinkedHashSet;
|
||||
import java.util.List;
|
||||
import java.util.Set;
|
||||
import java.util.logging.Level;
|
||||
import java.util.logging.Logger;
|
||||
|
||||
@@ -88,15 +89,14 @@ import net.bigeon.gclc.i18n.Messages;
|
||||
import net.bigeon.gclc.manager.ConsoleInput;
|
||||
import net.bigeon.gclc.manager.ConsoleOutput;
|
||||
|
||||
/**
|
||||
* A {@link ConsoleApplication} is an application that require the user to input
|
||||
* commands.
|
||||
/** A {@link ConsoleApplication} is an application that require the user to
|
||||
* input commands.
|
||||
* <p>
|
||||
* A typical use case is the following:
|
||||
*
|
||||
* <pre>
|
||||
* {@link ConsoleOutput} out = new {@link net.bigeon.gclc.utils.StreamConsoleOutput StreamConsoleOutput}();
|
||||
* {@link ConsoleInput} in = new {@link net.bigeon.gclc.utils.StreamConsoleInput StreamConsoleInput}();
|
||||
* {@link ConsoleOutput} out = new {@link net.bigeon.gclc.manager.StreamConsoleOutput StreamConsoleOutput}();
|
||||
* {@link ConsoleInput} in = new {@link net.bigeon.gclc.manager.StreamConsoleInput StreamConsoleInput}();
|
||||
* {@link ConsoleApplication} app = new {@link ConsoleApplication}(out, in, "welcome", "see you latter")};
|
||||
* app.{@link ConsoleApplication#add(ICommand) add}("my_command", new {@link ICommand MyCommand()});
|
||||
* app.{@link ConsoleApplication#start() start()};
|
||||
@@ -111,22 +111,22 @@ import net.bigeon.gclc.manager.ConsoleOutput;
|
||||
public final class ConsoleApplication implements ICommandProvider {
|
||||
|
||||
/** The class logger. */
|
||||
private static final Logger LOGGER = Logger
|
||||
private static final Logger LOGGER = Logger
|
||||
.getLogger(ConsoleApplication.class.getName());
|
||||
/** The welcome message. */
|
||||
public final String header;
|
||||
public final String header;
|
||||
/** The good bye message. */
|
||||
public final String footer;
|
||||
public final String footer;
|
||||
/** The standard output for the application. */
|
||||
private final ConsoleOutput out;
|
||||
private final ConsoleOutput out;
|
||||
/** The standard input for the application. */
|
||||
private final ConsoleInput in;
|
||||
private final ConsoleInput in;
|
||||
/** The container of commands. */
|
||||
public final SubedCommand root;
|
||||
public final SubedCommand root;
|
||||
/** The state of this application. */
|
||||
private boolean running;
|
||||
private boolean running;
|
||||
/** The listeners. */
|
||||
private final List<CommandRequestListener> listeners = new ArrayList<>();
|
||||
private final Set<CommandRequestListener> listeners = new LinkedHashSet<>();
|
||||
|
||||
/** Create a console application.
|
||||
*
|
||||
@@ -135,8 +135,7 @@ public final class ConsoleApplication implements ICommandProvider {
|
||||
* @param welcome the welcoming message
|
||||
* @param goodbye the goodbye message */
|
||||
public ConsoleApplication(final ConsoleOutput out, final ConsoleInput in,
|
||||
final String welcome,
|
||||
final String goodbye) {
|
||||
final String welcome, final String goodbye) {
|
||||
header = welcome;
|
||||
footer = goodbye;
|
||||
this.in = in;
|
||||
@@ -161,8 +160,7 @@ public final class ConsoleApplication implements ICommandProvider {
|
||||
* java.lang.String[]) */
|
||||
@Override
|
||||
public void executeSub(final ConsoleOutput output, final ConsoleInput input,
|
||||
final String command,
|
||||
final String... args) throws CommandRunException {
|
||||
final String command, final String... args) throws CommandRunException {
|
||||
root.executeSub(output, input, command, args);
|
||||
}
|
||||
|
||||
@@ -182,8 +180,8 @@ public final class ConsoleApplication implements ICommandProvider {
|
||||
|
||||
/** Interpret a command line.
|
||||
* <p>
|
||||
* This method will split the command in its part and execute the command
|
||||
* with {@link #executeSub(ConsoleOutput, ConsoleInput, String, String...)}.
|
||||
* This method will split the command in its part and execute the command with
|
||||
* {@link #executeSub(ConsoleOutput, ConsoleInput, String, String...)}.
|
||||
*
|
||||
* @param cmd the command
|
||||
* @throws IOException if the command could not be parsed */
|
||||
@@ -191,19 +189,18 @@ public final class ConsoleApplication implements ICommandProvider {
|
||||
List<String> args;
|
||||
try {
|
||||
args = GCLCConstants.splitCommand(cmd);
|
||||
} catch (final CommandParsingException e1) {
|
||||
} catch (final CommandParsingException e) {
|
||||
out.println("Command line cannot be parsed"); //$NON-NLS-1$
|
||||
LOGGER.log(Level.FINE, "Invalid user command " + cmd, e1); //$NON-NLS-1$
|
||||
LOGGER.log(Level.FINE, "Invalid user command " + cmd, e); //$NON-NLS-1$
|
||||
return;
|
||||
}
|
||||
if (!args.isEmpty()) {
|
||||
try {
|
||||
executeSub(out, in, args.get(0), Arrays.copyOfRange(
|
||||
args.toArray(new String[0]), 1, args.size()));
|
||||
executeSub(out, in, args.get(0),
|
||||
Arrays.copyOfRange(args.toArray(new String[0]), 1, args.size()));
|
||||
} catch (final CommandRunException e) {
|
||||
LOGGER.log(Level.FINE, "Command failed: " + cmd, e); //$NON-NLS-1$
|
||||
out.println(Messages
|
||||
.getString("ConsoleApplication.cmd.failed", cmd)); //$NON-NLS-1$
|
||||
out.println(Messages.getString("ConsoleApplication.cmd.failed", cmd)); //$NON-NLS-1$
|
||||
out.println(e.getLocalizedMessage());
|
||||
if (e.getType() == CommandRunExceptionType.USAGE) {
|
||||
get(args.get(0)).help(out);
|
||||
@@ -228,8 +225,8 @@ public final class ConsoleApplication implements ICommandProvider {
|
||||
|
||||
/** The running loop content.
|
||||
* <p>
|
||||
* This consisting in getting the command, executing it and exiting
|
||||
* (restarting the loop). */
|
||||
* This consisting in getting the command, executing it and exiting (restarting
|
||||
* the loop). */
|
||||
private void runLoop() {
|
||||
try {
|
||||
final String cmd = in.prompt();
|
||||
@@ -241,8 +238,7 @@ public final class ConsoleApplication implements ICommandProvider {
|
||||
}
|
||||
interpretCommand(cmd);
|
||||
} catch (final InterruptedIOException e) {
|
||||
LOGGER.info(
|
||||
"Prompt interrupted. It is likely the application is closing."); //$NON-NLS-1$
|
||||
LOGGER.info("Prompt interrupted. It is likely the application is closing."); //$NON-NLS-1$
|
||||
LOGGER.log(Level.FINER, "Interruption of the prompt.", //$NON-NLS-1$
|
||||
e);
|
||||
} catch (final IOException e) {
|
||||
@@ -250,8 +246,7 @@ public final class ConsoleApplication implements ICommandProvider {
|
||||
running = false;
|
||||
LOGGER.warning(
|
||||
"The console manager was closed. Closing the application as no one can reach it."); //$NON-NLS-1$
|
||||
LOGGER.log(Level.FINE,
|
||||
"An exception caused the closing of the application", //$NON-NLS-1$
|
||||
LOGGER.log(Level.FINE, "An exception caused the closing of the application", //$NON-NLS-1$
|
||||
e);
|
||||
}
|
||||
}
|
||||
@@ -268,8 +263,7 @@ public final class ConsoleApplication implements ICommandProvider {
|
||||
running = false;
|
||||
LOGGER.warning(
|
||||
"The console manager was closed. Closing the application as no one can reach it."); //$NON-NLS-1$
|
||||
LOGGER.log(Level.FINE,
|
||||
"An exception caused the closing of the application", //$NON-NLS-1$
|
||||
LOGGER.log(Level.FINE, "An exception caused the closing of the application", //$NON-NLS-1$
|
||||
e);
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -85,7 +85,7 @@ import net.bigeon.gclc.exception.CommandParsingException;
|
||||
public final class GCLCConstants {
|
||||
|
||||
/** The escaping character. */
|
||||
private static final char ESCAPING_CHAR = getSystemEscapingChar();
|
||||
private static final char ESCAPING_CHAR = '\\';
|
||||
|
||||
/** Hide utility class constructor. */
|
||||
private GCLCConstants() {
|
||||
@@ -99,22 +99,15 @@ public final class GCLCConstants {
|
||||
* @param index the index of the current position
|
||||
* @return the argument
|
||||
* @throws CommandParsingException if the end of string does not mark end of
|
||||
* command and is not followed by a space */
|
||||
* command and is not followed by a space */
|
||||
private static String endOfString(final String cmd, final int startIndex,
|
||||
final int index) throws CommandParsingException {
|
||||
final int index) throws CommandParsingException {
|
||||
if (index < cmd.length() && cmd.charAt(index) != ' ') {
|
||||
throw new CommandParsingException("Misplaced quote"); //$NON-NLS-1$
|
||||
}
|
||||
return cmd.substring(startIndex + 1, index - 1);
|
||||
}
|
||||
|
||||
/** Get the excaping character.
|
||||
*
|
||||
* @return the escaping character */
|
||||
private static char getSystemEscapingChar() {
|
||||
return '\\';
|
||||
}
|
||||
|
||||
/** Remove escaping characters from the string.
|
||||
*
|
||||
* @param arg the string to remove excaping character from
|
||||
@@ -137,7 +130,8 @@ public final class GCLCConstants {
|
||||
* @param cmd the command to split in its parts
|
||||
* @return the list of argument preceded by the command name
|
||||
* @throws CommandParsingException if the parsing of the command failed */
|
||||
public static List<String> splitCommand(final String cmd) throws CommandParsingException {
|
||||
public static List<String> splitCommand(final String cmd)
|
||||
throws CommandParsingException {
|
||||
final List<String> args = new ArrayList<>();
|
||||
// parse the string to separate arguments
|
||||
int index = 0;
|
||||
@@ -164,6 +158,8 @@ public final class GCLCConstants {
|
||||
startIndex = index;
|
||||
}
|
||||
inString = startIndex == index - 1;
|
||||
} else {
|
||||
// No special processing
|
||||
}
|
||||
}
|
||||
if (startIndex < cmd.length()) {
|
||||
|
||||
@@ -68,7 +68,7 @@ public abstract class Command implements ICommand {
|
||||
/** The linux end of line character. */
|
||||
private static final String EOL_LINUX = "\n"; //$NON-NLS-1$
|
||||
/** The name of the command. */
|
||||
protected final String name;
|
||||
protected final String name;
|
||||
|
||||
/** Create the command.
|
||||
*
|
||||
@@ -80,8 +80,8 @@ public abstract class Command implements ICommand {
|
||||
|
||||
/** Get the brief part of the command help.
|
||||
* <p>
|
||||
* This method may be overriden by implementations to improve the help
|
||||
* content. The default behavior is to print the tip.
|
||||
* This method may be overriden by implementations to improve the help content.
|
||||
* The default behavior is to print the tip.
|
||||
*
|
||||
* @return a brief description of the command
|
||||
* @see Command#help(ConsoleOutput, String...) */
|
||||
@@ -112,8 +112,8 @@ public abstract class Command implements ICommand {
|
||||
*
|
||||
* @see net.bigeon.gclc.command.ICommand#help(ConsoleOutput, String...) */
|
||||
@Override
|
||||
public final void help(final ConsoleOutput manager,
|
||||
final String... args) throws IOException {
|
||||
public final void help(final ConsoleOutput manager, final String... args)
|
||||
throws IOException {
|
||||
manager.println(getCommandName());
|
||||
manager.println(brief());
|
||||
manager.println();
|
||||
@@ -123,8 +123,8 @@ public abstract class Command implements ICommand {
|
||||
final String details = usageDetail();
|
||||
if (details != null && !details.isEmpty()) {
|
||||
manager.print(details);
|
||||
if (!(details.endsWith(EOL_LINUX) ||
|
||||
details.endsWith(System.lineSeparator()))) {
|
||||
if (!(details.endsWith(EOL_LINUX)
|
||||
|| details.endsWith(System.lineSeparator()))) {
|
||||
manager.println();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -43,6 +43,7 @@ import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
import java.util.concurrent.ConcurrentHashMap;
|
||||
|
||||
import net.bigeon.gclc.exception.CommandParsingException;
|
||||
|
||||
@@ -53,15 +54,15 @@ import net.bigeon.gclc.exception.CommandParsingException;
|
||||
* @author Emmanuel BIGEON */
|
||||
public final class CommandParameters {
|
||||
/** Number of element for a string argument. */
|
||||
private static final int STRINGARG_NUMBER_OF_ELEMENTS = 2;
|
||||
private static final int STRINGARG_NUMBER_OF_ELEMENTS = 2;
|
||||
/** Boolean arguments. */
|
||||
private final Map<String, Boolean> booleanArguments = new HashMap<>();
|
||||
private final Map<String, Boolean> booleanArguments;
|
||||
/** String arguments. */
|
||||
private final Map<String, String> stringArguments = new HashMap<>();
|
||||
private final Map<String, String> stringArguments;
|
||||
/** Arguments restriction on the named ones. */
|
||||
private final boolean strict;
|
||||
private final boolean strict;
|
||||
/** additional (unnamed) parameters. */
|
||||
private final List<String> additional = new ArrayList<>();
|
||||
private final List<String> additional = new ArrayList<>();
|
||||
|
||||
/** Create a command parameter object.
|
||||
*
|
||||
@@ -69,10 +70,13 @@ public final class CommandParameters {
|
||||
* @param strings the string parameters
|
||||
* @param strict if the argument are restricted to the declared ones */
|
||||
public CommandParameters(final Set<String> bools, final Set<String> strings,
|
||||
final boolean strict) {
|
||||
final boolean strict) {
|
||||
booleanArguments = new ConcurrentHashMap<>(bools.size());
|
||||
for (final String string : bools) {
|
||||
booleanArguments.put(string, Boolean.FALSE);
|
||||
}
|
||||
// Cannot use concurrent because of the null values.
|
||||
stringArguments = new HashMap<>(strings.size());
|
||||
for (final String string : strings) {
|
||||
stringArguments.put(string, null);
|
||||
}
|
||||
@@ -98,9 +102,9 @@ public final class CommandParameters {
|
||||
*
|
||||
* @param key the key
|
||||
* @return if the key was specified */
|
||||
public boolean getBool(final String key) {
|
||||
return booleanArguments.containsKey(key) &&
|
||||
booleanArguments.get(key).booleanValue();
|
||||
public boolean isActive(final String key) {
|
||||
Boolean val = booleanArguments.get(key);
|
||||
return val != null && val.booleanValue();
|
||||
}
|
||||
|
||||
/** Get the boolean arguments.
|
||||
@@ -122,14 +126,13 @@ public final class CommandParameters {
|
||||
* @param key the key
|
||||
* @return if the key is present in string arguments or boolean ones. */
|
||||
public boolean hasArgument(final String key) {
|
||||
return stringArguments.containsKey(key) ||
|
||||
booleanArguments.containsKey(key);
|
||||
return stringArguments.containsKey(key) || booleanArguments.containsKey(key);
|
||||
}
|
||||
|
||||
/** Attempt to parse an argument.
|
||||
* <p>
|
||||
* This method return 0 if the parsing was incorrect, or the number of
|
||||
* parsed elements.
|
||||
* This method return 0 if the parsing was incorrect, or the number of parsed
|
||||
* elements.
|
||||
*
|
||||
* @param arg the argument
|
||||
* @param next the next element
|
||||
@@ -170,8 +173,7 @@ public final class CommandParameters {
|
||||
}
|
||||
final int p = parseArg(args[i], next);
|
||||
if (p == 0) {
|
||||
throw new CommandParsingException(
|
||||
"Invalid parameter " + args[i]); //$NON-NLS-1$
|
||||
throw new CommandParsingException("Invalid parameter " + args[i]); //$NON-NLS-1$
|
||||
}
|
||||
i += p;
|
||||
}
|
||||
|
||||
@@ -35,8 +35,8 @@ package net.bigeon.gclc.command;
|
||||
* knowledge of the CeCILL license and that you accept its terms.
|
||||
* #L%
|
||||
*/
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import java.util.LinkedHashSet;
|
||||
import java.util.Set;
|
||||
|
||||
import net.bigeon.gclc.exception.CommandRunException;
|
||||
import net.bigeon.gclc.exception.InvalidCommandName;
|
||||
@@ -49,27 +49,20 @@ import net.bigeon.gclc.manager.ConsoleOutput;
|
||||
* @author Emmanuel BIGEON */
|
||||
public class CommandProvider implements ICommandProvider {
|
||||
/** The minus character. */
|
||||
private static final String MINUS = "-"; //$NON-NLS-1$
|
||||
private static final String MINUS = "-"; //$NON-NLS-1$
|
||||
/** The space character. */
|
||||
private static final String SPACE = " "; //$NON-NLS-1$
|
||||
/** The commands map. */
|
||||
protected final List<ICommand> commands;
|
||||
private static final String SPACE = " "; //$NON-NLS-1$
|
||||
|
||||
/** The commands set.
|
||||
* <p>
|
||||
* The insertion order is conserved through the use of a
|
||||
* {@link LinkedHashSet}. */
|
||||
protected final Set<ICommand> commands;
|
||||
|
||||
/** Create a command provider. */
|
||||
public CommandProvider() {
|
||||
super();
|
||||
commands = new ArrayList<>();
|
||||
}
|
||||
|
||||
/** Test the command name validity.
|
||||
*
|
||||
* @param name the command name
|
||||
* @throws InvalidCommandName if the name is invalid */
|
||||
private static void testCommandName(final String name) throws InvalidCommandName {
|
||||
if (name == null || name.isEmpty() || name.startsWith(MINUS)
|
||||
|| name.contains(SPACE)) {
|
||||
throw new InvalidCommandName();
|
||||
}
|
||||
commands = new LinkedHashSet<>();
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
@@ -118,4 +111,15 @@ public class CommandProvider implements ICommandProvider {
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
/** Test the command name validity.
|
||||
*
|
||||
* @param name the command name
|
||||
* @throws InvalidCommandName if the name is invalid */
|
||||
private static void testCommandName(final String name) throws InvalidCommandName {
|
||||
if (name == null || name.isEmpty() || name.startsWith(MINUS)
|
||||
|| name.contains(SPACE)) {
|
||||
throw new InvalidCommandName();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -90,8 +90,8 @@ public interface ICommand {
|
||||
* @param in the input
|
||||
* @param args the arguments
|
||||
* @throws CommandRunException if the command failed */
|
||||
void execute(ConsoleOutput out, ConsoleInput in,
|
||||
String... args) throws CommandRunException;
|
||||
void execute(ConsoleOutput out, ConsoleInput in, String... args)
|
||||
throws CommandRunException;
|
||||
|
||||
/** Get teh command name.
|
||||
*
|
||||
|
||||
@@ -81,8 +81,8 @@ import net.bigeon.gclc.manager.ConsoleOutput;
|
||||
* @author Emmanuel BIGEON */
|
||||
public interface ICommandProvider {
|
||||
|
||||
/** Adds a command to this provider, if no command was associated with the
|
||||
* given key.
|
||||
/** Adds a command to this provider, if no command was associated with the given
|
||||
* key.
|
||||
*
|
||||
* @param value the command to execute
|
||||
* @return if the command was added
|
||||
@@ -91,25 +91,25 @@ public interface ICommandProvider {
|
||||
|
||||
/** Execute the command with the given name.
|
||||
* <p>
|
||||
* If no command with this name is found, an error command is usually
|
||||
* executed. If there are several commands with the same name, the behavior
|
||||
* is unspecified. Depending on the implementation, it may run an error
|
||||
* command or prompt the user for a choice.
|
||||
* If no command with this name is found, an error command is usually executed.
|
||||
* If there are several commands with the same name, the behavior is
|
||||
* unspecified. Depending on the implementation, it may run an error command or
|
||||
* prompt the user for a choice.
|
||||
*
|
||||
* @param out the output
|
||||
* @param in the input
|
||||
* @param command the name of the command the user wishes to execute
|
||||
* @param args the arguments for the command
|
||||
* @throws CommandRunException if the command failed to run */
|
||||
void executeSub(ConsoleOutput out, ConsoleInput in, String command,
|
||||
String... args) throws CommandRunException;
|
||||
void executeSub(ConsoleOutput out, ConsoleInput in, String command, String... args)
|
||||
throws CommandRunException;
|
||||
|
||||
/** Get the command with the given name.
|
||||
* <p>
|
||||
* If no command with this name is found, an error command is usually
|
||||
* returned. If there are several commands with the same name, the behavior
|
||||
* is unspecified. Depending on the implementation, it may return an error
|
||||
* command or the first command with this name found.
|
||||
* If no command with this name is found, an error command is usually returned.
|
||||
* If there are several commands with the same name, the behavior is
|
||||
* unspecified. Depending on the implementation, it may return an error command
|
||||
* or the first command with this name found.
|
||||
*
|
||||
* @param command the name of the command the user wishes to execute
|
||||
* @return the command to execute */
|
||||
|
||||
@@ -89,9 +89,8 @@ public abstract class ParametrizedCommand extends Command {
|
||||
|
||||
/** Create a parametrized command.
|
||||
* <p>
|
||||
* Implementation are supposed to call the
|
||||
* {@link #addBooleanParameter(String)} and
|
||||
* {@link #addStringParameter(String, boolean)} method to set the
|
||||
* Implementation are supposed to call the {@link #addBooleanParameter(String)}
|
||||
* and {@link #addStringParameter(String, boolean)} method to set the
|
||||
* parameters.
|
||||
*
|
||||
* @param name the name */
|
||||
@@ -101,9 +100,8 @@ public abstract class ParametrizedCommand extends Command {
|
||||
|
||||
/** Create a parametrized command.
|
||||
* <p>
|
||||
* Implementation are supposed to call the
|
||||
* {@link #addBooleanParameter(String)} and
|
||||
* {@link #addStringParameter(String, boolean)} method to set the
|
||||
* Implementation are supposed to call the {@link #addBooleanParameter(String)}
|
||||
* and {@link #addStringParameter(String, boolean)} method to set the
|
||||
* parameters.
|
||||
*
|
||||
* @param name the name
|
||||
@@ -116,9 +114,9 @@ public abstract class ParametrizedCommand extends Command {
|
||||
/** Add a boolean parameter to defined parmaters.
|
||||
*
|
||||
* @param flag the boolean flag
|
||||
* @throws InvalidParameterException if the parameter is already defined as
|
||||
* a string parameter */
|
||||
protected final void addBooleanParameter(final String flag) throws InvalidParameterException {
|
||||
* @throws InvalidParameterException if the parameter is already defined as a
|
||||
* string parameter */
|
||||
protected final void addBooleanParameter(final String flag) {
|
||||
data.addBooleanParameter(flag);
|
||||
}
|
||||
|
||||
@@ -126,10 +124,9 @@ public abstract class ParametrizedCommand extends Command {
|
||||
*
|
||||
* @param flag the parameter flag
|
||||
* @param needed if the parameter's absence should cause an exception
|
||||
* @throws InvalidParameterException if the parameter is already defined as
|
||||
* a boolean parameter */
|
||||
protected final void addStringParameter(final String flag,
|
||||
final boolean needed) throws InvalidParameterException {
|
||||
* @throws InvalidParameterException if the parameter is already defined as a
|
||||
* boolean parameter */
|
||||
protected final void addStringParameter(final String flag, final boolean needed) {
|
||||
data.addStringParameter(flag, needed);
|
||||
}
|
||||
|
||||
@@ -140,14 +137,13 @@ public abstract class ParametrizedCommand extends Command {
|
||||
* @param parameters the command parameters
|
||||
* @throws CommandRunException if the command failed */
|
||||
protected abstract void doExecute(ConsoleOutput out, ConsoleInput in,
|
||||
CommandParameters parameters) throws CommandRunException;
|
||||
CommandParameters parameters) throws CommandRunException;
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.command.Command#execute(java.lang.String[]) */
|
||||
@Override
|
||||
public final void execute(final ConsoleOutput output,
|
||||
final ConsoleInput input,
|
||||
final String... args) throws CommandRunException {
|
||||
public final void execute(final ConsoleOutput output, final ConsoleInput input,
|
||||
final String... args) throws CommandRunException {
|
||||
try {
|
||||
doExecute(output, input, data.getParameters(input, args));
|
||||
} catch (final IOException e) {
|
||||
|
||||
@@ -75,30 +75,30 @@ import java.io.IOException;
|
||||
import java.text.MessageFormat;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collections;
|
||||
import java.util.HashMap;
|
||||
import java.util.HashSet;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Map.Entry;
|
||||
import java.util.Set;
|
||||
import java.util.concurrent.ConcurrentHashMap;
|
||||
|
||||
import net.bigeon.gclc.exception.CommandParsingException;
|
||||
import net.bigeon.gclc.exception.InvalidParameterException;
|
||||
import net.bigeon.gclc.manager.ConsoleInput;
|
||||
import net.bigeon.gclc.manager.EmptyInput;
|
||||
|
||||
import java.util.Set;
|
||||
|
||||
/** An object to handle standardized command parameters.
|
||||
*
|
||||
* @author Emmanuel BIGEON */
|
||||
public final class ParametrizedCommandData {
|
||||
|
||||
/** The boolean parameters mandatory status. */
|
||||
private final Set<String> boolParams = new HashSet<>();
|
||||
private final Set<String> boolParams = new HashSet<>();
|
||||
|
||||
/** The string parameters mandatory status. */
|
||||
private final Map<String, Boolean> stringParams = new HashMap<>();
|
||||
private final Map<String, Boolean> stringParams = new ConcurrentHashMap<>();
|
||||
/** The parameters mandatory status. */
|
||||
private final Map<String, Boolean> params = new HashMap<>();
|
||||
private final Map<String, Boolean> params = new ConcurrentHashMap<>();
|
||||
/** The restriction of provided parameters on execution to declared paramters in
|
||||
* the status maps. */
|
||||
private final boolean strict;
|
||||
@@ -120,8 +120,7 @@ public final class ParametrizedCommandData {
|
||||
* @param flag the boolean flag
|
||||
* @throws InvalidParameterException if the parameter is already defined as a
|
||||
* string parameter */
|
||||
public final void addBooleanParameter(final String flag)
|
||||
throws InvalidParameterException {
|
||||
public void addBooleanParameter(final String flag) {
|
||||
if (params.containsKey(flag) && stringParams.containsKey(flag)) {
|
||||
throw new InvalidParameterException("Parameter is already defined as string"); //$NON-NLS-1$
|
||||
}
|
||||
@@ -135,8 +134,7 @@ public final class ParametrizedCommandData {
|
||||
* @param needed if the parameter's absence should cause an exception
|
||||
* @throws InvalidParameterException if the parameter is already defined as a
|
||||
* boolean parameter */
|
||||
public final void addStringParameter(final String flag, final boolean needed)
|
||||
throws InvalidParameterException {
|
||||
public void addStringParameter(final String flag, final boolean needed) {
|
||||
if (params.containsKey(flag)) {
|
||||
checkParam(flag, needed);
|
||||
return;
|
||||
@@ -150,11 +148,10 @@ public final class ParametrizedCommandData {
|
||||
* @param param the string parameter
|
||||
* @param needed if the parameter is needed
|
||||
* @throws InvalidParameterException if the new definition is invalid */
|
||||
private void checkParam(final String param, final boolean needed)
|
||||
throws InvalidParameterException {
|
||||
if (stringParams.containsKey(param)) {
|
||||
final Boolean need = Boolean
|
||||
.valueOf(needed || stringParams.get(param).booleanValue());
|
||||
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);
|
||||
params.put(param, need);
|
||||
return;
|
||||
@@ -162,14 +159,28 @@ public final class ParametrizedCommandData {
|
||||
throw new InvalidParameterException("Parameter is already defined as boolean"); //$NON-NLS-1$
|
||||
}
|
||||
|
||||
/** Retrieve the boolean parameters (aka flags).
|
||||
*
|
||||
* @return the set of boolean parameters */
|
||||
public Set<String> getBooleanParameters() {
|
||||
return Collections.unmodifiableSet(boolParams);
|
||||
}
|
||||
|
||||
/** Retrieve the parameter names.
|
||||
*
|
||||
* @return the stringParams */
|
||||
public Set<String> getParameters() {
|
||||
return params.keySet();
|
||||
}
|
||||
|
||||
/** Get the parameters from an input.
|
||||
*
|
||||
* @param input the input
|
||||
* @param args the command arguments
|
||||
* @return the command object
|
||||
* @throws IOException if the command could not be filled. */
|
||||
public final CommandParameters getParameters(final ConsoleInput input,
|
||||
final String... args) throws IOException {
|
||||
public CommandParameters getParameters(final ConsoleInput input, final String... args)
|
||||
throws IOException {
|
||||
final CommandParameters parameters = new CommandParameters(boolParams,
|
||||
stringParams.keySet(), strict);
|
||||
try {
|
||||
@@ -192,6 +203,29 @@ public final class ParametrizedCommandData {
|
||||
return parameters;
|
||||
}
|
||||
|
||||
/** Get the string parameters names.
|
||||
*
|
||||
* @return the stringParams */
|
||||
public Set<String> getStringParameters() {
|
||||
return stringParams.keySet();
|
||||
}
|
||||
|
||||
/** Test if a parameter is needed.
|
||||
*
|
||||
* @param param the parameter name
|
||||
* @return if the parameter is needed */
|
||||
public boolean isNeeded(final String param) {
|
||||
final Boolean val = params.get(param);
|
||||
return val != null && val.booleanValue();
|
||||
}
|
||||
|
||||
/** If the command refuse unrecognized parameters.
|
||||
*
|
||||
* @return the strict */
|
||||
public boolean isStrict() {
|
||||
return strict;
|
||||
}
|
||||
|
||||
/** Fill the undefined parameters.
|
||||
* <p>
|
||||
* This method prompts the user to fill the needed parameters.
|
||||
@@ -200,7 +234,7 @@ public final class ParametrizedCommandData {
|
||||
* @param parameters the parameter list to complete
|
||||
* @param toProvide the parameters to ask for
|
||||
* @throws IOException if the manager was closed */
|
||||
private final static void fillParameters(final ConsoleInput input,
|
||||
private static void fillParameters(final ConsoleInput input,
|
||||
final List<String> toProvide, final CommandParameters parameters)
|
||||
throws IOException {
|
||||
for (final String string : toProvide) {
|
||||
@@ -214,40 +248,4 @@ public final class ParametrizedCommandData {
|
||||
parameters.set(string, value);
|
||||
}
|
||||
}
|
||||
|
||||
/** Retrieve the boolean parameters (aka flags).
|
||||
*
|
||||
* @return the set of boolean parameters */
|
||||
public final Set<String> getBooleanParameters() {
|
||||
return Collections.unmodifiableSet(boolParams);
|
||||
}
|
||||
|
||||
/** Retrieve the parameter names.
|
||||
*
|
||||
* @return the stringParams */
|
||||
public final Set<String> getParameters() {
|
||||
return params.keySet();
|
||||
}
|
||||
|
||||
/** Get the string parameters names.
|
||||
*
|
||||
* @return the stringParams */
|
||||
public final Set<String> getStringParameters() {
|
||||
return stringParams.keySet();
|
||||
}
|
||||
|
||||
/** Test if a parameter is needed.
|
||||
*
|
||||
* @param param the parameter name
|
||||
* @return if the parameter is needed */
|
||||
public final boolean isNeeded(final String param) {
|
||||
return params.containsKey(param) && params.get(param).booleanValue();
|
||||
}
|
||||
|
||||
/** If the command refuse unrecognized parameters.
|
||||
*
|
||||
* @return the strict */
|
||||
public final boolean isStrict() {
|
||||
return strict;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -86,16 +86,15 @@ import net.bigeon.gclc.manager.ConsoleOutput;
|
||||
public final class SubedCommand extends CommandProvider implements ICommand {
|
||||
|
||||
/** The tab character. */
|
||||
private static final String TAB = "\t"; //$NON-NLS-1$
|
||||
/** The command to execute when this command is called with no sub
|
||||
* arguments.
|
||||
private static final String TAB = "\t"; //$NON-NLS-1$
|
||||
/** The command to execute when this command is called with no sub arguments.
|
||||
* <p>
|
||||
* This may be null, in which case the command should have arguments. */
|
||||
private final ICommand noArgCommand;
|
||||
private final ICommand noArgCommand;
|
||||
/** A tip on this command. */
|
||||
private final String tip;
|
||||
private final String tip;
|
||||
/** The name of the command. */
|
||||
private final String name;
|
||||
private final String name;
|
||||
|
||||
/** Create the command that defines sub commands.
|
||||
*
|
||||
@@ -111,7 +110,7 @@ public final class SubedCommand extends CommandProvider implements ICommand {
|
||||
*
|
||||
* @param name the name of the command
|
||||
* @param noArgCommand the command to execute when no extra parameter are
|
||||
* provided */
|
||||
* provided */
|
||||
public SubedCommand(final String name, final ICommand noArgCommand) {
|
||||
super();
|
||||
this.name = name;
|
||||
@@ -125,7 +124,7 @@ public final class SubedCommand extends CommandProvider implements ICommand {
|
||||
* @param noArgCommand the command to execute
|
||||
* @param tip the help tip associated */
|
||||
public SubedCommand(final String name, final ICommand noArgCommand,
|
||||
final String tip) {
|
||||
final String tip) {
|
||||
super();
|
||||
this.name = name;
|
||||
this.noArgCommand = noArgCommand;
|
||||
@@ -147,7 +146,7 @@ public final class SubedCommand extends CommandProvider implements ICommand {
|
||||
* @see fr.bigeon.acide.Command#execute(java.lang.String[]) */
|
||||
@Override
|
||||
public void execute(final ConsoleOutput output, final ConsoleInput input,
|
||||
final String... args) throws CommandRunException {
|
||||
final String... args) throws CommandRunException {
|
||||
if (args.length == 0 || args[0].startsWith("-")) { //$NON-NLS-1$
|
||||
if (noArgCommand != null) {
|
||||
noArgCommand.execute(output, input, args);
|
||||
@@ -176,15 +175,15 @@ public final class SubedCommand extends CommandProvider implements ICommand {
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.command.Command#help() */
|
||||
@Override
|
||||
public void help(final ConsoleOutput manager,
|
||||
final String... args) throws IOException {
|
||||
public void help(final ConsoleOutput manager, final String... args)
|
||||
throws IOException {
|
||||
if (args.length != 0 && !args[0].startsWith("-")) { //$NON-NLS-1$
|
||||
// Specific
|
||||
final ICommand c = get(args[0]);
|
||||
if (c != null) {
|
||||
c.help(manager, Arrays.copyOfRange(args, 1, args.length));
|
||||
} else {
|
||||
manager.println("No command "+Arrays.toString(args));
|
||||
manager.println("No command " + Arrays.toString(args));
|
||||
}
|
||||
} else {
|
||||
// Generic
|
||||
@@ -196,7 +195,7 @@ public final class SubedCommand extends CommandProvider implements ICommand {
|
||||
manager.println(TAB + cmd.getCommandName());
|
||||
} else {
|
||||
manager.println(TAB + cmd.getCommandName() + ": " + //$NON-NLS-1$
|
||||
cmd.tip());
|
||||
cmd.tip());
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
/*
|
||||
* GCLC swt, provide a swt window for console applications
|
||||
* Copyright (C) 2015-2017 E. Bigeon
|
||||
* ralph.runner, Runs RALPH (belongs to IREQ) in sequence for several days
|
||||
* Copyright (C) 2016-2018 E. Bigeon
|
||||
* mailto:emmanuel@bigeon.fr
|
||||
*
|
||||
* This software is governed by the CeCILL license under French law and
|
||||
@@ -30,16 +30,15 @@
|
||||
* knowledge of the CeCILL license and that you accept its terms.
|
||||
*/
|
||||
/**
|
||||
* gclc-swt:net.bigeon.gclc.swt.SWTConsoleShell.java
|
||||
* Created on: Apr 18, 2015
|
||||
*
|
||||
*/
|
||||
package net.bigeon.gclc.swt;
|
||||
package net.bigeon.gclc.command.base;
|
||||
|
||||
/*-
|
||||
* #%L
|
||||
* GCLC swt
|
||||
* Generic Command Ligne console
|
||||
* %%
|
||||
* Copyright (C) 2015 - 2018 Bigeon
|
||||
* 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,
|
||||
@@ -68,51 +67,67 @@ package net.bigeon.gclc.swt;
|
||||
* knowledge of the CeCILL license and that you accept its terms.
|
||||
* #L%
|
||||
*/
|
||||
import org.eclipse.swt.SWT;
|
||||
import org.eclipse.swt.layout.FillLayout;
|
||||
import org.eclipse.swt.widgets.Display;
|
||||
import org.eclipse.swt.widgets.Shell;
|
||||
import java.io.IOException;
|
||||
import java.text.MessageFormat;
|
||||
import java.util.Arrays;
|
||||
|
||||
/** A shell containing a {@link SWTConsole}
|
||||
import net.bigeon.gclc.command.Command;
|
||||
import net.bigeon.gclc.exception.CommandRunException;
|
||||
import net.bigeon.gclc.manager.ConsoleInput;
|
||||
import net.bigeon.gclc.manager.ConsoleOutput;
|
||||
|
||||
/** A command printing test to the console.
|
||||
* <p>
|
||||
* This command mimics the effect of the echo command in linux system. The
|
||||
* difference is this command accepts java like formatting.
|
||||
*
|
||||
* <pre>
|
||||
* echo.execute(out, in, "My Formatted {0}, with {1}", "message", "short arguments");
|
||||
* </pre>
|
||||
*
|
||||
* @author Emmanuel Bigeon */
|
||||
public final class SWTConsoleShell extends Shell {
|
||||
public class EchoCommand extends Command {
|
||||
|
||||
/** The console component */
|
||||
private SWTConsole console;
|
||||
|
||||
/** Create the shell.
|
||||
/** Create the command.
|
||||
*
|
||||
* @param display the display */
|
||||
public SWTConsoleShell(final Display display) {
|
||||
super(display, SWT.SHELL_TRIM);
|
||||
setLayout(new FillLayout(SWT.HORIZONTAL));
|
||||
|
||||
createContents();
|
||||
}
|
||||
|
||||
@Override
|
||||
protected void checkSubclass() {
|
||||
// Disable the check that prevents subclassing of SWT components
|
||||
}
|
||||
|
||||
/** Create contents of the shell. */
|
||||
protected void createContents() {
|
||||
console = new SWTConsole(this, SWT.NONE);
|
||||
setText("Console Application"); //$NON-NLS-1$
|
||||
* @param name the command name */
|
||||
public EchoCommand(final String name) {
|
||||
super(name);
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see org.eclipse.swt.widgets.Shell#dispose() */
|
||||
* @see
|
||||
* fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.manager.ConsoleOutput,
|
||||
* fr.bigeon.gclc.manager.ConsoleInput, java.lang.String[]) */
|
||||
@Override
|
||||
public void dispose() {
|
||||
super.dispose();
|
||||
console.close();
|
||||
public void execute(final ConsoleOutput out, final ConsoleInput in,
|
||||
final String... args) throws CommandRunException {
|
||||
try {
|
||||
if (args.length == 1) {
|
||||
out.print(args[0]);
|
||||
}
|
||||
if (args.length > 1) {
|
||||
out.print(MessageFormat.format(args[0],
|
||||
(Object[]) Arrays.copyOfRange(args, 1, args.length)));
|
||||
}
|
||||
out.println();
|
||||
} catch (final IOException e) {
|
||||
throw new CommandRunException("Printing failed", e);
|
||||
}
|
||||
}
|
||||
|
||||
/** @return the input and output. */
|
||||
public SWTConsole getManager() {
|
||||
return console;
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.command.ICommand#tip() */
|
||||
@Override
|
||||
public String tip() {
|
||||
return "Print the message";
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see fr.bigeon.gclc.command.Command#usageDetail() */
|
||||
@Override
|
||||
protected String usageDetail() {
|
||||
return "A formatted message can be used";
|
||||
}
|
||||
|
||||
}
|
||||
@@ -84,13 +84,13 @@ import net.bigeon.gclc.prompt.CLIPrompterMessages;
|
||||
* @author Emmanuel BIGEON */
|
||||
public class ExitCommand implements ICommand {
|
||||
/** The exit command manual message key. */
|
||||
private static final String EXIT_MAN = "exit.man"; //$NON-NLS-1$
|
||||
private static final String EXIT_MAN = "exit.man"; //$NON-NLS-1$
|
||||
/** The tip of the exit command. */
|
||||
private static final String EXIT = "exit.tip"; //$NON-NLS-1$
|
||||
private static final String EXIT = "exit.tip"; //$NON-NLS-1$
|
||||
/** The application that will be exited when this command runs. */
|
||||
private final ConsoleApplication app;
|
||||
/** The exit command name. */
|
||||
private final String name;
|
||||
private final String name;
|
||||
|
||||
/** Create the exiting command.
|
||||
*
|
||||
@@ -109,8 +109,8 @@ public class ExitCommand implements ICommand {
|
||||
}
|
||||
|
||||
@Override
|
||||
public final void execute(final ConsoleOutput output,
|
||||
final ConsoleInput input, final String... args) {
|
||||
public final void execute(final ConsoleOutput output, final ConsoleInput input,
|
||||
final String... args) {
|
||||
beforeExit();
|
||||
app.exit();
|
||||
}
|
||||
@@ -123,11 +123,11 @@ public class ExitCommand implements ICommand {
|
||||
}
|
||||
|
||||
@Override
|
||||
public final void help(final ConsoleOutput manager,
|
||||
final String... args) throws IOException {
|
||||
manager.println(
|
||||
CLIPrompterMessages.getString(EXIT_MAN, (Object[]) args));
|
||||
public final void help(final ConsoleOutput manager, final String... args)
|
||||
throws IOException {
|
||||
manager.println(CLIPrompterMessages.getString(EXIT_MAN, (Object[]) args));
|
||||
}
|
||||
|
||||
@Override
|
||||
public final String tip() {
|
||||
return CLIPrompterMessages.getString(EXIT);
|
||||
|
||||
@@ -36,7 +36,7 @@
|
||||
* gclc:net.bigeon.gclc.command.HelpExecutor.java
|
||||
* Created on: Sep 6, 2014
|
||||
*/
|
||||
package net.bigeon.gclc.command;
|
||||
package net.bigeon.gclc.command.base;
|
||||
|
||||
/*-
|
||||
* #%L
|
||||
@@ -73,6 +73,9 @@ package net.bigeon.gclc.command;
|
||||
*/
|
||||
import java.io.IOException;
|
||||
|
||||
import net.bigeon.gclc.command.Command;
|
||||
import net.bigeon.gclc.command.ICommand;
|
||||
import net.bigeon.gclc.command.SubedCommand;
|
||||
import net.bigeon.gclc.exception.CommandRunException;
|
||||
import net.bigeon.gclc.exception.CommandRunExceptionType;
|
||||
import net.bigeon.gclc.manager.ConsoleInput;
|
||||
@@ -93,8 +96,7 @@ public final class HelpExecutor extends Command {
|
||||
*
|
||||
* @param cmdName the command name
|
||||
* @param cmd the command to execute the help of */
|
||||
public HelpExecutor(final String cmdName,
|
||||
final ICommand cmd) {
|
||||
public HelpExecutor(final String cmdName, final ICommand cmd) {
|
||||
super(cmdName);
|
||||
this.cmd = cmd;
|
||||
}
|
||||
@@ -114,7 +116,7 @@ public final class HelpExecutor extends Command {
|
||||
* String[]) */
|
||||
@Override
|
||||
public void execute(final ConsoleOutput out, final ConsoleInput in,
|
||||
final String... args) throws CommandRunException {
|
||||
final String... args) throws CommandRunException {
|
||||
try {
|
||||
cmd.help(out, args);
|
||||
} catch (final IOException e) {
|
||||
@@ -131,8 +133,7 @@ public final class HelpExecutor extends Command {
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.command.Command#usageDetail()
|
||||
*/
|
||||
* @see net.bigeon.gclc.command.Command#usageDetail() */
|
||||
@Override
|
||||
protected String usageDetail() {
|
||||
return null;
|
||||
@@ -98,7 +98,7 @@ public final class MockCommand implements ICommand {
|
||||
* String[]) */
|
||||
@Override
|
||||
public void execute(final ConsoleOutput out, final ConsoleInput in,
|
||||
final String... args) {
|
||||
final String... args) {
|
||||
//
|
||||
}
|
||||
|
||||
@@ -113,8 +113,7 @@ public final class MockCommand implements ICommand {
|
||||
* @see net.bigeon.gclc.command.ICommand#help(net.bigeon.gclc.manager.
|
||||
* ConsoleManager, java.lang.String[]) */
|
||||
@Override
|
||||
public void help(final ConsoleOutput manager,
|
||||
final String... args) {
|
||||
public void help(final ConsoleOutput manager, final String... args) {
|
||||
//
|
||||
}
|
||||
|
||||
|
||||
@@ -72,10 +72,11 @@ package net.bigeon.gclc.command.base;
|
||||
* #L%
|
||||
*/
|
||||
import java.io.BufferedReader;
|
||||
import java.io.FileInputStream;
|
||||
import java.io.IOException;
|
||||
import java.io.InputStreamReader;
|
||||
import java.nio.charset.Charset;
|
||||
import java.nio.file.Files;
|
||||
import java.nio.file.Paths;
|
||||
import java.text.MessageFormat;
|
||||
import java.util.Arrays;
|
||||
import java.util.List;
|
||||
@@ -98,13 +99,16 @@ import net.bigeon.gclc.manager.ConsoleOutput;
|
||||
public final class ScriptExecution extends Command {
|
||||
|
||||
/** The tab character. */
|
||||
private static final String TAB = "\t"; //$NON-NLS-1$
|
||||
private static final String TAB = "\t"; //$NON-NLS-1$
|
||||
/** the space character. */
|
||||
private static final String SPACE = " "; //$NON-NLS-1$
|
||||
private static final String SPACE = " "; //$NON-NLS-1$
|
||||
|
||||
/** The application. */
|
||||
private final ConsoleApplication application;
|
||||
|
||||
/** The commenting prefix. */
|
||||
private final String commentPrefix;
|
||||
|
||||
/** The charset for files. */
|
||||
private final Charset charset;
|
||||
|
||||
@@ -115,40 +119,27 @@ public final class ScriptExecution extends Command {
|
||||
* @param commentPrefix the comment prefix in the script files
|
||||
* @param charset the charset to use for files */
|
||||
public ScriptExecution(final String name, final ConsoleApplication application,
|
||||
final String commentPrefix, final Charset charset) {
|
||||
final String commentPrefix, final Charset charset) {
|
||||
super(name);
|
||||
this.application = application;
|
||||
this.commentPrefix = commentPrefix;
|
||||
this.charset = charset;
|
||||
}
|
||||
|
||||
/** Check the arguments.
|
||||
*
|
||||
* @param args the arguments
|
||||
* @throws CommandRunException if the arguments were not the ones
|
||||
* expected */
|
||||
private static void checkArgs(final String[] args) throws CommandRunException {
|
||||
if (args.length == 0) {
|
||||
throw new CommandRunException(CommandRunExceptionType.USAGE,
|
||||
"Expecting a file"); //$NON-NLS-1$
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see net.bigeon.gclc.command.ICommand#execute(java.lang.String[]) */
|
||||
@Override
|
||||
public void execute(final ConsoleOutput out, final ConsoleInput in,
|
||||
final String... args) throws CommandRunException {
|
||||
final String... args) throws CommandRunException {
|
||||
checkArgs(args);
|
||||
final String scriptFile = args[0];
|
||||
final String[] params = Arrays.copyOfRange(args, 1, args.length);
|
||||
String cmd;
|
||||
int lineNo = -1;
|
||||
try (InputStreamReader fReader = new InputStreamReader(
|
||||
new FileInputStream(scriptFile), charset);
|
||||
BufferedReader reader = new BufferedReader(fReader)) {
|
||||
Files.newInputStream(Paths.get(scriptFile)), charset);
|
||||
BufferedReader reader = new BufferedReader(fReader)) {
|
||||
String[] emptyArray = new String[0];
|
||||
while ((cmd = reader.readLine()) != null) {
|
||||
lineNo++;
|
||||
final String cmdLine = readCommandLine(cmd, params);
|
||||
@@ -157,12 +148,12 @@ public final class ScriptExecution extends Command {
|
||||
}
|
||||
final List<String> ps = GCLCConstants.splitCommand(cmdLine);
|
||||
final String command = ps.remove(0);
|
||||
application.executeSub(out, in, command,
|
||||
ps.toArray(new String[0]));
|
||||
application.executeSub(out, in, command, ps.toArray(emptyArray));
|
||||
}
|
||||
} catch (final CommandParsingException e) {
|
||||
throw new CommandRunException(MessageFormat.format(
|
||||
"Invalid command in script ({0})", e.getLocalizedMessage()), //$NON-NLS-1$
|
||||
throw new CommandRunException(
|
||||
MessageFormat.format("Invalid command in script ({0})", //$NON-NLS-1$
|
||||
e.getLocalizedMessage()),
|
||||
e);
|
||||
} catch (final IOException e) {
|
||||
throw new CommandRunException("Unable to read script", //$NON-NLS-1$
|
||||
@@ -172,29 +163,14 @@ public final class ScriptExecution extends Command {
|
||||
}
|
||||
}
|
||||
|
||||
/** This method will create the correct exception. The exception source must
|
||||
* be this command.
|
||||
*
|
||||
* @param e the exception
|
||||
* @param lineNo the line nu;ber
|
||||
* @return the exception to actually throw */
|
||||
private static CommandRunException manageRunException(final CommandRunException e,
|
||||
final int lineNo) {
|
||||
return new CommandRunException(CommandRunExceptionType.EXECUTION,
|
||||
MessageFormat.format(
|
||||
"The script could not complete due to command failure at line {0} ({1})", //$NON-NLS-1$
|
||||
Integer.valueOf(lineNo), e.getLocalizedMessage()),
|
||||
e);
|
||||
}
|
||||
|
||||
/** Read a line of the script.
|
||||
*
|
||||
* @param cmd the line
|
||||
* @param params the formatting parameters
|
||||
* @return the command if it is indeed one, null otherwise
|
||||
* @throws CommandRunException if the line stqrted with a space character */
|
||||
private String readCommandLine(final String cmd,
|
||||
final Object[] params) throws CommandRunException {
|
||||
private String readCommandLine(final String cmd, final Object[] params)
|
||||
throws CommandRunException {
|
||||
if (cmd.startsWith(SPACE) || cmd.startsWith(TAB)) {
|
||||
throw new CommandRunException(
|
||||
"Invalid line in script (line starts with space character)");
|
||||
@@ -225,8 +201,7 @@ public final class ScriptExecution extends Command {
|
||||
builder.append(
|
||||
" The script file must contain one line commands. The lines must never"); //$NON-NLS-1$
|
||||
builder.append(System.lineSeparator());
|
||||
builder.append(
|
||||
"start with whitespace characters. The lines starting with"); //$NON-NLS-1$
|
||||
builder.append("start with whitespace characters. The lines starting with"); //$NON-NLS-1$
|
||||
builder.append(System.lineSeparator());
|
||||
builder.append('"');
|
||||
builder.append(commentPrefix);
|
||||
@@ -243,4 +218,30 @@ public final class ScriptExecution extends Command {
|
||||
return super.usagePattern() + " <scriptfile>"; //$NON-NLS-1$
|
||||
}
|
||||
|
||||
/** Check the arguments.
|
||||
*
|
||||
* @param args the arguments
|
||||
* @throws CommandRunException if the arguments were not the ones expected */
|
||||
private static void checkArgs(final String[] args) throws CommandRunException {
|
||||
if (args.length == 0) {
|
||||
throw new CommandRunException(CommandRunExceptionType.USAGE,
|
||||
"Expecting a file"); //$NON-NLS-1$
|
||||
}
|
||||
}
|
||||
|
||||
/** This method will create the correct exception. The exception source must be
|
||||
* this command.
|
||||
*
|
||||
* @param e the exception
|
||||
* @param lineNo the line nu;ber
|
||||
* @return the exception to actually throw */
|
||||
private static CommandRunException manageRunException(final CommandRunException e,
|
||||
final int lineNo) {
|
||||
return new CommandRunException(CommandRunExceptionType.EXECUTION,
|
||||
MessageFormat.format(
|
||||
"The script could not complete due to command failure at line {0} ({1})", //$NON-NLS-1$
|
||||
Integer.valueOf(lineNo), e.getLocalizedMessage()),
|
||||
e);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@@ -1,7 +1,4 @@
|
||||
/**
|
||||
* @author Emmanuel Bigeon
|
||||
*
|
||||
*/
|
||||
/** @author Emmanuel Bigeon */
|
||||
package net.bigeon.gclc.command.base;
|
||||
|
||||
/*-
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user