Fix spotbugs code smells

.github/workflows/maven.yml

@@ -34,5 +34,8 @@ jobs:
       - name: Validate
         run: ./mvnw -B clean validate
 
+      - name: Check spotbugs
+        run: ./mvnw -B -DskipTests=true -P check-spotbugs verify
+
       - name: Tests
         run: ./mvnw -B -DwebDriverType=chrome verify

pom.xml

@@ -22,6 +22,9 @@
         <decycle-maven-plugin.version>1.1.1</decycle-maven-plugin.version>
 
         <jacoco-maven-plugin.version>0.8.11</jacoco-maven-plugin.version>        
+
+        <spotbugs-maven-plugin.version>4.7.3.4</spotbugs-maven-plugin.version>
+        <findbugs-annotations.version>3.0.1</findbugs-annotations.version>
     </properties>
 
     <dependencyManagement>
@@ -36,6 +39,11 @@
                 <artifactId>springdoc-openapi-starter-common</artifactId>
                 <version>${springdoc.version}</version>
             </dependency>
+            <dependency>
+                <groupId>com.google.code.findbugs</groupId>
+                <artifactId>findbugs-annotations</artifactId>
+                <version>${findbugs-annotations.version}</version>
+            </dependency>
         </dependencies>
     </dependencyManagement>
 
@@ -91,6 +99,10 @@
             <artifactId>hsqldb</artifactId>
             <scope>runtime</scope>
         </dependency>
+        <dependency>
+            <groupId>com.google.code.findbugs</groupId>
+            <artifactId>findbugs-annotations</artifactId>
+        </dependency>
     </dependencies>
 
     <build>
@@ -140,6 +152,17 @@
                         </slicings>
                     </configuration>
                 </plugin>                
+                <plugin>
+                    <groupId>com.github.spotbugs</groupId>
+                    <artifactId>spotbugs-maven-plugin</artifactId>
+                    <version>${spotbugs-maven-plugin.version}</version>
+                    <configuration>
+                        <includeTests>true</includeTests>
+                        <xmlOutput>true</xmlOutput>
+                        <effort>Max</effort>
+                        <failOnError>true</failOnError>
+                    </configuration>
+                </plugin>
                 <plugin>
                     <groupId>org.jacoco</groupId>
                     <artifactId>jacoco-maven-plugin</artifactId>
@@ -206,6 +229,27 @@
         </plugins>
     </build>
 
+    <profiles>        
+        <profile>
+            <id>check-spotbugs</id>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>com.github.spotbugs</groupId>
+                        <artifactId>spotbugs-maven-plugin</artifactId>
+                        <executions>
+                            <execution>
+                                <goals>
+                                    <goal>check</goal>
+                                </goals>
+                            </execution>
+                        </executions>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
+    </profiles>
+
     <name>conta</name>
     <description>Conta do Desenvolvimento de Sistemas Corporativos</description>
     <url>https://github.com/persapiens/conta</url>

src/main/java/br/edu/ifrn/conta/domain/Categoria.java

@@ -3,6 +3,7 @@
 import java.io.Serializable;
 import java.util.Set;
 
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import jakarta.persistence.Column;
 import jakarta.persistence.Entity;
 import jakarta.persistence.GeneratedValue;
@@ -24,6 +25,7 @@
 /**
  * Categoria entity.
  */
+@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @Getter
 @Setter
 @ToString(exclude = "contas")

src/main/java/br/edu/ifrn/conta/domain/Conta.java

@@ -15,6 +15,7 @@
 import jakarta.persistence.SequenceGenerator;
 import java.util.Comparator;
 
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import lombok.AllArgsConstructor;
 import lombok.EqualsAndHashCode;
 import lombok.Getter;
@@ -27,6 +28,7 @@
 /**
  * Conta abstract entity.
  */
+@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @SuperBuilder
 @Getter
 @Setter

src/main/java/br/edu/ifrn/conta/domain/ContaPatrimonio.java

@@ -2,6 +2,7 @@
 
 import java.util.Set;
 
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import jakarta.persistence.Entity;
 import jakarta.persistence.OneToMany;
 
@@ -17,6 +18,7 @@
 /**
  * Conta Patrimonio entity.
  */
