[gmime] Added more unit tests for quoted-printable

[Rico Tzschichholz <ricotz src gnome org>]

commit 2dd1be81555d787ff1ff03b11e5cb4b9e81630d6
Author: Jeffrey Stedfast <jestedfa microsoft com>
Date:   Sun Nov 25 20:11:27 2018 -0500

    Added more unit tests for quoted-printable

 gmime/gmime-encodings.c           |   9 +-
 tests/data/encodings/wikipedia.qp |   1 -
 tests/test-encodings.c            | 232 ++++++++++++++++++++++++++++++++------
 3 files changed, 198 insertions(+), 44 deletions(-)
---
diff --git a/gmime/gmime-encodings.c b/gmime/gmime-encodings.c
index 4ef19dd2..4fa94b66 100644
--- a/gmime/gmime-encodings.c
+++ b/gmime/gmime-encodings.c
@@ -896,8 +896,7 @@ g_mime_encoding_quoted_encode_close (const unsigned char *inbuf, size_t inlen, u
        
        last = *state;
        if (last != -1) {
-               /* space/tab must be encoded if its the last character on
-                  the line */
+               /* space/tab must be encoded if its the last character on the line */
                if (is_qpsafe (last) && !is_blank (last)) {
                        *outptr++ = last;
                } else {
@@ -905,17 +904,15 @@ g_mime_encoding_quoted_encode_close (const unsigned char *inbuf, size_t inlen, u
                        *outptr++ = tohex[(last >> 4) & 0xf];
                        *outptr++ = tohex[last & 0xf];
                }
-       }
-       
-       if (last != '\n') {
+               
                /* we end with =\n so that the \n isn't interpreted as a real
                   \n when it gets decoded later */
                *outptr++ = '=';
                *outptr++ = '\n';
+               *state = -1;
        }
        
        *save = 0;
-       *state = -1;
        
        return (outptr - outbuf);
 }
diff --git a/tests/data/encodings/wikipedia.qp b/tests/data/encodings/wikipedia.qp
index 847a3959..42e05f4a 100644
--- a/tests/data/encodings/wikipedia.qp
+++ b/tests/data/encodings/wikipedia.qp
@@ -3,4 +3,3 @@ vite p=C3=A9dagogues et t'enseignent comme but ce qui n'est par essence qu'=
 un moyen, et te trompant ainsi sur la route =C3=A0 suivre les voil=C3=A0 bi=
 ent=C3=B4t qui te d=C3=A9gradent, car si leur musique est vulgaire ils te f=
 abriquent pour te la vendre une =C3=A2me vulgaire.
-=
diff --git a/tests/test-encodings.c b/tests/test-encodings.c
index c2f06c39..8697edb4 100644
--- a/tests/test-encodings.c
+++ b/tests/test-encodings.c
@@ -40,6 +40,43 @@ extern int verbose;
 #define d(x)
 #define v(x) if (verbose > 3) x
 
+static struct _mapping {
+       const char *name;
+       const char *text;
+       GMimeContentEncoding encoding;
+} mappings[] = {
+       { "\"7bit\"", "7bit", GMIME_CONTENT_ENCODING_7BIT },
+       { "\"7-bit\"", "7-bit", GMIME_CONTENT_ENCODING_7BIT },
+       { "\"8bit\"", "8bit", GMIME_CONTENT_ENCODING_8BIT },
+       { "\"8-bit\"", "8-bit", GMIME_CONTENT_ENCODING_8BIT },
+       { "\"binary\"", "binary", GMIME_CONTENT_ENCODING_BINARY },
+       { "\"base64\"", "base64", GMIME_CONTENT_ENCODING_BASE64 },
+       { "\"quoted-printable\"", "quoted-printable", GMIME_CONTENT_ENCODING_QUOTEDPRINTABLE },
+       { "\"uuencode\"", "uuencode", GMIME_CONTENT_ENCODING_UUENCODE },
+       { "\"x-uuencode\"", "x-uuencode", GMIME_CONTENT_ENCODING_UUENCODE },
+       { "\"x-uue\"", "x-uue", GMIME_CONTENT_ENCODING_UUENCODE },
+       { "\"garbage\"", "garbage", GMIME_CONTENT_ENCODING_DEFAULT },
+       { "\" 7bit \"", " 7bit ", GMIME_CONTENT_ENCODING_7BIT }
+};
+
+static void
+test_content_encoding_mappings (void)
+{
+       GMimeContentEncoding encoding;
+       guint i;
+       
+       for (i = 0; i < G_N_ELEMENTS (mappings); i++) {
+               testsuite_check ("%s", mappings[i].name);
+               encoding = g_mime_content_encoding_from_string (mappings[i].text);
+               if (encoding != mappings[i].encoding)
+                       testsuite_check_failed ("failed: expected: %s; was: %s",
+                                               g_mime_content_encoding_to_string (mappings[i].encoding),
+                                               g_mime_content_encoding_to_string (encoding));
+               else
+                       testsuite_check_passed ();
+       }
+}
+
 static const char *base64_encoded_patterns[] = {
        "VGhpcyBpcyB0aGUgcGxhaW4gdGV4dCBtZXNzYWdlIQ==",
        "VGhpcyBpcyBhIHRleHQgd2hpY2ggaGFzIHRvIGJlIHBhZGRlZCBvbmNlLi4=",
@@ -82,43 +119,6 @@ static const char *base64_encoded_long_patterns[] = {
        "fo6err7O3u7/Dx8vP09fb3+Pn6+/z9/v8AAQ=="
 };
 
-static struct _mapping {
-       const char *name;
-       const char *text;
-       GMimeContentEncoding encoding;
-} mappings[] = {
-       { "\"7bit\"", "7bit", GMIME_CONTENT_ENCODING_7BIT },
-       { "\"7-bit\"", "7-bit", GMIME_CONTENT_ENCODING_7BIT },
-       { "\"8bit\"", "8bit", GMIME_CONTENT_ENCODING_8BIT },
-       { "\"8-bit\"", "8-bit", GMIME_CONTENT_ENCODING_8BIT },
-       { "\"binary\"", "binary", GMIME_CONTENT_ENCODING_BINARY },
-       { "\"base64\"", "base64", GMIME_CONTENT_ENCODING_BASE64 },
-       { "\"quoted-printable\"", "quoted-printable", GMIME_CONTENT_ENCODING_QUOTEDPRINTABLE },
-       { "\"uuencode\"", "uuencode", GMIME_CONTENT_ENCODING_UUENCODE },
-       { "\"x-uuencode\"", "x-uuencode", GMIME_CONTENT_ENCODING_UUENCODE },
-       { "\"x-uue\"", "x-uue", GMIME_CONTENT_ENCODING_UUENCODE },
-       { "\"garbage\"", "garbage", GMIME_CONTENT_ENCODING_DEFAULT },
-       { "\" 7bit \"", " 7bit ", GMIME_CONTENT_ENCODING_7BIT }
-};
-
-static void
-test_content_encoding_mappings (void)
-{
-       GMimeContentEncoding encoding;
-       guint i;
-       
-       for (i = 0; i < G_N_ELEMENTS (mappings); i++) {
-               testsuite_check ("%s", mappings[i].name);
-               encoding = g_mime_content_encoding_from_string (mappings[i].text);
-               if (encoding != mappings[i].encoding)
-                       testsuite_check_failed ("failed: expected: %s; was: %s",
-                                               g_mime_content_encoding_to_string (mappings[i].encoding),
-                                               g_mime_content_encoding_to_string (encoding));
-               else
-                       testsuite_check_passed ();
-       }
-}
-
 static void
 test_base64_decode_patterns (void)
 {
@@ -173,6 +173,159 @@ test_base64_decode_patterns (void)
        }
 }
 
+static const char *qp_encoded_patterns[] = {
+       "=e1=e2=E3=E4\r\n",
+       "=e1=g2=E3=E4\r\n",
+       "=e1=eg=E3=E4\r\n",
+       "   =e1 =e2  =E3\t=E4  \t \t    \r\n",
+       "Soft line=\r\n\tHard line\r\n",
+       "width==\r\n340 height=3d200\r\n",
+       
+};
+
+static const char *qp_decoded_patterns[] = {
+       "\u00e1\u00e2\u00e3\u00e4\r\n",
+       "\u00e1=g2\u00e3\u00e4\r\n",
+       "\u00e1=eg\u00e3\u00e4\r\n",
+       "   \u00e1 \u00e2  \u00e3\t\u00e4  \t \t    \r\n",
+       "Soft line\tHard line\r\n",
+       "width=340 height=200\r\n"
+};
+
+static void
+test_quoted_printable_decode_patterns (void)
+{
+       const char *input;
+       GMimeEncoding decoder;
+       char output[4096];
+       char *expected;
+       size_t len, n;
+       iconv_t cd;
+       guint i;
+       
+       g_mime_encoding_init_decode (&decoder, GMIME_CONTENT_ENCODING_QUOTEDPRINTABLE);
+       cd = g_mime_iconv_open ("iso-8859-1", "utf-8");
+       
+       for (i = 0; i < G_N_ELEMENTS (base64_encoded_patterns); i++) {
+               testsuite_check ("qp_encoded_patterns[%u]", i);
+               
+               expected = g_mime_iconv_strdup (cd, qp_decoded_patterns[i]);
+               input = qp_encoded_patterns[i];
+               len = strlen (input);
+               
+               n = g_mime_encoding_step (&decoder, input, len, output);
+               len = strlen (expected);
+               
+               if (n != len)
+                       testsuite_check_failed ("qp_encoded_patterns[%u] failed: decoded lengths did not 
match (expected: %zu, was: %zu, value: \"%s\")", i, len, n, expected);
+               else if (strncmp (expected, output, n) != 0)
+                       testsuite_check_failed ("qp_encoded_patterns[%u] failed: decoded values did not 
match", i);
+               else
+                       testsuite_check_passed ();
+               
+               g_mime_encoding_reset (&decoder);
+               g_free (expected);
+       }
+       
+       g_mime_iconv_close (cd);
+}
+
+static void
+test_quoted_printable_encode_space_dos_linebreak (void)
+{
+       const char *input = "This line ends with a space \r\nbefore a line break.";
+       const char *expected = "This line ends with a space=20\nbefore a line break.";
+       GMimeEncoding encoder;
+       char output[4096];
+       size_t len, n;
+       
+       testsuite_check ("quoted-printable encode <SPACE><CR><LF>");
+       
+       g_mime_encoding_init_encode (&encoder, GMIME_CONTENT_ENCODING_QUOTEDPRINTABLE);
+       
+       n = g_mime_encoding_flush (&encoder, input, strlen (input), output);
+       len = strlen (expected);
+       
+       if (n != len)
+               testsuite_check_failed ("failed: encoded lengths did not match (expected: %zu, was: %zu)", 
len, n);
+       else if (strncmp (expected, output, n) != 0)
+               testsuite_check_failed ("failed: encoded values did not match");
+       else
+               testsuite_check_passed ();
+}
+
+static void
+test_quoted_printable_encode_space_unix_linebreak (void)
+{
+       const char *input = "This line ends with a space \nbefore a line break.";
+       const char *expected = "This line ends with a space=20\nbefore a line break.";
+       GMimeEncoding encoder;
+       char output[4096];
+       size_t len, n;
+       
+       testsuite_check ("quoted-printable encode <SPACE><LF>");
+       
+       g_mime_encoding_init_encode (&encoder, GMIME_CONTENT_ENCODING_QUOTEDPRINTABLE);
+       
+       n = g_mime_encoding_flush (&encoder, input, strlen (input), output);
+       len = strlen (expected);
+       
+       if (n != len)
+               testsuite_check_failed ("failed: encoded lengths did not match (expected: %zu, was: %zu)", 
len, n);
+       else if (strncmp (expected, output, n) != 0)
+               testsuite_check_failed ("failed: encoded values did not match");
+       else
+               testsuite_check_passed ();
+}
+
+static void
+test_quoted_printable_encode_ending_with_space (void)
+{
+       const char *input = "This line ends with a space ";
+       const char *expected = "This line ends with a space=20=\n";
+       GMimeEncoding encoder;
+       char output[4096];
+       size_t len, n;
+       
+       testsuite_check ("quoted-printable encode encoding with a space");
+       
+       g_mime_encoding_init_encode (&encoder, GMIME_CONTENT_ENCODING_QUOTEDPRINTABLE);
+       
+       n = g_mime_encoding_flush (&encoder, input, strlen (input), output);
+       len = strlen (expected);
+       
+       if (n != len)
+               testsuite_check_failed ("failed: encoded lengths did not match (expected: %zu, was: %zu)", 
len, n);
+       else if (strncmp (expected, output, n) != 0)
+               testsuite_check_failed ("failed: encoded values did not match");
+       else
+               testsuite_check_passed ();
+}
+
+static void
+test_quoted_printable_decode_invalid_soft_break (void)
+{
+       const char *input = "This is an invalid=\rsoft break.";
+       const char *expected = "This is an invalid=\rsoft break.";
+       GMimeEncoding decoder;
+       char output[4096];
+       size_t len, n;
+       
+       testsuite_check ("quoted-printable decode invalid soft break");
+       
+       g_mime_encoding_init_decode (&decoder, GMIME_CONTENT_ENCODING_QUOTEDPRINTABLE);
+       
+       n = g_mime_encoding_step (&decoder, input, strlen (input), output);
+       len = strlen (expected);
+       
+       if (n != len)
+               testsuite_check_failed ("failed: encoded lengths did not match (expected: %zu, was: %zu)", 
len, n);
+       else if (strncmp (expected, output, n) != 0)
+               testsuite_check_failed ("failed: encoded values did not match");
+       else
+               testsuite_check_passed ();
+}
+
 static GByteArray *
 read_all_bytes (const char *path, gboolean is_text)
 {
@@ -421,6 +574,11 @@ int main (int argc, char **argv)
        testsuite_end ();
        
        testsuite_start ("quoted-printable");
+       test_quoted_printable_decode_patterns ();
+       test_quoted_printable_encode_space_dos_linebreak ();
+       test_quoted_printable_encode_space_unix_linebreak ();
+       test_quoted_printable_encode_ending_with_space ();
+       test_quoted_printable_decode_invalid_soft_break ();
        test_encoder (GMIME_CONTENT_ENCODING_QUOTEDPRINTABLE, wikipedia, qp, 4096);
        test_encoder (GMIME_CONTENT_ENCODING_QUOTEDPRINTABLE, wikipedia, qp, 1024);
        test_encoder (GMIME_CONTENT_ENCODING_QUOTEDPRINTABLE, wikipedia, qp, 16);