Add basic functional test for value sources

Author: jpenilla

indra-git/src/main/java/net/kyori/indra/git/MappedRepositoryValueSource.java

@@ -30,9 +30,10 @@
 /**
  * A {@link RepositoryValueSource} that maps an intermediary value type to a final value type.
  *
- * @param <I> intermediary (non-serializable/config-cacheable) value type
- * @param <V> mapped value type
- * @param <P> parameters type
+ * @param <I> the intermediary (non-serializable/config-cacheable) value type
+ * @param <V> the mapped value type
+ * @param <P> the parameters type
+ * @since 4.0.0
  */
 public abstract class MappedRepositoryValueSource<I, V, P extends RepositoryValueSource.Parameters> extends RepositoryValueSource<V, P> {
   @Override
@@ -44,10 +45,29 @@ public abstract class MappedRepositoryValueSource<I, V, P extends RepositoryValu
     return this.mapValue(repository, rawValue);
   }
 
+  /**
+   * Obtains the raw value from the repository.
+   *
+   * @param repository the git repository
+   * @return the raw value, or {@code null}
+   */
   protected abstract @Nullable I getRawValue(final @NotNull Git repository);
 
+  /**
+   * Maps the raw value to the final value type.
+   *
+   * @param git the git repository
+   * @param value the raw value
+   * @return the mapped value, or {@code null}
+   */
   protected abstract @Nullable V mapValue(final @NotNull Git git, final @NotNull I value);
 
+  /**
+   * A {@link MappedRepositoryValueSource} that does not require any additional parameters.
+   *
+   * @param <I> the intermediary (non-serializable/config-cacheable) value type
+   * @param <V> the mapped value type
+   */
   public abstract static class Parameterless<I, V> extends MappedRepositoryValueSource<I, V, Parameters> {
   }
 }

indra-git/src/main/java/net/kyori/indra/git/QueryBranch.java

@@ -36,7 +36,7 @@
  * A {@link MappedRepositoryValueSource} that obtains values from the current branch,
  * or {@code null} if the project is not in a git repository or is checked out to a detached {@code HEAD}.
  *
- * @param <V> value type
+ * @param <V> the value type
  */
 public abstract class QueryBranch<V> extends MappedRepositoryValueSource.Parameterless<Ref, V> {
   private static final Logger LOGGER = Logging.getLogger(QueryBranch.class);
@@ -54,6 +54,9 @@ public abstract class QueryBranch<V> extends MappedRepositoryValueSource.Paramet
     }
   }
 
