Skip to content

Pull #34816: Add checkstyle rule UnusedLocalVariable, UnusedLocalMethodCheck #34816

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Pull #34816: Add checkstyle rule UnusedLocalVariable, UnusedLocalMethodCheck #34816

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions buildSrc/config/checkstyle/checkstyle.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@

<!-- Imports -->
<module name="AvoidStarImport"/>
<!-- Unused -->
<module name="UnusedImports"/>
<module name="UnusedLocalVariable"/>
<!-- <module name="UnusedLocalMethodCheck"/> https://github.com/checkstyle/checkstyle/pull/16894 -->
<module name="RedundantImport"/>
<!-- Modifiers -->
<module name="com.puppycrawl.tools.checkstyle.checks.modifier.ModifierOrderCheck"/>
Expand Down
2 changes: 1 addition & 1 deletion ...dSrc/src/test/java/org/springframework/build/multirelease/MultiReleaseJarPluginTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ void packageInJar() throws IOException {
writeClass("src/main/java17", "Main.java", """
public class Main {}
""");
BuildResult buildResult = runGradle("assemble");
runGradle("assemble");
File file = new File(this.projectDir, "/build/libs/" + this.projectDir.getName() + "-1.2.3.jar");
assertThat(file).exists();
try (JarFile jar = new JarFile(file)) {
Expand Down
3 changes: 1 addition & 2 deletions ...va/org/springframework/docs/core/aot/hints/testing/SampleReflectionRuntimeHintsTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,7 @@ void shouldRegisterReflectionHints() {

// Invoke the relevant piece of code we want to test within a recording lambda
RuntimeHintsInvocations invocations = org.springframework.aot.test.agent.RuntimeHintsRecorder.record(() -> {
SampleReflection sample = new SampleReflection();
sample.performReflection();
new SampleReflection().performReflection();
});
// assert that the recorded invocations are covered by the contributed hints
assertThat(invocations).match(runtimeHints);
Expand Down
16 changes: 4 additions & 12 deletions integration-tests/src/test/java/org/springframework/aot/test/ReflectionInvocationsTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@

import org.springframework.aot.hint.RuntimeHints;
import org.springframework.aot.test.agent.EnabledIfRuntimeHintsAgent;
import org.springframework.aot.test.agent.RuntimeHintsInvocations;

import static org.assertj.core.api.Assertions.assertThat;

Expand All @@ -33,24 +32,17 @@ class ReflectionInvocationsTests {
void sampleTest() {
RuntimeHints hints = new RuntimeHints();
hints.reflection().registerType(String.class);

RuntimeHintsInvocations invocations = org.springframework.aot.test.agent.RuntimeHintsRecorder.record(() -> {
SampleReflection sample = new SampleReflection();
sample.sample(); // does Method[] methods = String.class.getMethods();
});
assertThat(invocations).match(hints);
// does Method[] methods = String.class.getMethods();
assertThat(org.springframework.aot.test.agent.RuntimeHintsRecorder.record(new SampleReflection()::sample)).match(hints);
}

@Test
void multipleCallsTest() {
RuntimeHints hints = new RuntimeHints();
hints.reflection().registerType(String.class);
hints.reflection().registerType(Integer.class);
RuntimeHintsInvocations invocations = org.springframework.aot.test.agent.RuntimeHintsRecorder.record(() -> {
SampleReflection sample = new SampleReflection();
sample.multipleCalls(); // does Method[] methods = String.class.getMethods(); methods = Integer.class.getMethods();
});
assertThat(invocations).match(hints);
// does String.class.getMethods(); Integer.class.getMethods();
assertThat(org.springframework.aot.test.agent.RuntimeHintsRecorder.record(new SampleReflection()::multipleCalls)).match(hints);
}

}
10 changes: 3 additions & 7 deletions integration-tests/src/test/java/org/springframework/aot/test/SampleReflection.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@

package org.springframework.aot.test;

import java.lang.reflect.Method;

/**
* @author Brian Clozel
* @since 6.0
Expand All @@ -26,15 +24,13 @@ public class SampleReflection {

@SuppressWarnings("unused")
public void sample() {
String value = "Sample";
Method[] methods = String.class.getMethods();
String.class.getMethods();
}

@SuppressWarnings("unused")
public void multipleCalls() {
String value = "Sample";
Method[] methods = String.class.getMethods();
methods = Integer.class.getMethods();
String.class.getMethods();
Integer.class.getMethods();
}

}
12 changes: 3 additions & 9 deletions ...rc/test/java/org/springframework/beans/factory/config/ServiceLocatorFactoryBeanTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,15 +122,9 @@ void testStringArgGetter() throws Exception {
genericBeanDefinition(ServiceLocatorFactoryBean.class)
.addPropertyValue("serviceLocatorInterface", TestServiceLocator2.class)
.getBeanDefinition());

// test string-arg getter with null id
TestServiceLocator2 factory = (TestServiceLocator2) bf.getBean("factory");

@SuppressWarnings("unused")
TestService testBean = factory.getTestService(null);
// now test with explicit id
testBean = factory.getTestService("testService");
// now verify failure on bad id
TestServiceLocator2 factory = (TestServiceLocator2) bf.getBean("factory"); // test string-arg getter with null id
factory.getTestService(null); // now test with explicit id
factory.getTestService("testService"); // now verify failure on bad id
assertThatExceptionOfType(NoSuchBeanDefinitionException.class).isThrownBy(() ->
factory.getTestService("bogusTestService"));
}
Expand Down
3 changes: 1 addition & 2 deletions ...ssion/src/test/java/org/springframework/expression/spel/SpelCompilationCoverageTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7145,8 +7145,7 @@ public TestClass9(int i) {
static class HttpServlet3RequestFactory {

static Servlet3SecurityContextHolderAwareRequestWrapper getOne() {
HttpServlet3RequestFactory outer = new HttpServlet3RequestFactory();
return outer.new Servlet3SecurityContextHolderAwareRequestWrapper();
return new HttpServlet3RequestFactory().new Servlet3SecurityContextHolderAwareRequestWrapper();
}

// private class Servlet3SecurityContextHolderAwareRequestWrapper extends SecurityContextHolderAwareRequestWrapper
Expand Down
24 changes: 10 additions & 14 deletions spring-test/src/test/java/org/springframework/test/web/client/samples/SampleTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,13 +67,15 @@ public void setup() {
@Test
public void performGet() {

String responseBody = "{\"name\" : \"Ludwig van Beethoven\", \"someDouble\" : \"1.6035\"}";
String responseBody = """
{"name" : "Ludwig van Beethoven", "someDouble" : "1.6035"}""";

this.mockServer.expect(requestTo("/composers/42")).andExpect(method(HttpMethod.GET))
.andRespond(withSuccess(responseBody, MediaType.APPLICATION_JSON));

@SuppressWarnings("unused")
Person ludwig = this.restTemplate.getForObject("/composers/{id}", Person.class, 42);
assertThat(ludwig.getName()).isEqualTo("Ludwig van Beethoven");
assertThat(ludwig.getSomeDouble()).isEqualTo(1.6035);

// We are only validating the request. The response is mocked out.
// hotel.getId() == 42
Expand All @@ -90,8 +92,9 @@ public void performGetManyTimes() {
this.mockServer.expect(manyTimes(), requestTo("/composers/42")).andExpect(method(HttpMethod.GET))
.andRespond(withSuccess(responseBody, MediaType.APPLICATION_JSON));

@SuppressWarnings("unused")
Person ludwig = this.restTemplate.getForObject("/composers/{id}", Person.class, 42);
assertThat(ludwig.getName()).isEqualTo("Ludwig van Beethoven");
assertThat(ludwig.getSomeDouble()).isEqualTo(1.6035);

// We are only validating the request. The response is mocked out.
// hotel.getId() == 42
Expand Down Expand Up @@ -142,11 +145,9 @@ public void performGetWithResponseBodyFromFile() {
this.mockServer.expect(requestTo("/composers/42")).andExpect(method(HttpMethod.GET))
.andRespond(withSuccess(responseBody, MediaType.APPLICATION_JSON));

@SuppressWarnings("unused")
Person ludwig = this.restTemplate.getForObject("/composers/{id}", Person.class, 42);

// hotel.getId() == 42
// hotel.getName().equals("Holiday Inn")
assertThat(ludwig.getName()).isEqualTo("Ludwig van Beethoven");
assertThat(ludwig.getSomeDouble()).isEqualTo(1.6035);

this.mockServer.verify();
}
Expand All @@ -166,13 +167,8 @@ public void verify() {
this.mockServer.expect(requestTo("/number")).andExpect(method(HttpMethod.GET))
.andRespond(withSuccess("8", MediaType.TEXT_PLAIN));

@SuppressWarnings("unused")
String result1 = this.restTemplate.getForObject("/number", String.class);
// result1 == "1"
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why no simple assertThat?


@SuppressWarnings("unused")
String result2 = this.restTemplate.getForObject("/number", String.class);
// result == "2"
assertThat(this.restTemplate.getForObject("/number", String.class)).isEqualTo("1");
assertThat(this.restTemplate.getForObject("/number", String.class)).isEqualTo("2");

try {
this.mockServer.verify();
Expand Down
2 changes: 1 addition & 1 deletion ...bmvc/src/test/java/org/springframework/web/servlet/handler/HandlerMethodMappingTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ void getCorsConfigWithBeanNameHandler() throws Exception {

this.mapping.setApplicationContext(context);
this.mapping.registerMapping(key, beanName, this.method1);
HandlerMethod handlerMethod = this.mapping.getHandlerInternal(new MockHttpServletRequest("GET", key));
this.mapping.getHandlerInternal(new MockHttpServletRequest("GET", key));
}

@Test
Expand Down
3 changes: 3 additions & 0 deletions src/checkstyle/checkstyle.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,10 @@

<!-- Imports -->
<module name="AvoidStarImport"/>
<!-- Unused -->
<module name="UnusedImports"/>
<module name="UnusedLocalVariable"/>
<!-- <module name="UnusedLocalMethodCheck"/> https://github.com/checkstyle/checkstyle/pull/16894 -->
<module name="RedundantImport"/>
<module name="com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck">
<property name="groups" value="java,javax,*,org.springframework"/>
Expand Down