Add maven checkstyle plugin and Add Checkstyle to CI

.github/workflows/cart-ci.yaml

@@ -29,6 +29,11 @@ jobs:
       - uses: ./.github/workflows/actions
       - name: Run Maven Build Command
         run: mvn clean install -DskipTests -pl cart -am
+      - name: Run Maven Checkstyle
+        run: mvn checkstyle:check -pl cart -am
+      - uses: jwgmeligmeyling/checkstyle-github-action@master
+        with:
+          path: '**/checkstyle-result.xml'
       - name: Run Maven Test
         run: mvn test -pl cart -am
       - name: Unit Test Results

cart/pom.xml

@@ -1,5 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xmlns="http://maven.apache.org/POM/4.0.0"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <parent>
         <groupId>com.yas</groupId>

cart/src/main/java/com/yas/cart/CartApplication.java

@@ -9,7 +9,7 @@
 @EnableConfigurationProperties(ServiceUrlConfig.class)
 public class CartApplication {
 
-	public static void main(String[] args) {
-		SpringApplication.run(CartApplication.class, args);
-	}
+    public static void main(String[] args) {
+        SpringApplication.run(CartApplication.class, args);
+    }
 }

cart/src/main/java/com/yas/cart/config/CorsConfig.java

@@ -7,6 +7,7 @@
 
 @Configuration
 public class CorsConfig {
+
     @Bean
     public WebMvcConfigurer corsConfigure() {
         return new WebMvcConfigurer() {

cart/src/main/java/com/yas/cart/config/DatabaseAutoConfig.java

@@ -21,7 +21,9 @@ public class DatabaseAutoConfig {
     public AuditorAware<String> auditorAware() {
         return () -> {
             Authentication auth = SecurityContextHolder.getContext().getAuthentication();
-            if (auth == null) return Optional.of("");
+            if (auth == null) {
+                return Optional.of("");
+            }
             return Optional.of(auth.getName());
         };
     }

cart/src/main/java/com/yas/cart/config/RestClientConfig.java

@@ -7,9 +7,9 @@
 @Configuration
 public class RestClientConfig {
 
-  @Bean
-  public RestClient restClient() {
-    return RestClient.builder().build();
-  }
+    @Bean
+    public RestClient restClient() {
+        return RestClient.builder().build();
+    }
 
 }

cart/src/main/java/com/yas/cart/config/SecurityConfig.java

@@ -17,17 +17,18 @@
 
 @Configuration
 public class SecurityConfig {
+
     @Bean
     public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
 
         return http
                 .authorizeHttpRequests(auth -> auth
-                    .requestMatchers("/actuator/prometheus", "/actuator/health/**",
-                            "/swagger-ui", "/swagger-ui/**", "/error", "/v3/api-docs/**").permitAll()
-                    .requestMatchers("/storefront/carts", "/storefront/carts/**").hasRole("CUSTOMER")
-                    .requestMatchers("/storefront/**").permitAll()
-                    .requestMatchers("/backoffice/**").hasRole("ADMIN")
-                    .anyRequest().authenticated())
+                        .requestMatchers("/actuator/prometheus", "/actuator/health/**",
+                                "/swagger-ui", "/swagger-ui/**", "/error", "/v3/api-docs/**").permitAll()
+                        .requestMatchers("/storefront/carts", "/storefront/carts/**").hasRole("CUSTOMER")
+                        .requestMatchers("/storefront/**").permitAll()
+                        .requestMatchers("/backoffice/**").hasRole("ADMIN")
+                        .anyRequest().authenticated())
                 .oauth2ResourceServer(oauth2 -> oauth2.jwt(Customizer.withDefaults()))
                 .build();
     }
@@ -43,7 +44,8 @@ public JwtAuthenticationConverter jwtAuthenticationConverterForKeycloak() {
         };
 
         var jwtAuthenticationConverter = new JwtAuthenticationConverter();
-        jwtAuthenticationConverter.setJwtGrantedAuthoritiesConverter(jwtGrantedAuthoritiesConverter);
+        jwtAuthenticationConverter.setJwtGrantedAuthoritiesConverter(
+                jwtGrantedAuthoritiesConverter);
 
         return jwtAuthenticationConverter;
     }

cart/src/main/java/com/yas/cart/config/ServiceUrlConfig.java

@@ -4,4 +4,5 @@
 
 @ConfigurationProperties(prefix = "yas.services")
 public record ServiceUrlConfig(String media, String product) {
+
 }

cart/src/main/java/com/yas/cart/config/SwaggerConfig.java

@@ -13,4 +13,5 @@
                 @OAuthScope(name = "openid", description = "openid")
         })))
 public class SwaggerConfig {
+
 }

