Add incremental backoff, customizable retries, and many convenience methods

Author: erichaagdev

README.md

@@ -1,3 +1,3 @@
 # Develocity Build Processor
 
-wip
+A library to process Develocity™ build data with built-in caching and retry mechanisms.

build.gradle.kts

@@ -1,9 +1,10 @@
 @file:Suppress("UnstableApiUsage")
 
 plugins {
-    alias(libs.plugins.develocity.api.models)
-    alias(libs.plugins.java.test.fixtures)
-    alias(libs.plugins.java.library)
+    alias(libs.plugins.conventions.develocity.api)
+    alias(libs.plugins.conventions.release)
+    alias(libs.plugins.gradle.java.library)
+    alias(libs.plugins.gradle.java.test.fixtures)
 }
 
 group = "dev.erichaag"
@@ -30,3 +31,30 @@ develocityApi {
 val test by testing.suites.getting(JvmTestSuite::class) {
     useJUnitJupiter(libs.versions.junit)
 }
+
+val mavenJava by publishing.publications.getting(MavenPublication::class) {
+    pom {
+        name = "Develocity Build Processor"
+        description = "A library to process Develocity™ build data with built-in caching and retry mechanisms."
+        url = "https://github.com/erichaagdev/develocity-build-processor"
+        licenses {
+            license {
+                name = "MIT License"
+                url = "https://raw.githubusercontent.com/erichaagdev/develocity-build-processor/main/LICENSE"
+                distribution = "repo"
+            }
+        }
+        developers {
+            developer {
+                id = "erichaagdev"
+                name = "Eric Haag"
+                email = "[email protected]"
+            }
+        }
+        scm {
+            connection = "scm:git:git://github.com/erichaagdev/develocity-build-processor.git"
+            developerConnection = "scm:git:ssh://github.com/erichaagdev/develocity-build-processor.git"
+            url = "https://github.com/erichaagdev/develocity-build-processor"
+        }
+    }
+}

buildSrc/src/main/kotlin/conventions.develocity-api-models.gradle.kts renamed to buildSrc/src/main/kotlin/conventions.develocity-api.gradle.kts

@@ -0,0 +1,57 @@
+plugins {
+    id("java")
+    id("maven-publish")
+    id("signing")
+}
+
+java {
+    withJavadocJar()
+    withSourcesJar()
+}
+
+publishing.repositories.maven {
+    name = "distribution"
+    url = uri(layout.buildDirectory.dir("distributionRepository"))
+}
+
+tasks.javadoc {
+    (options as StandardJavadocDocletOptions).addBooleanOption("html5", true)
+}
+
+val mavenJava by publishing.publications.creating(MavenPublication::class) {
+    from(components["java"])
+}
+
+signing {
+    val signingSecretKey = providers.gradleProperty("signingSecretKey")
+    val signingPassword = providers.gradleProperty("signingPassword")
+    if (signingSecretKey.isPresent && signingPassword.isPresent) {
+        sign(mavenJava)
+        useInMemoryPgpKeys(signingSecretKey.get(), signingPassword.get())
+        isRequired = true
+    }
+}
+
+val verifySigningCredentials by tasks.registering {
+    val signingSecretKey = providers.gradleProperty("signingSecretKey")
+    val signingPassword = providers.gradleProperty("signingPassword")
+    doFirst {
+        if (!signingSecretKey.isPresent && !signingPassword.isPresent) throw GradleException("'signingSecretKey' and 'signingPassword' properties must be set")
+        if (!signingSecretKey.isPresent) throw GradleException("'signingSecretKey' property must be set")
+        if (!signingPassword.isPresent) throw GradleException("'signingPassword' property must be set")
+    }
+}
+
+val publishMavenJavaPublicationToDistributionRepository = tasks.named<PublishToMavenRepository>("publishMavenJavaPublicationToDistributionRepository") {
+    dependsOn(verifySigningCredentials)
+    val repositoryUrl = repository.url
+    doFirst {
+        File(repositoryUrl.toURL().file).deleteRecursively()
+    }
+}
+
+val packageDistribution by tasks.registering(Zip::class) {
+    destinationDirectory = layout.buildDirectory.dir("packageDistribution")
+    from(publishMavenJavaPublicationToDistributionRepository.map { it.repository.url })
+    exclude("**/*.asc.*")
+}

buildSrc/src/main/kotlin/conventions.release.gradle.kts

@@ -11,7 +11,8 @@ jakarta-annotation-api = { module = "jakarta.annotation:jakarta.annotation-api",
 junit-jupiter = { module = "org.junit.jupiter:junit-jupiter", version.ref = "junit" }
 
 [plugins]
-develocity-api-models = { id = "conventions.develocity-api-models" }
-java-library = { id = "java-library" }
-java-test-fixtures = { id = "java-test-fixtures" }
+conventions-develocity-api = { id = "conventions.develocity-api" }
+conventions-release = { id = "conventions.release" }
+gradle-java-library = { id = "java-library" }
+gradle-java-test-fixtures = { id = "java-test-fixtures" }
 openapi-generator = { id = "org.openapi.generator", version.ref = "openapi-generator" }

gradle/libs.versions.toml

@@ -7,8 +7,8 @@ plugins {
 develocity {
     buildScan {
         termsOfUseAgree = "yes"
-        termsOfUseUrl = "https://gradle.com/terms-of-service"
+        termsOfUseUrl = "https://gradle.com/help/legal-terms-of-use"
     }
 }
 
-rootProject.name = "develocity-build-scan-processor"
+rootProject.name = "develocity-build-processor"

settings.gradle.kts

@@ -0,0 +1,15 @@
+package dev.erichaag.develocity.api;
+
+import java.util.function.Supplier;
+
+public class AttributesNotPresentException extends RuntimeException {
+
+    AttributesNotPresentException(String methodName) {
+        super("'" + methodName + "' may only be called when attributes are present.");
+    }
+
+    static Supplier<AttributesNotPresentException> attributesNotPresent(String methodName) {
+        return () -> new AttributesNotPresentException(methodName);
+    }
+
+}

src/main/java/dev/erichaag/develocity/api/AttributesNotPresentException.java

@@ -1,8 +1,12 @@
 package dev.erichaag.develocity.api;
 
+import java.time.Duration;
+import java.time.Instant;
+import java.util.List;
 import java.util.Objects;
 import java.util.Set;
 
+import static dev.erichaag.develocity.api.MethodNotSupportedException.methodNotSupportedForBazel;
 import static java.util.Collections.emptySet;
 
 public final class BazelBuild implements Build {
@@ -33,6 +37,46 @@ public String getBuildAgentVersion() {
         return build.getBuildAgentVersion();
     }
 
+    @Override
+    public Instant getStartTime() {
+        throw methodNotSupportedForBazel("getStartTime()");
+    }
+
+    @Override
+    public Duration getDuration() {
+        throw methodNotSupportedForBazel("getDuration()");
+    }
+
+    @Override
+    public String getProjectName() {
+        throw methodNotSupportedForBazel("getProjectName()");
+    }
+
+    @Override
+    public List<String> getRequestedWorkUnits() {
+        throw methodNotSupportedForBazel("getRequestedWorkUnits()");
+    }
+
+    @Override
+    public boolean hasFailed() {
+        throw methodNotSupportedForBazel("hasFailed()");
+    }
+
+    @Override
+    public String getUser() {
+        throw methodNotSupportedForBazel("getUser()");
+    }
+
+    @Override
+    public List<String> getTags() {
+        throw methodNotSupportedForBazel("getTags()");
+    }
+
+    @Override
+    public List<Value> getValues() {
+        throw methodNotSupportedForBazel("getValues()");
+    }
+
     @Override
     public Set<BuildModel> getAvailableBuildModels() {
         return emptySet();

src/main/java/dev/erichaag/develocity/api/BazelBuild.java

@@ -1,7 +1,14 @@
 package dev.erichaag.develocity.api;
 
+import java.time.Duration;
+import java.time.Instant;
+import java.util.Collection;
+import java.util.List;
+import java.util.Optional;
 import java.util.Set;
 
+import static java.util.stream.Collectors.toUnmodifiableSet;
+
 public sealed interface Build permits GradleBuild, MavenBuild, BazelBuild, SbtBuild {
 
     String getId();
@@ -12,10 +19,58 @@ public sealed interface Build permits GradleBuild, MavenBuild, BazelBuild, SbtBu
 
     String getBuildAgentVersion();
 
-    Set<BuildModel> getAvailableBuildModels();
+    Instant getStartTime();
+
+    Duration getDuration();
+
+    String getProjectName();
+
+    List<String> getRequestedWorkUnits();
+
+    boolean hasFailed();
+
+    String getUser();
+
+    List<String> getTags();
+
+    default boolean hasTag(String tag) {
+        return getTags().contains(tag);
+    }
+
+    List<Value> getValues();
+
+    default boolean hasValue(String key) {
+        return getValues().stream().anyMatch(it -> it.name().equals(key));
+    }
+
+    default List<String> getValues(String key) {
+        return getValues().stream()
+                .filter(it -> it.name().equals(key))
+                .map(Value::value)
+                .toList();
+    }
+
+    default Optional<String> getValue(String key) {
+        final var values = getValues(key);
+        if (values.size() > 1) throw new IllegalStateException("Multiple values for key '" + key + "'");
+        return values.stream().findFirst();
+    }
+
+    default Optional<String> getFirstValue(String key) {
+        return getValues(key).stream().findFirst();
+    }
 
     ApiBuild getBuild();
 
+    Set<BuildModel> getAvailableBuildModels();
+
+    default boolean containsAllRelevantBuildModelsFrom(Collection<BuildModel> requiredBuildModels) {
+        return getAvailableBuildModels()
+                .containsAll(requiredBuildModels.stream()
+                        .filter(it -> it.isModelFor(this))
+                        .collect(toUnmodifiableSet()));
+    }
+
     static Build from(ApiBuild build) {
         return switch (build.getBuildToolType()) {
             case "gradle" -> new GradleBuild(build);

src/main/java/dev/erichaag/develocity/api/Build.java

@@ -2,22 +2,32 @@
 
 public enum BuildModel {
 
-    ALL_MODELS("*"),
-    GRADLE_ARTIFACT_TRANSFORM_EXECUTIONS("gradle-artifact-transform-executions"),
-    GRADLE_ATTRIBUTES("gradle-attributes"),
-    GRADLE_BUILD_CACHE_PERFORMANCE("gradle-build-cache-performance"),
-    GRADLE_DEPRECATIONS("gradle-deprecations"),
-    GRADLE_NETWORK_ACTIVITY("gradle-network-activity"),
-    GRADLE_PROJECTS("gradle-projects"),
-    MAVEN_ATTRIBUTES("maven-attributes"),
-    MAVEN_BUILD_CACHE_PERFORMANCE("maven-build-cache-performance"),
-    MAVEN_DEPENDENCY_RESOLUTION("maven-dependency-resolution"),
-    MAVEN_MODULES("maven-modules");
+    ALL_MODELS("*", null),
+    GRADLE_ARTIFACT_TRANSFORM_EXECUTIONS("gradle-artifact-transform-executions", GradleBuild.class),
+    GRADLE_ATTRIBUTES("gradle-attributes", GradleBuild.class),
+    GRADLE_BUILD_CACHE_PERFORMANCE("gradle-build-cache-performance", GradleBuild.class),
+    GRADLE_DEPRECATIONS("gradle-deprecations", GradleBuild.class),
+    GRADLE_NETWORK_ACTIVITY("gradle-network-activity", GradleBuild.class),
+    GRADLE_PROJECTS("gradle-projects", GradleBuild.class),
+    MAVEN_ATTRIBUTES("maven-attributes", MavenBuild.class),
+    MAVEN_BUILD_CACHE_PERFORMANCE("maven-build-cache-performance", MavenBuild.class),
+    MAVEN_DEPENDENCY_RESOLUTION("maven-dependency-resolution", MavenBuild.class),
+    MAVEN_MODULES("maven-modules", MavenBuild.class);
 
-    final String modelName;
+    private final String modelName;
+    private final Class<? extends Build> modelFor;
 
-    BuildModel(String modelName) {
+    BuildModel(String modelName, Class<? extends Build> modelFor) {
         this.modelName = modelName;
+        this.modelFor = modelFor;
+    }
+
+    boolean isModelFor(Build build) {
+        return modelFor == null || modelFor.isInstance(build);
+    }
+
+    public String modelName() {
+        return modelName;
     }
 
 }