Skip to content

Commit e2c21ed

Browse files
wy471xwy471x
authored
test(task#5161): improve test coverage for admin. (#6328)
* test(admin):improve test case coverage for DashboardProperties. * test(admin):improve test case coverage for SuperAdminPasswordSafeAdvice. * test(admin):improve test case coverage for exception classes. * test(admin):improve test case coverage for exception classes. * test(admin):improve test case coverage for exception classes. * test(admin):improve test case coverage for utils classes. * test(admin):improve test case coverage under package org.apache.shenyu.admin.listener. * test(admin):improve test case coverage under package org.apache.shenyu.admin.disruptor. * test(admin):improve test case coverage for utils classes. * test(admin):improve test case coverage in package org.apache.shenyu.admin.service. * test(admin):improve test case coverage in package org.apache.shenyu.admin.service. * test(admin):improve test case coverage in package org.apache.shenyu.admin.service.
1 parent 4f346c5 commit e2c21ed

41 files changed

Lines changed: 7650 additions & 148 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎shenyu-admin/src/test/java/org/apache/shenyu/admin/aspect/controller/SuperAdminPasswordSafeAdviceTest.java‎

Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
/*
2+
* Licensed to the Apache Software Foundation (ASF) under one or more
3+
* contributor license agreements. See the NOTICE file distributed with
4+
* this work for additional information regarding copyright ownership.
5+
* The ASF licenses this file to You under the Apache License, Version 2.0
6+
* (the "License"); you may not use this file except in compliance with
7+
* the License. You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
17+
18+
package org.apache.shenyu.admin.aspect.controller;
19+
20+
import com.google.common.base.Stopwatch;
21+
import org.apache.shenyu.admin.config.properties.DashboardProperties;
22+
import org.apache.shenyu.admin.model.custom.UserInfo;
23+
import org.apache.shenyu.admin.service.DashboardUserService;
24+
import org.apache.shenyu.admin.utils.SessionUtil;
25+
import org.junit.jupiter.api.BeforeEach;
26+
import org.junit.jupiter.api.Test;
27+
import org.junit.jupiter.api.extension.ExtendWith;
28+
import org.mockito.InjectMocks;
29+
import org.mockito.Mock;
30+
import org.mockito.MockedStatic;
31+
import org.mockito.junit.jupiter.MockitoExtension;
32+
import org.springframework.core.annotation.AnnotatedElementUtils;
33+
34+
import java.lang.reflect.Method;
35+
import java.util.Arrays;
36+
import java.util.List;
37+
38+
import static org.mockito.ArgumentMatchers.anyString;
39+
import static org.mockito.Mockito.mock;
40+
import static org.mockito.Mockito.mockStatic;
41+
import static org.mockito.Mockito.never;
42+
import static org.mockito.Mockito.verify;
43+
import static org.mockito.Mockito.when;
44+
45+
/**
46+
* Test cases for {@link SuperAdminPasswordSafeAdvice}.
47+
*/
48+
@ExtendWith(MockitoExtension.class)
49+
public class SuperAdminPasswordSafeAdviceTest {
50+
51+
@Mock
52+
private DashboardProperties properties;
53+
54+
@Mock
55+
private DashboardUserService userService;
56+
57+
@InjectMocks
58+
private SuperAdminPasswordSafeAdvice advice;
59+
60+
private Object bean;
61+
62+
private Method method;
63+
64+
private Stopwatch stopwatch;
65+
66+
@BeforeEach
67+
void setUp() throws Exception {
68+
bean = new Object();
69+
method = Object.class.getMethod("toString");
70+
stopwatch = Stopwatch.createUnstarted();
71+
}
72+
73+
@Test
74+
void testDoPreProcessWhenEnableOnlySuperAdminPermissionIsFalseShouldSkip() {
75+
when(properties.getEnableOnlySuperAdminPermission()).thenReturn(false);
76+
77+
advice.doPreProcess(bean, method, stopwatch);
78+
79+
verify(properties, never()).getEnableSuperAdminPasswordSafe();
80+
verify(userService, never()).checkUserPassword(anyString());
81+
}
82+
83+
@Test
84+
void testDoPreProcessWhenEnableSuperAdminPasswordSafeIsFalseShouldSkip() {
85+
when(properties.getEnableOnlySuperAdminPermission()).thenReturn(true);
86+
when(properties.getEnableSuperAdminPasswordSafe()).thenReturn(false);
87+
88+
advice.doPreProcess(bean, method, stopwatch);
89+
90+
verify(userService, never()).checkUserPassword(anyString());
91+
}
92+
93+
@Test
94+
void testDoPreProcessWhenNotAdminShouldSkip() {
95+
when(properties.getEnableOnlySuperAdminPermission()).thenReturn(true);
96+
when(properties.getEnableSuperAdminPasswordSafe()).thenReturn(true);
97+
98+
try (MockedStatic<SessionUtil> sessionUtilMock = mockStatic(SessionUtil.class)) {
99+
sessionUtilMock.when(SessionUtil::isAdmin).thenReturn(false);
100+
101+
advice.doPreProcess(bean, method, stopwatch);
102+
103+
verify(userService, never()).checkUserPassword(anyString());
104+
}
105+
}
106+
107+
@Test
108+
void testDoPreProcessWhenNoRequiresPermissionsShouldSkip() {
109+
when(properties.getEnableOnlySuperAdminPermission()).thenReturn(true);
110+
when(properties.getEnableSuperAdminPasswordSafe()).thenReturn(true);
111+
112+
try (MockedStatic<SessionUtil> sessionUtilMock = mockStatic(SessionUtil.class)) {
113+
sessionUtilMock.when(SessionUtil::isAdmin).thenReturn(true);
114+
115+
advice.doPreProcess(bean, method, stopwatch);
116+
117+
verify(userService, never()).checkUserPassword(anyString());
118+
}
119+
}
120+
121+
@Test
122+
void testDoPreProcessWhenPermissionNotInListShouldSkip() throws Exception {
123+
when(properties.getEnableOnlySuperAdminPermission()).thenReturn(true);
124+
when(properties.getEnableSuperAdminPasswordSafe()).thenReturn(true);
125+
126+
Method methodWithAnnotation = TestController.class.getMethod("testMethod");
127+
UserInfo user = mock(UserInfo.class);
128+
129+
try (MockedStatic<SessionUtil> sessionUtilMock = mockStatic(SessionUtil.class);
130+
MockedStatic<AnnotatedElementUtils> annotatedElementUtilsMock = mockStatic(AnnotatedElementUtils.class)) {
131+
sessionUtilMock.when(SessionUtil::isAdmin).thenReturn(true);
132+
sessionUtilMock.when(SessionUtil::visitor).thenReturn(user);
133+
annotatedElementUtilsMock.when(() -> AnnotatedElementUtils.findMergedAnnotation(methodWithAnnotation, org.apache.shiro.authz.annotation.RequiresPermissions.class))
134+
.thenReturn(mock(org.apache.shiro.authz.annotation.RequiresPermissions.class));
135+
136+
advice.doPreProcess(bean, methodWithAnnotation, stopwatch);
137+
138+
verify(userService, never()).checkUserPassword(anyString());
139+
}
140+
}
141+
142+
@Test
143+
void testDoPreProcessWhenPermissionInListShouldCheckPassword() throws Exception {
144+
when(properties.getEnableOnlySuperAdminPermission()).thenReturn(true);
145+
when(properties.getEnableSuperAdminPasswordSafe()).thenReturn(true);
146+
List<String> permissions = Arrays.asList("admin:permission", "other:permission");
147+
when(properties.getOnlySuperAdminPermission()).thenReturn(permissions);
148+
149+
Method methodWithAnnotation = TestController.class.getMethod("testMethod");
150+
org.apache.shiro.authz.annotation.RequiresPermissions requiresPermissions = mock(org.apache.shiro.authz.annotation.RequiresPermissions.class);
151+
when(requiresPermissions.value()).thenReturn(new String[]{"admin:permission"});
152+
UserInfo user = mock(UserInfo.class);
153+
when(user.getUserId()).thenReturn("userId");
154+
155+
try (MockedStatic<SessionUtil> sessionUtilMock = mockStatic(SessionUtil.class);
156+
MockedStatic<AnnotatedElementUtils> annotatedElementUtilsMock = mockStatic(AnnotatedElementUtils.class)) {
157+
sessionUtilMock.when(SessionUtil::isAdmin).thenReturn(true);
158+
sessionUtilMock.when(SessionUtil::visitor).thenReturn(user);
159+
annotatedElementUtilsMock.when(() -> AnnotatedElementUtils.findMergedAnnotation(methodWithAnnotation, org.apache.shiro.authz.annotation.RequiresPermissions.class))
160+
.thenReturn(requiresPermissions);
161+
162+
advice.doPreProcess(bean, methodWithAnnotation, stopwatch);
163+
164+
verify(userService).checkUserPassword("userId");
165+
}
166+
}
167+
168+
private static class TestController {
169+
@org.apache.shiro.authz.annotation.RequiresPermissions("admin:permission")
170+
public void testMethod() {
171+
throw new UnsupportedOperationException("testMethod() used for unit test.");
172+
}
173+
}
174+
}

‎shenyu-admin/src/test/java/org/apache/shenyu/admin/config/properties/DashboardPropertiesTest.java‎

Lines changed: 83 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,22 +17,101 @@
1717

1818
package org.apache.shenyu.admin.config.properties;
1919

20+
import org.apache.shenyu.admin.AbstractConfigurationTest;
2021
import org.junit.jupiter.api.Assertions;
2122
import org.junit.jupiter.api.Test;
23+
import org.junit.jupiter.api.extension.ExtendWith;
24+
import org.mockito.junit.jupiter.MockitoExtension;
25+
import org.springframework.boot.context.properties.EnableConfigurationProperties;
26+
import org.springframework.context.annotation.Configuration;
27+
28+
import java.util.ArrayList;
29+
import java.util.List;
2230

2331
/**
2432
* Test cases for {@link DashboardProperties}.
2533
*/
26-
public class DashboardPropertiesTest {
34+
@ExtendWith(MockitoExtension.class)
35+
public class DashboardPropertiesTest extends AbstractConfigurationTest {
2736

2837
@Test
2938
public void dashboardPropertiesTest() {
3039
final DashboardProperties dashboardProperties = new DashboardProperties();
3140
dashboardProperties.setOnlyCleanDays(0);
3241
dashboardProperties.setEnablePrintApiLog(true);
3342
dashboardProperties.setRecordLogLimit(0);
34-
Assertions.assertEquals(dashboardProperties.getOnlyCleanDays(), 0);
35-
Assertions.assertEquals(dashboardProperties.getEnablePrintApiLog(), true);
36-
Assertions.assertEquals(dashboardProperties.getRecordLogLimit(), 0);
43+
dashboardProperties.setEnableOnlySuperAdminPermission(false);
44+
dashboardProperties.setEnableSuperAdminPasswordSafe(false);
45+
dashboardProperties.setSuperAdminPasswordValidDuration(0L);
46+
47+
Assertions.assertEquals(0, dashboardProperties.getOnlyCleanDays());
48+
Assertions.assertEquals(true, dashboardProperties.getEnablePrintApiLog());
49+
Assertions.assertEquals(0, dashboardProperties.getRecordLogLimit());
50+
Assertions.assertEquals(false, dashboardProperties.getEnableOnlySuperAdminPermission());
51+
Assertions.assertEquals(false, dashboardProperties.getEnableSuperAdminPasswordSafe());
52+
Assertions.assertEquals(0, dashboardProperties.getSuperAdminPasswordValidDuration());
53+
}
54+
55+
@Test
56+
public void testSpecified() {
57+
load(DashboardPropertiesTest.DashboardPropertiesConfiguration.class,
58+
"shenyu.dashboard.core.recordLogLimit=10",
59+
"shenyu.dashboard.core.onlyCleanDays=1",
60+
"shenyu.dashboard.core.enablePrintApiLog=true",
61+
"shenyu.dashboard.core.enableOnlySuperAdminPermission=false",
62+
"shenyu.dashboard.core.enableSuperAdminPasswordSafe=false",
63+
"shenyu.dashboard.core.superAdminPasswordValidDuration=0");
64+
65+
List<String> onlySuperAdminPermission = new ArrayList<>();
66+
onlySuperAdminPermission.add("1");
67+
DashboardProperties dashboardProperties = getContext().getBean(DashboardProperties.class);
68+
dashboardProperties.setOnlySuperAdminPermission(onlySuperAdminPermission);
69+
70+
Assertions.assertEquals(10, dashboardProperties.getRecordLogLimit());
71+
Assertions.assertEquals(1, dashboardProperties.getOnlyCleanDays());
72+
Assertions.assertTrue(dashboardProperties.getEnablePrintApiLog());
73+
Assertions.assertFalse(dashboardProperties.getEnableOnlySuperAdminPermission());
74+
Assertions.assertFalse(dashboardProperties.getEnableSuperAdminPasswordSafe());
75+
Assertions.assertEquals(0L, dashboardProperties.getSuperAdminPasswordValidDuration());
76+
Assertions.assertEquals(1, dashboardProperties.getOnlySuperAdminPermission().size());
77+
Assertions.assertEquals("1", dashboardProperties.getOnlySuperAdminPermission().get(0));
78+
}
79+
80+
@Test
81+
public void testOnlySuperAdminPermission() {
82+
final DashboardProperties dashboardProperties = new DashboardProperties();
83+
dashboardProperties.afterPropertiesSet();
84+
Assertions.assertEquals(12, dashboardProperties.getOnlySuperAdminPermission().size());
85+
// Check user permissions
86+
Assertions.assertEquals("system:manager:add", dashboardProperties.getOnlySuperAdminPermission().get(0));
87+
Assertions.assertEquals("system:manager:edit", dashboardProperties.getOnlySuperAdminPermission().get(1));
88+
Assertions.assertEquals("system:manager:delete", dashboardProperties.getOnlySuperAdminPermission().get(2));
89+
90+
// Check role permissions
91+
Assertions.assertEquals("system:role:edit", dashboardProperties.getOnlySuperAdminPermission().get(3));
92+
Assertions.assertEquals("system:role:add", dashboardProperties.getOnlySuperAdminPermission().get(4));
93+
Assertions.assertEquals("system:role:delete", dashboardProperties.getOnlySuperAdminPermission().get(5));
94+
95+
// Check resource permissions
96+
Assertions.assertEquals("system:resource:addButton", dashboardProperties.getOnlySuperAdminPermission().get(6));
97+
Assertions.assertEquals("system:resource:addMenu", dashboardProperties.getOnlySuperAdminPermission().get(7));
98+
Assertions.assertEquals("system:resource:editButton", dashboardProperties.getOnlySuperAdminPermission().get(8));
99+
Assertions.assertEquals("system:resource:editMenu", dashboardProperties.getOnlySuperAdminPermission().get(9));
100+
Assertions.assertEquals("system:resource:deleteMenu", dashboardProperties.getOnlySuperAdminPermission().get(10));
101+
Assertions.assertEquals("system:resource:deleteButton", dashboardProperties.getOnlySuperAdminPermission().get(11));
102+
103+
List<String> onlySuperAdminPermission = new ArrayList<>();
104+
onlySuperAdminPermission.add("1");
105+
dashboardProperties.setOnlySuperAdminPermission(onlySuperAdminPermission);
106+
Assertions.assertEquals(1, dashboardProperties.getOnlySuperAdminPermission().size());
107+
108+
dashboardProperties.setEnableOnlySuperAdminPermission(false);
109+
dashboardProperties.afterPropertiesSet();
110+
Assertions.assertEquals(0, dashboardProperties.getOnlySuperAdminPermission().size());
111+
}
112+
113+
@Configuration
114+
@EnableConfigurationProperties(DashboardProperties.class)
115+
static class DashboardPropertiesConfiguration {
37116
}
38117
}

0 commit comments

Comments
 (0)