Add CI pipeline and a very basic test (#3)

* Add a very basic test of the statsd client
* Setup a simple test and a CI pipeline

Author: vthiery

.gitignore

@@ -1 +1 @@
-build/
+bin

.travis.yml

@@ -0,0 +1,48 @@
+language: cpp
+
+matrix:
+  include:
+    - os: linux
+      addons:
+        apt:
+          sources:
+            - ubuntu-toolchain-r-test
+          packages:
+            - g++-7
+      env:
+         - MATRIX_EVAL="BUILD_MODE=Debug && CC=gcc-7 && CXX=g++-7 && CMAKE_CXX_FLAGS="${CMAKE_CXX_FLAGS} -std=c++17"
+
+    - os: linux
+      addons:
+        apt:
+          sources:
+            - ubuntu-toolchain-r-test
+          packages:
+            - g++-7
+      env:
+         - MATRIX_EVAL="BUILD_MODE=Release && CC=gcc-7 && CXX=g++-7 && CMAKE_CXX_FLAGS="${CMAKE_CXX_FLAGS} -std=c++17"
+
+    - os: linux
+      addons:
+        apt:
+          sources:
+            - ubuntu-toolchain-r-test
+          packages:
+            - g++-7
+      env:
+         - MATRIX_EVAL="BUILD_MODE=Debug && CC=gcc-7 && CXX=g++-7 && CMAKE_CXX_FLAGS="${CMAKE_CXX_FLAGS} -std=c++14"
+
+    - os: linux
+      addons:
+        apt:
+          sources:
+            - ubuntu-toolchain-r-test
+          packages:
+            - g++-7
+      env:
+         - MATRIX_EVAL="BUILD_MODE=Release && CC=gcc-7 && CXX=g++-7 && CMAKE_CXX_FLAGS="${CMAKE_CXX_FLAGS} -std=c++14"
+
+before_install:
+    - eval "${MATRIX_EVAL}"
+
+script: make test

CMakeLists.txt

@@ -0,0 +1,14 @@
+cmake_minimum_required(VERSION 3.2)
+
+project(StatsdClient)
+
+include_directories(${CMAKE_CURRENT_SOURCE_DIR}/src)
+
+install(FILES src/* DESTINATION include)
+
+find_package (Threads)
+add_executable(testStatsdClient ${CMAKE_CURRENT_SOURCE_DIR}/tests/testStatsdClient.cpp)
+target_link_libraries(testStatsdClient ${CMAKE_THREAD_LIBS_INIT})
+
+enable_testing()
+add_test(testSuite testStatsdClient)

Makefile

@@ -0,0 +1,18 @@
+# simple makefile to build, test and clean
+
+BUILD_MODE ?= Release
+
+build: clean
+	@echo "Build in ${BUILD_MODE} mode"
+	mkdir -p bin/${BUILD_MODE}
+	@cd bin/${BUILD_MODE}; cmake ../../ -DCMAKE_BUILD_TYPE=${BUILD_MODE}
+	@cd bin/${BUILD_MODE}; make
+
+test: build
+	@cd bin/${BUILD_MODE}; make test
+
+install: build
+	@cd bin/${BUILD_MODE}; make install
+
+clean:
+	@rm -rf bin

README.md

@@ -20,7 +20,7 @@ using namespace Statsd;
 int main()
 {
     // Define the client
-    StatsdClient client{ "127.0.0.1", 5005, "myPrefix_", true };
+    StatsdClient client{ "127.0.0.1", 5005, "myPrefix.", 3 };
 
     // Increment "coco"
     client.increment("coco");

src/StatsdClient.hpp

@@ -65,16 +65,6 @@ class StatsdClient
 
     //!@}
 
-private:
-
-    // @name Private methods
-    // @{
-
-    //! Returns a cleaned key
-    inline std::string clean(const std::string& key) const noexcept;
-
-    // @}
-
 private:
 
     //! The prefix to be used for metrics
@@ -166,9 +156,6 @@ send(const std::string& key, const int value, const std::string& type, const flo
         }
     }
 
-    // Clean the key
-    clean(key);
-
     // Prepare the buffer, with a sampling rate if specified different from 1.0f
     char buffer[256];
     if (isFrequencyOne(frequency))
@@ -186,22 +173,6 @@ send(const std::string& key, const int value, const std::string& type, const flo
     m_sender.send(buffer);
 }
 
-std::string
-StatsdClient::
-clean(const std::string& key) const noexcept
-{
-    std::string cleanKey = key;
-    size_t pos = key.find_first_of(":|@");
-
-    // Add the '_' appropriately to the key
-    while (pos != std::string::npos)
-    {
-        cleanKey[pos] = '_';
-        pos = cleanKey.find_first_of(":|@");
-    }
-    return cleanKey;
-}
-
 }
 
 #endif

tests/testStatsdClient.cpp

@@ -0,0 +1,38 @@
+#include <StatsdClient.hpp>
+#include <cassert>
+
+using namespace Statsd;
+
+int main()
+{
+    StatsdClient client{ "localhost", 8080, "myPrefix.", 1 };
+
+    // set a new config with a different port
+    client.setConfig("localhost", 80, "myPrefix.");
+
+    // Increment "coco"
+    client.increment("coco");
+    assert(!client.errorMessage());
+
+    // Decrement "kiki"
+    client.decrement("kiki");
+    assert(!client.errorMessage());
+
+    // Adjusts "toto" by +3
+    client.count("toto", 2, 0.1f);
+    assert(!client.errorMessage());
+
+    // Record a gauge "titi" to 3
+    client.gauge("titi", 3);
+    assert(!client.errorMessage());
+
+    // Record a timing of 2ms for "myTiming"
+    client.timing("myTiming", 2, 0.1f);
+    assert(!client.errorMessage());
+
+    // Send a metric explicitly
+    client.send("tutu", 4, "c", 2.0f);
+    assert(!client.errorMessage());
+
+    return EXIT_SUCCESS;
+}