Add unit tests for chain syncing

src/CMakeLists.txt

@@ -40,28 +40,35 @@ set(monero-lws-common_headers config.h error.h fwd.h)
 add_library(monero-lws-common ${monero-lws-common_sources} ${monero-lws-common_headers})
 target_link_libraries(monero-lws-common monero::libraries)
 
-
-add_executable(monero-lws-daemon server_main.cpp rest_server.cpp scanner.cpp)
-target_include_directories(monero-lws-daemon PUBLIC ${ZMQ_INCLUDE_PATH})
-target_link_libraries(monero-lws-daemon
-  PRIVATE
+add_library(monero-lws-daemon-common rest_server.cpp scanner.cpp)
+target_include_directories(monero-lws-daemon-common PUBLIC ${ZMQ_INCLUDE_PATH})
+target_link_libraries(monero-lws-daemon-common
+  PUBLIC
     monero::libraries
     ${MONERO_lmdb}
     monero-lws-common
     monero-lws-db
     monero-lws-rpc
-    monero-lws-util
     monero-lws-wire-json
+    monero-lws-util
     ${Boost_CHRONO_LIBRARY}
     ${Boost_PROGRAM_OPTIONS_LIBRARY}
-    ${Boost_FILESYSTEM_LIBRARY}
     ${Boost_THREAD_LIBRARY}
-    ${CMAKE_THREAD_LIBS_INIT}
+    ${Boost_THREAD_LIBS_INIT}
     ${EXTRA_LIBRARIES}
     ${ZMQ_LIB}
     Threads::Threads
 )
 
+add_executable(monero-lws-daemon server_main.cpp)
+target_link_libraries(monero-lws-daemon
+  PRIVATE
+    monero::libraries
+    monero-lws-daemon-common
+    ${Boost_PROGRAM_OPTIONS_LIBRARY}
+    ${Boost_FILESYSTEM_LIBRARY}
+)
+
 add_executable(monero-lws-admin admin_main.cpp)
 target_link_libraries(monero-lws-admin
   PRIVATE

src/rpc/CMakeLists.txt

@@ -31,4 +31,4 @@ set(monero-lws-rpc_headers admin.h client.h daemon_pub.h daemon_zmq.h fwd.h json
 
 add_library(monero-lws-rpc ${monero-lws-rpc_sources} ${monero-lws-rpc_headers})
 target_include_directories(monero-lws-rpc PRIVATE ${RMQ_INCLUDE_DIR})
-target_link_libraries(monero-lws-rpc monero::libraries monero-lws-wire-json monero-lws-wire-wrapper ${RMQ_LIBRARY})
+target_link_libraries(monero-lws-rpc monero::libraries monero-lws-util monero-lws-wire-json monero-lws-wire-wrapper ${RMQ_LIBRARY})

src/rpc/client.cpp

@@ -513,6 +513,13 @@ namespace rpc
       raise_abort_process();
   }
 
+  void* context::zmq_context() const
+  {
+    if (ctx == nullptr)
+      return nullptr;
+    return ctx->comm.get();
+  }
+
   std::string const& context::daemon_address() const
   {
     if (ctx == nullptr)

src/rpc/client.h

@@ -218,6 +218,9 @@ namespace rpc
 
     // Do not create clone method, only one of these should exist right now.
 
+    // \return zmq context pointer (for testing).
+    void* zmq_context() const;
+
     //! \return The full address of the monerod ZMQ daemon.
     std::string const& daemon_address() const;
 

src/scanner.h

@@ -56,5 +56,8 @@ namespace lws
 
     //! Stops all scanner instances globally.
     static void stop() noexcept { running = false; }
+
+    //! For testing, \post is_running() == true
+    static void reset() noexcept { running = true; }
   };
 } // lws

tests/unit/CMakeLists.txt

@@ -34,15 +34,20 @@ add_subdirectory(db)
 add_subdirectory(rpc)
 add_subdirectory(wire)
 
-add_executable(monero-lws-unit main.cpp)
-target_link_libraries(
-  monero-lws-unit
+add_executable(monero-lws-unit main.cpp scanner.test.cpp)
+target_link_libraries(monero-lws-unit
+  monero::libraries
+  monero-lws-daemon-common
   monero-lws-unit-db
   monero-lws-unit-framework
   monero-lws-unit-rpc
   monero-lws-unit-wire
   monero-lws-unit-wire-json
   monero-lws-unit-wire-msgpack
+  ${Boost_FILESYSTEM_LIBRARY}
+  ${Boost_PROGRAM_OPTIONS_LIBRARY}
+  ${Boost_THREAD_LIBRARY}
+  ${Boost_THREAD_LIBS_INIT}
   Threads::Threads
 )
 add_test(NAME monero-lws-unit COMMAND monero-lws-unit -v)

tests/unit/db/CMakeLists.txt

@@ -26,7 +26,13 @@
 # STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 # THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-add_library(monero-lws-unit-db OBJECT data.test.cpp storage.test.cpp subaddress.test.cpp webhook.test.cpp)
+add_library(monero-lws-unit-db OBJECT
+  chain.test.cpp
+  data.test.cpp
+  storage.test.cpp
+  subaddress.test.cpp
+  webhook.test.cpp
+)
 target_link_libraries(
   monero-lws-unit-db
   monero-lws-unit-framework

tests/unit/db/chain.test.cpp

@@ -0,0 +1,114 @@
+// Copyright (c) 2023, The Monero Project
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without modification, are
+// permitted provided that the following conditions are met:
+//
+// 1. Redistributions of source code must retain the above copyright notice, this list of
+//    conditions and the following disclaimer.
+//
+// 2. Redistributions in binary form must reproduce the above copyright notice, this list
+//    of conditions and the following disclaimer in the documentation and/or other
+//    materials provided with the distribution.
+//
+// 3. Neither the name of the copyright holder nor the names of its contributors may be
+//    used to endorse or promote products derived from this software without specific
+//    prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
+// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
+// THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+#include "chain.test.h"
+
+#include <cstdint>
+#include "db/storage.test.h"
+#include "error.h"
+
+namespace lws_test
+{
+  void test_chain(lest::env& lest_env, lws::db::storage_reader reader, lws::db::block_id id, epee::span<const crypto::hash> snapshot)
+  {
+    EXPECT(1 <= snapshot.size());
+
+    std::uint64_t d = std::uint64_t(id);
+    for (const auto& hash : snapshot)
+    {
+      EXPECT(MONERO_UNWRAP(reader.get_block_hash(lws::db::block_id(d))) == hash);
+      ++d;
+    }
+
+    const lws::db::block_info last_block =
+      MONERO_UNWRAP(reader.get_last_block());
+    EXPECT(last_block.id == lws::db::block_id(d - 1));
+    EXPECT(last_block.hash == snapshot[snapshot.size() - 1]);
+  }
+}
+
+LWS_CASE("db::storage::sync_chain")
+{
+  lws::db::account_address account{};
+  crypto::secret_key view{};
+  crypto::generate_keys(account.spend_public, view);
+  crypto::generate_keys(account.view_public, view);
+ 
+  SETUP("Appended Chain")
+  {
+    lws::db::test::cleanup_db on_scope_exit{};
+    lws::db::storage db = lws::db::test::get_fresh_db();
+    const lws::db::block_info last_block =
+      MONERO_UNWRAP(MONERO_UNWRAP(db.start_read()).get_last_block());
+
+    const auto get_account = [&db, &account] () -> lws::db::account
+    {
+      return MONERO_UNWRAP(MONERO_UNWRAP(db.start_read()).get_account(account)).second;
+    };
+   
+    const crypto::hash chain[5] = {
+      last_block.hash,
+      crypto::rand<crypto::hash>(),
+      crypto::rand<crypto::hash>(),
+      crypto::rand<crypto::hash>(),
+      crypto::rand<crypto::hash>()
+    };
+
+    EXPECT(db.add_account(account, view));
+    EXPECT(db.sync_chain(lws::db::block_id(0), chain) == lws::error::bad_blockchain);
+    EXPECT(db.sync_chain(last_block.id, {chain + 1, 4}) == lws::error::bad_blockchain);
+    EXPECT(db.sync_chain(last_block.id, chain));
+
+    {
+      const lws::account accounts[1] = {lws::account{get_account(), {}, {}}};
+      EXPECT(accounts[0].scan_height() == last_block.id);
+      EXPECT(db.update(last_block.id, chain, accounts));
+      EXPECT(get_account().scan_height == lws::db::block_id(std::uint64_t(last_block.id) + 4));
+    }
+
+    SECTION("Verify Append")
+    {
+      lws_test::test_chain(lest_env, MONERO_UNWRAP(db.start_read()), last_block.id, chain);
+    }
+
+    SECTION("Fork Chain")
+    {
+      const crypto::hash fchain[5] = {
+        chain[0],
+        chain[1],
+        crypto::rand<crypto::hash>(),
+        crypto::rand<crypto::hash>(),
+        crypto::rand<crypto::hash>()
+      };
+
+      EXPECT(db.sync_chain(last_block.id, fchain));
+      lws_test::test_chain(lest_env, MONERO_UNWRAP(db.start_read()), last_block.id, fchain);
+      EXPECT(get_account().scan_height == lws::db::block_id(std::uint64_t(last_block.id) + 1));
+    }
+  }
+}
+

tests/unit/db/chain.test.h

@@ -0,0 +1,38 @@
+// Copyright (c) 2023, The Monero Project
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without modification, are
+// permitted provided that the following conditions are met:
+//
+// 1. Redistributions of source code must retain the above copyright notice, this list of
+//    conditions and the following disclaimer.
+//
+// 2. Redistributions in binary form must reproduce the above copyright notice, this list
+//    of conditions and the following disclaimer in the documentation and/or other
+//    materials provided with the distribution.
+//
+// 3. Neither the name of the copyright holder nor the names of its contributors may be
+//    used to endorse or promote products derived from this software without specific
+//    prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
+// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
+// THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+#include "framework.test.h"
+
+#include "crypto/crypto.h" // monero/src
+#include "db/data.h"
+#include "db/storage.h"
+#include "span.h"          // monero/contrib/epee/include
+
+namespace lws_test
+{
+  void test_chain(lest::env& lest_env, lws::db::storage_reader reader, lws::db::block_id id, epee::span<const crypto::hash> snapshot);
+}

tests/unit/scanner.test.cpp

@@ -0,0 +1,223 @@
+// Copyright (c) 2023, The Monero Project
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without modification, are
+// permitted provided that the following conditions are met:
+//
+// 1. Redistributions of source code must retain the above copyright notice, this list of
+//    conditions and the following disclaimer.
+//
+// 2. Redistributions in binary form must reproduce the above copyright notice, this list
+//    of conditions and the following disclaimer in the documentation and/or other
+//    materials provided with the distribution.
+//
+// 3. Neither the name of the copyright holder nor the names of its contributors may be
+//    used to endorse or promote products derived from this software without specific
+//    prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
+// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
+// THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
+// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+#include "framework.test.h"
+
+#include <boost/thread.hpp>
+#include <iostream>
+
+#include "db/chain.test.h"
+#include "db/storage.test.h"
+#include "net/zmq.h"             // monero/src
+#include "rpc/client.h"
+#include "rpc/daemon_messages.h" // monero/src
+#include "scanner.h"
+#include "wire/error.h"
+#include "wire/json/write.h"
+
+namespace
+{
+  constexpr const char rendevous[] = "inproc://fake_daemon";
+  constexpr const std::chrono::seconds message_timeout{3};
+
+  template<typename T>
+  struct json_rpc_response
+  {
+    T result;
+    std::uint32_t id = 0;
+  };
+
+  template<typename T>
+  void write_bytes(wire::json_writer& dest, const json_rpc_response<T>& self)
+  {
+    wire::object(dest, WIRE_FIELD(id), WIRE_FIELD(result));
+  }
+
+  template<typename T>
+  epee::byte_slice to_json_rpc(T message)
+  {
+    epee::byte_slice out{};
+    const std::error_code err =
+      wire::json::to_bytes(out, json_rpc_response<T>{std::move(message)});
+    if (err)
+      MONERO_THROW(err, "Failed to serialize json_rpc_response");
+    return out;
+  }
+
+  template<typename T>
+  epee::byte_slice daemon_response(const T& message)
+  {
+    rapidjson::Value id;
+    id.SetInt(0);
+    return cryptonote::rpc::FullMessage::getResponse(message, id);
+  }
+
+  void rpc_thread(void* server, const std::vector<epee::byte_slice>& reply)
+  {
+    struct stop_
+    {
+      ~stop_() noexcept { lws::scanner::stop(); }; 
+    } stop{};
+
+    try
+    {
+      for (const epee::byte_slice& message : reply)
+      {
+        const auto start = std::chrono::steady_clock::now();
+        for (;;)
+        {
+          const auto request = net::zmq::receive(server, ZMQ_DONTWAIT);
+          if (request)
+            break;
+
+          if (request != net::zmq::make_error_code(EAGAIN))
+          {
+            std::cout << "Failed to retrieve message in fake ZMQ server: " << request.error().message() << std::endl;;
+            return;
+          }
+
+          if (message_timeout <= std::chrono::steady_clock::now() - start)
+          {
+            std::cout << "Timeout in dummy RPC server" << std::endl;
+            return;
+          }
+          boost::this_thread::sleep_for(boost::chrono::milliseconds{10});
+        } // until error or received message
+
+        const auto sent = net::zmq::send(message.clone(), server);
+        if (!sent)
+        {
+          std::cout << "Failed to send dummy RPC message: " << sent.error().message() << std::endl;
+          return;
+        }
+      } // foreach message
+    }
+    catch (const std::exception& e)
+    {
+      std::cout << "Unexpected exception in dummy RPC server: " << e.what() << std::endl;
+    }
+  }
+
+  struct join
+  {
+      boost::thread& thread;
+      ~join() { thread.join(); }
+  }; 
+}
+
+LWS_CASE("lws::scanner::sync")
+{
+  SETUP("lws::rpc::context, ZMQ_REP Server, and lws::db::storage")
+  {
+    lws::scanner::reset();
+    auto rpc = 
+      lws::rpc::context::make(rendevous, {}, {}, {}, std::chrono::minutes{0});
+
+    net::zmq::socket server{};
+    server.reset(zmq_socket(rpc.zmq_context(), ZMQ_REP));
+    EXPECT(server);
+    EXPECT(0 <= zmq_bind(server.get(), rendevous));
+
+    lws::db::test::cleanup_db on_scope_exit{};
+    lws::db::storage db = lws::db::test::get_fresh_db();
+    const lws::db::block_info last_block =
+      MONERO_UNWRAP(MONERO_UNWRAP(db.start_read()).get_last_block());
+
+    SECTION("Invalid Response")
+    {
+      const crypto::hash hashes[1] = {
+        last_block.hash
+      };
+
+      std::vector<epee::byte_slice> messages{};
+      messages.push_back(to_json_rpc(1));
+
+      boost::thread server_thread(&rpc_thread, server.get(), std::cref(messages));
+      const join on_scope_exit{server_thread};
+      EXPECT(!lws::scanner::sync(db.clone(), MONERO_UNWRAP(rpc.connect())));
+      lws_test::test_chain(lest_env, MONERO_UNWRAP(db.start_read()), last_block.id, hashes);
+    }
+
+    SECTION("Chain Update")
+    {
+      std::vector<epee::byte_slice> messages{};
+      std::vector<crypto::hash> hashes{
+        last_block.hash,
+        crypto::rand<crypto::hash>(),
+        crypto::rand<crypto::hash>(),
+        crypto::rand<crypto::hash>(),
+        crypto::rand<crypto::hash>(),
+        crypto::rand<crypto::hash>()
+      };
+
+      cryptonote::rpc::GetHashesFast::Response message{};
+
+      message.start_height = std::uint64_t(last_block.id);
+      message.hashes = hashes;
+      message.current_height = message.start_height + hashes.size() - 1;
+      messages.push_back(daemon_response(message));
+
+      message.start_height = message.current_height;
+      message.hashes.front() = message.hashes.back();
+      message.hashes.resize(1);
+      messages.push_back(daemon_response(message));
+
+      lws_test::test_chain(lest_env, MONERO_UNWRAP(db.start_read()), last_block.id, {hashes.data(), 1});
+      {
+        boost::thread server_thread(&rpc_thread, server.get(), std::cref(messages));
+        const join on_scope_exit{server_thread};
+        EXPECT(lws::scanner::sync(db.clone(), MONERO_UNWRAP(rpc.connect())));
+        lws_test::test_chain(lest_env, MONERO_UNWRAP(db.start_read()), last_block.id, epee::to_span(hashes));
+      }
+
+      SECTION("Fork Chain")
+      {
+        messages.clear();
+        hashes[2] = crypto::rand<crypto::hash>();
+        hashes[3] = crypto::rand<crypto::hash>();
+        hashes[4] = crypto::rand<crypto::hash>();
+        hashes[5] = crypto::rand<crypto::hash>();
+
+        message.start_height = std::uint64_t(last_block.id);
+        message.hashes = hashes;
+        messages.push_back(daemon_response(message));
+
+        message.start_height = message.current_height;
+        message.hashes.front() = message.hashes.back();
+        message.hashes.resize(1);
+        messages.push_back(daemon_response(message));
+
+        boost::thread server_thread(&rpc_thread, server.get(), std::cref(messages));
+        const join on_scope_exit{server_thread};
+        EXPECT(lws::scanner::sync(db.clone(), MONERO_UNWRAP(rpc.connect())));
+        lws_test::test_chain(lest_env, MONERO_UNWRAP(db.start_read()), last_block.id, epee::to_span(hashes));
+      }
+    }
+  }
+}
+
+