Add checkOverbroadConstraints to check task (#1258)

Add `checkOverbroadConstraints` to `check` task
palantir · Oct 28, 2024 · 8318ac2 · 8318ac2
1 parent 0b82090
commit 8318ac2
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 16 deletions.
diff --git a/changelog/@unreleased/pr-1258.v2.yml b/changelog/@unreleased/pr-1258.v2.yml
@@ -0,0 +1,5 @@
+type: fix
+fix:
+  description: Add `checkOverbroadConstraints` to `check` task
+  links:
+  - https://github.com/palantir/gradle-consistent-versions/pull/1258
diff --git a/src/main/java/com/palantir/gradle/versions/VersionsPropsPlugin.java b/src/main/java/com/palantir/gradle/versions/VersionsPropsPlugin.java
@@ -92,16 +92,14 @@ public final void apply(Project project) {
                     });
             project.getTasks().named("check").configure(task -> task.dependsOn(checkNoUnusedConstraints));
 
-            // Currently checkOverbroadConstraints is not running as part of check while for testing - uncomment once
-            // testing is complete (also uncomment groovy test)
-            //            TaskProvider<CheckOverbroadConstraints> checkOverbroadConstraints =
-            project.getTasks().register("checkOverbroadConstraints", CheckOverbroadConstraints.class, task -> {
-                task.getLockFile().set(project.getLayout().getProjectDirectory().file("versions.lock"));
-                task.getPropsFile()
-                        .set(project.getLayout().getProjectDirectory().file("versions.props"));
-            });
-            //                project.getTasks().named("check").configure(task ->
-            // task.dependsOn(checkOverbroadConstraints));
+            TaskProvider<CheckOverbroadConstraints> checkOverbroadConstraints = project.getTasks()
+                    .register("checkOverbroadConstraints", CheckOverbroadConstraints.class, task -> {
+                        task.getLockFile()
+                                .set(project.getLayout().getProjectDirectory().file("versions.lock"));
+                        task.getPropsFile()
+                                .set(project.getLayout().getProjectDirectory().file("versions.props"));
+                    });
+            project.getTasks().named("check").configure(task -> task.dependsOn(checkOverbroadConstraints));
 
             // Create "platform" configuration in root project, which will hold the versions props constraints
             project.getConfigurations().register(GCV_VERSIONS_PROPS_CONSTRAINTS_CONFIGURATION_NAME, conf -> {

diff --git a/src/test/groovy/com/palantir/gradle/versions/CheckOverbroadConstraintsIntegrationSpec.groovy b/src/test/groovy/com/palantir/gradle/versions/CheckOverbroadConstraintsIntegrationSpec.groovy
@@ -53,12 +53,11 @@ class CheckOverbroadConstraintsIntegrationSpec extends IntegrationSpec {
         runTasks('checkOverbroadConstraints')
     }
 
-//    Currently checkOverbroadConstraints is not running as part of check while for testing uncomment once re-added to check
-//    def 'Task should run as part of :check'() {
-//        expect:
-//        def result = runTasks('check', '-m')
-//        result.output.contains(':checkOverbroadConstraints')
-//    }
+    def 'Task should run as part of :check'() {
+        expect:
+        def result = runTasks('check', '-m')
+        result.output.contains(':checkOverbroadConstraints')
+    }
 
     def 'All versions are pinned'() {
         when: