Add sonar login/password and Token authentication. (#18)

* Add sonar token for authentication.
* Issue-17: Add support for Jenkins pipelines.
* Issue-17: Add login/password and Oath token possibility.

Author: Aliaksandr Kavalevich

README.md

@@ -49,7 +49,8 @@ Parse code coverage report generated by build and post code coverage status comm
     *  step([$class: 'MasterCoverageAction'])
 * Trigger CompareCoverageAction to compare coverage and publish results
     *  step([$class: 'CompareCoverageAction'])
-
+    * Optionally use can specify here sonar login and sonar password like this:
+        step([$class: 'CompareCoverageAction', sonarLogin: "login", sonarPassword: "password"])
 ## Master Coverage from Sonar
 
 You have the option to get the master coverage (base coverage) from your SonarQube instance. Otherwise the plugin will keep track of the master coverage in the project configuration file.
@@ -58,11 +59,10 @@ You have the option to get the master coverage (base coverage) from your SonarQu
 * Find section ```Coverage status for GitHub Pull Requests```
 * Fill ```Sonar URL``` field - e.g. `http://sonar.mycompany.com`
 * Turn On ```Use Sonar for master coverage```
-* The next pullrequest build will use SonarQube as the the source for master coverage
-
-The plugin will try to find the project in SonarQube based on the repository name. If more than one projects match, a waring is logged, and the first one will be used to get the coverage data. 
+* Optionally use can specify your personal ```Sonar access token```. 
+* The next pull request build will use SonarQube as the the source for master coverage
 
-This feature is still very basic. e.g. authorization against SonarQube is not yet implemented. Feel free to contribute.
+The plugin will try to find the project in SonarQube based on the repository name. If more than one projects match, a warning is logged, and the first one will be used to get the coverage data. 
 
 ## Troubleshooting
 

src/main/java/com/github/terma/jenkins/githubprcoveragestatus/CompareCoverageAction.java

@@ -21,6 +21,7 @@
 import java.io.PrintStream;
 import java.io.PrintWriter;
 
+import org.kohsuke.github.GHRepository;
 import org.kohsuke.stapler.DataBoundConstructor;
 
 import hudson.Extension;
@@ -35,16 +36,29 @@
 import hudson.tasks.Publisher;
 import hudson.tasks.Recorder;
 import jenkins.tasks.SimpleBuildStep;
+import org.kohsuke.stapler.DataBoundSetter;
 
 @SuppressWarnings({"unused", "WeakerAccess"})
 public class CompareCoverageAction extends Recorder implements SimpleBuildStep {
 
     private static final long serialVersionUID = 1L;
+    private String sonarLogin;
+    private String sonarPassword;
 
     @DataBoundConstructor
     public CompareCoverageAction() {
     }
 
+    @DataBoundSetter
+    public void setSonarLogin(String sonarLogin) {
+        this.sonarLogin = sonarLogin;
+    }
+
+    @DataBoundSetter
+    public void setSonarPassword(String sonarPassword) {
+        this.sonarPassword = sonarPassword;
+    }
+
     // todo show message that addition comment in progress as it could take a while
     @SuppressWarnings("NullableProblems")
     @Override
@@ -64,8 +78,9 @@ public void perform(
                             "https://wiki.jenkins-ci.org/display/JENKINS/GitHub+pull+request+builder+plugin " +
                             "to trigger build!");
         }
+        final GHRepository gitHubRepository = ServiceRegistry.getPullRequestRepository().getGitHubRepository(gitUrl);
 
-        final float masterCoverage = ServiceRegistry.getMasterCoverageRepository(buildLog).get(gitUrl);
+        final float masterCoverage = ServiceRegistry.getMasterCoverageRepository(buildLog, sonarLogin, sonarPassword).get(gitHubRepository.getName());
         final float coverage = ServiceRegistry.getCoverageRepository().get(workspace);
 
         final Message message = new Message(coverage, masterCoverage);
@@ -85,7 +100,7 @@ public void perform(
                     settingsRepository.getYellowThreshold(),
                     settingsRepository.getGreenThreshold(),
                     settingsRepository.isPrivateJenkinsPublicGitHub());
-            ServiceRegistry.getPullRequestRepository().comment(gitUrl, prId, comment);
+            ServiceRegistry.getPullRequestRepository().comment(gitHubRepository, prId, comment);
         } catch (Exception ex) {
             PrintWriter pw = listener.error("Couldn't add comment to pull request #" + prId + "!");
             ex.printStackTrace(pw);

src/main/java/com/github/terma/jenkins/githubprcoveragestatus/Configuration.java

@@ -61,6 +61,18 @@ public static String getSonarUrl() {
         return DESCRIPTOR.getSonarUrl();
     }
 
+    public static String getSonarToken() {
+        return DESCRIPTOR.getSonarToken();
+    }
+
+    public static String getSonarLogin() {
+        return DESCRIPTOR.getSonarLogin();
+    }
+
+    public static String getSonarPassword() {
+        return DESCRIPTOR.getSonarPassword();
+    }
+
     public static Boolean isUseSonarForMasterCoverage() {
         return DESCRIPTOR.isUseSonarForMasterCoverage();
     }
@@ -89,6 +101,9 @@ public static final class ConfigurationDescriptor extends Descriptor<Configurati
         private boolean privateJenkinsPublicGitHub;
         private boolean useSonarForMasterCoverage;
         private String sonarUrl;
+        private String sonarToken;
+        private String sonarLogin;
+        private String sonarPassword;
 
         private int yellowThreshold = DEFAULT_YELLOW_THRESHOLD;
         private int greenThreshold = DEFAULT_GREEN_THRESHOLD;
@@ -152,11 +167,24 @@ public String getSonarUrl() {
             return sonarUrl;
         }
 
+        @Override
+        public String getSonarToken() {
+            return sonarToken;
+        }
+
         @Override
         public String getJenkinsUrl() {
             return jenkinsUrl;
         }
 
+        public String getSonarLogin() {
+            return sonarLogin;
+        }
+
+        public String getSonarPassword() {
+            return sonarPassword;
+        }
+
         @Override
         public boolean configure(StaplerRequest req, JSONObject formData) throws FormException {
             gitHubApiUrl = StringUtils.trimToNull(formData.getString("gitHubApiUrl"));
@@ -167,6 +195,9 @@ public boolean configure(StaplerRequest req, JSONObject formData) throws FormExc
             privateJenkinsPublicGitHub = BooleanUtils.toBoolean(formData.getString("privateJenkinsPublicGitHub"));
             useSonarForMasterCoverage = BooleanUtils.toBoolean(formData.getString("useSonarForMasterCoverage"));
             sonarUrl = StringUtils.trimToNull(formData.getString("sonarUrl"));
+            sonarToken = StringUtils.trimToNull(formData.getString("sonarToken"));
+            sonarLogin = StringUtils.trimToNull(formData.getString("sonarLogin"));
+            sonarPassword = StringUtils.trimToNull(formData.getString("sonarPassword"));
             save();
             return super.configure(req, formData);
         }

src/main/java/com/github/terma/jenkins/githubprcoveragestatus/GitHubPullRequestRepository.java

@@ -8,7 +8,8 @@
 
 public class GitHubPullRequestRepository implements PullRequestRepository {
 
-    private static GHRepository getGitHubRepository(final String gitHubUrl) throws IOException {
+    @Override
+    public GHRepository getGitHubRepository(final String gitHubUrl) throws IOException {
         GitHub gitHub = getGitHub();
 
         try {
@@ -52,8 +53,8 @@ private static GitHub getGitHub() throws IOException {
     }
 
     @Override
-    public void comment(String gitUrl, int prId, String message) throws IOException {
-        getGitHubRepository(gitUrl).getPullRequest(prId).comment(message);
+    public void comment(final GHRepository ghRepository, final int prId, final String message) throws IOException {
+        ghRepository.getPullRequest(prId).comment(message);
     }
 
 }

src/main/java/com/github/terma/jenkins/githubprcoveragestatus/MasterCoverageRepository.java

@@ -2,6 +2,6 @@
 
 interface MasterCoverageRepository {
 
-    float get(String gitUrl);
+    float get(final String repoName);
 
 }

src/main/java/com/github/terma/jenkins/githubprcoveragestatus/PullRequestRepository.java

@@ -2,8 +2,12 @@
 
 import java.io.IOException;
 
+import org.kohsuke.github.GHRepository;
+
 interface PullRequestRepository {
 
-    void comment(String gitUrl, int prId, String message) throws IOException;
+    GHRepository getGitHubRepository(final String gitHubUrl) throws IOException;
+
+    void comment(GHRepository ghRepository, int prId, String message) throws IOException;
 
 }

src/main/java/com/github/terma/jenkins/githubprcoveragestatus/ServiceRegistry.java

@@ -9,12 +9,19 @@ public class ServiceRegistry {
     private static SettingsRepository settingsRepository;
     private static PullRequestRepository pullRequestRepository;
 
-    public static MasterCoverageRepository getMasterCoverageRepository(PrintStream buildLog) {
+    public static MasterCoverageRepository getMasterCoverageRepository(PrintStream buildLog, final String login, final String password) {
         if (masterCoverageRepository != null) {
             return masterCoverageRepository;
         } else {
             if (Configuration.isUseSonarForMasterCoverage()) {
-                return new SonarMasterCoverageRepository(Configuration.getSonarUrl(), buildLog);
+                final String sonarUrl = Configuration.getSonarUrl();
+                if (login != null && password != null) {
+                    return new SonarMasterCoverageRepository(sonarUrl, login, password, buildLog);
+                }
+                if (Configuration.getSonarToken() != null) {
+                    return new SonarMasterCoverageRepository(sonarUrl, Configuration.getSonarToken(), "", buildLog);
+                }
+                return new SonarMasterCoverageRepository(sonarUrl, Configuration.getSonarLogin(), Configuration.getSonarPassword(), buildLog);
             } else {
                 return Configuration.DESCRIPTOR;
             }

src/main/java/com/github/terma/jenkins/githubprcoveragestatus/SettingsRepository.java

@@ -17,4 +17,6 @@ interface SettingsRepository {
     boolean isUseSonarForMasterCoverage();
 
     String getSonarUrl();
+
+    String getSonarToken();
 }

src/main/java/com/github/terma/jenkins/githubprcoveragestatus/SonarMasterCoverageRepository.java

@@ -4,8 +4,10 @@
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import org.apache.commons.httpclient.HttpClient;
+import org.apache.commons.httpclient.auth.BasicScheme;
 import org.apache.commons.httpclient.methods.GetMethod;
-import org.apache.commons.lang.StringUtils;
+import org.apache.commons.httpclient.UsernamePasswordCredentials;
+import org.apache.commons.httpclient.auth.AuthScope;
 
 import java.io.IOException;
 import java.io.PrintStream;
@@ -20,27 +22,32 @@ public class SonarMasterCoverageRepository implements MasterCoverageRepository {
 
     private static final String SONAR_SEARCH_PROJECTS_API_PATH = "/api/projects/index";
     private static final String SONAR_COMPONENT_MEASURE_API_PATH = "/api/measures/component";
-    private static final String SONAR_OVERALL_LINE_COVERAGE_METRIC_NAME = "overall_line_coverage";
+    public static final String SONAR_OVERALL_LINE_COVERAGE_METRIC_NAME = "coverage";
 
     private final String sonarUrl;
+    private final String login;
     private final HttpClient httpClient;
     private final ObjectMapper objectMapper = new ObjectMapper().disable(FAIL_ON_UNKNOWN_PROPERTIES);
     private PrintStream buildLog;
 
-    public SonarMasterCoverageRepository(String sonarUrl, PrintStream buildLog) {
+    public SonarMasterCoverageRepository(String sonarUrl, String login, String password, PrintStream buildLog) {
         this.sonarUrl = sonarUrl;
+        this.login = login;
         this.buildLog = buildLog;
         httpClient = new HttpClient();
+        if (login != null) {
+            httpClient.getState().setCredentials(AuthScope.ANY, new UsernamePasswordCredentials(login, password));
+        }
     }
 
     @Override
-    public float get(String gitUrl) {
-        log("Getting coverage for %s", gitUrl);
+    public float get(final String repoName) {
+        log("Getting coverage for %s", repoName);
         try {
-            final SonarProject sonarProject = getSonarProject(gitUrl);
+            final SonarProject sonarProject = getSonarProject(repoName);
             return getCoverageMeasure(sonarProject);
         } catch (Exception e) {
-            log("Failed to get master coverage for %s", gitUrl);
+            log("Failed to get master coverage for %s", repoName);
             log("Exception message '%s'", e);
             e.printStackTrace(buildLog);
             return 0;
@@ -53,13 +60,11 @@ public float get(String gitUrl) {
      * @return the sonar project found in case multiple are found, the first one is returned
      * @throws SonarProjectRetrievalException if no project could be found or an error occurred during retrieval
      */
-    private SonarProject getSonarProject(String gitUrl) throws SonarProjectRetrievalException {
-        String repoName = StringUtils.substringAfterLast(StringUtils.removeEnd(gitUrl, ".git"), "/");
-
-        final String searchUri = sonarUrl + SONAR_SEARCH_PROJECTS_API_PATH + "?search=" + repoName;
+    private SonarProject getSonarProject(final String repoName) throws SonarProjectRetrievalException {
         try {
+            final String searchUri = sonarUrl + SONAR_SEARCH_PROJECTS_API_PATH + "?search=" + repoName;
             final GetMethod method = executeGetRequest(searchUri);
-            List<SonarProject> sonarProjects = objectMapper.readValue(method.getResponseBodyAsStream(), new TypeReference<List<SonarProject>>() {
+            final List<SonarProject> sonarProjects = objectMapper.readValue(method.getResponseBodyAsStream(), new TypeReference<List<SonarProject>>() {
             });
 
             if (sonarProjects.isEmpty()) {
@@ -71,8 +76,8 @@ private SonarProject getSonarProject(String gitUrl) throws SonarProjectRetrieval
                 log("Found multiple projects for repo name %s - found %s - returning first result", repoName, sonarProjects);
                 return sonarProjects.get(0);
             }
-        } catch (Exception e) {
-            throw new SonarProjectRetrievalException(String.format("failed to search for sonar project %s - %s", searchUri, e.getMessage()), e);
+        } catch (final Exception e) {
+            throw new SonarProjectRetrievalException(String.format("failed to search for sonar project %s - %s", repoName, e.getMessage()), e);
         }
     }
 
@@ -95,6 +100,9 @@ private float getCoverageMeasure(SonarProject project) throws SonarCoverageMeasu
 
     private GetMethod executeGetRequest(String uri) throws IOException, HttpClientException {
         final GetMethod method = new GetMethod(uri);
+        if (login != null) {
+            method.getHostAuthState().setAuthScheme(new BasicScheme());
+        }
         int status = httpClient.executeMethod(method);
         if (status >= SC_BAD_REQUEST) {
             throw new HttpClientException(uri, status, method.getResponseBodyAsString());

src/main/resources/com/github/terma/jenkins/githubprcoveragestatus/Configuration/global.groovy

@@ -36,4 +36,16 @@ f.section(title: descriptor.displayName) {
         f.textbox()
     }
 
+    f.entry(field: "sonarToken", title: _("Sonar access token")) {
+        f.password()
+    }
+
+    f.entry(field: "sonarLogin", title: _("Sonar login")) {
+        f.textbox()
+    }
+
+    f.entry(field: "sonarPassword", title: _("Sonar password")) {
+        f.password()
+    }
+
 }