include constructor and method declarations on the calls stack in order to avoid expressions in those declarations being seen as being invoked at the root of the script

John Burns · John Burns · commit ae7f86884535 · 2025-08-12T16:23:08.000-05:00
upgrade to Gradle 9.0.0 (release)
diff --git a/build.gradle b/build.gradle
@@ -87,11 +87,17 @@ dependencies {
     }
     plugin 'org.eclipse.jdt:core:3.3.0-v_771'
 
+    // These are because the AbstractRuleSpec test harness is included in src/main
     compileOnly "com.netflix.nebula:nebula-test:11.+"
+    compileOnly("org.spockframework:spock-core:2.3-groovy-4.0")
+    compileOnly("junit:junit:4.13.2")
+    compileOnly(gradleTestKit())
 
     testImplementation 'org.ow2.asm:asm-util:9.8'
     testImplementation 'joda-time:joda-time:latest.release'
     testImplementation 'com.netflix.nebula:gradle-info-plugin:latest.release'
+    testImplementation("org.spockframework:spock-core:2.3-groovy-4.0")
+    testImplementation("org.spockframework:spock-junit4:2.3-groovy-4.0")
 }
 
 afterEvaluate {
@@ -204,3 +210,9 @@ validatePlugins {
 javaCrossCompile {
     disableKotlinSupport = true
 }
+
+tasks.wrapper {
+    distributionType = Wrapper.DistributionType.BIN
+    gradleVersion = "9.0.0"
+    distributionSha256Sum = "8fad3d78296ca518113f3d29016617c7f9367dc005f932bd9d93bf45ba46072b"
+}
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,7 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionSha256Sum=f09991ce63e889bf8a5f579a467a82bdf7621bc93d59cd2f8fe5982f39f28e2a
-distributionUrl=https\://services.gradle.org/distributions/gradle-9.0.0-rc-4-bin.zip
+distributionSha256Sum=8fad3d78296ca518113f3d29016617c7f9367dc005f932bd9d93bf45ba46072b
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.0.0-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
diff --git a/src/main/groovy/com/netflix/nebula/lint/rule/CompositeGroovyAstVisitor.groovy b/src/main/groovy/com/netflix/nebula/lint/rule/CompositeGroovyAstVisitor.groovy
@@ -18,7 +18,7 @@ import org.codenarc.source.SourceCode
  */
 class CompositeGroovyAstVisitor extends ClassCodeVisitorSupport implements AstVisitor {
     List<GroovyAstVisitor> visitors
-    Stack<MethodCallExpression> callStack
+    Stack<AnnotatedNode> callStack
 
     @Override
     protected SourceUnit getSourceUnit() {
@@ -85,19 +85,28 @@ class CompositeGroovyAstVisitor extends ClassCodeVisitorSupport implements AstVi
 
     @Override
     protected void visitConstructorOrMethod(MethodNode node, boolean isConstructor) {
-        super.visitConstructorOrMethod(node, isConstructor)
+        // within a method or constructor declaration, this code is not actually being invoked
+        if (node.declaringClass.name == "None") {
+            super.visitConstructorOrMethod(node, isConstructor)
+        }
     }
 
     @Override
     void visitConstructor(ConstructorNode node) {
-        visitors.each { it.visitConstructor(node) }
-        super.visitConstructor(node)
+        // within a method or constructor declaration, this code is not actually being invoked
+        if (node.declaringClass.name == "None") {
+            visitors.each { it.visitConstructor(node) }
+            super.visitConstructor(node)
+        }
     }
 
     @Override
     void visitMethod(MethodNode node) {
-        visitors.each { it.visitMethod(node) }
-        super.visitMethod(node)
+        // within a method or constructor declaration, this code is not actually being invoked
+        if (node.declaringClass.name == "None") {
+            visitors.each { it.visitMethod(node) }
+            super.visitMethod(node)
+        }
     }
 
     @Override
diff --git a/src/main/groovy/com/netflix/nebula/lint/rule/GradleLintRule.groovy b/src/main/groovy/com/netflix/nebula/lint/rule/GradleLintRule.groovy
@@ -20,17 +20,9 @@ import com.netflix.nebula.lint.GradleViolation
 import com.netflix.nebula.lint.plugin.LintRuleRegistry
 import com.netflix.nebula.lint.plugin.UnexpectedLintRuleFailureException
 import org.codehaus.groovy.ast.ASTNode
+import org.codehaus.groovy.ast.AnnotatedNode
 import org.codehaus.groovy.ast.ClassNode
-import org.codehaus.groovy.ast.expr.ArgumentListExpression
-import org.codehaus.groovy.ast.expr.BinaryExpression
-import org.codehaus.groovy.ast.expr.ClosureExpression
-import org.codehaus.groovy.ast.expr.ConstantExpression
-import org.codehaus.groovy.ast.expr.Expression
-import org.codehaus.groovy.ast.expr.GStringExpression
-import org.codehaus.groovy.ast.expr.MapExpression
-import org.codehaus.groovy.ast.expr.MethodCallExpression
-import org.codehaus.groovy.ast.expr.PropertyExpression
-import org.codehaus.groovy.ast.expr.VariableExpression
+import org.codehaus.groovy.ast.expr.*
 import org.codehaus.groovy.ast.stmt.ExpressionStatement
 import org.codenarc.rule.AbstractAstVisitorRule
 import org.codenarc.rule.AstVisitor
@@ -53,7 +45,7 @@ abstract class GradleLintRule extends GroovyAstVisitor implements Rule {
     /**
      * Shared state of the method nesting context between gradleAstVisitor and our rule definition.
      */
-    Stack<MethodCallExpression> callStack = new Stack()
+    Stack<AnnotatedNode> callStack = new Stack()
 
     // a little convoluted, but will be set by LintRuleRegistry automatically so that name is derived from
     // the properties file resource that makes this rule available for use
@@ -138,9 +130,9 @@ abstract class GradleLintRule extends GroovyAstVisitor implements Rule {
         dslStack(callStack)
     }
 
-    final List<String> dslStack(List<MethodCallExpression> calls) {
+    final List<String> dslStack(List<AnnotatedNode> calls) {
         def _dslStack
-        _dslStack = { Expression expr ->
+        _dslStack = { AnnotatedNode expr ->
             if (expr instanceof PropertyExpression)
                 _dslStack(expr.objectExpression) + expr.propertyAsString
             else if (expr instanceof MethodCallExpression)
@@ -465,12 +457,12 @@ abstract class GradleLintRule extends GroovyAstVisitor implements Rule {
                             return null
                         }
                         dependency = GradleDependency.fromConstant(expr)
-                    } else if (call.arguments.expressions.any { it instanceof MethodCallExpression && it.methodAsString == 'project'}) {
+                    } else if (call.arguments.expressions.any { it instanceof MethodCallExpression && it.methodAsString == 'project' }) {
                         MethodCallExpression projectMethodCall = call.arguments.expressions
-                                .find { it instanceof MethodCallExpression && it.methodAsString == 'project'} as MethodCallExpression
+                                .find { it instanceof MethodCallExpression && it.methodAsString == 'project' } as MethodCallExpression
                         ConstantExpression projectName =
                                 projectMethodCall.arguments.expressions.
-                                find { it instanceof ConstantExpression} as ConstantExpression
+                                        find { it instanceof ConstantExpression } as ConstantExpression
                         if (projectName != null)
                             visitAnySubmoduleDependency(call, methodName, projectName.value.toString())
                         else if (projectMethodCall.arguments.expressions.any { it instanceof MapExpression }) {
diff --git a/src/test/groovy/com/netflix/nebula/lint/rule/GradleLintRuleSpec.groovy b/src/test/groovy/com/netflix/nebula/lint/rule/GradleLintRuleSpec.groovy
@@ -1,5 +1,5 @@
 /*
- * Copyright 2015-2019 Netflix, Inc.
+ * Copyright 2015-2025 Netflix, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,6 +21,7 @@ import com.netflix.nebula.lint.plugin.GradleLintPlugin
 import com.netflix.nebula.lint.plugin.LintRuleRegistry
 import com.netflix.nebula.lint.rule.test.AbstractRuleSpec
 import org.codehaus.groovy.ast.ClassNode
+import org.codehaus.groovy.ast.expr.BinaryExpression
 import org.codehaus.groovy.ast.expr.Expression
 import org.codehaus.groovy.ast.expr.MethodCallExpression
 import org.codehaus.groovy.ast.expr.VariableExpression
@@ -102,7 +103,7 @@ class GradleLintRuleSpec extends AbstractRuleSpec {
 
             @Override
             void visitGradlePlugin(MethodCallExpression call, String conf, GradlePlugin gradlePluginGradleLintRuleSpec) {
-                if(call.methodAsString == 'apply') {
+                if (call.methodAsString == 'apply') {
                     pluginCount++
                 }
             }
@@ -115,6 +116,42 @@ class GradleLintRuleSpec extends AbstractRuleSpec {
         plugin << ['java', 'org.gradle.java']
     }
 
+    def 'dont visit constructor declaration'() {
+        when:
+        project.buildFile << """
+            b = 2
+            a = 1
+            class A {
+                int a
+                A() {
+                    a = 1
+                }
+            }
+        """
+
+        int assignA = 0
+        int assignARoot = 0
+
+        runRulesAgainst(new AbstractExampleGradleLintRule() {
+            String description = 'test'
+
+            @Override
+            void visitBinaryExpression(BinaryExpression binaryExpression) {
+                if (binaryExpression.leftExpression.variable == 'a') {
+                    if (callStack.isEmpty()) {
+                        assignARoot++
+                    } else {
+                        assignA++
+                    }
+                }
+            }
+        })
+
+        then:
+        assignA == 0
+        assignARoot == 1
+    }
+
     def 'skip nested `plugins`'() {
         when:
         project.buildFile << """
@@ -240,7 +277,6 @@ class GradleLintRuleSpec extends AbstractRuleSpec {
     }
 
 
-
     def 'visit dependencies in subprojects block'() {
         when:
         def subproject = addSubproject('test')
@@ -711,7 +747,7 @@ class GradleLintRuleSpec extends AbstractRuleSpec {
             void visitMethodCallExpression(MethodCallExpression call) {
                 if (call.methodAsString == 'block')
                     addBuildLintViolation('inserting into block', call)
-                .insertIntoClosure(call, 'inserted true')
+                            .insertIntoClosure(call, 'inserted true')
             }
         })
 
@@ -738,7 +774,7 @@ class GradleLintRuleSpec extends AbstractRuleSpec {
             void visitMethodCallExpression(MethodCallExpression call) {
                 if (call.methodAsString == 'block')
                     addBuildLintViolation('inserting into block', call)
-                .insertIntoClosure(call, 'inserted true')
+                            .insertIntoClosure(call, 'inserted true')
             }
         })
 
