io.spring.initializr.actuate.info.DependencyRangesInfoContributor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of initializr-actuator Show documentation
JVM-based project generator
There is a newer version: 0.21.0
/*
 * Copyright 2012-2019 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 io.spring.initializr.actuate.info;

import java.util.LinkedHashMap;
import java.util.Map;

import io.spring.initializr.generator.version.Version;
import io.spring.initializr.generator.version.VersionRange;
import io.spring.initializr.metadata.Dependency;
import io.spring.initializr.metadata.InitializrMetadataProvider;

import org.springframework.boot.actuate.info.Info;
import org.springframework.boot.actuate.info.InfoContributor;
import org.springframework.util.ObjectUtils;

/**
 * An {@link InfoContributor} that exposes the actual ranges used by dependencies defined
 * in the project that have an explicit version (i.e. not relying on a bom).
 *
 * @author Stephane Nicoll
 */
public class DependencyRangesInfoContributor implements InfoContributor {

	private final InitializrMetadataProvider metadataProvider;

	public DependencyRangesInfoContributor(InitializrMetadataProvider metadataProvider) {
		this.metadataProvider = metadataProvider;
	}

	@Override
	public void contribute(Info.Builder builder) {
		Map details = new LinkedHashMap<>();
		this.metadataProvider.get().getDependencies().getAll().forEach((dependency) -> {
			if (dependency.getBom() == null) {
				contribute(details, dependency);
			}
		});
		if (!details.isEmpty()) {
			builder.withDetail("dependency-ranges", details);
		}
	}

	private void contribute(Map details, Dependency dependency) {
		if (!ObjectUtils.isEmpty(dependency.getMappings())) {
			Map dep = new LinkedHashMap<>();
			dependency.getMappings().forEach((it) -> {
				if (it.getRange() != null && it.getVersion() != null) {
					dep.put(it.getVersion(), it.getRange());
				}
			});
			if (!dep.isEmpty()) {
				if (dependency.getRange() == null) {
					boolean openRange = dep.values().stream().anyMatch((v) -> v.getHigherVersion() == null);
					if (!openRange) {
						Version higher = getHigher(dep);
						dep.put("managed", new VersionRange(higher));
					}
				}
				Map depInfo = new LinkedHashMap<>();
				dep.forEach((k, r) -> depInfo.put(k, "Spring Boot " + r));
				details.put(dependency.getId(), depInfo);
			}
		}
		else if (dependency.getVersion() != null && dependency.getRange() != null) {
			Map dep = new LinkedHashMap<>();
			String requirement = "Spring Boot " + dependency.getRange();
			dep.put(dependency.getVersion(), requirement);
			details.put(dependency.getId(), dep);
		}
	}

	private Version getHigher(Map dep) {
		Version higher = null;
		for (VersionRange versionRange : dep.values()) {
			Version candidate = versionRange.getHigherVersion();
			if (higher == null) {
				higher = candidate;
			}
			else if (candidate.compareTo(higher) > 0) {
				higher = candidate;
			}
		}
		return higher;
	}

}