diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..61afa8d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,55 @@ +name: Bug Report +description: File a bug report +body: + - type: markdown + attributes: + value: | + Thanks for reporting an issue, please review the task list below before submitting the issue. Your issue report will be closed if the issue is incomplete and the below tasks not completed. + + NOTE: If you are unsure about something and the issue is more of a question a better place to ask questions is on [Github Discussions](https://github.com/kestra-io/kestra/discussions) or [Slack](https://api.kestra.io/v1/communities/slack/redirect). + - type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + placeholder: Tell us what should happen + validations: + required: false + - type: textarea + attributes: + label: Actual Behaviour + description: A concise description of what you're experiencing. + placeholder: Tell us what happens instead + validations: + required: false + - type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. In this environment... + 2. With this config... + 3. Run '...' + 4. See error... + validations: + required: false + - type: textarea + attributes: + label: Environment Information + description: Environment information where the problem occurs. + value: | + - Kestra Version: + - Plugin version: + - Operating System (OS / Docker / Kubernetes): + - Java Version (If not docker): + validations: + required: true + - type: textarea + attributes: + label: Example flow + description: Example flow source. + placeholder: | + If relevant, an example flow + validations: + required: false +labels: + - bug diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..a6d0656 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,7 @@ +contact_links: + - name: GitHub Discussions + url: https://github.com/kestra-io/kestra/discussions + about: Ask questions about Kestra on Github + - name: Chat + url: https://api.kestra.io/v1/communities/slack/redirect + about: Chat with us on Slack. diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..11f8a1a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,15 @@ +name: Feature request +description: Create a new feature request +body: + - type: markdown + attributes: + value: | + Please describe the feature you want for Kestra to implement, before that check if there is already an existing issue to add it. + - type: textarea + attributes: + label: Feature description + placeholder: Tell us what feature you would like for Kestra to have and what problem is it going to solve + validations: + required: true +labels: + - enhancement diff --git a/.github/ISSUE_TEMPLATE/other.yml b/.github/ISSUE_TEMPLATE/other.yml new file mode 100644 index 0000000..20f261f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other.yml @@ -0,0 +1,8 @@ +name: Other +description: Something different +body: + - type: textarea + attributes: + label: Issue description + validations: + required: true diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..b880556 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,21 @@ +# See GitHub's docs for more information on this file: +# https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/configuration-options-for-dependency-updates +version: 2 +updates: + # Maintain dependencies for GitHub Actions + - package-ecosystem: "github-actions" + directory: "/" + schedule: + # Check for updates to GitHub Actions every weekday + interval: "daily" + labels: + - "dependency-upgrade" + + # Maintain dependencies for Gradle modules + - package-ecosystem: "gradle" + directory: "/" + schedule: + # Check for updates to Go modules every weekday + interval: "daily" + labels: + - "dependency-upgrade" diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..68570ae --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,37 @@ + + +### What changes are being made and why? + + +--- + +### How the changes have been QAed? + + + +--- + +### Setup Instructions + + diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..492e58d --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,103 @@ +name: Main + +on: + push: + branches: + - master + tags: + - v* + + pull_request: + branches: + - master + +jobs: + check: + name: Check & Publish + runs-on: ubuntu-latest + env: + SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} + steps: + - uses: actions/checkout@v4 + + # Caches + - name: Gradle cache + uses: actions/cache@v3 + with: + path: | + ~/.gradle/caches + ~/.gradle/wrapper + key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle*.properties') }} + restore-keys: | + ${{ runner.os }}-gradle- + + # JDK + - name: Set up JDK + uses: actions/setup-java@v3 + with: + distribution: 'temurin' + java-version: 17 + + - name: Validate Gradle wrapper + uses: gradle/wrapper-validation-action@v1 + + # Gradle check + - name: Build with Gradle + run: ./gradlew check + + # Publish + - name: Publish package to Sonatype + if: github.ref == 'refs/heads/master' + env: + ORG_GRADLE_PROJECT_sonatypeUsername: ${{ secrets.SONATYPE_USER }} + ORG_GRADLE_PROJECT_sonatypePassword: ${{ secrets.SONATYPE_PASSWORD }} + SONATYPE_GPG_KEYID: ${{ secrets.SONATYPE_GPG_KEYID }} + SONATYPE_GPG_PASSWORD: ${{ secrets.SONATYPE_GPG_PASSWORD }} + SONATYPE_GPG_FILE: ${{ secrets.SONATYPE_GPG_FILE }} + run: | + echo "signing.keyId=${SONATYPE_GPG_KEYID}" > ~/.gradle/gradle.properties + echo "signing.password=${SONATYPE_GPG_PASSWORD}" >> ~/.gradle/gradle.properties + echo "signing.secretKeyRingFile=${HOME}/.gradle/secring.gpg" >> ~/.gradle/gradle.properties + echo ${SONATYPE_GPG_FILE} | base64 -d > ~/.gradle/secring.gpg + ./gradlew publishToSonatype + + # Release + - name: Release package to Maven Central + if: startsWith(github.ref, 'refs/tags/v') + env: + ORG_GRADLE_PROJECT_sonatypeUsername: ${{ secrets.SONATYPE_USER }} + ORG_GRADLE_PROJECT_sonatypePassword: ${{ secrets.SONATYPE_PASSWORD }} + SONATYPE_GPG_KEYID: ${{ secrets.SONATYPE_GPG_KEYID }} + SONATYPE_GPG_PASSWORD: ${{ secrets.SONATYPE_GPG_PASSWORD }} + SONATYPE_GPG_FILE: ${{ secrets.SONATYPE_GPG_FILE }} + run: | + echo "signing.keyId=${SONATYPE_GPG_KEYID}" > ~/.gradle/gradle.properties + echo "signing.password=${SONATYPE_GPG_PASSWORD}" >> ~/.gradle/gradle.properties + echo "signing.secretKeyRingFile=${HOME}/.gradle/secring.gpg" >> ~/.gradle/gradle.properties + echo ${SONATYPE_GPG_FILE} | base64 -d > ~/.gradle/secring.gpg + ./gradlew publishToSonatype closeAndReleaseSonatypeStagingRepository + + # GitHub Release + - name: Create GitHub release + uses: "marvinpinto/action-automatic-releases@latest" + if: startsWith(github.ref, 'refs/tags/v') + with: + repo_token: "${{ secrets.GITHUB_TOKEN }}" + prerelease: false + files: | + build/libs/*.jar + + # Slack + - name: Slack notification + uses: 8398a7/action-slack@v3 + if: ${{ always() && env.SLACK_WEBHOOK_URL != 0 }} + with: + status: ${{ job.status }} + job_name: Check & Publish + fields: repo,message,commit,author,action,eventName,ref,workflow,job,took + username: GitHub Actions + icon_emoji: ':github-actions:' + channel: 'C02DQ1A7JLR' + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4be6e5d --- /dev/null +++ b/.gitignore @@ -0,0 +1,16 @@ +Thumbs.db +.DS_Store +.gradle +build/ +target/ +out/ +.idea +.vscode +*.iml +*.ipr +*.iws +.project +.settings +.classpath +.attach* +src/test/resources/application-test.yml diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b7ad1a9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,191 @@ + + Apache License + Version 2.0, January 2004 + https://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 + + Copyright 2019 Nigh Tech. + + 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 + + https://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. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..44f1a7f --- /dev/null +++ b/README.md @@ -0,0 +1,58 @@ +

+ + Kestra workflow orchestrator + +

+ +

+ Event-Driven Declarative Orchestrator +

+ +
+ Last Version + License + Github star
+Kestra infinitely scalable orchestration and scheduling platform +Slack +
+ +
+ +

+ twitter   + linkedin   +youtube   +

+ +
+

+ + Get started in 4 minutes with Kestra + +

+

Get started with Kestra in 4 minutes.

+ + +# Kestra Plugin Template + +> A template for creating Kestra plugins + +This repository serves as a general template for creating a new [Kestra](https://github.com/kestra-io/kestra) plugin. It should take only a few minutes! Use this repository as a scaffold to ensure that you've set up the plugin correctly, including unit tests and CI/CD workflows. + +![Kestra orchestrator](https://kestra.io/video.gif) + + +## Documentation +* Full documentation can be found under: [kestra.io/docs](https://kestra.io/docs) +* Documentation for developing a plugin is included in the [Plugin Developer Guide](https://kestra.io/docs/plugin-developer-guide/) + + +## License +Apache 2.0 © [Kestra Technologies](https://kestra.io) + + +## Stay up to date + +We release new versions every month. Give the [main repository](https://github.com/kestra-io/kestra) a star to stay up to date with the latest releases and get notified about future updates. + +![Star the repo](https://kestra.io/star.gif) diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..0989b37 --- /dev/null +++ b/build.gradle @@ -0,0 +1,163 @@ +plugins { + id 'java-library' + id "idea" + id "com.adarshr.test-logger" version "3.2.0" + id "com.github.johnrengelman.shadow" version "8.1.1" + id 'ru.vyarus.java-lib' version '2.4.0' + id 'ru.vyarus.github-info' version '1.5.0' + id 'signing' + id "io.github.gradle-nexus.publish-plugin" version "1.3.0" + id "com.github.ben-manes.versions" version "0.49.0" + id 'net.researchgate.release' version '3.0.2' +} + +def isBuildSnapshot = version.toString().endsWith("-SNAPSHOT") + +repositories { + mavenCentral() + if (isBuildSnapshot) { + maven { url "https://s01.oss.sonatype.org/content/repositories/snapshots/" } + } +} + +sourceCompatibility = 17 +targetCompatibility = 17 + +group "io.kestra.plugin" +description 'Plugin template for Kestra' + +tasks.withType(JavaCompile) { + options.encoding = "UTF-8" + options.compilerArgs.add("-parameters") +} + +configurations.all { + resolutionStrategy { + force("org.slf4j:slf4j-api:1.7.36") + } +} + +dependencies { + // lombok + annotationProcessor "org.projectlombok:lombok:$lombokVersion" + compileOnly "org.projectlombok:lombok:$lombokVersion" + + // micronaut + annotationProcessor platform("io.micronaut:micronaut-bom:$micronautVersion") + annotationProcessor "io.micronaut:micronaut-inject-java" + annotationProcessor "io.micronaut:micronaut-validation" + compileOnly platform("io.micronaut:micronaut-bom:$micronautVersion") + compileOnly "io.micronaut:micronaut-inject" + compileOnly "io.micronaut:micronaut-validation" + + // kestra + compileOnly group: "io.kestra", name: "core", version: kestraVersion + + // libs included in the final jar + api group: 'com.google.code.gson', name: 'gson', version: '2.10.1' +} + + +/**********************************************************************************************************************\ + * Test + **********************************************************************************************************************/ +test { + useJUnitPlatform() +} + +testlogger { + theme "mocha-parallel" + showExceptions true + showFullStackTraces true + showStandardStreams true + showPassedStandardStreams false + showSkippedStandardStreams true +} + +dependencies { + testAnnotationProcessor platform("io.micronaut:micronaut-bom:$micronautVersion") + testAnnotationProcessor "io.micronaut:micronaut-inject-java" + testImplementation platform("io.micronaut:micronaut-bom:$micronautVersion") + testImplementation "io.micronaut.test:micronaut-test-junit5" + + // test deps needed only for to have a runner + testImplementation group: "io.kestra", name: "core", version: kestraVersion + testImplementation group: "io.kestra", name: "repository-memory", version: kestraVersion + testImplementation group: "io.kestra", name: "runner-memory", version: kestraVersion + testImplementation group: "io.kestra", name: "storage-local", version: kestraVersion + + // test + testImplementation "org.junit.jupiter:junit-jupiter-engine" + testImplementation "org.hamcrest:hamcrest:2.2" + testImplementation "org.hamcrest:hamcrest-library:2.2" +} + +/**********************************************************************************************************************\ + * Publish + **********************************************************************************************************************/ +nexusPublishing { + repositoryDescription = "${project.group}:${rootProject.name}:${project.version}" + useStaging = !isBuildSnapshot + repositories { + sonatype { + nexusUrl.set(uri("https://s01.oss.sonatype.org/service/local/")) + snapshotRepositoryUrl.set(uri("https://s01.oss.sonatype.org/content/repositories/snapshots/")) + } + } +} + +jar { + manifest { + attributes( + "X-Kestra-Name": project.name, + "X-Kestra-Title": "Template", + "X-Kestra-Group": project.group + ".templates", + "X-Kestra-Description": project.description, + "X-Kestra-Version": project.version + ) + } +} + +pom { + developers { + developer { + id "tchiotludo" + name "Ludovic Dehon" + } + } +} + +shadowJar { + archiveClassifier.set(null) + mergeServiceFiles() +} + +github { + user 'kestra-io' + license 'Apache' +} + +/**********************************************************************************************************************\ + * Version + **********************************************************************************************************************/ +release { + preCommitText = 'chore(version):' + preTagCommitMessage = 'update to version' + tagCommitMessage = 'tag version' + newVersionCommitMessage = 'update snapshot version' + tagTemplate = 'v${version}' + buildTasks = ['classes'] + git { + requireBranch.set('master') + } +} + +/**********************************************************************************************************************\ + * Dev + **********************************************************************************************************************/ +idea { + module { + downloadJavadoc = true + downloadSources = true + } +} diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..88d8cec --- /dev/null +++ b/gradle.properties @@ -0,0 +1,4 @@ +version=0.13.0-SNAPSHOT +kestraVersion=[0.13,) +micronautVersion=3.10.1 +lombokVersion=1.18.30 diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..c1962a7 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..c30b486 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.3-bin.zip +networkTimeout=10000 +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..aeb74cb --- /dev/null +++ b/gradlew @@ -0,0 +1,245 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# 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 +# +# https://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. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..93e3f59 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/lombok.config b/lombok.config new file mode 100644 index 0000000..0586c81 --- /dev/null +++ b/lombok.config @@ -0,0 +1,5 @@ +config.stopBubbling = true +lombok.addLombokGeneratedAnnotation = true +lombok.anyConstructor.addConstructorProperties = true +lombok.equalsAndHashCode.callSuper = call +lombok.tostring.callsuper = call diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..aaa347f --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'plugin-template' diff --git a/src/main/java/io/kestra/plugin/templates/Example.java b/src/main/java/io/kestra/plugin/templates/Example.java new file mode 100644 index 0000000..82daa3c --- /dev/null +++ b/src/main/java/io/kestra/plugin/templates/Example.java @@ -0,0 +1,73 @@ +package io.kestra.plugin.templates; + +import io.kestra.core.models.annotations.Plugin; +import io.swagger.v3.oas.annotations.media.Schema; +import lombok.*; +import lombok.experimental.SuperBuilder; +import org.apache.commons.lang3.StringUtils; +import io.kestra.core.models.annotations.PluginProperty; +import io.kestra.core.models.tasks.RunnableTask; +import io.kestra.core.models.tasks.Task; +import io.kestra.core.runners.RunContext; +import org.slf4j.Logger; + +@SuperBuilder +@ToString +@EqualsAndHashCode +@Getter +@NoArgsConstructor +@Schema( + title = "Short description for this task", + description = "Full description of this task" +) +@Plugin( + examples = { + @io.kestra.core.models.annotations.Example( + title = "Simple revert", + code = { "format: \"Text to be reverted\"" } + ) + } +) +public class Example extends Task implements RunnableTask { + @Schema( + title = "Short description for this input", + description = "Full description of this input" + ) + @PluginProperty(dynamic = true) // If the variables will be rendered with template {{ }} + private String format; + + @Override + public Example.Output run(RunContext runContext) throws Exception { + Logger logger = runContext.logger(); + + String render = runContext.render(format); + logger.debug(render); + + return Output.builder() + .child(new OutputChild(StringUtils.reverse(render))) + .build(); + } + + /** + * Input or Output can be nested as you need + */ + @Builder + @Getter + public static class Output implements io.kestra.core.models.tasks.Output { + @Schema( + title = "Short description for this output", + description = "Full description of this output" + ) + private final OutputChild child; + } + + @Builder + @Getter + public static class OutputChild implements io.kestra.core.models.tasks.Output { + @Schema( + title = "Short description for this output", + description = "Full description of this output" + ) + private final String value; + } +} diff --git a/src/test/java/io/kestra/plugin/templates/ExampleRunnerTest.java b/src/test/java/io/kestra/plugin/templates/ExampleRunnerTest.java new file mode 100644 index 0000000..93bb336 --- /dev/null +++ b/src/test/java/io/kestra/plugin/templates/ExampleRunnerTest.java @@ -0,0 +1,53 @@ +package io.kestra.plugin.templates; + +import io.micronaut.test.extensions.junit5.annotation.MicronautTest; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import io.kestra.core.models.executions.Execution; +import io.kestra.core.repositories.LocalFlowRepositoryLoader; +import io.kestra.core.runners.RunnerUtils; +import io.kestra.runner.memory.MemoryRunner; + +import jakarta.inject.Inject; +import java.io.IOException; +import java.net.URISyntaxException; +import java.util.Map; +import java.util.Objects; +import java.util.concurrent.TimeoutException; + +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.hasSize; +import static org.hamcrest.Matchers.is; + +/** + * This test will load all flow located in `src/test/resources/flows/` + * and will run an in-memory runner to be able to test a full flow. There is also a + * configuration file in `src/test/resources/application.yml` that is only for the full runner + * test to configure in-memory runner. + */ +@MicronautTest +class ExampleRunnerTest { + @Inject + protected MemoryRunner runner; + + @Inject + protected RunnerUtils runnerUtils; + + @Inject + protected LocalFlowRepositoryLoader repositoryLoader; + + @BeforeEach + protected void init() throws IOException, URISyntaxException { + repositoryLoader.load(Objects.requireNonNull(ExampleRunnerTest.class.getClassLoader().getResource("flows"))); + this.runner.run(); + } + + @SuppressWarnings("unchecked") + @Test + void flow() throws TimeoutException { + Execution execution = runnerUtils.runOne(null, "io.kestra.templates", "example"); + + assertThat(execution.getTaskRunList(), hasSize(3)); + assertThat(((Map)execution.getTaskRunList().get(2).getOutputs().get("child")).get("value"), is("task-id")); + } +} diff --git a/src/test/java/io/kestra/plugin/templates/ExampleTest.java b/src/test/java/io/kestra/plugin/templates/ExampleTest.java new file mode 100644 index 0000000..48cfb7a --- /dev/null +++ b/src/test/java/io/kestra/plugin/templates/ExampleTest.java @@ -0,0 +1,36 @@ +package io.kestra.plugin.templates; + +import com.google.common.collect.ImmutableMap; +import io.micronaut.test.extensions.junit5.annotation.MicronautTest; +import org.apache.commons.lang3.StringUtils; +import org.junit.jupiter.api.Test; +import io.kestra.core.runners.RunContext; +import io.kestra.core.runners.RunContextFactory; + +import jakarta.inject.Inject; + +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.is; + +/** + * This test will only test the main task, this allow you to send any input + * parameters to your task and test the returning behaviour easily. + */ +@MicronautTest +class ExampleTest { + @Inject + private RunContextFactory runContextFactory; + + @Test + void run() throws Exception { + RunContext runContext = runContextFactory.of(ImmutableMap.of("variable", "John Doe")); + + Example task = Example.builder() + .format("Hello {{ variable }}") + .build(); + + Example.Output runOutput = task.run(runContext); + + assertThat(runOutput.getChild().getValue(), is(StringUtils.reverse("Hello John Doe"))); + } +} diff --git a/src/test/resources/application.yml b/src/test/resources/application.yml new file mode 100644 index 0000000..636ef67 --- /dev/null +++ b/src/test/resources/application.yml @@ -0,0 +1,9 @@ +kestra: + repository: + type: memory + queue: + type: memory + storage: + type: local + local: + base-path: /tmp/unittest diff --git a/src/test/resources/flows/example.yaml b/src/test/resources/flows/example.yaml new file mode 100644 index 0000000..c475b05 --- /dev/null +++ b/src/test/resources/flows/example.yaml @@ -0,0 +1,13 @@ +id: example +namespace: io.kestra.templates + +tasks: +- id: date + type: io.kestra.plugin.templates.Example + format: "{{taskrun.startDate}}" +- id: task-id + type: io.kestra.plugin.templates.Example + format: "{{task.id}}" +- id: flow-id + type: io.kestra.plugin.templates.Example + format: "{{outputs['task-id'].child.value}}" diff --git a/src/test/resources/logback.xml b/src/test/resources/logback.xml new file mode 100644 index 0000000..a1faa00 --- /dev/null +++ b/src/test/resources/logback.xml @@ -0,0 +1,23 @@ + + + + + true + + + System.out + true + + ${pattern} + + + + + + + + + + + +