Merge branch 'main' into JAVA-S1050-Non-final-static-fields

Signed-off-by: Piyush Acharya <[email protected]>

src/main/java/DNAnalyzer/DNAnalyzerApplication.java

@@ -3,16 +3,12 @@
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 
-/**
- * Main class to run the DNAnalyzer program with a webserver.
- */
+/** Main class to run the DNAnalyzer program with a webserver. */
 @SpringBootApplication
 public class DNAnalyzerApplication {
 
-    /**
-     * Main method to run the DNAnalyzer program with a webserver.
-     */
-    public static void main(final String[] args) {
-        SpringApplication.run(DNAnalyzerApplication.class);
-    }
+  /** Main method to run the DNAnalyzer program with a webserver. */
+  public static void main(final String[] args) {
+    SpringApplication.run(DNAnalyzerApplication.class);
+  }
 }

src/main/java/DNAnalyzer/adapter/AnalyseController.java

@@ -1,8 +1,4 @@
 package DNAnalyzer.adapter;
 
-/**
- * Controller for the analysis of DNA.
- */
-public class AnalyseController {
-
-}
+/** Controller for the analysis of DNA. */
+public class AnalyseController {}

src/main/java/DNAnalyzer/adapter/ApiKeyController.java

@@ -5,48 +5,46 @@
 import lombok.RequiredArgsConstructor;
 import org.springframework.web.bind.annotation.*;
 
-/**
- * Controller to get and set the API key.
- */
+/** Controller to get and set the API key. */
 @RequiredArgsConstructor
 @RestController
 @RequestMapping("/api-key")
 public class ApiKeyController {
 
-    /**
-     * Contructor of the controller.
-     *
-     * @param getApiKeyUseCase the use case to get the API key
-     * @param setApiKeyUseCase the use case to set the API key
-     */
-    public ApiKeyController(GetApiKeyUseCase getApiKeyUseCase, SetApiKeyUseCase setApiKeyUseCase) {
-        this.getApiKeyUseCase = getApiKeyUseCase;
-        this.setApiKeyUseCase = setApiKeyUseCase;
-    }
+  /**
+   * Contructor of the controller.
+   *
+   * @param getApiKeyUseCase the use case to get the API key
+   * @param setApiKeyUseCase the use case to set the API key
+   */
+  public ApiKeyController(GetApiKeyUseCase getApiKeyUseCase, SetApiKeyUseCase setApiKeyUseCase) {
+    this.getApiKeyUseCase = getApiKeyUseCase;
+    this.setApiKeyUseCase = setApiKeyUseCase;
+  }
 
-    private GetApiKeyUseCase getApiKeyUseCase;
-    private SetApiKeyUseCase setApiKeyUseCase;
+  private GetApiKeyUseCase getApiKeyUseCase;
+  private SetApiKeyUseCase setApiKeyUseCase;
 
-    /**
-     * Get the API key.
-     *
-     * @return the API key
-     */
-    @GetMapping
-    public ApiKeyResponse getApiKey() {
-        String apiKey = getApiKeyUseCase.getApiKey();
-        return new ApiKeyResponse(apiKey);
-    }
+  /**
+   * Get the API key.
+   *
+   * @return the API key
+   */
+  @GetMapping
+  public ApiKeyResponse getApiKey() {
+    String apiKey = getApiKeyUseCase.getApiKey();
+    return new ApiKeyResponse(apiKey);
+  }
 
-    /**
-     * Set the API key.
-     *
-     * @param request the request containing the new API key
-     * @return the new API key
-     */
-    @PutMapping
-    public ApiKeyResponse setApiKey(@RequestBody SetApiKeyRequest request) {
-        String apiKey = setApiKeyUseCase.setApiKey(request.apiKey());
-        return new ApiKeyResponse(apiKey);
-    }
+  /**
+   * Set the API key.
+   *
+   * @param request the request containing the new API key
+   * @return the new API key
+   */
+  @PutMapping
+  public ApiKeyResponse setApiKey(@RequestBody SetApiKeyRequest request) {
+    String apiKey = setApiKeyUseCase.setApiKey(request.apiKey());
+    return new ApiKeyResponse(apiKey);
+  }
 }

src/main/java/DNAnalyzer/adapter/ApiKeyResponse.java

@@ -2,7 +2,7 @@
 
 /**
  * Response to return the API key.
+ *
  * @param apiKey the API key.
  */
-public record ApiKeyResponse(String apiKey) {
-}
+public record ApiKeyResponse(String apiKey) {}

src/main/java/DNAnalyzer/adapter/SetApiKeyRequest.java

@@ -2,7 +2,7 @@
 
 /**
  * Request to set the API key.
+ *
  * @param apiKey the API key to set.
  */
-public record SetApiKeyRequest(String apiKey) {
-}
+public record SetApiKeyRequest(String apiKey) {}

