Space assignment rule handles ambiguous DSL for getting a project property

Author: OdysseusLives

src/main/groovy/com/netflix/nebula/lint/rule/dsl/SpaceAssignmentRule.groovy

@@ -1,5 +1,6 @@
 package com.netflix.nebula.lint.rule.dsl
 
+
 import com.netflix.nebula.lint.rule.BuildFiles
 import com.netflix.nebula.lint.rule.ModelAwareGradleLintRule
 import com.netflix.nebula.lint.utils.IndentUtils
@@ -35,6 +36,13 @@ class SpaceAssignmentRule extends ModelAwareGradleLintRule {
             return // no matching property
         }
 
+        if (call.methodAsString == 'property' && call.objectExpression != null) {
+            if (call.objectExpression.text?.toLowerCase()?.contains("project") || call.objectExpression.toString().contains("PropertyExpression")) {
+                addViolationForGettingAProperty(call)
+                return
+            }
+        }
+
         // check if it's a generated method for space assignment
         def exactMethod = receiverClass.getMethods().find { it.name == invokedMethodName }
         if (exactMethod != null) {
@@ -71,4 +79,17 @@ class SpaceAssignmentRule extends ModelAwareGradleLintRule {
         def originalLine = getSourceCode().line(call.lineNumber-1)
         return originalLine.replaceFirst(call.methodAsString, call.methodAsString + " =")
     }
+
+    private void addViolationForGettingAProperty(MethodCallExpression call) {
+        BuildFiles.Original originalFile = buildFiles.original(call.lineNumber)
+
+        def violation = addBuildLintViolation(description + ". Getters for properties should use unambiguous DSL", call)
+        def violationLineText = violation.files.text.readLines().subList(call.lineNumber - 1, call.lastLineNumber)[0]
+        def replacement = violationLineText.replaceFirst(".property", ".findProperty")
+
+        violation.insertBefore(call, replacement)
+                .deleteLines(originalFile.file, originalFile.line..originalFile.line)
+    }
+
+
 }

src/test/groovy/com/netflix/nebula/lint/rule/dsl/SpaceAssignmentRuleSpec.groovy

@@ -6,6 +6,14 @@ import spock.lang.Subject
 @Subject(SpaceAssignmentRule)
 class SpaceAssignmentRuleSpec extends BaseIntegrationTestKitSpec {
 
+    def setup() {
+        System.setProperty("ignoreDeprecations", "true")
+    }
+
+    def cleanup() {
+        System.setProperty("ignoreDeprecations", "false")
+    }
+
     def 'reports and fixes a violation if space assignment syntax is used - simple cases'() {
         buildFile << """
             import java.util.regex.Pattern;
@@ -182,4 +190,80 @@ class SpaceAssignmentRuleSpec extends BaseIntegrationTestKitSpec {
         and:
         runTasks('help', '--warning-mode', 'none')
     }
+
+    def 'reports and fixes a violation if space assignment syntax is used as a property getter - simple cases'() {
+        buildFile << """
+            plugins {
+                id 'java'
+                id 'nebula.lint'
+            }
+            gradleLint.rules = ['space-assignment']
+            tasks.register('task1') {
+                if (project.hasProperty('myCustomDescription')) {
+                    description = project.property('myCustomDescription')
+                }
+                doLast {
+                    logger.warn "myCustomDescription: \${description}"
+                }
+            }
+            tasks.register('task2', Exec) {
+                commandLine "echo"
+                args ('--task2', project.property("myCustomProperty1"))
+                doLast {
+                    logger.warn "myCustomProperty1: \${project.property('myCustomProperty1')}"
+                }
+            }
+            def a = project.property "myCustomProperty2"
+            
+            def subA = project(':subA')
+            subA.afterEvaluate { evaluatedProject ->
+                def b = project.rootProject.allprojects.find { it.name == "subA"}.property("myCustomPropertySubA1")
+                def c = rootProject.childProjects.subA.property("myCustomPropertySubA2")
+                def d = project.findProject(':subA').property("myCustomPropertySubA3")
+                tasks.register('showProperties') {
+                    doLast {
+                        logger.warn "myCustomProperty2: \${a}"
+                        logger.warn "subA.myCustomPropertySubA1: \${b}"
+                        logger.warn "subA.myCustomPropertySubA2: \${c}"
+                        logger.warn "subA.myCustomPropertySubA3: \${d}"
+                    }
+                }
+            }
+            """.stripIndent()
+
+        new File(projectDir, "gradle.properties") << """)
+            myCustomDescription=This is a custom description
+            myCustomProperty1=property1
+            myCustomProperty2=property2
+        """.stripIndent()
+
+        addSubproject('subA', """
+            ext {
+                myCustomPropertySubA1 = "subA-one"
+                myCustomPropertySubA2 = "subA-two"
+                myCustomPropertySubA3 = "subA-three"
+            }
+            """.stripIndent())
+
+        when:
+        runTasks('fixLintGradle', '--warning-mode', 'none')
+        def results = runTasks('task1', 'task2', 'showProperties')
+
+        then: "fixes are applied correctly"
+        buildFile.text.contains("description = project.findProperty('myCustomDescription')")
+        buildFile.text.contains("args ('--task2', project.findProperty(\"myCustomProperty1\"))")
+        buildFile.text.contains("logger.warn \"myCustomProperty1: \${project.findProperty('myCustomProperty1')}\"")
+        buildFile.text.contains("def a = project.findProperty \"myCustomProperty2\"")
+        buildFile.text.contains("def b = project.rootProject.allprojects.find { it.name == \"subA\"}.findProperty(\"myCustomPropertySubA1\")")
+        buildFile.text.contains("def c = rootProject.childProjects.subA.findProperty(\"myCustomPropertySubA2\")")
+        buildFile.text.contains("def d = project.findProject(':subA').findProperty(\"myCustomPropertySubA3\")")
+
+        and: "properties are read and printed correctly"
+        results.output.contains("myCustomDescription: This is a custom description")
+        results.output.contains("myCustomProperty1: property1")
+        results.output.contains("myCustomProperty2: property2")
+        results.output.contains("subA.myCustomPropertySubA1: subA-one")
+        results.output.contains("subA.myCustomPropertySubA2: subA-two")
+        results.output.contains("subA.myCustomPropertySubA3: subA-three")
+    }
 }