Add IMAPReply tests and documentation fixes

src/main/java/org/apache/commons/net/imap/AuthenticatingIMAPClient.java

@@ -38,11 +38,11 @@ public class AuthenticatingIMAPClient extends IMAPSClient {
      * The enumeration of currently-supported authentication methods.
      */
     public enum AUTH_METHOD {
-        /** The standarised (RFC4616) PLAIN method, which sends the password unencrypted (insecure). */
+        /** The standardised (RFC4616) PLAIN method, which sends the password unencrypted (insecure). */
         PLAIN("PLAIN"),
-        /** The standarised (RFC2195) CRAM-MD5 method, which doesn't send the password (secure). */
+        /** The standardised (RFC2195) CRAM-MD5 method, which doesn't send the password (secure). */
         CRAM_MD5("CRAM-MD5"),
-        /** The unstandarised Microsoft LOGIN method, which sends the password unencrypted (insecure). */
+        /** The unstandardised Microsoft LOGIN method, which sends the password unencrypted (insecure). */
         LOGIN("LOGIN"),
         /** XOAUTH */
         XOAUTH("XOAUTH"),

src/main/java/org/apache/commons/net/imap/IMAPReply.java

@@ -26,7 +26,6 @@
 /**
  * IMAPReply stores IMAP reply code constants.
  */
-
 public final class IMAPReply {
     /** The reply code indicating success of an operation. */
     public static final int OK = 0;
@@ -130,7 +129,7 @@ public static boolean isContinuation(final int replyCode) {
      * Checks if the reply line is a continuation, i.e. starts with "+"
      *
      * @param line the line to be checked
-     * @return {@code true} if the line is untagged
+     * @return {@code true} if the line is a continuation
      */
     public static boolean isContinuation(final String line) {
         return line.startsWith(IMAP_CONTINUATION_PREFIX);
@@ -160,7 +159,6 @@ public static boolean isUntagged(final String line) {
      * Checks if the line introduces a literal, i.e. ends with {dd}
      *
      * @param line the line to check
-     *
      * @return the literal count, or -1 if there was no literal.
      */
     public static int literalCount(final String line) {

src/test/java/org/apache/commons/net/imap/IMAPReplyTest.java

@@ -0,0 +1,156 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.commons.net.imap;
+
+import org.apache.commons.net.MalformedServerReplyException;
+import org.junit.jupiter.api.Test;
+
+import java.io.IOException;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+public class IMAPReplyTest {
+
+    @Test
+    public void getReplyCodeMalformedLine() {
+        final String malformedTaggedLine = "A064 FOO-BAR 0";
+        final MalformedServerReplyException replyException = assertThrows(MalformedServerReplyException.class, () -> IMAPReply.getReplyCode(malformedTaggedLine));
+        assertEquals("Received unexpected IMAP protocol response from server: 'A064 FOO-BAR 0'.", replyException.getMessage());
+    }
+
+    @Test
+    public void getReplyCodeContinuationLine() throws IOException {
+        final String continuationLine = "+ Ready for additional command text";
+        assertEquals(IMAPReply.CONT, IMAPReply.getReplyCode(continuationLine));
+    }
+
+    @Test
+    public void getReplyCodeOkLine() throws IOException {
+        final String okLine = "A001 OK LOGIN completed";
+        assertEquals(IMAPReply.OK, IMAPReply.getReplyCode(okLine));
+    }
+
+    @Test
+    public void getReplyCodeBadLine() throws IOException {
+        final String badLine = "A044 BAD No such command as \"FOOBAR\"";
+        assertEquals(IMAPReply.BAD, IMAPReply.getReplyCode(badLine));
+    }
+
+    @Test
+    public void getReplyCodeNoLine() throws IOException {
+        final String noLine = "A223 NO COPY failed: disk is full";
+        assertEquals(IMAPReply.NO, IMAPReply.getReplyCode(noLine));
+    }
+
+    @Test
+    public void getUntaggedReplyCodeMalformedLine() {
+        // invalid experimental comm response (missing X prefix)
+        final String malformedUntaggedLine = "* FOO-BAR hello-world";
+        final MalformedServerReplyException replyException = assertThrows(MalformedServerReplyException.class, () -> IMAPReply.getUntaggedReplyCode(malformedUntaggedLine));
+        assertEquals("Received unexpected IMAP protocol response from server: '* FOO-BAR hello-world'.", replyException.getMessage());
+    }
+
+    @Test
+    public void getUntaggedReplyCodeContinuationLine() throws IOException {
+        final String continuationLine = "+ Ready for additional command text";
+        assertEquals(IMAPReply.CONT, IMAPReply.getUntaggedReplyCode(continuationLine));
+    }
+
+    @Test
+    public void getUntaggedReplyCodeOkLine() throws IOException {
+        final String okLine = "* OK Salvage successful, no data lost";
+        assertEquals(IMAPReply.OK, IMAPReply.getUntaggedReplyCode(okLine));
+    }
+
+    @Test
+    public void getUntaggedReplyCodeBadLine() throws IOException {
+        final String badLine = "* BAD Empty command line";
+        assertEquals(IMAPReply.BAD, IMAPReply.getUntaggedReplyCode(badLine));
+    }
+
+    @Test
+    public void getUntaggedReplyCodeNoLine() throws IOException {
+        final String noLine = "* NO Disk is 98% full, please delete unnecessary data";
+        assertEquals(IMAPReply.NO, IMAPReply.getUntaggedReplyCode(noLine));
+    }
+
+    @Test
+    public void isContinuationReplyCode() {
+        final int replyCode = 3;
+        assertTrue(IMAPReply.isContinuation(replyCode));
+    }
+
+    @Test
+    public void isContinuationReplyCodeInvalidCode() {
+        final int invalidContinuationReplyCode = 1;
+        assertFalse(IMAPReply.isContinuation(invalidContinuationReplyCode));
+    }
+
+    @Test
+    public void isContinuationReplyLine() {
+        final String replyLine = "+FLAGS completed";
+        assertTrue(IMAPReply.isContinuation(replyLine));
+    }
+
+    @Test
+    public void isContinuationReplyLineInvalidLine() {
+        final String invalidContinuationReplyLine = "* 22 EXPUNGE";
+        assertFalse(IMAPReply.isContinuation(invalidContinuationReplyLine));
+    }
+
+    @Test
+    public void isSuccessReplyCode() {
+        final int successfulReplyCode = 0;
+        assertTrue(IMAPReply.isSuccess(successfulReplyCode));
+    }
+
+    @Test
+    public void isSuccessReplyCodeUnsuccessfulCode() {
+        final int unsuccessfulReplyCode = 2;
+        assertFalse(IMAPReply.isSuccess(unsuccessfulReplyCode));
+    }
+
+    @Test
+    public void isUntaggedReplyLine() {
+        final String replyLine = "* 18 EXISTS";
+        assertTrue(IMAPReply.isUntagged(replyLine));
+    }
+
+    @Test
+    public void isUntaggedReplyLineInvalidLine() {
+        final String taggedLine = "a001 OK LOGOUT completed";
+        assertFalse(IMAPReply.isUntagged(taggedLine));
+    }
+
+    @Test
+    public void literalCount() {
+        final int literal = 342;
+        final String replyLine = String.format("* 12 FETCH (BODY[HEADER] {%s}", literal);
+        assertEquals(literal, IMAPReply.literalCount(replyLine));
+    }
+
+    @Test
+    public void literalCountInvalid() {
+        final String replyLine = "STORE +FLAGS.SILENT \\DELETED {";
+        assertEquals(-1, IMAPReply.literalCount(replyLine));
+    }
+
+}

src/test/java/org/apache/commons/net/imap/IMAPTest.java

@@ -17,8 +17,10 @@
 
 package org.apache.commons.net.imap;
 
-import org.junit.Assert;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 public class IMAPTest {
 
@@ -43,7 +45,7 @@ public void checkGenerator() {
                 break;
             }
         }
-        Assert.assertEquals(expected, i);
-        Assert.assertTrue("Expected to see the original value again", matched);
+        assertEquals(expected, i);
+        assertTrue(matched, "Expected to see the original value again");
     }
 }