├── .circleci ├── config.yml ├── params │ └── common.dig ├── success.dig ├── templates │ ├── invalid.yml │ └── valid.yml ├── test.sh ├── validate_template.dig └── validate_webhook_url.dig ├── .gitignore ├── CHANGELOG.md ├── LICENSE ├── README.md ├── build.gradle ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── sample ├── danger-template.yml ├── good-template.yml ├── imgs │ ├── sample-danger.png │ └── sample-good.png └── slack.dig └── src └── main ├── java └── io │ └── digdag │ └── plugin │ └── slack │ ├── SlackOperatorFactory.java │ ├── SlackPayload.java │ └── SlackPlugin.java └── resources └── META-INF └── services └── io.digdag.spi.Plugin /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | jobs: 3 | build: 4 | working_directory: ~/digdag-slack 5 | docker: 6 | - image: openjdk:8u141-jdk 7 | environment: 8 | TERM: dumb 9 | 10 | steps: 11 | - checkout 12 | - run: ./gradlew clean && ./gradlew publish 13 | 14 | - run: 15 | name: Install digdag 16 | command: | 17 | curl -o /bin/digdag --create-dirs -L "https://dl.digdag.io/digdag-latest" 18 | chmod +x /bin/digdag 19 | 20 | - run: 21 | name: Testing post to slack 22 | command: | 23 | cd .circleci 24 | rm -rf .digdag/plugins 25 | ./test.sh 26 | environment: 27 | version: 0.1.5-SNAPSHOT 28 | -------------------------------------------------------------------------------- /.circleci/params/common.dig: -------------------------------------------------------------------------------- 1 | plugin: 2 | repositories: 3 | - file://${repos} 4 | dependencies: 5 | - io.digdag.plugin:digdag-slack:${version} 6 | workflow_name: slack 7 | ENV: test 8 | -------------------------------------------------------------------------------- /.circleci/success.dig: -------------------------------------------------------------------------------- 1 | _export: 2 | !include : params/common.dig 3 | webhook_url: https://hooks.slack.com/services/${token} 4 | 5 | +task: 6 | slack>: templates/valid.yml 7 | -------------------------------------------------------------------------------- /.circleci/templates/invalid.yml: -------------------------------------------------------------------------------- 1 | --- 2 | username: Digdag 3 | icon_emoji: ':blush:' 4 | # channel: '#general' ## if you need to send message to specific channel 5 | typo_text: "Hello digdag-slack!" 6 | typo_attachments: 7 | - fallback: '[SUCCESS] ${workflow_name} workflow' 8 | color: "good" 9 | text: '*[SUCCESS]* `${workflow_name}` Workflow' 10 | mrkdwn_in: 11 | - text 12 | - pretext 13 | - fields 14 | fields: 15 | - title: Task Name 16 | value: "${task_name}" 17 | short: false 18 | - title: Session Date 19 | value: "${session_date}" 20 | short: true 21 | - title: Environment 22 | value: "${ENV}" 23 | short: true 24 | -------------------------------------------------------------------------------- /.circleci/templates/valid.yml: -------------------------------------------------------------------------------- 1 | --- 2 | username: Digdag 3 | icon_emoji: ':blush:' 4 | # channel: '#general' ## if you need to send message to specific channel 5 | attachments: 6 | - fallback: '[SUCCESS] ${workflow_name} workflow' 7 | color: "good" 8 | text: '*[SUCCESS]* `${workflow_name}` Workflow' 9 | mrkdwn_in: 10 | - text 11 | - pretext 12 | - fields 13 | fields: 14 | - title: Task Name 15 | value: "${task_name}" 16 | short: false 17 | - title: Session Date 18 | value: "${session_date}" 19 | short: true 20 | - title: Environment 21 | value: "${ENV}" 22 | short: true 23 | -------------------------------------------------------------------------------- /.circleci/test.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | run() 4 | { 5 | case=$1 6 | workflow=$2 7 | echo "case: ${case}" 8 | digdag run --no-save -a ${workflow} \ 9 | -p repos=${PWD}/../build/repo \ 10 | -p token=${TOKEN} \ 11 | -p version=${version} 12 | } 13 | 14 | run "success" "success.dig" 15 | 16 | run "webhook_url validation" "validate_webhook_url.dig" 17 | if [[ $? -eq 0 ]]; then 18 | exit 1 19 | fi 20 | 21 | run "template validation" "validate_template.dig" 22 | if [[ $? -eq 0 ]]; then 23 | exit 1 24 | else 25 | exit 0 26 | fi 27 | -------------------------------------------------------------------------------- /.circleci/validate_template.dig: -------------------------------------------------------------------------------- 1 | _export: 2 | !include : params/common.dig 3 | webhook_url: https://hooks.slack.com/services/${token} 4 | 5 | +task: 6 | slack>: templates/invalid.yml 7 | -------------------------------------------------------------------------------- /.circleci/validate_webhook_url.dig: -------------------------------------------------------------------------------- 1 | _export: 2 | !include : params/common.dig 3 | 4 | +task: 5 | slack>: templates/valid.yml 6 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *~ 2 | /.gradle 3 | /build 4 | .java-version 5 | .digdag 6 | 7 | # git 8 | !.gitkeep 9 | .git 10 | 11 | # intellij 12 | *.iml 13 | *.ipr 14 | *.iws 15 | *.idea 16 | 17 | # eclipse 18 | .classpath 19 | .project 20 | .settings -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## Change Log 2 | 3 | ### 0.1.4 (2017/10/12 15:16 +00:00) 4 | - [#12](https://github.com/szyn/digdag-slack/pull/12) Make secrets available on webhook param (#12) (@mia-0032) 5 | - [#11](https://github.com/szyn/digdag-slack/pull/11) Release 0.1.3 (#11) (@szyn) 6 | 7 | ### 0.1.3 (2017/10/02 15:47 +00:00) 8 | - [#10](https://github.com/szyn/digdag-slack/pull/10) Bump digdagVersion to 0.9.17 (#10) (@szyn) 9 | - [#9](https://github.com/szyn/digdag-slack/pull/9) Using jackson dataformat yaml (#9) (@szyn) 10 | - [#8](https://github.com/szyn/digdag-slack/pull/8) Add params validation (#8) (@szyn) 11 | - [#7](https://github.com/szyn/digdag-slack/pull/7) Setup CircleCi (#7) (@szyn) 12 | 13 | ### 0.1.2 (2017/07/18 05:02 +00:00) 14 | - [#6](https://github.com/szyn/digdag-slack/pull/6) Bump version to 0.1.2 (@szyn) 15 | - [#5](https://github.com/szyn/digdag-slack/pull/5) fix PluginClassLoader(metaspace) Leak (@maitani) 16 | - [#2](https://github.com/szyn/digdag-slack/pull/2) Reformat code (@szyn) 17 | - [#1](https://github.com/szyn/digdag-slack/pull/1) Add channel parameter to sample (@grimrose) -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright 2017 szyn 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # digdag-slack 2 | [![](https://jitpack.io/v/szyn/digdag-slack.svg?style=flat-square)](https://jitpack.io/#szyn/digdag-slack) 3 | [![](https://jitpack.io/v/szyn/digdag-slack/month.svg?style=flat-square)](https://jitpack.io/#szyn/digdag-slack) 4 | [![Circle CI](https://img.shields.io/circleci/project/github/szyn/digdag-slack.svg?style=flat-square)](https://circleci.com/gh/szyn/digdag-slack) 5 | 6 | ## Description 7 | digdag-slack is a plugin sending messages to slack. 8 | It can use yaml templates for building messages. 9 | 10 | ***DEMO:*** 11 | 12 | |SUCCESS|FAILED| 13 | |---|---| 14 | |[![sample-good.png](sample/imgs/sample-good.png)](sample/imgs/sample-good.png)|[![sample-danger.png](sample/imgs/sample-danger.png)](sample/imgs/sample-danger.png)| 15 | 16 | 17 | ## Features 18 | 19 | - Can use the `slack>` opetaror 20 | - Easy to use 21 | - Flexible templates 22 | 23 | ## Requirement 24 | 25 | - [Digdag](https://www.digdag.io/) 26 | - Slack 27 | - Webhook URL [(Incoming WebHooks)](https://my.slack.com/apps/A0F7XDUAZ-incoming-webhooks) 28 | 29 | **[Note]** 30 | If you want to use `${task_name}`, you must digdag v0.9.9 and up. 31 | 32 | ## Usage 33 | Also, you can see expamle workflow at [sample](https://github.com/szyn/digdag-slack/tree/master/sample) directory. 34 | 35 | 1. Create workflow file (e.g. slack.dig) 36 | 37 | ```yaml 38 | _export: 39 | plugin: 40 | repositories: 41 | - https://jitpack.io 42 | dependencies: 43 | - com.github.szyn:digdag-slack:0.1.4 44 | # Set Reqired params 45 | webhook_url: https://hooks.slack.com/services/XXX/XXX/XXX 46 | # Set Option params 47 | workflow_name: slack 48 | ENV: develop 49 | 50 | +step1-1: 51 | echo>: "Next will be success!" 52 | 53 | +step1-2: 54 | slack>: good-template.yml 55 | ``` 56 | 57 | 2. Create templates for slack's payload (e.g. good-template.yml) 58 | 59 | ```yaml 60 | username: Digdag 61 | icon_emoji: ':blush:' 62 | # channel: '#general' ## if you need to send message to specific channel 63 | attachments: 64 | - fallback: '[SUCCESS] ${workflow_name} workflow' 65 | color: "good" 66 | text: '*[SUCCESS]* `${workflow_name}` Workflow' 67 | mrkdwn_in: 68 | - text 69 | - pretext 70 | - fields 71 | fields: 72 | - title: Task Name 73 | value: "${task_name}" 74 | short: false 75 | - title: Session Date 76 | value: "${session_date}" 77 | short: true 78 | - title: Environment 79 | value: "${ENV}" # You can use exported environment values 80 | short: true 81 | ``` 82 | 83 | 3. Runs workflow 84 | ```console 85 | $ digdag run -a slack.dig 86 | ``` 87 | 88 | ## Secrets 89 | 90 | * **slack.webhook_url**: The slack incoming webhook url 91 | 92 | ```yaml 93 | _export: 94 | ... 95 | # Set Reqired params 96 | webhook_url: ${secret:slack.webhook_url} 97 | ``` 98 | 99 | ## Author 100 | 101 | [szyn](https://twitter.com/i_szyn) 102 | 103 | ## License 104 | 105 | [Apache License 2.0](LICENSE) 106 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: 'java' 2 | apply plugin: 'maven' 3 | apply plugin: 'maven-publish' 4 | apply plugin: 'idea' 5 | 6 | group = 'io.digdag.plugin' 7 | version = '0.1.5-SNAPSHOT' 8 | 9 | def digdagVersion = '0.9.17' 10 | 11 | repositories { 12 | mavenLocal() 13 | mavenCentral() 14 | jcenter() 15 | maven { 16 | url "https://dl.bintray.com/digdag/maven" 17 | } 18 | } 19 | 20 | configurations { 21 | provided 22 | } 23 | 24 | dependencies { 25 | compile 'com.squareup.okhttp3:okhttp:3.8.1' 26 | provided 'com.fasterxml.jackson.dataformat:jackson-dataformat-yaml:2.9.1' 27 | provided 'io.digdag:digdag-spi:' + digdagVersion 28 | provided 'io.digdag:digdag-plugin-utils:' + digdagVersion // this should be 'compile' instead of 'provided' once digdag 0.8.18 is released to one of the built-in repositories (maven central or jcenter) 29 | } 30 | sourceSets { 31 | main { 32 | compileClasspath += configurations.provided 33 | test.compileClasspath += configurations.provided 34 | test.runtimeClasspath += configurations.provided 35 | } 36 | } 37 | 38 | publishing { 39 | publications { 40 | mavenJava(MavenPublication) { 41 | from components.java 42 | } 43 | } 44 | repositories { 45 | maven { 46 | url "$buildDir/repo" 47 | } 48 | } 49 | } 50 | 51 | sourceCompatibility = 1.8 52 | targetCompatibility = 1.8 53 | 54 | compileJava.options.encoding = 'UTF-8' 55 | compileTestJava.options.encoding = 'UTF-8' 56 | 57 | tasks.withType(JavaCompile) { 58 | options.compilerArgs << "-Xlint:unchecked" << "-Xlint:deprecation" 59 | } 60 | 61 | javadoc { 62 | options { 63 | locale = 'en_US' 64 | encoding = 'UTF-8' 65 | } 66 | } 67 | 68 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/szyn/digdag-slack/cd8920ef1045d6333eecb4aff9bd9fb23cd3277a/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Sun Apr 02 14:24:43 JST 2017 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-2.11-all.zip 7 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 10 | DEFAULT_JVM_OPTS="" 11 | 12 | APP_NAME="Gradle" 13 | APP_BASE_NAME=`basename "$0"` 14 | 15 | # Use the maximum available, or set MAX_FD != -1 to use that value. 16 | MAX_FD="maximum" 17 | 18 | warn ( ) { 19 | echo "$*" 20 | } 21 | 22 | die ( ) { 23 | echo 24 | echo "$*" 25 | echo 26 | exit 1 27 | } 28 | 29 | # OS specific support (must be 'true' or 'false'). 30 | cygwin=false 31 | msys=false 32 | darwin=false 33 | case "`uname`" in 34 | CYGWIN* ) 35 | cygwin=true 36 | ;; 37 | Darwin* ) 38 | darwin=true 39 | ;; 40 | MINGW* ) 41 | msys=true 42 | ;; 43 | esac 44 | 45 | # For Cygwin, ensure paths are in UNIX format before anything is touched. 46 | if $cygwin ; then 47 | [ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"` 48 | fi 49 | 50 | # Attempt to set APP_HOME 51 | # Resolve links: $0 may be a link 52 | PRG="$0" 53 | # Need this for relative symlinks. 54 | while [ -h "$PRG" ] ; do 55 | ls=`ls -ld "$PRG"` 56 | link=`expr "$ls" : '.*-> \(.*\)$'` 57 | if expr "$link" : '/.*' > /dev/null; then 58 | PRG="$link" 59 | else 60 | PRG=`dirname "$PRG"`"/$link" 61 | fi 62 | done 63 | SAVED="`pwd`" 64 | cd "`dirname \"$PRG\"`/" >&- 65 | APP_HOME="`pwd -P`" 66 | cd "$SAVED" >&- 67 | 68 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 69 | 70 | # Determine the Java command to use to start the JVM. 71 | if [ -n "$JAVA_HOME" ] ; then 72 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 73 | # IBM's JDK on AIX uses strange locations for the executables 74 | JAVACMD="$JAVA_HOME/jre/sh/java" 75 | else 76 | JAVACMD="$JAVA_HOME/bin/java" 77 | fi 78 | if [ ! -x "$JAVACMD" ] ; then 79 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 80 | 81 | Please set the JAVA_HOME variable in your environment to match the 82 | location of your Java installation." 83 | fi 84 | else 85 | JAVACMD="java" 86 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 87 | 88 | Please set the JAVA_HOME variable in your environment to match the 89 | location of your Java installation." 90 | fi 91 | 92 | # Increase the maximum file descriptors if we can. 93 | if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then 94 | MAX_FD_LIMIT=`ulimit -H -n` 95 | if [ $? -eq 0 ] ; then 96 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 97 | MAX_FD="$MAX_FD_LIMIT" 98 | fi 99 | ulimit -n $MAX_FD 100 | if [ $? -ne 0 ] ; then 101 | warn "Could not set maximum file descriptor limit: $MAX_FD" 102 | fi 103 | else 104 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 105 | fi 106 | fi 107 | 108 | # For Darwin, add options to specify how the application appears in the dock 109 | if $darwin; then 110 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 111 | fi 112 | 113 | # For Cygwin, switch paths to Windows format before running java 114 | if $cygwin ; then 115 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 116 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules 158 | function splitJvmOpts() { 159 | JVM_OPTS=("$@") 160 | } 161 | eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS 162 | JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" 163 | 164 | exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" 165 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 12 | set DEFAULT_JVM_OPTS= 13 | 14 | set DIRNAME=%~dp0 15 | if "%DIRNAME%" == "" set DIRNAME=. 16 | set APP_BASE_NAME=%~n0 17 | set APP_HOME=%DIRNAME% 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windowz variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | if "%@eval[2+2]" == "4" goto 4NT_args 53 | 54 | :win9xME_args 55 | @rem Slurp the command line arguments. 56 | set CMD_LINE_ARGS= 57 | set _SKIP=2 58 | 59 | :win9xME_args_slurp 60 | if "x%~1" == "x" goto execute 61 | 62 | set CMD_LINE_ARGS=%* 63 | goto execute 64 | 65 | :4NT_args 66 | @rem Get arguments from the 4NT Shell from JP Software 67 | set CMD_LINE_ARGS=%$ 68 | 69 | :execute 70 | @rem Setup the command line 71 | 72 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if "%ERRORLEVEL%"=="0" goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 85 | exit /b 1 86 | 87 | :mainEnd 88 | if "%OS%"=="Windows_NT" endlocal 89 | 90 | :omega 91 | -------------------------------------------------------------------------------- /sample/danger-template.yml: -------------------------------------------------------------------------------- 1 | --- 2 | username: Digdag 3 | icon_emoji: ':cry:' 4 | attachments: 5 | - fallback: '[FAILED] ${workflow_name} workflow' 6 | color: "danger" 7 | text: '*[FAILED]* `${workflow_name}` Workflow' 8 | mrkdwn_in: 9 | - text 10 | - pretext 11 | - fields 12 | fields: 13 | - title: Task Name 14 | value: "${task_name}" 15 | short: false 16 | - title: Error Message 17 | value: "`${error.message}`" 18 | short: false 19 | - title: Session Date 20 | value: "${session_date}" 21 | short: true 22 | - title: Environment 23 | value: "${ENV}" 24 | short: true -------------------------------------------------------------------------------- /sample/good-template.yml: -------------------------------------------------------------------------------- 1 | --- 2 | username: Digdag 3 | icon_emoji: ':blush:' 4 | # channel: '#general' ## if you need to send message to specific channel 5 | attachments: 6 | - fallback: '[SUCCESS] ${workflow_name} workflow' 7 | color: "good" 8 | text: '*[SUCCESS]* `${workflow_name}` Workflow' 9 | mrkdwn_in: 10 | - text 11 | - pretext 12 | - fields 13 | fields: 14 | - title: Task Name 15 | value: "${task_name}" 16 | short: false 17 | - title: Session Date 18 | value: "${session_date}" 19 | short: true 20 | - title: Environment 21 | value: "${ENV}" 22 | short: true 23 | -------------------------------------------------------------------------------- /sample/imgs/sample-danger.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/szyn/digdag-slack/cd8920ef1045d6333eecb4aff9bd9fb23cd3277a/sample/imgs/sample-danger.png -------------------------------------------------------------------------------- /sample/imgs/sample-good.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/szyn/digdag-slack/cd8920ef1045d6333eecb4aff9bd9fb23cd3277a/sample/imgs/sample-good.png -------------------------------------------------------------------------------- /sample/slack.dig: -------------------------------------------------------------------------------- 1 | _export: 2 | plugin: 3 | repositories: 4 | # - file://${repos} 5 | - https://jitpack.io 6 | dependencies: 7 | # - io.digdag.plugin:digdag-slack:0.1.2 8 | - com.github.szyn:digdag-slack:0.1.2 9 | # Set Reqired params 10 | webhook_url: https://hooks.slack.com/services/XXXX/XXXXX/XXXXXXX 11 | # Set Option params 12 | workflow_name: slack 13 | ENV: develop 14 | 15 | +step1-1: 16 | echo>: "Next will be success!" 17 | 18 | +step1-2: 19 | slack>: good-template.yml 20 | 21 | +step2-1: 22 | echo>: "Next will be failed..." 23 | 24 | +step2-2: 25 | sh>: exit 1 26 | _error: 27 | slack>: danger-template.yml 28 | -------------------------------------------------------------------------------- /src/main/java/io/digdag/plugin/slack/SlackOperatorFactory.java: -------------------------------------------------------------------------------- 1 | package io.digdag.plugin.slack; 2 | 3 | import io.digdag.client.config.Config; 4 | import io.digdag.client.config.ConfigException; 5 | import io.digdag.spi.Operator; 6 | import io.digdag.spi.OperatorContext; 7 | import io.digdag.spi.OperatorFactory; 8 | import io.digdag.spi.TaskResult; 9 | import io.digdag.spi.TemplateEngine; 10 | import io.digdag.util.BaseOperator; 11 | import io.digdag.util.UserSecretTemplate; 12 | import okhttp3.Call; 13 | import okhttp3.FormBody; 14 | import okhttp3.OkHttpClient; 15 | import okhttp3.Request; 16 | import okhttp3.RequestBody; 17 | import okhttp3.Response; 18 | 19 | import java.io.IOException; 20 | 21 | import static java.nio.charset.StandardCharsets.UTF_8; 22 | 23 | public class SlackOperatorFactory 24 | implements OperatorFactory 25 | { 26 | private final TemplateEngine templateEngine; 27 | 28 | private static final OkHttpClient singletonInstance = new OkHttpClient(); 29 | 30 | public SlackOperatorFactory(TemplateEngine templateEngine) 31 | { 32 | this.templateEngine = templateEngine; 33 | } 34 | 35 | public String getType() 36 | { 37 | return "slack"; 38 | } 39 | 40 | @Override 41 | public Operator newOperator(OperatorContext context) 42 | { 43 | return new SlackOperator(context); 44 | } 45 | 46 | private class SlackOperator 47 | extends BaseOperator 48 | { 49 | public SlackOperator(OperatorContext context) 50 | { 51 | super(context); 52 | } 53 | 54 | @Override 55 | public TaskResult runTask() 56 | { 57 | Config params = request.getConfig().mergeDefault( 58 | request.getConfig().getNestedOrGetEmpty("slack")); 59 | 60 | if (!params.has("webhook_url")) { 61 | throw new ConfigException("'webhook_url' is required"); 62 | } 63 | String webhook_url = UserSecretTemplate.of(params.get("webhook_url", String.class)) 64 | .format(context.getSecrets()); 65 | 66 | String message = workspace.templateCommand(templateEngine, params, "message", UTF_8); 67 | String payload = SlackPayload.convertToJson(message); 68 | 69 | this.postToSlack(webhook_url, payload); 70 | 71 | return TaskResult.empty(request); 72 | } 73 | 74 | private void postToSlack(String url, String payload) 75 | { 76 | RequestBody body = new FormBody.Builder() 77 | .add("payload", payload) 78 | .build(); 79 | 80 | Request request = new Request.Builder() 81 | .url(url) 82 | .post(body) 83 | .build(); 84 | 85 | Call call = singletonInstance.newCall(request); 86 | 87 | try (Response response = call.execute()) { 88 | if (!response.isSuccessful()) { 89 | String message = "status: " + response.code() + ", message: " + response.body().string(); 90 | throw new IOException(message); 91 | } 92 | } 93 | catch (IOException e) { 94 | e.printStackTrace(); 95 | } 96 | finally { 97 | singletonInstance.connectionPool().evictAll(); 98 | } 99 | } 100 | } 101 | } 102 | -------------------------------------------------------------------------------- /src/main/java/io/digdag/plugin/slack/SlackPayload.java: -------------------------------------------------------------------------------- 1 | package io.digdag.plugin.slack; 2 | 3 | import com.fasterxml.jackson.core.JsonProcessingException; 4 | import com.fasterxml.jackson.databind.JsonNode; 5 | import com.fasterxml.jackson.databind.ObjectMapper; 6 | import com.fasterxml.jackson.dataformat.yaml.YAMLFactory; 7 | import io.digdag.client.config.ConfigException; 8 | 9 | import java.io.IOException; 10 | 11 | class SlackPayload 12 | { 13 | private static ObjectMapper yamlReader = new ObjectMapper(new YAMLFactory()); 14 | static String convertToJson(String yamlString) 15 | { 16 | validate(yamlString); 17 | 18 | Object obj = null; 19 | try { 20 | obj = yamlReader.readValue(yamlString, Object.class); 21 | } 22 | catch (IOException e) { 23 | e.printStackTrace(); 24 | } 25 | 26 | String result = null; 27 | ObjectMapper jsonWriter = new ObjectMapper(); 28 | try { 29 | result = jsonWriter.writeValueAsString(obj); 30 | } 31 | catch (JsonProcessingException e) { 32 | e.printStackTrace(); 33 | } 34 | return result; 35 | } 36 | private static void validate (String yamlString) 37 | { 38 | JsonNode root = null; 39 | try { 40 | root = yamlReader.readTree(yamlString); 41 | } catch (IOException e) { 42 | e.printStackTrace(); 43 | } 44 | if (!root.has("text") && !root.has("attachments")) { 45 | throw new ConfigException("'text' or 'attachments' is required for template for slack's payload"); 46 | } 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/main/java/io/digdag/plugin/slack/SlackPlugin.java: -------------------------------------------------------------------------------- 1 | package io.digdag.plugin.slack; 2 | 3 | import io.digdag.spi.OperatorFactory; 4 | import io.digdag.spi.OperatorProvider; 5 | import io.digdag.spi.Plugin; 6 | import io.digdag.spi.TemplateEngine; 7 | 8 | import javax.inject.Inject; 9 | 10 | import java.util.Arrays; 11 | import java.util.List; 12 | 13 | public class SlackPlugin 14 | implements Plugin 15 | { 16 | @Override 17 | public Class getServiceProvider(Class type) 18 | { 19 | if (type == OperatorProvider.class) { 20 | return SlackOperatorProvider.class.asSubclass(type); 21 | } 22 | else { 23 | return null; 24 | } 25 | } 26 | 27 | public static class SlackOperatorProvider 28 | implements OperatorProvider 29 | { 30 | @Inject 31 | protected TemplateEngine templateEngine; 32 | 33 | @Override 34 | public List get() 35 | { 36 | return Arrays.asList( 37 | new SlackOperatorFactory(templateEngine)); 38 | } 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/services/io.digdag.spi.Plugin: -------------------------------------------------------------------------------- 1 | io.digdag.plugin.slack.SlackPlugin --------------------------------------------------------------------------------