- PIMPL usisng spimpl.h

- Fix a compilation in Windows (no gcov)
- All is const
- More sonar refactors

Author: david-antiteum

CMakeLists.txt

@@ -9,7 +9,7 @@ project( consulcpp VERSION 0.1.1 DESCRIPTION "A C++ library that implements the
 
 if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
 	include( CTest )
-	if(CMAKE_BUILD_TYPE STREQUAL "Debug")
+	if(CMAKE_BUILD_TYPE STREQUAL "Debug" AND UNIX)
 		include( CodeCoverage )
 		append_coverage_compiler_flags()
 		setup_target_for_coverage_gcovr( 

README.md

@@ -18,13 +18,13 @@ int main( int argc, char * argv[] )
 {
     consulcpp::Consul   consul;
 
-    if( consul.connect() ){
+    if( consulcpp::Consul consul; consul.connect() ) {
         consulcpp::Service        service;
         consulcpp::ServiceCheck   check;
 
         service.mName = "demo";
         service.mAddress = consul.address();
-        service.mPort = 50051;
+        service.mPort = 9990;
 
         check.mInterval = "10s";
         check.mGRPC = fmt::format( "{}:{}/Health", service.mAddress, service.mPort );
@@ -34,8 +34,7 @@ int main( int argc, char * argv[] )
 
         consulcpp::Session     session = consul.sessions().create();
 
-        consulcpp::Leader::Status leader = consul.leader().acquire( service, session );
-        if( leader == consulcpp::Leader::Status::Yes ){
+        if( consulcpp::Leader::Status leader = consul.leader().acquire( service, session ); leader == consulcpp::Leader::Status::Yes ){
             // I'm the leader
         }else{
             // I'm a follower
@@ -70,8 +69,8 @@ target_link_libraries(main PRIVATE consulcpp)
 
 ## Other Consul Clients in C++
 
+- [Ppconsul](https://github.com/oliora/ppconsul): C++ client for Consul. You should probably use this instead :)
 - [oatpp-consul](https://github.com/oatpp/oatpp-consul): C++ Consul integration for oatpp applications
-- [Ppconsul](https://github.com/oliora/ppconsul): C++ client for Consul
 
 ## Quality Checks
 

cmake/Tools.cmake

@@ -58,6 +58,10 @@ function(sonarqube_setup)
 	else()
 		find_program( buildwrapper_tmp build-wrapper-linux-x86-64 )
 	endif()
+	if( UNIX )
+		set( BUILD_TARGET coverage )	
+	endif()
+
 	if( buildwrapper_tmp )
 		set( BUILDWRAPPER_EXECUTABLE ${buildwrapper_tmp})
 		unset( buildwrapper_tmp )
@@ -67,8 +71,8 @@ function(sonarqube_setup)
 				${CMAKE_MAKE_PROGRAM} clean
 			COMMAND
 				${BUILDWRAPPER_EXECUTABLE}
-				--out-dir bw-output
-				${CMAKE_MAKE_PROGRAM} coverage
+				--out-dir bw-output				
+				${CMAKE_MAKE_PROGRAM} ${BUILD_TARGET}
 			COMMENT
 				"Run sonarqube build"
 			WORKING_DIRECTORY 

examples/leader/main.cpp

@@ -49,9 +49,10 @@ void TestService( consulcpp::Service & service )
 		spdlog::critical( "Cannot start gRPC server on {}:{}", service.mAddress, service.mPort );
 	}
 }
+
 int main( int argc, char * argv[] )
 {
-	unsigned short port = 50051;
+	unsigned short port = 9990;
 
 	if( argc > 1 ) {
 		if( auto maybePort = consulcpp::utils::asPort( argv[1] ); maybePort ){

include/consulcpp/Catalog.h

@@ -6,6 +6,7 @@
 #include <optional>
 
 #include "consulcpp/Export.h"
+#include "consulcpp/spimpl.h"
 
 namespace consulcpp {
 
@@ -18,15 +19,14 @@ class ConsulCPP_API Catalog
 {
 public:
 	explicit Catalog( Consul & consul );
-	~Catalog();
 
 	/*! Looks for a service in the catalog
 	*/
 	std::vector<Service> find( std::string_view name, const std::vector<std::string> & tags = {} ) const;
 
 private:
 	struct Private;
-	std::unique_ptr<Private>	d;
+	spimpl::impl_ptr<Private>	d;
 };
 
 }

include/consulcpp/Consul.h

@@ -4,6 +4,7 @@
 #include <memory>
 
 #include "consulcpp/Export.h"
+#include "consulcpp/spimpl.h"
 
 namespace consulcpp {
 
@@ -20,15 +21,12 @@ class KV;
 class ConsulCPP_API Consul
 {
 public:
-	//! Creates a consul services object pointing to a local agent at http://127.0.0.1:8500
-	Consul();
-	//! Creates a consul services object pointing to a local agent at "agentAddress"
-	explicit Consul( std::string_view agentAddress );	
-	~Consul();
+	//! Creates a consul services object
+	Consul();	
 
-	/*! Connects to the local agent
+	/*! Connects to an agent
 	*/
-	[[nodiscard]] bool connect();
+	[[nodiscard]] bool connect( std::string_view agentAddress = "http://127.0.0.1:8500" );
 
 	//! Address where consul agent is running	
 	[[nodiscard]] std::string address() const;
@@ -38,19 +36,19 @@ class ConsulCPP_API Consul
 	[[nodiscard]] std::string agentAPIVersion() const;
 
 	// Services access
-	[[nodiscard]] Services & services() const;
+	[[nodiscard]] const Services & services() const;
 	// Catalog access
-	[[nodiscard]] Catalog & catalog() const;
+	[[nodiscard]] const Catalog & catalog() const;
 	// Sessions access
-	[[nodiscard]] Sessions & sessions() const;
+	[[nodiscard]] const Sessions & sessions() const;
 	// Leader election access
-	[[nodiscard]] Leader & leader() const;
+	[[nodiscard]] const Leader & leader() const;
 	// KV Storer access
-	[[nodiscard]] KV & kv() const;
+	[[nodiscard]] const KV & kv() const;
 
 private:
 	struct Private;
-	std::unique_ptr<Private>	d;
+	spimpl::impl_ptr<Private>	d;
 };
 
 }

include/consulcpp/KV.h

@@ -5,6 +5,7 @@
 #include <optional>
 
 #include "consulcpp/Export.h"
+#include "consulcpp/spimpl.h"
 
 namespace consulcpp {
 
@@ -16,7 +17,6 @@ class ConsulCPP_API KV
 {
 public:
 	explicit KV( Consul & consul );
-	~KV();
 
 	/*! Returns the value of a single key
 	*/
@@ -32,7 +32,7 @@ class ConsulCPP_API KV
 
 private:
 	struct Private;
-	std::unique_ptr<Private>	d;
+	spimpl::impl_ptr<Private>	d;
 };
 
 }

include/consulcpp/Leader.h

@@ -4,6 +4,7 @@
 #include <memory>
 
 #include "consulcpp/Export.h"
+#include "consulcpp/spimpl.h"
 
 namespace consulcpp {
 
@@ -17,7 +18,6 @@ class ConsulCPP_API Leader
 {
 public:
 	explicit Leader( Consul & consul );
-	~Leader();
 
 	/*! Leader status:
 		- Yes: you are the leader
@@ -43,7 +43,7 @@ class ConsulCPP_API Leader
 
 private:
 	struct Private;
-	std::unique_ptr<Private>	d;
+	spimpl::impl_ptr<Private>	d;
 };
 
 }

include/consulcpp/Service.h

@@ -58,6 +58,13 @@ extern ConsulCPP_API void from_json( const nlohmann::json & j, ServiceCheck & s
 */
 struct ConsulCPP_API Service
 {
+	Service() = default;
+	Service( const Service & a ) = default;
+	Service( Service && a) noexcept = default;
+	~Service() = default;
+	Service & operator=( const Service & s ) = default;
+    Service & operator=( Service && a) noexcept = default;
+
 	// In Consul an empty id is valid and the name is used instead
 	[[nodiscard]] const std::string & id() const
 	{

include/consulcpp/Services.h

@@ -6,6 +6,7 @@
 #include <optional>
 
 #include "consulcpp/Export.h"
+#include "consulcpp/spimpl.h"
 
 namespace consulcpp {
 
@@ -18,7 +19,6 @@ class ConsulCPP_API Services
 {
 public:
 	explicit Services( Consul & consul );
-	~Services();
 
 	/*! Registers a new service.
 	*/
@@ -33,7 +33,7 @@ class ConsulCPP_API Services
 
 private:
 	struct Private;
-	std::unique_ptr<Private>	d;
+	spimpl::impl_ptr<Private>	d;
 };
 
 }

include/consulcpp/Sessions.h

@@ -4,6 +4,7 @@
 #include <memory>
 
 #include "consulcpp/Export.h"
+#include "consulcpp/spimpl.h"
 
 namespace consulcpp {
 
@@ -20,7 +21,6 @@ class ConsulCPP_API Sessions
 {
 public:
 	explicit Sessions( Consul & consul );
-	~Sessions();
 
 	/*! Creates a new session
 	*/
@@ -32,7 +32,7 @@ class ConsulCPP_API Sessions
 
 private:
 	struct Private;
-	std::unique_ptr<Private>	d;
+	spimpl::impl_ptr<Private>	d;
 };
 
 }