+@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @SuperBuilder
 @Getter
 @Setter

src/main/java/br/edu/ifrn/conta/domain/Dono.java

@@ -3,6 +3,7 @@
 import java.io.Serializable;
 import java.util.Set;
 
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import jakarta.persistence.Column;
 import jakarta.persistence.Entity;
 import jakarta.persistence.GeneratedValue;
@@ -24,6 +25,7 @@
 /**
  * Dono entity.
  */
+@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @Getter
 @Setter
 @ToString(of = "descricao")

src/main/java/br/edu/ifrn/conta/domain/Lancamento.java

@@ -5,6 +5,7 @@
 import java.time.LocalDateTime;
 import java.util.Comparator;
 
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import jakarta.persistence.Column;
 import jakarta.persistence.Entity;
 import jakarta.persistence.ForeignKey;
@@ -27,6 +28,7 @@
 /**
  * Lancamento entity.
  */
+@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @Getter
 @Setter
 @ToString

src/main/java/br/edu/ifrn/conta/domain/ValorInicialDoDonoNaContaPatrimonio.java

@@ -14,6 +14,7 @@
 import jakarta.persistence.SequenceGenerator;
 import java.util.Comparator;
 
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import lombok.AccessLevel;
 import lombok.AllArgsConstructor;
 import lombok.experimental.SuperBuilder;
@@ -26,6 +27,7 @@
 /**
  * Valor Inicial do Dono na Conta Patrimonio entity.
  */
+@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @Getter
 @Setter
 @ToString

src/main/java/br/edu/ifrn/conta/dto/ContaDTO.java

@@ -1,6 +1,8 @@
 package br.edu.ifrn.conta.dto;
 
 import java.io.Serializable;
+
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import lombok.Data;
 import lombok.NoArgsConstructor;
 import lombok.ToString;
@@ -9,6 +11,7 @@
 /**
  * DTO interface.
  */
+@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @SuperBuilder
 @Data
 @ToString

src/main/java/br/edu/ifrn/conta/dto/LancamentoDTO.java

@@ -3,6 +3,8 @@
 import java.io.Serializable;
 import java.math.BigDecimal;
 import java.time.LocalDateTime;
+
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import lombok.experimental.SuperBuilder;
 import lombok.Data;
 import lombok.NoArgsConstructor;
@@ -11,6 +13,7 @@
 /**
  * DTO interface.
  */
+@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @SuperBuilder
 @Data
 @ToString

src/main/java/br/edu/ifrn/conta/dto/ValorInicialDoDonoNaContaPatrimonioDTO.java

@@ -2,6 +2,8 @@
 
 import java.io.Serializable;
 import java.math.BigDecimal;
+
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import lombok.experimental.SuperBuilder;
 import lombok.Data;
 import lombok.NoArgsConstructor;
@@ -10,6 +12,7 @@
 /**
  * DTO interface.
  */
+@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @SuperBuilder
 @Data
 @ToString

src/main/java/br/edu/ifrn/conta/restclient/CategoriaRestClient.java

@@ -2,9 +2,11 @@
 
 import br.edu.ifrn.conta.dto.CategoriaDTO;
 import java.util.Optional;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import lombok.experimental.SuperBuilder;
 import lombok.Data;
 
