AbstractProcessorのテスト（コンパイル時のJavaの注釈処理）

Question

私は素晴らしいライブラリーを作成したいので、AbstractProcessorクラスに依存するライブラリーを作成しています。 プリプロセッサはコンパイル時に動作するので、そのコードのテスト方法がわかりません。

ビルドが失敗するテストシナリオがあります。しかし、私はそれをどのようにテストできますか？ gradleを実行して終了コードを確認する必要がありますか？予想される原因によってビルドが失敗するかどうかを検証するためのきれいな方法がありますか、また何らかのパーサーを記述する必要がありますか？それはIMHOだけで良いカバー範囲のための巨大なオーバーヘッドになります。例を必要としているあなたのそれらのため

：

@SupportedAnnotationTypes("eu.rekisoft.java.preprocessor.Decorator") 
@SupportedSourceVersion(SourceVersion.RELEASE_7) 
public class ExamplePreprocessor extends AbstractProcessor { 

    public ExamplePreprocessor() { 
     super(); 
    } 

    @Override 
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) { 
     for(Element elem : roundEnv.getElementsAnnotatedWith(Decorator.class)) { 
      Method method = Method.from((ExecutableElement)elem); 
      if(!method.matchesTypes(String.class, StringBuilder.class)) { 
       processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "No! " + elem + " has the wrong args!"); 
      } else { 
       processingEnv.getMessager().printMessage(Diagnostic.Kind.NOTE, "Yey " + elem + " this is fine!"); 
      } 
     } 
     return true; // no further processing of this annotation type 
    } 
} 

そして、ここでは、コンパイルされていないことができクラスです。

public class AnnotationedExample { 
    @Decorator 
    public int breakBuild() { 
     return -1; 
    } 

    @Decorator 
    public String willCompile(StringBuilder sb) { 
     return null; 
    } 
} 

そして最後に退屈な注釈：

@Retention(RetentionPolicy.SOURCE) 
@Target(ElementType.METHOD) 
public @interface Decorator { 
} 

GitHubでプロジェクトをチェックアウトし、プロジェクトをチェックアウトして01を実行するだけで済みます。。あなたは、linuxとmacのスクリプトに対する不足しているxの権限を修正しなければならないかもしれません。

Answer 1

この問題は、以前のチームがコンパイラとアノテーションプロセッサを作成することで解決されているため、ソリューションを再利用できます。

javacチームはjtregというツールを使用します。 たとえば、jtreg testは、ソースファイルを異なるコマンドライン引数で6回コンパイルします。これは、それぞれ異なるexpected compiler outputを示します。

Checker Frameworkチームは、注釈プロセッサ専用のテストフレームワークを設計しました。このフレームワークを使用するtest caseがあります。//::のコメントは、注釈プロセッサがa warningまたはan errorを発行する予定の行を示しています。

Answer 2

Googleは、コンパイルをテストするための非常に優れたAPIを提供しています。 （https://github.com/google/compile-testing）。以下は、.javaファイルがjunitを使用するプロセッサでコンパイルされているかどうかをテストする例です。

package org.coffeebag.processor; 

import com.google.testing.compile.JavaFileObjects; 
import com.google.testing.compile.JavaSourceSubjectFactory; 
import org.junit.Test; 

import java.io.File; 
import java.net.MalformedURLException; 

import static org.truth0.Truth.ASSERT; 

public class ExampleTest { 

    @Test 
    public void EmptyClassCompiles() throws MalformedURLException { 
     final MyProcessor processor = MyProcessor.testMode(); 
     File source = new File("path/to/test/file.java"); 
     ASSERT.about(JavaSourceSubjectFactory.javaSource()) 
       .that(JavaFileObjects.forResource(source.toURI().toURL())) 
       .processedWith(processor) 
       .compilesWithoutError(); 
    } 
}