diff --git a/spring-cloud-task-docs/src/main/asciidoc/features.adoc b/spring-cloud-task-docs/src/main/asciidoc/features.adoc index 16a23839..f3b170fb 100644 --- a/spring-cloud-task-docs/src/main/asciidoc/features.adoc +++ b/spring-cloud-task-docs/src/main/asciidoc/features.adoc @@ -212,53 +212,3 @@ marking the final state of the task. } ``` -=== Launching a task from a Spring Cloud Stream - -Allows a user to launch tasks from a stream. This is done by creating a sink that -listens for a message that contains a `TaskLaunchRequest` as its payload. The -TaskLaunchRequest contains the maven coordinates to the Task that is to be executed. It -also has a Map that contains the environment variables that will be used by the Task. - -NOTE: If the payload is of a different type then the sink will throw an exception. - -For example a stream can be created that has a processor that takes in data from a -http source and creates a `GenericMessage` that contains the `TaskLaunchRequest` and sends -the message to its output channel. The task sink would then receive the message from its -input channnel and then launch the task. - -To create a taskSink a user needs to only create a spring boot app that includes the -following annotation `EnableTaskLauncher`. The code would look something like this: - -``` -@SpringBootApplication -@EnableTaskLauncher -public class TaskSinkApplication { - public static void main(String[] args) { - SpringApplication.run(TaskSinkApplication.class, args); - } -} -``` - -A sample Sink and Processor have been made available to you in the samples module -of the Spring Cloud Task project. To install these samples into your local maven -repository execute a maven build from the `spring-cloud-task-samples` directory with the -property `skipInstall` set to false. For example: -`mvn clean install -DskipInstall=false`. - - -==== Spring Cloud Data Flow - -To create a stream in Spring Cloud Data Flow first we would want to register the Task Sink -Application we created. In the example below we are registering the Processor and Sink -sample applications using the Spring Cloud Data Flow shell: - -``` -module register --name taskSink --type sink --coordinates io.spring:tasksink:1.0.0.BUILD-SNAPSHOT -module register --name taskProcessor --type processor --coordinates io.spring:taskprocessor:1.0.0.BUILD-SNAPSHOT -``` - -To create a stream from the Spring Cloud Data Flow shell would look like this: - -``` -stream create foo --definition "http --server.port=9000|taskProcessor|taskSink" --deploy -``` diff --git a/spring-cloud-task-docs/src/main/asciidoc/index.adoc b/spring-cloud-task-docs/src/main/asciidoc/index.adoc index 63bade6d..d4801d26 100644 --- a/spring-cloud-task-docs/src/main/asciidoc/index.adoc +++ b/spring-cloud-task-docs/src/main/asciidoc/index.adoc @@ -43,6 +43,7 @@ include::preface.adoc[] include::getting-started.adoc[] include::features.adoc[] include::batch.adoc[] +include::stream.adoc[] include::appendix.adoc[] // ====================================================================================== diff --git a/spring-cloud-task-docs/src/main/asciidoc/stream.adoc b/spring-cloud-task-docs/src/main/asciidoc/stream.adoc new file mode 100644 index 00000000..9acd0df9 --- /dev/null +++ b/spring-cloud-task-docs/src/main/asciidoc/stream.adoc @@ -0,0 +1,108 @@ +[[stream-integration]] += Spring Cloud Stream Integration + +[[partintro]] +-- +A task by itself can be useful, but it's the integration of a task into a larger ecosystem +that allows it to be useful for more complex processing and orchestration. This section +covers the integration options for Spring Cloud Task and Spring Cloud Stream. +-- + +[[stream-integration-launching-sink]] +== Launching a task from a Spring Cloud Stream + +Allows a user to launch tasks from a stream. This is done by creating a sink that +listens for a message that contains a `TaskLaunchRequest` as its payload. The +TaskLaunchRequest contains the maven coordinates to the Task that is to be executed. It +also has a Map that contains the environment variables that will be used by the Task. + +NOTE: If the payload is of a different type then the sink will throw an exception. + +For example a stream can be created that has a processor that takes in data from a +http source and creates a `GenericMessage` that contains the `TaskLaunchRequest` and sends +the message to its output channel. The task sink would then receive the message from its +input channnel and then launch the task. + +To create a taskSink a user needs to only create a spring boot app that includes the +following annotation `EnableTaskLauncher`. The code would look something like this: + +``` +@SpringBootApplication +@EnableTaskLauncher +public class TaskSinkApplication { + public static void main(String[] args) { + SpringApplication.run(TaskSinkApplication.class, args); + } +} +``` + +A sample Sink and Processor have been made available to you in the samples module +of the Spring Cloud Task project. To install these samples into your local maven +repository execute a maven build from the `spring-cloud-task-samples` directory with the +property `skipInstall` set to false. For example: +`mvn clean install`. + +[[stream-integration-launching-sink-dataflow]] +=== Spring Cloud Data Flow + +To create a stream in Spring Cloud Data Flow first we would want to register the Task Sink +Application we created. In the example below we are registering the Processor and Sink +sample applications using the Spring Cloud Data Flow shell: + +``` +module register --name taskSink --type sink --uri maven://io.spring:tasksink:1.0.0.BUILD-SNAPSHOT +module register --name taskProcessor --type processor --uri maven:io.spring:taskprocessor:1.0.0.BUILD-SNAPSHOT +``` + +Creating a stream from the Spring Cloud Data Flow shell would look like this: + +``` +stream create foo --definition "http --server.port=9000|taskProcessor|taskSink" --deploy +``` + +[[stream-integration-events]] +== Spring Cloud Task Events + +Spring Cloud Task provides the ability to emit events via Spring Cloud Stream channel +when the task is executed via a Spring Cloud Stream channel. A task listener is used to +publish the `TaskExecution` on a message channel named `task-events`. This feature is +autowired into any task that has `spring-cloud-stream` on its classpath in addition to the +`spring-cloud-stream` and a task defined. + +NOTE: To disable the event emitting listener, set the property +`spring.cloud.task.events.enabled` to `false`. + +With the appropriate classpath defined, a simple task like this: + +``` +@SpringBootApplication +@EnableTask +public class TaskEventsApplication { + + public static void main(String[] args) { + SpringApplication.run(TaskEventsApplication.class, args); + } + + @Configuration + public static class TaskConfiguration { + + @Bean + public CommandLineRunner commandLineRunner() { + return new CommandLineRunner() { + @Override + public void run(String... args) throws Exception { + System.out.println("The CommandLineRunner was executed"); + } + }; + } + } +} +``` + +will emit events on the task-events channel. + +NOTE: Configuration of the content type may be required via +`--spring.cloud.stream.bindings.task-events.contentType=` if the processor +or sink downstream does not have the spring-cloud-task-core jar on its classpath. + +NOTE: A binder implementation is also required to be on the classpath. \ No newline at end of file diff --git a/spring-cloud-task-samples/task-events/.mvn/wrapper/maven-wrapper.jar b/spring-cloud-task-samples/task-events/.mvn/wrapper/maven-wrapper.jar new file mode 100644 index 00000000..5fd4d502 Binary files /dev/null and b/spring-cloud-task-samples/task-events/.mvn/wrapper/maven-wrapper.jar differ diff --git a/spring-cloud-task-samples/task-events/.mvn/wrapper/maven-wrapper.properties b/spring-cloud-task-samples/task-events/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 00000000..eb919476 --- /dev/null +++ b/spring-cloud-task-samples/task-events/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1 @@ +distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.3.3/apache-maven-3.3.3-bin.zip \ No newline at end of file diff --git a/spring-cloud-task-samples/task-events/README.adoc b/spring-cloud-task-samples/task-events/README.adoc new file mode 100644 index 00000000..a9d4118f --- /dev/null +++ b/spring-cloud-task-samples/task-events/README.adoc @@ -0,0 +1,33 @@ += Task Events + +This is a task application that emits events on a channel named `task-events` + +== Requirements: + +* Java 7 or Above + +== Build: + +[source,shell,indent=2] +---- +$ ./mvnw clean install +---- + +== Execution: + +[source,shell,indent=2] +---- +$ java -jar target/task-events-1.0.0.BUILD-SNAPSHOT.jar --spring.cloud.stream.bindings.task-events.contentType=application/json +---- + +You can listen for the events on the task-events channel with a Spring Cloud Stream Sink +like the log sink using the following: + +[source,shell,indent=2] +---- +$ java -jar /log-sink-1.0.0.BUILD-SNAPSHOT-exec.jar --server.port=9090 --spring.cloud.stream.bindings.input.destination=task-events +---- + +== Dependencies: + +The task processor requires an instance of Redis to be running. diff --git a/spring-cloud-task-samples/task-events/mvnw b/spring-cloud-task-samples/task-events/mvnw new file mode 100755 index 00000000..a1ba1bf5 --- /dev/null +++ b/spring-cloud-task-samples/task-events/mvnw @@ -0,0 +1,233 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Maven2 Start Up Batch script +# +# Required ENV vars: +# ------------------ +# JAVA_HOME - location of a JDK home dir +# +# Optional ENV vars +# ----------------- +# M2_HOME - location of maven2's installed home dir +# MAVEN_OPTS - parameters passed to the Java VM when running Maven +# e.g. to debug Maven itself, use +# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +# MAVEN_SKIP_RC - flag to disable loading of mavenrc files +# ---------------------------------------------------------------------------- + +if [ -z "$MAVEN_SKIP_RC" ] ; then + + if [ -f /etc/mavenrc ] ; then + . /etc/mavenrc + fi + + if [ -f "$HOME/.mavenrc" ] ; then + . "$HOME/.mavenrc" + fi + +fi + +# OS specific support. $var _must_ be set to either true or false. +cygwin=false; +darwin=false; +mingw=false +case "`uname`" in + CYGWIN*) cygwin=true ;; + MINGW*) mingw=true;; + Darwin*) darwin=true + # + # Look for the Apple JDKs first to preserve the existing behaviour, and then look + # for the new JDKs provided by Oracle. + # + if [ -z "$JAVA_HOME" ] && [ -L /System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK ] ; then + # + # Apple JDKs + # + export JAVA_HOME=/System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK/Home + fi + + if [ -z "$JAVA_HOME" ] && [ -L /System/Library/Java/JavaVirtualMachines/CurrentJDK ] ; then + # + # Apple JDKs + # + export JAVA_HOME=/System/Library/Java/JavaVirtualMachines/CurrentJDK/Contents/Home + fi + + if [ -z "$JAVA_HOME" ] && [ -L "/Library/Java/JavaVirtualMachines/CurrentJDK" ] ; then + # + # Oracle JDKs + # + export JAVA_HOME=/Library/Java/JavaVirtualMachines/CurrentJDK/Contents/Home + fi + + if [ -z "$JAVA_HOME" ] && [ -x "/usr/libexec/java_home" ]; then + # + # Apple JDKs + # + export JAVA_HOME=`/usr/libexec/java_home` + fi + ;; +esac + +if [ -z "$JAVA_HOME" ] ; then + if [ -r /etc/gentoo-release ] ; then + JAVA_HOME=`java-config --jre-home` + fi +fi + +if [ -z "$M2_HOME" ] ; then + ## resolve links - $0 may be a link to maven's home + PRG="$0" + + # need this for relative symlinks + while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG="`dirname "$PRG"`/$link" + fi + done + + saveddir=`pwd` + + M2_HOME=`dirname "$PRG"`/.. + + # make it fully qualified + M2_HOME=`cd "$M2_HOME" && pwd` + + cd "$saveddir" + # echo Using m2 at $M2_HOME +fi + +# For Cygwin, ensure paths are in UNIX format before anything is touched +if $cygwin ; then + [ -n "$M2_HOME" ] && + M2_HOME=`cygpath --unix "$M2_HOME"` + [ -n "$JAVA_HOME" ] && + JAVA_HOME=`cygpath --unix "$JAVA_HOME"` + [ -n "$CLASSPATH" ] && + CLASSPATH=`cygpath --path --unix "$CLASSPATH"` +fi + +# For Migwn, ensure paths are in UNIX format before anything is touched +if $mingw ; then + [ -n "$M2_HOME" ] && + M2_HOME="`(cd "$M2_HOME"; pwd)`" + [ -n "$JAVA_HOME" ] && + JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" + # TODO classpath? +fi + +if [ -z "$JAVA_HOME" ]; then + javaExecutable="`which javac`" + if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then + # readlink(1) is not available as standard on Solaris 10. + readLink=`which readlink` + if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then + if $darwin ; then + javaHome="`dirname \"$javaExecutable\"`" + javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" + else + javaExecutable="`readlink -f \"$javaExecutable\"`" + fi + javaHome="`dirname \"$javaExecutable\"`" + javaHome=`expr "$javaHome" : '\(.*\)/bin'` + JAVA_HOME="$javaHome" + export JAVA_HOME + fi + fi +fi + +if [ -z "$JAVACMD" ] ; then + 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 + else + JAVACMD="`which java`" + fi +fi + +if [ ! -x "$JAVACMD" ] ; then + echo "Error: JAVA_HOME is not defined correctly." >&2 + echo " We cannot execute $JAVACMD" >&2 + exit 1 +fi + +if [ -z "$JAVA_HOME" ] ; then + echo "Warning: JAVA_HOME environment variable is not set." +fi + +CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher + +# For Cygwin, switch paths to Windows format before running java +if $cygwin; then + [ -n "$M2_HOME" ] && + M2_HOME=`cygpath --path --windows "$M2_HOME"` + [ -n "$JAVA_HOME" ] && + JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` + [ -n "$CLASSPATH" ] && + CLASSPATH=`cygpath --path --windows "$CLASSPATH"` +fi + +# traverses directory structure from process work directory to filesystem root +# first directory with .mvn subdirectory is considered project base directory +find_maven_basedir() { + local basedir=$(pwd) + local wdir=$(pwd) + while [ "$wdir" != '/' ] ; do + if [ -d "$wdir"/.mvn ] ; then + basedir=$wdir + break + fi + wdir=$(cd "$wdir/.."; pwd) + done + echo "${basedir}" +} + +# concatenates all lines of a file +concat_lines() { + if [ -f "$1" ]; then + echo "$(tr -s '\n' ' ' < "$1")" + fi +} + +export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-$(find_maven_basedir)} +MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" + +# Provide a "standardized" way to retrieve the CLI args that will +# work with both Windows and non-Windows executions. +MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@" +export MAVEN_CMD_LINE_ARGS + +WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +exec "$JAVACMD" \ + $MAVEN_OPTS \ + -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ + "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ + ${WRAPPER_LAUNCHER} "$@" diff --git a/spring-cloud-task-samples/task-events/mvnw.cmd b/spring-cloud-task-samples/task-events/mvnw.cmd new file mode 100644 index 00000000..2b934e89 --- /dev/null +++ b/spring-cloud-task-samples/task-events/mvnw.cmd @@ -0,0 +1,145 @@ +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Maven2 Start Up Batch script +@REM +@REM Required ENV vars: +@REM JAVA_HOME - location of a JDK home dir +@REM +@REM Optional ENV vars +@REM M2_HOME - location of maven2's installed home dir +@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands +@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a key stroke before ending +@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven +@REM e.g. to debug Maven itself, use +@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files +@REM ---------------------------------------------------------------------------- + +@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' +@echo off +@REM enable echoing my setting MAVEN_BATCH_ECHO to 'on' +@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% + +@REM set %HOME% to equivalent of $HOME +if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") + +@REM Execute a user defined script before this one +if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre +@REM check for pre script, once with legacy .bat ending and once with .cmd ending +if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat" +if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd" +:skipRcPre + +@setlocal + +set ERROR_CODE=0 + +@REM To isolate internal variables from possible post scripts, we use another setlocal +@setlocal + +@REM ==== START VALIDATION ==== +if not "%JAVA_HOME%" == "" goto OkJHome + +echo. +echo Error: JAVA_HOME not found in your environment. >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +:OkJHome +if exist "%JAVA_HOME%\bin\java.exe" goto init + +echo. +echo Error: JAVA_HOME is set to an invalid directory. >&2 +echo JAVA_HOME = "%JAVA_HOME%" >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +@REM ==== END VALIDATION ==== + +:init + +set MAVEN_CMD_LINE_ARGS=%* + +@REM Find the project base dir, i.e. the directory that contains the folder ".mvn". +@REM Fallback to current working directory if not found. + +set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% +IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir + +set EXEC_DIR=%CD% +set WDIR=%EXEC_DIR% +:findBaseDir +IF EXIST "%WDIR%"\.mvn goto baseDirFound +cd .. +IF "%WDIR%"=="%CD%" goto baseDirNotFound +set WDIR=%CD% +goto findBaseDir + +:baseDirFound +set MAVEN_PROJECTBASEDIR=%WDIR% +cd "%EXEC_DIR%" +goto endDetectBaseDir + +:baseDirNotFound +set MAVEN_PROJECTBASEDIR=%EXEC_DIR% +cd "%EXEC_DIR%" + +:endDetectBaseDir + +IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig + +@setlocal EnableExtensions EnableDelayedExpansion +for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a +@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% + +:endReadAdditionalConfig + +SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" + +set WRAPPER_JAR="".\.mvn\wrapper\maven-wrapper.jar"" +set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +%MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CMD_LINE_ARGS% +if ERRORLEVEL 1 goto error +goto end + +:error +set ERROR_CODE=1 + +:end +@endlocal & set ERROR_CODE=%ERROR_CODE% + +if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost +@REM check for post script, once with legacy .bat ending and once with .cmd ending +if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat" +if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd" +:skipRcPost + +@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' +if "%MAVEN_BATCH_PAUSE%" == "on" pause + +if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE% + +exit /B %ERROR_CODE% \ No newline at end of file diff --git a/spring-cloud-task-samples/task-events/pom.xml b/spring-cloud-task-samples/task-events/pom.xml new file mode 100644 index 00000000..ee2adc88 --- /dev/null +++ b/spring-cloud-task-samples/task-events/pom.xml @@ -0,0 +1,72 @@ + + + 4.0.0 + + io.spring.task + task-events + 1.0.0.BUILD-SNAPSHOT + jar + + task-events + Demo of publishing task events to Spring Cloud Streams + + + org.springframework.boot + spring-boot-starter-parent + 1.3.3.RELEASE + + + + + UTF-8 + 1.7 + + + + + org.springframework.boot + spring-boot-starter + + + + org.springframework.cloud + spring-cloud-task-core + 1.0.0.BUILD-SNAPSHOT + + + + org.springframework.cloud + spring-cloud-task-stream + 1.0.0.BUILD-SNAPSHOT + + + + org.springframework.boot + spring-boot-starter-redis + + + + org.springframework.cloud + spring-cloud-stream-binder-redis + 1.0.0.BUILD-SNAPSHOT + + + + org.springframework.boot + spring-boot-starter-test + test + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + + + diff --git a/spring-cloud-task-samples/task-events/src/main/java/io/spring/TaskEventsApplication.java b/spring-cloud-task-samples/task-events/src/main/java/io/spring/TaskEventsApplication.java new file mode 100644 index 00000000..591ebd9a --- /dev/null +++ b/spring-cloud-task-samples/task-events/src/main/java/io/spring/TaskEventsApplication.java @@ -0,0 +1,46 @@ +/* + * Copyright 2016 the original author or 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 + * + * 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. + */ +package io.spring; + +import org.springframework.boot.CommandLineRunner; +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.cloud.task.configuration.EnableTask; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +@SpringBootApplication +@EnableTask +public class TaskEventsApplication { + + public static void main(String[] args) { + SpringApplication.run(TaskEventsApplication.class, args); + } + + @Configuration + public static class EventEmittingTaskConfiguration { + + @Bean + public CommandLineRunner commandLineRunner() { + return new CommandLineRunner() { + @Override + public void run(String... args) throws Exception { + System.out.println("The CommandLineRunner was executed"); + } + }; + } + } +} diff --git a/spring-cloud-task-samples/task-events/src/main/resources/application.properties b/spring-cloud-task-samples/task-events/src/main/resources/application.properties new file mode 100644 index 00000000..62a3ed49 --- /dev/null +++ b/spring-cloud-task-samples/task-events/src/main/resources/application.properties @@ -0,0 +1,3 @@ +spring.application.name=Event Emitting Task +logging.level.org.springframework.cloud.stream=DEBUG +logging.level.org.springframework.cloud.task=DEBUG diff --git a/spring-cloud-task-stream/src/main/java/org/springframework/cloud/task/listener/TaskEventAutoConfiguration.java b/spring-cloud-task-stream/src/main/java/org/springframework/cloud/task/listener/TaskEventAutoConfiguration.java new file mode 100644 index 00000000..36142271 --- /dev/null +++ b/spring-cloud-task-stream/src/main/java/org/springframework/cloud/task/listener/TaskEventAutoConfiguration.java @@ -0,0 +1,66 @@ +/* + * Copyright 2016 the original author or 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 + * + * 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. + */ +package org.springframework.cloud.task.listener; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.cloud.stream.annotation.EnableBinding; +import org.springframework.cloud.stream.annotation.Output; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.PropertySource; +import org.springframework.integration.gateway.GatewayProxyFactoryBean; +import org.springframework.messaging.MessageChannel; + +/** + * + * @author Michael Minella + */ +@Configuration +@ConditionalOnClass(EnableBinding.class) +@ConditionalOnBean(TaskLifecycleListener.class) +@ConditionalOnProperty(prefix = "spring.cloud.task.events", name = "enabled", havingValue = "true", matchIfMissing = true) +@PropertySource("classpath:/org/springframework/cloud/task/application.properties") +public class TaskEventAutoConfiguration { + + @Configuration + @EnableBinding(TaskEventChannels.class) + public static class ListenerConfiguration { + + @Autowired + private TaskEventChannels taskEventChannels; + + @Bean + public GatewayProxyFactoryBean taskEventListener() { + GatewayProxyFactoryBean factoryBean = + new GatewayProxyFactoryBean(TaskExecutionListener.class); + + factoryBean.setDefaultRequestChannel(taskEventChannels.taskEvents()); + + return factoryBean; + } + } + + public interface TaskEventChannels { + + String TASK_EVENTS = "task-events"; + + @Output(TASK_EVENTS) + MessageChannel taskEvents(); + } +} diff --git a/spring-cloud-task-stream/src/main/resources/META-INF/spring.factories b/spring-cloud-task-stream/src/main/resources/META-INF/spring.factories new file mode 100644 index 00000000..58dee30c --- /dev/null +++ b/spring-cloud-task-stream/src/main/resources/META-INF/spring.factories @@ -0,0 +1 @@ +org.springframework.boot.autoconfigure.EnableAutoConfiguration=org.springframework.cloud.task.listener.TaskEventAutoConfiguration diff --git a/spring-cloud-task-stream/src/main/resources/org/springframework/cloud/task/application.properties b/spring-cloud-task-stream/src/main/resources/org/springframework/cloud/task/application.properties new file mode 100644 index 00000000..2add9998 --- /dev/null +++ b/spring-cloud-task-stream/src/main/resources/org/springframework/cloud/task/application.properties @@ -0,0 +1 @@ +spring.cloud.stream.bindings.task-events.contentType=application/json diff --git a/spring-cloud-task-stream/src/test/java/org/springframework/cloud/task/launcher/TaskLauncherSinkTests.java b/spring-cloud-task-stream/src/test/java/org/springframework/cloud/task/launcher/TaskLauncherSinkTests.java index 357111b2..7fcaec58 100644 --- a/spring-cloud-task-stream/src/test/java/org/springframework/cloud/task/launcher/TaskLauncherSinkTests.java +++ b/spring-cloud-task-stream/src/test/java/org/springframework/cloud/task/launcher/TaskLauncherSinkTests.java @@ -16,13 +16,12 @@ package org.springframework.cloud.task.launcher; -import static org.junit.Assert.assertEquals; - import java.util.HashMap; import java.util.Map; import org.junit.Test; import org.junit.runner.RunWith; + import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.SpringApplicationConfiguration; import org.springframework.cloud.deployer.spi.task.LaunchState; @@ -34,6 +33,8 @@ import org.springframework.context.ApplicationContext; import org.springframework.messaging.support.GenericMessage; import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; +import static org.junit.Assert.assertEquals; + @RunWith(SpringJUnit4ClassRunner.class) @SpringApplicationConfiguration(classes = {TaskLauncherSinkApplication.class, TaskConfiguration.class} ) public class TaskLauncherSinkTests { @@ -47,7 +48,6 @@ public class TaskLauncherSinkTests { @Bindings(TaskLauncherSink.class) private Sink sink; - @Test public void testSuccess() { TaskConfiguration.TestTaskLauncher testTaskLauncher = diff --git a/spring-cloud-task-stream/src/test/java/org/springframework/cloud/task/listener/TaskEventTests.java b/spring-cloud-task-stream/src/test/java/org/springframework/cloud/task/listener/TaskEventTests.java new file mode 100644 index 00000000..f09bba20 --- /dev/null +++ b/spring-cloud-task-stream/src/test/java/org/springframework/cloud/task/listener/TaskEventTests.java @@ -0,0 +1,53 @@ +/* + * Copyright 2016 the original author or 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 + * + * 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. + */ +package org.springframework.cloud.task.listener; + +import org.junit.Test; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.PropertyPlaceholderAutoConfiguration; +import org.springframework.cloud.stream.test.binder.TestSupportBinderAutoConfiguration; +import org.springframework.cloud.task.configuration.EnableTask; +import org.springframework.context.ConfigurableApplicationContext; +import org.springframework.context.annotation.Configuration; + +import static org.junit.Assert.assertNotNull; + +/** + * @author Michael Minella + */ +public class TaskEventTests { + + @Test + public void testDefaultConfiguration() { + ConfigurableApplicationContext applicationContext = + SpringApplication.run(new Object[] {TaskEventsConfiguration.class, + TaskEventAutoConfiguration.class, + PropertyPlaceholderAutoConfiguration.class, + TestSupportBinderAutoConfiguration.class}, + new String[] {"--spring.cloud.task.closecontext.enable=false", + "--spring.main.web-environment=false", + "--spring.cloud.stream.defaultBinder=test"}); + + assertNotNull(applicationContext.getBean("taskEventListener")); + assertNotNull(applicationContext.getBean(TaskEventAutoConfiguration.TaskEventChannels.class)); + } + + @Configuration + @EnableTask + public static class TaskEventsConfiguration { + } +}