io.tapack.satisfy.plugin.StoryRunnersMojo Maven / Gradle / Ivy
/*
* Copyright © 2015 Tapack, and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* The Research Projects is dual-licensed under the GNU General Public
* License, version 2.0 (GPLv2) and the Tapack Commercial License.
*
* Solely for non-commercial purposes. A purpose is non-commercial only if
* it is in no manner primarily intended for or directed toward commercial
* advantage or private monetary compensation.
*
* This Tapack Software is supplied to you by Tapack in consideration of your
* agreement to the following terms, and your use, installation, modification
* or redistribution of this Tapack Software constitutes acceptance of these
* terms. If you do not agree with these terms, please do not use, install,
* modify or redistribute this Tapack Software.
*
* Neither the name, trademarks, service marks or logos of Tapack may be used
* to endorse or promote products derived from the Tapack Software without
* specific prior written permission from Tapack.
*
* The Tapack Software is provided by Tapack on an "AS IS" basis. TAPACK
* MAKES NO
* WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
* WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE, REGARDING THE TAPACK SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
* COMBINATION WITH YOUR PRODUCTS.
*
* IN NO EVENT SHALL TAPACK BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
* AND/OR DISTRIBUTION OF THE TAPACK SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER
* THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR
* OTHERWISE, EVEN IF TAPACK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* A copy of the GNU General Public License is included in the distribution in
* the file LICENSE and at
*
* http://www.gnu.org/licenses/gpl-2.0.html
*
* If you are using the Research Projects for commercial purposes, we
* encourage you to visit
*
* http://products.tapack.io/license
*
* for more details.
*
* This software or hardware and documentation may provide access to
* or information on content, products, and services from third parties.
* Tapack and its affiliates are not responsible for and expressly disclaim
* all warranties of any kind with respect to third-party content, products,
* and services. Tapack and its affiliates will not be responsible for any loss,
* costs, or damages incurred due to your access to or use of third-party
* content, products, or services. If a third-party content exists, the
* additional copyright notices and license terms applicable to portions of the
* software are set forth in the THIRD_PARTY_LICENSE_README file.
*
* Please contact Tapack or visit www.tapack.io if you need additional
* information or have any questions.
*/
package io.tapack.satisfy.plugin;
import com.sun.codemodel.JClassAlreadyExistsException;
import com.sun.codemodel.JCodeModel;
import com.sun.codemodel.JDefinedClass;
import com.sun.codemodel.JMethod;
import com.sun.codemodel.JMod;
import com.sun.codemodel.writer.FileCodeWriter;
import io.tapack.satisfy.ScanningJunitStory;
import org.apache.commons.io.FileUtils;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
import org.junit.Test;
import java.io.File;
import java.io.IOException;
import java.util.Collection;
/**
* Goal which generates junit runner classes for each *.story file.
*/
@Mojo(name = "generate-test-runners", defaultPhase = LifecyclePhase
.GENERATE_TEST_SOURCES)
public class StoryRunnersMojo
extends AbstractMojo {
/**
* Directory with story files.
*/
@Parameter(property = "project.stories.directory",
defaultValue = "${project.basedir}/src/test/resources/stories",
required = true)
private File storiesDirectory;
/**
* Output directory for runners.
*/
@Parameter(property = "project.junit.stories.directory",
defaultValue = "${project.build.directory}"
+ "/generated-test-sources/jbehave",
required = true)
private File outputDirectory;
/**
* Maven project instance.
*/
@Component
private MavenProject project;
/**
* Execute maven plugin goal.
*
* @throws MojoExecutionException maven plugin exception
*/
public void execute() throws MojoExecutionException {
Collection files = FileUtils.listFiles(getStoriesDirectory(),
new String[]{"story"}, true);
JCodeModel codeModel = new JCodeModel();
for (File storyFile : files) {
try {
String name = getClassNameFrom(storyFile.getName());
JDefinedClass runnerClass = codeModel._class(
"io.tapack.satisfy." + name);
runnerClass._extends(ScanningJunitStory.class);
final JMethod runMethod = runnerClass
.method(JMod.PUBLIC, void.class, name);
runMethod._throws(Throwable.class);
runMethod.annotate(Test.class);
runMethod.body().invoke("run");
} catch (JClassAlreadyExistsException e) {
getLog().error(e);
}
}
File outputDir = getOutputDirectory();
if (!outputDir.exists()
&& outputDir.mkdirs()) {
outputDir = getOutputDirectory();
}
try {
codeModel.build(new FileCodeWriter(outputDir));
} catch (IOException e) {
getLog().error(e);
}
addOutputToSourceRoot();
}
/**
* Convert file name to class name.
*
* @param name of file
* @return class name
*/
public String getClassNameFrom(final String name) {
int extensionIndex = name.lastIndexOf('.');
String nameWithOutExtension = name.substring(0, extensionIndex);
String[] words = nameWithOutExtension.split("_");
StringBuilder builder = new StringBuilder();
for (String word : words) {
builder.append(Character.toTitleCase(word.charAt(0)))
.append(word.substring(1));
}
return builder.toString();
}
/**
* Getter for stories directory.
*
* @return stories directory
*/
public File getStoriesDirectory() {
return storiesDirectory;
}
/**
* Setter for stories directory.
*
* @param storiesDir directory
*/
public void setStoriesDirectory(final File storiesDir) {
this.storiesDirectory = storiesDir;
}
/**
* Getter for output directory.
*
* @return runners directory
*/
public File getOutputDirectory() {
return outputDirectory;
}
/**
* Setter for output directory.
*
* @param outputDir directory
*/
public void setOutputDirectory(final File outputDir) {
this.outputDirectory = outputDir;
}
/**
* Getter for maven project.
*
* @return maven project
*/
public MavenProject getProject() {
return project;
}
/**
* Setter for maven project.
*
* @param mavenProject maven
*/
public void setProject(final MavenProject mavenProject) {
this.project = mavenProject;
}
/**
* Add generated runners to test compile source root.
*/
public void addOutputToSourceRoot() {
File source = getOutputDirectory();
getProject().addTestCompileSourceRoot(source.getAbsolutePath());
if (getLog().isInfoEnabled()) {
getLog().info("Test Source directory: " + source + " added.");
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy