feat(spring): Add disabledTests archetype property

jeffjensen · claude · jeffjensen · commit 9250b8072845 · 2026-06-29T11:42:33.000-05:00
Add a disabledTests archetype property (default false). When true, every generated test method is annotated with JUnit's @disabled, so the scaffolded suite compiles but does not run -- useful for adding the audits to a project that does not pass them yet and enabling them one at a time. * Declare disabledTests (default false) in archetype-metadata.xml. * Guard a Disabled import and a per-method @disabled annotation with #if($disabledTests == 'true') in all 11 test templates; the default renders identically to before. * List disabledTests=false in the four existing self-test variants and add a new disabled-tests project-mode self-test (disabledTests=true) that compiles the generated @disabled code and verifies every test is skipped. * Document the property in the site archetype reference and CLAUDE.md. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017xn2cPgARPz3joQXUbtejf
diff --git a/CLAUDE.md b/CLAUDE.md
@@ -136,7 +136,8 @@ mvn archetype:generate -DinteractiveMode=false `
   and `#[[$]]#` produces `$`.
 - **Properties** (`META-INF/maven/archetype-metadata.xml`): `generateMode` (`project`), `schemaName` (`public`),
   `schemaPropertyName` (`database.datasource.schema-name`), `parentClass` (`none`), `databaseAuditsVersion`