cart/src/main/java/com/yas/cart/controller/CartController.java

@@ -22,6 +22,7 @@
 @Validated
 @RestController
 public class CartController {
+
     private final CartService cartService;
 
     public CartController(CartService cartService) {
@@ -34,14 +35,16 @@ public ResponseEntity<List<CartListVm>> listCarts() {
     }
 
     @GetMapping("/backoffice/carts/{customerId}")
-    public ResponseEntity<List<CartGetDetailVm>> listCartDetailByCustomerId(@PathVariable String customerId) {
+    public ResponseEntity<List<CartGetDetailVm>> listCartDetailByCustomerId(
+            @PathVariable String customerId) {
         return ResponseEntity.ok(cartService.getCartDetailByCustomerId(customerId));
     }
 
     @GetMapping("/storefront/carts")
     public ResponseEntity<CartGetDetailVm> getLastCart(Principal principal) {
-        if (principal == null)
+        if (principal == null) {
             return ResponseEntity.ok(null);
+        }
         return ResponseEntity.ok(cartService.getLastCart(principal.getName()));
     }
 
@@ -51,15 +54,17 @@ public ResponseEntity<CartGetDetailVm> getLastCart(Principal principal) {
             @ApiResponse(responseCode = "201", description = "Add to cart successfully", content = @Content(schema = @Schema(implementation = CartGetDetailVm.class))),
             @ApiResponse(responseCode = "404", description = "Not found", content = @Content(schema = @Schema(implementation = ErrorVm.class))),
             @ApiResponse(responseCode = "400", description = "Bad request", content = @Content(schema = @Schema(implementation = ErrorVm.class)))})
-    public ResponseEntity<CartGetDetailVm> createCart(@Valid @RequestBody @NotEmpty List<CartItemVm> cartItemVms) {
+    public ResponseEntity<CartGetDetailVm> createCart(
+            @Valid @RequestBody @NotEmpty List<CartItemVm> cartItemVms) {
         CartGetDetailVm cartGetDetailVm = cartService.addToCart(cartItemVms);
         return new ResponseEntity<>(cartGetDetailVm, HttpStatus.CREATED);
     }
 
     @PutMapping("cart-item")
     public ResponseEntity<CartItemPutVm> updateCart(@Valid @RequestBody CartItemVm cartItemVm) {
         Authentication auth = SecurityContextHolder.getContext().getAuthentication();
-        return new ResponseEntity<>(cartService.updateCartItems(cartItemVm, auth.getName()), HttpStatus.OK);
+        return new ResponseEntity<>(cartService.updateCartItems(cartItemVm, auth.getName()),
+                HttpStatus.OK);
     }
 
     @DeleteMapping("/storefront/cart-item")
@@ -70,16 +75,18 @@ public ResponseEntity<Void> removeCartItemByProductId(@RequestParam Long product
     }
 
     @DeleteMapping("/storefront/cart-item/multi-delete")
-    public ResponseEntity<Void> removeCartItemListByProductIdList(@RequestParam List<Long> productIds) {
+    public ResponseEntity<Void> removeCartItemListByProductIdList(
+            @RequestParam List<Long> productIds) {
         Authentication auth = SecurityContextHolder.getContext().getAuthentication();
         cartService.removeCartItemListByProductIdList(productIds, auth.getName());
         return ResponseEntity.noContent().build();
     }
 
     @GetMapping(path = "/storefront/count-cart-items")
     public ResponseEntity<Long> getNumberItemInCart(Principal principal) {
-        if (principal == null)
+        if (principal == null) {
             return ResponseEntity.ok().body(0L);
+        }
         return ResponseEntity.ok().body(cartService.countNumberItemInCart(principal.getName()));
     }
 

cart/src/main/java/com/yas/cart/exception/ApiExceptionHandler.java

@@ -16,49 +16,55 @@
 @ControllerAdvice
 @Slf4j
 public class ApiExceptionHandler {
-  private static final String ERROR_LOG_FORMAT = "Error: URI: {}, ErrorCode: {}, Message: {}";
 
-  @ExceptionHandler(NotFoundException.class)
-  public ResponseEntity<ErrorVm> handleNotFoundException(NotFoundException ex, WebRequest request) {
-    String message = ex.getMessage();
-    ErrorVm errorVm = new ErrorVm(HttpStatus.NOT_FOUND.toString(), "NotFound", message);
-    log.warn(ERROR_LOG_FORMAT, this.getServletPath(request), 404, message);
-    log.debug(ex.toString());
-    return new ResponseEntity<>(errorVm, HttpStatus.NOT_FOUND);
-  }
+    private static final String ERROR_LOG_FORMAT = "Error: URI: {}, ErrorCode: {}, Message: {}";
 
-  @ExceptionHandler(BadRequestException.class)
-  public ResponseEntity<ErrorVm> handleBadRequestException(BadRequestException ex, WebRequest request) {
-    String message = ex.getMessage();
-    ErrorVm errorVm = new ErrorVm(HttpStatus.BAD_REQUEST.toString(), "Bad request", message);
-    return ResponseEntity.badRequest().body(errorVm);
-  }
+    @ExceptionHandler(NotFoundException.class)
+    public ResponseEntity<ErrorVm> handleNotFoundException(NotFoundException ex,
+                                                           WebRequest request) {
+        String message = ex.getMessage();
+        ErrorVm errorVm = new ErrorVm(HttpStatus.NOT_FOUND.toString(), "NotFound", message);
+        log.warn(ERROR_LOG_FORMAT, this.getServletPath(request), HttpStatus.NOT_FOUND, message);
+        log.debug(ex.toString());
+        return new ResponseEntity<>(errorVm, HttpStatus.NOT_FOUND);
+    }
 
-  @ExceptionHandler(MethodArgumentNotValidException.class)
-  protected ResponseEntity<ErrorVm> handleMethodArgumentNotValid(MethodArgumentNotValidException ex, HttpHeaders headers,
-                                                                HttpStatus status, WebRequest request) {
-    List<String> errors = ex.getBindingResult()
-            .getFieldErrors()
-            .stream()
-            .map(error -> error.getField() + " " + error.getDefaultMessage())
-            .toList();
+    @ExceptionHandler(BadRequestException.class)
+    public ResponseEntity<ErrorVm> handleBadRequestException(BadRequestException ex,
+                                                             WebRequest request) {
+        String message = ex.getMessage();
+        ErrorVm errorVm = new ErrorVm(HttpStatus.BAD_REQUEST.toString(), "Bad request", message);
+        return ResponseEntity.badRequest().body(errorVm);
+    }
 
-    ErrorVm errorVm = new ErrorVm("400", "Bad Request", "Request information is not valid", errors);
-    return ResponseEntity.badRequest().body(errorVm);
-  }
+    @ExceptionHandler(MethodArgumentNotValidException.class)
+    protected ResponseEntity<ErrorVm> handleMethodArgumentNotValid(
+            MethodArgumentNotValidException ex, HttpHeaders headers,
+            HttpStatus status, WebRequest request) {
+        List<String> errors = ex.getBindingResult()
+                .getFieldErrors()
+                .stream()
+                .map(error -> error.getField() + " " + error.getDefaultMessage())
+                .toList();
 
-  @ExceptionHandler(Exception.class)
-  protected ResponseEntity<ErrorVm> handleOtherException(Exception ex, WebRequest request) {
-    String message = ex.getMessage();
-    ErrorVm errorVm = new ErrorVm(HttpStatus.INTERNAL_SERVER_ERROR.toString(),
-        HttpStatus.INTERNAL_SERVER_ERROR.getReasonPhrase(), message);
-    log.warn(ERROR_LOG_FORMAT, this.getServletPath(request), 500, message);
-    log.debug(ex.toString());
-    return new ResponseEntity<>(errorVm, HttpStatus.INTERNAL_SERVER_ERROR);
-  }
+        ErrorVm errorVm = new ErrorVm("400", "Bad Request", "Request information is not valid",
+                errors);
+        return ResponseEntity.badRequest().body(errorVm);
+    }
 
-  private String getServletPath(WebRequest webRequest) {
-    ServletWebRequest servletRequest = (ServletWebRequest) webRequest;
-    return servletRequest.getRequest().getServletPath();
-  }
+    @ExceptionHandler(Exception.class)
+    protected ResponseEntity<ErrorVm> handleOtherException(Exception ex, WebRequest request) {
+        String message = ex.getMessage();
+        ErrorVm errorVm = new ErrorVm(HttpStatus.INTERNAL_SERVER_ERROR.toString(),
+                HttpStatus.INTERNAL_SERVER_ERROR.getReasonPhrase(), message);
+        log.warn(ERROR_LOG_FORMAT, this.getServletPath(request), HttpStatus.INTERNAL_SERVER_ERROR,
+                message);
+        log.debug(ex.toString());
+        return new ResponseEntity<>(errorVm, HttpStatus.INTERNAL_SERVER_ERROR);
+    }
+
+    private String getServletPath(WebRequest webRequest) {
+        ServletWebRequest servletRequest = (ServletWebRequest) webRequest;
+        return servletRequest.getRequest().getServletPath();
+    }
 }

cart/src/main/java/com/yas/cart/exception/BadRequestException.java

@@ -3,6 +3,7 @@
 import com.yas.cart.utils.MessagesUtils;
 
 public class BadRequestException extends RuntimeException {
+
     private String message;
 
     public BadRequestException(String errorCode, Object... var2) {

cart/src/main/java/com/yas/cart/exception/NotFoundException.java

@@ -2,20 +2,20 @@
 
 import com.yas.cart.utils.MessagesUtils;
 
-public class NotFoundException extends RuntimeException{
+public class NotFoundException extends RuntimeException {
 
-  private String message;
+    private String message;
 
-  public NotFoundException(String errorCode, Object... var2) {
-    this.message = MessagesUtils.getMessage(errorCode, var2);
-  }
+    public NotFoundException(String errorCode, Object... var2) {
+        this.message = MessagesUtils.getMessage(errorCode, var2);
+    }
 
-  @Override
-  public String getMessage() {
-    return message;
-  }
+    @Override
+    public String getMessage() {
+        return message;
+    }
 
-  public void setMessage(String message) {
-    this.message = message;
-  }
+    public void setMessage(String message) {
+        this.message = message;
+    }
 }

cart/src/main/java/com/yas/cart/listener/CustomAuditingEntityListener.java

@@ -10,6 +10,7 @@
 
 @Configurable
 public class CustomAuditingEntityListener extends AuditingEntityListener {
+
     public CustomAuditingEntityListener(ObjectFactory<AuditingHandler> handler) {
         super.setAuditingHandler(handler);
     }

cart/src/main/java/com/yas/cart/model/AbstractAuditEntity.java

@@ -17,6 +17,7 @@
 @Setter
 @EntityListeners(CustomAuditingEntityListener.class)
 public class AbstractAuditEntity {
+
     @CreationTimestamp
     private ZonedDateTime createdOn;
 

cart/src/main/java/com/yas/cart/model/Cart.java

@@ -14,6 +14,7 @@
 @NoArgsConstructor
 @AllArgsConstructor
 public class Cart extends AbstractAuditEntity {
+
     @Id
     @GeneratedValue(strategy = GenerationType.AUTO)
     private Long id;

cart/src/main/java/com/yas/cart/model/CartItem.java

@@ -1,19 +1,19 @@
 package com.yas.cart.model;
 
+import jakarta.persistence.*;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 import lombok.Setter;
 
-import jakarta.persistence.*;
-
 @Entity
 @Getter
 @Setter
 @Table(name = "cart_item")
 @NoArgsConstructor
 @AllArgsConstructor
 public class CartItem {
+
     @Id
     @GeneratedValue(strategy = GenerationType.AUTO)
     private Long id;

cart/src/main/java/com/yas/cart/repository/CartItemRepository.java

@@ -13,6 +13,7 @@
 
 @Repository
 public interface CartItemRepository extends JpaRepository<CartItem, Long> {
+
     Set<CartItem> findAllByCart(Cart cart);
 
     Optional<CartItem> findByCartIdAndProductId(Long cartId, Long productId);

cart/src/main/java/com/yas/cart/repository/CartRepository.java

@@ -1,14 +1,14 @@
 package com.yas.cart.repository;
 
-import java.util.List;
-
+import com.yas.cart.model.Cart;
 import org.springframework.data.jpa.repository.JpaRepository;
 import org.springframework.stereotype.Repository;
 
-import com.yas.cart.model.Cart;
+import java.util.List;
 
 @Repository
 public interface CartRepository extends JpaRepository<Cart, Long> {
+
     List<Cart> findByCustomerId(String customerId);
 
     List<Cart> findByCustomerIdAndOrderIdIsNull(String customerId);