screwdriver-coverage-sonar 3.3.2 → 3.4.0

package/commands.txt

@@ -1,13 +1,13 @@
 if [ ! -f sonar-project.properties ] && [ -z "$SD_SONAR_OPTS" ]; then echo "ERROR - No sonar project properties defined." && exit 0; fi
-if [ ! -z "$SD_PULL_REQUEST" ] && [ "$SD_SONAR_ENTERPRISE" = true ]; then export SD_SONAR_OPTS="${SD_SONAR_OPTS} -Dsonar.pullrequest.key=$SD_PULL_REQUEST -Dsonar.pullrequest.branch=${PR_BRANCH_NAME#*/} -Dsonar.pullrequest.base=${PR_BASE_BRANCH_NAME}"; fi
+if [ ! -z "$SD_PULL_REQUEST" ] && [ "$SD_SONAR_ENTERPRISE" = true ]; then export SD_SONAR_OPTS="${SD_SONAR_OPTS} -Dsonar.pullrequest.key=$SD_PULL_REQUEST -Dsonar.pullrequest.branch='${PR_BRANCH_NAME#*/}' -Dsonar.pullrequest.base='${PR_BASE_BRANCH_NAME}'"; fi
 if curl --version > /dev/null 2>&1; then SD_CURL_CMD_WRAPPER="eval"; else SD_CURL_CMD_WRAPPER="sd-step exec --pkg-version 7.54.1 core/curl"; fi
 export SD_CURL_CMD_WRAPPER
-SONAR_TOKEN=`$SD_CURL_CMD_WRAPPER "curl -H \"Authorization: Bearer $SD_TOKEN\" $SD_SONAR_AUTH_URL"`
+SONAR_TOKEN=`$SD_CURL_CMD_WRAPPER "curl -H \"Authorization: Bearer ${SD_TOKEN}\" \"${SD_SONAR_AUTH_URL}&selfSonarHost=${SD_SELF_SONAR_HOST}&selfSonarAdminToken=${SD_SELF_SONAR_ADMIN_TOKEN}\""`
 VERSION=`cat sonar-project.properties | awk -F= '/sonar.projectVersion=/{print $2}'`
 PROJECT_VERSION=${VERSION:='not provided'}
 SONAR_OPTIONS=`eval echo "$SD_SONAR_OPTS"`
 if echo $SCM_URL | grep git@ > /dev/null 2>&1; then export SONAR_SCM_URL=`echo $SCM_URL | sed -e 's/:/\//g' | sed -e 's/git@/https:\/\//g'`; else export SONAR_SCM_URL=${SCM_URL}; fi
-SCANNER_OPTION='"-Dsonar.host.url=$SD_SONAR_HOST" "-Dsonar.login=$SONAR_TOKEN" "-Dsonar.projectKey=$SD_SONAR_PROJECT_KEY" "-Dsonar.projectName=$SD_SONAR_PROJECT_NAME" "-Dsonar.projectVersion=$PROJECT_VERSION" "-Dsonar.links.scm=$SONAR_SCM_URL" "-Dsonar.links.ci=$SD_UI_URL/pipelines/$SD_PIPELINE_ID" "-Dsonar.scm.revision=$SD_BUILD_SHA" $SONAR_OPTIONS'
+if [ ! -z "$SD_SELF_SONAR_HOST" ]; then SCANNER_OPTION='"-Dsonar.host.url=$SD_SELF_SONAR_HOST" "-Dsonar.login=$SONAR_TOKEN" "-Dsonar.projectKey=$SD_SONAR_PROJECT_KEY" "-Dsonar.projectName=$SD_SONAR_PROJECT_NAME" "-Dsonar.projectVersion=$PROJECT_VERSION" "-Dsonar.links.scm=$SONAR_SCM_URL" "-Dsonar.links.ci=$SD_UI_URL/pipelines/$SD_PIPELINE_ID" "-Dsonar.scm.revision=$SD_BUILD_SHA" $SONAR_OPTIONS'; else SCANNER_OPTION='"-Dsonar.host.url=$SD_SONAR_HOST" "-Dsonar.login=$SONAR_TOKEN" "-Dsonar.projectKey=$SD_SONAR_PROJECT_KEY" "-Dsonar.projectName=$SD_SONAR_PROJECT_NAME" "-Dsonar.projectVersion=$PROJECT_VERSION" "-Dsonar.links.scm=$SONAR_SCM_URL" "-Dsonar.links.ci=$SD_UI_URL/pipelines/$SD_PIPELINE_ID" "-Dsonar.scm.revision=$SD_BUILD_SHA" $SONAR_OPTIONS'; fi
 SCANNER_PATH="/opt/sd/sonar-scanner/bin/sonar-scanner"
 if [ -s ${SCANNER_PATH} ] && [ -x ${SCANNER_PATH} ]; then eval $SCANNER_PATH $SCANNER_OPTION || true; exit 0; fi
 if [ `uname` = 'Darwin' ]; then TARGET_OS='macosx'; else TARGET_OS='linux'; fi

