diff --git a/baseline-error-prone/src/main/java/com/palantir/baseline/errorprone/GradleProviderToString.java b/baseline-error-prone/src/main/java/com/palantir/baseline/errorprone/GradleProviderToString.java new file mode 100644 index 000000000..70ce742b3 --- /dev/null +++ b/baseline-error-prone/src/main/java/com/palantir/baseline/errorprone/GradleProviderToString.java @@ -0,0 +1,56 @@ +/* + * (c) Copyright 2020 Palantir Technologies Inc. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.palantir.baseline.errorprone; + +import com.google.auto.service.AutoService; +import com.google.errorprone.BugPattern; +import com.google.errorprone.VisitorState; +import com.google.errorprone.bugpatterns.AbstractToString; +import com.google.errorprone.bugpatterns.BugChecker; +import com.google.errorprone.fixes.Fix; +import com.google.errorprone.fixes.SuggestedFix; +import com.google.errorprone.predicates.TypePredicate; +import com.google.errorprone.predicates.TypePredicates; +import com.sun.source.tree.ExpressionTree; +import com.sun.source.tree.Tree; +import java.util.Optional; + +@AutoService(BugChecker.class) +@BugPattern( + name = "GradleProviderToString", + summary = "Calling toString on a Provider does not render the contained value", + severity = BugPattern.SeverityLevel.ERROR) +public final class GradleProviderToString extends AbstractToString { + + private static final TypePredicate IS_PROVIDER = TypePredicates.isDescendantOf("org.gradle.api.provider.Provider"); + + @Override + protected TypePredicate typePredicate() { + return IS_PROVIDER; + } + + @Override + protected Optional implicitToStringFix(ExpressionTree tree, VisitorState state) { + // Note that this might not always be the right thing to do, but it's right in enough cases we should do it. + return Optional.of(SuggestedFix.postfixWith(tree, ".get()")); + } + + @Override + protected Optional toStringFix(Tree parent, ExpressionTree expression, VisitorState state) { + return Optional.empty(); + } +} diff --git a/baseline-error-prone/src/test/java/com/palantir/baseline/errorprone/GradleProviderToStringTest.java b/baseline-error-prone/src/test/java/com/palantir/baseline/errorprone/GradleProviderToStringTest.java new file mode 100644 index 000000000..0094541ba --- /dev/null +++ b/baseline-error-prone/src/test/java/com/palantir/baseline/errorprone/GradleProviderToStringTest.java @@ -0,0 +1,80 @@ +/* + * (c) Copyright 2020 Palantir Technologies Inc. All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.palantir.baseline.errorprone; + +import com.google.errorprone.CompilationTestHelper; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +public class GradleProviderToStringTest { + + private CompilationTestHelper compilationHelper; + private RefactoringValidator refactoringValidator; + + @BeforeEach + public void before() { + compilationHelper = CompilationTestHelper.newInstance(GradleProviderToString.class, getClass()); + refactoringValidator = RefactoringValidator.of(new GradleProviderToString(), getClass()); + } + + @Test + public void failsUsedInStringConcatenation() { + compilationHelper + .addSourceLines( + "Foo.java", + "import org.gradle.api.Project;", + "import org.gradle.api.Plugin;", + "import org.gradle.api.provider.Provider;", + "class Foo implements Plugin {", + " public final void apply(Project project) {", + " String nonProvider = \"foo\";", + " Provider provider = project.provider(() -> \"hello\");", + " // BUG: Diagnostic contains: Calling toString on a Provider", + " String value = \"My bad provider value: \" + provider + nonProvider;", + " }", + "}") + .doTest(); + } + + @Test + public void failsUsedInStringConcatenation_replacesWithGet() { + refactoringValidator + .addInputLines( + "Foo.java", + "import org.gradle.api.Project;", + "import org.gradle.api.Plugin;", + "import org.gradle.api.provider.Provider;", + "class Foo implements Plugin {", + " public final void apply(Project project) {", + " Provider provider = project.provider(() -> \"hello\");", + " String value = \"My bad provider value: \" + provider;", + " }", + "}") + .addOutputLines( + "Foo.java", + "import org.gradle.api.Project;", + "import org.gradle.api.Plugin;", + "import org.gradle.api.provider.Provider;", + "class Foo implements Plugin {", + " public final void apply(Project project) {", + " Provider provider = project.provider(() -> \"hello\");", + " String value = \"My bad provider value: \" + provider.get();", + " }", + "}") + .doTest(); + } +} diff --git a/changelog/@unreleased/pr-1322.v2.yml b/changelog/@unreleased/pr-1322.v2.yml new file mode 100644 index 000000000..62f4756ce --- /dev/null +++ b/changelog/@unreleased/pr-1322.v2.yml @@ -0,0 +1,5 @@ +type: feature +feature: + description: Forbid implicit toString of Gradle Providers. + links: + - https://github.com/palantir/gradle-baseline/pull/1322