-
Notifications
You must be signed in to change notification settings - Fork 743
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Per b/201676318, this converts `getSeconds` without corresponding `getNano` to `toSeconds. The bulk of the codebase (java) has been migrated. Only a warning for now (though I supposed GoodTime will make it an error). Will suppress in 3P on a need-to-basis. PiperOrigin-RevId: 688240816
- Loading branch information
1 parent
82a2168
commit 427b51d
Showing
3 changed files
with
149 additions
and
0 deletions.
There are no files selected for viewing
61 changes: 61 additions & 0 deletions
61
...c/main/java/com/google/errorprone/bugpatterns/time/JavaDurationGetSecondsToToSeconds.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
/* | ||
* Copyright 2018 The Error Prone Authors. | ||
* | ||
* 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.google.errorprone.bugpatterns.time; | ||
|
||
import static com.google.errorprone.BugPattern.SeverityLevel.WARNING; | ||
import static com.google.errorprone.bugpatterns.time.NearbyCallers.containsCallToSameReceiverNearby; | ||
import static com.google.errorprone.matchers.Matchers.allOf; | ||
import static com.google.errorprone.matchers.method.MethodMatchers.instanceMethod; | ||
|
||
import com.google.errorprone.BugPattern; | ||
import com.google.errorprone.VisitorState; | ||
import com.google.errorprone.bugpatterns.BugChecker; | ||
import com.google.errorprone.bugpatterns.BugChecker.MethodInvocationTreeMatcher; | ||
import com.google.errorprone.fixes.SuggestedFixes; | ||
import com.google.errorprone.matchers.Description; | ||
import com.google.errorprone.matchers.Matcher; | ||
import com.google.errorprone.matchers.Matchers; | ||
import com.sun.source.tree.ExpressionTree; | ||
import com.sun.source.tree.MethodInvocationTree; | ||
|
||
/** Error prone checking for {@code Duration.getSeconds()} without {@code Duration.getNano()}. */ | ||
@BugPattern( | ||
summary = "Prefer duration.toSeconds() over duration.getSeconds()", | ||
explanation = | ||
"duration.getSeconds() is a decomposition API which should always be used alongside" | ||
+ " duration.getNano(). duration.toSeconds() is a conversion API, and the preferred way" | ||
+ " to convert to seconds.", | ||
severity = WARNING) | ||
public final class JavaDurationGetSecondsToToSeconds extends BugChecker | ||
implements MethodInvocationTreeMatcher { | ||
|
||
private static final Matcher<ExpressionTree> GET_SECONDS = | ||
instanceMethod().onExactClass("java.time.Duration").named("getSeconds"); | ||
private static final Matcher<ExpressionTree> GET_NANO = | ||
allOf( | ||
instanceMethod().onExactClass("java.time.Duration").named("getNano"), | ||
Matchers.not(Matchers.packageStartsWith("java."))); | ||
|
||
@Override | ||
public Description matchMethodInvocation(MethodInvocationTree tree, VisitorState state) { | ||
if (GET_SECONDS.matches(tree, state)) { | ||
if (!containsCallToSameReceiverNearby(tree, GET_NANO, state, /* checkProtoChains= */ false)) { | ||
return describeMatch(tree, SuggestedFixes.renameMethodInvocation(tree, "toSeconds", state)); | ||
} | ||
} | ||
return Description.NO_MATCH; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
86 changes: 86 additions & 0 deletions
86
...st/java/com/google/errorprone/bugpatterns/time/JavaDurationGetSecondsToToSecondsTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
/* | ||
* Copyright 2018 The Error Prone Authors. | ||
* | ||
* 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.google.errorprone.bugpatterns.time; | ||
|
||
import com.google.errorprone.BugCheckerRefactoringTestHelper; | ||
import com.google.errorprone.CompilationTestHelper; | ||
import org.junit.Test; | ||
import org.junit.runner.RunWith; | ||
import org.junit.runners.JUnit4; | ||
|
||
/** Tests for {@link JavaDurationGetSecondsToToSeconds}. */ | ||
@RunWith(JUnit4.class) | ||
public class JavaDurationGetSecondsToToSecondsTest { | ||
|
||
private final CompilationTestHelper compilationHelper = | ||
CompilationTestHelper.newInstance(JavaDurationGetSecondsToToSeconds.class, getClass()); | ||
|
||
private final BugCheckerRefactoringTestHelper refactorHelper = | ||
BugCheckerRefactoringTestHelper.newInstance( | ||
JavaDurationGetSecondsToToSeconds.class, getClass()); | ||
|
||
@Test | ||
public void testNegative() { | ||
compilationHelper | ||
.addSourceLines( | ||
"test/TestCase.java", | ||
""" | ||
package test; | ||
import java.time.Duration; | ||
public class TestCase { | ||
public static void foo(Duration duration) { | ||
long seconds = duration.getSeconds(); | ||
int nanos = duration.getNano(); | ||
} | ||
} | ||
""") | ||
.doTest(); | ||
} | ||
|
||
@Test | ||
public void testPositive() { | ||
refactorHelper | ||
.addInputLines( | ||
"test/TestCase.java", | ||
""" | ||
package test; | ||
import java.time.Duration; | ||
public class TestCase { | ||
public static void foo(Duration duration) { | ||
long seconds = duration.getSeconds(); | ||
} | ||
} | ||
""") | ||
.addOutputLines( | ||
"out/TestCase.java", | ||
""" | ||
package test; | ||
import java.time.Duration; | ||
public class TestCase { | ||
public static void foo(Duration duration) { | ||
long seconds = duration.toSeconds(); | ||
} | ||
} | ||
""") | ||
.doTest(); | ||
} | ||
} |