diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..549076d --- /dev/null +++ b/.gitignore @@ -0,0 +1,24 @@ +# Eclipse +.classpath +.project +.settings/ + +# Intellij +.idea/ +*.iml +*.iws + +# Mac +.DS_Store + +# Maven +log/ +target/ +.gradle/ +build/ +out/ + +# Integration tests +build.log + +/bin/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..7a22957 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# Rundeck File Lookup Plugins + +This plugin provides utilities to read data from the filesystem into Rundeck step data. + +## Features + +### Scan File Step Plugin + +Scans a file for a regular expression pattern. If the specified pattern has one +replaceable field, the scan stops on first match for performance reasons. If the +pattern has two capture fields, the scan will go to the end of the file and the +last value for matches will be returned. + +### JSON Lookup Step Plugin + +Finds the first matching key in a JSON file. diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..ebaf493 --- /dev/null +++ b/build.gradle @@ -0,0 +1,97 @@ +plugins { + id 'pl.allegro.tech.build.axion-release' version '1.10.1' + id 'java' +} + +apply plugin: 'java' +apply plugin: 'eclipse' +apply plugin: 'idea' + +sourceCompatibility = 1.8 +defaultTasks 'clean','build' +ext.rundeckPluginVersion = '1.2' +ext.pluginClassNames='com.bioraft.rundeck.filelookup.JsonFindKeyStepPlugin,' + +'com.bioraft.rundeck.filelookup.ScanFileStepPlugin,' + +'com.bioraft.rundeck.filelookup.JsonFindKeyNodeStepPlugin,' + +'com.bioraft.rundeck.filelookup.ScanFileNodeStepPlugin' +ext.pluginName = 'RunDeck File Lookup Plugin' +ext.pluginDescription = 'Find step values within files' + +scmVersion { + ignoreUncommittedChanges = true + tag { + prefix = '' + versionSeparator = '' + def origDeserialize=deserialize + //apend .0 to satisfy semver if the tag version is only X.Y + deserialize = { config, position, tagName -> + def orig = origDeserialize(config, position, tagName) + if (orig.split('\\.').length < 3) { + orig += ".0" + } + orig + } + } +} +project.version = scmVersion.version + +repositories { + mavenLocal() + mavenCentral() +} + +configurations{ + //declare custom pluginLibs configuration to include only libs for this plugin + pluginLibs + + //declare compile to extend from pluginLibs so it inherits the dependencies + compile{ + extendsFrom pluginLibs + } +} + +dependencies { + implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.10.1' + + implementation 'org.rundeck:rundeck-core:3.0.+' + + testImplementation group: 'junit', name: 'junit', version:'4.12' + + testImplementation ( + 'org.mockito:mockito-all:1.9.5', + 'org.powermock:powermock-module-junit4:1.5', + 'org.powermock:powermock-api-mockito:1.5' + ) +} + +// task to copy plugin libs to output/lib dir +task copyToLib(type: Copy) { + into "$buildDir/output/lib" + from configurations.pluginLibs +} + +jar { + from "$buildDir/output" + manifest { + def libList = configurations.pluginLibs.collect{'lib/'+it.name}.join(' ') + + attributes 'Rundeck-Plugin-Classnames': pluginClassNames + attributes 'Rundeck-Plugin-File-Version': archiveVersion + attributes 'Rundeck-Plugin-Name': pluginName + attributes 'Rundeck-Plugin-Description': pluginDescription + attributes 'Rundeck-Plugin-Rundeck-Compatibility-Version': '3.x' + attributes 'Rundeck-Plugin-Tags': 'java,WorkflowNodeStep' + attributes 'Rundeck-Plugin-License': 'Apache 2.0' + attributes 'Rundeck-Plugin-Source-Link': 'https://github.com/' + attributes 'Rundeck-Plugin-Target-Host-Compatibility': 'all' + attributes 'Rundeck-Plugin-Version': rundeckPluginVersion + attributes 'Rundeck-Plugin-Archive': 'true' + attributes 'Rundeck-Plugin-Libs': "${libList}" + + } + dependsOn(copyToLib) +} + +wrapper { + gradleVersion = '6.0.1' +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..cc4fdc2 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..9492014 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-6.0.1-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..2fe81a7 --- /dev/null +++ b/gradlew @@ -0,0 +1,183 @@ +#!/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=`expr $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" + +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..82d1f17 --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'rundeck-file-lookup-plugins' diff --git a/src/main/java/com/bioraft/rundeck/filelookup/FileLookupFailureReason.java b/src/main/java/com/bioraft/rundeck/filelookup/FileLookupFailureReason.java new file mode 100644 index 0000000..2866f9e --- /dev/null +++ b/src/main/java/com/bioraft/rundeck/filelookup/FileLookupFailureReason.java @@ -0,0 +1,27 @@ +/* + * Copyright 2019 BioRAFT, Inc. (http://bioraft.com) + * + * 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 com.bioraft.rundeck.filelookup; + +import com.dtolabs.rundeck.core.execution.workflow.steps.FailureReason; + +/** + * @author Karl DeBisschop + * @since 2019-12-23 + */ +public enum FileLookupFailureReason implements FailureReason { + FileNotFound, + FileNotReadable +} diff --git a/src/main/java/com/bioraft/rundeck/filelookup/JsonFindValueNodeStepPlugin.java b/src/main/java/com/bioraft/rundeck/filelookup/JsonFindValueNodeStepPlugin.java new file mode 100644 index 0000000..19cf9a6 --- /dev/null +++ b/src/main/java/com/bioraft/rundeck/filelookup/JsonFindValueNodeStepPlugin.java @@ -0,0 +1,116 @@ +/* + * Copyright 2019 BioRAFT, Inc. (http://bioraft.com) + * + * 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 com.bioraft.rundeck.filelookup; + +import java.io.FileNotFoundException; +import java.io.FileReader; +import java.io.IOException; +import java.util.List; +import java.util.Map; + +import com.dtolabs.rundeck.core.common.INodeEntry; +import com.dtolabs.rundeck.core.execution.workflow.SharedOutputContext; +import com.dtolabs.rundeck.core.execution.workflow.steps.node.NodeStepException; +import com.dtolabs.rundeck.core.plugins.Plugin; +import com.dtolabs.rundeck.plugins.ServiceNameConstants; +import com.dtolabs.rundeck.plugins.descriptions.PluginDescription; +import com.dtolabs.rundeck.plugins.descriptions.PluginProperty; +import com.dtolabs.rundeck.plugins.step.NodeStepPlugin; +import com.dtolabs.rundeck.plugins.step.PluginStepContext; +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; + +/** + * Node Step Plug-in to find value of first matching field name in JSON file. + * + * Scans the specified file for the indicated field name and returns the value + * of the first matching value node. Search through non-value nodes is performed + * in a depth-first manner, so the match found is the first value match seen + * when when scanning down the file and earlier matches will mask matches that + * are less deep in the tree but later in the file. Breadth-first search could + * be implemented as an option but is not done here. + * + * @author Karl DeBisschop + * @since 2019-12-11 + */ +@Plugin(name = JsonFindValueNodeStepPlugin.SERVICE_PROVIDER_NAME, service = ServiceNameConstants.WorkflowNodeStep) +@PluginDescription(title = "JSON Lookup Plugin", description = "Scans a JSON file for the indicated field and returns the first atomic value.") +public class JsonFindValueNodeStepPlugin implements NodeStepPlugin { + public static final String SERVICE_PROVIDER_NAME = "JsonFileLookupNodeStepPlugin"; + + @PluginProperty(title = "Path", description = "Path to the JSON file", required = true) + private String path; + + @PluginProperty(title = "Group", description = "Variable group (i.e., ${group.x}", required = true) + private String group; + + @PluginProperty(title = "Name", description = "Variable name (i.e., ${group.name}", required = true) + private String name; + + @PluginProperty(title = "Field Name", description = "Field name to lookup in JSON", required = true) + private String fieldName; + + @Override + public void executeNodeStep(final PluginStepContext context, final Map configuration, + final INodeEntry node) throws NodeStepException { + String path = configuration.getOrDefault("path", this.path).toString(); + String group = configuration.getOrDefault("group", this.group).toString(); + String name = configuration.getOrDefault("name", this.name).toString(); + String fieldName = configuration.getOrDefault("fieldName", this.fieldName).toString(); + + try { + FileReader reader = new FileReader(path); + ObjectMapper objectMapper = new ObjectMapper(); + JsonNode rootNode = objectMapper.readTree(reader); + String value = this.searchTree(rootNode, fieldName); + if (value != null) { + SharedOutputContext sharedOutputContext = context.getOutputContext(); + sharedOutputContext.addOutput(group, name, value); + } + } catch (FileNotFoundException e) { + String msg = "Could not find file " + path; + String nodeName = node.getNodename(); + throw new NodeStepException(msg, e, FileLookupFailureReason.FileNotFound, nodeName); + } catch (IOException e) { + String msg = "Could not read file " + path; + String nodeName = node.getNodename(); + throw new NodeStepException(msg, e, FileLookupFailureReason.FileNotReadable, nodeName); + } + return; + } + + /** + * Performs the tree search in a recursive depth-first manner. + * + * @param node The node tree to search. + * @return The textual form of the first matched field, or null if not matched. + */ + private String searchTree(JsonNode node, String fieldName) { + List values = node.findValues(fieldName); + for (JsonNode value : values) { + if (value.isValueNode()) { + return value.asText(); + } else { + String subTreeSearch = this.searchTree(value, fieldName); + if (subTreeSearch != null) { + return subTreeSearch; + } + } + } + return null; + } +} diff --git a/src/main/java/com/bioraft/rundeck/filelookup/JsonFindValueStepPlugin.java b/src/main/java/com/bioraft/rundeck/filelookup/JsonFindValueStepPlugin.java new file mode 100644 index 0000000..bb8eb46 --- /dev/null +++ b/src/main/java/com/bioraft/rundeck/filelookup/JsonFindValueStepPlugin.java @@ -0,0 +1,112 @@ +/* + * Copyright 2019 BioRAFT, Inc. (http://bioraft.com) + * + * 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 com.bioraft.rundeck.filelookup; + +import java.io.FileNotFoundException; +import java.io.FileReader; +import java.io.IOException; +import java.util.List; +import java.util.Map; + +import com.dtolabs.rundeck.core.execution.workflow.SharedOutputContext; +import com.dtolabs.rundeck.core.execution.workflow.steps.StepException; +import com.dtolabs.rundeck.core.plugins.Plugin; +import com.dtolabs.rundeck.plugins.ServiceNameConstants; +import com.dtolabs.rundeck.plugins.descriptions.PluginDescription; +import com.dtolabs.rundeck.plugins.descriptions.PluginProperty; +import com.dtolabs.rundeck.plugins.step.PluginStepContext; +import com.dtolabs.rundeck.plugins.step.StepPlugin; +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; + +/** + * Workflow Step Plug-in to find value of first matching field name in JSON file. + * + * Scans the specified file for the indicated field name and returns the value + * of the first matching value node. Search through non-value nodes is performed + * in a depth-first manner, so the match found is the first value match seen when + * when scanning down the file and earlier matches will mask matches that are + * less deep in the tree but later in the file. Breadth-first search could be + * implemented as an option but is not done here. + * + * @author Karl DeBisschop + * @since 2019-12-11 + */ +@Plugin(name = JsonFindValueStepPlugin.SERVICE_PROVIDER_NAME, service = ServiceNameConstants.WorkflowStep) +@PluginDescription(title = "JSON Lookup Plugin", description = "Scans a JSON file for the indicated field and returns the first atomic value.") +public class JsonFindValueStepPlugin implements StepPlugin { + public static final String SERVICE_PROVIDER_NAME = "com.bioraft.rundeck.jsonlookup.JsonLookupStepPlugin"; + + @PluginProperty(title = "Path", description = "Path to the JSON file", required = true) + private String path; + + @PluginProperty(title = "Group", description = "Variable group (i.e., ${group.x}", required = true) + private String group; + + @PluginProperty(title = "Name", description = "Variable name (i.e., ${group.name}", required = true) + private String name; + + @PluginProperty(title = "Field Name", description = "Field name to lookup in JSON", required = true) + private String fieldName; + + @Override + public void executeStep(PluginStepContext context, Map configuration) throws StepException { + String path = configuration.getOrDefault("path", this.path).toString(); + String group = configuration.getOrDefault("group", this.group).toString(); + String name = configuration.getOrDefault("name", this.name).toString(); + String fieldName = configuration.getOrDefault("fieldName", this.fieldName).toString(); + + try { + FileReader reader = new FileReader(path); + ObjectMapper objectMapper = new ObjectMapper(); + JsonNode rootNode = objectMapper.readTree(reader); + String value = this.searchTree(rootNode, fieldName); + if (value != null) { + SharedOutputContext sharedOutputContext = context.getOutputContext(); + sharedOutputContext.addOutput(group, name, value); + } + } catch (FileNotFoundException e) { + String msg = "Could not find file " + path; + throw new StepException(msg, e, FileLookupFailureReason.FileNotFound); + } catch (IOException e) { + String msg = "Could not read file " + path; + throw new StepException(msg, e, FileLookupFailureReason.FileNotReadable); + } + return; + } + + /** + * Performs the tree search in a recursive depth-first manner. + * + * @param node The node tree to search. + * @return The textual form of the first matched field, or null if not matched. + */ + private String searchTree(JsonNode node, String fieldName) { + List values = node.findValues(fieldName); + for (JsonNode value : values) { + if (value.isValueNode()) { + return value.asText(); + } else { + String subTreeSearch = this.searchTree(value, fieldName); + if (subTreeSearch != null) { + return subTreeSearch; + } + } + } + return null; + } +} diff --git a/src/main/java/com/bioraft/rundeck/filelookup/ScanFileNodeStepPlugin.java b/src/main/java/com/bioraft/rundeck/filelookup/ScanFileNodeStepPlugin.java new file mode 100644 index 0000000..b4b083d --- /dev/null +++ b/src/main/java/com/bioraft/rundeck/filelookup/ScanFileNodeStepPlugin.java @@ -0,0 +1,123 @@ +/* + * Copyright 2019 BioRAFT, Inc. (http://bioraft.com) + * + * 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 com.bioraft.rundeck.filelookup; + +import java.io.BufferedReader; +import java.io.FileNotFoundException; +import java.io.FileReader; +import java.io.IOException; +import java.util.HashMap; +import java.util.Map; +import java.util.regex.MatchResult; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +import com.dtolabs.rundeck.core.common.INodeEntry; +import com.dtolabs.rundeck.core.execution.workflow.SharedOutputContext; +import com.dtolabs.rundeck.core.execution.workflow.steps.node.NodeStepException; +import com.dtolabs.rundeck.core.plugins.Plugin; +import com.dtolabs.rundeck.plugins.ServiceNameConstants; +import com.dtolabs.rundeck.plugins.descriptions.PluginDescription; +import com.dtolabs.rundeck.plugins.descriptions.PluginProperty; +import com.dtolabs.rundeck.plugins.step.NodeStepPlugin; +import com.dtolabs.rundeck.plugins.step.PluginStepContext; + +/** + * Workflow Step Plug-in to find value of first matching text file. + * + * Scans the specified file for the indicated pattern and returns the indicated + * capture fields. Can be used for unstructured text as well as structured text + * files like YAML and properties files. + * + * When one capture field is given, the desired variable name is required as an + * option. When two capture fields are given, the variable name will taken from + * the first capture field and the value from the second. + * + * In cases where there are multiple matches found, the first is returned. + * + * @author Karl DeBisschop + * @since 2019-12-11 + */ +@Plugin(name = ScanFileNodeStepPlugin.SERVICE_PROVIDER_NAME, service = ServiceNameConstants.WorkflowNodeStep) +@PluginDescription(title = "Scan a file to capture values", description = "Use a regular expression to look for key/value pairs in a text file.") +public class ScanFileNodeStepPlugin implements NodeStepPlugin { + public static final String SERVICE_PROVIDER_NAME = "com.bioraft.rundeck.filelookup.ScanFileStepPlugin"; + + @PluginProperty(title = "Path", description = "Path to the file to scan", required = true) + private String path; + + @PluginProperty(title = "Group", description = "Variable group (i.e., ${group.x}}", required = true, defaultValue = "data") + private String group; + + @PluginProperty(title = "Name", description = "Variable name (i.e., ${group.name}) [ignored when Pattern has 2 capture fields]", required = false) + private String name; + + @PluginProperty(title = "Pattern", description = "Regular expression to find, with one or two capture fields", required = true) + private String regex; + + @Override + public void executeNodeStep(PluginStepContext context, Map configuration, INodeEntry node) + throws NodeStepException { + String path = configuration.getOrDefault("path", this.path).toString(); + String group = configuration.getOrDefault("group", this.group).toString(); + String name = configuration.getOrDefault("name", this.name).toString(); + String regex = configuration.getOrDefault("regex", this.regex).toString(); + + SharedOutputContext sharedOutputContext = context.getOutputContext(); + Pattern pattern = Pattern.compile(regex); + MatchResult match; + Matcher matcher; + String line; + + if (name == null || name == "") { + name = "data"; + } + + Map map = new HashMap<>(); + try (BufferedReader reader = new BufferedReader(new FileReader(path))) { + // Scan lines for a match. + // Optimize by returning immediately when there is only one capture field. + while ((line = reader.readLine()) != null) { + matcher = pattern.matcher(line); + if (matcher.find()) { + match = matcher.toMatchResult(); + if (match.groupCount() == 1) { + sharedOutputContext.addOutput(group, name, match.group(1)); + return; + } else if (match.groupCount() == 2) { + // Take first value and do not overwrite, even though scanning proceeds + // through the rest of the file to find other matches to the pattern. + if (map.get(match.group(1)) == null) { + map.put(match.group(1), match.group(2)); + } + } + } + } + } catch (FileNotFoundException e) { + String msg = "Could not find file " + path; + String nodeName = node.getNodename(); + throw new NodeStepException(msg, e, FileLookupFailureReason.FileNotFound, nodeName); + } catch (IOException e) { + String msg = "Could not read file " + path; + String nodeName = node.getNodename(); + throw new NodeStepException(msg, e, FileLookupFailureReason.FileNotReadable, nodeName); + } + + for (Map.Entry element : map.entrySet()) { + sharedOutputContext.addOutput(group, element.getKey(), element.getValue()); + } + } +} diff --git a/src/main/java/com/bioraft/rundeck/filelookup/ScanFileStepPlugin.java b/src/main/java/com/bioraft/rundeck/filelookup/ScanFileStepPlugin.java new file mode 100644 index 0000000..16193f8 --- /dev/null +++ b/src/main/java/com/bioraft/rundeck/filelookup/ScanFileStepPlugin.java @@ -0,0 +1,116 @@ +/* + * Copyright 2019 BioRAFT, Inc. (http://bioraft.com) + * + * 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 com.bioraft.rundeck.filelookup; + +import java.util.HashMap; +import java.util.Map; +import java.util.regex.MatchResult; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import java.io.BufferedReader; +import java.io.FileNotFoundException; +import java.io.FileReader; +import java.io.IOException; + +import com.dtolabs.rundeck.core.execution.workflow.SharedOutputContext; +import com.dtolabs.rundeck.core.execution.workflow.steps.StepException; +import com.dtolabs.rundeck.core.plugins.Plugin; +import com.dtolabs.rundeck.plugins.ServiceNameConstants; +import com.dtolabs.rundeck.plugins.descriptions.PluginDescription; +import com.dtolabs.rundeck.plugins.descriptions.PluginProperty; +import com.dtolabs.rundeck.plugins.step.PluginStepContext; +import com.dtolabs.rundeck.plugins.step.StepPlugin; + +/** + * Workflow Step Plug-in to find value of first matching text file. + * + * Scans the specified file for the indicated pattern and returns the indicated + * capture fields. Can be used for unstructured text as well as structured text + * files like YAML and properties files. + * + * When one capture field is given, the desired variable name is required as an + * option. When two capture fields are given, the variable name will taken from + * the first capture field and the value from the second. + * + * In cases where there are multiple matches found, the first is returned. + * + * @author Karl DeBisschop + * @since 2019-12-11 + */ +@Plugin(name = ScanFileStepPlugin.SERVICE_PROVIDER_NAME, service = ServiceNameConstants.WorkflowStep) +@PluginDescription(title = "Scan a file to capture values", description = "Use a regular expression to look for key/value pairs in a text file.") +public class ScanFileStepPlugin implements StepPlugin { + public static final String SERVICE_PROVIDER_NAME = "com.bioraft.rundeck.filelookup.ScanFileStepPlugin"; + + @PluginProperty(title = "Path", description = "Path to the file to scan", required = true) + private String path; + + @PluginProperty(title = "Group", description = "Variable group (i.e., ${group.x}}", required = true, defaultValue = "data") + private String group; + + @PluginProperty(title = "Name", description = "Variable name (i.e., ${group.name}) [ignored when Pattern has 2 capture fields]", required = false) + private String name; + + @PluginProperty(title = "Pattern", description = "Regular expression to find, with one or two capture fields", required = true) + private String regex; + + @Override + public void executeStep(PluginStepContext context, Map configuration) throws StepException { + String path = configuration.getOrDefault("path", this.path).toString(); + String group = configuration.getOrDefault("group", this.group).toString(); + String name = configuration.getOrDefault("name", this.name).toString(); + String regex = configuration.getOrDefault("regex", this.regex).toString(); + + SharedOutputContext sharedOutputContext = context.getOutputContext(); + Pattern pattern = Pattern.compile(regex); + MatchResult match; + Matcher matcher; + String line; + + if (name == null || name == "") { + name = "data"; + } + + Map map = new HashMap<>(); + try (BufferedReader reader = new BufferedReader(new FileReader(path))) { + // Scan lines for a match. + // Optimize by returning immediately when there is only one capture field. + while ((line = reader.readLine()) != null) { + matcher = pattern.matcher(line); + if (matcher.find()) { + match = matcher.toMatchResult(); + if (match.groupCount() == 1) { + sharedOutputContext.addOutput(group, name, match.group(1)); + return; + } else if (match.groupCount() == 2) { + if (map.get(match.group(1)) == null) { + map.put(match.group(1), match.group(2)); + } + } + } + } + } catch (FileNotFoundException e) { + String msg = "Could not find file " + path; + throw new StepException(msg, e, FileLookupFailureReason.FileNotFound); + } catch (IOException e) { + String msg = "Could not read file " + path; + throw new StepException(msg, e, FileLookupFailureReason.FileNotReadable); + } + for (Map.Entry element : map.entrySet()) { + sharedOutputContext.addOutput(group, element.getKey(), element.getValue()); + } + } +} diff --git a/src/test/java/com/bioraft/rundeck/filelookup/JsonFindValueNodeStepPluginTest.java b/src/test/java/com/bioraft/rundeck/filelookup/JsonFindValueNodeStepPluginTest.java new file mode 100644 index 0000000..18e1dc7 --- /dev/null +++ b/src/test/java/com/bioraft/rundeck/filelookup/JsonFindValueNodeStepPluginTest.java @@ -0,0 +1,207 @@ +/* + * Copyright 2019 BioRAFT, Inc. (http://bioraft.com) + * + * 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 com.bioraft.rundeck.filelookup; + +import static org.junit.Assert.assertEquals; +import static org.mockito.Matchers.anyString; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import java.util.List; +import java.util.Map; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +import org.junit.Before; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.mockito.ArgumentCaptor; +import org.mockito.Captor; +import org.mockito.Mock; +import org.mockito.runners.MockitoJUnitRunner; + +import com.dtolabs.rundeck.core.common.INodeEntry; +import com.dtolabs.rundeck.core.data.DataContext; +import com.dtolabs.rundeck.core.execution.workflow.SharedOutputContext; +import com.dtolabs.rundeck.core.execution.workflow.steps.StepException; +import com.dtolabs.rundeck.plugins.step.PluginStepContext; + +/** + * Tests for JsonFindValueStepPlugin. + * + * @author Karl DeBisschop + * @since 2019-12-11 + */ +@RunWith(MockitoJUnitRunner.class) +public class JsonFindValueNodeStepPluginTest { + + JsonFindValueNodeStepPlugin plugin; + + @Mock + PluginStepContext context; + + @Mock + INodeEntry entry; + + @Mock + SharedOutputContext sharedOutputContext; + + @Mock + DataContext dataContext; + + @Captor + ArgumentCaptor groupCaptor; + + @Captor + ArgumentCaptor nameCaptor; + + @Captor + ArgumentCaptor valueCaptor; + + Map configuration; + + @Before + public void setUp() { + this.plugin = new JsonFindValueNodeStepPlugin(); + configuration = Stream.of(new String[][] { { "path", "testData/test.json" }, { "group", "raft" }, + { "name", "key" }, { "fieldName", "single" }, }) + .collect(Collectors.toMap(data -> data[0], data -> data[1])); + } + + @Test(expected = StepException.class) + public void noFileThrowsException() throws StepException { + configuration.put("path", "nosuchfile"); + when(context.getOutputContext()).thenReturn(sharedOutputContext); + this.plugin.executeNodeStep(context, configuration, entry); + } + + @Test + public void returnsValueForSimpleMatch() throws StepException { + when(context.getOutputContext()).thenReturn(sharedOutputContext); + this.plugin.executeNodeStep(context, configuration, entry); + verify(context).getOutputContext(); + verify(sharedOutputContext).addOutput(groupCaptor.capture(), nameCaptor.capture(), valueCaptor.capture()); + + List groups = groupCaptor.getAllValues(); + List names = nameCaptor.getAllValues(); + List values = valueCaptor.getAllValues(); + + int i = 0; + assertEquals("raft", groups.get(i)); + assertEquals("key", names.get(i)); + assertEquals("v1", values.get(i++)); + } + + @Test + public void returnsValueForMatchInTree() throws StepException { + configuration.put("fieldName", "address"); + when(context.getOutputContext()).thenReturn(sharedOutputContext); + this.plugin.executeNodeStep(context, configuration, entry); + verify(context).getOutputContext(); + verify(sharedOutputContext).addOutput(groupCaptor.capture(), nameCaptor.capture(), valueCaptor.capture()); + + List groups = groupCaptor.getAllValues(); + List names = nameCaptor.getAllValues(); + List values = valueCaptor.getAllValues(); + + int i = 0; + assertEquals("raft", groups.get(i)); + assertEquals("key", names.get(i)); + assertEquals("school", values.get(i++)); + } + + @Test + public void returnsValueInLaterTree() throws StepException { + configuration.put("fieldName", "number"); + when(context.getOutputContext()).thenReturn(sharedOutputContext); + this.plugin.executeNodeStep(context, configuration, entry); + verify(context).getOutputContext(); + verify(sharedOutputContext).addOutput(groupCaptor.capture(), nameCaptor.capture(), valueCaptor.capture()); + + List groups = groupCaptor.getAllValues(); + List names = nameCaptor.getAllValues(); + List values = valueCaptor.getAllValues(); + + int i = 0; + assertEquals("raft", groups.get(i)); + assertEquals("key", names.get(i)); + assertEquals("212 555-1234", values.get(i++)); + } + + @Test + public void returnsValueForInteger() throws StepException { + configuration.put("fieldName", "postalCode"); + when(context.getOutputContext()).thenReturn(sharedOutputContext); + this.plugin.executeNodeStep(context, configuration, entry); + verify(context).getOutputContext(); + verify(sharedOutputContext).addOutput(groupCaptor.capture(), nameCaptor.capture(), valueCaptor.capture()); + + List groups = groupCaptor.getAllValues(); + List names = nameCaptor.getAllValues(); + List values = valueCaptor.getAllValues(); + + int i = 0; + assertEquals("raft", groups.get(i)); + assertEquals("key", names.get(i)); + assertEquals("10021", values.get(i++)); + } + + @Test + public void returnsValueForDouble() throws StepException { + configuration.put("fieldName", "age"); + when(context.getOutputContext()).thenReturn(sharedOutputContext); + this.plugin.executeNodeStep(context, configuration, entry); + verify(context).getOutputContext(); + verify(sharedOutputContext).addOutput(groupCaptor.capture(), nameCaptor.capture(), valueCaptor.capture()); + + List groups = groupCaptor.getAllValues(); + List names = nameCaptor.getAllValues(); + List values = valueCaptor.getAllValues(); + + int i = 0; + assertEquals("raft", groups.get(i)); + assertEquals("key", names.get(i)); + assertEquals("25.2", values.get(i++)); + } + + @Test + public void returnsValueForBoolean() throws StepException { + configuration.put("fieldName", "deceased"); + when(context.getOutputContext()).thenReturn(sharedOutputContext); + this.plugin.executeNodeStep(context, configuration, entry); + verify(context).getOutputContext(); + verify(sharedOutputContext).addOutput(groupCaptor.capture(), nameCaptor.capture(), valueCaptor.capture()); + + List groups = groupCaptor.getAllValues(); + List names = nameCaptor.getAllValues(); + List values = valueCaptor.getAllValues(); + + int i = 0; + assertEquals("raft", groups.get(i)); + assertEquals("key", names.get(i)); + assertEquals("true", values.get(i++)); + } + + @Test + public void notCalledOnNoMatch() throws StepException { + configuration.put("fieldName", "no_such_key"); + when(context.getOutputContext()).thenReturn(sharedOutputContext); + this.plugin.executeNodeStep(context, configuration, entry); + verify(context, never()).getOutputContext(); + verify(sharedOutputContext, never()).addOutput(anyString(), anyString(), anyString()); + } +} diff --git a/src/test/java/com/bioraft/rundeck/filelookup/JsonFindValueStepPluginTest.java b/src/test/java/com/bioraft/rundeck/filelookup/JsonFindValueStepPluginTest.java new file mode 100644 index 0000000..72e2ad1 --- /dev/null +++ b/src/test/java/com/bioraft/rundeck/filelookup/JsonFindValueStepPluginTest.java @@ -0,0 +1,203 @@ +/* + * Copyright 2019 BioRAFT, Inc. (http://bioraft.com) + * + * 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 com.bioraft.rundeck.filelookup; + +import static org.junit.Assert.assertEquals; +import static org.mockito.Matchers.anyString; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import java.util.List; +import java.util.Map; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +import org.junit.Before; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.mockito.ArgumentCaptor; +import org.mockito.Captor; +import org.mockito.Mock; +import org.mockito.runners.MockitoJUnitRunner; + +import com.dtolabs.rundeck.core.data.DataContext; +import com.dtolabs.rundeck.core.execution.workflow.SharedOutputContext; +import com.dtolabs.rundeck.core.execution.workflow.steps.StepException; +import com.dtolabs.rundeck.plugins.step.PluginStepContext; + +/** + * Tests for JsonFindValueStepPlugin. + * + * @author Karl DeBisschop + * @since 2019-12-11 + */ +@RunWith(MockitoJUnitRunner.class) +public class JsonFindValueStepPluginTest { + + JsonFindValueStepPlugin plugin; + + @Mock + PluginStepContext context; + + @Mock + SharedOutputContext sharedOutputContext; + + @Mock + DataContext dataContext; + + @Captor + ArgumentCaptor groupCaptor; + + @Captor + ArgumentCaptor nameCaptor; + + @Captor + ArgumentCaptor valueCaptor; + + Map configuration; + + @Before + public void setUp() { + this.plugin = new JsonFindValueStepPlugin(); + configuration = Stream.of(new String[][] { { "path", "testData/test.json" }, { "group", "raft" }, + { "name", "key" }, { "fieldName", "single" }, }) + .collect(Collectors.toMap(data -> data[0], data -> data[1])); + } + + @Test(expected = StepException.class) + public void noFileThrowsException() throws StepException { + configuration.put("path", "nosuchfile"); + when(context.getOutputContext()).thenReturn(sharedOutputContext); + this.plugin.executeStep(context, configuration); + } + + @Test + public void returnsValueForSimpleMatch() throws StepException { + when(context.getOutputContext()).thenReturn(sharedOutputContext); + this.plugin.executeStep(context, configuration); + verify(context).getOutputContext(); + verify(sharedOutputContext).addOutput(groupCaptor.capture(), nameCaptor.capture(), valueCaptor.capture()); + + List groups = groupCaptor.getAllValues(); + List names = nameCaptor.getAllValues(); + List values = valueCaptor.getAllValues(); + + int i = 0; + assertEquals("raft", groups.get(i)); + assertEquals("key", names.get(i)); + assertEquals("v1", values.get(i++)); + } + + @Test + public void returnsValueForMatchInTree() throws StepException { + configuration.put("fieldName", "address"); + when(context.getOutputContext()).thenReturn(sharedOutputContext); + this.plugin.executeStep(context, configuration); + verify(context).getOutputContext(); + verify(sharedOutputContext).addOutput(groupCaptor.capture(), nameCaptor.capture(), valueCaptor.capture()); + + List groups = groupCaptor.getAllValues(); + List names = nameCaptor.getAllValues(); + List values = valueCaptor.getAllValues(); + + int i = 0; + assertEquals("raft", groups.get(i)); + assertEquals("key", names.get(i)); + assertEquals("school", values.get(i++)); + } + + @Test + public void returnsValueInLaterTree() throws StepException { + configuration.put("fieldName", "number"); + when(context.getOutputContext()).thenReturn(sharedOutputContext); + this.plugin.executeStep(context, configuration); + verify(context).getOutputContext(); + verify(sharedOutputContext).addOutput(groupCaptor.capture(), nameCaptor.capture(), valueCaptor.capture()); + + List groups = groupCaptor.getAllValues(); + List names = nameCaptor.getAllValues(); + List values = valueCaptor.getAllValues(); + + int i = 0; + assertEquals("raft", groups.get(i)); + assertEquals("key", names.get(i)); + assertEquals("212 555-1234", values.get(i++)); + } + + @Test + public void returnsValueForInteger() throws StepException { + configuration.put("fieldName", "postalCode"); + when(context.getOutputContext()).thenReturn(sharedOutputContext); + this.plugin.executeStep(context, configuration); + verify(context).getOutputContext(); + verify(sharedOutputContext).addOutput(groupCaptor.capture(), nameCaptor.capture(), valueCaptor.capture()); + + List groups = groupCaptor.getAllValues(); + List names = nameCaptor.getAllValues(); + List values = valueCaptor.getAllValues(); + + int i = 0; + assertEquals("raft", groups.get(i)); + assertEquals("key", names.get(i)); + assertEquals("10021", values.get(i++)); + } + + @Test + public void returnsValueForDouble() throws StepException { + configuration.put("fieldName", "age"); + when(context.getOutputContext()).thenReturn(sharedOutputContext); + this.plugin.executeStep(context, configuration); + verify(context).getOutputContext(); + verify(sharedOutputContext).addOutput(groupCaptor.capture(), nameCaptor.capture(), valueCaptor.capture()); + + List groups = groupCaptor.getAllValues(); + List names = nameCaptor.getAllValues(); + List values = valueCaptor.getAllValues(); + + int i = 0; + assertEquals("raft", groups.get(i)); + assertEquals("key", names.get(i)); + assertEquals("25.2", values.get(i++)); + } + + @Test + public void returnsValueForBoolean() throws StepException { + configuration.put("fieldName", "deceased"); + when(context.getOutputContext()).thenReturn(sharedOutputContext); + this.plugin.executeStep(context, configuration); + verify(context).getOutputContext(); + verify(sharedOutputContext).addOutput(groupCaptor.capture(), nameCaptor.capture(), valueCaptor.capture()); + + List groups = groupCaptor.getAllValues(); + List names = nameCaptor.getAllValues(); + List values = valueCaptor.getAllValues(); + + int i = 0; + assertEquals("raft", groups.get(i)); + assertEquals("key", names.get(i)); + assertEquals("true", values.get(i++)); + } + + @Test + public void notCalledOnNoMatch() throws StepException { + configuration.put("fieldName", "no_such_key"); + when(context.getOutputContext()).thenReturn(sharedOutputContext); + this.plugin.executeStep(context, configuration); + verify(context, never()).getOutputContext(); + verify(sharedOutputContext, never()).addOutput(anyString(), anyString(), anyString()); + } +} diff --git a/src/test/java/com/bioraft/rundeck/filelookup/ScanFileNodeStepPluginTest.java b/src/test/java/com/bioraft/rundeck/filelookup/ScanFileNodeStepPluginTest.java new file mode 100644 index 0000000..e6ce2eb --- /dev/null +++ b/src/test/java/com/bioraft/rundeck/filelookup/ScanFileNodeStepPluginTest.java @@ -0,0 +1,151 @@ +/* + * Copyright 2019 BioRAFT, Inc. (http://bioraft.com) + * + * 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 com.bioraft.rundeck.filelookup; + +import static org.junit.Assert.assertEquals; +import static org.mockito.Matchers.anyString; +import static org.mockito.Matchers.matches; +import static org.mockito.Mockito.atLeastOnce; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +import org.junit.Before; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.mockito.ArgumentCaptor; +import org.mockito.Captor; +import org.mockito.Mock; +import org.mockito.runners.MockitoJUnitRunner; + +import com.dtolabs.rundeck.core.common.INodeEntry; +import com.dtolabs.rundeck.core.data.DataContext; +import com.dtolabs.rundeck.core.execution.workflow.SharedOutputContext; +import com.dtolabs.rundeck.core.execution.workflow.steps.StepException; +import com.dtolabs.rundeck.plugins.step.PluginStepContext; + +/** + * Tests for ScanFileStepPlugin. + * + * @author Karl DeBisschop + * @since 2019-12-11 + */ +@RunWith(MockitoJUnitRunner.class) +public class ScanFileNodeStepPluginTest { + + ScanFileNodeStepPlugin plugin; + + @Mock + PluginStepContext context; + + @Mock + INodeEntry entry; + + @Mock + SharedOutputContext sharedOutputContext; + + @Mock + DataContext dataContext; + + @Captor + ArgumentCaptor nameCaptor; + + @Captor + ArgumentCaptor valueCaptor; + + Map configuration; + + @Before + public void setUp() { + this.plugin = new ScanFileNodeStepPlugin(); + configuration = Stream.of(new String[][] { { "path", "testData/test.yaml" }, { "group", "example" }, + { "name", "key" }, { "regex", "single" }, }) + .collect(Collectors.toMap(data -> data[0], data -> data[1])); + } + + @Test(expected = StepException.class) + public void noFileThrowsException() throws StepException { + configuration.put("path", "nosuchfile"); + when(context.getOutputContext()).thenReturn(sharedOutputContext); + this.plugin.executeNodeStep(context, configuration, entry); + } + + @Test + public void canRunWithoutMatch() throws StepException { + configuration.put("regex", "com[.]example[.]label3: (.*)"); + when(context.getOutputContext()).thenReturn(sharedOutputContext); + this.plugin.executeNodeStep(context, configuration, entry); + + verify(context).getOutputContext(); + verify(sharedOutputContext, never()).addOutput(anyString(), anyString(), anyString()); + } + + @Test + public void canFindSingleCapture() throws StepException { + configuration.put("regex", "com[.]example[.]label2: (.*)"); + when(context.getOutputContext()).thenReturn(sharedOutputContext); + this.plugin.executeNodeStep(context, configuration, entry); + + verify(context).getOutputContext(); + verify(sharedOutputContext).addOutput(matches("^example$"), nameCaptor.capture(), valueCaptor.capture()); + + List names = nameCaptor.getAllValues(); + List values = valueCaptor.getAllValues(); + Map found = mergeLists(names, values); + + // Returns first match. + assertEquals("another", found.get("key")); + } + + @Test + public void canFindMultipleCapture() throws StepException { + configuration.put("regex", "com[.]example[.](label1|label2): (.*)"); + when(context.getOutputContext()).thenReturn(sharedOutputContext); + this.plugin.executeNodeStep(context, configuration, entry); + + verify(context).getOutputContext(); + verify(sharedOutputContext, atLeastOnce()).addOutput(matches("^example$"), nameCaptor.capture(), + valueCaptor.capture()); + + List names = nameCaptor.getAllValues(); + List values = valueCaptor.getAllValues(); + Map found = mergeLists(names, values); + + assertEquals("firstValue", found.get("label1")); + // Returns first match. + assertEquals("another", found.get("label2")); + } + + private Map mergeLists(List keys, List values) { + if (keys.size() != values.size()) { + throw new IllegalArgumentException("Cannot combine lists with dissimilar sizes"); + } + + Map map = new HashMap<>(); + for (int i = 0; i < keys.size(); i++) { + map.put(keys.get(i), values.get(i)); + } + + return map; + } + +} diff --git a/src/test/java/com/bioraft/rundeck/filelookup/ScanFileStepPluginTest.java b/src/test/java/com/bioraft/rundeck/filelookup/ScanFileStepPluginTest.java new file mode 100644 index 0000000..5e876d0 --- /dev/null +++ b/src/test/java/com/bioraft/rundeck/filelookup/ScanFileStepPluginTest.java @@ -0,0 +1,146 @@ +/* + * Copyright 2019 BioRAFT, Inc. (http://bioraft.com) + * + * 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 com.bioraft.rundeck.filelookup; + +import static org.junit.Assert.assertEquals; +import static org.mockito.Matchers.anyString; +import static org.mockito.Matchers.matches; +import static org.mockito.Mockito.atLeastOnce; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +import org.junit.Before; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.mockito.ArgumentCaptor; +import org.mockito.Captor; +import org.mockito.Mock; +import org.mockito.runners.MockitoJUnitRunner; + +import com.dtolabs.rundeck.core.data.DataContext; +import com.dtolabs.rundeck.core.execution.workflow.SharedOutputContext; +import com.dtolabs.rundeck.core.execution.workflow.steps.StepException; +import com.dtolabs.rundeck.plugins.step.PluginStepContext; + +/** + * Tests for ScanFileStepPlugin. + * + * @author Karl DeBisschop + * @since 2019-12-11 + */ +@RunWith(MockitoJUnitRunner.class) +public class ScanFileStepPluginTest { + + ScanFileStepPlugin plugin; + + @Mock + PluginStepContext context; + + @Mock + SharedOutputContext sharedOutputContext; + + @Mock + DataContext dataContext; + + @Captor + ArgumentCaptor nameCaptor; + + @Captor + ArgumentCaptor valueCaptor; + + Map configuration; + + @Before + public void setUp() { + this.plugin = new ScanFileStepPlugin(); + configuration = Stream.of(new String[][] { { "path", "testData/test.yaml" }, { "group", "example" }, + { "name", "key" }, { "regex", "single" }, }) + .collect(Collectors.toMap(data -> data[0], data -> data[1])); + } + + @Test(expected=StepException.class) + public void noFileThrowsException() throws StepException { + configuration.put("path", "nosuchfile"); + when(context.getOutputContext()).thenReturn(sharedOutputContext); + this.plugin.executeStep(context, configuration); + } + + @Test + public void canRunWithoutMatch() throws StepException { + configuration.put("regex", "com[.]example[.]label3: (.*)"); + when(context.getOutputContext()).thenReturn(sharedOutputContext); + + this.plugin.executeStep(context, configuration); + verify(context).getOutputContext(); + verify(sharedOutputContext, never()).addOutput(anyString(), anyString(), anyString()); + } + + @Test + public void canFindSingleCapture() throws StepException { + configuration.put("regex", "com[.]example[.]label2: (.*)"); + when(context.getOutputContext()).thenReturn(sharedOutputContext); + + this.plugin.executeStep(context, configuration); + verify(context).getOutputContext(); + verify(sharedOutputContext).addOutput(matches("^example$"), nameCaptor.capture(), valueCaptor.capture()); + + List names = nameCaptor.getAllValues(); + List values = valueCaptor.getAllValues(); + Map found = mergeLists(names, values); + + // Returns first match. + assertEquals("another", found.get("key")); + } + + @Test + public void canFindMultipleCapture() throws StepException { + configuration.put("regex", "com[.]example[.](label1|label2): (.*)"); + when(context.getOutputContext()).thenReturn(sharedOutputContext); + + this.plugin.executeStep(context, configuration); + verify(context).getOutputContext(); + verify(sharedOutputContext, atLeastOnce()).addOutput(matches("^example$"), nameCaptor.capture(), valueCaptor.capture()); + + List names = nameCaptor.getAllValues(); + List values = valueCaptor.getAllValues(); + Map found = mergeLists(names, values); + + assertEquals("firstValue", found.get("label1")); + // Returns first match. + assertEquals("another", found.get("label2")); + } + + private Map mergeLists (List keys, List values) { + if (keys.size() != values.size()) { + throw new IllegalArgumentException ("Cannot combine lists with dissimilar sizes"); + } + + Map map = new HashMap<>(); + for (int i = 0; i < keys.size(); i++) { + map.put(keys.get(i), values.get(i)); + } + + return map; + } + +} diff --git a/testData/test.json b/testData/test.json new file mode 100644 index 0000000..8d3bf6a --- /dev/null +++ b/testData/test.json @@ -0,0 +1,28 @@ +{ + "single": "v1", + "lastName": "Smith", + "address": { + "streetAddress": "21 2nd Street", + "city": "New York", + "state": "NY", + "postalCode": 10021, + "address": "school" + }, + "number": { + "one": 1, + "two": 2 + }, + "age": 25.2, + "phoneNumbers": [ + { + "address": "home", + "number": "212 555-1234" + }, + { + "address": "work", + "number": "212 555-1234" + } + ], + "firstName": "John", + "deceased": true +} diff --git a/testData/test.yaml b/testData/test.yaml new file mode 100644 index 0000000..2c59dca --- /dev/null +++ b/testData/test.yaml @@ -0,0 +1,28 @@ +version: '3' +services: + mysql: + image: percona:5.7 + networks: + - back + - front + ports: + - 127.0.0.1:3306:3306 + labels: + com.example.label1: firstValue + com.example.label2: another + + web: + image: image:latest + networks: + - front + - back + ports: + - 80:80 + - 443:443 + labels: + com.example.label1: secondValue + com.example.label2: notAnother + +networks: + front: {} + back: {}