Merge pull request #3 from Simverge/sonarcloud

Enable SonarCloud analysis

Author: jimmysoda

.travis.yml

@@ -1,8 +1,17 @@
 sudo: required
 
-language: minimal
+# Required by SonarCloud - see https://docs.travis-ci.com/user/sonarcloud/
+language: java
+dist: trusty
+
 services: docker
 
+addons:
+  sonarcloud:
+    organization: "simverge"
+    token:
+      secure: $SONAR_TOKEN
+
 env:
   - DISTRO=alpine BUILD_TYPE=Release
   - DISTRO=alpine BUILD_TYPE=Debug
@@ -14,4 +23,5 @@ before_install:
 
 script:
   - chmod u+x $TRAVIS_BUILD_DIR/tests/travis/script.sh
-  - docker run -e TRAVIS_BRANCH -e BUILD_TYPE -e DISTRO -v $TRAVIS_BUILD_DIR:/pdalc -t simverge/pdalc-build-deps:$DISTRO /pdalc/tests/travis/script.sh
+  - docker run -e TRAVIS_BRANCH -e BUILD_TYPE -e DISTRO -v $TRAVIS_BUILD_DIR:/pdalc -t simverge/pdalc-build-deps:$DISTRO /pdalc/tests/travis/script.sh
+  - if [ "$DISTRO" = "ubuntu" ]; then sonar-scanner; fi

README.md

@@ -2,6 +2,7 @@ pdal-c: PDAL C API
 ==================
 
 [![Build Status](https://travis-ci.com/Simverge/pdal-c.svg?branch=master)](https://travis-ci.com/Simverge/pdal-c)
+[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=Simverge_pdal-c&metric=alert_status)](https://sonarcloud.io/project/issues?id=Simverge_pdal-c)
 
 *pdal-c* is a C API for the Point Data Abstraction Library ([PDAL](http:/github.com/PDAL/PDAL))
 and is compatible with PDAL 1.7 and later.

sonar-project.properties

@@ -0,0 +1,20 @@
+# SonarQube/SonarCloud properties for pdal-c
+
+# must be unique in a given SonarQube instance
+sonar.projectKey=Simverge_pdal-c
+# this is the name and version displayed in the SonarQube UI. Was mandatory prior to SonarQube 6.1.
+sonar.projectName=pdal-c
+sonar.projectVersion=1.8
+ 
+# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
+# This property is optional if sonar.modules is set. 
+sonar.sources=source
+ 
+# Encoding of the source code. Default is default system encoding
+#sonar.sourceEncoding=UTF-8
+
+sonar.branch.name=sonarcloud
+
+# Properties specific to the C/C++ analyzer:
+sonar.cfamily.build-wrapper-output=bw-output
+#sonar.cfamily.gcov.reportsPath=build/${env.DISTRO}-x86_64-${env.BUILD_TYPE}/coverage_pdalc

source/pdal/pdalc_config.cpp

@@ -40,20 +40,28 @@ namespace pdal
 {
 namespace capi
 {
-size_t PDALGetGdalDataPath(char *path, size_t size)
+/**
+ * Retrieves the value of an environment variable.
+ * 
+ * @param name The name of the environment variable
+ * @param[out] path The buffer used to retrieve the value
+ * @param size The size of the provided buffer
+ * @return The size of the retrieved value
+ */
+size_t getEnvironmentVariable(const char *name, char *value, size_t size)
 {
     size_t length = 0;
 
-    if (path && size > 0)
+    if (value && size > 0)
     {
-        path[0] = '\0';
-        path[size-1] = '\0';
+        value[0] = '\0';
+        value[size-1] = '\0';
 
         char *env = nullptr;
 
         try
         {
-            env = std::getenv("GDAL_DATA");
+            env = std::getenv(name);
         }
         catch (const std::exception &)
         {
@@ -62,42 +70,22 @@ size_t PDALGetGdalDataPath(char *path, size_t size)
 
         if (env)
         {
-            std::strncpy(path, env, size - 1);
+            std::strncpy(value, env, size - 1);
             length = std::min(std::strlen(env), size - 1);
         }
     }
 
     return length;
 }
 
-size_t PDALGetProj4DataPath(char *path, size_t size)
+size_t PDALGetGdalDataPath(char *path, size_t size)
 {
-    size_t length = 0;
-
-    if (path && size > 0)
-    {
-        path[0] = '\0';
-        path[size-1] = '\0';
-
-        char *env = nullptr;
-
-        try
-        {
-            env = std::getenv("PROJ_LIB");
-        }
-        catch (const std::exception &)
-        {
-            env = nullptr;
-        }
-
-        if (env)
-        {
-            std::strncpy(path, env, size - 1);
-            length = std::min(std::strlen(env), size - 1);
-        }
-    }
+    return getEnvironmentVariable("GDAL_DATA", path, size);
+}
 
-    return length;
+size_t PDALGetProj4DataPath(char *path, size_t size)
+{
+    return getEnvironmentVariable("PROJ_LIB", path, size);
 }
 
 void PDALSetGdalDataPath(const char *path)

tests/docker/pdalc-build-deps_alpine/Dockerfile

@@ -11,4 +11,5 @@ RUN \
 		g++ \
 		lcov \
 		make \
-		cmake
+		cmake \
+		curl

tests/travis/script.sh

@@ -3,6 +3,13 @@
 gcc --version
 g++ --version
 
+if [ "$DISTRO" = "ubuntu" ]; then
+	# Download and unzip the sonarcloud build wrapper
+	curl -LsS https://sonarcloud.io/static/cpp/build-wrapper-linux-x86.zip > build-wrapper-linux-x86.zip
+	unzip build-wrapper-linux-x86.zip
+	export SONARCLOUD_DIR=$PWD/build-wrapper-linux-x86
+fi
+
 export CI_PROJECT_DIR=/pdalc
 export CI_PROJECT_NAME=pdal-c
 export TARGET_PLATFORM=$DISTRO-`uname -m`-$BUILD_TYPE
@@ -11,5 +18,10 @@ rm -rf "$CI_PROJECT_DIR/build/$TARGET_PLATFORM"
 mkdir -p "$CI_PROJECT_DIR/build/$TARGET_PLATFORM"
 cd "$CI_PROJECT_DIR/build/$TARGET_PLATFORM"
 cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DPDALC_GCC_PARAM_GGC_MIN_HEAPSIZE=8192 "$CI_PROJECT_DIR"
-make
+
+if [ "$DISTRO" = "ubuntu" ]; then
+	$SONARCLOUD_DIR/build-wrapper-linux-x86-64 --out-dir $CI_PROJECT_DIR/bw-output make
+else
+	make
+fi
 make coverage_pdalc