From 280a5599ebccbb54fb650f5e3939b0878b2f667a Mon Sep 17 00:00:00 2001
From: Karl-Johan Alm <karljohan-alm@garage.co.jp>
Date: Wed, 21 Dec 2016 13:43:49 +0900
Subject: [PATCH] Added some simple tests for the RAII-style events.

---
 src/Makefile.test.include     |  3 +-
 src/support/events.h          |  1 +
 src/test/raii_event_tests.cpp | 88 +++++++++++++++++++++++++++++++++++
 3 files changed, 91 insertions(+), 1 deletion(-)
 create mode 100644 src/test/raii_event_tests.cpp

diff --git a/src/Makefile.test.include b/src/Makefile.test.include
index 5969de087..5d57daff4 100644
--- a/src/Makefile.test.include
+++ b/src/Makefile.test.include
@@ -74,6 +74,7 @@ BITCOIN_TESTS =\
   test/policyestimator_tests.cpp \
   test/pow_tests.cpp \
   test/prevector_tests.cpp \
+  test/raii_event_tests.cpp \
   test/reverselock_tests.cpp \
   test/rpc_tests.cpp \
   test/sanity_tests.cpp \
@@ -111,7 +112,7 @@ endif
 test_test_bitcoin_SOURCES = $(BITCOIN_TESTS) $(JSON_TEST_FILES) $(RAW_TEST_FILES)
 test_test_bitcoin_CPPFLAGS = $(AM_CPPFLAGS) $(BITCOIN_INCLUDES) -I$(builddir)/test/ $(TESTDEFS)
 test_test_bitcoin_LDADD = $(LIBBITCOIN_SERVER) $(LIBBITCOIN_CLI) $(LIBBITCOIN_COMMON) $(LIBBITCOIN_UTIL) $(LIBBITCOIN_CONSENSUS) $(LIBBITCOIN_CRYPTO) $(LIBUNIVALUE) $(LIBLEVELDB) $(LIBMEMENV) \
-  $(BOOST_LIBS) $(BOOST_UNIT_TEST_FRAMEWORK_LIB) $(LIBSECP256K1)
+  $(BOOST_LIBS) $(BOOST_UNIT_TEST_FRAMEWORK_LIB) $(LIBSECP256K1) $(EVENT_LIBS)
 test_test_bitcoin_CXXFLAGS = $(AM_CXXFLAGS) $(PIE_FLAGS)
 if ENABLE_WALLET
 test_test_bitcoin_LDADD += $(LIBBITCOIN_WALLET)
diff --git a/src/support/events.h b/src/support/events.h
index 16378086f..4f2f3cf9e 100644
--- a/src/support/events.h
+++ b/src/support/events.h
@@ -6,6 +6,7 @@
 #define BITCOIN_SUPPORT_EVENTS_H
 
 #include <ios>
+#include <memory>
 
 #include <event2/event.h>
 #include <event2/http.h>
diff --git a/src/test/raii_event_tests.cpp b/src/test/raii_event_tests.cpp
new file mode 100644
index 000000000..87d25c0e2
--- /dev/null
+++ b/src/test/raii_event_tests.cpp
@@ -0,0 +1,88 @@
+// Copyright (c) 2016 The Bitcoin Core developers
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
+#include <event2/event.h>
+#include <map>
+#include <stdlib.h>
+
+#include "support/events.h"
+
+#include "test/test_bitcoin.h"
+
+#include <vector>
+
+#include <boost/test/unit_test.hpp>
+
+static std::map<void*, short> tags;
+static std::map<void*, uint16_t> orders;
+static uint16_t tagSequence = 0;
+
+static void* tag_malloc(size_t sz) {
+    void* mem = malloc(sz);
+    if (!mem) return mem;
+    tags[mem]++;
+    orders[mem] = tagSequence++;
+    return mem;
+}
+
+static void tag_free(void* mem) {
+    tags[mem]--;
+    orders[mem] = tagSequence++;
+    free(mem);
+}
+
+BOOST_FIXTURE_TEST_SUITE(raii_event_tests, BasicTestingSetup)
+
+BOOST_AUTO_TEST_CASE(raii_event_creation)
+{
+    event_set_mem_functions(tag_malloc, realloc, tag_free);
+    
+    void* base_ptr = NULL;
+    {
+        auto base = obtain_event_base();
+        base_ptr = (void*)base.get();
+        BOOST_CHECK(tags[base_ptr] == 1);
+    }
+    BOOST_CHECK(tags[base_ptr] == 0);
+    
+    void* event_ptr = NULL;
+    {
+        auto base = obtain_event_base();
+        auto event = obtain_event(base.get(), -1, 0, NULL, NULL);
+
+        base_ptr = (void*)base.get();
+        event_ptr = (void*)event.get();
+
+        BOOST_CHECK(tags[base_ptr] == 1);
+        BOOST_CHECK(tags[event_ptr] == 1);
+    }
+    BOOST_CHECK(tags[base_ptr] == 0);
+    BOOST_CHECK(tags[event_ptr] == 0);
+    
+    event_set_mem_functions(malloc, realloc, free);
+}
+
+BOOST_AUTO_TEST_CASE(raii_event_order)
+{
+    event_set_mem_functions(tag_malloc, realloc, tag_free);
+    
+    void* base_ptr = NULL;
+    void* event_ptr = NULL;
+    {
+        auto base = obtain_event_base();
+        auto event = obtain_event(base.get(), -1, 0, NULL, NULL);
+
+        base_ptr = (void*)base.get();
+        event_ptr = (void*)event.get();
+
+        // base should have allocated before event
+        BOOST_CHECK(orders[base_ptr] < orders[event_ptr]);
+    }
+    // base should be freed after event
+    BOOST_CHECK(orders[base_ptr] > orders[event_ptr]);
+
+    event_set_mem_functions(malloc, realloc, free);
+}
+
+BOOST_AUTO_TEST_SUITE_END()