diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6c01878 --- /dev/null +++ b/.gitignore @@ -0,0 +1,32 @@ +HELP.md +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/** +!**/src/test/** + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr +out/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ diff --git a/README.md b/README.md index 6a22027..d4228a1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,19 @@ -# status-endpoint -A an endpoint for testing polling +## Simulated Job Status Endpoint +A endpoint for testing polling + +Instructions +1. Start the Spring Application +2. In a browser, go to `http://localhost:8080/job/1` +3. The current status of job #1 is dipslayed in the browser, e.g. **INPROGRESS** +4. Refresh the browser several times until the status changes. Some jobs are stuck in the INPROGRESS and never complete. This is part of the simulation. + +* The endpoint's path is `/job/{id}`, where `id` can be any string. If the string is unrecognized, a new job is created. If `id` is recognized, its current status is returned. + +The lifecycle of a job is: +``` + +----> COMPLETED + NOT STARTED +--> IN PROGRESS -| + +----> FAILED +``` + +The lifecycle of a `Job` is determined randomly by the `JobFactory` when the `Job` is created. \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..e6aa99f --- /dev/null +++ b/build.gradle @@ -0,0 +1,53 @@ +buildscript { + ext { + junitJupiterVersion = "5.5.2" + lombokVersion = "1.18.10" + springBootVersion = "2.1.9.RELEASE" + springfoxSwaggerVersion = "2.9.2" + } +} + +plugins { + id "com.diffplug.gradle.spotless" version "3.25.0" + id "java" + id "org.springframework.boot" version "${springBootVersion}" +} +spotless { + java { + removeUnusedImports() + } +} + +group = "com.connexta" + +repositories { + mavenLocal() + mavenCentral() + jcenter() +} + +dependencies { + annotationProcessor "org.projectlombok:lombok:${lombokVersion}" + compile 'javax.inject:javax.inject:1' + compileOnly "org.projectlombok:lombok:${lombokVersion}" + implementation 'com.dyngr:polling:1.1.3' + implementation "org.springframework.boot:spring-boot-starter-web:${springBootVersion}" + testCompile "org.junit.jupiter:junit-jupiter-params:${junitJupiterVersion}" + testCompile "org.mockito:mockito-junit-jupiter:3.1.0" + testImplementation "org.junit.jupiter:junit-jupiter-api:${junitJupiterVersion}" + testImplementation("org.springframework.boot:spring-boot-starter-test:${springBootVersion}") { + exclude group: "junit", module: "junit" // excludes JUnit 4 + } + testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:${junitJupiterVersion}" +} + +sourceCompatibility = 1.11 +targetCompatibility = 1.11 + +bootJar { + launchScript() +} + +task listDependencies(type: DependencyReportTask) + +bootRun.dependsOn(build) diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..5c2d1cf 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..dde9e6b --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Sat Oct 26 15:06:33 MST 2019 +distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.2-all.zip +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStorePath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..83f2acf --- /dev/null +++ b/gradlew @@ -0,0 +1,188 @@ +#!/usr/bin/env sh + +# +# Copyright 2015 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 +# +# 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 UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +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 +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# 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"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# 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 + ;; + 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" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=$(save "$@") + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong +if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then + cd "$(dirname "$0")" +fi + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..9618d8d --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,100 @@ +@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=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@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%" == "0" goto init + +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 init + +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 + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +: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 %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="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! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..65a2a3f --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'status-endpoint' diff --git a/src/main/java/status/Job.java b/src/main/java/status/Job.java new file mode 100644 index 0000000..c4325bc --- /dev/null +++ b/src/main/java/status/Job.java @@ -0,0 +1,24 @@ +package status; + +import java.util.Random; + +public class Job { + + final String id; + final JobStateMachine stateMachine; + static final Random random = new Random(2); + + public Job(String id, JobStateMachine stateMachine) { + this.id = id; + this.stateMachine = stateMachine; + } + + public JobStatus getCurrentStatus() { + return stateMachine.tryAdvanceAndGet(random.nextDouble()); + } + + // Use this to clean up the list of jobs and generate some metrics + public boolean isFinal() { + return stateMachine.isFinal(); + } +} diff --git a/src/main/java/status/JobFactory.java b/src/main/java/status/JobFactory.java new file mode 100644 index 0000000..38cfc32 --- /dev/null +++ b/src/main/java/status/JobFactory.java @@ -0,0 +1,47 @@ +package status; + +import static status.JobStatus.COMPLETED; +import static status.JobStatus.FAILED; +import static status.JobStatus.INPROGRESS; +import static status.JobStatus.NOTSTARTED; + +import java.util.ArrayList; +import java.util.List; +import java.util.Random; + +public class JobFactory { + + Random random; + double probabilityFirstStateNotStated = 0.20; + double probabilityOfFailure = 0.15; + double probabilityOfSuccess = 0.85; + + JobFactory() { + random = new Random(1); + } + + Job next(String id) { + return new Job(id, (new JobStateMachine(createLifecycle()))); + } + + // Everything starts as INPROGRESS and finishes as COMPLETED or FAILED + // TODO Enhance class to be able to hang and just keep HTTP connection open. + // TODO Enhance class to model "not-yet-started". + // new ResponseStatusException(HttpStatus.NOT_FOUND, "Unable to find resource"); + JobStatus[] createLifecycle() { + List lifecycle = new ArrayList<>(); + if (random.nextDouble() < probabilityFirstStateNotStated) { + lifecycle.add(NOTSTARTED); + } + lifecycle.add(INPROGRESS); + double p = random.nextDouble(); + if (p < probabilityOfFailure) { + lifecycle.add(FAILED); + } else if (p < probabilityOfSuccess) { + lifecycle.add(COMPLETED); + } + // If not failure or complete, job stays stuck in progress. + + return lifecycle.toArray(new JobStatus[0]); + } +} diff --git a/src/main/java/status/JobStateMachine.java b/src/main/java/status/JobStateMachine.java new file mode 100644 index 0000000..abef4d1 --- /dev/null +++ b/src/main/java/status/JobStateMachine.java @@ -0,0 +1,33 @@ +package status; + +public class JobStateMachine { + + static double probabilityOfStateChange = 0.20; + + final JobStatus[] lifecycle; + int index; + + public JobStateMachine(JobStatus[] lifecycle) { + this.lifecycle = lifecycle; + } + + JobStatus getStatus() { + return lifecycle[index]; + } + + JobStatus tryAdvanceAndGet(double p) { + advance(p); + return getStatus(); + } + + private void advance(double p) { + if (!isFinal() && p < probabilityOfStateChange) { + index++; + } + } + + boolean isFinal() { + int maxIndex = lifecycle.length - 1; + return index >= maxIndex; + } +} diff --git a/src/main/java/status/JobStatus.java b/src/main/java/status/JobStatus.java new file mode 100644 index 0000000..a748ba0 --- /dev/null +++ b/src/main/java/status/JobStatus.java @@ -0,0 +1,8 @@ +package status; + +public enum JobStatus { + NOTSTARTED, + INPROGRESS, + FAILED, + COMPLETED +} diff --git a/src/main/java/status/StatusController.java b/src/main/java/status/StatusController.java new file mode 100644 index 0000000..960ab4c --- /dev/null +++ b/src/main/java/status/StatusController.java @@ -0,0 +1,27 @@ +package status; + +import static org.springframework.http.HttpStatus.NOT_FOUND; + +import java.util.HashMap; +import java.util.Map; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.RestController; +import org.springframework.web.server.ResponseStatusException; + +@RestController +public class StatusController { + + final Map jobs = new HashMap<>(); + JobFactory jobFactory = new JobFactory(); + + @GetMapping(value = "/job/{jobId}") + // Synchronize to avoid concurrent modification exception + public synchronized String status(@PathVariable String jobId) { + JobStatus status = jobs.computeIfAbsent(jobId, jobFactory::next).getCurrentStatus(); + if(status.equals(JobStatus.NOTSTARTED)) { + throw new ResponseStatusException(NOT_FOUND, "Unable to find resource"); + } + return status.toString(); + } +} diff --git a/src/main/java/status/StatusEndpointApplication.java b/src/main/java/status/StatusEndpointApplication.java new file mode 100644 index 0000000..2e9e65e --- /dev/null +++ b/src/main/java/status/StatusEndpointApplication.java @@ -0,0 +1,14 @@ +package status; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class StatusEndpointApplication { + + + public static void main(String[] args) { + SpringApplication.run(StatusEndpointApplication.class, args); + } + +} diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties new file mode 100644 index 0000000..d14af3b --- /dev/null +++ b/src/main/resources/application.properties @@ -0,0 +1 @@ +#logging.level.web=DEBUG