Problem: ZAP tests are now generic but placed in test_security_curve.cpp

Solution: Move ZAP tests to own file test_security_zap.cpp, move common code to testutil_security.hpp

Makefile.am

@@ -376,6 +376,7 @@ test_apps = \
 	tests/test_ctx_destroy \
 	tests/test_security_null \
 	tests/test_security_plain \
+	tests/test_security_zap \
 	tests/test_iov \
 	tests/test_spec_req \
 	tests/test_spec_rep \
@@ -522,6 +523,9 @@ tests_test_security_null_LDADD = src/libzmq.la
 tests_test_security_plain_SOURCES = tests/test_security_plain.cpp
 tests_test_security_plain_LDADD = src/libzmq.la
 
+tests_test_security_zap_SOURCES = tests/test_security_zap.cpp
+tests_test_security_zap_LDADD = src/libzmq.la
+
 tests_test_spec_req_SOURCES = tests/test_spec_req.cpp
 tests_test_spec_req_LDADD = src/libzmq.la
 

builds/gyp/project-tests.gypi

@@ -374,6 +374,17 @@
         'libzmq'
       ],
     },
+    {
+      'target_name': 'test_security_zap',
+      'type': 'executable',
+      'sources': [
+        '../../tests/test_security_zap.cpp',
+        '../../tests/testutil.hpp'
+      ],
+      'dependencies': [
+        'libzmq'
+      ],
+    },
     {
       'target_name': 'test_iov',
       'type': 'executable',

builds/gyp/project-tests.xml

@@ -33,6 +33,7 @@
     <test name = "test_security_null" />
     <test name = "test_security_plain" />
     <test name = "test_security_curve" />
+    <test name = "test_security_zap" />
     <test name = "test_iov" />
     <test name = "test_spec_req" />
     <test name = "test_spec_rep" />

tests/CMakeLists.txt

@@ -34,6 +34,7 @@ set(tests
         test_ctx_destroy
         test_security_null
         test_security_plain
+        test_security_zap
         test_iov
         test_spec_req
         test_spec_rep
@@ -184,10 +185,16 @@ if(ZMQ_HAVE_CURVE)
 	"../src/err.cpp" 
 	"../src/random.cpp" 
 	"../src/clock.cpp"
+	"testutil_security.hpp"
 	)
   target_compile_definitions(test_security_curve PRIVATE "-DZMQ_USE_TWEETNACL")
 endif()
 
+target_sources(test_security_zap PRIVATE 
+  "testutil_security.hpp"
+)
+set_tests_properties(test_security_zap PROPERTIES TIMEOUT 60)
+
 #Check whether all tests in the current folder are present
 file(READ "${CMAKE_CURRENT_LIST_FILE}" CURRENT_LIST_FILE_CONTENT)
 file(GLOB ALL_TEST_SOURCES "test_*.cpp")

tests/test_security_zap.cpp

+/*
+    Copyright (c) 2007-2017 Contributors as noted in the AUTHORS file
+
+    This file is part of libzmq, the ZeroMQ core engine in C++.
+
+    libzmq is free software; you can redistribute it and/or modify it under
+    the terms of the GNU Lesser General Public License (LGPL) as published
+    by the Free Software Foundation; either version 3 of the License, or
+    (at your option) any later version.
+
+    As a special exception, the Contributors give you permission to link
+    this library with independent modules to produce an executable,
+    regardless of the license terms of these independent modules, and to
+    copy and distribute the resulting executable under terms of your choice,
+    provided that you also meet, for each linked independent module, the
+    terms and conditions of the license of that module. An independent
+    module is a module which is not derived from or based on this library.
+    If you modify this library, you must extend this exception to your
+    version of the library.
+
+    libzmq is distributed in the hope that it will be useful, but WITHOUT
+    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+    FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
+    License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#include "testutil_security.hpp"
+
+static void zap_handler_wrong_version (void *ctx)
+{
+    zap_handler_generic (ctx, zap_wrong_version);
+}
+
+static void zap_handler_wrong_request_id (void *ctx)
+{
+    zap_handler_generic (ctx, zap_wrong_request_id);
+}
+
+static void zap_handler_wrong_status_invalid (void *ctx)
+{
+    zap_handler_generic (ctx, zap_status_invalid);
+}
+
+static void zap_handler_wrong_status_temporary_failure (void *ctx)
+{
+    zap_handler_generic (ctx, zap_status_temporary_failure);
+}
+
+static void zap_handler_wrong_status_internal_error (void *ctx)
+{
+    zap_handler_generic (ctx, zap_status_internal_error);
+}
+
+static void zap_handler_too_many_parts (void *ctx)
+{
+    zap_handler_generic (ctx, zap_too_many_parts);
+}
+
+void test_zap_unsuccessful (void *ctx,
+                            char *my_endpoint,
+                            void *server,
+                            void *server_mon,
+                            int expected_event,
+                            int expected_err,
+                            socket_config_fn socket_config_,
+                            void *socket_config_data_)
+{
+    expect_new_client_bounce_fail (ctx, my_endpoint, server, socket_config_,
+                                   socket_config_data_);
+
+    int events_received = 0;
+#ifdef ZMQ_BUILD_DRAFT_API
+    events_received =
+      expect_monitor_event_multiple (server_mon, expected_event, expected_err);
+#endif
+
+    // there may be more than one ZAP request due to repeated attempts by the client
+    assert (events_received == 0
+            || 1 <= zmq_atomic_counter_value (zap_requests_handled));
+}
+
+void test_zap_protocol_error (void *ctx,
+                              char *my_endpoint,
+                              void *server,
+                              void *server_mon,
+                              socket_config_fn socket_config_,
+                              void *socket_config_data_)
+{
+    test_zap_unsuccessful (ctx, my_endpoint, server, server_mon,
+#ifdef ZMQ_BUILD_DRAFT_API
+                           ZMQ_EVENT_HANDSHAKE_FAILED_ZAP, EPROTO,
+#else
+                           0, 0,
+#endif
+                           socket_config_, socket_config_data_);
+}
+
+void test_zap_errors (socket_config_fn server_socket_config_,
+                      void *server_socket_config_data_,
+                      socket_config_fn client_socket_config_,
+                      void *client_socket_config_data_)
+{
+    void *ctx;
+    void *handler;
+    void *zap_thread;
+    void *server;
+    void *server_mon;
+    char my_endpoint[MAX_SOCKET_STRING];
+
+    //  Invalid ZAP protocol tests
+
+    //  wrong version
+    fprintf (stderr, "test_zap_protocol_error wrong_version\n");
+    setup_context_and_server_side (
+      &ctx, &handler, &zap_thread, &server, &server_mon, my_endpoint,
+      &zap_handler_wrong_version, server_socket_config_,
+      server_socket_config_data_);
+    test_zap_protocol_error (ctx, my_endpoint, server, server_mon,
+                             client_socket_config_, client_socket_config_data_);
+    shutdown_context_and_server_side (ctx, zap_thread, server, server_mon,
+                                      handler);
+
+    //  wrong request id
+    fprintf (stderr, "test_zap_protocol_error wrong_request_id\n");
+    setup_context_and_server_side (
+      &ctx, &handler, &zap_thread, &server, &server_mon, my_endpoint,
+      &zap_handler_wrong_request_id, server_socket_config_,
+      server_socket_config_data_);
+    test_zap_protocol_error (ctx, my_endpoint, server, server_mon,
+                             client_socket_config_, client_socket_config_data_);
+    shutdown_context_and_server_side (ctx, zap_thread, server, server_mon,
+                                      handler);
+
+    //  status invalid (not a 3-digit number)
+    fprintf (stderr, "test_zap_protocol_error wrong_status_invalid\n");
+    setup_context_and_server_side (
+      &ctx, &handler, &zap_thread, &server, &server_mon, my_endpoint,
+      &zap_handler_wrong_status_invalid, server_socket_config_,
+      server_socket_config_data_);
+    test_zap_protocol_error (ctx, my_endpoint, server, server_mon,
+                             client_socket_config_, client_socket_config_data_);
+    shutdown_context_and_server_side (ctx, zap_thread, server, server_mon,
+                                      handler);
+
+    //  too many parts
+    fprintf (stderr, "test_zap_protocol_error too_many_parts\n");
+    setup_context_and_server_side (
+      &ctx, &handler, &zap_thread, &server, &server_mon, my_endpoint,
+      &zap_handler_too_many_parts, server_socket_config_,
+      server_socket_config_data_);
+    test_zap_protocol_error (ctx, my_endpoint, server, server_mon,
+                             client_socket_config_, client_socket_config_data_);
+    shutdown_context_and_server_side (ctx, zap_thread, server, server_mon,
+                                      handler);
+
+    //  ZAP non-standard cases
+
+    //  TODO make these observable on the client side as well (they are
+    //  transmitted as an ERROR message)
+
+    //  status 300 temporary failure
+    fprintf (stderr, "test_zap_unsuccessful status 300\n");
+    setup_context_and_server_side (
+      &ctx, &handler, &zap_thread, &server, &server_mon, my_endpoint,
+      &zap_handler_wrong_status_temporary_failure, server_socket_config_,
+      server_socket_config_data_);
+    test_zap_unsuccessful (ctx, my_endpoint, server, server_mon,
+#ifdef ZMQ_BUILD_DRAFT_API
+                           ZMQ_EVENT_HANDSHAKE_FAILED_NO_DETAIL, EAGAIN,
+#else
+                           0, 0,
+#endif
+                           client_socket_config_, client_socket_config_data_);
+    shutdown_context_and_server_side (ctx, zap_thread, server, server_mon,
+                                      handler);
+
+    //  status 500 internal error
+    fprintf (stderr, "test_zap_unsuccessful status 500\n");
+    setup_context_and_server_side (
+      &ctx, &handler, &zap_thread, &server, &server_mon, my_endpoint,
+      &zap_handler_wrong_status_internal_error, server_socket_config_);
+    test_zap_unsuccessful (ctx, my_endpoint, server, server_mon,
+#ifdef ZMQ_BUILD_DRAFT_API
+                           ZMQ_EVENT_HANDSHAKE_FAILED_NO_DETAIL, EFAULT,
+#else
+                           0, 0,
+#endif
+                           client_socket_config_, client_socket_config_data_);
+    shutdown_context_and_server_side (ctx, zap_thread, server, server_mon,
+                                      handler);
+}
+
+int main (void)
+{
+    setup_test_environment ();
+
+    if (zmq_has ("curve")) {
+        setup_testutil_security_curve ();
+
+        curve_client_data_t curve_client_data = {
+          valid_server_public, valid_client_public, valid_client_secret};
+        test_zap_errors (&socket_config_curve_server, valid_server_secret,
+                         &socket_config_curve_client, &curve_client_data);
+    }
+}