-
Notifications
You must be signed in to change notification settings - Fork 57
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add URLEqualHashCode Recipe Based upon, but not completely fixing this: https://errorprone.info/bugpattern/URLEqualsHashCode Signed-off-by: Jonathan Leitschuh <Jonathan.Leitschuh@gmail.com> * Apply suggestions from code review Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Remove unnecessary blank line --------- Signed-off-by: Jonathan Leitschuh <Jonathan.Leitschuh@gmail.com> Co-authored-by: Tim te Beek <tim@moderne.io> Co-authored-by: Tim te Beek <timtebeek@gmail.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
- Loading branch information
1 parent
4073a69
commit 7838285
Showing
2 changed files
with
161 additions
and
0 deletions.
There are no files selected for viewing
69 changes: 69 additions & 0 deletions
69
src/main/java/org/openrewrite/staticanalysis/URLEqualsHashCode.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,69 @@ | ||
/* | ||
* Copyright 2024 the original author or authors. | ||
* <p> | ||
* 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 | ||
* <p> | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* <p> | ||
* 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 org.openrewrite.staticanalysis; | ||
|
||
import com.google.errorprone.refaster.annotation.AfterTemplate; | ||
import com.google.errorprone.refaster.annotation.BeforeTemplate; | ||
import org.openrewrite.java.template.RecipeDescriptor; | ||
|
||
import java.net.URI; | ||
import java.net.URL; | ||
|
||
@SuppressWarnings("UrlHashCode") | ||
@RecipeDescriptor( | ||
name = "URL Equals and Hash Code", | ||
description = "Uses of `equals()` and `hashCode()` cause `java.net.URL` to make blocking internet connections. " + | ||
"Instead, use `java.net.URI`.", | ||
tags = {"RSPEC-2112"} | ||
) | ||
public class URLEqualsHashCode { | ||
|
||
@RecipeDescriptor( | ||
name = "URL Equals", | ||
description = "Uses of `equals()` cause `java.net.URL` to make blocking internet connections. " + | ||
"Instead, use `java.net.URI`.", | ||
tags = {"RSPEC-2112"} | ||
) | ||
public static class URLEquals { | ||
@BeforeTemplate | ||
boolean before(URL a, URL b) { | ||
return a.equals(b); | ||
} | ||
|
||
@AfterTemplate | ||
boolean after(URL a, URL b) { | ||
return URI.create(a.toString()).equals(URI.create(b.toString())); | ||
} | ||
} | ||
|
||
@RecipeDescriptor( | ||
name = "URL Hash Code", | ||
description = "Uses of `hashCode()` cause `java.net.URL` to make blocking internet connections. " + | ||
"Instead, use `java.net.URI`.", | ||
tags = {"RSPEC-2112"} | ||
) | ||
public static class URLHashCode { | ||
@BeforeTemplate | ||
int before(URL a) { | ||
return a.hashCode(); | ||
} | ||
|
||
@AfterTemplate | ||
int after(URL a) { | ||
return URI.create(a.toString()).hashCode(); | ||
} | ||
} | ||
} |
92 changes: 92 additions & 0 deletions
92
src/test/java/org/openrewrite/staticanalysis/URLEqualsHashCodeTest.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,92 @@ | ||
/* | ||
* Copyright 2024 the original author or authors. | ||
* <p> | ||
* 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 | ||
* <p> | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* <p> | ||
* 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 org.openrewrite.staticanalysis; | ||
|
||
import org.junit.jupiter.api.Test; | ||
import org.openrewrite.DocumentExample; | ||
import org.openrewrite.test.RecipeSpec; | ||
import org.openrewrite.test.RewriteTest; | ||
|
||
import static org.openrewrite.java.Assertions.java; | ||
|
||
class URLEqualsHashCodeTest implements RewriteTest { | ||
|
||
@Override | ||
public void defaults(RecipeSpec spec) { | ||
spec.recipe(new URLEqualsHashCodeRecipes()); | ||
} | ||
|
||
@DocumentExample | ||
@Test | ||
void urlHashCode() { | ||
rewriteRun( | ||
java( | ||
""" | ||
import java.net.URL; | ||
class Test { | ||
public void test() { | ||
URL url = new URL("https://example.com"); | ||
int hash = url.hashCode(); | ||
} | ||
} | ||
""", | ||
""" | ||
import java.net.URI; | ||
import java.net.URL; | ||
class Test { | ||
public void test() { | ||
URL url = new URL("https://example.com"); | ||
int hash = URI.create(url.toString()).hashCode(); | ||
} | ||
} | ||
""" | ||
) | ||
); | ||
} | ||
|
||
@Test | ||
void urlEquals() { | ||
rewriteRun( | ||
java( | ||
""" | ||
import java.net.URL; | ||
class Test { | ||
public void test() { | ||
URL url1 = new URL("https://example.com"); | ||
URL url2 = new URL("https://example.com"); | ||
boolean equals = url1.equals(url2); | ||
} | ||
} | ||
""", | ||
""" | ||
import java.net.URI; | ||
import java.net.URL; | ||
class Test { | ||
public void test() { | ||
URL url1 = new URL("https://example.com"); | ||
URL url2 = new URL("https://example.com"); | ||
boolean equals = URI.create(url1.toString()).equals(URI.create(url2.toString())); | ||
} | ||
} | ||
""" | ||
) | ||
); | ||
} | ||
} |