Skip to content

Commit

Permalink
Working implementation
Browse files Browse the repository at this point in the history
  • Loading branch information
@marchermans
marchermans committed May 19, 2024
1 parent 3bf1819 commit b287ddc
Show file tree
Hide file tree
Showing 9 changed files with 206 additions and 82 deletions.
6 changes: 5 additions & 1 deletion common/src/main/java/net/neoforged/gradle/common/CommonProjectPlugin.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,12 @@ private void configureSourceSetConventions(Project project, Conventions conventi

ProjectUtils.afterEvaluate(project, () -> {
project.getExtensions().configure(RunsConstants.Extensions.RUNS, (Action<NamedDomainObjectContainer<Run>>) runs -> runs.configureEach(run -> {
if (sourceSets.getShouldMainSourceSetBeAutomaticallyAddedToRuns().get())
if (sourceSets.getShouldMainSourceSetBeAutomaticallyAddedToRuns().get()) {
//We always register main
run.getModSources().add(project.getExtensions().getByType(SourceSetContainer.class).getByName("main"));
if (run.getIsUnitTest().get())
run.getUnitTestSources().add(project.getExtensions().getByType(SourceSetContainer.class).getByName("test"));
}

if (sourceSets.getShouldSourceSetsLocalRunRuntimesBeAutomaticallyAddedToRuns().get() && configurations.getIsEnabled().get())
run.getModSources().get().forEach(sourceSet -> {
Expand Down
1 change: 1 addition & 0 deletions ...src/main/java/net/neoforged/gradle/common/extensions/subsystems/ConventionsExtension.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ public RunsExtension(WithEnabledProperty parent) {
super(parent, "runs");

getShouldDefaultRunsBeCreated().convention(getBooleanProperty("create-default-run-per-type").orElse(true));
getShouldDefaultTestTaskBeReused().convention(getBooleanProperty("reuse-default-test-task").orElse(true));
}
}

Expand Down
2 changes: 2 additions & 0 deletions common/src/main/java/net/neoforged/gradle/common/runs/run/RunImpl.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ public RunImpl(final Project project, final String name) {
getIsServer().convention(false);
getIsDataGenerator().convention(false);
getIsGameTest().convention(false);
getIsUnitTest().convention(false);
getShouldBuildAllProjects().convention(false);
getDependencies().convention(project.getObjects().newInstance(DependencyHandlerImpl.class, project));

Expand Down Expand Up @@ -163,6 +164,7 @@ public void configureInternally(final @NotNull RunType spec) {
getIsServer().convention(spec.getIsServer());
getIsDataGenerator().convention(spec.getIsDataGenerator());
getIsGameTest().convention(spec.getIsGameTest());
getIsUnitTest().convention(spec.getIsUnitTest());
getClasspath().from(spec.getClasspath());

if (spec.getRunAdapter().isPresent()) {
Expand Down
230 changes: 161 additions & 69 deletions common/src/main/java/net/neoforged/gradle/common/util/run/RunsUtil.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,57 +5,164 @@
import net.neoforged.gradle.common.runs.run.RunImpl;
import net.neoforged.gradle.common.runs.tasks.RunExec;
import net.neoforged.gradle.common.util.SourceSetUtils;
import net.neoforged.gradle.dsl.common.extensions.subsystems.Subsystems;
import net.neoforged.gradle.dsl.common.extensions.subsystems.conventions.Runs;
import net.neoforged.gradle.dsl.common.runs.idea.extensions.IdeaRunsExtension;
import net.neoforged.gradle.dsl.common.runs.run.Run;
import net.neoforged.gradle.util.StringCapitalizationUtils;
import org.gradle.api.Project;
import org.gradle.api.Task;
import org.gradle.api.file.ConfigurableFileCollection;
import org.gradle.api.plugins.ExtensionAware;
import org.gradle.api.provider.ListProperty;
import org.gradle.api.provider.Provider;
import org.gradle.api.tasks.SourceSet;
import org.gradle.api.tasks.SourceSetContainer;
import org.gradle.api.tasks.TaskProvider;
import org.gradle.api.tasks.testing.Test;
import org.gradle.plugins.ide.eclipse.model.EclipseModel;
import org.gradle.plugins.ide.idea.model.IdeaModel;

import javax.annotation.Nonnull;
import java.io.File;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.util.Collection;
import java.util.Set;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;

public class RunsUtil {

private RunsUtil() {
throw new IllegalStateException("Tried to create utility class!");
}

public static String createTaskName(final Run run) {
return createTaskName(run.getName());
}

public static String createTaskName(final String prefix, final Run run) {
return createTaskName(prefix, run.getName());
}

public static Run create(final Project project, final String name) {
final RunImpl run = project.getObjects().newInstance(RunImpl.class, project, name);

final TaskProvider<RunExec> runTask = project.getTasks().register(createTaskName(name), RunExec.class, runExec -> {
runExec.getRun().set(run);
project.afterEvaluate(evaluatedProject -> {
if (!run.getIsUnitTest().get()) {
//Create run exec tasks for all none unit test runs
project.getTasks().register(createTaskName(name), RunExec.class, runExec -> {
runExec.getRun().set(run);
addRunSourcesDependenciesToTask(runExec, run);

run.getTaskDependencies().forEach(runExec::dependsOn);
});
} else {
createOrReuseTestTask(project, name, run);
}
});

//Configure mod sources when needed
project.afterEvaluate(evaluatedProject -> {
//Create a combined provider for the mod and unit test sources
Provider<? extends Collection<SourceSet>> sourceSets = run.getModSources().map(modSources -> {
if (!run.getIsUnitTest().get())
//No Unit test sources for non unit test runs
return modSources;

//Combine mod sources with unit test sources
return Stream.concat(modSources.stream(), run.getUnitTestSources().get().stream()).collect(Collectors.toList());
});
//Set the mod classes environment variable
run.getEnvironmentVariables().put("MOD_CLASSES", buildGradleModClasses(sourceSets));
});

project.afterEvaluate(evaluatedProject -> runTask.configure(task -> {
addRunSourcesDependenciesToTask(task, run);

run.getTaskDependencies().forEach(task::dependsOn);
}));

run.getEnvironmentVariables().put("MOD_CLASSES", buildGradleModClasses(run.getModSources()));


return run;
}

private static void createOrReuseTestTask(Project project, String name, RunImpl run) {
final Set<SourceSet> currentProjectsModSources = run.getModSources().get()
.stream()
.filter(sourceSet -> SourceSetUtils.getProject(sourceSet).equals(project))
.collect(Collectors.toSet());

final Set<SourceSet> currentProjectsTestSources = run.getUnitTestSources().get()
.stream()
.filter(sourceSet -> SourceSetUtils.getProject(sourceSet).equals(project))
.collect(Collectors.toSet());

//If the run has only one mod source of this project, and one test source of this project, and these are the main and test sourcesets respectively,
//we can reuse the test task, if it is allowed.
if (
(currentProjectsModSources.size() == 1 && currentProjectsModSources.contains(project.getExtensions().getByType(SourceSetContainer.class).getByName("main")))
&&
(currentProjectsTestSources.size() == 1 && currentProjectsTestSources.contains(project.getExtensions().getByType(SourceSetContainer.class).getByName("test")))
) {
final Runs runsConventions = project.getExtensions().getByType(Subsystems.class).getConventions().getRuns();
if (runsConventions.getShouldDefaultTestTaskBeReused().get()) {
//Get the default test task
final TaskProvider<Test> testTask = project.getTasks().named("test", Test.class);
configureTestTAsk(project, testTask.get(), run);
return;
}
}

createNewTestTask(project, name, run);
}

private static void createNewTestTask(Project project, String name, RunImpl run) {
//Create a test task for unit tests
TaskProvider<Test> newTestTask = project.getTasks().register(createTaskName("test", name), Test.class, testTask -> {
configureTestTAsk(project, testTask, run);
});

project.getTasks().named("check", check -> check.dependsOn(newTestTask));
}

private static void configureTestTAsk(Project project, Test testTask, RunImpl run) {
addRunSourcesDependenciesToTask(testTask, run);
run.getTaskDependencies().forEach(testTask::dependsOn);

testTask.setWorkingDir(run.getWorkingDirectory().get());
testTask.getSystemProperties().putAll(run.getSystemProperties().get());

testTask.useJUnitPlatform();

testTask.setGroup("verification");

File argsFile = new File(testTask.getWorkingDir(), "test_args.txt");
testTask.doFirst("writeArgs", task -> {
if (!testTask.getWorkingDir().exists()) {
testTask.getWorkingDir().mkdirs();
}
try {
Files.write(argsFile.toPath(), run.getProgramArguments().get(), StandardCharsets.UTF_8);
} catch (IOException e) {
throw new RuntimeException(e);
}
});
testTask.systemProperty("fml.junit.argsfile", argsFile.getAbsolutePath());

testTask.getEnvironment().putAll(run.getEnvironmentVariables().get());
testTask.setJvmArgs(run.getJvmArguments().get());

testTask.setClasspath(testTask.getClasspath().filter(file -> Stream.concat(run.getModSources().get().stream(), run.getUnitTestSources().get().stream())
.noneMatch(sourceSet -> (sourceSet.getOutput().getResourcesDir() != null &&
sourceSet.getOutput().getResourcesDir().equals(file)) ||
sourceSet.getOutput().getClassesDirs().getFiles().contains(file)
)));

final ConfigurableFileCollection testClassesDirs = project.files();
for (SourceSet sourceSet : run.getUnitTestSources().get()) {
testClassesDirs.from(sourceSet.getOutput().getClassesDirs());
}

testTask.setTestClassesDirs(testClassesDirs);
}

public static void addRunSourcesDependenciesToTask(Task task, Run run) {
for (SourceSet sourceSet : run.getModSources().get()) {
final Project sourceSetProject = SourceSetUtils.getProject(sourceSet);
Expand All @@ -67,83 +174,68 @@ public static void addRunSourcesDependenciesToTask(Task task, Run run) {

//There might be additional tasks that are needed to configure and run a source set.
//Also run those
sourceSet.getOutput().getBuildDependencies().getDependencies(null)
.forEach(task::dependsOn);
sourceSet.getOutput().getBuildDependencies().getDependencies(null).forEach(task::dependsOn);
}
}

public static Provider<String> buildGradleModClasses(final ListProperty<SourceSet> sourceSetsProperty) {
return buildGradleModClasses(
sourceSetsProperty,
sourceSet -> Stream.concat(Stream.of(sourceSet.getOutput().getResourcesDir()), sourceSet.getOutput().getClassesDirs().getFiles().stream())
);

public static Provider<String> buildGradleModClasses(final Provider<? extends Collection<SourceSet>> sourceSetsProperty) {
return buildGradleModClasses(sourceSetsProperty, sourceSet -> Stream.concat(Stream.of(sourceSet.getOutput().getResourcesDir()), sourceSet.getOutput().getClassesDirs().getFiles().stream()));
}

public static Provider<String> buildRunWithIdeaModClasses(final ListProperty<SourceSet> sourceSetsProperty) {
return buildGradleModClasses(
sourceSetsProperty,
sourceSet -> {
final Project project = SourceSetUtils.getProject(sourceSet);
final IdeaModel rootIdeaModel = project.getRootProject().getExtensions().getByType(IdeaModel.class);
final IdeaRunsExtension ideaRunsExtension = ((ExtensionAware) rootIdeaModel
.getProject())
.getExtensions().getByType(IdeaRunsExtension.class);

if (ideaRunsExtension.getRunWithIdea().get()) {
final File parentDir = ideaRunsExtension.getOutDirectory().get().getAsFile();
final File sourceSetDir = new File(parentDir, getIntellijOutName(sourceSet));
return Stream.of(new File(sourceSetDir, "resources"), new File(sourceSetDir, "classes"));
}

return Stream.concat(Stream.of(sourceSet.getOutput().getResourcesDir()), sourceSet.getOutput().getClassesDirs().getFiles().stream());
}
);

public static Provider<String> buildRunWithIdeaModClasses(final Provider<? extends Collection<SourceSet>> sourceSetsProperty) {
return buildGradleModClasses(sourceSetsProperty, sourceSet -> {
final Project project = SourceSetUtils.getProject(sourceSet);
final IdeaModel rootIdeaModel = project.getRootProject().getExtensions().getByType(IdeaModel.class);
final IdeaRunsExtension ideaRunsExtension = ((ExtensionAware) rootIdeaModel.getProject()).getExtensions().getByType(IdeaRunsExtension.class);

if (ideaRunsExtension.getRunWithIdea().get()) {
final File parentDir = ideaRunsExtension.getOutDirectory().get().getAsFile();
final File sourceSetDir = new File(parentDir, getIntellijOutName(sourceSet));
return Stream.of(new File(sourceSetDir, "resources"), new File(sourceSetDir, "classes"));
}

return Stream.concat(Stream.of(sourceSet.getOutput().getResourcesDir()), sourceSet.getOutput().getClassesDirs().getFiles().stream());
});
}

@SuppressWarnings("UnstableApiUsage")
public static Provider<String> buildRunWithEclipseModClasses(final ListProperty<SourceSet> sourceSetsProperty) {
return buildGradleModClasses(
sourceSetsProperty,
sourceSet -> {
final Project project = SourceSetUtils.getProject(sourceSet);
final EclipseModel eclipseModel = project.getExtensions().getByType(EclipseModel.class);

final File conventionsDir = new File(project.getProjectDir(), "bin");
eclipseModel.getClasspath().getBaseSourceOutputDir().convention(project.provider(() -> conventionsDir));

final File parentDir = eclipseModel.getClasspath().getBaseSourceOutputDir().get();
final File sourceSetDir = new File(parentDir, sourceSet.getName());
return Stream.of(sourceSetDir);
}
);
return buildGradleModClasses(sourceSetsProperty, sourceSet -> {
final Project project = SourceSetUtils.getProject(sourceSet);
final EclipseModel eclipseModel = project.getExtensions().getByType(EclipseModel.class);

final File conventionsDir = new File(project.getProjectDir(), "bin");
eclipseModel.getClasspath().getBaseSourceOutputDir().convention(project.provider(() -> conventionsDir));

final File parentDir = eclipseModel.getClasspath().getBaseSourceOutputDir().get();
final File sourceSetDir = new File(parentDir, sourceSet.getName());
return Stream.of(sourceSetDir);
});
}

public static String getIntellijOutName(@Nonnull final SourceSet sourceSet) {
return sourceSet.getName().equals(SourceSet.MAIN_SOURCE_SET_NAME) ? "production" : sourceSet.getName();
}
public static Provider<String> buildGradleModClasses(final ListProperty<SourceSet> sourceSetsProperty, final Function<SourceSet, Stream<File>> directoryBuilder) {

public static Provider<String> buildGradleModClasses(final Provider<? extends Collection<SourceSet>> sourceSetsProperty, final Function<SourceSet, Stream<File>> directoryBuilder) {
return sourceSetsProperty.map(sourceSets -> {
final Multimap<String, SourceSet> sourceSetsByRunId = HashMultimap.create();
sourceSets.forEach(sourceSet -> sourceSetsByRunId.put(SourceSetUtils.getModIdentifier(sourceSet), sourceSet));

return sourceSetsByRunId.entries()
.stream().flatMap(entry -> directoryBuilder.apply(entry.getValue())
.map(directory -> String.format("%s%%%%%s", entry.getKey(), directory.getAbsolutePath())))
.collect(Collectors.joining(File.pathSeparator));

return sourceSetsByRunId.entries().stream().flatMap(entry -> directoryBuilder.apply(entry.getValue()).map(directory -> String.format("%s%%%%%s", entry.getKey(), directory.getAbsolutePath()))).collect(Collectors.joining(File.pathSeparator));
});
}

private static String createTaskName(final String runName) {
return createTaskName("run", runName);
}

private static String createTaskName(final String prefix, final String runName) {
final String conventionTaskName = runName.replaceAll("[^a-zA-Z0-9\\-_]", "");
if (conventionTaskName.startsWith("run")) {
return conventionTaskName;
}

return prefix + StringCapitalizationUtils.capitalize(conventionTaskName);
}
}
6 changes: 6 additions & 0 deletions ...main/groovy/net/neoforged/gradle/dsl/common/extensions/subsystems/conventions/Runs.groovy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,10 @@ interface Runs extends BaseDSLElement<Runs> {
*/
@DSLProperty
Property<Boolean> getShouldDefaultRunsBeCreated()

/**
* Whether or not the default test task should be reused.
*/
@DSLProperty
Property<Boolean> getShouldDefaultTestTaskBeReused();
}
23 changes: 23 additions & 0 deletions dsl/common/src/main/groovy/net/neoforged/gradle/dsl/common/runs/run/Run.groovy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,17 @@ interface Run extends BaseDSLElement<Run>, NamedDSLElement {
@Optional
abstract Property<Boolean> getIsServer();

/**
* Indicates if this run is a unit test run.
*
* @return {@code true} if this run is a unit test run; otherwise, {@code false}.
*/
@Input
@DSLProperty
@Optional
abstract Property<Boolean> getIsUnitTest();


/**
* Indicates if this run is a data generation run.
*
Expand Down Expand Up @@ -157,6 +168,18 @@ interface Run extends BaseDSLElement<Run>, NamedDSLElement {
@DSLProperty
abstract ListProperty<SourceSet> getModSources();

/**
* Defines the source sets that are used as a test.
* <p>
* For changing the mod identifier a source set belongs to see
* {@link net.neoforged.gradle.dsl.common.extensions.RunnableSourceSet#getModIdentifier RunnableSourceSet#getModIdentifier}.
*
* @return The source sets that are used as a mod.
*/
@Internal
@DSLProperty
abstract ListProperty<SourceSet> getUnitTestSources();

/**
* Gives access to the classpath for this run.
* Does not contain the full classpath since that is dependent on the actual run environment, but contains the additional classpath elements
Expand Down
Loading

0 comments on commit b287ddc

Please sign in to comment.