spring InteractiveUpgradeResolver 源码

springboot InteractiveUpgradeResolver 代码

文件路径：/buildSrc/src/main/java/org/springframework/boot/build/bom/bomr/InteractiveUpgradeResolver.java

/*
 * Copyright 2012-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.boot.build.bom.bomr;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.SortedSet;
import java.util.stream.Collectors;

import org.apache.maven.artifact.versioning.DefaultArtifactVersion;
import org.gradle.api.InvalidUserDataException;
import org.gradle.api.internal.tasks.userinput.UserInputHandler;

import org.springframework.boot.build.bom.Library;
import org.springframework.boot.build.bom.Library.DependencyVersions;
import org.springframework.boot.build.bom.Library.Group;
import org.springframework.boot.build.bom.Library.Module;
import org.springframework.boot.build.bom.Library.ProhibitedVersion;
import org.springframework.boot.build.bom.Library.VersionAlignment;
import org.springframework.boot.build.bom.UpgradePolicy;
import org.springframework.boot.build.bom.bomr.version.DependencyVersion;
import org.springframework.util.StringUtils;

/**
 * Interactive {@link UpgradeResolver} that uses command line input to choose the upgrades
 * to apply.
 *
 * @author Andy Wilkinson
 */
public final class InteractiveUpgradeResolver implements UpgradeResolver {

	private final VersionResolver versionResolver;

	private final UpgradePolicy upgradePolicy;

	private final UserInputHandler userInputHandler;

	InteractiveUpgradeResolver(VersionResolver versionResolver, UpgradePolicy upgradePolicy,
			UserInputHandler userInputHandler) {
		this.versionResolver = versionResolver;
		this.upgradePolicy = upgradePolicy;
		this.userInputHandler = userInputHandler;
	}

	@Override
	public List<Upgrade> resolveUpgrades(Collection<Library> librariesToUpgrade, Collection<Library> libraries) {
		Map<String, Library> librariesByName = new HashMap<>();
		for (Library library : libraries) {
			librariesByName.put(library.getName(), library);
		}
		return librariesToUpgrade.stream().filter((library) -> !library.getName().equals("Spring Boot"))
				.map((library) -> resolveUpgrade(library, librariesByName)).filter(Objects::nonNull)
				.collect(Collectors.toList());
	}

	private Upgrade resolveUpgrade(Library library, Map<String, Library> libraries) {
		List<VersionOption> versionOptions = getVersionOptions(library, libraries);
		if (versionOptions.isEmpty()) {
			return null;
		}
		VersionOption current = new VersionOption(library.getVersion().getVersion());
		VersionOption selected = this.userInputHandler
				.selectOption(library.getName() + " " + library.getVersion().getVersion(), versionOptions, current);
		return (selected.equals(current)) ? null : new Upgrade(library, selected.version);
	}

	private List<VersionOption> getVersionOptions(Library library, Map<String, Library> libraries) {
		if (library.getVersion().getVersionAlignment() != null) {
			return determineAlignedVersionOption(library, libraries);
		}
		return determineResolvedVersionOptions(library);
	}

	private List<VersionOption> determineResolvedVersionOptions(Library library) {
		Map<String, SortedSet<DependencyVersion>> moduleVersions = new LinkedHashMap<>();
		DependencyVersion libraryVersion = library.getVersion().getVersion();
		for (Group group : library.getGroups()) {
			for (Module module : group.getModules()) {
				moduleVersions.put(group.getId() + ":" + module.getName(),
						getLaterVersionsForModule(group.getId(), module.getName(), libraryVersion));
			}
			for (String bom : group.getBoms()) {
				moduleVersions.put(group.getId() + ":" + bom,
						getLaterVersionsForModule(group.getId(), bom, libraryVersion));
			}
			for (String plugin : group.getPlugins()) {
				moduleVersions.put(group.getId() + ":" + plugin,
						getLaterVersionsForModule(group.getId(), plugin, libraryVersion));
			}
		}
		List<DependencyVersion> allVersions = moduleVersions.values().stream().flatMap(SortedSet::stream).distinct()
				.filter((dependencyVersion) -> isPermitted(dependencyVersion, library.getProhibitedVersions()))
				.collect(Collectors.toList());
		if (allVersions.isEmpty()) {
			return Collections.emptyList();
		}
		return allVersions.stream()
				.map((version) -> new ResolvedVersionOption(version, getMissingModules(moduleVersions, version)))
				.collect(Collectors.toList());
	}

