screwdriver-coverage-sonar 3.1.5 → 3.3.2

package/commands.txt

@@ -15,7 +15,7 @@ SCANNER_PATH="/opt/sd/sonarscanner-cli-${TARGET_OS}/bin/sonar-scanner"
 if [ -s ${SCANNER_PATH} ] && [ -x ${SCANNER_PATH} ]; then eval $SCANNER_PATH $SCANNER_OPTION || true; exit 0; fi
 if unzip -version > /dev/null 2>&1; then SD_UNZIP_CMD_WRAPPER="eval"; else SD_UNZIP_CMD_WRAPPER="sd-step exec --pkg-version 6.0 core/unzip"; fi
 export SD_UNZIP_CMD_WRAPPER
-SD_SONAR_SCANNER_CLI_VERSION=4.4.0.2170
+SD_SONAR_SCANNER_CLI_VERSION=4.6.2.2472
 $SD_CURL_CMD_WRAPPER "curl -o ./sonarscanner.zip -L https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-${SD_SONAR_SCANNER_CLI_VERSION}-${TARGET_OS}.zip"
 $SD_UNZIP_CMD_WRAPPER "unzip -q ./sonarscanner.zip"
 SCANNER_PATH="sonar-scanner-${SD_SONAR_SCANNER_CLI_VERSION}-${TARGET_OS}/bin/sonar-scanner"

package/index.js

@@ -6,7 +6,7 @@ const fs = require('fs');
 const joi = require('joi');
 const hoek = require('@hapi/hoek');
 const path = require('path');
-const request = require('request-promise-native');
+const request = require('screwdriver-request');
 const uuidv4 = require('uuid/v4');
 const logger = require('screwdriver-logger');
 const CoverageBase = require('screwdriver-coverage-base');
