sonarcloud.yml added

Author: vijayagopalsb

.github/workflows/sonarcloud.yml

@@ -0,0 +1,32 @@
+name: SonarCloud
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  build:
+    name: Build and Analyze
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+      - name: Cache SonarCloud packages
+        uses: actions/cache@v4
+        with:
+          path: ~/.sonar/cache
+          key: ${{ runner.os }}-sonar
+          restore-keys: ${{ runner.os }}-sonar
+      - name: SonarCloud Scan
+        uses: SonarSource/sonarcloud-github-action@v2
+        with:
+          projectBaseDir: .
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          SONAR_HOST_URL: "https://sonarcloud.io"

README.md

@@ -3,6 +3,7 @@
 
 [![Build Status](https://github.com/vijayagopalsb/SpringCleanArch/actions/workflows/ci.yml/badge.svg)](https://github.com/vijayagopalsb/SpringCleanArch/actions)
 ![Java](https://img.shields.io/badge/Java-17+-blue)
+[![SonarCloud Status](https://sonarcloud.io/api/project_badges/measure?project=vijayagopalsb_CleanArchitecture&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=vijayagopalsb_CleanArchitecture)
 ![License](https://img.shields.io/badge/license-MIT-green)
 
 ---

src/main/java/com/example/app/DemoApplication.java

@@ -2,13 +2,12 @@
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
-import static java.lang.System.out;
 
 @SpringBootApplication
 public class DemoApplication {
 
 	public static void main(String[] args) {
-		out.println ("Starting application...");
+	
 		SpringApplication.run(DemoApplication.class, args);
 
 

src/main/java/com/example/app/api/UserController.java

@@ -58,10 +58,6 @@ public AppUser createUser(@RequestBody AppUser user) {
 	@GetMapping("/{id}")
 	public AppUser getUser(@PathVariable Long id) {
 		logger.info("Fetching user with id: {}", id);
-		// return userService.getUserById(id).orElseThrow(() -> new
-		// RuntimeException("User not Found!"));
-		// return userService.getUserById(id).orElseThrow(() -> new
-		// ResponseStatusException(HttpStatus.NOT_FOUND, "User not Found"));
 		return userService.getUserById(id).orElseThrow(() -> new UserNotFoundException(id));
 	}
 
@@ -102,7 +98,7 @@ public AppUser assignRoles(@PathVariable Long id, @RequestBody Map<String, List<
 	}
 
 	@PostMapping("/{id}/photo")
-	public ResponseEntity<?> uploadPhoto(@PathVariable Long id, @RequestParam("file") MultipartFile file) {
+	public ResponseEntity<Map<String, String>> uploadPhoto(@PathVariable Long id, @RequestParam("file") MultipartFile file) {
 		String uploadDir = "uploads/";
 		String fileName = id + "_" + System.currentTimeMillis() + "_" + file.getOriginalFilename();
 		Path filePath = Paths.get(uploadDir, fileName);
@@ -114,26 +110,25 @@ public ResponseEntity<?> uploadPhoto(@PathVariable Long id, @RequestParam("file"
 			return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(Map.of("error", "Photo upload failed"));
 		}
 
-		// AppUser user = userService.getUserById(id).orElseThrow(() -> new
-		// UserNotFoundException(id));
-		// user.setPhotoPath(filePath.toString());
-		userService.updateUserPhoto(id, fileName.toString());
+		userService.updateUserPhoto(id, fileName);
 
 		// Return the file name/path as response
-		return ResponseEntity.ok(Map.of("message", "Photo uploaded successfully", "photoPath", fileName.toString()));
+		return ResponseEntity.ok(Map.of("message", "Photo uploaded successfully", "photoPath", fileName));
 	}
 
 	@GetMapping("/photos/{filename:.+}") // allows for extensions (like .jpg, .png)
 	public ResponseEntity<Resource> getPhoto(@PathVariable String filename) {
-		
+
 		logger.info("Received request to fetch photo: {}", filename);
 
 		try {
 			String uploadDir = System.getProperty("user.dir") + "/uploads/";
 			Path filePath = Paths.get(uploadDir, filename).normalize();
-			
-			logger.info("--- Looking for photo at: {}", filePath.toString());
-			
+
+			if (logger.isInfoEnabled()) {
+				logger.info("Looking for photo at: {}", filePath);
+			}
+
 			Resource resource = new UrlResource(filePath.toUri());
 
 			if (!resource.exists()) {
@@ -152,6 +147,6 @@ public ResponseEntity<Resource> getPhoto(@PathVariable String filename) {
 			logger.error("Error serving photo {}: {}", filename, exception.getMessage());
 			return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).build();
 		}
-	
+
 	}
 }

src/main/java/com/example/app/api/exceptions/ApiExceptionHandler.java

@@ -10,6 +10,8 @@
 import org.springframework.web.bind.annotation.ControllerAdvice;
 import org.springframework.web.bind.annotation.ExceptionHandler;
 
+import com.example.app.constants.ApiConstants;
+
 import jakarta.servlet.http.HttpServletRequest;
 
 @ControllerAdvice
@@ -19,13 +21,12 @@ public class ApiExceptionHandler {
 	@ExceptionHandler(UserNotFoundException.class)
 	public ResponseEntity<Object> handleUserNotFound(UserNotFoundException ex, HttpServletRequest request) {
 		Map<String, Object> body = new HashMap<>();
-		body.put("timestamp", ZonedDateTime.now());
-		body.put("status", HttpStatus.NOT_FOUND.value());
-		body.put("error", "Not Found");
-		body.put("message", ex.getMessage());
-		body.put("path", request.getRequestURI());
-		// Optionally, add more fields, e.g., "path"
-		return new ResponseEntity<Object>(body, HttpStatus.NOT_FOUND);
+		body.put(ApiConstants.TIMESTAMP, ZonedDateTime.now());
+		body.put(ApiConstants.STATUS, HttpStatus.NOT_FOUND.value());
+		body.put(ApiConstants.ERROR, "Not Found");
+		body.put(ApiConstants.MESSAGE, ex.getMessage());
+		body.put(ApiConstants.PATH, request.getRequestURI());
+		return new ResponseEntity<>(body, HttpStatus.NOT_FOUND);
 	}
 
 	// 2. Custom Duplicate Email Exception - More Specific
@@ -34,11 +35,11 @@ public ResponseEntity<Map<String, Object>> handleDuplicateEmail(DuplicateEmailEx
 			HttpServletRequest request) {
 
 		Map<String, Object> body = new HashMap<>();
-		body.put("timestamp", ZonedDateTime.now());
-		body.put("status", 409);
-		body.put("error", "Conflict");
-		body.put("message", duplicateEmailException.getMessage());
-		body.put("path", request.getRequestURI());
+		body.put(ApiConstants.TIMESTAMP, ZonedDateTime.now());
+		body.put(ApiConstants.STATUS, 409);
+		body.put(ApiConstants.ERROR, "Conflict");
+		body.put(ApiConstants.MESSAGE, duplicateEmailException.getMessage());
+		body.put(ApiConstants.PATH, request.getRequestURI());
 		return new ResponseEntity<>(body, HttpStatus.CONFLICT);
 
 	}
@@ -60,11 +61,11 @@ public ResponseEntity<Map<String, Object>> handleAll(Exception ex, HttpServletRe
 	// --- Utility Method for Response Construction ---
 	private ResponseEntity<Map<String, Object>> buildResponse(int status, String error, String message, String path) {
 		Map<String, Object> body = new HashMap<>();
-		body.put("timestamp", ZonedDateTime.now());
-		body.put("status", status);
-		body.put("error", error);
-		body.put("message", message);
-		body.put("path", path);
+		body.put(ApiConstants.TIMESTAMP, ZonedDateTime.now());
+		body.put(ApiConstants.STATUS, status);
+		body.put( ApiConstants.ERROR, error);
+		body.put(ApiConstants.MESSAGE, message);
+		body.put(ApiConstants.PATH, path);
 		return new ResponseEntity<>(body, HttpStatus.valueOf(status));
 	}
 

src/main/java/com/example/app/application/UserService.java

@@ -83,9 +83,6 @@ public AppUser assignRolesToUser(Long userId, List<String> roleNames) {
 		return userRepository.save(user);
 	}
 
-	//	public AppUser saveUser(AppUser user) {
-	//        return userRepository.save(user);
-	//    }
 
 	// Update User with Photo
 	public AppUser updateUserPhoto(Long id, String photoPath) {

src/main/java/com/example/app/constants/ApiConstants.java

@@ -0,0 +1,17 @@
+package com.example.app.constants;
+
+public class ApiConstants {
+	
+	private ApiConstants() {} // To prevent instantiation
+	
+	public static final String TIMESTAMP = "timestamp";
+	
+	public static final String STATUS = "status";
+	
+	public static final String ERROR = "error";
+	
+	public static final String MESSAGE = "message";
+	
+	public static final String PATH = "path";
+
+}

src/test/java/com/example/app/SpringCleanArchApplicationTests.java

@@ -8,6 +8,7 @@ class SpringCleanArchApplicationTests {
 
 	@Test
 	void contextLoads() {
+		// This test is intentionally empty to verify the application context loads successfully.
 	}
 
 }