Add option to not send the "hello!" message to non-whitelisted pull request submissions

.gitignore

@@ -18,3 +18,6 @@ bin/
 *.ipr
 *.iws
 .idea/
+
+# OS X
+.DS_Store

README.md

@@ -15,7 +15,7 @@ build.
 
 A new build can also be started with a comment: ``retest this please``.
 
-You can extend the standard build comment message on github 
+You can extend the standard build comment message on GitHub
 creating a comment file from shell console or any other 
 jenkins plugin. Contents of that file will be added to the comment on GitHub. 
 This is useful for posting some build dependent urls for users without 
@@ -93,7 +93,7 @@ For more details, see https://wiki.jenkins-ci.org/display/JENKINS/GitHub+pull+re
 * If you want to use the actual commit in the pull request, use ``${ghprbActualCommit}`` instead of ``${sha1}``
 * Under ``Build Triggers``, check ``GitHub pull requests builder``.
   * Add admins for this specific job.  
-  * If you want to use GitHub hooks for automatic testing, read the help for ``Use github hooks for build triggering`` in job configuration. Then you can check the checkbox.
+  * If you want to use GitHub hooks for automatic testing, read the help for ``Use GitHub hooks for build triggering`` in job configuration. Then you can check the checkbox.
   * In Advanced, you can modify:  
     * The crontab line for this specific job. This schedules polling to GitHub for new changes in Pull Requests.  
     * The whitelisted users for this specific job.  
