WS-3330: CI add coverage for sonar

Author: Adam Soos

.gitignore

@@ -1,6 +1,7 @@
 # Dependency directory
 node_modules
 
+coverage
 target
 
 .grunt

CI.Jenkinsfile

@@ -9,17 +9,41 @@ node ("docker-light") {
             checkout scm
         }
         stage("Build And Test") {
-            nodeVersions.each { version ->
-              sh "docker run --rm \
-                    --pull always \
-                    --volume ${sourceDir}:/source \
-                    node:${version}-alpine \
-                    sh -c \"cd /source && npm install && npx grunt\""
+
+            withSonarQubeEnv {
+                mySonarOpts="-Dsonar.login=${env.SONAR_AUTH_TOKEN} -Dsonar.host.url=${env.SONAR_HOST_URL} -D"
+                if("${env.CHANGE_ID}" != "null"){
+                        mySonarOpts = "$mySonarOpts -Dsonar.pullrequest.key=${env.CHANGE_ID} -Dsonar.pullrequest.branch=${env.BRANCH_NAME}"
+                } else {
+                    mySonarOpts = "$mySonarOpts -Dsonar.branch.name=${env.BRANCH_NAME}"
+                }
+                if ("${env.CHANGE_BRANCH}" != "null") {
+                    mySonarOpts="$mySonarOpts -Dsonar.pullrequest.base=${env.CHANGE_TARGET} -Dsonar.pullrequest.branch=${env.CHANGE_BRANCH}"
+                }
+
+                nodeVersions.each { version ->
+                    if (version == "23") {
+                        sonarExec="cd /root/ && \
+                                       wget -q https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-4.8.1.3023-linux.zip && \
+                                       unzip -q sonar-scanner-cli-4.8.1.3023-linux.zip && \
+                                       cd /source && \
+                                       /root/sonar-scanner-4.8.1.3023-linux/bin/sonar-scanner ${mySonarOpts}"
+                    } else {
+                        sonarExec="echo Skipping Sonar for this version."
+                    }
+
+                    sh "docker run --rm \
+                            --pull always \
+                            --volume ${sourceDir}:/source \
+                            node:${version}-alpine \
+                            sh -c \"cd /source && npm install && npx grunt && ${sonarExec} && chown -R 9960:9960 /source\""
+                }
             }
         }
     }
     catch (e) {
         currentBuild.result = "FAILED"
         throw e
     }
-}
+}
+// todo post to teams

Gruntfile.js

@@ -24,7 +24,7 @@ module.exports = function(grunt) {
         }
       }
     },
-     mochaTest: {
+    mochaTest: {
       test: {
         options: {
           reporter: 'spec',
@@ -34,6 +34,17 @@ module.exports = function(grunt) {
         src: ['tests/**/*.js']
       }
     },
+    nyc: {
+      cover: {
+        options: {
+          include: ['lib/**/*.js'],
+          reporter: ['html', 'lcov'],
+          reportDir: 'coverage'
+        },
+        cmd: false,
+        args: ['grunt', 'mochaTest']
+      }
+    },
     'gh-pages': {
       options: {
         base: 'target/html'
@@ -54,14 +65,16 @@ module.exports = function(grunt) {
 
   // These plugins provide necessary tasks.
   grunt.loadNpmTasks("grunt-contrib-clean");
-  grunt.loadNpmTasks("grunt-contrib-watch");;
+  grunt.loadNpmTasks("grunt-contrib-watch");
   grunt.loadNpmTasks("grunt-jsdoc");
   grunt.loadNpmTasks('grunt-mocha-test');
   grunt.loadNpmTasks('grunt-gh-pages');
+  grunt.loadNpmTasks('grunt-simple-nyc');
 
   // Task definitions.
   // run `grunt <task>` in command line and it will run the sequence in brackets
-  grunt.registerTask("default", ["clean","jsdoc", "test"]);
+  grunt.registerTask("default", ["clean","jsdoc", "nyc:cover"]);
   grunt.registerTask("doc", ["jsdoc", "gh-pages"]);
   grunt.registerTask("test", ["mochaTest"]);
+  grunt.registerTask("coverage", ["nyc:cover"]);
 };

package.json

@@ -54,8 +54,10 @@
     "grunt-jsdoc": "^2.4.1",
     "grunt-jslint": "^1.1.15",
     "grunt-mocha-test": "^0.13.3",
+    "grunt-simple-nyc": "^3.0.1",
     "mocha": "^10.8.2",
     "nock": "^13.5.5",
+    "nyc": "^17.1.0",
     "temporary": "1.1.0"
   },
   "dependencies": {

sonar-project.properties

@@ -0,0 +1,3 @@
+sonar.projectKey=rosette-api-nodejs-binding
+sonar.sources=lib
+sonar.javascript.lcov.reportPaths=./coverage/lcov.info