Introduce a build listener that can be disabled in case of conflict

Author: lacasseio

src/main/java/dev/nokee/init/NokeeInitPlugin.java

@@ -1,5 +1,6 @@
 package dev.nokee.init;
 
+import dev.nokee.init.internal.DisableableBuildListener;
 import dev.nokee.init.internal.NokeeInitBuildListener;
 import dev.nokee.init.internal.RegisterNokeeTaskAction;
 import dev.nokee.init.internal.versions.DefaultGradleVersionProvider;
@@ -28,7 +29,7 @@ protected NokeeInitPlugin() {
 	@Override
 	public void apply(Gradle gradle) {
 		if (MINIMUM_GRADLE_SUPPORTED.compareTo(gradleVersionProvider.get()) <= 0) {
-			gradle.addBuildListener(new NokeeInitBuildListener());
+			gradle.addBuildListener(new DisableableBuildListener(new NokeeInitBuildListener()));
 		}
 	}
 }

src/main/java/dev/nokee/init/internal/DisableableBuildListener.java

@@ -0,0 +1,55 @@
+package dev.nokee.init.internal;
+
+import org.gradle.BuildAdapter;
+import org.gradle.BuildListener;
+import org.gradle.BuildResult;
+import org.gradle.api.initialization.Settings;
+import org.gradle.api.invocation.Gradle;
+
+public final class DisableableBuildListener extends BuildAdapter {
+	private final BuildListener delegate;
+	private boolean disabled = false;
+
+	public DisableableBuildListener(BuildListener delegate) {
+		this.delegate = delegate;
+	}
+
+	public void disable() {
+		disabled = true;
+	}
+
+	@Override
+	public void beforeSettings(Settings settings) {
+		if (!disabled) {
+			delegate.beforeSettings(settings);
+		}
+	}
+
+	@Override
+	public void settingsEvaluated(Settings settings) {
+		if (!disabled) {
+			delegate.settingsEvaluated(settings);
+		}
+	}
+
+	@Override
+	public void projectsLoaded(Gradle gradle) {
+		if (!disabled) {
+			delegate.projectsLoaded(gradle);
+		}
+	}
+
+	@Override
+	public void projectsEvaluated(Gradle gradle) {
+		if (!disabled) {
+			delegate.projectsEvaluated(gradle);
+		}
+	}
+
+	@Override
+	public void buildFinished(BuildResult result) {
+		if (!disabled) {
+			delegate.buildFinished(result);
+		}
+	}
+}

src/test/groovy/dev/nokee/init/NokeeInitPluginTest.java

@@ -1,12 +1,11 @@
 package dev.nokee.init;
 
-import dev.nokee.init.internal.NokeeInitBuildListener;
 import org.gradle.api.invocation.Gradle;
 import org.gradle.util.GradleVersion;
 import org.junit.jupiter.api.Test;
 import org.mockito.Mockito;
 
-import static org.mockito.ArgumentMatchers.isA;
+import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.verifyNoInteractions;
 
@@ -22,6 +21,6 @@ void doNothingOnUnsupportedVersion() {
 	@Test
 	void configuresGradleOnSupportedVersion() {
 		new NokeeInitPlugin(() -> GradleVersion.version("6.3")).apply(gradle);
-		verify(gradle).addBuildListener(isA(NokeeInitBuildListener.class));
+		verify(gradle).addBuildListener(any());
 	}
 }

src/test/groovy/dev/nokee/init/internal/DisableableBuildListenerTest.java

@@ -0,0 +1,98 @@
+package dev.nokee.init.internal;
+
+import lombok.val;
+import org.gradle.BuildListener;
+import org.gradle.BuildResult;
+import org.gradle.api.initialization.Settings;
+import org.gradle.api.invocation.Gradle;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Nested;
+import org.junit.jupiter.api.Test;
+
+import static org.mockito.Mockito.*;
+
+class DisableableBuildListenerTest {
+	private final BuildListener delegate = mock(BuildListener.class);
+	private final DisableableBuildListener subject = new DisableableBuildListener(delegate);
+
+	@Nested
+	class Enabled {
+		@Test
+		void delegatesCallToBeforeSettings() {
+			val arg = mock(Settings.class);
+			subject.beforeSettings(arg);
+			verify(delegate).beforeSettings(arg);
+		}
+
+		@Test
+		void delegatesCallToSettingsEvaluated() {
+			val arg = mock(Settings.class);
+			subject.settingsEvaluated(arg);
+			verify(delegate).settingsEvaluated(arg);
+		}
+
+		@Test
+		void delegatesCallToBuildFinished() {
+			val arg = new BuildResult(null, null);
+			subject.buildFinished(arg);
+			verify(delegate).buildFinished(arg);
+		}
+
+		@Test
+		void delegatesCallToProjectsEvaluated() {
+			val arg = mock(Gradle.class);
+			subject.projectsEvaluated(arg);
+			verify(delegate).projectsEvaluated(arg);
+		}
+
+		@Test
+		void delegatesCallToProjectsLoaded() {
+			val arg = mock(Gradle.class);
+			subject.projectsLoaded(arg);
+			verify(delegate).projectsLoaded(arg);
+		}
+	}
+
+	@Nested
+	class Disabled {
+		@BeforeEach
+		void disableBuildListener() {
+			subject.disable();
+		}
+
+		@Test
+		void delegatesCallToBeforeSettings() {
+			val arg = mock(Settings.class);
+			subject.beforeSettings(arg);
+			verify(delegate, never()).beforeSettings(arg);
+		}
+
+		@Test
+		void delegatesCallToSettingsEvaluated() {
+			val arg = mock(Settings.class);
+			subject.settingsEvaluated(arg);
+			verify(delegate, never()).settingsEvaluated(arg);
+		}
+
+		@Test
+		void delegatesCallToBuildFinished() {
+			val arg = new BuildResult(null, null);
+			subject.buildFinished(arg);
+			verify(delegate, never()).buildFinished(arg);
+		}
+
+		@Test
+		void delegatesCallToProjectsEvaluated() {
+			val arg = mock(Gradle.class);
+			subject.projectsEvaluated(arg);
+			verify(delegate, never()).projectsEvaluated(arg);
+		}
+
+		@Test
+		void delegatesCallToProjectsLoaded() {
+			val arg = mock(Gradle.class);
+			subject.projectsLoaded(arg);
+			verify(delegate, never()).projectsLoaded(arg);
+		}
+	}
+}