diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7ea69e5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,119 @@ + +# Created by https://www.toptal.com/developers/gitignore/api/intellij+all +# Edit at https://www.toptal.com/developers/gitignore?templates=intellij+all + +### Intellij+all ### +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider +# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 + +# User-specific stuff +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml + +# Gradle +.idea/**/gradle.xml +.idea/**/libraries + +# Gradle and Maven with auto-import +# When using Gradle or Maven with auto-import, you should exclude module files, +# since they will be recreated, and may cause churn. Uncomment if using +# auto-import. +# .idea/artifacts +# .idea/compiler.xml +# .idea/jarRepositories.xml +# .idea/modules.xml +# .idea/*.iml +# .idea/modules +# *.iml +# *.ipr + +# CMake +cmake-build-*/ + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# File-based project format +*.iws + +# IntelliJ +out/ + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties + +# Editor-based Rest Client +.idea/httpRequests + +# Android studio 3.1+ serialized cache file +.idea/caches/build_file_checksums.ser + +### Intellij+all Patch ### +# Ignores the whole .idea folder and all .iml files +# See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360 + +.idea/ + +# Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023 + +*.iml +modules.xml +.idea/misc.xml +*.ipr + +# Sonarlint plugin +.idea/sonarlint + +# End of https://www.toptal.com/developers/gitignore/api/intellij+all + + +# Created by https://www.toptal.com/developers/gitignore/api/gradle +# Edit at https://www.toptal.com/developers/gitignore?templates=gradle + +### Gradle ### +.gradle +build/ + +# Ignore Gradle GUI config +gradle-app.setting + +# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) +!gradle-wrapper.jar + +# Cache of project +.gradletasknamecache + +# # Work around https://youtrack.jetbrains.com/issue/IDEA-116898 +# gradle/wrapper/gradle-wrapper.properties + +### Gradle Patch ### +**/build/ + +# End of https://www.toptal.com/developers/gitignore/api/gradle diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..6ae1854 --- /dev/null +++ b/build.gradle @@ -0,0 +1,31 @@ +plugins { + id 'java-gradle-plugin' +} + +group 'org.mybatis.gradle' +version '1.0-SNAPSHOT' + +repositories { + mavenCentral() +} + +gradlePlugin { + plugins { + simplePlugin { + id = 'org.mybatis.gradle.migrations-gradle-plugin' + implementationClass = 'org.mybatis.gradle.MigrationsPlugin' + } + } +} + +dependencies { + testImplementation gradleTestKit() + implementation 'org.mybatis:mybatis-migrations:3.3.9' + testImplementation 'org.junit.jupiter:junit-jupiter-api:5.7.1' + testImplementation "org.mockito:mockito-core:3.+" + testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine' +} + +tasks.withType(Test).configureEach { + useJUnitPlatform() +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..e708b1c 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..3c4101c --- /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-7.0-all.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..4f906e0 --- /dev/null +++ b/gradlew @@ -0,0 +1,185 @@ +#!/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..ac1b06f --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,89 @@ +@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 Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="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..861cd2f --- /dev/null +++ b/settings.gradle @@ -0,0 +1,2 @@ +rootProject.name = 'migrations-gradle-plugin' + diff --git a/src/main/java/org/mybatis/gradle/CommandFactory.java b/src/main/java/org/mybatis/gradle/CommandFactory.java new file mode 100644 index 0000000..10b6cbb --- /dev/null +++ b/src/main/java/org/mybatis/gradle/CommandFactory.java @@ -0,0 +1,16 @@ +package org.mybatis.gradle; + +import org.apache.ibatis.migration.commands.Command; +import org.apache.ibatis.migration.options.SelectedOptions; + +import java.lang.reflect.InvocationTargetException; + +public class CommandFactory { + public T create(Class klass, SelectedOptions options) { + try { + return klass.getConstructor(SelectedOptions.class).newInstance(options); + } catch (InstantiationException | IllegalAccessException | InvocationTargetException | NoSuchMethodException e) { + throw new RuntimeException(e); + } + } +} diff --git a/src/main/java/org/mybatis/gradle/MigrationsExtension.java b/src/main/java/org/mybatis/gradle/MigrationsExtension.java new file mode 100644 index 0000000..dbf3b49 --- /dev/null +++ b/src/main/java/org/mybatis/gradle/MigrationsExtension.java @@ -0,0 +1,46 @@ +package org.mybatis.gradle; + +import org.gradle.api.internal.provider.DefaultProperty; +import org.gradle.api.internal.provider.PropertyHost; +import org.gradle.api.provider.Property; +import org.gradle.api.tasks.Input; + +import java.io.File; + +public abstract class MigrationsExtension { + @Input + abstract public Property getBaseDir(); + + @Input + abstract public Property getEnvironment(); + + @Input + abstract public Property getForce(); + + public static MigrationsExtension defaultValues() { + return new MigrationsExtension() { + private final Property force = getDefaultValue(Boolean.class, false); + private final Property environment = getDefaultValue(String.class, "development"); + private final Property baseDir = getDefaultValue(File.class, new File("./")); + + @Override + public Property getBaseDir() { + return baseDir; + } + + @Override + public Property getEnvironment() { + return environment; + } + + @Override + public Property getForce() { + return force; + } + + private Property getDefaultValue(Class klass, T value) { + return new DefaultProperty<>(PropertyHost.NO_OP, klass).value(value); + } + }; + } +} diff --git a/src/main/java/org/mybatis/gradle/MigrationsPlugin.java b/src/main/java/org/mybatis/gradle/MigrationsPlugin.java new file mode 100644 index 0000000..2cb106d --- /dev/null +++ b/src/main/java/org/mybatis/gradle/MigrationsPlugin.java @@ -0,0 +1,21 @@ +package org.mybatis.gradle; + +import org.gradle.api.Plugin; +import org.gradle.api.Project; +import org.mybatis.gradle.task.BootstrapTask; +import org.mybatis.gradle.task.InitTask; +import org.mybatis.gradle.task.PendingTask; +import org.mybatis.gradle.task.StatusTask; + +public class MigrationsPlugin implements Plugin { + + @Override + public void apply(Project project) { + var factory = new CommandFactory(); + project.getExtensions().create("migrations", MigrationsExtension.class); + project.getTasks().create(InitTask.TASK_NAME, InitTask.class, factory); + project.getTasks().create(BootstrapTask.TASK_NAME, BootstrapTask.class, factory); + project.getTasks().create(StatusTask.TASK_NAME, StatusTask.class, factory); + project.getTasks().create(PendingTask.TASK_NAME, PendingTask.class, factory); + } +} diff --git a/src/main/java/org/mybatis/gradle/task/BootstrapTask.java b/src/main/java/org/mybatis/gradle/task/BootstrapTask.java new file mode 100644 index 0000000..fdf2eaf --- /dev/null +++ b/src/main/java/org/mybatis/gradle/task/BootstrapTask.java @@ -0,0 +1,24 @@ +package org.mybatis.gradle.task; + +import org.apache.ibatis.migration.commands.BootstrapCommand; +import org.apache.ibatis.migration.options.SelectedOptions; +import org.gradle.api.tasks.TaskAction; +import org.mybatis.gradle.CommandFactory; + +import javax.inject.Inject; + +public class BootstrapTask extends MigrationsTask { + public static final String TASK_NAME = TASK_PREFIX + "Bootstrap"; + + @Inject + public BootstrapTask(CommandFactory factory) { + super(factory); + } + + @Override + @TaskAction + public void run() { + SelectedOptions options = getSelectedOptions(); + factory.create(BootstrapCommand.class, options).execute(); + } +} diff --git a/src/main/java/org/mybatis/gradle/task/InitTask.java b/src/main/java/org/mybatis/gradle/task/InitTask.java new file mode 100644 index 0000000..f7e7c3e --- /dev/null +++ b/src/main/java/org/mybatis/gradle/task/InitTask.java @@ -0,0 +1,32 @@ +package org.mybatis.gradle.task; + +import org.apache.ibatis.migration.commands.InitializeCommand; +import org.apache.ibatis.migration.options.SelectedOptions; +import org.gradle.api.tasks.TaskAction; +import org.gradle.api.tasks.options.Option; +import org.mybatis.gradle.CommandFactory; + +import javax.inject.Inject; + +public class InitTask extends MigrationsTask { + public static final String TASK_NAME = TASK_PREFIX + "Init"; + private String idPattern; + + @Inject + public InitTask(CommandFactory factory) { + super(factory); + } + + @Option(option = "idPattern", description = "Default file prefix") + public void setIdPattern(String idPattern) { + this.idPattern = idPattern; + } + + @Override + @TaskAction + public void run() { + SelectedOptions options = getSelectedOptions(); + options.setIdPattern(idPattern); + factory.create(InitializeCommand.class, options).execute(); + } +} diff --git a/src/main/java/org/mybatis/gradle/task/MigrationsTask.java b/src/main/java/org/mybatis/gradle/task/MigrationsTask.java new file mode 100644 index 0000000..8154035 --- /dev/null +++ b/src/main/java/org/mybatis/gradle/task/MigrationsTask.java @@ -0,0 +1,32 @@ +package org.mybatis.gradle.task; + +import org.apache.ibatis.migration.options.SelectedOptions; +import org.gradle.api.DefaultTask; +import org.gradle.api.tasks.TaskAction; +import org.mybatis.gradle.CommandFactory; +import org.mybatis.gradle.MigrationsExtension; + +public abstract class MigrationsTask extends DefaultTask implements Runnable { + public static final String TASK_PREFIX = "migrate"; + protected final CommandFactory factory; + protected MigrationsExtension extension = MigrationsExtension.defaultValues(); + + protected MigrationsTask(CommandFactory factory) { + this.factory = factory; + } + + public void setExtension(MigrationsExtension extension) { + this.extension = extension; + } + + @TaskAction + public abstract void run(); + + protected SelectedOptions getSelectedOptions() { + SelectedOptions options = new SelectedOptions(); + options.setEnvironment(extension.getEnvironment().get()); + options.getPaths().setBasePath(extension.getBaseDir().get()); + options.setForce(extension.getForce().get()); + return options; + } +} diff --git a/src/main/java/org/mybatis/gradle/task/PendingTask.java b/src/main/java/org/mybatis/gradle/task/PendingTask.java new file mode 100644 index 0000000..a0ff005 --- /dev/null +++ b/src/main/java/org/mybatis/gradle/task/PendingTask.java @@ -0,0 +1,24 @@ +package org.mybatis.gradle.task; + +import org.apache.ibatis.migration.commands.PendingCommand; +import org.apache.ibatis.migration.options.SelectedOptions; +import org.gradle.api.tasks.TaskAction; +import org.mybatis.gradle.CommandFactory; + +import javax.inject.Inject; + +public class PendingTask extends MigrationsTask { + public static final String TASK_NAME = TASK_PREFIX + "Pending"; + + @Inject + public PendingTask(CommandFactory factory) { + super(factory); + } + + @Override + @TaskAction + public void run() { + SelectedOptions options = getSelectedOptions(); + factory.create(PendingCommand.class, options).execute(); + } +} diff --git a/src/main/java/org/mybatis/gradle/task/StatusTask.java b/src/main/java/org/mybatis/gradle/task/StatusTask.java new file mode 100644 index 0000000..4c82123 --- /dev/null +++ b/src/main/java/org/mybatis/gradle/task/StatusTask.java @@ -0,0 +1,24 @@ +package org.mybatis.gradle.task; + +import org.apache.ibatis.migration.commands.StatusCommand; +import org.apache.ibatis.migration.options.SelectedOptions; +import org.gradle.api.tasks.TaskAction; +import org.mybatis.gradle.CommandFactory; + +import javax.inject.Inject; + +public class StatusTask extends MigrationsTask { + public static final String TASK_NAME = TASK_PREFIX + "Status"; + + @Inject + public StatusTask(CommandFactory factory) { + super(factory); + } + + @Override + @TaskAction + public void run() { + SelectedOptions options = getSelectedOptions(); + factory.create(StatusCommand.class, options).execute(); + } +} diff --git a/src/test/java/org/mybatis/gradle/MigrationsPluginFunctionalTest.java b/src/test/java/org/mybatis/gradle/MigrationsPluginFunctionalTest.java new file mode 100644 index 0000000..dd1786e --- /dev/null +++ b/src/test/java/org/mybatis/gradle/MigrationsPluginFunctionalTest.java @@ -0,0 +1,61 @@ +package org.mybatis.gradle; + +import org.gradle.testkit.runner.BuildResult; +import org.gradle.testkit.runner.GradleRunner; +import org.gradle.testkit.runner.TaskOutcome; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; + +import java.io.File; +import java.io.FileWriter; +import java.io.IOException; +import java.nio.file.Path; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertTrue; + +class MigrationsPluginFunctionalTest { + String baseDir = "THIS IS BASE DIR"; + String environment = "THIS IS THE ENVIRONMENT"; + boolean force = true; + + @TempDir + File buildDir; + File buildFile; + + @BeforeEach + void setUp() throws IOException { + buildFile = Path.of(buildDir.getPath(), "build.gradle").toFile(); + assertTrue(buildFile.createNewFile()); + + appendToGradleBuildFile(""" + plugins { + id 'org.mybatis.gradle.migrations-gradle-plugin' + } + migrations { + baseDir = new File('%s') + environment = '%s' + force = %s + } + """.formatted(baseDir, environment, force) + ); + } + + @Test + void whenBuildAndHasMigrationsExtension_expectSuccess() { + BuildResult result = GradleRunner.create() + .withProjectDir(buildDir) + .withArguments("build") + .withPluginClasspath() + .build(); + + result.getTasks().forEach(t -> assertEquals(t.getOutcome(), TaskOutcome.SUCCESS)); + } + + protected void appendToGradleBuildFile(String append) throws IOException { + try (FileWriter writer = new FileWriter(buildFile, true)) { + writer.append(append); + } + } +} diff --git a/src/test/java/org/mybatis/gradle/MigrationsPluginTest.java b/src/test/java/org/mybatis/gradle/MigrationsPluginTest.java new file mode 100644 index 0000000..e7d5fa2 --- /dev/null +++ b/src/test/java/org/mybatis/gradle/MigrationsPluginTest.java @@ -0,0 +1,47 @@ +package org.mybatis.gradle; + +import org.gradle.api.Project; +import org.gradle.testfixtures.ProjectBuilder; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.mybatis.gradle.task.BootstrapTask; +import org.mybatis.gradle.task.InitTask; +import org.mybatis.gradle.task.PendingTask; +import org.mybatis.gradle.task.StatusTask; + +import static org.junit.jupiter.api.Assertions.assertNotNull; + +class MigrationsPluginTest { + private Project project; + + @BeforeEach + void setUp() { + project = ProjectBuilder.builder().build(); + project.getPlugins().apply(MigrationsPlugin.class); + } + + @Test + void expectMigrationsExtensionToBeRegistered() { + assertNotNull(project.getExtensions().getByType(MigrationsExtension.class)); + } + + @Test + void expectInitToBeRegistered() { + assertNotNull(project.getTasks().withType(InitTask.class).getByName(InitTask.TASK_NAME)); + } + + @Test + void expectBootstrapToBeRegistered() { + assertNotNull(project.getTasks().withType(BootstrapTask.class).getByName(BootstrapTask.TASK_NAME)); + } + + @Test + void expectStatusToBeRegistered() { + assertNotNull(project.getTasks().withType(StatusTask.class).getByName(StatusTask.TASK_NAME)); + } + + @Test + void expectPendingToBeRegistered() { + assertNotNull(project.getTasks().withType(PendingTask.class).getByName(PendingTask.TASK_NAME)); + } +} diff --git a/src/test/java/org/mybatis/gradle/task/BootstrapTaskTest.java b/src/test/java/org/mybatis/gradle/task/BootstrapTaskTest.java new file mode 100644 index 0000000..e9e7d0c --- /dev/null +++ b/src/test/java/org/mybatis/gradle/task/BootstrapTaskTest.java @@ -0,0 +1,16 @@ +package org.mybatis.gradle.task; + +import org.apache.ibatis.migration.commands.BootstrapCommand; + +class BootstrapTaskTest extends MigrationsTaskTest { + + @Override + Class getType() { + return BootstrapTask.class; + } + + @Override + Class getMigrationsCommandType() { + return BootstrapCommand.class; + } +} diff --git a/src/test/java/org/mybatis/gradle/task/InitTaskTest.java b/src/test/java/org/mybatis/gradle/task/InitTaskTest.java new file mode 100644 index 0000000..b87ffd0 --- /dev/null +++ b/src/test/java/org/mybatis/gradle/task/InitTaskTest.java @@ -0,0 +1,39 @@ +package org.mybatis.gradle.task; + +import org.apache.ibatis.migration.commands.InitializeCommand; +import org.apache.ibatis.migration.options.SelectedOptions; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.verify; + +class InitTaskTest extends MigrationsTaskTest { + + @Override + @BeforeEach + void setUp() { + super.setUp(); + } + + @Test + void whenIdPatternProvidedAndTaskIsRun_expectIdPatternPassedToCommand() { + SelectedOptions options = new SelectedOptions(); + options.setIdPattern("ID-PATTERN"); + + task.setIdPattern(options.getIdPattern()); + task.run(); + + verify(factory).create(any(), optionsEqualTo(options)); + } + + @Override + Class getType() { + return InitTask.class; + } + + @Override + Class getMigrationsCommandType() { + return InitializeCommand.class; + } +} diff --git a/src/test/java/org/mybatis/gradle/task/MigrationsTaskTest.java b/src/test/java/org/mybatis/gradle/task/MigrationsTaskTest.java new file mode 100644 index 0000000..28c1c42 --- /dev/null +++ b/src/test/java/org/mybatis/gradle/task/MigrationsTaskTest.java @@ -0,0 +1,145 @@ +package org.mybatis.gradle.task; + +import org.apache.ibatis.migration.commands.Command; +import org.apache.ibatis.migration.options.SelectedOptions; +import org.apache.ibatis.migration.options.SelectedPaths; +import org.gradle.api.Project; +import org.gradle.api.tasks.TaskAction; +import org.gradle.api.tasks.options.Option; +import org.gradle.testfixtures.ProjectBuilder; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.mockito.Mock; +import org.mockito.MockitoAnnotations; +import org.mybatis.gradle.CommandFactory; +import org.mybatis.gradle.MigrationsExtension; + +import java.io.File; +import java.util.Objects; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.mockito.ArgumentMatchers.*; +import static org.mockito.Mockito.*; + +abstract class MigrationsTaskTest { + @Mock + CommandFactory factory; + C command; + T task; + + @BeforeEach + void setUp() { + command = mock(getMigrationsCommandType()); + MockitoAnnotations.openMocks(this); + + Project project = ProjectBuilder.builder().build(); + + task = project.getTasks().create(getType().getSimpleName(), getType(), factory); + doReturn(command).when(factory).create(eq(getMigrationsCommandType()), any(SelectedOptions.class)); + } + + abstract Class getType(); + + abstract Class getMigrationsCommandType(); + + @Test + void expectToHaveTaskActionAnnotation() throws NoSuchMethodException { + String nameOfRunMethodInRunnable = Runnable.class.getMethods()[0].getName(); + assertTrue(InitTask.class.getMethod(nameOfRunMethodInRunnable).isAnnotationPresent(TaskAction.class)); + } + + @Test + void expectSetIdPatternToHaveOptionAnnotation() throws NoSuchMethodException { + Option annotation = InitTask.class.getMethod("setIdPattern", String.class).getAnnotation(Option.class); + assertEquals("idPattern", annotation.option()); + } + + @Test + void whenTaskIsRun_expectInitializeCommandToBeRun() { + task.run(); + verify(command).execute(); + } + + @Test + void whenTaskIsRun_expectEnvironmentPassedToCommand() { + SelectedOptions options = new SelectedOptions(); + options.setEnvironment("ENVIRONMENT"); + + MigrationsExtension extension = getExtensionFromOptions(options); + task.setExtension(extension); + task.run(); + + verify(factory).create(any(), optionsEqualTo(options)); + } + + @Test + void whenTaskIsRun_expectBasePassedToCommand() { + SelectedOptions options = new SelectedOptions(); + options.getPaths().setBasePath(new File("BASE-PATH")); + + MigrationsExtension extension = getExtensionFromOptions(options); + task.setExtension(extension); + task.run(); + + verify(factory).create(any(), optionsEqualTo(options)); + } + + @Test + void whenTaskIsRun_expectForcePassedToCommand() { + SelectedOptions options = new SelectedOptions(); + options.setForce(true); + + MigrationsExtension extension = getExtensionFromOptions(options); + task.setExtension(extension); + task.run(); + + verify(factory).create(any(), optionsEqualTo(options)); + } + + SelectedOptions optionsEqualTo(final SelectedOptions options) { + return argThat(o -> optionsAreEqual(o, options)); + } + + MigrationsExtension getExtensionFromOptions(SelectedOptions options) { + MigrationsExtension extension = MigrationsExtension.defaultValues(); + extension.getEnvironment().set(options.getEnvironment()); + extension.getBaseDir().set(options.getPaths().getBasePath()); + extension.getForce().set(options.isForce()); + return extension; + } + + boolean optionsAreEqual(SelectedOptions options, SelectedOptions otherOptions) { + if (options == null && otherOptions == null) { + return true; + } + if (options == null || otherOptions == null) { + return false; + } + return pathsAreEqual(options.getPaths(), otherOptions.getPaths()) + && Objects.equals(options.getEnvironment(), otherOptions.getEnvironment()) + && Objects.equals(options.getTemplate(), otherOptions.getTemplate()) + && Objects.equals(options.getIdPattern(), otherOptions.getIdPattern()) + && Objects.equals(options.isForce(), otherOptions.isForce()) + && Objects.equals(options.isTrace(), otherOptions.isTrace()) + && Objects.equals(options.getCommand(), otherOptions.getCommand()) + && Objects.equals(options.getParams(), otherOptions.getParams()) + && Objects.equals(options.needsHelp(), otherOptions.needsHelp()) + && Objects.equals(options.isQuiet(), otherOptions.isQuiet()) + && Objects.equals(options.hasColor(), otherOptions.hasColor()); + } + + private boolean pathsAreEqual(SelectedPaths paths, SelectedPaths otherPaths) { + if (paths == null && otherPaths == null) { + return true; + } + if (paths == null || otherPaths == null) { + return false; + } + return Objects.equals(paths.getBasePath(), otherPaths.getBasePath()) + && Objects.equals(paths.getEnvPath(), otherPaths.getEnvPath()) + && Objects.equals(paths.getScriptPath(), otherPaths.getScriptPath()) + && Objects.equals(paths.getDriverPath(), otherPaths.getDriverPath()) + && Objects.equals(paths.getHookPath(), otherPaths.getHookPath()); + } +} diff --git a/src/test/java/org/mybatis/gradle/task/PendingTaskTest.java b/src/test/java/org/mybatis/gradle/task/PendingTaskTest.java new file mode 100644 index 0000000..8c326da --- /dev/null +++ b/src/test/java/org/mybatis/gradle/task/PendingTaskTest.java @@ -0,0 +1,16 @@ +package org.mybatis.gradle.task; + +import org.apache.ibatis.migration.commands.PendingCommand; + +class PendingTaskTest extends MigrationsTaskTest { + + @Override + Class getType() { + return PendingTask.class; + } + + @Override + Class getMigrationsCommandType() { + return PendingCommand.class; + } +} diff --git a/src/test/java/org/mybatis/gradle/task/StatusTaskTest.java b/src/test/java/org/mybatis/gradle/task/StatusTaskTest.java new file mode 100644 index 0000000..40634b5 --- /dev/null +++ b/src/test/java/org/mybatis/gradle/task/StatusTaskTest.java @@ -0,0 +1,16 @@ +package org.mybatis.gradle.task; + +import org.apache.ibatis.migration.commands.StatusCommand; + +class StatusTaskTest extends MigrationsTaskTest { + + @Override + Class getType() { + return StatusTask.class; + } + + @Override + Class getMigrationsCommandType() { + return StatusCommand.class; + } +} diff --git a/src/test/resources/mockito-extensions/org.mockito.plugins.MockMaker b/src/test/resources/mockito-extensions/org.mockito.plugins.MockMaker new file mode 100644 index 0000000..1f0955d --- /dev/null +++ b/src/test/resources/mockito-extensions/org.mockito.plugins.MockMaker @@ -0,0 +1 @@ +mock-maker-inline