@@ -128,7 +128,7 @@ job('upstreamJob') {
     }
 
     triggers {
-        pullRequest {
+        githubPullRequest {
             admin('user_1')
             admins(['user_2', 'user_3'])
             userWhitelist('[email protected]')
@@ -143,6 +143,7 @@ job('upstreamJob') {
             autoCloseFailedPullRequests()
             displayBuildErrorsOnDownstreamBuilds()
             whiteListTargetBranches(['master','test', 'test2'])
+            blackListListTargetBranches(['master','test', 'test2'])
             allowMembersOfWhitelistedOrgsAsAdmin()
             extensions {
                 commitStatus {

pom.xml

@@ -10,7 +10,7 @@
 
     <artifactId>ghprb</artifactId>
     <name>GitHub Pull Request Builder</name>
-    <version>1.31.5-SNAPSHOT</version>
+    <version>1.33.1</version>
     <packaging>hpi</packaging>
 
     <url>https://wiki.jenkins-ci.org/display/JENKINS/GitHub+pull+request+builder+plugin</url>
@@ -26,13 +26,13 @@
             <name>Valdis Rigdon</name>
         </developer>
     </developers>
-
     <scm>
         <connection>scm:git:ssh://github.com/jenkinsci/ghprb-plugin.git</connection>
         <developerConnection>scm:git:ssh://[email protected]/jenkinsci/ghprb-plugin.git</developerConnection>
         <url>https://github.com/jenkinsci/ghprb-plugin</url>
-        <tag>HEAD</tag>
-    </scm>
+      <tag>ghprb-1.33.1</tag>
+  </scm>
+
 
     <issueManagement>
         <system>GitHub</system>

src/main/java/org/jenkinsci/plugins/ghprb/Ghprb.java

@@ -108,27 +108,48 @@ private Pattern retestPhrasePattern() {
      * @return skip build phrases
      */
     public Set<String> getSkipBuildPhrases() {
-        return new HashSet<String>(Arrays.asList(GhprbTrigger.getDscp().getSkipBuildPhrase().split("[\\r\\n]+")));
+        return new HashSet<String>(Arrays.asList(getTrigger().getSkipBuildPhrase().split("[\\r\\n]+")));
     }
 
     /**
-     * Checks for skip build phrase in pull request comment. If present it updates shouldRun as false.
+     * Checks for skip build phrase in pull request title and body. If present it updates shouldRun as false.
      * 
      * @param issue The GitHub issue
      * @return the skip phrase or null if should not skip
      */
     public String checkSkipBuild(GHIssue issue) {
-        // check for skip build phrase.
+        // check in title
+        String pullRequestTitle = issue.getTitle();
+        String skipBuildPhrase = checkSkipBuildInString(pullRequestTitle);
+        if (StringUtils.isNotBlank(skipBuildPhrase)) {
+            return skipBuildPhrase;
+        }
+        // not found in title, check in body
         String pullRequestBody = issue.getBody();
-        if (StringUtils.isNotBlank(pullRequestBody)) {
-            pullRequestBody = pullRequestBody.trim();
+        skipBuildPhrase = checkSkipBuildInString(pullRequestBody);
+        if (StringUtils.isNotBlank(skipBuildPhrase)) {
+            return skipBuildPhrase;
+        }
+        return null;
+    }
+
+    /**
+     * Checks for skip build phrase in the passed string
+     *
+     * @param string The string we're looking for the phrase in
+     * @return the skip phrase or null if we don't find it
+     */
+    private String checkSkipBuildInString( String string ) {
+        // check for skip build phrase in the passed string
+        if (StringUtils.isNotBlank(string)) {
+            string = string.trim();
             Set<String> skipBuildPhrases = getSkipBuildPhrases();
             skipBuildPhrases.remove("");
 
             for (String skipBuildPhrase : skipBuildPhrases) {
                 skipBuildPhrase = skipBuildPhrase.trim();
                 Pattern skipBuildPhrasePattern = compilePattern(skipBuildPhrase);
-                if (skipBuildPhrasePattern != null && skipBuildPhrasePattern.matcher(pullRequestBody).matches()) {
+                if (skipBuildPhrasePattern != null && skipBuildPhrasePattern.matcher(string).matches()) {
                     return skipBuildPhrase;
                 }
             }
@@ -188,6 +209,10 @@ public boolean isTriggerPhrase(String comment) {
     public boolean ifOnlyTriggerPhrase() {
         return trigger.getOnlyTriggerPhrase();
     }
+
+    public boolean suppressTestingRequest() {
+        return trigger.getSuppressTestingRequest();
+    }
 
     public boolean isWhitelisted(GHUser user) {
         return trigger.getPermitAll()
@@ -215,6 +240,10 @@ private boolean isInWhitelistedOrganisation(GHUser user) {
         return false;
     }
 
+    List<GhprbBranch> getBlackListTargetBranches() {
+        return trigger.getBlackListTargetBranches();
+    }
+
     List<GhprbBranch> getWhiteListTargetBranches() {
         return trigger.getWhiteListTargetBranches();
     }

src/main/java/org/jenkinsci/plugins/ghprb/GhprbAdditionalParameterEnvironmentContributor.java

@@ -0,0 +1,78 @@
+package org.jenkinsci.plugins.ghprb;
+
+import hudson.EnvVars;
+import hudson.Extension;
+import hudson.model.EnvironmentContributor;
+import hudson.model.ParameterValue;
+import hudson.model.ParametersAction;
+import hudson.model.Run;
+import hudson.model.StringParameterValue;
+import hudson.model.TaskListener;
+
+import javax.annotation.Nonnull;
+
+import java.io.IOException;
+import java.util.Arrays;
+import java.util.HashSet;
+import java.util.Set;
+
+@Extension
+public class GhprbAdditionalParameterEnvironmentContributor extends EnvironmentContributor {
+
+    private static Set<String> params =
+                    new HashSet<String>(Arrays.asList("sha1",
+                                                      "ghprbCredentialsId",
+                                                      "ghprbActualCommit",
+                                                      "ghprbPullId",
+                                                      "ghprbPullDescription",
+                                                      "ghprbPullTitle",
+                                                      "ghprbPullLink",
+                                                      "ghprbPullLongDescription",
+                                                      "ghprbTargetBranch",
+                                                      "ghprbSourceBranch",
+                                                      "ghprbCommentBody",
+                                                      "ghprbGhRepository",
+                                                      "ghprbTriggerAuthor",
+                                                      "ghprbTriggerAuthorEmail",
+                                                      "ghprbTriggerAuthorLogin",
+                                                      "ghprbTriggerAuthorLoginMention",
+                                                      "GIT_BRANCH",
+                                                      "ghprbPullAuthorEmail",
+                                                      "ghprbPullAuthorLogin",
+                                                      "ghprbPullAuthorLoginMention",
+                                                      "ghprbAuthorRepoGitUrl",
+                                                      "ghprbActualCommitAuthor",
+                                                      "ghprbActualCommitAuthorEmail"));
+
+    @Override
+    @SuppressWarnings("rawtypes")
+    public void buildEnvironmentFor(@Nonnull Run run,
+                                    @Nonnull EnvVars envs,
+                                    @Nonnull TaskListener listener) throws IOException, InterruptedException {
+        GhprbCause cause = (GhprbCause) ((Run<?, ?>) run).getCause(GhprbCause.class);
+        if (cause == null || envs.containsKey(params.iterator().next())) {
+            return;
+        }
+
+        ParametersAction pa = run.getAction(ParametersAction.class);
+        for (String param : params) {
+            addParameter(param, pa, envs);
+        }
+    }
+
+    private static void addParameter(String key,
+                                     ParametersAction pa,
+                                     EnvVars envs) {
+        ParameterValue pv = pa.getParameter(key);
+        if (pv == null || !(pv instanceof StringParameterValue)) {
+            return;
+        }
+        StringParameterValue value = (StringParameterValue) pa.getParameter(key);
+        envs.put(key, getString(value.value, ""));
+    }
+
+    private static String getString(String actual,
+                                    String d) {
+        return actual == null ? d : actual;
+    }
+}

src/main/java/org/jenkinsci/plugins/ghprb/GhprbBuilds.java

@@ -66,7 +66,9 @@ public void build(GhprbPullRequest pr, GHUser triggerSender, String commentBody)
                 pr.getCommitAuthor(), 
                 prAuthor, 
                 pr.getDescription(), 
-                pr.getAuthorRepoGitUrl());
+                pr.getAuthorRepoGitUrl(),
+                repo.getName(),
+                trigger.getGitHubApiAuth().getCredentialsId());
 
         for (GhprbExtension ext : Ghprb.getJobExtensions(trigger, GhprbCommitStatus.class)) {
             if (ext instanceof GhprbCommitStatus) {

src/main/java/org/jenkinsci/plugins/ghprb/GhprbCause.java

@@ -26,6 +26,8 @@ public class GhprbCause extends Cause {
     private final GHUser pullRequestAuthor;
     private final String description;
     private final String authorRepoGitUrl;
+    private final String repoName;
+    private final String credentialsId;
 
     public GhprbCause(String commit, 
             int pullID, 
@@ -40,7 +42,9 @@ public GhprbCause(String commit,
             GitUser commitAuthor,
             GHUser pullRequestAuthor,
             String description,
-            String authorRepoGitUrl) {
+            String authorRepoGitUrl,
+            String repoName,
+            String credentialsId) {
 
         this.commit = commit;
         this.pullID = pullID;
@@ -57,6 +61,8 @@ public GhprbCause(String commit,
         this.commitAuthor = commitAuthor;
         this.pullRequestAuthor = pullRequestAuthor;
         this.authorRepoGitUrl = authorRepoGitUrl;
+        this.repoName = repoName;
+        this.credentialsId = credentialsId;
     }
 
     @Override
@@ -132,4 +138,12 @@ public String getDescription() {
     public String getAuthorRepoGitUrl() {
         return authorRepoGitUrl;
     }
+
+    public String getRepositoryName() {
+        return repoName;
+    }
+
+    public String getCredentialsId() {
+        return credentialsId;
+    }
 }

src/main/java/org/jenkinsci/plugins/ghprb/GhprbGitHubAuth.java

@@ -49,6 +49,7 @@
 import hudson.security.ACL;
 import hudson.util.FormValidation;
 import hudson.util.ListBoxModel;
+import hudson.util.Secret;
 
 public class GhprbGitHubAuth extends AbstractDescribableImpl<GhprbGitHubAuth> {
     private static final Logger logger = Logger.getLogger(GhprbGitHubAuth.class.getName());
@@ -61,7 +62,7 @@ public class GhprbGitHubAuth extends AbstractDescribableImpl<GhprbGitHubAuth> {
     private final String credentialsId;
     private final String id;
     private final String description;
-    private final String secret;
+    private final Secret secret;
 
     private transient GitHub gh;
 
@@ -72,7 +73,7 @@ public GhprbGitHubAuth(
             String credentialsId, 
             String description, 
             String id,
-            String secret
+            Secret secret
             ) {
         if (StringUtils.isEmpty(serverAPIUrl)) {
             serverAPIUrl = "https://api.github.com";
@@ -116,21 +117,21 @@ public String getId() {
 
 
     @Exported
-    public String getSecret() {
+    public Secret getSecret() {
         return secret;
     }
 
 
     public boolean checkSignature(String body, String signature) {
-        if (StringUtils.isEmpty(secret)) {
+        if (secret == null || StringUtils.isEmpty(secret.getPlainText())) {
             return true;
         }
 
         if (signature != null && signature.startsWith("sha1=")) {
             String expected = signature.substring(5);
             String algorithm = "HmacSHA1";
             try {
-                SecretKeySpec keySpec = new SecretKeySpec(secret.getBytes(), algorithm);
+                SecretKeySpec keySpec = new SecretKeySpec(secret.getPlainText().getBytes(), algorithm);
                 Mac mac = Mac.getInstance(algorithm);
                 mac.init(keySpec);
                 byte[] localSignatureBytes = mac.doFinal(body.getBytes("UTF-8"));