Move diagnostics to lib (#2967)

Situ Singh · web-flow · commit b6616106d8ca · 2023-03-29T16:56:02.000+05:30
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -195,7 +195,6 @@ add_subdirectory(bftengine)
 add_subdirectory(tools)
 add_subdirectory(storage)
 add_subdirectory(scripts)
-add_subdirectory(diagnostics)
 add_subdirectory(client)
 if(USE_GRPC)
 	add_subdirectory(thin-replica-server)
diff --git a/bftengine/src/bcstatetransfer/BCStateTran.hpp b/bftengine/src/bcstatetransfer/BCStateTran.hpp
@@ -36,8 +36,8 @@
 #include "util/Handoff.hpp"
 #include "SysConsts.hpp"
 #include "util/throughput.hpp"
-#include "diagnostics.h"
-#include "performance_handler.h"
+#include "diagnostics.hpp"
+#include "performance_handler.hpp"
 #include "util/Timers.hpp"
 #include "TimeUtils.hpp"
 #include "util/SimpleMemoryPool.hpp"
diff --git a/bftengine/src/bftengine/IncomingMsgsStorageImp.hpp b/bftengine/src/bftengine/IncomingMsgsStorageImp.hpp
@@ -16,8 +16,8 @@
 #include "IncomingMsgsStorage.hpp"
 #include "MsgHandlersRegistrator.hpp"
 #include "util/Timers.hpp"
-#include "diagnostics.h"
-#include "performance_handler.h"
+#include "diagnostics.hpp"
+#include "performance_handler.hpp"
 
 #include <queue>
 #include <atomic>
diff --git a/bftengine/src/bftengine/MsgsCommunicator.cpp b/bftengine/src/bftengine/MsgsCommunicator.cpp
@@ -12,7 +12,7 @@
 #include "MsgsCommunicator.hpp"
 #include "util/assertUtils.hpp"
 #include "communication/CommDefs.hpp"
-#include "diagnostics.h"
+#include "diagnostics.hpp"
 
 namespace bftEngine::impl {
 
diff --git a/bftengine/src/bftengine/ReplicaImp.cpp b/bftengine/src/bftengine/ReplicaImp.cpp
@@ -31,7 +31,7 @@
 #include "ReplicaLoader.hpp"
 #include "PersistentStorage.hpp"
 #include "util/OpenTracing.hpp"
-#include "diagnostics.h"
+#include "diagnostics.hpp"
 #include "TimeUtils.hpp"
 #include "util/json_output.hpp"
 
diff --git a/bftengine/src/bftengine/ReplicaImp.hpp b/bftengine/src/bftengine/ReplicaImp.hpp
@@ -31,8 +31,8 @@
 #include "util/OpenTracing.hpp"
 #include "RequestHandler.h"
 #include "InternalBFTClient.hpp"
-#include "diagnostics.h"
-#include "performance_handler.h"
+#include "diagnostics.hpp"
+#include "performance_handler.hpp"
 #include "RequestsBatchingLogic.hpp"
 #include "ReplicaStatusHandlers.hpp"
 #include "PerformanceManager.hpp"
diff --git a/bftengine/src/bftengine/ReplicaStatusHandlers.cpp b/bftengine/src/bftengine/ReplicaStatusHandlers.cpp
@@ -10,7 +10,7 @@
 // file.
 
 #include "ReplicaStatusHandlers.hpp"
-#include "diagnostics.h"
+#include "diagnostics.hpp"
 #include "util/json_output.hpp"
 
 #include <string>
diff --git a/bftengine/src/bftengine/RequestsBatchingLogic.hpp b/bftengine/src/bftengine/RequestsBatchingLogic.hpp
@@ -18,7 +18,7 @@
 #include "InternalReplicaApi.hpp"
 #include "messages/PrePrepareMsg.hpp"
 #include "util/Timers.hpp"
-#include "performance_handler.h"
+#include "performance_handler.hpp"
 
 namespace bftEngine::batchingLogic {
 
diff --git a/bftengine/src/bftengine/messages/ClientRequestMsg.hpp b/bftengine/src/bftengine/messages/ClientRequestMsg.hpp
@@ -14,8 +14,8 @@
 #include "MessageBase.hpp"
 #include "ReplicasInfo.hpp"
 #include "ClientMsgs.hpp"
-#include "diagnostics.h"
-#include "performance_handler.h"
+#include "diagnostics.hpp"
+#include "performance_handler.hpp"
 
 namespace bftEngine::impl {
 
diff --git a/bftengine/src/preprocessor/PreProcessor.hpp b/bftengine/src/preprocessor/PreProcessor.hpp
@@ -24,7 +24,7 @@
 #include "util/Timers.hpp"
 #include "InternalReplicaApi.hpp"
 #include "PreProcessorRecorder.hpp"
-#include "diagnostics.h"
+#include "diagnostics.hpp"
 #include "PerformanceManager.hpp"
 #include "util/RollingAvgAndVar.hpp"
 #include "SharedTypes.hpp"
diff --git a/bftengine/src/preprocessor/PreProcessorRecorder.hpp b/bftengine/src/preprocessor/PreProcessorRecorder.hpp
@@ -11,7 +11,7 @@
 
 #pragma once
 
-#include "diagnostics.h"
+#include "diagnostics.hpp"
 
 namespace preprocessor {
 class PreProcessorRecorder {
diff --git a/client/bftclient/include/bftclient/bft_client.h b/client/bftclient/include/bftclient/bft_client.h
@@ -24,7 +24,7 @@
 #include "msg_receiver.h"
 #include "exception.h"
 #include "metrics.h"
-#include "diagnostics.h"
+#include "diagnostics.hpp"
 #include "seq_num_generator.h"
 #include "crypto/signer.hpp"
 
diff --git a/client/clientservice/src/event_service.cpp b/client/clientservice/src/event_service.cpp
@@ -17,8 +17,8 @@
 #include "client/clientservice/event_service.hpp"
 #include "client/concordclient/concord_client.hpp"
 #include "util/throughput.hpp"
-#include "diagnostics.h"
-#include "performance_handler.h"
+#include "diagnostics.hpp"
+#include "performance_handler.hpp"
 
 using grpc::Status;
 using grpc::ServerContext;
diff --git a/kvbc/benchmark/kvbcbench/main.cpp b/kvbc/benchmark/kvbcbench/main.cpp
@@ -33,10 +33,10 @@
 #include "categorization/updates.h"
 #include "categorized_kvbc_msgs.cmf.hpp"
 #include "kvbc_adapter/replica_adapter.hpp"
-#include "performance_handler.h"
+#include "performance_handler.hpp"
 #include "rocksdb/native_client.h"
-#include "diagnostics.h"
-#include "diagnostics_server.h"
+#include "diagnostics.hpp"
+#include "diagnostics_server.hpp"
 #include "input.h"
 #include "pre_execution.h"
 
diff --git a/kvbc/include/categorization/kv_blockchain.h b/kvbc/include/categorization/kv_blockchain.h
@@ -25,8 +25,8 @@
 #include "categorization/types.h"
 #include "util/thread_pool.hpp"
 #include "util/Metrics.hpp"
-#include "diagnostics.h"
-#include "performance_handler.h"
+#include "diagnostics.hpp"
+#include "performance_handler.hpp"
 #include "bftengine/ReplicaConfig.hpp"
 #include "categorized_kvbc_msgs.cmf.hpp"
 
diff --git a/kvbc/include/kvbc_adapter/v4blockchain/blocks_deleter_adapter.hpp b/kvbc/include/kvbc_adapter/v4blockchain/blocks_deleter_adapter.hpp
@@ -18,8 +18,8 @@
 #include "db_interfaces.h"
 #include "v4blockchain/v4_blockchain.h"
 #include "kvbc_adapter/replica_adapter_auxilliary_types.hpp"
-#include "performance_handler.h"
-#include "diagnostics.h"
+#include "performance_handler.hpp"
+#include "diagnostics.hpp"
 
 namespace concord::kvbc::adapter::v4blockchain {
 
diff --git a/kvbc/include/sparse_merkle/histograms.h b/kvbc/include/sparse_merkle/histograms.h
@@ -13,7 +13,7 @@
 
 #pragma once
 
-#include "diagnostics.h"
+#include "diagnostics.hpp"
 #include "sparse_merkle/base_types.h"
 
 namespace concord::kvbc::sparse_merkle::detail {
diff --git a/kvbc/src/categorization/kv_blockchain.cpp b/kvbc/src/categorization/kv_blockchain.cpp
@@ -14,8 +14,8 @@
 #include "categorization/kv_blockchain.h"
 #include "bcstatetransfer/SimpleBCStateTransfer.hpp"
 #include "bftengine/ControlStateManager.hpp"
-#include "diagnostics.h"
-#include "performance_handler.h"
+#include "diagnostics.hpp"
+#include "performance_handler.hpp"
 #include "kvbc_key_types.hpp"
 #include "categorization/db_categories.h"
 #include "util/endianness.hpp"
diff --git a/libs/CMakeLists.txt b/libs/CMakeLists.txt
@@ -6,5 +6,5 @@ add_subdirectory(crypto)
 add_subdirectory(secrets)
 add_subdirectory(communication)
 add_subdirectory(reconfiguration)
-
+add_subdirectory(diagnostics)
 
diff --git a/libs/communication/src/TlsDiagnostics.h b/libs/communication/src/TlsDiagnostics.h
@@ -17,7 +17,7 @@
 #include <sstream>
 
 #include "util/kvstream.h"
-#include "diagnostics.h"
+#include "diagnostics.hpp"
 
 namespace bft::communication {
 
diff --git a/libs/communication/tests/multiplex_comm_test.cpp b/libs/communication/tests/multiplex_comm_test.cpp
@@ -13,7 +13,7 @@
 
 #include "communication/CommDefs.hpp"
 #include "communication/CommFactory.hpp"
-#include "diagnostics.h"
+#include "diagnostics.hpp"
 #include <gtest/gtest.h>
 
 using namespace bft::communication;
diff --git a/libs/diagnostics/CMakeLists.txt b/libs/diagnostics/CMakeLists.txt
@@ -11,6 +11,17 @@ set_property(TARGET diagnostics PROPERTY POSITION_INDEPENDENT_CODE ON)
 target_include_directories(diagnostics PUBLIC include ${HDR_HISTOGRAM_INCLUDE_DIR})
 target_link_libraries(diagnostics ${HDR_HISTOGRAM_LIBRARY})
 
+target_sources(diagnostics PUBLIC FILE_SET diagnostics_pub_hdrs
+                                       TYPE HEADERS
+                                       FILES 
+                                       diagnostics_server.hpp
+                                       diagnostics.hpp
+                                       protocol.hpp
+                                       status_handlers.hpp
+                                       performance_handler.hpp)
+
+install(TARGETS diagnostics FILE_SET diagnostics_pub_hdrs DESTINATION diagnostics)
+
 if (BUILD_TESTING)
     add_subdirectory(test)
 endif()
diff --git a/libs/diagnostics/README.md b/libs/diagnostics/README.md
diff --git a/libs/diagnostics/concord-ctl b/libs/diagnostics/concord-ctl
diff --git a/libs/diagnostics/diagnostics.hpp b/libs/diagnostics/diagnostics.hpp
@@ -17,8 +17,8 @@
 #include <mutex>
 #include <stdexcept>
 
-#include "performance_handler.h"
-#include "status_handlers.h"
+#include "performance_handler.hpp"
+#include "status_handlers.hpp"
 
 namespace concord::diagnostics {
 
diff --git a/libs/diagnostics/diagnostics_server.hpp b/libs/diagnostics/diagnostics_server.hpp
@@ -11,7 +11,7 @@
 // terms and conditions of the subcomponent's license, as noted in the LICENSE
 // file.
 
-// This file contains a tcp server listening on localhost that handles the messages in protocol.h.
+// This file contains a tcp server listening on localhost that handles the messages in protocol.hpp.
 
 #pragma once
 
@@ -30,7 +30,7 @@
 #include "log/logger.hpp"
 #include "util/errnoString.hpp"
 #include "util/kvstream.h"
-#include "protocol.h"
+#include "protocol.hpp"
 
 using concordUtils::errnoString;
 
diff --git a/libs/diagnostics/performance_handler.hpp b/libs/diagnostics/performance_handler.hpp
diff --git a/libs/diagnostics/protocol.hpp b/libs/diagnostics/protocol.hpp
@@ -21,7 +21,7 @@
 #include <array>
 #include <variant>
 
-#include "diagnostics.h"
+#include "diagnostics.hpp"
 
 namespace concord::diagnostics {
 
diff --git a/libs/diagnostics/src/performance_handler.cpp b/libs/diagnostics/src/performance_handler.cpp
@@ -13,7 +13,7 @@
 
 #include <iomanip>
 
-#include "performance_handler.h"
+#include "performance_handler.hpp"
 
 static logging::Logger DIAG_LOGGER = logging::getLogger("concord.diag.perf");
 
diff --git a/libs/diagnostics/src/status_handlers.cpp b/libs/diagnostics/src/status_handlers.cpp
@@ -11,7 +11,7 @@
 // terms and conditions of the subcomponent's license, as noted in the LICENSE
 // file.
 
-#include "status_handlers.h"
+#include "status_handlers.hpp"
 
 #include "log/logger.hpp"
 
diff --git a/libs/diagnostics/status_handlers.hpp b/libs/diagnostics/status_handlers.hpp
diff --git a/libs/diagnostics/test/CMakeLists.txt b/libs/diagnostics/test/CMakeLists.txt
diff --git a/libs/diagnostics/test/diagnostics_tests.cpp b/libs/diagnostics/test/diagnostics_tests.cpp
@@ -19,10 +19,10 @@
 #include <sys/types.h>
 #include <sys/socket.h>
 
-#include "diagnostics_server.h"
+#include "diagnostics_server.hpp"
 #include "gtest/gtest.h"
-#include "diagnostics.h"
-#include "protocol.h"
+#include "diagnostics.hpp"
+#include "protocol.hpp"
 
 using namespace concord::diagnostics;
 
diff --git a/libs/diagnostics/test/histogram_tests.cpp b/libs/diagnostics/test/histogram_tests.cpp
@@ -12,7 +12,7 @@
 // file.
 
 #include "gtest/gtest.h"
-#include "performance_handler.h"
+#include "performance_handler.hpp"
 
 using namespace concord::diagnostics;
 
diff --git a/libs/diagnostics/test/main.cpp b/libs/diagnostics/test/main.cpp
@@ -17,8 +17,8 @@
 #include <thread>
 #include <unistd.h>
 
-#include "diagnostics.h"
-#include "diagnostics_server.h"
+#include "diagnostics.hpp"
+#include "diagnostics_server.hpp"
 
 using namespace std::chrono_literals;
 
diff --git a/libs/util/MultiSizeBufferPool.hpp b/libs/util/MultiSizeBufferPool.hpp
@@ -15,8 +15,8 @@
 #include "util/Metrics.hpp"
 #include "util/assertUtils.hpp"
 #include "throughput.hpp"
-#include "diagnostics.h"
-#include "performance_handler.h"
+#include "diagnostics.hpp"
+#include "performance_handler.hpp"
 
 #include <boost/lockfree/queue.hpp>
 #include <yaml-cpp/yaml.h>
diff --git a/tests/apollo/test_skvbc_diagnostics.py b/tests/apollo/test_skvbc_diagnostics.py
@@ -21,7 +21,7 @@
 from util import skvbc as kvbc
 from typing import TYPE_CHECKING, Sequence
 
-diagnostics_dir = Path(__file__).absolute().parent.parent.parent / "diagnostics"
+diagnostics_dir = Path(__file__).absolute().parent.parent.parent / "libs" / "diagnostics"
 imported_concord_ctl_module_name = 'concord_ctl'
 
 # The following code allows importing a module file which has dashes in its name
diff --git a/tests/simpleKVBC/TesterReplica/main.cpp b/tests/simpleKVBC/TesterReplica/main.cpp
@@ -24,7 +24,7 @@
 #include "client/reconfiguration/cre_interfaces.hpp"
 #include "util/assertUtils.hpp"
 #include "util/Metrics.hpp"
-#include "diagnostics_server.h"
+#include "diagnostics_server.hpp"
 #include <csignal>
 
 #ifdef USE_ROCKSDB
diff --git a/tests/simpleTest/src/persistency_test.cpp b/tests/simpleTest/src/persistency_test.cpp
@@ -22,7 +22,7 @@
 #include "log/logger.hpp"
 #include "simple_test_client.hpp"
 #include "simple_test_replica.hpp"
-#include "diagnostics.h"
+#include "diagnostics.hpp"
 
 namespace test::persistency {
 class PersistencyTest : public testing::Test {
diff --git a/thin-replica-server/include/thin-replica-server/grpc_services.hpp b/thin-replica-server/include/thin-replica-server/grpc_services.hpp
@@ -19,8 +19,8 @@
 
 #include <memory>
 
-#include "diagnostics.h"
-#include "performance_handler.h"
+#include "diagnostics.hpp"
+#include "performance_handler.hpp"
 #include "thin_replica.grpc.pb.h"
 
 #ifdef RUN_PERF_TRS_TRC_TOOL
