Ensure spock 2/nebula-test 10 tests actually run #1929
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| type: fix | ||
| fix: | ||
| description: Ensure nebula-test 10/Spock 2 test run by automatically setting `useJUnitPlatform()` | ||
| on test tasks. Add extra verification to the `checkJUnitDependencies` task for | ||
| nebula-test 10/Spock 2 tests. | ||
| links: | ||
| - https://github.com/palantir/gradle-baseline/pull/1929 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,18 +16,20 @@ | |
|
|
||
| package com.palantir.baseline.plugins; | ||
|
|
||
| import com.google.common.base.Predicate; | ||
| import com.google.common.collect.ImmutableSet; | ||
| import com.palantir.baseline.tasks.CheckJUnitDependencies; | ||
| import com.palantir.baseline.tasks.CheckUnusedDependenciesTask; | ||
| import com.palantir.baseline.util.VersionUtils; | ||
| import java.util.Objects; | ||
| import java.util.Optional; | ||
| import org.gradle.api.Plugin; | ||
| import org.gradle.api.Project; | ||
| import org.gradle.api.Task; | ||
| import org.gradle.api.artifacts.component.ModuleComponentIdentifier; | ||
| import org.gradle.api.artifacts.result.ResolvedComponentResult; | ||
| import org.gradle.api.plugins.JavaPlugin; | ||
| import org.gradle.api.plugins.JavaPluginConvention; | ||
| import org.gradle.api.tasks.SourceSet; | ||
| import org.gradle.api.tasks.TaskContainer; | ||
| import org.gradle.api.tasks.TaskProvider; | ||
|
|
@@ -61,38 +63,44 @@ public void apply(Project project) { | |
| }); | ||
|
|
||
| project.getPlugins().withType(JavaPlugin.class, unusedPlugin -> { | ||
| TaskProvider<CheckJUnitDependencies> checkJUnitDependencies = | ||
| project.getTasks().register("checkJUnitDependencies", CheckJUnitDependencies.class); | ||
|
|
||
| project.getConvention() | ||
| .getPlugin(JavaPluginConvention.class) | ||
| .getSourceSets() | ||
| .configureEach(sourceSet -> { | ||
| getTestTaskForSourceSet(project, sourceSet).ifPresent(testTask -> { | ||
| testTask.dependsOn(checkJUnitDependencies); | ||
| }); | ||
|
|
||
| ifHasResolvedCompileDependenciesMatching( | ||
| project, | ||
| sourceSet, | ||
| BaselineTesting::requiresJunitPlatform, | ||
| () -> fixSourceSet(project, sourceSet)); | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| private void fixSourceSet(Project project, SourceSet ss) { | ||
| Optional<Test> maybeTestTask = getTestTaskForSourceSet(project, ss); | ||
| if (!maybeTestTask.isPresent()) { | ||
| log.warn("Detected 'org:junit.jupiter:junit-jupiter', but unable to find test task"); | ||
| return; | ||
| } | ||
| log.info( | ||
| "Detected 'org:junit.jupiter:junit-jupiter', enabling useJUnitPlatform() on {}", | ||
| maybeTestTask.get().getName()); | ||
| enableJunit5ForTestTask(maybeTestTask.get()); | ||
|
|
||
| // Also wire up a test ignore for this source set | ||
| project.getPlugins().withType(BaselineExactDependencies.class, exactDeps -> { | ||
| TaskContainer tasks = project.getTasks(); | ||
| tasks.named( | ||
| BaselineExactDependencies.checkUnusedDependenciesNameForSourceSet(ss), | ||
| CheckUnusedDependenciesTask.class, | ||
| task -> task.ignore("org.junit.jupiter", "junit-jupiter")); | ||
| }); | ||
| } | ||
|
|
||
|
|
@@ -112,20 +120,32 @@ public static Optional<Test> getTestTaskForSourceSet(Project proj, SourceSet ss) | |
| return Optional.empty(); | ||
| } | ||
|
|
||
| private static void ifHasResolvedCompileDependenciesMatching( | ||
| Project project, SourceSet sourceSet, Predicate<ModuleComponentIdentifier> spec, Runnable runnable) { | ||
| project.getConfigurations() | ||
| .getByName(sourceSet.getRuntimeClasspathConfigurationName()) | ||
| .getIncoming() | ||
| .afterResolve(deps -> { | ||
|
There was a problem hiding this comment. Since we need to distinguish between Spock 1 and Spock 2, we need to actually resolve the configuration to get a version number. It's actually quite tricky to resolve here, as it fails foul of the checks we have to prevent resolving configuration at configuration time, which destroys perf. Instead, we wait for this configuration to resolved, which will happen before the test is run, by the (This would be so much easier if There was a problem hiding this comment. I was initially thinking that it might be sufficient to just go through the explicitly declared deps which would not require resolution. However most of the time Spock is brought in as a transitive and so you have to do resolution :( There was a problem hiding this comment. I initially did that and checked for nebula-test too, but until resolution happens you don't know the version number, so can't decide whether or not to do the right thing |
||
| boolean anyMatch = deps.getResolutionResult().getAllComponents().stream() | ||
| .map(ResolvedComponentResult::getId) | ||
| .filter(componentId -> componentId instanceof ModuleComponentIdentifier) | ||
| .map(componentId -> (ModuleComponentIdentifier) componentId) | ||
| .anyMatch(spec); | ||
|
|
||
| if (anyMatch) { | ||
| runnable.run(); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| private static boolean requiresJunitPlatform(ModuleComponentIdentifier dep) { | ||
| return isDep(dep, "org.junit.jupiter", "junit-jupiter") | ||
| || (isDep(dep, "org.spockframework", "spock-core") | ||
| && VersionUtils.majorVersionNumber(dep.getVersion()) >= 2); | ||
| } | ||
|
|
||
| private static boolean isDep(ModuleComponentIdentifier dep, String group, String name) { | ||
| return group.equals(dep.getGroup()) && name.equals(dep.getModule()); | ||
| } | ||
|
|
||
| private static void enableJunit5ForTestTask(Test task) { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| /* | ||
| * (c) Copyright 2021 Palantir Technologies Inc. All rights reserved. | ||
| * | ||
| * 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 | ||
| * | ||
| * http://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 com.palantir.baseline.util; | ||
|
|
||
| import com.google.common.base.Splitter; | ||
| import org.gradle.api.GradleException; | ||
|
|
||
| public final class VersionUtils { | ||
| public static int majorVersionNumber(String version) { | ||
| return Integer.parseInt(Splitter.on('.') | ||
| .splitToStream(version) | ||
| .findFirst() | ||
| .orElseThrow(() -> new GradleException("Cannot find major version number for version " + version))); | ||
| } | ||
|
|
||
| private VersionUtils() {} | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should use the
JavaPluginExtensionas conventions are deprecated and to be removed with Gradle 8.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried, but Gradle 6 doesn't have the
getSourceSetsmethod we need 118cb97There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah I remember encountering this before. I guess Gradle 7 is the bridge version then at with Gradle 8 we have to cut support for Gradle 6. Fine for now then!