deps: upgrade enforcer rule to the latest 3.5.0 (#2379)

* deps: upgrade enforcer rule to the latest 3.5.0 Credit: this change is based on the proposed changes by Robert Scholte in #2378 (comment) * Fixing integration tests to use a better syntax in the new enforcer rule version * Detailed error message for the new enforcer rule version
GoogleCloudPlatform · Sep 23, 2024 · 7c7fe4f · 7c7fe4f
1 parent f50c4db
commit 7c7fe4f
Show file tree

Hide file tree

Showing 17 changed files with 234 additions and 200 deletions.
diff --git a/enforcer-rules/README.md b/enforcer-rules/README.md
@@ -17,8 +17,13 @@ $ mvn verify
 Listening for transport dt_socket at address: 5005
 ```
 
-When you debug one of the integration tests in the "src/it" directory, use the following
-command to specify the test case and to provide the debug parameter to Maven invoker plugin. 
+When you debug one of the integration tests in the "src/it" directory, check the
+`build.log` files in the `enforcer-rules/target/it` directory (run
+`find enforcer-rules -name 'build.log'`).
+The file is used in verification scripts and usually contains build errors.
+
+If you want to attach a debugger, use the following  command to specify the test
+case and to provide the debug parameter to Maven invoker plugin. 
 
 ```
 mvn install -Dmaven.test.skip -Dinvoker.test=bom-project-using-spring-repository \

diff --git a/enforcer-rules/pom.xml b/enforcer-rules/pom.xml
@@ -48,7 +48,7 @@
   </licenses>
 
   <properties>
-    <enforcer.version>3.0.0-M3</enforcer.version>
+    <enforcer.version>3.5.0</enforcer.version>
     <maven.compiler.source>1.8</maven.compiler.source>
     <maven.compiler.target>1.8</maven.compiler.target>
   </properties>
@@ -131,6 +131,20 @@
 
   <build>
     <plugins>
+      <plugin>
+        <!-- generate index of project components, this enables users to
+            specify the rule as linkageCheckerRule via the Named annotation -->
+        <groupId>org.eclipse.sisu</groupId>
+        <artifactId>sisu-maven-plugin</artifactId>
+        <version>0.9.0.M1</version>
+        <executions>
+          <execution>
+            <goals>
+              <goal>main-index</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
       <plugin>
         <artifactId>maven-invoker-plugin</artifactId>
         <version>3.2.2</version>

diff --git a/enforcer-rules/src/it/abstract-method-errors/pom.xml b/enforcer-rules/src/it/abstract-method-errors/pom.xml
@@ -52,7 +52,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-enforcer-plugin</artifactId>
-        <version>3.0.0-M3</version>
+        <version>@enforcer.version@</version>
         <dependencies>
           <dependency>
             <groupId>com.google.cloud.tools</groupId>
@@ -69,9 +69,7 @@
             </goals>
             <configuration>
               <rules>
-                <LinkageCheckerRule
-                  implementation="com.google.cloud.tools.dependencies.enforcer.LinkageCheckerRule">
-                </LinkageCheckerRule>
+                <linkageCheckerRule/>
               </rules>
             </configuration>
           </execution>

diff --git a/enforcer-rules/src/it/bom-project-error/pom.xml b/enforcer-rules/src/it/bom-project-error/pom.xml
@@ -54,7 +54,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-enforcer-plugin</artifactId>
-        <version>3.0.0-M3</version>
+        <version>@enforcer.version@</version>
         <dependencies>
           <dependency>
             <groupId>com.google.cloud.tools</groupId>
@@ -71,10 +71,9 @@
             </goals>
             <configuration>
               <rules>
-                <LinkageCheckerRule
-                  implementation="com.google.cloud.tools.dependencies.enforcer.LinkageCheckerRule">
+                <linkageCheckerRule>
                   <dependencySection>DEPENDENCY_MANAGEMENT</dependencySection>
-                </LinkageCheckerRule>
+                </linkageCheckerRule>
               </rules>
             </configuration>
           </execution>

diff --git a/enforcer-rules/src/it/bom-project-no-error/pom.xml b/enforcer-rules/src/it/bom-project-no-error/pom.xml
@@ -50,7 +50,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-enforcer-plugin</artifactId>
-        <version>3.0.0-M3</version>
+        <version>@enforcer.version@</version>
         <dependencies>
           <dependency>
             <groupId>com.google.cloud.tools</groupId>

diff --git a/enforcer-rules/src/it/bom-project-no-packaging/pom.xml b/enforcer-rules/src/it/bom-project-no-packaging/pom.xml
@@ -48,7 +48,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-enforcer-plugin</artifactId>
-        <version>3.0.0-M3</version>
+        <version>@enforcer.version@</version>
         <dependencies>
           <dependency>
             <groupId>com.google.cloud.tools</groupId>
@@ -65,10 +65,9 @@
             </goals>
             <configuration>
               <rules>
-                <LinkageCheckerRule
-                  implementation="com.google.cloud.tools.dependencies.enforcer.LinkageCheckerRule">
+                <linkageCheckerRule>
                   <dependencySection>DEPENDENCY_MANAGEMENT</dependencySection>
-                </LinkageCheckerRule>
+                </linkageCheckerRule>
               </rules>
             </configuration>
           </execution>

diff --git a/enforcer-rules/src/it/bom-project-using-spring-repository/pom.xml b/enforcer-rules/src/it/bom-project-using-spring-repository/pom.xml
@@ -67,7 +67,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-enforcer-plugin</artifactId>
-        <version>3.0.0-M3</version>
+        <version>@enforcer.version@</version>
         <dependencies>
           <dependency>
             <groupId>com.google.cloud.tools</groupId>
@@ -84,10 +84,9 @@
             </goals>
             <configuration>
               <rules>
-                <LinkageCheckerRule
-                  implementation="com.google.cloud.tools.dependencies.enforcer.LinkageCheckerRule">
+                <linkageCheckerRule>
                   <dependencySection>DEPENDENCY_MANAGEMENT</dependencySection>
-                </LinkageCheckerRule>
+                </linkageCheckerRule>
               </rules>
             </configuration>
           </execution>

diff --git a/enforcer-rules/src/it/fail-build-for-linkage-errors/pom.xml b/enforcer-rules/src/it/fail-build-for-linkage-errors/pom.xml
@@ -50,7 +50,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-enforcer-plugin</artifactId>
-        <version>3.0.0-M3</version>
+        <version>@enforcer.version@</version>
         <dependencies>
           <dependency>
             <groupId>com.google.cloud.tools</groupId>
@@ -67,9 +67,7 @@
             </goals>
             <configuration>
               <rules>
-                <LinkageCheckerRule
-                  implementation="com.google.cloud.tools.dependencies.enforcer.LinkageCheckerRule">
-                </LinkageCheckerRule>
+                <linkageCheckerRule />
               </rules>
             </configuration>
           </execution>

diff --git a/enforcer-rules/src/it/inaccessible-class-error/pom.xml b/enforcer-rules/src/it/inaccessible-class-error/pom.xml
@@ -52,7 +52,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-enforcer-plugin</artifactId>
-        <version>3.0.0-M3</version>
+        <version>@enforcer.version@</version>
         <dependencies>
           <dependency>
             <groupId>com.google.cloud.tools</groupId>
@@ -69,9 +69,7 @@
             </goals>
             <configuration>
               <rules>
-                <LinkageCheckerRule
-                  implementation="com.google.cloud.tools.dependencies.enforcer.LinkageCheckerRule">
-                </LinkageCheckerRule>
+                <linkageCheckerRule />
               </rules>
             </configuration>
           </execution>

diff --git a/enforcer-rules/src/it/missing-filter-file-error/pom.xml b/enforcer-rules/src/it/missing-filter-file-error/pom.xml
@@ -50,7 +50,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-enforcer-plugin</artifactId>
-        <version>3.0.0-M3</version>
+        <version>@enforcer.version@</version>
         <dependencies>
           <dependency>
             <groupId>com.google.cloud.tools</groupId>

diff --git a/enforcer-rules/src/it/report-only-reachable-bom/pom.xml b/enforcer-rules/src/it/report-only-reachable-bom/pom.xml
@@ -59,7 +59,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-enforcer-plugin</artifactId>
-        <version>3.0.0-M3</version>
+        <version>@enforcer.version@</version>
         <dependencies>
           <dependency>
             <groupId>com.google.cloud.tools</groupId>
@@ -76,11 +76,10 @@
             </goals>
             <configuration>
               <rules>
-                <LinkageCheckerRule
-                  implementation="com.google.cloud.tools.dependencies.enforcer.LinkageCheckerRule">
+                <linkageCheckerRule>
                   <dependencySection>DEPENDENCY_MANAGEMENT</dependencySection>
                   <reportOnlyReachable>true</reportOnlyReachable>
-                </LinkageCheckerRule>
+                </linkageCheckerRule>
               </rules>
             </configuration>
           </execution>

diff --git a/enforcer-rules/src/it/report-only-reachable/pom.xml b/enforcer-rules/src/it/report-only-reachable/pom.xml
@@ -51,7 +51,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-enforcer-plugin</artifactId>
-        <version>3.0.0-M3</version>
+        <version>@enforcer.version@</version>
         <dependencies>
           <dependency>
             <groupId>com.google.cloud.tools</groupId>
@@ -68,10 +68,9 @@
             </goals>
             <configuration>
               <rules>
-                <LinkageCheckerRule
-                  implementation="com.google.cloud.tools.dependencies.enforcer.LinkageCheckerRule">
+                <linkageCheckerRule>
                   <reportOnlyReachable>true</reportOnlyReachable>
-                </LinkageCheckerRule>
+                </linkageCheckerRule>
               </rules>
             </configuration>
           </execution>

diff --git a/enforcer-rules/src/it/return-type-mismatch/pom.xml b/enforcer-rules/src/it/return-type-mismatch/pom.xml
@@ -47,7 +47,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-enforcer-plugin</artifactId>
-        <version>3.0.0-M3</version>
+        <version>@enforcer.version@</version>
         <dependencies>
           <dependency>
             <groupId>com.google.cloud.tools</groupId>
@@ -64,9 +64,7 @@
             </goals>
             <configuration>
               <rules>
-                <LinkageCheckerRule
-                  implementation="com.google.cloud.tools.dependencies.enforcer.LinkageCheckerRule">
-                </LinkageCheckerRule>
+                <linkageCheckerRule/>
               </rules>
             </configuration>
           </execution>

diff --git a/enforcer-rules/src/it/test-scope/pom.xml b/enforcer-rules/src/it/test-scope/pom.xml
@@ -56,7 +56,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-enforcer-plugin</artifactId>
-        <version>3.0.0-M3</version>
+        <version>@enforcer.version@</version>
         <dependencies>
           <dependency>
             <groupId>com.google.cloud.tools</groupId>
@@ -73,10 +73,9 @@
             </goals>
             <configuration>
               <rules>
-                <LinkageCheckerRule
-                  implementation="com.google.cloud.tools.dependencies.enforcer.LinkageCheckerRule">
+                <linkageCheckerRule>
                   <reportOnlyReachable>true</reportOnlyReachable>
-                </LinkageCheckerRule>
+                </linkageCheckerRule>
               </rules>
             </configuration>
           </execution>

diff --git a/enforcer-rules/src/it/war-project-private-modifier/pom.xml b/enforcer-rules/src/it/war-project-private-modifier/pom.xml
@@ -46,7 +46,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-enforcer-plugin</artifactId>
-        <version>3.0.0-M3</version>
+        <version>@enforcer.version@</version>
         <dependencies>
           <dependency>
             <groupId>com.google.cloud.tools</groupId>