[maven-release-plugin] prepare release gclc-1.3.4

Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>

gclc-socket/pom.xml

@@ -70,7 +70,7 @@ of Emmanuel Bigeon.                                                   -->
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <artifactId>gclc-socket</artifactId>
-  <version>1.1.5-SNAPSHOT</version>
+  <version>1.1.7-SNAPSHOT</version>
   <packaging>jar</packaging>
   <url>http://www.bigeon.fr/emmanuel</url>
   <properties>
@@ -78,16 +78,10 @@ of Emmanuel Bigeon.                                                   -->
     <project.scm.id>git.bigeon.net</project.scm.id>
   </properties>
   <dependencies>
-    <dependency>
-      <groupId>junit</groupId>
-      <artifactId>junit</artifactId>
-      <version>4.11</version>
-      <scope>test</scope>
-    </dependency>
     <dependency>
     	<groupId>fr.bigeon</groupId>
     	<artifactId>gclc</artifactId>
-    	<version>1.3.3-SNAPSHOT</version>
+    	<version>1.3.4-SNAPSHOT</version>
     </dependency>
     <dependency>
     	<groupId>fr.bigeon</groupId>

gclc-socket/src/main/java/fr/bigeon/gclc/socket/SocketConsoleApplicationShell.java

@@ -95,12 +95,11 @@ public class SocketConsoleApplicationShell implements Runnable, AutoCloseable {
         @Override
         public void run() {
             try {
-                while (!socket.isOutputShutdown()) {
-                    while (!socket.isOutputShutdown() &&
-                           !consoleManager.available()) {
+                while (!socket.isClosed()) {
+                    while (!socket.isClosed() && !consoleManager.available()) {
                         waitASec();
                     }
-                    if (socket.isOutputShutdown()) {
+                    if (socket.isClosed()) {
                         return;
                     }
                     String m = consoleManager.readNextLine();
@@ -192,7 +191,8 @@ public class SocketConsoleApplicationShell implements Runnable, AutoCloseable {
             // Create the streams
             runSokectServer();
         } catch (final IOException e) {
-            LOGGER.log(Level.SEVERE,
+            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$
         }
     }
@@ -229,12 +229,20 @@ public class SocketConsoleApplicationShell implements Runnable, AutoCloseable {
                 LOGGER.log(Level.FINE,
                         "Socket closed with exception (probably due to server interruption)", //$NON-NLS-1$
                         e);
+            } catch (IOException e) {
+                throw e;
             }
             LOGGER.info("Closing client"); //$NON-NLS-1$
         }
         runnable.setRunning(false);
-        consoleManager.type(applicationShutdown);
-        consoleManager.close();
+        try {
+            consoleManager.type(applicationShutdown);
+            consoleManager.close();
+        } catch (IOException e) {
+            LOGGER.warning("Unable to close application correctly"); //$NON-NLS-1$
+            LOGGER.log(Level.FINE, "Application closing caused an exception", //$NON-NLS-1$
+                    e);
+        }
         LOGGER.info("Closing Server"); //$NON-NLS-1$
     }
 
@@ -263,43 +271,46 @@ public class SocketConsoleApplicationShell implements Runnable, AutoCloseable {
         Thread th = new Thread(cc, "ClientComm"); //$NON-NLS-1$
         th.start();
         if (autoClose) {
-            communicateOnce(socket, in);
+            communicateOnce(in);
         } else {
-            communicateLoop(socket, in);
-
+            communicateLoop(in);
         }
     }
 
-    /** @param socket the socket
-     * @param in the input from the client
+    /** @param in the input from the client
      * @throws IOException if the communication failed */
-    private void communicateOnce(Socket socket,
-                                 BufferedReader in) throws IOException {
+    private void communicateOnce(BufferedReader in) throws IOException {
         ReadingRunnable reading = new ReadingRunnable(in);
         Thread th = new Thread(reading, "gclcToApp"); //$NON-NLS-1$
         th.start();
         communicationContent(reading);
-        reading.setRunning(false);
-        socket.shutdownOutput();
+        doEndCommunication(reading);
     }
 
-    /** @param socket the socket
-     * @param in the input from the client
+    /** @param reading the reading runnable
+     * @throws IOException if the end of communication failed */
+    private void doEndCommunication(ReadingRunnable reading) throws IOException {
+        reading.setRunning(false);
+        Thread wait = consoleManager.getWaitForDelivery("Bye."); //$NON-NLS-1$
+        consoleManager.println("Bye."); //$NON-NLS-1$
+        try {
+            wait.join();
+        } catch (InterruptedException e) {
+            LOGGER.warning("The Bye wait was interrupted."); //$NON-NLS-1$
+            LOGGER.log(Level.FINE, "An interruption occured", e); //$NON-NLS-1$
+        }
+    }
+
+    /** @param in the input from the client
      * @throws IOException if the communication failed */
-    private void communicateLoop(Socket socket,
-                                 BufferedReader in) throws IOException {
+    private void communicateLoop(BufferedReader in) throws IOException {
         ReadingRunnable reading = new ReadingRunnable(in);
         Thread th = new Thread(reading, "gclcToApp"); //$NON-NLS-1$
         th.start();
         while (app.isRunning() && communicationContent(reading)) {
             // keep on going
         }
-        reading.setRunning(false);
-        while (consoleManager.available()) {
-            waitASec();
-        }
-        socket.shutdownOutput();
-
+        doEndCommunication(reading);
     }
 
     /** @param reading the reading
@@ -322,14 +333,6 @@ public class SocketConsoleApplicationShell implements Runnable, AutoCloseable {
         }
         String ln = reading.getMessage();
         if (ln.equals(close)) {
-            Thread wait = consoleManager.getWaitForDelivery("Bye."); //$NON-NLS-1$
-            consoleManager.println("Bye."); //$NON-NLS-1$
-            try {
-                wait.join();
-            } catch (InterruptedException e) {
-                LOGGER.warning("The Bye wait was interrupted."); //$NON-NLS-1$
-                LOGGER.log(Level.FINE, "An interruption occured", e); //$NON-NLS-1$
-            }
             return false;
         }
         // Pass command to application

gclc-socket/src/test/java/fr/bigeon/gclc/socket/SocketConsoleApplicationTest.java

@@ -89,17 +89,10 @@ public class SocketConsoleApplicationTest {
             String[] cmds = {"help", "toto", "test", "bye"};
             while ((fromServer = in.readLine()) != null) {
                 i++;
-                LOGGER.fine("Server: \n" + fromServer);
-                if (fromServer.equals("Bye.")) {
+                fromServer = consumeToPrompt(fromServer, in);
+                if (fromServer == null || fromServer.equals("Bye.")) {
                     break;
                 }
-                while (fromServer != null && !fromServer.equals("> ")) {
-                    fromServer = in.readLine();
-                    LOGGER.fine("Server: \n" + fromServer);
-                }
-                if (fromServer == null) {
-                    fail("Null pointer");
-                }
 
                 final String fromUser = cmds[i];
                 if (fromUser != null) {
@@ -123,19 +116,15 @@ public class SocketConsoleApplicationTest {
             String[] cmds = {"help", "toto", "test",
                     ConsoleTestApplication.EXIT};
             while ((fromServer = in.readLine()) != null) {
-                LOGGER.fine("Server: \n" + fromServer);
-                while (fromServer != null && !fromServer.equals("> ")) {
-                    LOGGER.fine("Server: \n" + fromServer);
-                    fromServer = in.readLine();
-                }
-                if (fromServer == null) {
+                fromServer = consumeToPrompt(fromServer, in);
+                if (fromServer == null || fromServer.equals("Bye.")) {
                     break;
                 }
-                LOGGER.fine("Server: \n" + fromServer);
+                LOGGER.info("Server: \n" + fromServer);
 
                 final String fromUser = cmds[i];
                 if (fromUser != null) {
-                    LOGGER.fine("Client: " + fromUser);
+                    LOGGER.info("Client: " + fromUser);
                     out.println(fromUser);
                 }
                 i++;
@@ -161,11 +150,8 @@ public class SocketConsoleApplicationTest {
             String[] cmds = {"help", "toto", "test",
                     ConsoleTestApplication.EXIT};
             while ((fromServer = in.readLine()) != null) {
-                while (fromServer != null && !fromServer.equals("> ")) {
-                    fromServer = in.readLine();
-                    LOGGER.fine("Server: \n" + fromServer);
-                }
-                if (fromServer == null) {
+                fromServer = consumeToPrompt(fromServer, in);
+                if (fromServer == null || fromServer.equals("Bye.")) {
                     break;
                 }
 
@@ -207,17 +193,11 @@ public class SocketConsoleApplicationTest {
             int i = 0;
             String[] cmds = {"help", "test", "close"};
             while ((fromServer = in.readLine()) != null) {
-                assertTrue(i < 1);
-                while (fromServer != null && !fromServer.equals("> ") &&
-                       !fromServer.equals("See you")) {
-                    fromServer = in.readLine();
-                    LOGGER.fine("Server: \n" + fromServer);
-                }
-                if (fromServer == null || fromServer.equals("Bye.") ||
-                    fromServer.equals("See you")) {
+                fromServer = consumeToPrompt(fromServer, in);
+                if (fromServer == null || fromServer.equals("Bye.")) {
                     break;
                 }
-
+                assertTrue(i < 1);
                 final String fromUser = cmds[i];
                 if (fromUser != null) {
                     LOGGER.fine("Client: " + fromUser);
@@ -243,4 +223,19 @@ public class SocketConsoleApplicationTest {
             e.printStackTrace();
         }
     }
+
+    /** @param in the input
+     * @return the string
+     * @throws IOException if the input reading failed */
+    private String consumeToPrompt(String server,
+                                   BufferedReader in) throws IOException {
+        String fromServer = server;
+        LOGGER.fine("Server: \n" + fromServer);
+        while (fromServer != null && !fromServer.equals("Bye.") &&
+               !fromServer.equals("> ")) {
+            fromServer = in.readLine();
+            LOGGER.fine("Server: \n" + fromServer);
+        }
+        return fromServer;
+    }
 }

gclc-swt/pom.xml

@@ -51,7 +51,7 @@
     <dependency>
       <groupId>fr.bigeon</groupId>
       <artifactId>gclc</artifactId>
-      <version>1.3.2</version>
+      <version>1.3.4-SNAPSHOT</version>
     </dependency>
     <dependency>
       <groupId>fr.bigeon</groupId>

gclc/pom.xml

@@ -35,7 +35,7 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 	<artifactId>gclc</artifactId>
-	<version>1.3.3</version>
+	<version>1.3.4</version>
 	<packaging>jar</packaging>
 	<url>http://www.bigeon.fr/emmanuel</url>
 	<properties>
@@ -83,6 +83,6 @@
   <scm>
   
     <developerConnection>scm:git:gogs@git.code.bigeon.net:emmanuel/gclc.git</developerConnection>
-	<tag>gclc-1.3.3</tag>
+	<tag>gclc-1.3.4</tag>
   </scm>
 </project>

gclc/src/main/java/fr/bigeon/gclc/command/ParametrizedCommand.java

@@ -167,7 +167,8 @@ public abstract class ParametrizedCommand extends Command {
     /** @param param the parameter
      * @param stringParameter the string parameter type
      * @param needed if the parameter is needed
-     * @throws InvalidParameterException if the new definition is invalid */
+     * @throws InvalidParameterException if the new definition is invalid
+     * @deprecated since 1.3.3 */
     @Deprecated
     private void checkParam(String param, boolean stringParameter,
                             boolean needed) throws InvalidParameterException {

gclc/src/main/java/fr/bigeon/gclc/manager/ReadingRunnable.java

@@ -53,6 +53,61 @@ import java.util.logging.Logger;
  * @author Emmanuel Bigeon */
 public class ReadingRunnable implements Runnable {
 
+    /** The runnable to wait for notification on an object
+     *
+     * @author Emmanuel Bigeon */
+    private final class ToWaitRunnable implements Runnable {
+        /** The Object */
+        private final Object obj;
+        /** The locking object */
+        private final Object start;
+        /** The message */
+        private final String message;
+        /** The started status */
+        private boolean started = false;
+
+        /** @param obj the object to lock on
+         * @param start the object to notify when ready to wait
+         * @param message the message to wait for */
+        public ToWaitRunnable(Object obj, Object start,
+                String message) {
+            this.obj = obj;
+            this.start = start;
+            this.message = message;
+        }
+
+        @SuppressWarnings("synthetic-access")
+        @Override
+        public void run() {
+            synchronized (obj) {
+                synchronized (start) {
+                    started = true;
+                    start.notify();
+                }
+                while (isRunning()) {
+                    try {
+                        obj.wait();
+                        if (delivering.equals(message)) {
+                            return;
+                        }
+                    } catch (InterruptedException e) {
+                        LOGGER.log(Level.SEVERE,
+                                THREAD_INTERRUPTION_EXCEPTION, e); 
+                    }
+                }
+            }
+        }
+
+        /** @return the started */
+        public boolean isStarted() {
+            synchronized (start) {
+                return started;
+            }
+        }
+    }
+
+    /** The thread intteruption logging message */
+    private static final String THREAD_INTERRUPTION_EXCEPTION = "Thread interruption exception."; //$NON-NLS-1$
     /** The closed pipe message */
     private static final String CLOSED_PIPE = "Closed pipe"; //$NON-NLS-1$
     /** Wait timeout */
@@ -79,6 +134,7 @@ public class ReadingRunnable implements Runnable {
      * The lock
      */
     private final Object messageBlockerLock = new Object();
+    /** The message being delivered */
     private String delivering;
 
     /** @param reader the input to read from */
@@ -146,7 +202,7 @@ public class ReadingRunnable implements Runnable {
                 try {
                     lock.wait(TIMEOUT);
                 } catch (InterruptedException e) {
-                    LOGGER.log(Level.SEVERE, "Thread interruption exception.", //$NON-NLS-1$
+                    LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION, 
                             e);
                 }
                 if (messages.isEmpty() && !running) {
@@ -218,36 +274,18 @@ public class ReadingRunnable implements Runnable {
             }
             final Object obj = messageBlocker.get(message);
             final Object start = new Object();
-            Thread th = new Thread(new Runnable() {
-    
-                @SuppressWarnings("synthetic-access")
-                @Override
-                public void run() {
-                    synchronized (obj) {
-                        synchronized (start) {
-                            start.notify();
-                        }
-                        while (isRunning()) {
-                            try {
-                                obj.wait();
-                                if (delivering.equals(message)) {
-                                    return;
-                                }
-                            } catch (InterruptedException e) {
-                                LOGGER.log(Level.SEVERE,
-                                        "Thread interruption exception.", e); //$NON-NLS-1$
-                            }
-                        }
-                    }
-                }
-            });
+            ToWaitRunnable waitRunn = new ToWaitRunnable(obj, start, message);
+            Thread th = new Thread(waitRunn);
+
             synchronized (start) {
                 th.start();
-                try {
-                    start.wait();
-                } catch (InterruptedException e) {
-                    LOGGER.log(Level.SEVERE, "Thread interruption exception.", //$NON-NLS-1$
-                            e);
+                while (!waitRunn.isStarted()) {
+                    try {
+                        start.wait(TIMEOUT);
+                    } catch (InterruptedException e) {
+                        LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION, 
+                                e);
+                    }
                 }
             }
             return th;

gclc/src/test/java/fr/bigeon/gclc/manager/ReadingRunnableTest.java

@@ -0,0 +1,149 @@
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software.  You can  use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and  rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty  and the software's author,  the holder of the
+ * economic rights,  and the successive licensors  have only  limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading,  using,  modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean  that it is complicated to manipulate,  and  that  also
+ * therefore means  that it is reserved for developers  and  experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and,  more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.manager.ReadingRunnableTest.java
+ * Created on: Dec 6, 2016
+ */
+package fr.bigeon.gclc.manager;
+
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
+import static org.junit.Assert.fail;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.io.PipedInputStream;
+import java.io.PipedOutputStream;
+
+import org.junit.Before;
+import org.junit.Test;
+
+/** <p>
+ * TODO
+ *
+ * @author Emmanuel Bigeon */
+public class ReadingRunnableTest {
+
+    /**
+     */
+    @Before
+    public void setUp() {}
+
+    /** Test method for
+     * {@link fr.bigeon.gclc.manager.ReadingRunnable#getMessage()}. */
+    @Test
+    public final void testGetMessage() {
+        BufferedReader reader = null;
+        ReadingRunnable runnable = new ReadingRunnable(reader);
+        runnable.setRunning(false);
+
+        try {
+            runnable.getMessage();
+            fail("reading from closed runnable");
+        } catch (IOException e) {
+            assertNotNull(e);
+        }
+
+    }
+
+    /** Test method for
+     * {@link fr.bigeon.gclc.manager.ReadingRunnable#hasMessage()}. */
+    @Test
+    public final void testHasMessage() {
+
+        BufferedReader reader = null;
+        ReadingRunnable runnable = new ReadingRunnable(reader);
+        runnable.setRunning(false);
+
+        try {
+            runnable.getMessage();
+            fail("reading from closed runnable");
+        } catch (IOException e) {
+            assertNotNull(e);
+        }
+    }
+
+    /** Test method for
+     * {@link fr.bigeon.gclc.manager.ReadingRunnable#getWaitForDelivery(java.lang.String)}.
+     * 
+     * @throws InterruptedException */
+    @Test
+    public final void testGetWaitForDelivery() throws InterruptedException {
+        try (PipedOutputStream out = new PipedOutputStream();
+             InputStream piped = new PipedInputStream(out);
+             BufferedReader reader = new BufferedReader(
+                     new InputStreamReader(piped, "UTF-8"))) {
+            final ReadingRunnable runnable = new ReadingRunnable(reader);
+            Thread th0 = new Thread(runnable, "read");
+            th0.start();
+            Thread th = runnable.getWaitForDelivery("");
+
+            final Object start = new Object();
+
+            Thread th2 = new Thread(new Runnable() {
+
+                @Override
+                public void run() {
+                    synchronized (start) {
+                        start.notify();
+                    }
+                    try {
+                        runnable.getMessage();
+                    } catch (IOException e) {
+                        // TODO Auto-generated catch block
+                        e.printStackTrace();
+                    }
+                }
+            }, "get");
+            synchronized (start) {
+                th2.start();
+                start.wait();
+            }
+            runnable.interrupt();
+            try {
+                th.join();
+            } catch (InterruptedException e) {
+                assertNull(e);
+            }
+            runnable.setRunning(false);
+            out.close();
+        } catch (IOException e1) {
+            assertNull(e1);
+        }
+    }
+
+}