Add sonarqube support

and:
- fix and error in checks definio. Use CheckID instead of ID
- remove unneded lib: gRPC::grpc_cronet
- remove obsolete vcpkg port definition

Author: david-antiteum

.gitignore

@@ -1,3 +1,6 @@
+# Sonar
+.scannerwork
+
 # Prerequisites
 *.d
 

.vscode/launch.json

@@ -0,0 +1,38 @@
+{
+	// Use IntelliSense to learn about possible attributes.
+	// Hover to view descriptions of existing attributes.
+	// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"name": "(gdb) Launch",
+			"type": "cppdbg",
+			"request": "launch",
+			"program": "${workspaceFolder}/build/bin/leader",
+			"args": [],
+			"stopAtEntry": false,
+			"cwd": "${workspaceFolder}",
+			"environment": [],
+			"externalConsole": false,
+			"MIMode": "gdb",
+			"setupCommands": [
+				{
+					"description": "Enable pretty-printing for gdb",
+					"text": "-enable-pretty-printing",
+					"ignoreFailures": true
+				}
+			]
+		},
+		{
+			"name": "(Windows) Launch",
+			"type": "cppvsdbg",
+			"request": "launch",
+			"program": "${workspaceFolder}/build/bin/leader.exe",
+			"args": [],
+			"stopAtEntry": false,
+			"cwd": "${workspaceFolder}",
+			"environment": [],
+			"externalConsole": false
+		}
+	]
+}

.vscode/settings.json

@@ -87,6 +87,13 @@
 		"xtr1common": "cpp",
 		"xtree": "cpp",
 		"xutility": "cpp",
-		"resumable": "cpp"
+		"resumable": "cpp",
+		"compare": "cpp",
+		"concepts": "cpp",
+		"coroutine": "cpp",
+		"fstream": "cpp",
+		"random": "cpp",
+		"pointers": "cpp",
+		"*.ipp": "cpp"
 	}
 }

README.md

@@ -57,7 +57,7 @@ Use cmake to build it on Windows, macOS and Linux.
 
 ### Dependencies using VCPKG
 
-```
+```shell
 ./vcpkg install boost
 ./vcpkg install fmt
 ./vcpkg install uriparser
@@ -78,3 +78,15 @@ target_link_libraries(main PRIVATE consulcpp)
 
 - [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
+
+### Sonarqube
+
+1. Install and add to the path both build-wrapper and sonar-scanner
+2. Set the SONAR_TOKEN environment variable
+3. Use the sonarqube target:
+
+```shell
+cmake --build build --target sonarqube
+```

cmake/Tools.cmake

@@ -50,6 +50,43 @@ function(target_clang_format_setup target)
 	clang_format_setup(${target_sources})
 endfunction()
 
+function(sonarqube_setup)
+	if( WIN32 )
+		find_program( buildwrapper_tmp build-wrapper-win-x86-64.exe )
+	elseif( APPLE )
+		find_program( buildwrapper_tmp build-wrapper-macosx-x86 )
+	else()
+		find_program( buildwrapper_tmp build-wrapper-linux-x86-64 )
+	endif()
+	if( buildwrapper_tmp )
+		set( BUILDWRAPPER_EXECUTABLE ${buildwrapper_tmp})
+		unset( buildwrapper_tmp )
+
+		add_custom_target( sonarqube-build
+			COMMAND
+				${CMAKE_MAKE_PROGRAM} clean
+			COMMAND
+				${BUILDWRAPPER_EXECUTABLE}
+				--out-dir bw-output
+				${CMAKE_MAKE_PROGRAM}
+			COMMENT
+				"Run sonarqube build"
+			WORKING_DIRECTORY 
+				${CMAKE_BINARY_DIR} 
+		)
+
+		add_custom_target( sonarqube
+			COMMAND
+				sonar-scanner
+			COMMENT
+				"Run sonarqube analysis"
+			WORKING_DIRECTORY 
+				${CMAKE_SOURCE_DIR} 
+		)
+
+		add_dependencies( sonarqube sonarqube-build )
+	endif()
+endfunction()
 ###
 
 # Enable clang-tidy either setting the app or using the option

examples/leader/CMakeLists.txt

@@ -33,7 +33,7 @@ endif()
 target_link_libraries( ${PROJECT_NAME} 
 	consulcpp
 	protobuf::libprotobuf
-	gRPC::gpr gRPC::grpc gRPC::grpc++ gRPC::grpc_cronet
+	gRPC::gpr gRPC::grpc gRPC::grpc++
 )
 
 if( UNIX )
@@ -51,6 +51,7 @@ target_include_directories( ${PROJECT_NAME}
 )
 
 clang_format_setup( ${SOURCES} )
+sonarqube_setup()
 
 include(GNUInstallDirs)
 

examples/leader/main.cpp

@@ -7,6 +7,7 @@
 #include <csignal>
 #include <chrono>
 #include <thread>
+#include <optional>
 
 #include "../common/helpers.h"
 
@@ -28,9 +29,7 @@ class HealthServiceImpl final : public grpc::health::v1::Health::Service
 	}
 };
 
