minor changes and doc

Author: Bernhard Grünewaldt

DEVELOPMENT.md

@@ -1,18 +1,97 @@
 ### Tests
 
 ```bash
-mvn hpi:run
+mvn compile && rm -rf work/ && mvn hpi:run
 
 curl -X POST \
     -H "Content-Type: application/json" \
     -d @test-webhook-payload.json \
-    http://localhost:8080/jenkins/plugin/github-webhook-notifier-plugin/receive
+    http://localhost:8080/jenkins/github-webhook-notifier/receive
 ```
 
 ### Build hpi
 
 ```
-mvn clean
-mvn compile
-mvn hpi:hpi
+mvn clean && mvn compile && mvn hpi:hpi
+```
+
+
+### Notes
+
+Howto manually checkout certain branch at specific revision
+
+```
+# Clone develop branch
+git clone --single-branch --branch develop https://github.com/codeclou/test-webhook.git .
+# Switch to revision
+git reset --hard 495140cf2b763b8bc3821e25b4c26dd1273d6206
+```
+
+
+### Webhook Payload Examples
+
+
+##### Tag Push Payload
+
+```bash
+# on head of master
+git tag -a 0.0.1 -m "0.0.1"
+git push origin 0.0.1
+```
+
+Webhook payload:
+
+```json
+{
+  "ref": "refs/tags/0.0.1",
+  "before": "0000000000000000000000000000000000000000",
+  "after": "80aa5698b8688df969d56678d5304f4450adda84",
+  "created": true,
+  "deleted": false,
+  "forced": false
+}
+```
+
+##### Branch Push Payload
+
+```bash
+# on head of master
+git branch develop
+git push origin develop
+```
+
+Webhook payload:
+
+```json
+{
+  "ref": "refs/heads/develop",
+  "before": "0000000000000000000000000000000000000000",
+  "after": "495140cf2b763b8bc3821e25b4c26dd1273d6206",
+  "created": true,
+  "deleted": false,
+  "forced": false
+}
+```
+
+##### Normal commit Push Payload
+
+```bash
+# on head of master
+echo "foo" > newfile.txt
+git add . -A
+git commit -m "foo"
+git push
+```
+
+Webhook payload:
+
+```json
+{
+  "ref": "refs/heads/master",
+  "before": "495140cf2b763b8bc3821e25b4c26dd1273d6206",
+  "after": "3be1cb4b6b86533b5dab2b0083fa9fb8b401b430",
+  "created": false,
+  "deleted": false,
+  "forced": false
+}
 ```

README.md

@@ -27,11 +27,12 @@ and push that tag, that the jenkins job will not be triggered, since the revisio
 ### GitHub Webhook Configuration
 
  * **Payload URL**
-   * `https://user:pass@jenkins.foo/jenkins/github-webhook-notifier-plugin/receive`
+   * `https://jenkins.foo/jenkins/github-webhook-notifier/receive`
+   * Note: The endpoint can be called without authentication.
  * **Content type**
    * `application/json`
  * **Secret**
-   * empty.
+   * Choose a good secret, at best a random sha512 hash
  * **Which events ...**
    * Just the `push` event
 

pom.xml

@@ -6,7 +6,7 @@
   <parent>
     <groupId>org.jenkins-ci.plugins</groupId>
     <artifactId>plugin</artifactId>
-    <version>1.580.1</version>
+    <version>2.25</version>
     <relativePath/>
   </parent>
   <groupId>io.codeclou.jenkins.github.webhook.notifier.plugin</groupId>
@@ -52,5 +52,10 @@
       <artifactId>commons-io</artifactId>
       <version>2.5</version>
     </dependency>
+    <dependency>
+      <groupId>org.jenkins-ci.plugins</groupId>
+      <artifactId>git</artifactId>
+      <version>3.2.0</version>
+    </dependency>
   </dependencies>
 </project>

src/main/java/io/codeclou/jenkins/githubwebhooknotifierplugin/GithubWebhookNotifierPlugin.java

@@ -0,0 +1,11 @@
+/*
+ * Licensed under MIT License
+ * Copyright (c) 2017 Bernhard Grünewaldt
+ */
+package io.codeclou.jenkins.githubwebhooknotifierplugin;
+
+import hudson.Plugin;
+
+public class GithubWebhookNotifierPlugin extends Plugin {
+
+}

src/main/java/io/codeclou/jenkins/github/webhook/notifier/plugin/GithubWebhookNotifierPlugin.java renamed to src/main/java/io/codeclou/jenkins/githubwebhooknotifierplugin/GithubWebhookNotifyAction.java

@@ -2,11 +2,11 @@
  * Licensed under MIT License
  * Copyright (c) 2017 Bernhard Grünewaldt
  */
-package io.codeclou.jenkins.github.webhook.notifier.plugin;
+package io.codeclou.jenkins.githubwebhooknotifierplugin;
 
 import com.google.gson.Gson;
 import com.google.gson.JsonSyntaxException;
-import hudson.Plugin;
+import hudson.Extension;
 import hudson.model.UnprotectedRootAction;
 import hudson.util.HttpResponses;
 import jenkins.model.Jenkins;
