Adding Parameters to Annotations Using Rewrite Actions

Published Nov 07, 2022
by Alan Richardson
tl;dr?

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse varius enim in eros elementum tristique. Duis cursus, mi quis viverra ornare, eros dolor interdum nulla, ut commodo diam libero vitae erat. Aenean faucibus nibh et justo cursus id rutrum lorem imperdiet. Nunc ut sem vitae risus tristique posuere.

View Resource

In this blog post, we will:

  • Demonstrate searching and matching annotations
  • Amen annotations using mustache templates

Sensei provides the ability to match problematic code patterns and then amend them to agreed implementations. In this example, I am using @Disabled without a parameter as the problematic code pattern.

Disabled Test Annotation

Disabled tests without a specified reason can prove problematic over the long term because we forget why we disabled it.


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

The risk is that, over time, the code base moves on, the disabled test is not updated in step with the purpose of the code and eventually becomes redundant and irrelevant, and potentially never re-enabled.

During code reviews, we will often point out that it is a good idea to add an explanatory description as the annotation parameter.


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

A Sensei Recipe

We can write a recipe to detect when @Disabled is added without explanation and a Quick Fix that reminds us to add the actual reason explaining why we disabled it.

When I think about what I'm going to do, I have to:

  • match the Disabled annotation without any parameters
  • change the Disabled annotation to have a parameter with marker text "TODO: add a description here"

Create a Warning Recipe

I use Alt+Enter to Create a new Recipe.

Create A New Recipe Function

Then add the basic descriptive text in the general information.

General Settings

By making the rule a warning, any matching code is highlighted but not shown as a glaring error.

Making The Rule A Warning

Find the Annotation

In the recipe editor, I change the Search to match an annotation.

This will highlight all annotations in the preview.

Recipe Editor

Having done that, I want to filter on the type of annotation.

I could just use Disabled but I fully qualify the class with the package so that it only matches the annotation from JUnit 5. Because the source code is shown in the preview, I can easily copy and paste this in from the actual code to avoid any typos.

I then want to match only annotations without Parameters, and I can use the GUI to do that.

Recipe Settings

i.e. Search:

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

Create a Rewrite Quick Fix Action

For my QuickFix I will use a rewrite action.

I use the Show Variables functionality to show me the Mustache variables and preview the contents.

QuickFix Settings

And then I add the extra code needed to create the place marker comment.

Add Extra code To Create The Place Marker Comment

i.e. QuickFix:

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

Sensei in Action

We have created a short video showing the recipe creation process in action.

Summary

When building a rewrite Quick Fix, it is easier when we can search for the code element that we want to rewrite, because it is then the self entity we can act on.

In this example, I used a rewrite action to amend the Annotation. Rewrite is a general-purpose action that can apply to any code element and is a good default to explore.

Want more?

Dive into onto our latest secure coding insights on the blog.

Our extensive resource library aims to empower the human approach to secure coding upskilling.

View Blog
Want more?

Get the latest research on developer-driven security

Our extensive resource library is full of helpful resources from whitepapers to webinars to get you started with developer-driven secure coding. Explore it now.

Resource Hub

Secure Code Warrior named in 2022 Gartner® Cool Vendors™

Published Nov 07, 2022
By Alan Richardson

In this blog post, we will:

  • Demonstrate searching and matching annotations
  • Amen annotations using mustache templates

Sensei provides the ability to match problematic code patterns and then amend them to agreed implementations. In this example, I am using @Disabled without a parameter as the problematic code pattern.

Disabled Test Annotation

Disabled tests without a specified reason can prove problematic over the long term because we forget why we disabled it.


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

The risk is that, over time, the code base moves on, the disabled test is not updated in step with the purpose of the code and eventually becomes redundant and irrelevant, and potentially never re-enabled.

During code reviews, we will often point out that it is a good idea to add an explanatory description as the annotation parameter.


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

A Sensei Recipe

We can write a recipe to detect when @Disabled is added without explanation and a Quick Fix that reminds us to add the actual reason explaining why we disabled it.

When I think about what I'm going to do, I have to:

  • match the Disabled annotation without any parameters
  • change the Disabled annotation to have a parameter with marker text "TODO: add a description here"

Create a Warning Recipe

I use Alt+Enter to Create a new Recipe.

Create A New Recipe Function

Then add the basic descriptive text in the general information.

General Settings

By making the rule a warning, any matching code is highlighted but not shown as a glaring error.

Making The Rule A Warning

Find the Annotation

In the recipe editor, I change the Search to match an annotation.

This will highlight all annotations in the preview.

Recipe Editor

Having done that, I want to filter on the type of annotation.

I could just use Disabled but I fully qualify the class with the package so that it only matches the annotation from JUnit 5. Because the source code is shown in the preview, I can easily copy and paste this in from the actual code to avoid any typos.

I then want to match only annotations without Parameters, and I can use the GUI to do that.

Recipe Settings

i.e. Search:

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

Create a Rewrite Quick Fix Action

For my QuickFix I will use a rewrite action.

I use the Show Variables functionality to show me the Mustache variables and preview the contents.

QuickFix Settings

And then I add the extra code needed to create the place marker comment.

Add Extra code To Create The Place Marker Comment

i.e. QuickFix:

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

Sensei in Action

We have created a short video showing the recipe creation process in action.

Summary

When building a rewrite Quick Fix, it is easier when we can search for the code element that we want to rewrite, because it is then the self entity we can act on.

In this example, I used a rewrite action to amend the Annotation. Rewrite is a general-purpose action that can apply to any code element and is a good default to explore.

Enter your details to access the full report.

We would like your permission to send you information on our products and/or related secure coding topics. We’ll always treat your personal details with the utmost care and will never sell them to other companies for marketing purposes.

Oopsie daisy