Модульное тестирование GMavenPlus Groovy Mojos - project.basedir не расширяется
В настоящее время я пытаюсь написать плагин для Maven с использованием GMavenPlus (спасибо @Keegan!) И Groovy 2.4.3. В двух словах, плагин анализирует каталог DDL-файлов SQL и генерирует выходные данные из этих проанализированных DDL-файлов.
Сам Mojo работает просто отлично, когда создается, импортируется и запускается в полном проекте. Horrah!
Проблема в модульном тестировании. При попытке модульного тестирования этого Mojo, Maven POM vars вроде ${project.basedir}
не расширяются, и, следовательно, mojo завершается с ошибкой типа "Файл не найден! [${project.basedir}/src/test/resources/ddl]". Как вы можете видеть из этого сообщения об ошибке, ${project.basedir}
был передан в качестве буквального вместо расширения.
В настоящее время я использую Maven Plugin Testing Harness (с фиксированными зависимостями, см. Этот блог), JUnit 4.12 и AssertJ 3.0.0 в качестве моего стека тестирования.
Какие-нибудь идеи или особые приемы, чтобы получить такие вещи, как project.basedir для расширения в модульном тесте?
Заранее спасибо!
Модульный тест в вопросе:
import edge.SqlToScalaMojo
import org.junit.Before
import org.junit.Test
/**
* Created by medge on 6/15/15.
*/
class SqlToScalaMojoTest extends BaseMojoTest<SqlToScalaMojo> {
SqlToScalaMojo mojo
@Before
void setup() {
mojo = getMojo("parse-ddls")
}
@Test
void testMojoExecution() throws Exception {
assertThat mojo isNotNull()
mojo.execute()
}
}
BaseMojoTest.groovy (на самом деле просто удобный базовый класс):
import org.apache.maven.plugin.AbstractMojo
import org.apache.maven.plugin.testing.MojoRule
import org.junit.Rule
/**
* Base Test class for Mojo tests. Extends {@link org.assertj.core.api.Assertions}
*
* If a type is given to this class then the result of #getMojo() does not have to be cast, reducing the amount of code
* to be written in the unit tests themselves.
*
* Created by medge on 6/5/15.
*/
abstract class BaseMojoTest<T extends AbstractMojo> extends org.assertj.core.api.Assertions {
/**
* MojoRule used to lookup Mojos
*/
@Rule public MojoRule rule = new MojoRule()
/**
* Get a configured mojo using the default pom file. Calls #getMojo(goal, getPom()) implicitly
*
* @param goal Goal to look up
* @return T configured Mojo
*/
T getMojo(String goal) {
getMojo(goal, getPom())
}
/**
* Get a configured mojo using the specified pom file
*
* @param goal Goal to look up
* @param pom POM file to use when configuring Mojo
* @return T configured Mojo
*/
T getMojo(String goal, File pom) {
T mojo = (T) rule.lookupMojo(goal, pom)
mojo
}
/**
* Default POM file if no custom path is given
*/
String defaultPomPath = "src/test/resources/plugin-config.xml"
/**
* Return a File reference containing the default POM file
*
* @return File
*/
File getPom() {
getPom(defaultPomPath)
}
/**
* Return a File reference containing the POM file found at the specified path. Implicitly asserts that the POM
* exists using <code>assertFile</code>
*
* @param path Path to user-defined POM (overrides the default if provided)
* @return File containing the specified POM.
*/
File getPom(String path) {
File _pom = getTestFile(path)
// Implicitly assert POM exists
assertFile(_pom)
// Then return the POM file
_pom
}
/**
* Convenience method to assert that a file is valid
*
* @param file File to validate
*/
static void assertFile(File file) {
assertThat file isNotNull()
assertThat file exists()
}
/**
* Get the current project's base directory. From {@link org.codehaus.plexus.PlexusTestCase}
*
* @return Base directory path
*/
static String getBaseDir() {
final String path = System.getProperty( "basedir" );
path ?: new File( "" ).getAbsolutePath();
}
/**
* Return a test file from the src/test/resources directory. Assumes the base directory is src/test/resources so the
* src/test/resources prefix can be omitted from the path if desired
*
* @param path File path
* @return File
*/
static File getTestFile(String path) {
File testFile
if(path.indexOf("src/test/resources/") > -1)
testFile = getTestFile(getBaseDir(), path)
else
testFile = getTestFile(getBaseDir(), "src/test/resources/${path}")
testFile
}
/**
* Retrieve a test file from the given baseDir/path
*
* @param baseDir String base directory to look in
* @param path String path to the file desired
* @return File
*/
static File getTestFile(String baseDir, String path) {
new File(baseDir, path)
}
}
Основной файл POM для самого Mojo:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>edge</groupId>
<artifactId>parser-mojo</artifactId>
<version>0.0.3-SNAPSHOT</version>
<packaging>maven-plugin</packaging>
<properties>
<groovy.version>2.4.3</groovy.version>
<maven.version>3.3.3</maven.version>
<junit.version>4.12</junit.version>
<assertj.version>3.0.0</assertj.version>
</properties>
<dependencies>
<dependency>
<groupId>org.codehaus.groovy</groupId>
<artifactId>groovy-all</artifactId>
<version>${groovy.version}</version>
</dependency>
<!-- Test dependencies -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>${junit.version}</version>
</dependency>
<dependency>
<groupId>org.assertj</groupId>
<artifactId>assertj-core</artifactId>
<version>${assertj.version}</version>
<scope>test</scope>
</dependency>
<!-- Dependencies for Maven Mojos -->
<dependency>
<groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-utils</artifactId>
<version>3.0.22</version>
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-core</artifactId>
<version>${maven.version}</version>
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-artifact</artifactId>
<version>${maven.version}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-compat</artifactId>
<version>${maven.version}</version>
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-plugin-api</artifactId>
<version>${maven.version}</version>
</dependency>
<dependency>
<groupId>org.apache.maven.plugin-tools</groupId>
<artifactId>maven-plugin-annotations</artifactId>
<version>3.4</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.maven.plugin-testing</groupId>
<artifactId>maven-plugin-testing-harness</artifactId>
<version>3.3.0</version>
<scope>test</scope>
<type>jar</type>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.codehaus.gmavenplus</groupId>
<artifactId>gmavenplus-plugin</artifactId>
<version>1.5</version>
<executions>
<execution>
<goals>
<goal>addSources</goal>
<goal>addTestSources</goal>
<goal>generateStubs</goal>
<goal>compile</goal>
<goal>testGenerateStubs</goal>
<goal>testCompile</goal>
<goal>removeStubs</goal>
<goal>removeTestStubs</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-plugin-plugin</artifactId>
<version>3.4</version>
<configuration>
<!-- see http://jira.codehaus.org/browse/MNG-5346 -->
<skipErrorNoDescriptorsFound>true</skipErrorNoDescriptorsFound>
</configuration>
<executions>
<execution>
<id>generate-descriptor</id>
<goals>
<goal>descriptor</goal>
</goals>
</execution>
<execution>
<id>help-goal</id>
<goals>
<goal>helpmojo</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
Тест POM, используемый во время модульного теста:
<project>
<build>
<plugins>
<plugin>
<groupId>edge</groupId>
<artifactId>parser-mojo</artifactId>
<version>0.0.3-SNAPSHOT</version>
<configuration>
<template>${project.basedir}/src/test/resources/sample.template</template>
<inputDir>${project.basedir}/src/test/resources/ddl</inputDir>
<outputDir>${project.basedir}/src/test/resources/generated/</outputDir>
</configuration>
<executions>
<execution>
<phase>generate-resources</phase>
<goals>
<goal>parse-ddls</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
Спасибо!
2 ответа
Нашел ответ на свой вопрос. Публикация здесь на случай, если кто-то еще ищет ту же проблему.
Во-первых, я столкнулся с еще одной проблемой с самим Моджо в отношении @Parameter
аннотаций. Следующие:
@Parameter(defaultValue = "${project.basedir}/src/main/resources")
String inputDir
Сгенерирует ошибку, потому что Groovy-компилятор подберет строку "${project.basedir}/src/main/resources"
до мавена. Затем он выполнит свою оценку и преобразует его в GString. Это приводит к ошибке, потому что аннотация ожидает java.lang.String, но получит java.lang.Object
Решение, как указал @Keegan в другом вопросе, заключается в использовании одинарных кавычек вместо двойных кавычек:
@Parameter(defaultValue = '${project.basedir}/src/main/resources')
String inputDir
Groovy-компилятор не будет оценивать строку, а Maven получит оттуда
Далее, оригинальный вопрос о defaultValue не читается во время модульного теста. Виновником был этот метод в BaseMojoTest.groovy:
T getMojo(String goal, File pom) {
T mojo = (T) rule.lookupMojo(goal, pom)
mojo
}
В частности, эта часть:
rule.lookupMojo(goal, pom)
lookupMojo в MojoRule не оценивает значение по умолчанию для аннотации параметра. Ожидается, что все возможные параметры присутствуют в тестовом файле POM. Быстрое погружение в исходный код MojoRule, и я нашел способ исправить это:
/**
* Get a configured mojo using the specified pom file
*
* @param goal Goal to look up
* @param pom POM file to use when configuring Mojo
* @return T configured Mojo
*/
T getMojo(String goal, File pom) {
T mojo = (T) rule.lookupConfiguredMojo(getMavenProject(pom), goal)
mojo
}
/**
* Method to handle creating a MavenProject instance to create configured Mojos from
* @param pom File to POM file containing Mojo config
* @return MavenProject
*/
MavenProject getMavenProject(File pom) {
// create the MavenProject from the pom.xml file
MavenExecutionRequest request = new DefaultMavenExecutionRequest()
ProjectBuildingRequest configuration = request.getProjectBuildingRequest()
.setRepositorySession(new DefaultRepositorySystemSession())
MavenProject project = rule.lookup(ProjectBuilder.class).build(pom, configuration).getProject()
project.basedir = new File(getBaseDir())
// Implicit assert
assertThat project isNotNull()
// And return
project
}
getMavenProject()
метод является небольшим изменением кода, найденного в MojoRule#readMavenProject()
, измененный для ссылки на MojoRule и мое определение getBaseDir(). Мохо, сгенерированные этим методом, теперь правильно оценивают @Parameter's defaultValue! Я чувствую, что getMavenProject()
вероятно, можно сделать более эффективным (вместо создания MavenProject каждый раз), но пока этого будет достаточно.
Еще кое-что
Возможно, вы заметили эту строку из getMavenProject()
метод:
project.basedir = new File(getBaseDir())
Этот очень раздражающий маленький взлом необходим, потому что при создании объекта MavenProject:
MavenProject project = rule.lookup(ProjectBuilder.class).build(pom, configuration).getProject()
${project.basedir} фактически становится базисом тестового файла POM, используемого в модульном тесте. Если, как и у меня, у вас есть тестовое POM в src/test/resources, то basedir станет чем-то вроде /Users/medge/.../src/test/resources. Следовательно, когда аннотации @Parameter с ${project.basedir} раскрываются, например:
@Parameter(defaultValue='${project.basedir}/src/main/resources')
String inputDir
При запуске из модульного теста inputDir будет разрешать в /Users/medge/.../src/test/resources/src/main/resources
Тонкие вещи могут сбить вас с толку...
Надеюсь, что это полезно для кого-то еще!
У меня была похожая проблема, но я вставил путь из конфигурации и нашел другое решение.
Я изменил pom тестового проекта на это:
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.example.maven.plugin.MyPlugin</groupId>
<artifactId>testProject</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>Test MyPlugin</name>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>3.8.1</version>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<artifactId>myPlugin-maven-plugin</artifactId>
<configuration>
<testDirectory>${basedir}\src\test\resources\testDir</testDirectory>
</configuration>
</plugin>
</plugins>
</build>
</project>
Разница в testDirectory. В то время как
<testDirectory>${project.basedir}\src\test\resources\testDir</testDirectory>
оценивает ту же строку, это
<testDirectory>${basedir}\src\test\resources\testDir</testDirectory>
оценивает конкретный путь в файловой системе C:\Development\projects\..\src\test\resources\testDir
,