Move Actuator docs into a separate module

Author: wilkinsona

eclipse-thread-dump.txt

@@ -43,6 +43,7 @@ include "spring-boot-project:spring-boot"
 include "spring-boot-project:spring-boot-activemq"
 include "spring-boot-project:spring-boot-actuator"
 include "spring-boot-project:spring-boot-actuator-autoconfigure"
+include "spring-boot-project:spring-boot-actuator-docs"
 include "spring-boot-project:spring-boot-amqp"
 include "spring-boot-project:spring-boot-artemis"
 include "spring-boot-project:spring-boot-autoconfigure"

settings.gradle

@@ -1,6 +1,5 @@
 plugins {
 	id "java-library"
-	id "org.springframework.boot.antora-contributor"
 	id "org.springframework.boot.auto-configuration"
 	id "org.springframework.boot.configuration-properties"
 	id "org.springframework.boot.deployed"
@@ -207,8 +206,6 @@ dependencies {
 	testImplementation("org.springframework:spring-orm")
 	testImplementation("org.springframework.data:spring-data-rest-webmvc")
 	testImplementation("org.springframework.integration:spring-integration-jmx")
-	testImplementation("org.springframework.restdocs:spring-restdocs-mockmvc")
-	testImplementation("org.springframework.restdocs:spring-restdocs-webtestclient")
 	testImplementation("org.springframework.security:spring-security-test")
 	testImplementation("org.yaml:snakeyaml")
 
@@ -230,42 +227,4 @@ dependencies {
 
 tasks.named("test") {
 	jvmArgs += "--add-opens=java.base/java.net=ALL-UNNAMED"
-	filter {
-		excludeTestsMatching("*DocumentationTests")
-	}
-}
-
-def documentationTest = tasks.register("documentationTest", Test) {
-	testClassesDirs = testing.suites.test.sources.output.classesDirs
-	classpath = testing.suites.test.sources.runtimeClasspath
-	jvmArgs += "--add-opens=java.base/java.net=ALL-UNNAMED"
-	filter {
-		includeTestsMatching("*DocumentationTests")
-	}
-	outputs.dir(layout.buildDirectory.dir("generated-snippets"))
-	develocity {
-		predictiveTestSelection {
-			enabled = false
-		}
-	}
-}
-
-tasks.named("generateAntoraPlaybook") {
-	antoraExtensions.xref.stubs = ["appendix:.*", "api:.*", "reference:.*"]
-}
-
-antoraContributions {
-	'actuator-rest-api' {
-		aggregateContent {
-			from(documentationTest.map { layout.buildDirectory.dir("generated-snippets") }) {
-				into "modules/api/partials/rest/actuator"
-			}
-		}
-		localAggregateContent {
-			from(tasks.named("generateAntoraYml")) {
-				into "modules"
-			}
-		}
-		source()
-	}
 }

spring-boot-project/spring-boot-actuator-autoconfigure/build.gradle

@@ -0,0 +1,57 @@
+plugins {
+	id "java"
+	id "org.springframework.boot.antora-contributor"
+}
+
+description = "Spring Boot Actuator Docs"
+
+dependencies {
+	testImplementation(project(":spring-boot-project:spring-boot-actuator-autoconfigure"))
+	testImplementation(project(":spring-boot-project:spring-boot-http-converter"))
+	testImplementation(project(":spring-boot-project:spring-boot-flyway"))
+	testImplementation(project(":spring-boot-project:spring-boot-integration"))
+	testImplementation(project(":spring-boot-project:spring-boot-jackson"))
+	testImplementation(project(":spring-boot-project:spring-boot-jdbc"))
+	testImplementation(project(":spring-boot-project:spring-boot-liquibase"))
+	testImplementation(project(":spring-boot-project:spring-boot-quartz"))
+	testImplementation(project(":spring-boot-project:spring-boot-reactor-netty"))
+	testImplementation(project(":spring-boot-project:spring-boot-session"))
+	testImplementation(project(":spring-boot-project:spring-boot-test"))
+	testImplementation(project(":spring-boot-project:spring-boot-tomcat"))
+	testImplementation(project(":spring-boot-project:spring-boot-tools:spring-boot-test-support"))
+	testImplementation(project(":spring-boot-project:spring-boot-web-server-test"))
+	testImplementation(project(":spring-boot-project:spring-boot-webflux"))
+	testImplementation(project(":spring-boot-project:spring-boot-webmvc"))
+	testImplementation("io.micrometer:micrometer-core")
+	testImplementation("io.micrometer:micrometer-registry-prometheus")
+	testImplementation("io.prometheus:prometheus-metrics-exposition-formats")
+	testImplementation("org.springframework.restdocs:spring-restdocs-mockmvc")
+	testImplementation("org.springframework.restdocs:spring-restdocs-webtestclient")
+
+	testRuntimeOnly("ch.qos.logback:logback-classic")
+	testRuntimeOnly("com.h2database:h2")
+}
+
+tasks.named("test") {
+	outputs.dir(layout.buildDirectory.dir("generated-snippets"))
+}
+
+tasks.named("generateAntoraPlaybook") {
+	antoraExtensions.xref.stubs = ["appendix:.*", "api:.*", "reference:.*"]
+}
+
+antoraContributions {
+	'actuator-rest-api' {
+		aggregateContent {
+			from(tasks.named('test').map { layout.buildDirectory.dir("generated-snippets") }) {
+				into "modules/api/partials/rest/actuator"
+			}
+		}
+		localAggregateContent {
+			from(tasks.named("generateAntoraYml")) {
+				into "modules"
+			}
+		}
+		source()
+	}
+}

spring-boot-project/spring-boot-actuator-docs/build.gradle

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.actuate.autoconfigure.endpoint.web.documentation;
+package org.springframework.boot.actuate.docs;
 
 import java.io.IOException;
 import java.util.HashMap;
@@ -31,9 +31,9 @@
 import org.springframework.boot.actuate.autoconfigure.endpoint.EndpointAutoConfiguration;
 import org.springframework.boot.actuate.autoconfigure.endpoint.jackson.JacksonEndpointAutoConfiguration;
 import org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointAutoConfiguration;
-import org.springframework.boot.actuate.autoconfigure.endpoint.web.documentation.AbstractEndpointDocumentationTests.BaseDocumentationConfiguration;
 import org.springframework.boot.actuate.autoconfigure.endpoint.web.reactive.WebFluxEndpointManagementContextConfiguration;
 import org.springframework.boot.actuate.autoconfigure.endpoint.web.servlet.WebMvcEndpointManagementContextConfiguration;
+import org.springframework.boot.actuate.docs.AbstractEndpointDocumentationTests.BaseDocumentationConfiguration;
 import org.springframework.boot.actuate.endpoint.jackson.EndpointObjectMapper;
 import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
 import org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration;

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/antora.yml renamed to spring-boot-project/spring-boot-actuator-docs/src/docs/antora/antora.yml

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2024 the original author or authors.
+ * Copyright 2012-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.actuate.autoconfigure.endpoint.web.documentation;
+package org.springframework.boot.actuate.docs;
 
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.extension.ExtendWith;

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/local-nav.adoc renamed to spring-boot-project/spring-boot-actuator-docs/src/docs/antora/local-nav.adoc

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.actuate.autoconfigure.audit;
+package org.springframework.boot.actuate.docs.audit;
 
 import java.time.OffsetDateTime;
 import java.time.format.DateTimeFormatter;
@@ -26,7 +26,7 @@
 import org.springframework.boot.actuate.audit.AuditEvent;
 import org.springframework.boot.actuate.audit.AuditEventRepository;
 import org.springframework.boot.actuate.audit.AuditEventsEndpoint;
-import org.springframework.boot.actuate.autoconfigure.endpoint.web.documentation.MockMvcEndpointDocumentationTests;
+import org.springframework.boot.actuate.docs.MockMvcEndpointDocumentationTests;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.test.context.bean.override.mockito.MockitoBean;

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/auditevents.adoc renamed to spring-boot-project/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/auditevents.adoc

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.actuate.autoconfigure.beans;
+package org.springframework.boot.actuate.docs.beans;
 
 import java.util.Collection;
 import java.util.List;
@@ -23,8 +23,8 @@
 
 import org.junit.jupiter.api.Test;
 
-import org.springframework.boot.actuate.autoconfigure.endpoint.web.documentation.MockMvcEndpointDocumentationTests;
 import org.springframework.boot.actuate.beans.BeansEndpoint;
+import org.springframework.boot.actuate.docs.MockMvcEndpointDocumentationTests;
 import org.springframework.context.ConfigurableApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/beans.adoc renamed to spring-boot-project/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/beans.adoc

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.actuate.autoconfigure.cache;
+package org.springframework.boot.actuate.docs.cache;
 
 import java.util.Collections;
 import java.util.HashMap;
@@ -23,9 +23,9 @@
 
 import org.junit.jupiter.api.Test;
 
-import org.springframework.boot.actuate.autoconfigure.endpoint.web.documentation.MockMvcEndpointDocumentationTests;
 import org.springframework.boot.actuate.cache.CachesEndpoint;
 import org.springframework.boot.actuate.cache.CachesEndpointWebExtension;
+import org.springframework.boot.actuate.docs.MockMvcEndpointDocumentationTests;
 import org.springframework.cache.CacheManager;
 import org.springframework.cache.concurrent.ConcurrentMapCacheManager;
 import org.springframework.context.annotation.Bean;

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/caches.adoc renamed to spring-boot-project/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/caches.adoc

@@ -14,13 +14,14 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.actuate.autoconfigure.condition;
+package org.springframework.boot.actuate.docs.condition;
 
 import java.util.List;
 
 import org.junit.jupiter.api.Test;
 
-import org.springframework.boot.actuate.autoconfigure.endpoint.web.documentation.MockMvcEndpointDocumentationTests;
+import org.springframework.boot.actuate.autoconfigure.condition.ConditionsReportEndpoint;
+import org.springframework.boot.actuate.docs.MockMvcEndpointDocumentationTests;
 import org.springframework.boot.autoconfigure.condition.ConditionEvaluationReport;
 import org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration;
 import org.springframework.context.ConfigurableApplicationContext;

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/conditions.adoc renamed to spring-boot-project/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/conditions.adoc

@@ -14,12 +14,12 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.actuate.autoconfigure.context;
+package org.springframework.boot.actuate.docs.context;
 
 import org.junit.jupiter.api.Test;
 
-import org.springframework.boot.actuate.autoconfigure.endpoint.web.documentation.MockMvcEndpointDocumentationTests;
 import org.springframework.boot.actuate.context.ShutdownEndpoint;
+import org.springframework.boot.actuate.docs.MockMvcEndpointDocumentationTests;
 import org.springframework.context.annotation.AnnotationConfigApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/configprops.adoc renamed to spring-boot-project/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/configprops.adoc

@@ -14,14 +14,14 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.actuate.autoconfigure.context.properties;
+package org.springframework.boot.actuate.docs.context.properties;
 
 import java.util.Collections;
 
 import org.junit.jupiter.api.Test;
 
-import org.springframework.boot.actuate.autoconfigure.endpoint.web.documentation.MockMvcEndpointDocumentationTests;
 import org.springframework.boot.actuate.context.properties.ConfigurationPropertiesReportEndpoint;
+import org.springframework.boot.actuate.docs.MockMvcEndpointDocumentationTests;
 import org.springframework.boot.actuate.endpoint.Show;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/env.adoc renamed to spring-boot-project/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/env.adoc

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.actuate.autoconfigure.env;
+package org.springframework.boot.actuate.docs.env;
 
 import java.io.IOException;
 import java.util.Collections;
@@ -28,7 +28,7 @@
 import com.fasterxml.jackson.databind.SerializationFeature;
 import org.junit.jupiter.api.Test;
 
-import org.springframework.boot.actuate.autoconfigure.endpoint.web.documentation.MockMvcEndpointDocumentationTests;
+import org.springframework.boot.actuate.docs.MockMvcEndpointDocumentationTests;
 import org.springframework.boot.actuate.endpoint.Show;
 import org.springframework.boot.actuate.env.EnvironmentEndpoint;
 import org.springframework.context.annotation.Bean;
@@ -56,8 +56,7 @@
  *
  * @author Andy Wilkinson
  */
-@TestPropertySource(
-		properties = "spring.config.location=classpath:/org/springframework/boot/actuate/autoconfigure/env/")
+@TestPropertySource(properties = "spring.config.location=classpath:/org/springframework/boot/actuate/docs/env/")
 class EnvironmentEndpointDocumentationTests extends MockMvcEndpointDocumentationTests {
 
 	private static final FieldDescriptor activeProfiles = fieldWithPath("activeProfiles")

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/flyway.adoc renamed to spring-boot-project/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/flyway.adoc

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.actuate.autoconfigure.flyway;
+package org.springframework.boot.actuate.docs.flyway;
 
 import java.util.List;
 
@@ -23,7 +23,7 @@
 import org.flywaydb.core.api.MigrationState;
 import org.junit.jupiter.api.Test;
 
-import org.springframework.boot.actuate.autoconfigure.endpoint.web.documentation.MockMvcEndpointDocumentationTests;
+import org.springframework.boot.actuate.docs.MockMvcEndpointDocumentationTests;
 import org.springframework.boot.actuate.flyway.FlywayEndpoint;
 import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
 import org.springframework.boot.flyway.autoconfigure.FlywayAutoConfiguration;
@@ -45,8 +45,7 @@
  *
  * @author Andy Wilkinson
  */
-@TestPropertySource(
-		properties = "spring.flyway.locations=classpath:org/springframework/boot/actuate/autoconfigure/flyway")
+@TestPropertySource(properties = "spring.flyway.locations=classpath:org/springframework/boot/actuate/docs/flyway")
 class FlywayEndpointDocumentationTests extends MockMvcEndpointDocumentationTests {
 
 	@Test

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/health.adoc renamed to spring-boot-project/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/health.adoc

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.actuate.autoconfigure.health;
+package org.springframework.boot.actuate.docs.health;
 
 import java.io.File;
 import java.util.Collections;
@@ -26,7 +26,7 @@
 
 import org.junit.jupiter.api.Test;
 
-import org.springframework.boot.actuate.autoconfigure.endpoint.web.documentation.MockMvcEndpointDocumentationTests;
+import org.springframework.boot.actuate.docs.MockMvcEndpointDocumentationTests;
 import org.springframework.boot.actuate.endpoint.SecurityContext;
 import org.springframework.boot.actuate.health.AdditionalHealthEndpointPath;
 import org.springframework.boot.actuate.health.CompositeHealthContributor;

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/heapdump.adoc renamed to spring-boot-project/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/heapdump.adoc

@@ -14,15 +14,15 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.actuate.autoconfigure.info;
+package org.springframework.boot.actuate.docs.info;
 
 import java.time.Instant;
 import java.util.List;
 import java.util.Properties;
 
 import org.junit.jupiter.api.Test;
 
-import org.springframework.boot.actuate.autoconfigure.endpoint.web.documentation.MockMvcEndpointDocumentationTests;
+import org.springframework.boot.actuate.docs.MockMvcEndpointDocumentationTests;
 import org.springframework.boot.actuate.info.BuildInfoContributor;
 import org.springframework.boot.actuate.info.GitInfoContributor;
 import org.springframework.boot.actuate.info.InfoContributor;

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/httpexchanges.adoc renamed to spring-boot-project/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/httpexchanges.adoc

@@ -14,11 +14,11 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.actuate.autoconfigure.integration;
+package org.springframework.boot.actuate.docs.integration;
 
 import org.junit.jupiter.api.Test;
 
-import org.springframework.boot.actuate.autoconfigure.endpoint.web.documentation.MockMvcEndpointDocumentationTests;
+import org.springframework.boot.actuate.docs.MockMvcEndpointDocumentationTests;
 import org.springframework.boot.actuate.integration.IntegrationGraphEndpoint;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/index.adoc renamed to spring-boot-project/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/index.adoc

@@ -14,14 +14,14 @@
  * limitations under the License.
  */
 
-package org.springframework.boot.actuate.autoconfigure.liquibase;
+package org.springframework.boot.actuate.docs.liquibase;
 
 import java.util.List;
 
 import liquibase.changelog.ChangeSet.ExecType;
 import org.junit.jupiter.api.Test;
 
-import org.springframework.boot.actuate.autoconfigure.endpoint.web.documentation.MockMvcEndpointDocumentationTests;
+import org.springframework.boot.actuate.docs.MockMvcEndpointDocumentationTests;
 import org.springframework.boot.actuate.liquibase.LiquibaseEndpoint;
 import org.springframework.boot.jdbc.autoconfigure.EmbeddedDataSourceConfiguration;
 import org.springframework.boot.liquibase.autoconfigure.LiquibaseAutoConfiguration;
@@ -44,7 +44,7 @@
  * @author Andy Wilkinson
  */
 @TestPropertySource(
-		properties = "spring.liquibase.change-log=classpath:org/springframework/boot/actuate/autoconfigure/liquibase/db.changelog-master.yaml")
+		properties = "spring.liquibase.change-log=classpath:org/springframework/boot/actuate/docs/liquibase/db.changelog-master.yaml")
 class LiquibaseEndpointDocumentationTests extends MockMvcEndpointDocumentationTests {
 
 	@Test