	private List<VersionOption> determineAlignedVersionOption(Library library, Map<String, Library> libraries) {
		VersionOption alignedVersionOption = alignedVersionOption(library, libraries);
		if (alignedVersionOption == null) {
			return Collections.emptyList();
		}
		if (!isPermitted(alignedVersionOption.version, library.getProhibitedVersions())) {
			throw new InvalidUserDataException("Version alignment failed. Version " + alignedVersionOption.version
					+ " from " + library.getName() + " is prohibited");
		}
		return Collections.singletonList(alignedVersionOption);
	}

	private VersionOption alignedVersionOption(Library library, Map<String, Library> libraries) {
		VersionAlignment versionAlignment = library.getVersion().getVersionAlignment();
		Library alignmentLibrary = libraries.get(versionAlignment.getLibraryName());
		DependencyVersions dependencyVersions = alignmentLibrary.getDependencyVersions();
		if (dependencyVersions == null) {
			throw new InvalidUserDataException("Cannot align with library '" + versionAlignment.getLibraryName()
					+ "' as it does not define any dependency versions");
		}
		if (!dependencyVersions.available()) {
			return null;
		}
		Set<String> versions = new HashSet<>();
		for (Group group : library.getGroups()) {
			for (Module module : group.getModules()) {
				String version = dependencyVersions.getVersion(group.getId(), module.getName());
				if (version != null) {
					versions.add(version);
				}
			}
		}
		if (versions.isEmpty()) {
			throw new InvalidUserDataException("Cannot align with library '" + versionAlignment.getLibraryName()
					+ "' as its dependency versions do not include any of this library's modules");
		}
		if (versions.size() > 1) {
			throw new InvalidUserDataException("Cannot align with library '" + versionAlignment.getLibraryName()
					+ "' as it uses multiple different versions of this library's modules");
		}
		DependencyVersion version = DependencyVersion.parse(versions.iterator().next());
		return library.getVersion().getVersion().equals(version) ? null
				: new AlignedVersionOption(version, alignmentLibrary);
	}

	private boolean isPermitted(DependencyVersion dependencyVersion, List<ProhibitedVersion> prohibitedVersions) {
		if (prohibitedVersions.isEmpty()) {
			return true;
		}
		for (ProhibitedVersion prohibitedVersion : prohibitedVersions) {
			if (prohibitedVersion.getRange()
					.containsVersion(new DefaultArtifactVersion(dependencyVersion.toString()))) {
				return false;
			}
		}
		return true;
	}

	private List<String> getMissingModules(Map<String, SortedSet<DependencyVersion>> moduleVersions,
			DependencyVersion version) {
		List<String> missingModules = new ArrayList<>();
		moduleVersions.forEach((name, versions) -> {
			if (!versions.contains(version)) {
				missingModules.add(name);
			}
		});
		return missingModules;
	}

	private SortedSet<DependencyVersion> getLaterVersionsForModule(String groupId, String artifactId,
			DependencyVersion currentVersion) {
		SortedSet<DependencyVersion> versions = this.versionResolver.resolveVersions(groupId, artifactId);
		versions.removeIf((candidate) -> !this.upgradePolicy.test(candidate, currentVersion));
		return versions;
	}

	private static class VersionOption {

		private final DependencyVersion version;

		protected VersionOption(DependencyVersion version) {
			this.version = version;
		}

		@Override
		public String toString() {
			return this.version.toString();
		}

	}

	private static final class AlignedVersionOption extends VersionOption {

		private final Library alignedWith;

		private AlignedVersionOption(DependencyVersion version, Library alignedWith) {
			super(version);
			this.alignedWith = alignedWith;
		}

		@Override
		public String toString() {
			return super.toString() + " (aligned with " + this.alignedWith.getName() + " "
					+ this.alignedWith.getVersion().getVersion() + ")";
		}

	}

	private static final class ResolvedVersionOption extends VersionOption {

		private final List<String> missingModules;

		private ResolvedVersionOption(DependencyVersion version, List<String> missingModules) {
			super(version);
			this.missingModules = missingModules;
		}

		@Override
		public String toString() {
			if (this.missingModules.isEmpty()) {
				return super.toString();
			}
			return super.toString() + " (some modules are missing: "
					+ StringUtils.collectionToDelimitedString(this.missingModules, ", ") + ")";
		}

	}

}

相关信息

spring 源码目录

相关文章

spring MavenMetadataVersionResolver 源码

spring Upgrade 源码

spring UpgradeApplicator 源码

spring UpgradeBom 源码

spring UpgradeResolver 源码

spring VersionResolver 源码