org.openrewrite.java.Assertions Maven / Gradle / Ivy
Show all versions of rewrite-java Show documentation
/*
* Copyright 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.openrewrite.java;
import org.intellij.lang.annotations.Language;
import org.jspecify.annotations.Nullable;
import org.openrewrite.ExecutionContext;
import org.openrewrite.Parser;
import org.openrewrite.SourceFile;
import org.openrewrite.Tree;
import org.openrewrite.java.internal.JavaTypeCache;
import org.openrewrite.java.marker.JavaProject;
import org.openrewrite.java.marker.JavaSourceSet;
import org.openrewrite.java.marker.JavaVersion;
import org.openrewrite.java.search.FindMissingTypes;
import org.openrewrite.java.tree.J;
import org.openrewrite.java.tree.JavaSourceFile;
import org.openrewrite.test.*;
import java.nio.file.Path;
import java.util.*;
import java.util.function.Consumer;
import java.util.stream.Collectors;
import static org.openrewrite.test.SourceSpecs.dir;
@SuppressWarnings("unused")
public class Assertions {
private static final Map javaVersions = new HashMap<>();
private static final Map javaProjects = new HashMap<>();
private static final Map javaSourceSets = new HashMap<>();
private Assertions() {
}
static void customizeExecutionContext(ExecutionContext ctx) {
if (ctx.getMessage(JavaParser.SKIP_SOURCE_SET_TYPE_GENERATION) == null) {
ctx.putMessage(JavaParser.SKIP_SOURCE_SET_TYPE_GENERATION, true);
}
}
public static SourceFile validateTypes(SourceFile source, TypeValidation typeValidation) {
if (source instanceof JavaSourceFile) {
assertValidTypes(typeValidation, (JavaSourceFile) source);
}
return source;
}
private static void assertValidTypes(TypeValidation typeValidation, J sf) {
if (typeValidation.identifiers() || typeValidation.methodInvocations() || typeValidation.methodDeclarations() || typeValidation.classDeclarations() ||
typeValidation.constructorInvocations()) {
List missingTypeResults = FindMissingTypes.findMissingTypes(sf);
missingTypeResults = missingTypeResults.stream()
.filter(missingType -> {
if (missingType.getJ() instanceof J.Identifier) {
return typeValidation.identifiers();
} else if (missingType.getJ() instanceof J.ClassDeclaration) {
return typeValidation.classDeclarations();
} else if (missingType.getJ() instanceof J.MethodInvocation || missingType.getJ() instanceof J.MemberReference) {
return typeValidation.methodInvocations();
} else if (missingType.getJ() instanceof J.NewClass) {
return typeValidation.constructorInvocations();
} else if (missingType.getJ() instanceof J.MethodDeclaration) {
return typeValidation.methodDeclarations();
} else if (missingType.getJ() instanceof J.VariableDeclarations.NamedVariable) {
return typeValidation.variableDeclarations();
} else {
return true;
}
})
.collect(Collectors.toList());
if (!missingTypeResults.isEmpty()) {
throw new IllegalStateException("LST contains missing or invalid type information\n" + missingTypeResults.stream().map(v -> v.getPath() + "\n" + v.getPrintedTree())
.collect(Collectors.joining("\n\n")));
}
}
}
public static SourceSpecs java(@Language("java") @Nullable String before) {
return java(before, s -> {
});
}
private static final Parser.Builder javaParser = JavaParser.fromJavaVersion()
.classpath(JavaParser.runtimeClasspath())
.logCompilationWarningsAndErrors(true);
public static SourceSpecs java(@Language("java") @Nullable String before, Consumer> spec) {
SourceSpec java = new SourceSpec<>(
J.CompilationUnit.class, null, javaParser, before,
Assertions::validateTypes,
Assertions::customizeExecutionContext
);
acceptSpec(spec, java);
return java;
}
public static SourceSpecs java(@Language("java") @Nullable String before, @Language("java") @Nullable String after) {
return java(before, after, s -> {
});
}
public static SourceSpecs java(@Language("java") @Nullable String before, @Language("java") @Nullable String after,
Consumer> spec) {
SourceSpec java = new SourceSpec<>(J.CompilationUnit.class, null, javaParser, before,
Assertions::validateTypes,
Assertions::customizeExecutionContext).after(s -> after);
acceptSpec(spec, java);
return java;
}
private static void acceptSpec(Consumer> spec, SourceSpec java) {
Consumer userSuppliedAfterRecipe = java.getAfterRecipe();
java.afterRecipe(userSuppliedAfterRecipe::accept);
spec.accept(java);
}
public static SourceSpecs mavenProject(String project, Consumer> spec, SourceSpecs... sources) {
return dir(project, spec, sources);
}
public static SourceSpecs mavenProject(String project, SourceSpecs... sources) {
return mavenProject(project, spec -> project(spec, project), sources);
}
public static SourceSpecs srcMainJava(Consumer> spec, SourceSpecs... javaSources) {
return dir("src/main/java", spec, javaSources);
}
public static SourceSpecs srcMainJava(SourceSpecs... javaSources) {
return srcMainJava(spec -> sourceSet(spec, "main"), javaSources);
}
public static SourceSpecs srcMainResources(Consumer> spec, SourceSpecs... resources) {
return dir("src/main/resources", spec, resources);
}
public static SourceSpecs srcMainResources(SourceSpecs... resources) {
return srcMainResources(spec -> sourceSet(spec, "main"), resources);
}
public static SourceSpecs srcTestJava(Consumer> spec, SourceSpecs... javaSources) {
return dir("src/test/java", spec, javaSources);
}
public static SourceSpecs srcTestJava(SourceSpecs... javaSources) {
return srcTestJava(spec -> sourceSet(spec, "test"), javaSources);
}
public static SourceSpecs srcTestResources(Consumer> spec, SourceSpecs... resources) {
return dir("src/test/resources", spec, resources);
}
public static SourceSpecs srcTestResources(SourceSpecs... resources) {
return srcTestResources(spec -> sourceSet(spec, "test"), resources);
}
public static SourceSpecs srcSmokeTestJava(Consumer> spec, SourceSpecs... javaSources) {
return dir("src/smokeTest/java", spec, javaSources);
}
public static SourceSpecs srcSmokeTestJava(SourceSpecs... javaSources) {
return srcSmokeTestJava(spec -> sourceSet(spec, "smokeTest"), javaSources);
}
public static SourceSpec version(SourceSpec sourceSpec, int version) {
return sourceSpec.markers(javaVersion(version));
}
public static SourceSpecs version(SourceSpecs sourceSpec, int version) {
for (SourceSpec spec : sourceSpec) {
spec.markers(javaVersion(version));
}
return sourceSpec;
}
public static SourceSpec project(SourceSpec sourceSpec, String projectName) {
return sourceSpec.markers(javaProject(projectName));
}
public static SourceSpec sourceSet(SourceSpec sourceSpec, String sourceSet) {
sourceSpec.markers(javaSourceSet(sourceSet));
return sourceSpec;
}
public static UncheckedConsumer> addTypesToSourceSet(String sourceSetName, List extendsFrom, List classpath) {
return sourceFiles -> {
JavaSourceSet sourceSet = JavaSourceSet.build(sourceSetName, classpath, new JavaTypeCache(), false);
for (int i = 0; i < sourceFiles.size(); i++) {
SourceFile sourceFile = sourceFiles.get(i);
Optional maybeCurrentSourceSet = sourceFile.getMarkers().findFirst(JavaSourceSet.class);
if (!maybeCurrentSourceSet.isPresent() || !maybeCurrentSourceSet.get().getName().equals(sourceSetName)) {
continue;
}
sourceFiles.set(i, sourceFile.withMarkers(sourceFile.getMarkers().computeByType(sourceSet, (original, updated) -> updated)));
}
};
}
public static UncheckedConsumer> addTypesToSourceSet(String sourceSetName, List extendsFrom) {
return addTypesToSourceSet(sourceSetName, extendsFrom, Collections.emptyList());
}
public static UncheckedConsumer> addTypesToSourceSet(String sourceSetName) {
return addTypesToSourceSet(sourceSetName, Collections.emptyList(), Collections.emptyList());
}
public static JavaVersion javaVersion(int version) {
return javaVersions.computeIfAbsent(version, v ->
new JavaVersion(Tree.randomId(), "openjdk", "adoptopenjdk",
Integer.toString(v), Integer.toString(v)));
}
private static JavaProject javaProject(String projectName) {
return javaProjects.computeIfAbsent(projectName, name ->
new JavaProject(Tree.randomId(), name, null));
}
private static JavaSourceSet javaSourceSet(String sourceSet) {
return javaSourceSets.computeIfAbsent(sourceSet, name ->
new JavaSourceSet(Tree.randomId(), name, Collections.emptyList(), Collections.emptyMap()));
}
}