[geary/mjog/imap-connection-fixes: 19/42] Add unit test for Geary.Imap.ClientConnection

[Michael Gratton <mjog src gnome org>]

commit 0b5da880792f2f7bfd3c6267a71475a502cc946b
Author: Michael Gratton <mike vee net>
Date:   Sun Dec 29 01:56:48 2019 +1030

    Add unit test for Geary.Imap.ClientConnection

 .../transport/imap-client-connection-test.vala     | 152 +++++++++++++++++++++
 test/meson.build                                   |   1 +
 test/test-engine.vala                              |  11 +-
 3 files changed, 162 insertions(+), 2 deletions(-)
---
diff --git a/test/engine/imap/transport/imap-client-connection-test.vala 
b/test/engine/imap/transport/imap-client-connection-test.vala
new file mode 100644
index 00000000..56f6029b
--- /dev/null
+++ b/test/engine/imap/transport/imap-client-connection-test.vala
@@ -0,0 +1,152 @@
+/*
+ * Copyright 2019 Michael Gratton <mike vee net>
+ *
+ * This software is licensed under the GNU Lesser General Public License
+ * (version 2.1 or later). See the COPYING file in this distribution.
+ */
+
+class Geary.Imap.ClientConnectionTest : TestCase {
+
+
+    private TestServer? server = null;
+
+
+    public ClientConnectionTest() {
+        base("Geary.Imap.ClientConnectionTest");
+        add_test("connect_disconnect", connect_disconnect);
+        if (GLib.Test.slow()) {
+            add_test("idle", idle);
+            add_test("command_timeout", command_timeout);
+        }
+    }
+
+    protected override void set_up() throws GLib.Error {
+        this.server = new TestServer();
+    }
+
+    protected override void tear_down() {
+        this.server.stop();
+        this.server = null;
+    }
+
+    public void connect_disconnect() throws GLib.Error {
+        var test_article = new ClientConnection(new_endpoint());
+
+        test_article.connect_async.begin(null, this.async_complete_full);
+        test_article.connect_async.end(async_result());
+
+        assert_non_null(test_article.get_remote_address());
+        assert_non_null(test_article.get_local_address());
+
+        test_article.disconnect_async.begin(null, this.async_complete_full);
+        test_article.disconnect_async.end(async_result());
+
+        assert_null(test_article.get_remote_address());
+        assert_null(test_article.get_local_address());
+
+        TestServer.Result result = this.server.wait_for_script(this.main_loop);
+        assert(result.succeeded);
+    }
+
+    public void idle() throws GLib.Error {
+        this.server.add_script_line(RECEIVE_LINE, "a001 IDLE");
+        this.server.add_script_line(SEND_LINE, "+ idling");
+        this.server.add_script_line(RECEIVE_LINE, "DONE");
+        this.server.add_script_line(SEND_LINE, "a001 OK Completed");
+        this.server.add_script_line(RECEIVE_LINE, "a002 TEST");
+        this.server.add_script_line(SEND_LINE, "a002 OK Looks good");
+        this.server.add_script_line(WAIT_FOR_DISCONNECT, "");
+
+        const int COMMAND_TIMEOUT = 1;
+        const int IDLE_TIMEOUT = 1;
+
+        var test_article = new ClientConnection(
+            new_endpoint(), COMMAND_TIMEOUT, IDLE_TIMEOUT
+        );
+        test_article.connect_async.begin(null, this.async_complete_full);
+        test_article.connect_async.end(async_result());
+
+        assert_false(test_article.is_in_idle(), "Initial idle state");
+        test_article.enable_idle_when_quiet(true);
+        assert_false(test_article.is_in_idle(), "Post-enabled idle state");
+
+        // Wait for idle to kick in
+        GLib.Timer timer = new GLib.Timer();
+        timer.start();
+        while (!test_article.is_in_idle() &&
+               timer.elapsed() < IDLE_TIMEOUT * 2) {
+            this.main_loop.iteration(false);
+        }
+
+        assert_true(test_article.is_in_idle(), "Entered idle");
+
+        // Ensure idle outlives command timeout
+        timer.start();
+        while (timer.elapsed() < COMMAND_TIMEOUT * 2) {
+            this.main_loop.iteration(false);
+        }
+
+        assert_true(test_article.is_in_idle(), "Post idle command timeout");
+
+        var command = new Command("TEST");
+        test_article.send_command(command);
+        command.wait_until_complete.begin(null, this.async_complete_full);
+        command.wait_until_complete.end(async_result());
+
+        assert_false(test_article.is_in_idle(), "Post test command");
+
+        test_article.disconnect_async.begin(null, this.async_complete_full);
+        test_article.disconnect_async.end(async_result());
+
+        TestServer.Result result = this.server.wait_for_script(this.main_loop);
+        assert(result.succeeded);
+    }
+
+    public void command_timeout() throws GLib.Error {
+        this.server.add_script_line(
+            SEND_LINE, "* OK localhost test server ready"
+        );
+        this.server.add_script_line(RECEIVE_LINE, "a001 TEST");
+        this.server.add_script_line(WAIT_FOR_DISCONNECT, "");
+
+        const int TIMEOUT = 2;
+
+        bool sent = false;
+        bool recv_fail = false;
+        bool timed_out = false;
+
+        var test_article = new ClientConnection(new_endpoint(), TIMEOUT);
+        test_article.sent_command.connect(() => { sent = true; });
+        test_article.receive_failure.connect(() => { recv_fail = true; });
+        test_article.connect_async.begin(null, this.async_complete_full);
+        test_article.connect_async.end(async_result());
+
+        var command = new Command("TEST");
+        command.response_timed_out.connect(() => { timed_out = true; });
+
+        test_article.send_command(command);
+
+        GLib.Timer timer = new GLib.Timer();
+        timer.start();
+        while (!timed_out && timer.elapsed() < TIMEOUT * 2) {
+            this.main_loop.iteration(false);
+        }
+
+        test_article.disconnect_async.begin(null, this.async_complete_full);
+        test_article.disconnect_async.end(async_result());
+
+        assert_true(sent, "connection.sent_command");
+        assert_true(recv_fail, "command.receive_failure");
+        assert_true(timed_out, "command.response_timed_out");
+
+        debug("Waiting for server...");
+
+        TestServer.Result result = this.server.wait_for_script(this.main_loop);
+        assert_true(result.succeeded);
+    }
+
+    protected Endpoint new_endpoint() {
+        return new Endpoint(this.server.get_client_address(), NONE, 10);
+    }
+
+}
diff --git a/test/meson.build b/test/meson.build
index f410f914..18906688 100644
--- a/test/meson.build
+++ b/test/meson.build
@@ -42,6 +42,7 @@ geary_test_engine_sources = [
   'engine/imap/message/imap-mailbox-specifier-test.vala',
   'engine/imap/parameter/imap-list-parameter-test.vala',
   'engine/imap/response/imap-namespace-response-test.vala',
+  'engine/imap/transport/imap-client-connection-test.vala',
   'engine/imap/transport/imap-deserializer-test.vala',
   'engine/imap-db/imap-db-account-test.vala',
   'engine/imap-db/imap-db-attachment-test.vala',
diff --git a/test/test-engine.vala b/test/test-engine.vala
index a8e262fa..85f6961b 100644
--- a/test/test-engine.vala
+++ b/test/test-engine.vala
@@ -46,20 +46,27 @@ int main(string[] args) {
     engine.add_suite(new Geary.Db.DatabaseTest().get_suite());
     engine.add_suite(new Geary.Db.VersionedDatabaseTest().get_suite());
     engine.add_suite(new Geary.HTML.UtilTest().get_suite());
-    // Other IMAP tests rely on DataFormat working, so test that first
+
+    // Other IMAP tests rely on these working, so test them first
     engine.add_suite(new Geary.Imap.DataFormatTest().get_suite());
+
     engine.add_suite(new Geary.Imap.CreateCommandTest().get_suite());
-    engine.add_suite(new Geary.Imap.DeserializerTest().get_suite());
     engine.add_suite(new Geary.Imap.FetchCommandTest().get_suite());
     engine.add_suite(new Geary.Imap.ListParameterTest().get_suite());
     engine.add_suite(new Geary.Imap.MailboxSpecifierTest().get_suite());
     engine.add_suite(new Geary.Imap.NamespaceResponseTest().get_suite());
+
+    // Depends on IMAP commands working
+    engine.add_suite(new Geary.Imap.DeserializerTest().get_suite());
+    engine.add_suite(new Geary.Imap.ClientConnectionTest().get_suite());
+
     engine.add_suite(new Geary.ImapDB.AccountTest().get_suite());
     engine.add_suite(new Geary.ImapDB.AttachmentTest().get_suite());
     engine.add_suite(new Geary.ImapDB.AttachmentIoTest().get_suite());
     engine.add_suite(new Geary.ImapDB.DatabaseTest().get_suite());
     engine.add_suite(new Geary.ImapDB.EmailIdentifierTest().get_suite());
     engine.add_suite(new Geary.ImapDB.FolderTest().get_suite());
+
     engine.add_suite(new Geary.ImapEngine.AccountProcessorTest().get_suite());
     engine.add_suite(new Geary.ImapEngine.GenericAccountTest().get_suite());