SDK-358 - Add integration test framework for helper classes #308
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| package org.openmrs.maven.plugins; | ||
|
|
||
| import lombok.Getter; | ||
| import lombok.Setter; | ||
| import org.apache.commons.lang.StringUtils; | ||
| import org.apache.maven.plugin.MojoExecutionException; | ||
| import org.apache.maven.plugins.annotations.Mojo; | ||
| import org.apache.maven.plugins.annotations.Parameter; | ||
| import org.openmrs.maven.plugins.utility.MavenEnvironment; | ||
| import org.openmrs.maven.plugins.utility.Wizard; | ||
|
|
||
| import java.lang.reflect.Method; | ||
|
|
||
| /** | ||
| * The purpose is this Mojo is to support testing of helper utilities that are used by the various goals. This will: | ||
| * instantiate a new object of type className | ||
| * if this class has a setter property for a MavenExecution, this will be set | ||
| * it will then invoke the given testMethod on the testClass | ||
| */ | ||
| @Mojo(name = InvokeMethod.NAME) | ||
| @Getter @Setter | ||
| public class InvokeMethod extends AbstractTask { | ||
|
|
||
| public static final String NAME = "invoke-method"; | ||
|
|
||
| @Parameter(property = "className") | ||
| String className; | ||
|
|
||
| @Parameter(property = "methodName") | ||
| String methodName; | ||
|
|
||
| public void executeTask() throws MojoExecutionException { | ||
|
|
||
| if (StringUtils.isBlank(className) || StringUtils.isBlank(methodName)) { | ||
| throw new MojoExecutionException("You must supply both a className and methodName parameter"); | ||
| } | ||
|
|
||
| Wizard wizard = getMavenEnvironment().getWizard(); | ||
|
|
||
| wizard.showMessage("Invoking: " + className + ":" + methodName); | ||
|
|
||
| Class<?> clazz; | ||
| try { | ||
| clazz = getClass().getClassLoader().loadClass(className); | ||
| } | ||
| catch (ClassNotFoundException e) { | ||
| throw new MojoExecutionException("Unable to load class", e); | ||
| } | ||
| wizard.showMessage("Class " + clazz.getName() + " loaded successfully"); | ||
|
|
||
| Object instance; | ||
| try { | ||
| instance = clazz.getConstructor().newInstance(); | ||
| } catch (Exception e) { | ||
| throw new MojoExecutionException("Unable to instantiate class with " + getClass(), e); | ||
| } | ||
| wizard.showMessage("New instance of " + clazz.getName() + " instantiated"); | ||
|
|
||
| Method setterMethod = null; | ||
| try { | ||
| setterMethod = clazz.getMethod("set" + MavenEnvironment.class.getSimpleName(), MavenEnvironment.class); | ||
| } | ||
| catch (NoSuchMethodException ignored) { | ||
| } | ||
|
|
||
| if (setterMethod != null) { | ||
| try { | ||
| setterMethod.invoke(instance, getMavenEnvironment()); | ||
| wizard.showMessage("Instance populated with maven environment"); | ||
| } | ||
| catch (Exception e) { | ||
| throw new MojoExecutionException("Error executing method: " + methodName, e); | ||
| } | ||
| } | ||
|
There was a problem hiding this comment. This code is admittedly ugly. I probably should have just found a library to do this all more elegantly. In any event, this plugin will instantiate the given class, set the |
||
|
|
||
| Method method; | ||
| try { | ||
| method = clazz.getMethod(methodName); | ||
| } | ||
| catch (NoSuchMethodException e) { | ||
| throw new MojoExecutionException("Unable to find method: " + methodName, e); | ||
| } | ||
| wizard.showMessage("Got test method: " + method.getName()); | ||
|
|
||
| try { | ||
| method.invoke(instance); | ||
| } | ||
| catch (Exception e) { | ||
| throw new MojoExecutionException("Error executing method: " + methodName, e); | ||
| } | ||
| wizard.showMessage("Method: " + method.getName() + " invoked successfully"); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| package org.openmrs.maven.plugins; | ||
|
|
||
|
|
||
| import lombok.Getter; | ||
| import lombok.Setter; | ||
| import org.junit.Before; | ||
| import org.openmrs.maven.plugins.utility.MavenEnvironment; | ||
|
|
||
| import java.io.File; | ||
|
|
||
| @Getter @Setter | ||
| public abstract class AbstractMavenIT extends AbstractSdkIT { | ||
|
|
||
| MavenEnvironment mavenEnvironment = null; | ||
|
|
||
| @Override | ||
| @Before | ||
| public void setup() throws Exception { | ||
| super.setup(); | ||
| mavenEnvironment = null; | ||
| } | ||
|
|
||
| @Override | ||
| void addTestResources() throws Exception { | ||
| includePomFile("invokeIT", "pom.xml"); | ||
| } | ||
|
|
||
| protected void executeTest(MavenTestFunction testFunction) throws Exception { | ||
| StackTraceElement invoker = Thread.currentThread().getStackTrace()[2]; | ||
| String className = invoker.getClassName(); | ||
| String testMethod = invoker.getMethodName(); | ||
| if (mavenEnvironment == null) { | ||
| addTaskParam("className", className); | ||
| addTaskParam("methodName", testMethod); | ||
| addTaskParam(BATCH_ANSWERS, getAnswers()); | ||
| addTaskParam("testMode", "true"); | ||
| String plugin = resolveSdkArtifact(); | ||
| verifier.executeGoal(plugin + ":" + InvokeMethod.NAME); | ||
| } | ||
| else { | ||
| testFunction.executeTest(); | ||
| } | ||
|
There was a problem hiding this comment. So the general idea here, is that a particular integration test will wrap it's test functionality in this |
||
| } | ||
|
|
||
| protected File getMavenTestDirectory() { | ||
| return new File(mavenEnvironment.getMavenProject().getBuild().getDirectory()); | ||
| } | ||
|
|
||
| /** | ||
| * Simple interface that encapsulates a test that should be evaluated by tests that use this Mojo | ||
| */ | ||
| public interface MavenTestFunction { | ||
| void executeTest() throws Exception; | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This adds all of the test classes to their own library, so this library can be added to the classpath of the pom used by the Maven verifier during the integration tests, which runs outside of this project