SonarQube complains about JpaRepository method name

Question

How everybody solve code smells related to method name on interfaces that extends JpaRepository? In my case I have an CpoWorkflowStepExecution entity and I want to find by id and date.

CpoWorkflowStepExecution:

@Entity
@Table(name = "cpo_workflow_step_execution", catalog = "cup_orchestrator")
public class CpoWorkflowStepExecution implements java.io.Serializable { 
    private Integer workflowStepExecutionId;
    private CpoWorkflowExecution cpoWorkflowExecution;
    private CpoWorkflowStep cpoWorkflowStep;
    private LocalDateTime startDate;
    private LocalDateTime finishDate;
    private String outcome;
    ...

WorkflowStepExecRep:

@Repository
public interface WorkflowStepExecRep extends JpaRepository<CpoWorkflowStepExecution, Integer>{

   Optional<CpoWorkflowStepExecution> findByCpoWorkflowStep_WorkflowStepIdAndFinishDateIsNull(String workflowStepId);

SonarQube: Rename this method name to match the regular expression '^[a-z][a-zA-Z0-9]*$'.

Good day, could you include the CpoWorkflowStepExecution entity in your question please? — Enmanuel Rodríguez Paz, Feb 03 '22 at 20:47

Aldo Inácio da Silva · Accepted Answer · 2023-03-24T11:40:36.580

2

I've changed the method name by removing _ character and it worked perfectly with SonarQube and JpaRepository:

findByCpoWorkflowStepWorkflowStepIdAndFinishDateIsNull

edited Mar 24 '23 at 11:40

answered Jul 06 '22 at 23:40

Aldo Inácio da Silva

824
2
14
38

score 1 · Answer 2 · answered Jan 20 '23 at 20:57

Spring Data uses _ to resolve ambiguity issues. You can find more details at Working with Spring Data Repository - Property Expressions.

You might want to change Sonarqube's rule java:S100 from ^[a-z][a-zA-Z0-9]*$ to ^[a-z][a-zA-Z0-9]+(_[a-zA-Z]+)*$ but makes it possible to misuse

SonarQube complains about JpaRepository method name

2 Answers2