@@ -28,14 +28,10 @@ let sonarGitAppName;
  */
 function createProject(projectKey) {
     return request({
-        json: true,
         method: 'POST',
-        // eslint-disable-next-line max-len
-        uri: `${sonarHost}/api/projects/create?project=${projectKey}&name=${projectKey}`,
-        auth: {
-            username: adminToken
-        }
-    }).catch((err) => {
+        url: `${sonarHost}/api/projects/create?project=${projectKey}&name=${projectKey}`,
+        username: adminToken
+    }).catch(err => {
         if (err.statusCode === 400 && err.message.includes('already exists')) {
             return {};
         }
@@ -53,14 +49,10 @@ function createProject(projectKey) {
  */
 function createUser(username, password) {
     return request({
-        json: true,
         method: 'POST',
-        // eslint-disable-next-line max-len
-        uri: `${sonarHost}/api/users/create?login=${username}&name=${username}&password=${password}`,
-        auth: {
-            username: adminToken
-        }
-    }).catch((err) => {
+        url: `${sonarHost}/api/users/create?login=${username}&name=${username}&password=${password}`,
+        username: adminToken
+    }).catch(err => {
         if (err.statusCode === 400 && err.message.includes('already exists')) {
             return {};
         }
@@ -82,12 +74,9 @@ function configureGitApp(projectKey, projectName) {
 
     // Check if binding exists
     return request({
-        json: true,
         method: 'GET',
-        uri: `${sonarHost}/api/alm_settings/get_binding?project=${componentId}`,
-        auth: {
-            username: adminToken
-        }
+        url: `${sonarHost}/api/alm_settings/get_binding?project=${componentId}`,
+        username: adminToken
     }).catch(() => {
         // if binding does not exist, add it
         logger.info(`Binding does not exist for Sonar project ${projectKey}, adding`);
@@ -96,19 +85,14 @@ function configureGitApp(projectKey, projectName) {
             return Promise.resolve();
         }
 
-        // eslint-disable-next-line max-len
         const parameters = `almSetting=${gitAppEncoded}&project=${componentId}&repository=${projectName}&summaryCommentEnabled=true`;
 
         return request({
-            json: true,
             method: 'POST',
-            uri: `${sonarHost}/api/alm_settings/set_github_binding?${parameters}`,
-            auth: {
-                username: adminToken
-            }
-        }).catch((error) => {
+            url: `${sonarHost}/api/alm_settings/set_github_binding?${parameters}`,
+            username: adminToken
+        }).catch(error => {
             // if cannot configure app, do not throw err
-            // eslint-disable-next-line max-len
             logger.error(`Failed to configure Git App ${gitApp} for Sonar project ${projectKey}: ${error.message}`);
 
             return Promise.resolve();
@@ -126,14 +110,10 @@ function configureGitApp(projectKey, projectName) {
 function grantUserPermission(username, projectKey) {
     // Always return 204 even with duplicate calls
     return request({
-        json: true,
         method: 'POST',
-        // eslint-disable-next-line
-        uri: `${sonarHost}/api/permissions/add_user?login=${username}&permission=scan&projectKey=${projectKey}`,
-        auth: {
-            username: adminToken
-        }
-    }).catch((err) => {
+        url: `${sonarHost}/api/permissions/add_user?login=${username}&permission=scan&projectKey=${projectKey}`,
+        username: adminToken
+    }).catch(err => {
         throw new Error(`Failed to grant user ${username} permission: ${err.message}`);
     });
 }
@@ -148,13 +128,10 @@ function generateToken(username) {
     const tokenName = uuidv4();
 
     return request({
-        json: true,
         method: 'POST',
-        uri: `${sonarHost}/api/user_tokens/generate?login=${username}&name=${tokenName}`,
-        auth: {
-            username: adminToken
-        }
-    }).catch((err) => {
+        url: `${sonarHost}/api/user_tokens/generate?login=${username}&name=${tokenName}`,
+        username: adminToken
+    }).catch(err => {
         throw new Error(`Failed to generate user ${username} token: ${err.message}`);
     });
 }
@@ -178,7 +155,6 @@ function getMetrics({ projectKey, startTime, endTime, prNum, sonarEnterprise: en
     const parsedEndTime = endTime.replace(/\.(.*)/, timezoneOffset);
     const from = encodeURIComponent(parsedStartTime);
     const to = encodeURIComponent(parsedEndTime);
-    // eslint-disable-next-line max-len
     let coverageUrl = `${sonarHost}/api/measures/search_history?component=${componentId}&metrics=tests,test_errors,test_failures,coverage&from=${from}&to=${to}&ps=1`;
 
     if (enterpriseEnabled && prNum) {
@@ -186,18 +162,15 @@ function getMetrics({ projectKey, startTime, endTime, prNum, sonarEnterprise: en
     }
 
     return request({
-        json: true,
         method: 'GET',
-        uri: coverageUrl,
-        auth: {
-            username: adminToken
-        }
+        url: coverageUrl,
+        username: adminToken
     })
-        .then((result) => {
+        .then(result => {
             const measures = {};
 
             // measures in result is an array, covert it to an object with metric name as key
-            (hoek.reach(result, 'measures') || []).forEach((measure) => {
+            (hoek.reach(result, 'body.measures') || []).forEach(measure => {
                 measures[measure.metric] = measure;
             });
 
@@ -219,12 +192,13 @@ function getMetrics({ projectKey, startTime, endTime, prNum, sonarEnterprise: en
 
             return metrics;
         })
-        .catch((err) => {
+        .catch(err => {
             // if there is no coverage measurement target, 404 and 'Component key not found' are returned and this is not an error
             if (err.statusCode !== 404 || !/Component key '.*' not found/.test(err.message)) {
                 // if cannot get coverage, do not throw err
-                // eslint-disable-next-line max-len
-                logger.error(`Failed to get coverage and tests percentage for Sonar project ${projectKey}: ${err.message}`);
+                logger.error(
+                    `Failed to get coverage and tests percentage for Sonar project ${projectKey}: ${err.message}`
+                );
             }
 
             return {
@@ -251,16 +225,24 @@ function getMetrics({ projectKey, startTime, endTime, prNum, sonarEnterprise: en
  * @param  {String}     [config.prParentJobId]      Screwdriver PR parent job ID
  * @return {Object}                                 Sonar project key, project name, and username
  */
-function getProjectData({ scope, enterpriseEnabled, jobId: buildJobId,
-    jobName: buildJobName, pipelineId, pipelineName, projectKey, prParentJobId, prNum }) {
+function getProjectData({
+    scope,
+    enterpriseEnabled,
+    jobId: buildJobId,
+    jobName: buildJobName,
+    pipelineId,
+    pipelineName,
+    projectKey,
+    prParentJobId,
+    prNum
+}) {
     let jobId = buildJobId;
     let jobName = buildJobName;
 
     // Determine scope based on projectKey
     if (projectKey) {
         const [projectScope, id] = projectKey.split(':');
-        const projectName = projectScope === 'pipeline' ?
-            pipelineName : `${pipelineName}:${jobName}`;
+        const projectName = projectScope === 'pipeline' ? pipelineName : `${pipelineName}:${jobName}`;
         const username = `user-${projectScope}-${id}`;
 
         return {
@@ -272,7 +254,7 @@ function getProjectData({ scope, enterpriseEnabled, jobId: buildJobId,
     }
 
     // Use user-configured scope; otherwise figure out default scope: pipeline scope for enterprise edition, job scope for everything else
-    const userScope = (scope && scope !== 'undefined') ? scope : undefined;
+    const userScope = scope && scope !== 'undefined' ? scope : undefined;
     const coverageScope = userScope || (enterpriseEnabled ? 'pipeline' : 'job');
 
     if (coverageScope === 'pipeline') {
@@ -316,14 +298,30 @@ class CoverageSonar extends CoverageBase {
     constructor(config) {
         super();
 
-        this.config = joi.attempt(config, joi.object().keys({
-            sdApiUrl: joi.string().uri().required(),
-            sdUiUrl: joi.string().uri().required(),
-            sonarHost: joi.string().uri().required(),
-            adminToken: joi.string().required(),
-            sonarEnterprise: joi.boolean().default(false),
-            sonarGitAppName: joi.string().default(DEFAULT_GIT_APP_NAME)
-        }).unknown(true), 'Invalid config for sonar coverage plugin');
+        this.config = joi.attempt(
+            config,
+            joi
+                .object()
+                .keys({
+                    sdApiUrl: joi
+                        .string()
+                        .uri()
+                        .required(),
+                    sdUiUrl: joi
+                        .string()
+                        .uri()
+                        .required(),
+                    sonarHost: joi
+                        .string()
+                        .uri()
+                        .required(),
+                    adminToken: joi.string().required(),
+                    sonarEnterprise: joi.boolean().default(false),
+                    sonarGitAppName: joi.string().default(DEFAULT_GIT_APP_NAME)
+                })
+                .unknown(true),
+            'Invalid config for sonar coverage plugin'
+        );
 
         sdCoverageAuthUrl = `${this.config.sdApiUrl}/v4/coverage/token`;
         adminToken = this.config.adminToken;
@@ -331,8 +329,7 @@ class CoverageSonar extends CoverageBase {
         sonarEnterprise = this.config.sonarEnterprise;
         sonarGitAppName = this.config.sonarGitAppName;
 
-        this.uploadCommands = COMMANDS
-            .replace('$SD_SONAR_HOST', sonarHost)
+        this.uploadCommands = COMMANDS.replace('$SD_SONAR_HOST', sonarHost)
             .replace('$SD_UI_URL', this.config.sdUiUrl)
             .replace('$SD_SONAR_ENTERPRISE', sonarEnterprise)
             .split('\n');
@@ -354,8 +351,7 @@ class CoverageSonar extends CoverageBase {
      * @return {Promise}                        An access token that build can use
      *                                          to talk to coverage server
      */
-    _getAccessToken({ scope, username, projectKey, projectName, jobName, pipelineName,
-        buildCredentials }) {
+    _getAccessToken({ scope, username, projectKey, projectName, jobName, pipelineName, buildCredentials }) {
         const { jobId, pipelineId, prParentJobId } = buildCredentials;
         let projectData = { username, projectKey, projectName };
 
@@ -379,7 +375,7 @@ class CoverageSonar extends CoverageBase {
             .then(() => createUser(projectData.username, password))
             .then(() => grantUserPermission(projectData.username, projectData.projectKey))
             .then(() => generateToken(projectData.username))
-            .then(res => res.token);
+            .then(res => res.body.token);
     }
 
     /**
@@ -402,8 +398,18 @@ class CoverageSonar extends CoverageBase {
      *                                              - project url
      *                                              - Sonar env vars
      */
-    _getInfo({ scope, jobId, jobName, startTime, endTime, pipelineId,
-        pipelineName, prNum, projectKey: coverageProjectKey, prParentJobId }) {
+    _getInfo({
+        scope,
+        jobId,
+        jobName,
+        startTime,
+        endTime,
+        pipelineId,
+        pipelineName,
+        prNum,
+        projectKey: coverageProjectKey,
+        prParentJobId
+    }) {
         const { projectScope, projectKey, projectName, username } = getProjectData({
             enterpriseEnabled: sonarEnterprise,
             jobId,
@@ -418,7 +424,6 @@ class CoverageSonar extends CoverageBase {
 
         const infoObject = {
             envVars: {
-                // eslint-disable-next-line max-len
                 SD_SONAR_AUTH_URL: `${sdCoverageAuthUrl}?projectKey=${projectKey}&projectName=${projectName}&username=${username}&scope=${projectScope}`,
                 SD_SONAR_HOST: sonarHost,
                 SD_SONAR_ENTERPRISE: sonarEnterprise,
@@ -429,8 +434,8 @@ class CoverageSonar extends CoverageBase {
 
         // Only get coverage percentage if the steps are finished
         if (projectKey && startTime && endTime) {
-            return getMetrics({ projectKey, startTime, endTime, prNum, sonarEnterprise })
-                .then(({ coverage, tests }) => {
+            return getMetrics({ projectKey, startTime, endTime, prNum, sonarEnterprise }).then(
+                ({ coverage, tests }) => {
                     const componentId = encodeURIComponent(projectKey);
                     let projectUrl = `${this.config.sonarHost}/dashboard?id=${componentId}`;
 
@@ -443,7 +448,8 @@ class CoverageSonar extends CoverageBase {
                     infoObject.projectUrl = projectUrl;
 
                     return Promise.resolve(infoObject);
-                });
+                }
+            );
         }
 
         return Promise.resolve(infoObject);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screwdriver-coverage-sonar",
-  "version": "3.1.5",
+  "version": "3.3.2",
   "description": "SonarQube implementation of the coverage-base class",
   "main": "index.js",
   "scripts": {
@@ -30,24 +30,23 @@
     "Tiffany Kyi <tiffanykyi@gmail.com>"
   ],
   "devDependencies": {
-    "chai": "^3.5.0",
-    "eslint": "^4.3.0",
-    "eslint-config-screwdriver": "^3.0.0",
+    "chai": "^4.2.0",
+    "eslint": "^7.31.0",
+    "eslint-config-screwdriver": "^5.0.1",
     "mocha": "^8.3.2",
     "mocha-multi-reporters": "^1.5.1",
     "mocha-sonarqube-reporter": "^1.0.2",
     "mockery": "^2.1.0",
     "nyc": "^15.0.0",
-    "sinon": "^5.1.1"
+    "sinon": "^9.0.0"
   },
   "dependencies": {
-    "@hapi/hoek": "^9.0.4",
-    "joi": "^17.2.1",
-    "request": "^2.87.0",
-    "request-promise-native": "^1.0.5",
-    "screwdriver-coverage-base": "^2.0.0",
-    "screwdriver-logger": "^1.0.1",
-    "uuid": "^3.2.1"
+    "@hapi/hoek": "^9.2.0",
+    "joi": "^17.4.1",
+    "screwdriver-coverage-base": "^2.1.0",
+    "screwdriver-logger": "^1.1.0",
+    "screwdriver-request": "^1.0.1",
+    "uuid": "^3.4.0"
   },
   "release": {
     "debug": false,