@@ -33,12 +33,12 @@
 import java.security.cert.CertificateException;
 import java.security.cert.X509Certificate;
 
-
-public class GithubWebhookNotifierPlugin extends Plugin implements UnprotectedRootAction {
+@Extension
+public class GithubWebhookNotifyAction implements UnprotectedRootAction {
 
     @Override
     public String getUrlName() {
-        return "github-webhook-notifier-plugin";
+        return "github-webhook-notifier";
     }
 
     @Override
@@ -48,11 +48,11 @@ public String getIconFileName() {
 
     @Override
     public String getDisplayName() {
-        return "github-webhook-notifier-plugin";
+        return "github-webhook-notifier";
     }
 
     /*
-     * http://jenkins.foo/plugin/github-webhook-notifier-plugin/receive
+     * http://jenkins.foo/github-webhook-notifier/receive
      */
     @RequirePOST
     public HttpResponse doReceive(HttpServletRequest request, StaplerRequest staplerRequest) throws IOException, ServletException {
@@ -66,7 +66,7 @@ public HttpResponse doReceive(HttpServletRequest request, StaplerRequest stapler
                     "git/notifyCommit?url=" +
                     githubWebhookPayload.getRepository().getClone_url() +
                     "&branches=" +
-                    githubWebhookPayload.getRef() +
+                    this.normalizeBranchNameForJenkins(githubWebhookPayload.getRef()) +
                     "&sha1=" +
                     githubWebhookPayload.getAfter();
             SSLContext sslContext = new SSLContextBuilder()
@@ -84,19 +84,37 @@ public boolean isTrusted(X509Certificate[] certificate, String authType) throws
             CloseableHttpResponse response = client.execute(httpGet);
             int statusCode = response.getStatusLine().getStatusCode();
             String gitNotificationResponse = IOUtils.toString(response.getEntity().getContent(), "UTF-8");
-            String responseText = "ok triggered: " + gitPluginNotifyUrl + "\nstatus: " + statusCode + "\n\n" + gitNotificationResponse;
+            StringBuilder responseText = new StringBuilder();
+            responseText.append("----------------------------------------------------------------------------------\n");
+            responseText.append("github-webhook-notifier-plugin - parsed webhook payload:\n");
+            responseText.append("   ref:       ").append(githubWebhookPayload.getRef()).append("\n");
+            responseText.append("   before:    ").append(githubWebhookPayload.getBefore()).append("\n");
+            responseText.append("   after:     ").append(githubWebhookPayload.getAfter()).append("\n");
+            responseText.append("   clone_url: ").append(githubWebhookPayload.getRepository().getClone_url()).append("\n");
+            responseText.append("----------------------------------------------------------------------------------\n");
+            responseText.append(">> REQUEST\n").append(gitPluginNotifyUrl).append("\n\n");
+            responseText.append("<< RESPONSE HTTP ").append(statusCode).append("\n");
+            responseText.append(gitNotificationResponse);
             if (statusCode != 200) {
-                return HttpResponses.error(400, responseText);
+                return HttpResponses.error(400, responseText.toString());
             }
-            return HttpResponses.plainText(responseText);
+            return HttpResponses.plainText(responseText.toString());
         } catch (JsonSyntaxException ex) {
-            return HttpResponses.error(500, "json invalid");
+            return HttpResponses.error(500, "github-webhook-notifier-plugin: github webhook json invalid");
         } catch (NoSuchAlgorithmException ex) {
-            return HttpResponses.error(500, "NoSuchAlgorithmException");
+            return HttpResponses.error(500, "github-webhook-notifier-plugin: internal error NoSuchAlgorithmException");
         } catch (KeyStoreException ex) {
-            return HttpResponses.error(500, "KeyStoreException");
+            return HttpResponses.error(500, "github-webhook-notifier-plugin: internal error KeyStoreException");
         } catch (KeyManagementException ex) {
-            return HttpResponses.error(500, "KeyManagementException");
+            return HttpResponses.error(500, "github-webhook-notifier-plugin: internal error KeyManagementException");
         }
     }
+
+    /*
+     * converts "refs/heads/develop" to "origin/develop"
+     */
+    private String normalizeBranchNameForJenkins(String branchname) {
+        return branchname.replace("refs/heads/", "origin/");
+    }
+
 }

src/main/java/io/codeclou/jenkins/github/webhook/notifier/plugin/GithubWebhookPayload.java renamed to src/main/java/io/codeclou/jenkins/githubwebhooknotifierplugin/GithubWebhookPayload.java

@@ -2,8 +2,12 @@
  * Licensed under MIT License
  * Copyright (c) 2017 Bernhard Grünewaldt
  */
-package io.codeclou.jenkins.github.webhook.notifier.plugin;
+package io.codeclou.jenkins.githubwebhooknotifierplugin;
 
+/**
+ * GitHub Webhook JSON Pojo with only the parts that are interesting for us.
+ * See: https://developer.github.com/webhooks/#payloads
+ */
 public class GithubWebhookPayload {
 
     private String ref;