Report GitVersion failure as problem instead of console log bloat

Next step is to add a check to fail the build if the `CI` environment
variable is true and Git Version failed to calculate the version number
(opt-out).

Author: Jonathing

gitversion-gradle/src/main/groovy/net/minecraftforge/gitversion/gradle/GitVersionExtensionImpl.groovy

@@ -30,7 +30,7 @@ import javax.inject.Inject
     @Inject
     GitVersionExtensionImpl(GitVersionPlugin plugin, ExtensionAware target, Directory projectDirectory) {
         this.gitversion = this.objects.property(Output)
-                              .value(GitVersionValueSource.of(plugin, projectDirectory))
+                              .value(GitVersionValueSource.of(objects.newInstance(GitVersionProblems), plugin, projectDirectory))
                               .tap { disallowChanges(); finalizeValueOnRead() }
 
         if (target instanceof Project)

gitversion-gradle/src/main/groovy/net/minecraftforge/gitversion/gradle/GitVersionExtensionInternal.java

@@ -97,6 +97,8 @@ record Info(
         String getCommit,
         String getAbbreviatedId
     ) implements GitVersionExtension.Info {
+        static final Info EMPTY = new Info("0.0", "0", "00000000", "master", "0000000000000000000000", "00000000");
+
         @Override
         public String getBranch(boolean versionFriendly) {
             var branch = this.getBranch();
@@ -149,5 +151,15 @@ record Output(
         @Nullable String tagPrefix,
         List<String> filters,
         List<String> subprojectPaths
-    ) implements Serializable { }
+    ) implements Serializable {
+        static final Output EMPTY = new Output(
+            Info.EMPTY,
+            null,
+            null,
+            null,
+            null,
+            null,
+            List.of(),
+            List.of());
+    }
 }

gitversion-gradle/src/main/groovy/net/minecraftforge/gitversion/gradle/GitVersionPlugin.java

@@ -9,6 +9,7 @@
 import org.gradle.api.initialization.Settings;
 import org.gradle.api.logging.Logger;
 import org.gradle.api.logging.Logging;
+import org.gradle.api.model.ObjectFactory;
 import org.gradle.api.plugins.ExtensionAware;
 import org.gradle.api.provider.ProviderFactory;
 
@@ -22,6 +23,7 @@ abstract class GitVersionPlugin extends EnhancedPlugin<ExtensionAware> {
     static final Logger LOGGER = Logging.getLogger(GitVersionPlugin.class);
 
     // Used by GitVersionValueSource
+    @Override protected abstract @Inject ObjectFactory getObjects();
     @Override protected abstract @Inject ProviderFactory getProviders();
 
     @Inject

gitversion-gradle/src/main/groovy/net/minecraftforge/gitversion/gradle/GitVersionProblems.java

@@ -14,4 +14,18 @@ abstract class GitVersionProblems extends EnhancedProblems {
     public GitVersionProblems() {
         super(GitVersionPlugin.NAME, GitVersionPlugin.DISPLAY_NAME);
     }
+
+    void reportGitVersionFailure(String errorOutput, Throwable failure) {
+        report("git-version-failure", "Git Version failed to generate version info", spec -> spec
+            .details("""
+                Git Version failed to generate version information. Please address this issue before attempting to publish your project.
+                Error Output:
+                %s""".formatted(errorOutput.indent(2)))
+            .withException(failure)
+            .severity(Severity.ERROR)
+            .solution("If you are not in a Git repository, ignore until you initialize it or do not use the Git Version Gradle plugin.")
+            .solution("If your Git repository has no remote, add one.")
+            .solution("If your Git repository has no tags, add one.")
+            .solution(HELP_MESSAGE));
+    }
 }

gitversion-gradle/src/main/groovy/net/minecraftforge/gitversion/gradle/GitVersionValueResult.java

@@ -0,0 +1,3 @@
+package net.minecraftforge.gitversion.gradle;
+
+record GitVersionValueResult(GitVersionExtensionInternal.Output output, String errorOutput, Throwable execFailure) { }

gitversion-gradle/src/main/groovy/net/minecraftforge/gitversion/gradle/GitVersionValueSource.groovy

@@ -10,22 +10,16 @@ import net.minecraftforge.gitversion.gradle.common.GitVersionTools
 import org.gradle.api.file.ConfigurableFileCollection
 import org.gradle.api.file.Directory
 import org.gradle.api.file.DirectoryProperty
-import org.gradle.api.provider.Property
-import org.gradle.api.provider.Provider
-import org.gradle.api.provider.ProviderFactory
 import org.gradle.api.provider.ValueSource
 import org.gradle.api.provider.ValueSourceParameters
 import org.gradle.process.ExecOperations
 import org.gradle.process.JavaExecSpec
-import org.gradle.process.ProcessExecutionException
 
 import javax.inject.Inject
 import java.nio.charset.StandardCharsets
 
-import static net.minecraftforge.gitversion.gradle.GitVersionPlugin.LOGGER
-
 @CompileStatic
-@PackageScope abstract class GitVersionValueSource implements ValueSource<String, Parameters> {
+@PackageScope abstract class GitVersionValueSource implements ValueSource<GitVersionValueResult, Parameters> {
     static interface Parameters extends ValueSourceParameters {
         ConfigurableFileCollection getClasspath()
 
@@ -37,8 +31,8 @@ import static net.minecraftforge.gitversion.gradle.GitVersionPlugin.LOGGER
     @Inject
     GitVersionValueSource() {}
 
-    @PackageScope static Provider<GitVersionExtensionInternal.Output> of(GitVersionPlugin plugin, Directory projectDirectory) {
-        plugin.getProviders().of(GitVersionValueSource) { spec ->
+    @PackageScope static GitVersionExtensionInternal.Output of(GitVersionProblems problems, GitVersionPlugin plugin, Directory projectDirectory) {
+        var result = plugin.getProviders().of(GitVersionValueSource) { spec ->
             spec.parameters { parameters ->
                 parameters.classpath.from(plugin.getTool(GitVersionTools.GITVERSION).classpath)
                 // NOTE: We are NOT manually setting the java launcher this time
@@ -47,20 +41,30 @@ import static net.minecraftforge.gitversion.gradle.GitVersionPlugin.LOGGER
 
                 parameters.projectPath.set(projectDirectory)
             }
-        }.map { Util.fromJson(it, GitVersionExtensionInternal.Output) }
+        }.get()
+
+        if (result.execFailure() !== null)
+            problems.reportGitVersionFailure(result.errorOutput(), result.execFailure())
+
+        return result.output()
     }
 
     @Override
-    String obtain() {
+    GitVersionValueResult obtain() {
         final parameters = this.parameters
-        final output = new ByteArrayOutputStream()
+        final stdOut = new ByteArrayOutputStream()
+        final stdErr = new ByteArrayOutputStream()
+
+        GitVersionExtensionInternal.Output output
+        String errorOutput
+        Throwable execFailure
 
         Closure javaExecSpec = { JavaExecSpec exec ->
             exec.classpath = parameters.classpath
             exec.mainClass.set(GitVersionTools.GITVERSION.mainClass)
 
-            exec.standardOutput = output
-            exec.errorOutput = Util.toLog(LOGGER.&error)
+            exec.standardOutput = stdOut
+            exec.errorOutput = stdErr
 
             exec.args(
                 '--json',
@@ -70,19 +74,29 @@ import static net.minecraftforge.gitversion.gradle.GitVersionPlugin.LOGGER
 
         try {
             this.execOperations.javaexec(javaExecSpec).rethrowFailure().assertNormalExitValue()
-        } catch (ProcessExecutionException e) {
-            output.reset()
+
+            output = Util.fromJson(stdOut.toString(StandardCharsets.UTF_8), GitVersionExtensionInternal.Output)
+            errorOutput = stdErr.toString(StandardCharsets.UTF_8)
+            execFailure = null
+        } catch (Exception e) {
+            stdOut.reset()
 
             try {
                 this.execOperations.javaexec(javaExecSpec.andThen { JavaExecSpec exec ->
                     exec.args('--disable-strict')
+                    exec.errorOutput = new ByteArrayOutputStream()
                 }).rethrowFailure().assertNormalExitValue()
-            } catch (ProcessExecutionException suppressed) {
+
+                output = Util.fromJson(stdOut.toString(StandardCharsets.UTF_8), GitVersionExtensionInternal.Output)
+            } catch (Exception suppressed) {
                 e.addSuppressed(suppressed)
-                throw e
+                output = GitVersionExtensionInternal.Output.EMPTY
             }
+
+            errorOutput = stdErr.toString(StandardCharsets.UTF_8)
+            execFailure = e
         }
 
-        output.toString(StandardCharsets.UTF_8)
+        return new GitVersionValueResult(output, errorOutput, execFailure)
     }
 }