From a02c329f8d6fba839c7f3472a20073b8cf485269 Mon Sep 17 00:00:00 2001
From: brinxmat <789709+brinxmat@users.noreply.github.com>
Date: Thu, 26 Sep 2024 07:47:15 +0200
Subject: [PATCH] Bump PMD with fixes

---
 build.gradle                                  |  2 +-
 config/pmd/ruleset.xml                        | 12 ++------
 src/main/java/no/sikt/generator/ApiData.java  | 30 +++++++++++--------
 .../sikt/generator/ApplicationConstants.java  |  5 +++-
 .../no/sikt/generator/OpenApiCombiner.java    |  5 ++--
 .../no/sikt/generator/OpenApiExtractor.java   |  3 +-
 .../java/no/sikt/generator/OpenApiUtils.java  | 16 +++++-----
 .../handlers/GenerateDocsHandler.java         | 17 ++++++-----
 .../handlers/GenerateExternalDocsHandler.java |  5 ++--
 .../handlers/GenerateInternalDocsHandler.java |  5 ++--
 .../PublishDocumentationsHandler.java         |  7 +++--
 .../GenerateInternalDocsHandlerTest.java      |  3 +-
 .../no/sikt/generator/handlers/TestUtils.java |  7 +++--
 13 files changed, 62 insertions(+), 55 deletions(-)

