Skip to content

Commit

Permalink
[ISSUE #5219] Enable checkstyle for test code (rocketmq-acl and rocke…
Browse files Browse the repository at this point in the history 
…tmq-tools) (#5220)

* style(acl):Enable checkstyle for test code

* style(tools):Enable checkstyle for test code
  • Loading branch information
@nowinkeyy
nowinkeyy committed Sep 29, 2022
1 parent 0ad7db6 commit a5725c6
Show file tree
Hide file tree
Showing 16 changed files with 139 additions and 85 deletions.
24 changes: 24 additions & 0 deletions acl/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,28 @@
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>${maven-checkstyle-plugin.version}</version>
<executions>
<execution>
<id>validate</id>
<phase>validate</phase>
<configuration>
<configLocation>${project.parent.basedir}/style/rmq_checkstyle.xml</configLocation>
<inputEncoding>UTF-8</inputEncoding>
<consoleOutput>true</consoleOutput>
<failsOnError>true</failsOnError>
<includeTestSourceDirectory>true</includeTestSourceDirectory>
</configuration>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
4 changes: 2 additions & 2 deletions acl/src/test/java/org/apache/rocketmq/acl/common/AclSignerTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@
public class AclSignerTest {

@Test(expected = Exception.class)
public void calSignatureExceptionTest(){
public void calSignatureExceptionTest() {
AclSigner.calSignature(new byte[]{},"");
}

@Test
public void calSignatureTest(){
public void calSignatureTest() {
String expectedSignature = "IUc8rrO/0gDch8CjObLQsW2rsiA=";
Assert.assertEquals(expectedSignature, AclSigner.calSignature("RocketMQ", "12345678"));
Assert.assertEquals(expectedSignature, AclSigner.calSignature("RocketMQ".getBytes(), "12345678"));
Expand Down
16 changes: 8 additions & 8 deletions acl/src/test/java/org/apache/rocketmq/acl/common/PermissionTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ public void fromStringGetPermissionTest() {
Assert.assertEquals(perm, Permission.SUB);

perm = Permission.parsePermFromString("PUB|SUB");
Assert.assertEquals(perm, Permission.PUB|Permission.SUB);
Assert.assertEquals(perm, Permission.PUB | Permission.SUB);

perm = Permission.parsePermFromString("SUB|PUB");
Assert.assertEquals(perm, Permission.PUB|Permission.SUB);
Assert.assertEquals(perm, Permission.PUB | Permission.SUB);

perm = Permission.parsePermFromString("DENY");
Assert.assertEquals(perm, Permission.DENY);
Expand All @@ -64,13 +64,13 @@ public void checkPermissionTest() {
boo = Permission.checkPermission(Permission.SUB, Permission.SUB);
Assert.assertTrue(boo);

boo = Permission.checkPermission(Permission.PUB, (byte) (Permission.PUB|Permission.SUB));
boo = Permission.checkPermission(Permission.PUB, (byte) (Permission.PUB | Permission.SUB));
Assert.assertTrue(boo);

boo = Permission.checkPermission(Permission.SUB, (byte) (Permission.PUB|Permission.SUB));
boo = Permission.checkPermission(Permission.SUB, (byte) (Permission.PUB | Permission.SUB));
Assert.assertTrue(boo);

boo = Permission.checkPermission(Permission.ANY, (byte) (Permission.PUB|Permission.SUB));
boo = Permission.checkPermission(Permission.ANY, (byte) (Permission.PUB | Permission.SUB));
Assert.assertTrue(boo);

boo = Permission.checkPermission(Permission.ANY, Permission.SUB);
Expand Down Expand Up @@ -112,7 +112,7 @@ public void setTopicPermTest() {
Assert.assertEquals(perm, Permission.DENY);

perm = resourcePermMap.get(PlainAccessResource.getRetryTopic("groupB"));
Assert.assertEquals(perm,Permission.PUB|Permission.SUB);
Assert.assertEquals(perm,Permission.PUB | Permission.SUB);

perm = resourcePermMap.get(PlainAccessResource.getRetryTopic("groupC"));
Assert.assertEquals(perm, Permission.PUB);
Expand All @@ -128,7 +128,7 @@ public void setTopicPermTest() {
Assert.assertEquals(perm, Permission.DENY);

perm = resourcePermMap.get("topicB");
Assert.assertEquals(perm, Permission.PUB|Permission.SUB);
Assert.assertEquals(perm, Permission.PUB | Permission.SUB);

perm = resourcePermMap.get("topicC");
Assert.assertEquals(perm, Permission.PUB);
Expand Down Expand Up @@ -156,7 +156,7 @@ public void checkAdminCodeTest() {
}

@Test
public void AclExceptionTest(){
public void AclExceptionTest() {
AclException aclException = new AclException("CAL_SIGNATURE_FAILED",10015);
AclException aclExceptionWithMessage = new AclException("CAL_SIGNATURE_FAILED",10015,"CAL_SIGNATURE_FAILED Exception");
Assert.assertEquals(aclException.getCode(),10015);
Expand Down
34 changes: 17 additions & 17 deletions acl/src/test/java/org/apache/rocketmq/acl/common/SessionCredentialsTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,27 +24,27 @@
public class SessionCredentialsTest {

@Test
public void equalsTest(){
SessionCredentials sessionCredentials=new SessionCredentials("RocketMQ","12345678");
public void equalsTest() {
SessionCredentials sessionCredentials = new SessionCredentials("RocketMQ","12345678");
sessionCredentials.setSecurityToken("abcd");
SessionCredentials other=new SessionCredentials("RocketMQ","12345678","abcd");
SessionCredentials other = new SessionCredentials("RocketMQ","12345678","abcd");
Assert.assertTrue(sessionCredentials.equals(other));
}

@Test
public void updateContentTest(){
SessionCredentials sessionCredentials=new SessionCredentials();
Properties properties=new Properties();
public void updateContentTest() {
SessionCredentials sessionCredentials = new SessionCredentials();
Properties properties = new Properties();
properties.setProperty(SessionCredentials.ACCESS_KEY,"RocketMQ");
properties.setProperty(SessionCredentials.SECRET_KEY,"12345678");
properties.setProperty(SessionCredentials.SECURITY_TOKEN,"abcd");
sessionCredentials.updateContent(properties);
}

@Test
public void SessionCredentialHashCodeTest(){
SessionCredentials sessionCredentials=new SessionCredentials();
Properties properties=new Properties();
public void SessionCredentialHashCodeTest() {
SessionCredentials sessionCredentials = new SessionCredentials();
Properties properties = new Properties();
properties.setProperty(SessionCredentials.ACCESS_KEY,"RocketMQ");
properties.setProperty(SessionCredentials.SECRET_KEY,"12345678");
properties.setProperty(SessionCredentials.SECURITY_TOKEN,"abcd");
Expand All @@ -53,16 +53,16 @@ public void SessionCredentialHashCodeTest(){
}

@Test
public void SessionCredentialEqualsTest(){
SessionCredentials sessionCredential1 =new SessionCredentials();
Properties properties1=new Properties();
public void SessionCredentialEqualsTest() {
SessionCredentials sessionCredential1 = new SessionCredentials();
Properties properties1 = new Properties();
properties1.setProperty(SessionCredentials.ACCESS_KEY,"RocketMQ");
properties1.setProperty(SessionCredentials.SECRET_KEY,"12345678");
properties1.setProperty(SessionCredentials.SECURITY_TOKEN,"abcd");
sessionCredential1.updateContent(properties1);

SessionCredentials sessionCredential2 =new SessionCredentials();
Properties properties2=new Properties();
SessionCredentials sessionCredential2 = new SessionCredentials();
Properties properties2 = new Properties();
properties2.setProperty(SessionCredentials.ACCESS_KEY,"RocketMQ");
properties2.setProperty(SessionCredentials.SECRET_KEY,"12345678");
properties2.setProperty(SessionCredentials.SECURITY_TOKEN,"abcd");
Expand All @@ -75,9 +75,9 @@ public void SessionCredentialEqualsTest(){
}

@Test
public void SessionCredentialToStringTest(){
SessionCredentials sessionCredential1 =new SessionCredentials();
Properties properties1=new Properties();
public void SessionCredentialToStringTest() {
SessionCredentials sessionCredential1 = new SessionCredentials();
Properties properties1 = new Properties();
properties1.setProperty(SessionCredentials.ACCESS_KEY,"RocketMQ");
properties1.setProperty(SessionCredentials.SECRET_KEY,"12345678");
properties1.setProperty(SessionCredentials.SECURITY_TOKEN,"abcd");
Expand Down
14 changes: 7 additions & 7 deletions acl/src/test/java/org/apache/rocketmq/acl/plain/AclTestHelper.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,15 +80,15 @@ private static void copyTo(String path, InputStream src, File dstDir, String fla

public static void recursiveDelete(File file) {
if (file.isFile()) {
file.delete();
file.delete();
} else {
File[] files = file.listFiles();
if (null != files) {
for (File f : files) {
recursiveDelete(f);
File[] files = file.listFiles();
if (null != files) {
for (File f : files) {
recursiveDelete(f);
}
}
}
file.delete();
file.delete();
}
}

Expand Down
1 change: 0 additions & 1 deletion acl/src/test/java/org/apache/rocketmq/acl/plain/PlainAccessControlFlowTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,6 @@ public void validateSendMessage(int requestCode,
try {
PlainAccessResource accessResource = (PlainAccessResource) plainAccessValidator.parse(
RemotingCommand.decode(buf), remoteAddr);
System.out.println(accessResource.getWhiteRemoteAddress());
plainAccessValidator.validate(accessResource);
} catch (RemotingCommandException e) {
e.printStackTrace();
Expand Down
34 changes: 17 additions & 17 deletions acl/src/test/java/org/apache/rocketmq/acl/plain/PlainPermissionManagerTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@
public class PlainPermissionManagerTest {

PlainPermissionManager plainPermissionManager;
PlainAccessResource PUBPlainAccessResource;
PlainAccessResource SUBPlainAccessResource;
PlainAccessResource ANYPlainAccessResource;
PlainAccessResource DENYPlainAccessResource;
PlainAccessResource pubPlainAccessResource;
PlainAccessResource subPlainAccessResource;
PlainAccessResource anyPlainAccessResource;
PlainAccessResource denyPlainAccessResource;
PlainAccessResource plainAccessResource = new PlainAccessResource();
PlainAccessConfig plainAccessConfig = new PlainAccessConfig();
Set<Integer> adminCode = new HashSet<>();
Expand All @@ -70,10 +70,10 @@ public void init() throws NoSuchFieldException, SecurityException, IOException {
// DELETE_SUBSCRIPTIONGROUP
adminCode.add(207);

PUBPlainAccessResource = clonePlainAccessResource(Permission.PUB);
SUBPlainAccessResource = clonePlainAccessResource(Permission.SUB);
ANYPlainAccessResource = clonePlainAccessResource(Permission.ANY);
DENYPlainAccessResource = clonePlainAccessResource(Permission.DENY);
pubPlainAccessResource = clonePlainAccessResource(Permission.PUB);
subPlainAccessResource = clonePlainAccessResource(Permission.SUB);
anyPlainAccessResource = clonePlainAccessResource(Permission.ANY);
denyPlainAccessResource = clonePlainAccessResource(Permission.DENY);

String folder = "conf";
confHome = AclTestHelper.copyResources(folder, true);
Expand Down Expand Up @@ -150,23 +150,23 @@ public void buildPlainAccessResourceTest() {
public void checkPermAdmin() {
PlainAccessResource plainAccessResource = new PlainAccessResource();
plainAccessResource.setRequestCode(17);
plainPermissionManager.checkPerm(plainAccessResource, PUBPlainAccessResource);
plainPermissionManager.checkPerm(plainAccessResource, pubPlainAccessResource);
}

@Test
public void checkPerm() {

PlainAccessResource plainAccessResource = new PlainAccessResource();
plainAccessResource.addResourceAndPerm("topicA", Permission.PUB);
plainPermissionManager.checkPerm(plainAccessResource, PUBPlainAccessResource);
plainPermissionManager.checkPerm(plainAccessResource, pubPlainAccessResource);
plainAccessResource.addResourceAndPerm("topicB", Permission.SUB);
plainPermissionManager.checkPerm(plainAccessResource, ANYPlainAccessResource);
plainPermissionManager.checkPerm(plainAccessResource, anyPlainAccessResource);

plainAccessResource = new PlainAccessResource();
plainAccessResource.addResourceAndPerm("topicB", Permission.SUB);
plainPermissionManager.checkPerm(plainAccessResource, SUBPlainAccessResource);
plainPermissionManager.checkPerm(plainAccessResource, subPlainAccessResource);
plainAccessResource.addResourceAndPerm("topicA", Permission.PUB);
plainPermissionManager.checkPerm(plainAccessResource, ANYPlainAccessResource);
plainPermissionManager.checkPerm(plainAccessResource, anyPlainAccessResource);

}

Expand All @@ -175,7 +175,7 @@ public void checkErrorPermDefaultValueNotMatch() {

plainAccessResource = new PlainAccessResource();
plainAccessResource.addResourceAndPerm("topicF", Permission.PUB);
plainPermissionManager.checkPerm(plainAccessResource, SUBPlainAccessResource);
plainPermissionManager.checkPerm(plainAccessResource, subPlainAccessResource);
}

@Test(expected = AclException.class)
Expand Down Expand Up @@ -358,7 +358,7 @@ public void createAclAccessConfigMapTest() {
public void deleteAccessConfigTest() throws InterruptedException {
// delete not exist accessConfig
final boolean flag1 = plainPermissionManager.deleteAccessConfig("test_delete");
assert flag1 == false;
assert !flag1;

plainAccessConfig.setAccessKey("test_delete");
plainAccessConfig.setSecretKey("12345678");
Expand All @@ -371,14 +371,14 @@ public void deleteAccessConfigTest() throws InterruptedException {

//delete existed accessConfig
final boolean flag2 = plainPermissionManager.deleteAccessConfig("test_delete");
assert flag2 == true;
assert flag2;

}

@Test
public void updateGlobalWhiteAddrsConfigTest() {
final boolean flag = plainPermissionManager.updateGlobalWhiteAddrsConfig(Lists.newArrayList("192.168.1.2"));
assert flag == true;
assert flag;
final AclConfig config = plainPermissionManager.getAllAclConfig();
Assert.assertEquals(true, config.getGlobalWhiteAddrs().contains("192.168.1.2"));
}
Expand Down
24 changes: 24 additions & 0 deletions tools/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,28 @@
<artifactId>guava</artifactId>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>${maven-checkstyle-plugin.version}</version>
<executions>
<execution>
<id>validate</id>
<phase>validate</phase>
<configuration>
<configLocation>${project.parent.basedir}/style/rmq_checkstyle.xml</configLocation>
<inputEncoding>UTF-8</inputEncoding>
<consoleOutput>true</consoleOutput>
<failsOnError>true</failsOnError>
<includeTestSourceDirectory>true</includeTestSourceDirectory>
</configuration>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
Loading

0 comments on commit a5725c6

Please sign in to comment.