+@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @Data
 @SuperBuilder
 public class CategoriaRestClient {

src/main/java/br/edu/ifrn/conta/restclient/ContaCreditoRestClient.java

@@ -2,9 +2,11 @@
 
 import br.edu.ifrn.conta.dto.ContaCreditoDTO;
 import java.util.Optional;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import lombok.experimental.SuperBuilder;
 import lombok.Data;
 
+@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @Data
 @SuperBuilder
 public class ContaCreditoRestClient {

src/main/java/br/edu/ifrn/conta/restclient/ContaDebitoRestClient.java

@@ -2,9 +2,11 @@
 
 import br.edu.ifrn.conta.dto.ContaDebitoDTO;
 import java.util.Optional;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import lombok.experimental.SuperBuilder;
 import lombok.Data;
 
+@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @Data
 @SuperBuilder
 public class ContaDebitoRestClient {

src/main/java/br/edu/ifrn/conta/restclient/ContaPatrimonioRestClient.java

@@ -2,9 +2,11 @@
 
 import br.edu.ifrn.conta.dto.ContaPatrimonioDTO;
 import java.util.Optional;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import lombok.experimental.SuperBuilder;
 import lombok.Data;
 
+@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @Data
 @SuperBuilder
 public class ContaPatrimonioRestClient {

src/main/java/br/edu/ifrn/conta/restclient/DonoRestClient.java

@@ -2,9 +2,11 @@
 
 import br.edu.ifrn.conta.dto.DonoDTO;
 import java.util.Optional;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import lombok.experimental.SuperBuilder;
 import lombok.Data;
 
+@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @Data
 @SuperBuilder
 public class DonoRestClient {

src/main/java/br/edu/ifrn/conta/restclient/LancamentoRestClient.java

@@ -2,10 +2,12 @@
 
 import br.edu.ifrn.conta.dto.LancamentoDTO;
 import java.math.BigDecimal;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import lombok.experimental.SuperBuilder;
 import lombok.Data;
 import org.springframework.web.util.UriComponentsBuilder;
 
+@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @Data
 @SuperBuilder
 public class LancamentoRestClient {

src/main/java/br/edu/ifrn/conta/restclient/RestClientHelper.java

@@ -3,12 +3,14 @@
 import java.net.URI;
 import lombok.experimental.SuperBuilder;
 import lombok.Data;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import org.springframework.core.ParameterizedTypeReference;
 import org.springframework.http.HttpEntity;
 import org.springframework.http.HttpMethod;
 import org.springframework.web.client.RestTemplate;
 import org.springframework.web.util.UriComponentsBuilder;
 
+@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @Data
 @SuperBuilder
 public class RestClientHelper <T> {

src/main/java/br/edu/ifrn/conta/restclient/SaldoRestClient.java

@@ -2,10 +2,12 @@
 
 import br.edu.ifrn.conta.dto.LancamentoDTO;
 import java.math.BigDecimal;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import lombok.experimental.SuperBuilder;
 import lombok.Data;
 import org.springframework.web.util.UriComponentsBuilder;
 
+@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @Data
 @SuperBuilder
 public class SaldoRestClient {

src/main/java/br/edu/ifrn/conta/restclient/TransferenciaRestClient.java

@@ -1,11 +1,12 @@
 package br.edu.ifrn.conta.restclient;
 
 import br.edu.ifrn.conta.dto.TransferenciaDTO;
-import java.math.BigDecimal;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import lombok.experimental.SuperBuilder;
 import lombok.Data;
 import org.springframework.web.util.UriComponentsBuilder;
 
+@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @Data
 @SuperBuilder
 public class TransferenciaRestClient {

src/main/java/br/edu/ifrn/conta/restclient/ValorInicialDoDonoNaContaPatrimonioRestClient.java

@@ -1,9 +1,11 @@
 package br.edu.ifrn.conta.restclient;
 
 import br.edu.ifrn.conta.dto.ValorInicialDoDonoNaContaPatrimonioDTO;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import lombok.experimental.SuperBuilder;
 import lombok.Data;
 
+@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @Data
 @SuperBuilder
 public class ValorInicialDoDonoNaContaPatrimonioRestClient {

src/main/java/br/edu/ifrn/conta/service/CrudService.java

@@ -2,6 +2,7 @@
 
 import java.io.Serializable;
 import java.util.Optional;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import org.springframework.beans.factory.annotation.Autowired;
 
 import org.springframework.data.repository.CrudRepository;
@@ -12,6 +13,7 @@
  * @param <T> entity
  * @param <ID> entity id
  */
+@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @Transactional(readOnly = true)
 public class CrudService<T extends Object, ID extends Serializable> {
 

src/main/java/br/edu/ifrn/conta/service/TransferenciaService.java

@@ -8,6 +8,8 @@
 import br.edu.ifrn.conta.domain.ContaPatrimonio;
 import br.edu.ifrn.conta.domain.Dono;
 import br.edu.ifrn.conta.domain.Lancamento;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 
@@ -16,6 +18,7 @@
 /**
  * Service of transferencia.
  */
+@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @Service
 public class TransferenciaService {