-  (`1.0.0-SNAPSHOT`), `springBootVersion` (`4.1.0`), `postgresImage` (`postgres:16`).
+  (`1.0.0-SNAPSHOT`), `springBootVersion` (`4.1.0`), `postgresImage` (`postgres:16`), `disabledTests` (`false`,
+  annotates every generated test method with JUnit's `@Disabled` when `true`).
   All have defaults; none are required. The self-test's `archetype.properties` must list every property that the
   templates reference — the IT mojo does not apply defaults the way `archetype:generate` does.
 - **`projectDirectory` is NOT a declared archetype property** (deliberately). `archetype:generate` therefore
diff --git a/archetype/src/main/resources/META-INF/maven/archetype-metadata.xml b/archetype/src/main/resources/META-INF/maven/archetype-metadata.xml
@@ -36,6 +36,12 @@
     <requiredProperty key="postgresImage">
       <defaultValue>postgres:16</defaultValue>
     </requiredProperty>
+    <!-- When 'true', every generated test method is annotated with JUnit's @Disabled, so the suite is
+         generated and compiles but does not run. Default 'false' runs the audits. Useful for scaffolding the
+         suite into a project that does not pass it yet, then enabling audits one at a time. -->
+    <requiredProperty key="disabledTests">
+      <defaultValue>false</defaultValue>
+    </requiredProperty>
   </requiredProperties>
 
   <fileSets>
diff --git a/archetype/src/main/resources/archetype-resources/src/test/java/catalog/ForeignKeyIndexAuditIT.java b/archetype/src/main/resources/archetype-resources/src/test/java/catalog/ForeignKeyIndexAuditIT.java
@@ -1,5 +1,8 @@
 package ${package}.catalog;
 
+#if($disabledTests == 'true')
+import org.junit.jupiter.api.Disabled;
+#end
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
@@ -27,6 +30,9 @@ public class ForeignKeyIndexAuditIT extends AbstractDatabaseAuditIT {
     private String schema;
 
     @Test
+#if($disabledTests == 'true')
+    @Disabled("Generated as disabled; remove @Disabled to enable")
+#end
     void testEveryForeignKeyHasSupportingIndex() {
         foreignKeyIndexAuditAssertion.assertClean(schema);
     }
diff --git a/archetype/src/main/resources/archetype-resources/src/test/java/catalog/ForeignKeyNotNullAuditIT.java b/archetype/src/main/resources/archetype-resources/src/test/java/catalog/ForeignKeyNotNullAuditIT.java
@@ -2,6 +2,9 @@
 
 import java.util.Set;
 
+#if($disabledTests == 'true')
+import org.junit.jupiter.api.Disabled;
+#end
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
@@ -32,6 +35,9 @@ public class ForeignKeyNotNullAuditIT extends AbstractDatabaseAuditIT {
     private String schema;
 
     @Test
+#if($disabledTests == 'true')
+    @Disabled("Generated as disabled; remove @Disabled to enable")
+#end
     void testEveryForeignKeyColumnIsConfiguredNotNullOrOptional() {
         foreignKeyNotNullAuditAssertion.assertClean(schema, EXCLUDED_COLUMNS);
     }
diff --git a/archetype/src/main/resources/archetype-resources/src/test/java/catalog/ForeignKeyTypeMatchAuditIT.java b/archetype/src/main/resources/archetype-resources/src/test/java/catalog/ForeignKeyTypeMatchAuditIT.java
@@ -2,6 +2,9 @@
 
 import java.util.Set;
 
+#if($disabledTests == 'true')
+import org.junit.jupiter.api.Disabled;
+#end
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
@@ -33,6 +36,9 @@ public class ForeignKeyTypeMatchAuditIT extends AbstractDatabaseAuditIT {
     private String schema;
 
     @Test
+#if($disabledTests == 'true')
+    @Disabled("Generated as disabled; remove @Disabled to enable")
+#end
     void testEveryForeignKeyColumnTypeMatchesItsReferencedColumn() {
         foreignKeyTypeMatchAuditAssertion.assertClean(schema, EXCLUDED_COLUMNS);
     }
diff --git a/archetype/src/main/resources/archetype-resources/src/test/java/catalog/PrimaryKeyPresenceAuditIT.java b/archetype/src/main/resources/archetype-resources/src/test/java/catalog/PrimaryKeyPresenceAuditIT.java
@@ -1,5 +1,8 @@
 package ${package}.catalog;
 
+#if($disabledTests == 'true')
+import org.junit.jupiter.api.Disabled;
+#end
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
@@ -27,6 +30,9 @@ public class PrimaryKeyPresenceAuditIT extends AbstractDatabaseAuditIT {
     private String schema;
 
     @Test
+#if($disabledTests == 'true')
+    @Disabled("Generated as disabled; remove @Disabled to enable")
+#end
     void testEveryBaseTableHasPrimaryKey() {
         primaryKeyPresenceAuditAssertion.assertClean(schema);
     }
diff --git a/archetype/src/main/resources/archetype-resources/src/test/java/catalog/RedundantIndexAuditIT.java b/archetype/src/main/resources/archetype-resources/src/test/java/catalog/RedundantIndexAuditIT.java
@@ -2,6 +2,9 @@
 
 import java.util.Set;
 
+#if($disabledTests == 'true')
+import org.junit.jupiter.api.Disabled;
+#end
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
@@ -32,6 +35,9 @@ public class RedundantIndexAuditIT extends AbstractDatabaseAuditIT {
     private String schema;
 
     @Test
+#if($disabledTests == 'true')
+    @Disabled("Generated as disabled; remove @Disabled to enable")
+#end
     void testNoRedundantIndexes() {
         redundantIndexAuditAssertion.assertClean(schema, EXCLUDED_INDEXES);
     }
diff --git a/archetype/src/main/resources/archetype-resources/src/test/java/jpa/SchemaEntityValidationAuditIT.java b/archetype/src/main/resources/archetype-resources/src/test/java/jpa/SchemaEntityValidationAuditIT.java
@@ -1,5 +1,8 @@
 package ${package}.jpa;
 
+#if($disabledTests == 'true')
+import org.junit.jupiter.api.Disabled;
+#end
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.test.context.TestPropertySource;
@@ -26,6 +29,9 @@ public class SchemaEntityValidationAuditIT extends AbstractDatabaseAuditIT {
     private SchemaEntityValidationAuditAssertion schemaEntityValidationAuditAssertion;
 
     @Test
+#if($disabledTests == 'true')
+    @Disabled("Generated as disabled; remove @Disabled to enable")
+#end
     void testEntitiesMatchSchema() {
         schemaEntityValidationAuditAssertion.assertClean();
     }
diff --git a/archetype/src/main/resources/archetype-resources/src/test/java/runtime/JoinIndexAuditIT.java b/archetype/src/main/resources/archetype-resources/src/test/java/runtime/JoinIndexAuditIT.java
@@ -3,6 +3,9 @@
 import java.util.List;
 import java.util.Set;
 
+#if($disabledTests == 'true')
+import org.junit.jupiter.api.Disabled;
+#end
 import org.junit.jupiter.api.Order;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -35,6 +38,9 @@ public class JoinIndexAuditIT extends AbstractDatabaseAuditIT {
     private JoinIndexAuditAssertion joinIndexAuditAssertion;
 
     @Test
+#if($disabledTests == 'true')
+    @Disabled("Generated as disabled; remove @Disabled to enable")
+#end
     void testEveryJoinKeyIsServedByAnIndex() {
         joinIndexAuditAssertion.assertClean(EXCLUDED_RELATIONS, EXCLUDED_SQL_FRAGMENTS);
     }
diff --git a/archetype/src/main/resources/archetype-resources/src/test/java/runtime/OrderByIndexAuditIT.java b/archetype/src/main/resources/archetype-resources/src/test/java/runtime/OrderByIndexAuditIT.java
@@ -3,6 +3,9 @@
 import java.util.List;
 import java.util.Set;
 
+#if($disabledTests == 'true')
+import org.junit.jupiter.api.Disabled;
+#end
 import org.junit.jupiter.api.Order;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -35,6 +38,9 @@ public class OrderByIndexAuditIT extends AbstractDatabaseAuditIT {
     private OrderByIndexAuditAssertion orderByIndexAuditAssertion;
 
     @Test
+#if($disabledTests == 'true')
+    @Disabled("Generated as disabled; remove @Disabled to enable")
+#end
     void testEveryOrderByIsServedByAnIndexNotAnExplicitSort() {
         orderByIndexAuditAssertion.assertClean(EXCLUDED_RELATIONS, EXCLUDED_SQL_FRAGMENTS);
     }
diff --git a/archetype/src/main/resources/archetype-resources/src/test/java/runtime/RepositoryWorkloadIT.java b/archetype/src/main/resources/archetype-resources/src/test/java/runtime/RepositoryWorkloadIT.java
@@ -1,5 +1,8 @@
 package ${package}.runtime;
 
+#if($disabledTests == 'true')
+import org.junit.jupiter.api.Disabled;
+#end
 import org.junit.jupiter.api.Order;
 import org.junit.jupiter.api.Test;
 #if($generateMode == 'project')
@@ -45,6 +48,9 @@ class RepositoryWorkloadIT extends AbstractDatabaseAuditIT {
     private ChildRepository children;
 
     @Test
+#if($disabledTests == 'true')
+    @Disabled("Generated as disabled; remove @Disabled to enable")
+#end
     void primeSqlCaptureWithIndexableWorkload() {
         Parent parent = parents.save(new Parent("ACME"));
         children.save(new Child("widget", parent));
@@ -56,6 +62,9 @@ void primeSqlCaptureWithIndexableWorkload() {
     // TODO: @Autowired YourRepository yourRepository;
 
     @Test
+#if($disabledTests == 'true')
+    @Disabled("Generated as disabled; remove @Disabled to enable")
+#end
     void primeSqlCaptureWithRepositoryWorkload() {
         // TODO: Call your repository methods here to prime the SQL capturer.
         // Include queries that exercise WHERE, ORDER BY, and JOIN conditions.
diff --git a/archetype/src/main/resources/archetype-resources/src/test/java/runtime/UnconditionalMutationAuditIT.java b/archetype/src/main/resources/archetype-resources/src/test/java/runtime/UnconditionalMutationAuditIT.java
@@ -2,6 +2,9 @@
 
 import java.util.Set;
 
+#if($disabledTests == 'true')
+import org.junit.jupiter.api.Disabled;
+#end
 import org.junit.jupiter.api.Order;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -31,6 +34,9 @@ public class UnconditionalMutationAuditIT extends AbstractDatabaseAuditIT {
     private UnconditionalMutationAuditAssertion unconditionalMutationAuditAssertion;
 
     @Test
+#if($disabledTests == 'true')
+    @Disabled("Generated as disabled; remove @Disabled to enable")
+#end
     void testNoUnconditionalMutations() {
         unconditionalMutationAuditAssertion.assertClean(EXCLUDED_STATEMENTS);
     }
diff --git a/archetype/src/main/resources/archetype-resources/src/test/java/runtime/WhereClauseIndexAuditIT.java b/archetype/src/main/resources/archetype-resources/src/test/java/runtime/WhereClauseIndexAuditIT.java
@@ -3,6 +3,9 @@
 import java.util.List;
 import java.util.Set;
 
+#if($disabledTests == 'true')
+import org.junit.jupiter.api.Disabled;
+#end
 import org.junit.jupiter.api.Order;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -35,6 +38,9 @@ public class WhereClauseIndexAuditIT extends AbstractDatabaseAuditIT {
     private WhereClauseIndexAuditAssertion whereClauseIndexAuditAssertion;
 
     @Test
+#if($disabledTests == 'true')
+    @Disabled("Generated as disabled; remove @Disabled to enable")
+#end
     void testEveryWhereClauseColumnIsIndexed() {
         whereClauseIndexAuditAssertion.assertClean(EXCLUDED_RELATIONS, EXCLUDED_SQL_FRAGMENTS);
     }
diff --git a/archetype/src/test/resources/projects/disabled-tests/archetype.properties b/archetype/src/test/resources/projects/disabled-tests/archetype.properties
@@ -0,0 +1,12 @@
+groupId=com.example
+artifactId=archetype-it-disabled-tests
+version=1.0.0-SNAPSHOT
+package=com.example.demo
+schemaName=public
+schemaPropertyName=database.datasource.schema-name
+postgresImage=postgres:16
+databaseAuditsVersion=@project.version@
+springBootVersion=4.1.0
+generateMode=project
+parentClass=none
+disabledTests=true
diff --git a/archetype/src/test/resources/projects/disabled-tests/goal.txt b/archetype/src/test/resources/projects/disabled-tests/goal.txt
@@ -0,0 +1 @@
+verify
diff --git a/archetype/src/test/resources/projects/full/archetype.properties b/archetype/src/test/resources/projects/full/archetype.properties
@@ -9,3 +9,4 @@ databaseAuditsVersion=@project.version@
 springBootVersion=4.1.0
 generateMode=project
 parentClass=none
+disabledTests=false
diff --git a/archetype/src/test/resources/projects/tests-only-with-project-dir/archetype.properties b/archetype/src/test/resources/projects/tests-only-with-project-dir/archetype.properties
@@ -10,3 +10,4 @@ springBootVersion=4.1.0
 generateMode=tests-only
 parentClass=none
 projectDirectory=target/it-dest/tests-only-with-project-dir
+disabledTests=false
diff --git a/archetype/src/test/resources/projects/tests-only/archetype.properties b/archetype/src/test/resources/projects/tests-only/archetype.properties
@@ -9,3 +9,4 @@ databaseAuditsVersion=@project.version@
 springBootVersion=4.1.0
 generateMode=tests-only
 parentClass=none
+disabledTests=false
diff --git a/archetype/src/test/resources/projects/with-parent-class/archetype.properties b/archetype/src/test/resources/projects/with-parent-class/archetype.properties
@@ -9,3 +9,4 @@ databaseAuditsVersion=@project.version@
 springBootVersion=4.1.0
 generateMode=tests-only
 parentClass=java.lang.Thread
+disabledTests=false
diff --git a/integration/src/site/asciidoc/archetype.adoc b/integration/src/site/asciidoc/archetype.adoc
@@ -128,6 +128,11 @@ Pass only the ones that differ.
 | project only
 | Testcontainers PostgreSQL image used by `DemoPostgresTestConfig`. Override to pin a specific version, e.g. `postgres:17`. Not used in `tests-only` mode.
 
+| `disabledTests`
+| `false`
+| both
+| When `true`, annotates every generated test method with JUnit's `@Disabled`, so the suite is generated and compiles but does not run. Useful for scaffolding the audits into a project that does not pass them yet — remove the `@Disabled` annotations to enable audits one at a time.
+
 | `projectDirectory`
 | (empty)
 | tests-only only