-static std::unique_ptr<grpc::Server> gServer;
-
-void RunServer( const consulcpp::Service & service )
+void TestService( consulcpp::Service & service )
 {
 	std::string			serverAddress = fmt::format( "{}:{}", service.mAddress, service.mPort );
 	HealthServiceImpl	healthService;
@@ -39,21 +38,30 @@ void RunServer( const consulcpp::Service & service )
 	builder.AddListeningPort( serverAddress, grpc::InsecureServerCredentials() );
 	builder.RegisterService( &healthService );
 
-	gServer = builder.BuildAndStart();
-	if( gServer ) {
-		spdlog::info( "Server listening on {}", serverAddress );
-		gServer->Wait();
+	if( std::unique_ptr<grpc::Server> server = builder.BuildAndStart(); server ){
+		std::thread grpcThread( &grpc::Server::Wait, server.get() );
+		spdlog::info( "Server listening on {}:{}", service.mAddress, service.mPort );
+		loop();
+		server->Shutdown();
+		grpcThread.join();
 		spdlog::info( "Server stopped" );
 	} else {
-		spdlog::critical( "Cannot start gRPC server on {}", serverAddress );
+		spdlog::critical( "Cannot start gRPC server on {}:{}", service.mAddress, service.mPort );
 	}
 }
-
 int main( int argc, char * argv[] )
 {
-	consulcpp::Consul consul;
-
-	if( consul.connect() ) {
+	unsigned short port = 50051;
+
+	if( argc > 1 ) {
+		if( auto maybePort = consulcpp::utils::asPort( argv[1] ); maybePort ){
+			port = maybePort.value();
+		}else{
+			spdlog::error( "This is not a valid port number {}", argv[1] );
+			return 1;
+		}
+	}
+	if( consulcpp::Consul consul; consul.connect() ) {
 		spdlog::info( "Agent address {}", consul.address() );
 
 		consulcpp::Service		service;
@@ -62,20 +70,18 @@ int main( int argc, char * argv[] )
 		service.mId		 = fmt::format( "{}", std::chrono::duration_cast<std::chrono::milliseconds>( std::chrono::system_clock::now().time_since_epoch() ).count() );
 		service.mName	 = "leader-demo";
 		service.mAddress = consul.address();
-		if( argc > 1 ) {
-			service.mPort = std::stoi( argv[ 1 ] );
-		} else {
-			service.mPort = 50051;
-		}
+		service.mPort    = port;
+	
+		check.mId							  = "presence";
 		check.mInterval						  = "5s";
 		check.mDeregisterCriticalServiceAfter = "1m";
 		check.mGRPC							  = fmt::format( "{}:{}/Health", service.mAddress, service.mPort );
 		service.mChecks						  = { check };
 
 		// Purge death services
 		std::vector<consulcpp::Service> otherServices = consul.services().findInCatalog( service.mName, service.mTags );
-		for( auto service: otherServices ) {
-			consul.services().destroy( service );
+		for( const auto & otherService: otherServices ) {
+			consul.services().destroy( otherService );
 		}
 
 		consul.services().create( service );
@@ -84,21 +90,15 @@ int main( int argc, char * argv[] )
 
 		consul.kv().set( "my-key", "my-value" );
 
-		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 ) {
 			spdlog::info( "I'm the leader" );
 		} else {
 			spdlog::info( "I'm a follower" );
 		}
-		std::thread grpcThread( RunServer, service );
-		loop();
-		if( gServer ) {
-			gServer->Shutdown();
-		}
-		grpcThread.join();
 
-		auto val = consul.kv().get( "my-key" );
-		if( val ) {
+		TestService( service );
+
+		if( auto val = consul.kv().get( "my-key" ); val ) {
 			spdlog::info( "Key value was {}", val.value() );
 			if( consul.kv().destroy( "my-key" ) ) {
 				spdlog::info( "Key deleted" );

include/consulcpp/Consul.h

@@ -22,28 +22,28 @@ class ConsulCPP_API Consul
 	//! 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"
-	Consul( const std::string & agentAddress );	
+	explicit Consul( std::string_view agentAddress );	
 	~Consul();
 
 	/*! Connects to the local agent
 	*/
-	bool connect();
+	[[nodiscard]] bool connect();
 
 	//! Address where consul agent is running	
-	std::string address() const;
+	[[nodiscard]] std::string address() const;
 	//! Agent end point address, including the schema and port
-	std::string agentAddress() const;
+	[[nodiscard]] std::string agentAddress() const;
 	//! Consul API Version
-	std::string agentAPIVersion() const;
+	[[nodiscard]] std::string agentAPIVersion() const;
 
 	// Services access
-	Services & services() const;
+	[[nodiscard]] Services & services() const;
 	// Sessions access
-	Sessions & sessions() const;
+	[[nodiscard]] Sessions & sessions() const;
 	// Leader election access
-	Leader & leader() const;
+	[[nodiscard]] Leader & leader() const;
 	// KV Storer access
-	KV & kv() const;
+	[[nodiscard]] KV & kv() const;
 
 private:
 	struct Private;

include/consulcpp/ConsulCpp

@@ -6,3 +6,4 @@
 #include <consulcpp/Sessions.h>
 #include <consulcpp/Leader.h>
 #include <consulcpp/KV.h>
+#include <consulcpp/Utils.h>

include/consulcpp/Export.h

@@ -19,17 +19,3 @@
 	#define ConsulCPP_API
 #endif
 
-// Temporary hack for Ubuntu 16 default gcc compiler
-// https://codereview.stackexchange.com/a/136373
-#if __has_include(<optional>)
-#include <optional>
-namespace stdx {
-	using namespace ::std;
-}
-#elif __has_include(<experimental/optional>)
-#include <experimental/optional>
-namespace stdx {
-	using namespace ::std;
-	using namespace ::std::experimental;
-}
-#endif