Rewriteアクションを使用したアノテーションへのパラメータ追加

本ブログ記事では、以下の内容を解説します。

• アノテーションの検索とマッチングの実演
• Mustacheテンプレートを使用したアノテーションの修正

Senseiは、問題のあるコードパターンを検出し、合意された実装へと修正する機能を提供します。この例では、パラメータのない @Disabled を問題のあるコードパターンとして使用します。

無効化されたテストアノテーション

理由が明記されていない無効化されたテストは、なぜ無効にしたのかを忘れてしまうため、長期的には問題となる可能性があります。

@Disabled
   void thisTestMethodHasNoDisabledReason(){
    Assertions.fail("This test is disabled and should not run");
    }

リスクとして、時間の経過とともにコードベースが進化しても、無効化されたテストがコードの目的に合わせて更新されず、最終的には冗長で無関係なものとなり、二度と有効化されない可能性があります。

コードレビューの際、アノテーションのパラメータとして説明文を追加することが推奨される場面はよくあります。

@Disabled ("Disabled to demonstrate adding a reason")
    void thisTestMethodHasDisabledReason(){
   Assertions.fail("This test is disabled and should not run");
   }

Senseiレシピ

説明なしで @Disabled が追加されたことを検出し、なぜ無効にしたのか理由の追記を促すクイックフィックス（修正案）を作成できます。

実行する手順は以下の通りです。

• パラメータのないDisabledアノテーションをマッチングする
• Disabledアノテーションを、「TODO: add a description here」というマーカーテキストを含むパラメータを持つ形式に変更する

警告レシピの作成

Alt+Enterキーを使用して新しいレシピを作成します。

次に、基本情報に説明文を追加します。

ルールを警告として設定することで、該当するコードはハイライト表示されますが、重大なエラーとしては扱われません。

アノテーションの検索

レシピエディタで、検索対象をアノテーションに一致するように変更します。

これにより、プレビュー内のすべてのアノテーションがハイライト表示されます。

次に、アノテーションの型でフィルタリングを行います。

単に「Disabled」と指定することもできますが、JUnit 5のアノテーションのみを対象とするよう、パッケージ名を含めた完全修飾名で指定します。プレビューにはソースコードが表示されるため、実際のコードからコピー＆ペーストすることで、タイプミスを確実に防ぐことができます。

続いて、パラメータを持たないアノテーションのみを対象とするよう、GUIを使って設定します。

例：検索設定

search:
  annotation:
    type: "org.junit.jupiter.api.Disabled"
    without:
       parameters:
          - {}

Rewriteクイックフィックスアクションの作成

クイックフィックスには、rewriteアクションを使用します。

「Show Variables」機能を使用して、Mustache変数とプレビュー内容を確認します。

そして、プレースホルダーのコメントを作成するために必要なコードを追加します。

例：クイックフィックス設定

availableFixes:
 - name: "Add a todo comment parameter"
   actions:
   - rewrite:
      to: "{{{ . }}}(\"TODO: add a description here\")"
      target: "self"

Senseiの活用

レシピ作成プロセスの実際を紹介する短い動画を作成しました。

概要

Rewriteクイックフィックスを作成する際は、書き換えたいコード要素を検索できるようにしておくと、その要素を「self」として操作できるため、作業が容易になります。

この例では、rewriteアクションを使用してアノテーションを修正しました。Rewriteはあらゆるコード要素に適用できる汎用的なアクションであり、まず試してみるべき基本機能です。