feat: Added DependencyVersionHelper for finding the latest release version for a given dependency

Author: szymonsadowski3

applications/spring-shell/src/test/java/org/springframework/sbm/helpers/DependencyVersionHelper.java

@@ -0,0 +1,97 @@
+/*
+ * Copyright 2021 - 2022 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.sbm.helpers;
+
+import net.minidev.json.JSONArray;
+import net.minidev.json.JSONObject;
+import net.minidev.json.parser.JSONParser;
+import net.minidev.json.parser.ParseException;
+import org.springframework.web.client.RestClientException;
+import org.springframework.web.client.RestTemplate;
+
+import java.text.MessageFormat;
+import java.util.Optional;
+
+
+/**
+ * Test helper that provides various information about the dependencies.
+ */
+public class DependencyVersionHelper {
+    public static final String MAVEN_DEPENDENCY_SEARCH_URL_TEMPLATE =
+            "https://search.maven.org/solrsearch/select?q=g:\"{0}\"+AND+a:\"{1}\"&rows=1&wt=json";
+    public static final String RESPONSE_JSON_KEY = "response";
+    public static final String DOCS_JSON_KEY = "docs";
+    public static final String LATEST_VERSION_JSON_KEY = "latestVersion";
+
+    /**
+     * Finds the latest release version for a given dependency.
+     * @param groupId GroupId of a sought dependency.
+     * @param artifactId ArtifactId of a sought dependency.
+     * @return Optional string with the version number of the latest release for a given dependency
+     * if the search was successful. Empty optional if the search was not successful.
+     */
+    public static Optional<String> getLatestReleaseVersion(String groupId, String artifactId) {
+        final RestTemplate restTemplate = new RestTemplate();
+
+        String url = MessageFormat.format(
+                MAVEN_DEPENDENCY_SEARCH_URL_TEMPLATE,
+                groupId,
+                artifactId
+        );
+
+        final String response;
+
+        try {
+            response = restTemplate.getForObject(url, String.class);
+        } catch(RestClientException restClientException) {
+            return Optional.empty();
+        }
+
+
+        JSONObject json;
+
+        try {
+            json = new JSONParser(JSONParser.MODE_PERMISSIVE).parse(response, JSONObject.class);
+        } catch(ParseException jsonException) {
+            return Optional.empty();
+        }
+
+
+        if (!json.containsKey(RESPONSE_JSON_KEY)) {
+            return Optional.empty();
+        }
+
+        JSONObject responseSection = (JSONObject) json.get(RESPONSE_JSON_KEY);
+
+        if(!responseSection.containsKey(DOCS_JSON_KEY)) {
+            return Optional.empty();
+        }
+
+        JSONArray docs = (JSONArray) responseSection.get(DOCS_JSON_KEY);
+
+        if (docs.size() == 0) {
+            return Optional.empty();
+        }
+
+        JSONObject docEntry = (JSONObject) docs.get(0);
+
+        if(!docEntry.containsKey(LATEST_VERSION_JSON_KEY)) {
+            return Optional.empty();
+        }
+
+        return Optional.of(docEntry.getAsString(LATEST_VERSION_JSON_KEY));
+    }
+}