diff --git a/build.gradle b/build.gradle
index 1c97d28..116ef32 100644
--- a/build.gradle
+++ b/build.gradle
@@ -98,7 +98,7 @@ tasks.named('test') {
 }
 
 pmd {
-    toolVersion = '6.20.0'
+    toolVersion = '7.5.0'
     ruleSetConfig = rootProject.resources.text.fromFile('config/pmd/ruleset.xml')
     ruleSets = []
     ignoreFailures = false
diff --git a/config/pmd/ruleset.xml b/config/pmd/ruleset.xml
index 8ecf4b7..f6924aa 100644
--- a/config/pmd/ruleset.xml
+++ b/config/pmd/ruleset.xml
@@ -10,13 +10,11 @@
   <exclude-pattern>.*/test/.*</exclude-pattern>
 
   <rule ref="category/java/errorprone.xml">
-    <exclude name="DataflowAnomalyAnalysis"/>
     <exclude name="MissingSerialVersionUID"/>
-    <exclude name="BeanMembersShouldSerialize"/>
   </rule>
 
   <rule ref="category/java/multithreading.xml">
-    <!-- Because it complains for the Map interface in the Resource class.-->
+    <!-- Because it complains about the Map interface in the Resource class.-->
     <exclude name="UseConcurrentHashMap"/>
   </rule>
 
@@ -42,12 +40,8 @@
     <exclude name="UnnecessaryConstructor"/>
     <!-- Conflicts with the rule category/java/codestyle.xml/AvoidProtectedMethodInFinalClassNotExtending -->
     <exclude name="CommentDefaultAccessModifier"/>
-    <!-- Conflicts with the rule category/java/codestyle.xml/AvoidProtectedMethodInFinalClassNotExtending -->
-    <exclude name="DefaultPackage"/>
-
-
-    <!--<exclude name="BeanMembersShouldSerialize"/>-->
-
+    <!-- We use vars! -->
+    <exclude name="UseExplicitTypes"/>
     <exclude name="ConfusingTernary"/>
 
     <!-- printStackTrace is used in the Default Amazon handler in a static clause
diff --git a/src/main/java/no/sikt/generator/ApiData.java b/src/main/java/no/sikt/generator/ApiData.java
index 9a255b2..17533d9 100644
--- a/src/main/java/no/sikt/generator/ApiData.java
+++ b/src/main/java/no/sikt/generator/ApiData.java
@@ -8,7 +8,6 @@
 import io.swagger.v3.oas.models.OpenAPI;
 import java.util.HashMap;
 import java.util.List;
-import java.util.Objects;
 import java.util.Optional;
 import nva.commons.core.JacocoGenerated;
 import nva.commons.core.attempt.Failure;
@@ -24,10 +23,10 @@ public class ApiData {
 
     private final RestApi awsRestApi;
     private final OpenAPI openapiApiGateway;
-    private Optional<OpenAPI> openapiApiGithub;
     private final String rawYaml;
     private final Stage stage;
     private static final Logger logger = LoggerFactory.getLogger(ApiData.class);
+    private OpenAPI openapiApiGithub;
 
     public ApiData(RestApi awsRestApi, OpenAPI openapiApiGateway, String rawYaml, Stage stage) {
         this.awsRestApi = awsRestApi;
@@ -64,6 +63,10 @@ public int getDashesInPath() {
         return Try.attempt(this::getNumberOfDashesInBasePath).orElse(this::handleGetDashesFailure);
     }
 
+    private Optional<OpenAPI> getOpenapiApiGithub() {
+        return Optional.ofNullable(openapiApiGithub);
+    }
+
     public void setMatchingGithubOpenapi(List<Pair<S3Object, OpenAPI>> templateOpenapiDocs) {
         var title = this.openapiApiGateway.getInfo().getTitle();
         var matchingGithubOpenApi = templateOpenapiDocs.stream()
@@ -73,16 +76,15 @@ public void setMatchingGithubOpenapi(List<Pair<S3Object, OpenAPI>> templateOpena
                                                                           .equals(title))
                                         .findFirst();
         if (matchingGithubOpenApi.isPresent()) {
-            logger.info("Using matching github openapi at " + matchingGithubOpenApi.get().getLeft().key()+ " for " + title);
-            this.openapiApiGithub = Optional.of(matchingGithubOpenApi.get().getRight());
+            logger.info("Using matching github openapi at "
+                        + matchingGithubOpenApi.get().getLeft().key()+ " for " + title);
+            this.openapiApiGithub = matchingGithubOpenApi.get().getRight();
         } else {
             logger.warn("No matching github openapi found for " + title);
-            this.openapiApiGithub = Optional.empty();
         }
-;
     }
 
-    public ApiData setEmptySchemasIfNull() {
+    public ApiData applyEmptySchemasIfNull() {
         if (isNull(this.openapiApiGateway.getComponents())) {
             this.openapiApiGateway.setComponents(new Components());
         }
@@ -93,27 +95,29 @@ public ApiData setEmptySchemasIfNull() {
     }
 
     public ApiData overridePropsFromGithub() {
-        if (this.openapiApiGithub.isPresent()) {
+        var openApiGithub = getOpenapiApiGithub();
+        if (openApiGithub.isPresent()) {
             this.openapiApiGateway.getPaths().forEach((pathKey, pathItem) -> {
                 pathItem.readOperationsMap().forEach((httpMethod, operation) -> {
                     if (nonNull(operation.getParameters())) {
                         operation.getParameters().forEach(parameter -> {
-                            var operationInGithub = Optional.ofNullable(openapiApiGithub.get().getPaths().get(pathKey).readOperationsMap()
+                            var operationInGithub =
+                                Optional.ofNullable(openApiGithub.get().getPaths().get(pathKey).readOperationsMap()
                                                                              .get(httpMethod));
                             operationInGithub.ifPresent(value -> operation.setParameters(value.getParameters()));
                         });
                     }
                 });
             });
-            if (nonNull(this.openapiApiGithub.get().getComponents())
-                && nonNull(this.openapiApiGithub.get().getComponents().getSchemas())
+            if (nonNull(openApiGithub.get().getComponents())
+                && nonNull(openApiGithub.get().getComponents().getSchemas())
             ) {
-                this.openapiApiGithub.get().getComponents().getSchemas().forEach(((key,value) -> {
+                openApiGithub.get().getComponents().getSchemas().forEach((key,value) -> {
                     if (isNull(this.openapiApiGateway.getComponents().getSchemas().get(key))) {
                         logger.info("Adding schema " + key + " from github");
                         this.openapiApiGateway.getComponents().getSchemas().put(key, value);
                     }
-                }));
+                });
             }
 
         }
diff --git a/src/main/java/no/sikt/generator/ApplicationConstants.java b/src/main/java/no/sikt/generator/ApplicationConstants.java
index ca2e356..4ce4518 100644
--- a/src/main/java/no/sikt/generator/ApplicationConstants.java
+++ b/src/main/java/no/sikt/generator/ApplicationConstants.java
@@ -32,7 +32,10 @@ private static String readExternalBucketName() {
     private static String readInternalBucketName()  {
         return ENVIRONMENT.readEnv("INTERNAL_BUCKET_NAME");
     }
-    public static String readOpenApiBucketName() { return ENVIRONMENT.readEnv("OPEN_API_DOCS_BUCKET_NAME");}
+
+    public static String readOpenApiBucketName() {
+        return ENVIRONMENT.readEnv("OPEN_API_DOCS_BUCKET_NAME");
+    }
 
     private static String readExternalCloudFrontDistributionId() {
         return ENVIRONMENT.readEnv("EXTERNAL_CLOUD_FRONT_DISTRIBUTION");
diff --git a/src/main/java/no/sikt/generator/OpenApiCombiner.java b/src/main/java/no/sikt/generator/OpenApiCombiner.java
index e668bf3..d6a5f5d 100644
--- a/src/main/java/no/sikt/generator/OpenApiCombiner.java
+++ b/src/main/java/no/sikt/generator/OpenApiCombiner.java
@@ -12,7 +12,6 @@
 import io.swagger.v3.oas.models.PathItem;
 import io.swagger.v3.oas.models.media.Schema;
 import io.swagger.v3.oas.models.parameters.Parameter;
-import io.swagger.v3.oas.models.security.SecurityRequirement;
 import io.swagger.v3.oas.models.security.SecurityScheme;
 import io.swagger.v3.oas.models.servers.Server;
 import java.util.Collection;
@@ -118,8 +117,8 @@ private void removeTags(OpenAPI api) {
 
     private void mergeSecurity(OpenAPI api) {
         if (nonNull(api.getSecurity())) {
-            for (SecurityRequirement securityRequirement : api.getSecurity()) {
-                logger.info("adding security req {}", securityRequirement.toString());
+            for (var securityRequirement : api.getSecurity()) {
+                logger.info("adding security req {}", securityRequirement);
                 this.baseTemplate.addSecurityItem(securityRequirement);
             }
         }
diff --git a/src/main/java/no/sikt/generator/OpenApiExtractor.java b/src/main/java/no/sikt/generator/OpenApiExtractor.java
index abaf7de..7971e59 100644
--- a/src/main/java/no/sikt/generator/OpenApiExtractor.java
+++ b/src/main/java/no/sikt/generator/OpenApiExtractor.java
@@ -7,7 +7,6 @@
 import io.swagger.v3.oas.models.media.Schema;
 import java.util.HashMap;
 import java.util.List;
-import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Set;
 import org.slf4j.Logger;
@@ -34,7 +33,7 @@ private void removeUnusedSchemas(OpenAPI openAPI) {
         var usedSchemas = getUsedSchemas(openAPI);
         var allSchemas = schemas.keySet();
 
-        Map<String, Schema> newSchemas = new HashMap();
+        var newSchemas = new HashMap<String, Schema>();
 
         allSchemas.forEach(key -> {
             var value = schemas.get(key);
diff --git a/src/main/java/no/sikt/generator/OpenApiUtils.java b/src/main/java/no/sikt/generator/OpenApiUtils.java
index e708227..bb9ff9e 100644
--- a/src/main/java/no/sikt/generator/OpenApiUtils.java
+++ b/src/main/java/no/sikt/generator/OpenApiUtils.java
@@ -2,7 +2,6 @@
 
 import static java.util.Objects.nonNull;
 import static java.util.stream.Collectors.toSet;
-import static java.util.stream.Stream.concat;
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.Operation;
 import io.swagger.v3.oas.models.PathItem;
@@ -96,12 +95,12 @@ public static List<Schema> getNestedSchemas(OpenAPI openAPI, Schema schema) {
     public static List<Schema> getNestedSchemas(OpenAPI openAPI, List<Schema> visited, Schema schema) {
         var nestedSchemas = Stream.of(
             Stream.of(schema.getItems()),
-            OpenApiUtils.getReffedSchema(openAPI, schema),
-            OpenApiUtils.getNestedAllOfSchemas(schema),
-            OpenApiUtils.getNestedAnyOfSchemas(schema),
-            OpenApiUtils.getNestedOneOfSchemas(schema),
-            OpenApiUtils.getNestedPropertiesSchemas(schema),
-            OpenApiUtils.getAdditionalPropertiesSchemas(schema)
+            getReffedSchema(openAPI, schema),       
+            getNestedAllOfSchemas(schema),
+            getNestedAnyOfSchemas(schema),
+            getNestedOneOfSchemas(schema),
+            getNestedPropertiesSchemas(schema),
+            getAdditionalPropertiesSchemas(schema)
         ).flatMap(stream -> stream).filter(Objects::nonNull).toList();
 
         var newSchemas = nestedSchemas.stream().filter(ns -> !visited.contains(ns)).collect(toSet());
@@ -116,7 +115,8 @@ public static List<Schema> getNestedSchemas(OpenAPI openAPI, List<Schema> visite
 
     private static Stream<Schema> getReffedSchema(OpenAPI openAPI, Schema schema) {
         if (nonNull(schema.get$ref()) && schema.get$ref().startsWith(COMPONENTS_SCHEMAS)) {
-            return Stream.of(openAPI.getComponents().getSchemas().get(StringUtils.stripStart(schema.get$ref(), COMPONENTS_SCHEMAS)));
+            return Stream.of(openAPI.getComponents()
+                                 .getSchemas().get(StringUtils.stripStart(schema.get$ref(), COMPONENTS_SCHEMAS)));
         } else {
             return Stream.of();
         }
diff --git a/src/main/java/no/sikt/generator/handlers/GenerateDocsHandler.java b/src/main/java/no/sikt/generator/handlers/GenerateDocsHandler.java
index baa7f14..f8a6e89 100644
--- a/src/main/java/no/sikt/generator/handlers/GenerateDocsHandler.java
+++ b/src/main/java/no/sikt/generator/handlers/GenerateDocsHandler.java
@@ -54,15 +54,18 @@ public GenerateDocsHandler() {
                                               .retryPolicy(retryPolicy)
                                               .build();
 
-        var apiGatewayClient =
-            ApiGatewayAsyncClient.builder().overrideConfiguration(clientOverrideConfiguration).build();
-        var cloudFrontClient = CloudFrontClient.builder()
+        try (
+            var apiGatewayClient =
+                ApiGatewayAsyncClient.builder().overrideConfiguration(clientOverrideConfiguration).build()) {
+            this.apiGatewayHighLevelClient = new ApiGatewayHighLevelClient(apiGatewayClient);
+        }
+
+        try (var cloudFrontClient = CloudFrontClient.builder()
                                    .httpClient(UrlConnectionHttpClient.builder().build())
                                    .region(AWS_GLOBAL)
-                                   .build();
-
-        this.apiGatewayHighLevelClient = new ApiGatewayHighLevelClient(apiGatewayClient);
-        this.cloudFrontHighLevelClient = new CloudFrontHighLevelClient(cloudFrontClient);
+                                   .build()) {
+            this.cloudFrontHighLevelClient = new CloudFrontHighLevelClient(cloudFrontClient);
+        }
         this.s3ClientInput = S3Driver.defaultS3Client().build();
         this.s3ClientOutput = S3Driver.defaultS3Client().build();
     }
diff --git a/src/main/java/no/sikt/generator/handlers/GenerateExternalDocsHandler.java b/src/main/java/no/sikt/generator/handlers/GenerateExternalDocsHandler.java
index 450f253..92f61a8 100644
--- a/src/main/java/no/sikt/generator/handlers/GenerateExternalDocsHandler.java
+++ b/src/main/java/no/sikt/generator/handlers/GenerateExternalDocsHandler.java
@@ -68,14 +68,15 @@ public void handleRequest(InputStream input, OutputStream output, Context contex
         cloudFrontHighLevelClient.invalidateAll(EXTERNAL_CLOUD_FRONT_DISTRIBUTION);
     }
 
-    private Stream<ApiData> validateAndFilterApis(GetRestApisResponse apis, List<Pair<S3Object, OpenAPI>> templateOpenapiDocs) {
+    private Stream<ApiData> validateAndFilterApis(GetRestApisResponse apis,
+                                                  List<Pair<S3Object, OpenAPI>> templateOpenapiDocs) {
         return apis.items().stream()
                    .map(this::fetchProdApiData)
                    .filter(Objects::nonNull)
                    .filter(this::apiShouldBeIncluded)
                    .peek(apiData -> openApiValidator.validateOpenApi(apiData.getOpenapi()))
                    .peek(apiData -> apiData.setMatchingGithubOpenapi(templateOpenapiDocs))
-                   .map(ApiData::setEmptySchemasIfNull)
+                   .map(ApiData::applyEmptySchemasIfNull)
                    .map(ApiData::overridePropsFromGithub)
                    .sorted(ApiData::sortByDate)
                    .sorted(ApiData::sortByDashes)
diff --git a/src/main/java/no/sikt/generator/handlers/GenerateInternalDocsHandler.java b/src/main/java/no/sikt/generator/handlers/GenerateInternalDocsHandler.java
index 9754424..6d6e137 100644
--- a/src/main/java/no/sikt/generator/handlers/GenerateInternalDocsHandler.java
+++ b/src/main/java/no/sikt/generator/handlers/GenerateInternalDocsHandler.java
@@ -66,14 +66,15 @@ public void handleRequest(InputStream input, OutputStream output, Context contex
         cloudFrontHighLevelClient.invalidateAll(INTERNAL_CLOUD_FRONT_DISTRIBUTION);
     }
 
-    private Stream<ApiData> validateAndFilterApis(GetRestApisResponse apis, List<Pair<S3Object, OpenAPI>> templateOpenapiDocs) {
+    private Stream<ApiData> validateAndFilterApis(GetRestApisResponse apis,
+                                                  List<Pair<S3Object, OpenAPI>> templateOpenapiDocs) {
         return apis.items().stream()
                    .map(this::fetchProdApiData)
                    .filter(Objects::nonNull)
                    .filter(this::apiShouldBeIncluded)
                    .peek(apiData -> openApiValidator.validateOpenApi(apiData.getOpenapi()))
                    .peek(apiData -> apiData.setMatchingGithubOpenapi(templateOpenapiDocs))
-                   .map(ApiData::setEmptySchemasIfNull)
+                   .map(ApiData::applyEmptySchemasIfNull)
                    .map(ApiData::overridePropsFromGithub)
                    .sorted(ApiData::sortByDate)
                    .sorted(ApiData::sortByDashes)
diff --git a/src/main/java/no/sikt/generator/handlers/PublishDocumentationsHandler.java b/src/main/java/no/sikt/generator/handlers/PublishDocumentationsHandler.java
index ed287c9..2e50bc1 100644
--- a/src/main/java/no/sikt/generator/handlers/PublishDocumentationsHandler.java
+++ b/src/main/java/no/sikt/generator/handlers/PublishDocumentationsHandler.java
@@ -41,10 +41,11 @@ public PublishDocumentationsHandler() {
                          .retryPolicy(retryPolicy)
                          .build();
 
-        var apiGatewayClient =
-            ApiGatewayAsyncClient.builder().overrideConfiguration(clientOverrideConfiguration).build();
+        try (var apiGatewayClient =
+                 ApiGatewayAsyncClient.builder().overrideConfiguration(clientOverrideConfiguration).build()) {
 
-        this.apiGatewayHighLevelClient = new ApiGatewayHighLevelClient(apiGatewayClient);
+            this.apiGatewayHighLevelClient = new ApiGatewayHighLevelClient(apiGatewayClient);
+        }
     }
 
     public PublishDocumentationsHandler(ApiGatewayHighLevelClient apiGatewayHighLevelClient) {
diff --git a/src/test/java/no/sikt/generator/handlers/GenerateInternalDocsHandlerTest.java b/src/test/java/no/sikt/generator/handlers/GenerateInternalDocsHandlerTest.java
index 9dd7877..ccdd601 100644
--- a/src/test/java/no/sikt/generator/handlers/GenerateInternalDocsHandlerTest.java
+++ b/src/test/java/no/sikt/generator/handlers/GenerateInternalDocsHandlerTest.java
@@ -284,7 +284,8 @@ public void shouldOverrideStyleIfSetInGithubOpenapi() {
         handler.handleRequest(null, null, null);
         var openApi = readGeneratedOpenApi();
         var parameter =
-            openApi.getPaths().get("/publication/{publicationIdentifier}").getGet().getParameters().stream().filter(param -> param.getName().equals("doNotRedirect")).findFirst().get();
+            openApi.getPaths().get("/publication/{publicationIdentifier}").getGet().getParameters().stream()
+                .filter(param -> param.getName().equals("doNotRedirect")).findFirst().get();
 
         assertThat(parameter.getStyle(), is(equalTo(StyleEnum.FORM)));
         assertThat(parameter.getExplode(), is(equalTo(false)));
diff --git a/src/test/java/no/sikt/generator/handlers/TestUtils.java b/src/test/java/no/sikt/generator/handlers/TestUtils.java
index 0ae88fc..6c27d04 100644
--- a/src/test/java/no/sikt/generator/handlers/TestUtils.java
+++ b/src/test/java/no/sikt/generator/handlers/TestUtils.java
@@ -74,8 +74,8 @@ private static RestApi buildRestApiFromTestCase(TestCase testCase) {
     public static void loadGithubOpenapiFile(S3Driver s3Driver, TestCase testCase) {
         if (testCase.getContentGithub().isPresent()) {
             Try.attempt(() ->
-                            s3Driver.insertFile(UnixPath.of(String.valueOf(Path.of(testCase.getId() + ".yaml")))
-                                , testCase.getContentGithub().get())
+                            s3Driver.insertFile(UnixPath.of(String.valueOf(Path.of(testCase.getId() + ".yaml"))),
+                                                testCase.getContentGithub().get())
             );
         }
     }
@@ -87,7 +87,8 @@ public static void setupTestcasesFromFiles(S3Client s3Client,
                                                List<Pair<String, Optional<String>>> fileNames) {
         var filePrefix = "openapi_docs/" + ((isNull(folder)) ? "" : folder + "/");
         var testCases = fileNames.stream().map(fileName -> loadTestCase(filePrefix + fileName.getLeft(),
-                                                                        fileName.getRight().map(fn -> filePrefix + fn)) ).toList();
+                                                                        fileName.getRight()
+                                                                            .map(fn -> filePrefix + fn))).toList();
 
         var s3driver = new S3Driver(s3Client, readOpenApiBucketName());
         testCases.forEach(tc -> loadGithubOpenapiFile(s3driver, tc));