+  /**
+   * Queries the {@link Ref#getName() name} of the current branch ref.
+   */
   public abstract static class Name extends QueryBranch<String> {
     @Override
     protected @NotNull String mapValue(final @NotNull Git git, final @NotNull Ref ref) {

indra-git/src/main/java/net/kyori/indra/git/QueryHeadTag.java

@@ -33,14 +33,17 @@
  * A {@link MappedRepositoryValueSource} that obtains values from the tag pointing to the commit checked out as {@code HEAD},
  * or {@code null} if the project is not in a git repository or is not checked out to a tag
  *
- * @param <V> value type
+ * @param <V> the value type
  */
 public abstract class QueryHeadTag<V> extends MappedRepositoryValueSource.Parameterless<Ref, V> {
   @Override
   protected @Nullable Ref getRawValue(final @NotNull Git repository) {
     return IndraGitExtensionImpl.headTag(repository);
   }
 
+  /**
+   * Queries the {@link Ref#getName() name} of the head tag ref.
+   */
   public abstract static class Name extends QueryHeadTag<String> {
     @Override
     protected @NotNull String mapValue(final @NotNull Git git, final @NotNull Ref ref) {

indra-git/src/main/java/net/kyori/indra/git/QueryTags.java

@@ -37,7 +37,7 @@
  * A {@link MappedRepositoryValueSource} that queries the git repository for a list of tags.
  * Returns an empty list if the repository is not present or if an error occurs while querying.
  *
- * @param <V> value type
+ * @param <V> the value type
  */
 public abstract class QueryTags<V> extends MappedRepositoryValueSource.Parameterless<List<? extends Ref>, V> {
   private static final Logger LOGGER = Logging.getLogger(QueryTags.class);
@@ -52,6 +52,9 @@ public abstract class QueryTags<V> extends MappedRepositoryValueSource.Parameter
     }
   }
 
+  /**
+   * Queries the {@link Ref#getName() names} of the tags.
+   */
   public abstract static class Names extends QueryTags<List<String>> {
     @Override
     protected @NotNull List<String> mapValue(final @NotNull Git git, final @NotNull List<? extends Ref> value) {

indra-git/src/main/java/net/kyori/indra/git/RepositoryValueSource.java

@@ -42,7 +42,7 @@
  * <p>Implementations must be abstract, and only implement {@link #obtain(Git)}.</p>
  *
  * @param <V> the value type
- * @param <P> the parameter type
+ * @param <P> the parameters type
  * @since 4.0.0
  */
 public abstract class RepositoryValueSource<V, P extends RepositoryValueSource.Parameters> implements ValueSource<V, P> {

indra-git/src/test/java/net/kyori/indra/git/IndraGitPluginFunctionalTest.java

@@ -1,7 +1,7 @@
 /*
  * This file is part of indra, licensed under the MIT License.
  *
- * Copyright (c) 2020-2024 KyoriPowered
+ * Copyright (c) 2020-2025 KyoriPowered
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -27,6 +27,7 @@
 import net.kyori.indra.test.FunctionalTestDisplayNameGenerator;
 import net.kyori.indra.test.IndraConfigCacheFunctionalTest;
 import net.kyori.mammoth.test.TestContext;
+import org.eclipse.jgit.api.Git;
 import org.eclipse.jgit.api.errors.GitAPIException;
 import org.gradle.testkit.runner.BuildResult;
 import org.junit.jupiter.api.DisplayNameGeneration;
@@ -53,6 +54,27 @@ void testGitApplication(final TestContext ctx) throws IOException, GitAPIExcepti
     assertTrue(second.getOutput().contains("Configuration cache entry reused"), "No config cache reuse");
   }
 
+  @IndraConfigCacheFunctionalTest
+  void valueSources(final TestContext ctx) throws IOException, GitAPIException {
+    try (final Git git = IndraGitPluginTest.initRepo(ctx.outputDirectory())) {
+      git.commit()
+        .setAllowEmpty(true)
+        .setMessage("initial commit")
+        .setAuthor(IndraGitPluginTest.COMMITTER)
+        .setCommitter(IndraGitPluginTest.COMMITTER)
+        .setSign(false)
+        .call();
+    }
+    ctx.copyInput("build.gradle");
+    ctx.copyInput("settings.gradle");
+
+    final BuildResult result = ctx.build("jar");
+    assertTrue(result.getOutput().contains("Configuration cache entry stored"), "No config cache");
+
+    final BuildResult second = ctx.build("jar");
+    assertTrue(second.getOutput().contains("Configuration cache entry reused"), "No config cache reuse");
+  }
+
   @IndraConfigCacheFunctionalTest
   void testOnSettings(final TestContext ctx) throws IOException, GitAPIException {
     IndraGitPluginTest.initRepo(ctx.outputDirectory());

indra-git/src/test/java/net/kyori/indra/git/IndraGitPluginTest.java

@@ -51,7 +51,7 @@
 class IndraGitPluginTest {
   private static final String PLUGIN = "net.kyori.indra.git";
   private static final String DEFAULT_BRANCH = "trunk";
-  private static final PersonIdent COMMITTER = new PersonIdent("CI", "[email protected]");
+  public static final PersonIdent COMMITTER = new PersonIdent("CI", "[email protected]");
 
   @TempDir
   private Path projectDir;

indra-git/src/test/resources/net/kyori/indra/git/gitApplication/in/build.gradle

@@ -2,7 +2,7 @@ plugins {
   id 'net.kyori.indra.git'
 }
 
-task printGitStatus(type: net.kyori.indra.git.task.RepositoryTask) {
+tasks.register('printGitStatus', net.kyori.indra.git.task.RepositoryTask) {
   doLast {
     logger.lifecycle("Git present: ${repo() != null}")
   }

indra-git/src/test/resources/net/kyori/indra/git/valueSources/in/build.gradle

@@ -0,0 +1,11 @@
+plugins {
+  id 'net.kyori.indra.git'
+  id 'java'
+}
+
+println(indraGit.branchName().get())
+println(indraGit.commit().get().name())
+
+tasks.jar {
+  indraGit.applyVcsInformationToManifest(manifest)
+}

indra-git/src/test/resources/net/kyori/indra/git/valueSources/in/settings.gradle

@@ -0,0 +1 @@
+rootProject.name = "valueSources"