From de2bf82fdfbea556cec741aa17499869875302b3 Mon Sep 17 00:00:00 2001 From: JC Brand Date: Thu, 19 Oct 2023 22:18:50 +0200 Subject: [PATCH] Add Github action to notify to Converse XMPP chatroom --- .github/workflows/codeql.yml | 4 +- .github/workflows/xmpp-notify.yml | 60 +++++++++ action.yml | 32 +++++ docker/xmpp-notify/Dockerfile | 9 ++ docker/xmpp-notify/LICENSE | 201 ++++++++++++++++++++++++++++++ docker/xmpp-notify/entrypoint.sh | 3 + docker/xmpp-notify/go.mod | 5 + docker/xmpp-notify/main.go | 138 ++++++++++++++++++++ 8 files changed, 450 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/xmpp-notify.yml create mode 100644 action.yml create mode 100644 docker/xmpp-notify/Dockerfile create mode 100644 docker/xmpp-notify/LICENSE create mode 100644 docker/xmpp-notify/entrypoint.sh create mode 100644 docker/xmpp-notify/go.mod create mode 100644 docker/xmpp-notify/main.go diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index 40865f18da..7fe2cf43c2 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -2,9 +2,9 @@ name: "CodeQL" on: push: - branches: [ "master" ] + branches: [ "master", "jcbrand/xmpp-notify"] pull_request: - branches: [ "master" ] + branches: [ "master", "jcbrand/xmpp-notify"] schedule: - cron: "11 18 * * 6" diff --git a/.github/workflows/xmpp-notify.yml b/.github/workflows/xmpp-notify.yml new file mode 100644 index 0000000000..da29f4d681 --- /dev/null +++ b/.github/workflows/xmpp-notify.yml @@ -0,0 +1,60 @@ +name: 'XMPP Notifier' + +on: + push: + branches: [ "master" ] + pull_request: + branches: [ "master" ] + +jobs: + notif-script: + runs-on: ubuntu-latest + name: job that pushes repo news to xmpp + steps: + - name: push_info_step + id: push + uses: processone/xmpp-notifier@v1.0.0 + # Will only trigger when a push is made to the master branch + if: github.event_name == 'push' + with: # Set the secrets as inputs + # jid expects the bot's bare jid (user@domain) + jid: ${{ secrets.jid }} + password: ${{ secrets.password }} + server_host: ${{ secrets.server_host }} + # Intended recipient of the notification such as a room or single user. Bare JID expected. + recipient: ${{ secrets.recipient }} + # Port is optional. Defaults to 5222 + server_port: ${{ secrets.server_port }} + message: | + ${{ github.actor }} pushed ${{ github.event.ref }} ${{ github.event.compare }} with message: + ${{ join(github.event.commits.*.message) }} + # Boolean to indicate if correspondent should be treated as a room (true) or a single user (false) + recipient_is_room: true + - name: pr_open_info_step + id: pull_request_open + uses: processone/xmpp-notifier@v1.0.0 + # Will only get triggered when a pull request to master is created + if: github.event_name == 'pull_request' && github.event.action == 'opened' + with: # Set the secrets as inputs + jid: ${{ secrets.jid }} + password: ${{ secrets.password }} + server_host: ${{ secrets.server_host }} + recipient: ${{ secrets.recipient }} + message: | + ${{ github.actor }} opened a PR : ${{ github.event.pull_request.html_url }} with message : + ${{ github.event.pull_request.title }} + recipient_is_room: true + - name: pr_edit_info_step + id: pull_request_edit + uses: processone/xmpp-notifier@v1.0.0 + # Will only get triggered when a pull request to master is created + if: github.event_name == 'pull_request' && github.event.action == 'edited' + with: # Set the secrets as inputs + jid: ${{ secrets.jid }} + password: ${{ secrets.password }} + server_host: ${{ secrets.server_host }} + recipient: ${{ secrets.recipient }} + message: | + ${{ github.actor }} edited the following PR : ${{ github.event.pull_request.html_url }} with message : + ${{ github.event.pull_request.title }} + recipient_is_room: true diff --git a/action.yml b/action.yml new file mode 100644 index 0000000000..890f479316 --- /dev/null +++ b/action.yml @@ -0,0 +1,32 @@ +# action.yml +name: 'XMPP Notifier' +description: 'Send notifications using XMPP' +author: 'ProcessOne' +runs: + using: 'docker' + image: './docker/xmpp-notify/Dockerfile' +inputs: + jid: + description: 'bot client login' + required: true + password: + description: 'bot client password' + required: true + server_host: + description: 'server domain for the bot client' + required: true + recipient: + description: "user or chat room that this action sends messages to" + required: true + recipient_is_room: + description: "is the correspondent passed as a parameter a chat room identifier or a single user" + required: false + server_port: + description: "server port for target notifications audience" + required: false + bot_alias: + description: "alias of the bot sending notifications in a chat room. Alias may be different from jid." + required: false + message: + description: "message to send to xmpp entities" + required: true diff --git a/docker/xmpp-notify/Dockerfile b/docker/xmpp-notify/Dockerfile new file mode 100644 index 0000000000..759fff4108 --- /dev/null +++ b/docker/xmpp-notify/Dockerfile @@ -0,0 +1,9 @@ +# Container image that runs your code +FROM golang:1.13 + +# Copies your code file from your action repository to the filesystem path `/` of the container +COPY entrypoint.sh /notifier/entrypoint.sh +COPY main.go /notifier/main.go + +# Code file to execute when the docker container starts up (`entrypoint.sh`) +ENTRYPOINT ["/notifier/entrypoint.sh"] diff --git a/docker/xmpp-notify/LICENSE b/docker/xmpp-notify/LICENSE new file mode 100644 index 0000000000..261eeb9e9f --- /dev/null +++ b/docker/xmpp-notify/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/docker/xmpp-notify/entrypoint.sh b/docker/xmpp-notify/entrypoint.sh new file mode 100644 index 0000000000..3e2c6629bd --- /dev/null +++ b/docker/xmpp-notify/entrypoint.sh @@ -0,0 +1,3 @@ +#!/bin/bash +go get -u github.com/FluuxIO/go-xmpp +go run /notifier/main.go "${INPUT_SERVER_HOST}" "${INPUT_RECIPIENT}" "${INPUT_JID}" "${INPUT_PASSWORD}" "${INPUT_SERVER_PORT}" "${INPUT_MESSAGE}" "${INPUT_RECIPIENT_IS_ROOM}" "${INPUT_BOT_ALIAS}" diff --git a/docker/xmpp-notify/go.mod b/docker/xmpp-notify/go.mod new file mode 100644 index 0000000000..b615204f0b --- /dev/null +++ b/docker/xmpp-notify/go.mod @@ -0,0 +1,5 @@ +module go-xmpp_notifier + +go 1.13 + +require gosrc.io/xmpp v0.4.0 diff --git a/docker/xmpp-notify/main.go b/docker/xmpp-notify/main.go new file mode 100644 index 0000000000..31eb7f2149 --- /dev/null +++ b/docker/xmpp-notify/main.go @@ -0,0 +1,138 @@ +package main + +import ( + "log" + "os" + "strconv" + "strings" + + "gosrc.io/xmpp" + "gosrc.io/xmpp/stanza" +) + +const ( + serverDomain = iota + 1 + recipient + jid + password + serverPort + message + recipientIsRoom + botAlias + + defaultServerPort = "5222" + defaultBotAlias = "/github_bot" +) + +func main() { + // Find server port from action config or use default one + var port string + if strings.TrimSpace(os.Args[serverPort]) == "" { + port = defaultServerPort + } else { + port = os.Args[serverPort] + } + + // Build client and connect to server + config := xmpp.Config{ + TransportConfiguration: xmpp.TransportConfiguration{ + Address: os.Args[serverDomain] + ":" + port, + }, + Jid: os.Args[jid], + Credential: xmpp.Password(os.Args[password]), + StreamLogger: os.Stdout, + Insecure: false, + } + router := xmpp.NewRouter() + client, err := xmpp.NewClient(config, router, errorHandler) + + if err != nil { + log.Fatalf("%+v", err) + } + + err = client.Connect() + if err != nil { + panic(err) + } + + // Check if we want to send to a chat room or a single user + // Send presence to connect to chat room, if specified + // Set the correspondentJid + var clientJid *stanza.Jid + isRecipientRoom, err := strconv.ParseBool(os.Args[recipientIsRoom]) + if err != nil { + panic("failed to determine if sending to a client or chat room : " + err.Error()) + } + + if isRecipientRoom { + // Building Jid for the room. + // the "resource". See XEP-0045 + if strings.TrimSpace(os.Args[botAlias]) != "" { + if os.Args[botAlias][:1] != "/" { + os.Args[botAlias] = "/" + os.Args[botAlias] + } + clientJid, err = stanza.NewJid(os.Args[recipient] + os.Args[botAlias]) + } else { + clientJid, err = stanza.NewJid(os.Args[recipient] + defaultBotAlias) + } + if err != nil { + panic(err) + } + // Sending room presence + err = joinMUC(client, clientJid) + if err != nil { + panic(err) + } + } else { + clientJid, err = stanza.NewJid(os.Args[recipient]) + if err != nil { + panic(err) + } + } + + // Send github message to recipient or chat room + m := stanza.Message{Attrs: stanza.Attrs{To: clientJid.Bare(), Type: getMessageType(isRecipientRoom)}, Body: os.Args[message]} + err = client.Send(m) + if err != nil { + panic(err) + } + + // After sending the action message, let's disconnect from the chat room if we were connected to one. + if isRecipientRoom { + leaveMUC(client, clientJid) + } + // And disconnect from the server + client.Disconnect() +} + +// errorHandler is the client error handler +func errorHandler(err error) { + panic(err) +} + +// joinMUC builds a presence stanza to request joining a chat room +func joinMUC(c xmpp.Sender, toJID *stanza.Jid) error { + return c.Send(stanza.Presence{Attrs: stanza.Attrs{To: toJID.Full()}, + Extensions: []stanza.PresExtension{ + stanza.MucPresence{ + History: stanza.History{MaxStanzas: stanza.NewNullableInt(0)}, + }}, + }) +} + +// leaveMUC builds a presence stanza to request leaving a chat room +func leaveMUC(c xmpp.Sender, muc *stanza.Jid) error { + return c.Send(stanza.Presence{Attrs: stanza.Attrs{ + To: muc.Full(), + Type: stanza.PresenceTypeUnavailable, + }}) +} + +// getMessageType figures out the right message type for the github message, depending on what recipient is targeted. +// Message type is important since servers are allowed to ignore messages that do not have an appropriate type +func getMessageType(isCorrespRoom bool) stanza.StanzaType { + if isCorrespRoom { + return stanza.MessageTypeGroupchat + } + return stanza.MessageTypeChat +}