feat(ZNTA-2623) fetch PR body and escape for HTML

pom.xml

@@ -65,6 +65,11 @@
             <version>1.12</version>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>commons-lang</groupId>
+            <artifactId>commons-lang</artifactId>
+            <version>2.6</version>
+        </dependency>
     </dependencies>
 
 </project>

src/org/zanata/jenkins/PullRequests.groovy

@@ -2,6 +2,8 @@ package org.zanata.jenkins
 
 import com.cloudbees.groovy.cps.NonCPS
 import groovy.json.JsonSlurper
+@Grab(group='commons-lang', module='commons-lang', version='2.6')
+import static org.apache.commons.lang.StringEscapeUtils.escapeHtml
 
 /**
  * @author Sean Flanigan <a href="mailto:[email protected]">[email protected]</a>
@@ -15,16 +17,19 @@ class PullRequests implements Serializable {
         def job = manager.build.project
         // we only want to do this once, to avoid hammering the github api
         if (!job.description || !job.description.contains(env.CHANGE_URL)) {
-          def sourceBranchLabel = getSourceBranchLabel(env.CHANGE_URL, steps)
-          def abbrTitle = Strings.truncateAtWord(env.CHANGE_TITLE, 50)
-          def prDesc = """<a title=\"${env.CHANGE_TITLE}\" href=\"${
-            env.CHANGE_URL
-          }\">PR #${env.CHANGE_ID} by ${env.CHANGE_AUTHOR}</a>:
-                       |$abbrTitle
-                       |merging ${sourceBranchLabel} to ${env.CHANGE_TARGET}""".
+          // PR body and source branch info aren't available in env, so we use GitHub API:
+          def pullRequest = getPullRequest(env.CHANGE_URL, steps)
+          def sourceBranchLabel = pullRequest?.head?.label ?: "[unknown]"
+          def prBody = pullRequest?.body ?: "[body not available]"
+          def quoteSafeTitle = escapeHtml(env.CHANGE_TITLE).replace('"', "'")
+          def safeTitle = escapeHtml(env.CHANGE_TITLE)
+          def safeBody = escapeHtml(prBody)
+          def prDesc = """<a title=\"$quoteSafeTitle\" href=\"${env.CHANGE_URL}\">
+                       |PR #${env.CHANGE_ID} by ${env.CHANGE_AUTHOR}</a>:<br />
+                       |$safeTitle<br />
+                       |merging ${sourceBranchLabel} to ${env.CHANGE_TARGET}<br />
+                       |$safeBody""".
               stripMargin()
-          // ideally we would show eg sourceRepo/featureBranch ⭆ master
-          // but there is no env var with that info
 
           steps.echo "description: " + prDesc
           //currentBuild.description = prDesc
@@ -46,7 +51,7 @@ class PullRequests implements Serializable {
   }
 
   @NonCPS
-  private static String getSourceBranchLabel(String changeURL, def steps) {
+  private static Object getPullRequest(String changeURL, def steps) {
     steps.echo "checking github api for pull request details"
 
     def tokens = changeURL.tokenize('/')
@@ -55,9 +60,15 @@ class PullRequests implements Serializable {
     def pr = tokens[5]
 
     // FIXME use github credentials to avoid rate limiting
+    // https://developer.github.com/v3/pulls/#get-a-single-pull-request
     def prUrl = new URL(
         "https://api.github.com/repos/${org}/${repo}/pulls/${pr}")
-    def sourceBranchLabel = new JsonSlurper().parseText(prUrl.text).head.label
-    return sourceBranchLabel
+    try {
+      return new JsonSlurper().parseText(prUrl.text)
+    } catch (Exception e) {
+      // NB we don't want to lose entire job description because of rate limiting
+      steps.echo StackTraces.getStackTrace(e)
+      return null
+    }
   }
 }