package/index.js

@@ -14,275 +14,6 @@ const CoverageBase = require('screwdriver-coverage-base');
 const COMMANDS = fs.readFileSync(path.join(__dirname, 'commands.txt'), 'utf8').trim();
 const DEFAULT_GIT_APP_NAME = 'Screwdriver Sonar PR Checks';
 
-let adminToken;
-let sonarHost;
-let sdCoverageAuthUrl;
-let sonarEnterprise;
-let sonarGitAppName;
-
-/**
- * Create a project in sonar
- * @method createProject
- * @param  {String} projectKey    Unique identifier for the project
- * @return {Promise}              Project object if it gets created or empty object if already exists
- */
-function createProject(projectKey) {
-    return request({
-        method: 'POST',
-        url: `${sonarHost}/api/projects/create?project=${projectKey}&name=${projectKey}`,
-        username: adminToken
-    }).catch(err => {
-        if (err.statusCode === 400 && err.message.includes('already exists')) {
-            return {};
-        }
-
-        throw new Error(`Failed to create project ${projectKey}: ${err.message}`);
-    });
-}
-
-/**
- * Create a user in sonar
- * @method createUser
- * @param  {String} username  Username of the user
- * @param  {String} password  Password of the user
- * @return {Promise}          User object if it gets created or empty object if already exists
- */
-function createUser(username, password) {
-    return request({
-        method: 'POST',
-        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 {};
-        }
-
-        throw new Error(`Failed to create user ${username}: ${err.message}`);
-    });
-}
-
-/**
- * Configure Git App in SonarQube
- * @param  {String} projectKey  Sonar project key
- * @param  {String} projectName Sonar project name
- * @return {Promise}            Nothing if Git App configured successfully
- */
-function configureGitApp(projectKey, projectName) {
-    const gitApp = sonarGitAppName;
-    const gitAppEncoded = encodeURIComponent(gitApp);
-    const componentId = encodeURIComponent(projectKey);
-
-    // Check if binding exists
-    return request({
-        method: 'GET',
-        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`);
-
-        if (!sonarEnterprise || !projectName) {
-            return Promise.resolve();
-        }
-
-        const parameters = `almSetting=${gitAppEncoded}&project=${componentId}&repository=${projectName}&summaryCommentEnabled=true`;
-
-        return request({
-            method: 'POST',
-            url: `${sonarHost}/api/alm_settings/set_github_binding?${parameters}`,
-            username: adminToken
-        }).catch(error => {
-            // if cannot configure app, do not throw err
-            logger.error(`Failed to configure Git App ${gitApp} for Sonar project ${projectKey}: ${error.message}`);
-
-            return Promise.resolve();
-        });
-    });
-}
-
-/**
- * Give specific user push access to the project
- * @method grantUserPermission
- * @param  {String} username      Username of the user
- * @param  {String} projectKey    Unique identifier for the project
- * @return {Promise}              Nothing if permission granted
- */
-function grantUserPermission(username, projectKey) {
-    // Always return 204 even with duplicate calls
-    return request({
-        method: 'POST',
-        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}`);
-    });
-}
-
-/**
- * Generate an access token for the given user
- * @method generateToken
- * @param  {String} username   Username of the user
- * @return {Promise}           Object with a token field
- */
-function generateToken(username) {
-    const tokenName = uuidv4();
-
-    return request({
-        method: 'POST',
-        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}`);
-    });
-}
-
-/**
- * Get metrics for a project
- * @method getMetrics
- * @param  {Object} config
- * @param  {String} config.projectKey   Sonar project key (job:jobId or pipeline:pipelineId)
- * @param  {String} config.startTime    Job start time
- * @param  {String} config.endTime      Job end time
- * @param  {String} [config.prNum]      Pull request number
- * @return {Promise}                    Object with coverage percentage and tests success percentage
- */
-function getMetrics({ projectKey, startTime, endTime, prNum, sonarEnterprise: enterpriseEnabled }) {
-    const componentId = encodeURIComponent(projectKey);
-    // get timezone offset (e.g. -0700) from 'Fri May 11 2018 15:25:37 GMT-0700 (PDT)'
-    const timezoneOffset = new Date().toString().match(/GMT(.*?) /)[1];
-    // Convert the time format from 2018-05-10T19:05:53.123Z to 2018-05-10T19:05:53-0700 as required by sonar
-    const parsedStartTime = startTime.replace(/\.(.*)/, timezoneOffset);
-    const parsedEndTime = endTime.replace(/\.(.*)/, timezoneOffset);
-    const from = encodeURIComponent(parsedStartTime);
-    const to = encodeURIComponent(parsedEndTime);
-    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) {
-        coverageUrl = coverageUrl.concat(`&pullRequest=${prNum}`);
-    }
-
-    return request({
-        method: 'GET',
-        url: coverageUrl,
-        username: adminToken
-    })
-        .then(result => {
-            const measures = {};
-
-            // measures in result is an array, covert it to an object with metric name as key
-            (hoek.reach(result, 'body.measures') || []).forEach(measure => {
-                measures[measure.metric] = measure;
-            });
-
-            const metrics = {
-                coverage: hoek.reach(measures, 'coverage.history.0.value') || 'N/A',
-                tests: 'N/A'
-            };
-            const zero = { default: 0 };
-            const total = hoek.reach(measures, 'tests.history.0.value', { default: 'N/A' });
-            const testErrors = hoek.reach(measures, 'test_errors.history.0.value', zero);
-            const testFailures = hoek.reach(measures, 'test_failures.history.0.value', zero);
-
-            if (!Number.isNaN(Number(total))) {
-                const totalInt = parseInt(total, 10);
-                const pass = totalInt - parseInt(testErrors, 10) - parseInt(testFailures, 10);
-
-                metrics.tests = `${pass}/${totalInt}`;
-            }
-
-            return metrics;
-        })
-        .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
-                logger.error(
-                    `Failed to get coverage and tests percentage for Sonar project ${projectKey}: ${err.message}`
-                );
-            }
-
-            return {
-                tests: 'N/A',
-                coverage: 'N/A'
-            };
-        });
-}
-
-/**
- * Determine Sonar project key, project name, and username based on:
- * - SonarQube edition
- * - job annotation
- * @method getProjectData
- * @param  {Object}     config
- * @param  {Object}     [config.scope]              Coverage scope (pipeline or job)
- * @param  {Boolean}    config.enterpriseEnabled    If enterprise is enabled
- * @param  {String}     config.jobId                Screwdriver job ID
- * @param  {String}     config.jobName              Screwdriver job name
- * @param  {String}     config.pipelineId           Screwdriver pipeline ID
- * @param  {String}     config.pipelineName         Screwdriver pipeline name
- * @param  {String}     [config.projectKey]         Sonar project key
- * @param  {String}     [config.prNum]              PR number
- * @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
-}) {
-    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 username = `user-${projectScope}-${id}`;
-
-        return {
-            projectKey,
-            username,
-            projectName,
-            projectScope
-        };
-    }
-
-    // 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 coverageScope = userScope || (enterpriseEnabled ? 'pipeline' : 'job');
-
-    if (coverageScope === 'pipeline') {
-        return {
-            projectKey: `pipeline:${pipelineId}`,
-            projectName: pipelineName,
-            username: `user-pipeline-${pipelineId}`,
-            projectScope: coverageScope
-        };
-    }
-
-    // Use prParentJobId as ID for PRs
-    if (prNum && coverageScope === 'job' && enterpriseEnabled) {
-        const prRegex = /^PR-(\d+)(?::([\w-]+))?$/;
-        const prNameMatch = jobName.match(prRegex);
-
-        jobId = prParentJobId;
-        jobName = prNameMatch && prNameMatch.length > 1 ? prNameMatch[2] : jobName;
-    }
-
-    return {
-        projectKey: `job:${jobId}`,
-        projectName: `${pipelineName}:${jobName}`,
-        username: `user-job-${jobId}`,
-        projectScope: coverageScope
-    };
-}
-
 class CoverageSonar extends CoverageBase {
     /**
      * Constructor
@@ -323,20 +54,283 @@ class CoverageSonar extends CoverageBase {
             'Invalid config for sonar coverage plugin'
         );
 
-        sdCoverageAuthUrl = `${this.config.sdApiUrl}/v4/coverage/token`;
-        adminToken = this.config.adminToken;
-        sonarHost = this.config.sonarHost;
-        sonarEnterprise = this.config.sonarEnterprise;
-        sonarGitAppName = this.config.sonarGitAppName;
+        this.sdCoverageAuthUrl = `${config.sdApiUrl}/v4/coverage/token`;
+        this.adminToken = config.adminToken;
+        this.sonarHost = config.sonarHost;
+        this.sonarEnterprise = config.sonarEnterprise;
+        this.sonarGitAppName = config.sonarGitAppName;
 
-        this.uploadCommands = COMMANDS.replace('$SD_SONAR_HOST', sonarHost)
-            .replace('$SD_UI_URL', this.config.sdUiUrl)
-            .replace('$SD_SONAR_ENTERPRISE', sonarEnterprise)
+        this.uploadCommands = COMMANDS.replace('$SD_SONAR_HOST', this.sonarHost)
+            .replace('$SD_UI_URL', config.sdUiUrl)
+            .replace('$SD_SONAR_ENTERPRISE', this.sonarEnterprise)
             .split('\n');
 
         this.uploadCommands[this.uploadCommands.length - 1] += ' || true';
     }
 
+    /**
+     * Create a project in sonar
+     * @method createProject
+     * @param  {String} projectKey    Unique identifier for the project
+     * @return {Promise}              Project object if it gets created or empty object if already exists
+     */
+    createProject(projectKey) {
+        return request({
+            method: 'POST',
+            url: `${this.sonarHost}/api/projects/create?project=${projectKey}&name=${projectKey}`,
+            username: this.adminToken
+        }).catch(err => {
+            if (err.statusCode === 400 && err.message.includes('already exists')) {
+                return {};
+            }
+
+            throw new Error(`Failed to create project ${projectKey}: ${err.message}`);
+        });
+    }
+
+    /**
+     * Create a user in sonar
+     * @method createUser
+     * @param  {String} username  Username of the user
+     * @param  {String} password  Password of the user
+     * @return {Promise}          User object if it gets created or empty object if already exists
+     */
+    createUser(username, password) {
+        return request({
+            method: 'POST',
+            url: `${this.sonarHost}/api/users/create?login=${username}&name=${username}&password=${password}`,
+            username: this.adminToken
+        }).catch(err => {
+            if (err.statusCode === 400 && err.message.includes('already exists')) {
+                return {};
+            }
+
+            throw new Error(`Failed to create user ${username}: ${err.message}`);
+        });
+    }
+
+    /**
+     * Configure Git App in SonarQube
+     * @param  {String} projectKey  Sonar project key
+     * @param  {String} projectName Sonar project name
+     * @return {Promise}            Nothing if Git App configured successfully
+     */
+    configureGitApp(projectKey, projectName) {
+        const gitApp = this.sonarGitAppName;
+        const gitAppEncoded = encodeURIComponent(gitApp);
+        const componentId = encodeURIComponent(projectKey);
+
+        // Check if binding exists
+        return request({
+            method: 'GET',
+            url: `${this.sonarHost}/api/alm_settings/get_binding?project=${componentId}`,
+            username: this.adminToken
+        }).catch(() => {
+            // if binding does not exist, add it
+            logger.info(`Binding does not exist for Sonar project ${projectKey}, adding`);
+
+            if (!this.sonarEnterprise || !projectName) {
+                return Promise.resolve();
+            }
+
+            const parameters = `almSetting=${gitAppEncoded}&project=${componentId}&repository=${projectName}&summaryCommentEnabled=true&monorepo=false`;
+
+            return request({
+                method: 'POST',
+                url: `${this.sonarHost}/api/alm_settings/set_github_binding?${parameters}`,
+                username: this.adminToken
+            }).catch(error => {
+                // if cannot configure app, do not throw err
+                logger.error(`Failed to configure Git App ${gitApp} for Sonar project ${projectKey}: ${error.message}`);
+
+                return Promise.resolve();
+            });
+        });
+    }
+
+    /**
+     * Give specific user push access to the project
+     * @method grantUserPermission
+     * @param  {String} username      Username of the user
+     * @param  {String} projectKey    Unique identifier for the project
+     * @return {Promise}              Nothing if permission granted
+     */
+    grantUserPermission(username, projectKey) {
+        // Always return 204 even with duplicate calls
+        return request({
+            method: 'POST',
+            url: `${this.sonarHost}/api/permissions/add_user?login=${username}&permission=scan&projectKey=${projectKey}`,
+            username: this.adminToken
+        }).catch(err => {
+            throw new Error(`Failed to grant user ${username} permission: ${err.message}`);
+        });
+    }
+
+    /**
+     * Generate an access token for the given user
+     * @method generateToken
+     * @param  {String} username   Username of the user
+     * @return {Promise}           Object with a token field
+     */
+    generateToken(username) {
+        const tokenName = uuidv4();
+
+        return request({
+            method: 'POST',
+            url: `${this.sonarHost}/api/user_tokens/generate?login=${username}&name=${tokenName}`,
+            username: this.adminToken
+        }).catch(err => {
+            throw new Error(`Failed to generate user ${username} token: ${err.message}`);
+        });
+    }
+
+    /**
+     * Get metrics for a project
+     * @method getMetrics
+     * @param  {Object} config
+     * @param  {String} config.projectKey   Sonar project key (job:jobId or pipeline:pipelineId)
+     * @param  {String} config.startTime    Job start time
+     * @param  {String} config.endTime      Job end time
+     * @param  {String} [config.prNum]      Pull request number
+     * @return {Promise}                    Object with coverage percentage and tests success percentage
+     */
+    getMetrics({ projectKey, startTime, endTime, prNum, sonarEnterprise: enterpriseEnabled }) {
+        const componentId = encodeURIComponent(projectKey);
+        // get timezone offset (e.g. -0700) from 'Fri May 11 2018 15:25:37 GMT-0700 (PDT)'
+        const timezoneOffset = new Date().toString().match(/GMT(.*?) /)[1];
+        // Convert the time format from 2018-05-10T19:05:53.123Z to 2018-05-10T19:05:53-0700 as required by sonar
+        const parsedStartTime = startTime.replace(/\.(.*)/, timezoneOffset);
+        const parsedEndTime = endTime.replace(/\.(.*)/, timezoneOffset);
+        const from = encodeURIComponent(parsedStartTime);
+        const to = encodeURIComponent(parsedEndTime);
+        let coverageUrl = `${this.sonarHost}/api/measures/search_history?component=${componentId}&metrics=tests,test_errors,test_failures,coverage&from=${from}&to=${to}&ps=1`;
+
+        if (enterpriseEnabled && prNum) {
+            coverageUrl = coverageUrl.concat(`&pullRequest=${prNum}`);
+        }
+
+        return request({
+            method: 'GET',
+            url: coverageUrl,
+            username: this.adminToken
+        })
+            .then(result => {
+                const measures = {};
+
+                // measures in result is an array, covert it to an object with metric name as key
+                (hoek.reach(result, 'body.measures') || []).forEach(measure => {
+                    measures[measure.metric] = measure;
+                });
+
+                const metrics = {
+                    coverage: hoek.reach(measures, 'coverage.history.0.value') || 'N/A',
+                    tests: 'N/A'
+                };
+                const zero = { default: 0 };
+                const total = hoek.reach(measures, 'tests.history.0.value', { default: 'N/A' });
+                const testErrors = hoek.reach(measures, 'test_errors.history.0.value', zero);
+                const testFailures = hoek.reach(measures, 'test_failures.history.0.value', zero);
+
+                if (!Number.isNaN(Number(total))) {
+                    const totalInt = parseInt(total, 10);
+                    const pass = totalInt - parseInt(testErrors, 10) - parseInt(testFailures, 10);
+
+                    metrics.tests = `${pass}/${totalInt}`;
+                }
+
+                return metrics;
+            })
+            .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
+                    logger.error(
+                        `Failed to get coverage and tests percentage for Sonar project ${projectKey}: ${err.message}`
+                    );
+                }
+
+                return {
+                    tests: 'N/A',
+                    coverage: 'N/A'
+                };
+            });
+    }
+
+    /**
+     * Determine Sonar project key, project name, and username based on:
+     * - SonarQube edition
+     * - job annotation
+     * @method getProjectData
+     * @param  {Object}     config
+     * @param  {Object}     [config.scope]              Coverage scope (pipeline or job)
+     * @param  {Boolean}    config.enterpriseEnabled    If enterprise is enabled
+     * @param  {String}     config.jobId                Screwdriver job ID
+     * @param  {String}     config.jobName              Screwdriver job name
+     * @param  {String}     config.pipelineId           Screwdriver pipeline ID
+     * @param  {String}     config.pipelineName         Screwdriver pipeline name
+     * @param  {String}     [config.projectKey]         Sonar project key
+     * @param  {String}     [config.prNum]              PR number
+     * @param  {String}     [config.prParentJobId]      Screwdriver PR parent job ID
+     * @return {Object}                                 Sonar project key, project name, and username
+     */
+    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 username = `user-${projectScope}-${id}`;
+
+            return {
+                projectKey,
+                username,
+                projectName,
+                projectScope
+            };
+        }
+
+        // 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 coverageScope = userScope || (enterpriseEnabled ? 'pipeline' : 'job');
+
+        if (coverageScope === 'pipeline') {
+            return {
+                projectKey: `pipeline:${pipelineId}`,
+                projectName: pipelineName,
+                username: `user-pipeline-${pipelineId}`,
+                projectScope: coverageScope
+            };
+        }
+
+        // Use prParentJobId as ID for PRs
+        if (prNum && coverageScope === 'job' && enterpriseEnabled) {
+            const prRegex = /^PR-(\d+)(?::([\w-]+))?$/;
+            const prNameMatch = jobName.match(prRegex);
+
+            jobId = prParentJobId;
+            jobName = prNameMatch && prNameMatch.length > 1 ? prNameMatch[2] : jobName;
+        }
+
+        return {
+            projectKey: `job:${jobId}`,
+            projectName: `${pipelineName}:${jobName}`,
+            username: `user-job-${jobId}`,
+            projectScope: coverageScope
+        };
+    }
+
     /**
      * Return an access token that build can use to talk to coverage server
      * @method getAccessToken
@@ -356,8 +350,8 @@ class CoverageSonar extends CoverageBase {
         let projectData = { username, projectKey, projectName };
 
         if (!username || !projectKey || !projectName || projectName.includes('undefined')) {
-            projectData = getProjectData({
-                enterpriseEnabled: sonarEnterprise,
+            projectData = this.getProjectData({
+                enterpriseEnabled: this.sonarEnterprise,
                 jobId,
                 jobName,
                 prParentJobId,
@@ -370,11 +364,11 @@ class CoverageSonar extends CoverageBase {
 
         const password = uuidv4();
 
-        return createProject(projectData.projectKey)
-            .then(() => configureGitApp(projectData.projectKey, projectData.projectName))
-            .then(() => createUser(projectData.username, password))
-            .then(() => grantUserPermission(projectData.username, projectData.projectKey))
-            .then(() => generateToken(projectData.username))
+        return this.createProject(projectData.projectKey)
+            .then(() => this.configureGitApp(projectData.projectKey, projectData.projectName))
+            .then(() => this.createUser(projectData.username, password))
+            .then(() => this.grantUserPermission(projectData.username, projectData.projectKey))
+            .then(() => this.generateToken(projectData.username))
             .then(res => res.body.token);
     }
 
@@ -410,8 +404,8 @@ class CoverageSonar extends CoverageBase {
         projectKey: coverageProjectKey,
         prParentJobId
     }) {
-        const { projectScope, projectKey, projectName, username } = getProjectData({
-            enterpriseEnabled: sonarEnterprise,
+        const { projectScope, projectKey, projectName, username } = this.getProjectData({
+            enterpriseEnabled: this.sonarEnterprise,
             jobId,
             pipelineId,
             scope,
@@ -424,9 +418,9 @@ class CoverageSonar extends CoverageBase {
 
         const infoObject = {
             envVars: {
-                SD_SONAR_AUTH_URL: `${sdCoverageAuthUrl}?projectKey=${projectKey}&projectName=${projectName}&username=${username}&scope=${projectScope}`,
-                SD_SONAR_HOST: sonarHost,
-                SD_SONAR_ENTERPRISE: sonarEnterprise,
+                SD_SONAR_AUTH_URL: `${this.sdCoverageAuthUrl}?projectKey=${projectKey}&projectName=${projectName}&username=${username}&scope=${projectScope}`,
+                SD_SONAR_HOST: this.sonarHost,
+                SD_SONAR_ENTERPRISE: this.sonarEnterprise,
                 SD_SONAR_PROJECT_KEY: projectKey,
                 SD_SONAR_PROJECT_NAME: projectName
             }
@@ -434,10 +428,12 @@ 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(
+            const { sonarEnterprise } = this;
+
+            return this.getMetrics({ projectKey, startTime, endTime, prNum, sonarEnterprise }).then(
                 ({ coverage, tests }) => {
                     const componentId = encodeURIComponent(projectKey);
-                    let projectUrl = `${this.config.sonarHost}/dashboard?id=${componentId}`;
+                    let projectUrl = `${this.sonarHost}/dashboard?id=${componentId}`;
 
                     if (sonarEnterprise && prNum) {
                         projectUrl = projectUrl.concat(`&pullRequest=${prNum}`);

package/package.json

@@ -1,16 +1,15 @@
 {
   "name": "screwdriver-coverage-sonar",
-  "version": "3.3.2",
+  "version": "3.4.0",
   "description": "SonarQube implementation of the coverage-base class",
   "main": "index.js",
   "scripts": {
     "pretest": "eslint .",
-    "test": "nyc --report-dir ./artifacts/coverage --reporter=lcov mocha --reporter mocha-multi-reporters --reporter-options configFile=./mocha.config.json --recursive --timeout 4000 --retries 1 --exit --allow-uncaught true --color true",
-    "semantic-release": "semantic-release pre && npm publish && semantic-release post"
+    "test": "nyc --report-dir ./artifacts/coverage --reporter=lcov mocha --reporter mocha-multi-reporters --reporter-options configFile=./mocha.config.json --recursive --timeout 4000 --retries 1 --exit --allow-uncaught true --color true"
   },
   "repository": {
     "type": "git",
-    "url": "git@github.com:screwdriver-cd/coverage-sonar.git"
+    "url": "git+https://github.com/screwdriver-cd/coverage-sonar.git"
   },
   "homepage": "https://github.com/screwdriver-cd/coverage-sonar",
   "bugs": "https://github.com/screwdriver-cd/screwdriver/issues",
@@ -33,7 +32,7 @@
     "chai": "^4.2.0",
     "eslint": "^7.31.0",
     "eslint-config-screwdriver": "^5.0.1",
-    "mocha": "^8.3.2",
+    "mocha": "^9.1.3",
     "mocha-multi-reporters": "^1.5.1",
     "mocha-sonarqube-reporter": "^1.0.2",
     "mockery": "^2.1.0",
@@ -49,9 +48,6 @@
     "uuid": "^3.4.0"
   },
   "release": {
-    "debug": false,
-    "verifyConditions": {
-      "path": "./node_modules/semantic-release/src/lib/plugin-noop.js"
-    }
+    "debug": false
   }
-}
+}