Add XML payload support

Fixes adnanh#238
jacobweinstock · Dec 24, 2019 · 3463804 · 3463804
1 parent 3f4520d
commit 3463804
Show file tree

Hide file tree

Showing 42 changed files with 5,174 additions and 4 deletions.
diff --git a/docs/Hook-Examples.md b/docs/Hook-Examples.md
@@ -424,3 +424,53 @@ Travis sends webhooks as `payload=<JSON_STRING>`, so the payload needs to be par
   }
 ]
 ```
+
+## XML Payload
+
+Given the following payload:
+
+```xml
+<app>
+  <users>
+    <user id="1" name="Jeff" />
+    <user id="2" name="Sally" />
+  </users>
+  <messages>
+    <message id="1" from_user="1" to_user="2">Hello!!</message>
+  </messages>
+</app>
+```
+
+```json
+[
+  {
+    "id": "deploy",
+    "execute-command": "/root/my-server/deployment.sh",
+    "command-working-directory": "/root/my-server",
+    "trigger-rule": {
+      "and": [
+        {
+          "match": {
+            "type": "value",
+            "parameter": {
+              "source": "payload",
+              "name": "app.users.user.0.-name"
+            },
+            "value": "Jeff"
+          }
+        },
+        {
+          "match": {
+            "type": "value",
+            "parameter": {
+              "source": "payload",
+              "name": "app.messages.message.#text"
+            },
+            "value": "Hello!!"
+          }
+        },
+      ],
+    }
+  }
+]
+```
diff --git a/docs/Referencing-Request-Values.md b/docs/Referencing-Request-Values.md
@@ -57,6 +57,31 @@ There are three types of request values:
 
     If the payload contains a key with the specified name "commits.0.commit.id", then the value of that key has priority over the dot-notation referencing.
 
+3. XML Payload
+
+    Referencing XML payload parameters is much like the JSON examples above, but XML is more complex.
+    Take the following XML payload:
+
+    ```xml
+    <app>
+      <users>
+        <user id="1" name="Jeff" />
+        <user id="2" name="Sally" />
+      </users>
+      <messages>
+        <message id="1" from_user="1" to_user="2">Hello!!</message>
+      </messages>
+    </app>
+    ```
+
+    To access a given `user` tag, you must treat them as an array.
+    So `app.users.user.0.name` yields `Jeff`.
+
+    Since there's only one `message` tag, it's not treated as an array.
+    So `app.messages.message.id` yields `1`.
+
+    To access the text within the `message` tag, you would use: `app.messages.message.#text`.
+
 If you are referencing values for environment, you can use `envname` property to set the name of the environment variable like so
 ```json
 {
@@ -87,4 +112,4 @@ and for query variables you can use
 {
   "source": "entire-query"
 }
-```
+```
diff --git a/go.mod b/go.mod
@@ -3,6 +3,7 @@ module github.com/adnanh/webhook
 go 1.13
 
 require (
+	github.com/clbanning/mxj v1.8.4
 	github.com/dustin/go-humanize v1.0.0
 	github.com/fsnotify/fsnotify v1.4.7 // indirect
 	github.com/ghodss/yaml v1.0.0

diff --git a/go.sum b/go.sum
@@ -1,3 +1,5 @@
+github.com/clbanning/mxj v1.8.4 h1:HuhwZtbyvyOw+3Z1AowPkU87JkJUSv751ELWaiTpj8I=
+github.com/clbanning/mxj v1.8.4/go.mod h1:BVjHeAH+rl9rs6f+QIpeRl0tfu10SXn1pUSa5PVGJng=
 github.com/dustin/go-humanize v1.0.0 h1:VSnTsYCnlFHaM2/igO1h6X3HA71jcobQuxemgkq4zYo=
 github.com/dustin/go-humanize v1.0.0/go.mod h1:HtrtbFcZ19U5GC7JDqmcUSB87Iq5E25KnS6fMYU6eOk=
 github.com/fsnotify/fsnotify v1.4.7 h1:IXs+QLmnXW2CcXuY+8Mzv/fWEsPGWxqefPtCP5CnV9I=

diff --git a/test/hooks.json.tmpl b/test/hooks.json.tmpl
@@ -137,6 +137,36 @@
       }
     }
   },
+  {
+    "id": "xml",
+    "execute-command": "{{ .Hookecho }}",
+    "command-working-directory": "/",
+    "response-message": "success",
+    "trigger-rule": {
+      "and": [
+        {
+          "match": {
+            "type": "value",
+            "parameter": {
+              "source": "payload",
+              "name": "app.users.user.0.-name"
+            },
+            "value": "Jeff"
+          }
+        },
+        {
+          "match": {
+            "type": "value",
+            "parameter": {
+              "source": "payload",
+              "name": "app.messages.message.#text"
+            },
+            "value": "Hello!!"
+          }
+        },
+      ],
+    }
+  },
   {
     "id": "capture-command-output-on-success-not-by-default",
     "pass-arguments-to-command": [

diff --git a/test/hooks.yaml.tmpl b/test/hooks.yaml.tmpl
@@ -76,6 +76,25 @@
   include-command-output-in-response: true
   command-working-directory: /
 
+- id: xml
+  execute-command: '{{ .Hookecho }}'
+  command-working-directory: /
+  response-message: success
+  trigger-rule:
+    and:
+    - match:
+        type: value
+        parameter:
+          source: payload
+          name: app.users.user.0.-name
+        value: Jeff
+    - match:
+        type: value
+        parameter:
+          source: payload
+          name: "app.messages.message.#text"
+        value: "Hello!!"
+
 - id: capture-command-output-on-success-not-by-default
   pass-arguments-to-command:
   - source: string
@@ -113,4 +132,4 @@
 
 - id: warn-on-space
   execute-command: '{{ .Hookecho }} foo'
-  include-command-output-in-response: true
+  include-command-output-in-response: true
diff --git a/vendor/github.com/clbanning/mxj/LICENSE b/vendor/github.com/clbanning/mxj/LICENSE