src/main/java/DNAnalyzer/core/ApiKeyMissingException.java

@@ -1,15 +1,14 @@
 package DNAnalyzer.core;
 
-/**
- * Exception thrown when the API key is missing.
- */
+/** Exception thrown when the API key is missing. */
 public class ApiKeyMissingException extends RuntimeException {
 
-    /**
-     * Constructor of ApiKeyMissingException.
-     * @param message the message of the exception.
-     */
-    public ApiKeyMissingException(String message) {
-        super(message);
-    }
+  /**
+   * Constructor of ApiKeyMissingException.
+   *
+   * @param message the message of the exception.
+   */
+  public ApiKeyMissingException(String message) {
+    super(message);
+  }
 }

src/main/java/DNAnalyzer/core/ApiKeyService.java

@@ -1,31 +1,28 @@
 package DNAnalyzer.core;
 
-
 import DNAnalyzer.core.port.in.GetApiKeyUseCase;
 import DNAnalyzer.core.port.in.SetApiKeyUseCase;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Service;
 
-/**
- * The purpose of this service is to handle all operations concerning the OpenAI API key.
- */
+/** The purpose of this service is to handle all operations concerning the OpenAI API key. */
 @Service
 public class ApiKeyService implements GetApiKeyUseCase, SetApiKeyUseCase {
 
-    @Value("${openai.api.key}")
-    private String apiKey;
+  @Value("${openai.api.key}")
+  private String apiKey;
 
-    @Override
-    public String getApiKey() {
-        if (apiKey == null) {
-            throw new ApiKeyMissingException("No API-Key defined.");
-        }
-        return apiKey;
+  @Override
+  public String getApiKey() {
+    if (apiKey == null) {
+      throw new ApiKeyMissingException("No API-Key defined.");
     }
+    return apiKey;
+  }
 
-    @Override
-    public String setApiKey(String apiKey) {
-        this.apiKey = apiKey;
-        return this.apiKey;
-    }
+  @Override
+  public String setApiKey(String apiKey) {
+    this.apiKey = apiKey;
+    return this.apiKey;
+  }
 }

src/main/java/DNAnalyzer/core/port/in/AnalyzeDnaRequest.java

@@ -1,7 +1,4 @@
 package DNAnalyzer.core.port.in;
 
-/**
- * The request body holding the parameters for the analyze DNA use case.
- */
-public record AnalyzeDnaRequest() {
-}
+/** The request body holding the parameters for the analyze DNA use case. */
+public record AnalyzeDnaRequest() {}

src/main/java/DNAnalyzer/core/port/in/AnalyzeDnaUseCase.java

@@ -1,14 +1,13 @@
 package DNAnalyzer.core.port.in;
 
-/**
- * Use case interface to analyze DNA.
- */
+/** Use case interface to analyze DNA. */
 public interface AnalyzeDnaUseCase {
 
-    /**
-     * Analyze the DNA.
-     * @param request the request to analyze the DNA
-     * @return the result of the analysis
-     */
-    AnalyzeResult analyzeDna(AnalyzeDnaRequest request);
+  /**
+   * Analyze the DNA.
+   *
+   * @param request the request to analyze the DNA
+   * @return the result of the analysis
+   */
+  AnalyzeResult analyzeDna(AnalyzeDnaRequest request);
 }

src/main/java/DNAnalyzer/core/port/in/AnalyzeResult.java

@@ -1,7 +1,4 @@
 package DNAnalyzer.core.port.in;
 
-/**
- * Result of an DNA analysis.
- */
-public class AnalyzeResult {
-}
+/** Result of an DNA analysis. */
+public class AnalyzeResult {}

src/main/java/DNAnalyzer/core/port/in/GetApiKeyUseCase.java

@@ -1,13 +1,12 @@
 package DNAnalyzer.core.port.in;
 
-/**
- * Use case interface to get the API key.
- */
+/** Use case interface to get the API key. */
 public interface GetApiKeyUseCase {
 
-    /**
-     * Use case to get the set API key.
-     * @return the api key
-     */
-    String getApiKey();
+  /**
+   * Use case to get the set API key.
+   *
+   * @return the api key
+   */
+  String getApiKey();
 }

src/main/java/DNAnalyzer/core/port/in/SetApiKeyUseCase.java

@@ -1,14 +1,13 @@
 package DNAnalyzer.core.port.in;
 
-/**
- * Use case interface to set the API key.
- */
+/** Use case interface to set the API key. */
 public interface SetApiKeyUseCase {
 
-    /**
-     * Set the API key for the OpenAI API.
-     * @param apiKey the new API key.
-     * @return the api key
-     */
-    String setApiKey(String apiKey);
+  /**
+   * Set the API key for the OpenAI API.
+   *
+   * @param apiKey the new API key.
+   * @return the api key
+   */
+  String setApiKey(String apiKey);
 }

src/test/java/DNAnalyzer/adapter/ApiKeyControllerTest.java

@@ -1,8 +1,13 @@
 package DNAnalyzer.adapter;
 
+import static org.hamcrest.Matchers.*;
+import static org.junit.jupiter.api.Assertions.*;
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.Mockito.when;
+import static org.springframework.http.HttpHeaders.*;
+
 import DNAnalyzer.core.port.in.GetApiKeyUseCase;
 import DNAnalyzer.core.port.in.SetApiKeyUseCase;
-import org.hamcrest.Matchers;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
@@ -15,52 +20,46 @@
 import org.springframework.test.web.servlet.result.MockMvcResultHandlers;
 import org.springframework.test.web.servlet.result.MockMvcResultMatchers;
 
-import static org.hamcrest.Matchers.*;
-import static org.junit.jupiter.api.Assertions.*;
-import static org.mockito.ArgumentMatchers.anyString;
-import static org.mockito.Mockito.when;
-import static org.springframework.http.HttpHeaders.*;
-import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
-
 @WebMvcTest(ApiKeyController.class)
 class ApiKeyControllerTest {
 
-    @Autowired
-    private MockMvc mockMvc;
+  @Autowired private MockMvc mockMvc;
 
-    @MockBean
-    private GetApiKeyUseCase getApiKeyUseCase;
+  @MockBean private GetApiKeyUseCase getApiKeyUseCase;
 
-    @MockBean
-    private SetApiKeyUseCase setApiKeyUseCase;
+  @MockBean private SetApiKeyUseCase setApiKeyUseCase;
 
-    @Test
-    void getApiKey() throws Exception {
-        when(getApiKeyUseCase.getApiKey()).thenReturn("mock-key");
+  @Test
+  void getApiKey() throws Exception {
+    when(getApiKeyUseCase.getApiKey()).thenReturn("mock-key");
 
-        MvcResult mvcResult = this.mockMvc
-                .perform(MockMvcRequestBuilders.get("/api-key")
-                        .header(HttpHeaders.ACCEPT, MediaType.APPLICATION_JSON))
-                .andExpect(MockMvcResultMatchers.status().is(200))
-                .andExpect(MockMvcResultMatchers.jsonPath("$.apiKey", is("mock-key")))
-                .andExpect(MockMvcResultMatchers.content().contentType(MediaType.APPLICATION_JSON))
-                .andDo(MockMvcResultHandlers.print())
-                .andReturn();
-    }
+    MvcResult mvcResult =
+        this.mockMvc
+            .perform(
+                MockMvcRequestBuilders.get("/api-key")
+                    .header(HttpHeaders.ACCEPT, MediaType.APPLICATION_JSON))
+            .andExpect(MockMvcResultMatchers.status().is(200))
+            .andExpect(MockMvcResultMatchers.jsonPath("$.apiKey", is("mock-key")))
+            .andExpect(MockMvcResultMatchers.content().contentType(MediaType.APPLICATION_JSON))
+            .andDo(MockMvcResultHandlers.print())
+            .andReturn();
+  }
 
-    @Test
-    void setApiKey() throws Exception {
-        when(setApiKeyUseCase.setApiKey(anyString())).thenAnswer(i -> i.getArguments()[0]);
+  @Test
+  void setApiKey() throws Exception {
+    when(setApiKeyUseCase.setApiKey(anyString())).thenAnswer(i -> i.getArguments()[0]);
 
-        MvcResult mvcResult = this.mockMvc
-                .perform(MockMvcRequestBuilders.put("/api-key")
-                        .header(HttpHeaders.ACCEPT, MediaType.APPLICATION_JSON)
-                        .contentType(MediaType.APPLICATION_JSON)
-                        .content("{\"apiKey\":\"new-key\"}"))
-                .andExpect(MockMvcResultMatchers.status().is(200))
-                .andExpect(MockMvcResultMatchers.jsonPath("$.apiKey", is("new-key")))
-                .andExpect(MockMvcResultMatchers.content().contentType(MediaType.APPLICATION_JSON))
-                .andDo(MockMvcResultHandlers.print())
-                .andReturn();
-    }
+    MvcResult mvcResult =
+        this.mockMvc
+            .perform(
+                MockMvcRequestBuilders.put("/api-key")
+                    .header(HttpHeaders.ACCEPT, MediaType.APPLICATION_JSON)
+                    .contentType(MediaType.APPLICATION_JSON)
+                    .content("{\"apiKey\":\"new-key\"}"))
+            .andExpect(MockMvcResultMatchers.status().is(200))
+            .andExpect(MockMvcResultMatchers.jsonPath("$.apiKey", is("new-key")))
+            .andExpect(MockMvcResultMatchers.content().contentType(MediaType.APPLICATION_JSON))
+            .andDo(MockMvcResultHandlers.print())
+            .andReturn();
+  }
 }