Commit 3fbd394653996865c32df068908e54851338768f

Authored by YunaiV
1 parent 0f792c64

完善数据权限的单元测试

yudao-framework/yudao-spring-boot-starter-data-permission/src/main/java/cn/iocoder/yudao/framework/datapermission/config/DataPermission.java renamed to yudao-framework/yudao-spring-boot-starter-data-permission/src/main/java/cn/iocoder/yudao/framework/datapermission/core/annotation/DataPermission.java
1   -package cn.iocoder.yudao.framework.datapermission.config;
  1 +package cn.iocoder.yudao.framework.datapermission.core.annotation;
2 2  
3 3 import cn.iocoder.yudao.framework.datapermission.core.rule.DataPermissionRule;
4 4  
... ... @@ -25,11 +25,11 @@ public @interface DataPermission {
25 25 /**
26 26 * 生效的数据权限规则数组,优先级高于 {@link #excludeRules()}
27 27 */
28   - Class<DataPermissionRule>[] includeRules() default {};
  28 + Class<? extends DataPermissionRule>[] includeRules() default {};
29 29  
30 30 /**
31 31 * 排除的数据权限规则数组,优先级最低
32 32 */
33   - Class<DataPermissionRule>[] excludeRules() default {};
  33 + Class<? extends DataPermissionRule>[] excludeRules() default {};
34 34  
35 35 }
... ...
yudao-framework/yudao-spring-boot-starter-data-permission/src/main/java/cn/iocoder/yudao/framework/datapermission/core/interceptor/DataPermissionInterceptor.java
... ... @@ -129,7 +129,6 @@ public class DataPermissionInterceptor extends JsqlParserSupport implements Inne
129 129 @Override
130 130 protected void processUpdate(Update update, int index, String sql, Object obj) {
131 131 final Table table = update.getTable();
132   -// update.setWhere(this.andExpression(table, update.getWhere()));
133 132 update.setWhere(this.builderExpression(update.getWhere(), table));
134 133 }
135 134  
... ... @@ -138,28 +137,9 @@ public class DataPermissionInterceptor extends JsqlParserSupport implements Inne
138 137 */
139 138 @Override
140 139 protected void processDelete(Delete delete, int index, String sql, Object obj) {
141   -// delete.setWhere(this.andExpression(delete.getTable(), delete.getWhere()));
142 140 delete.setWhere(this.builderExpression(delete.getWhere(), delete.getTable()));
143 141 }
144 142  
145   -// /**
146   -// * delete update 语句 where 处理
147   -// */
148   -// protected BinaryExpression andExpression(Table table, Expression where) {
149   -// //获得where条件表达式
150   -// EqualsTo equalsTo = new EqualsTo();
151   -// equalsTo.setLeftExpression(this.getAliasColumn(table));
152   -// equalsTo.setRightExpression(getTenantId());
153   -// if (null != where) {
154   -// if (where instanceof OrExpression) {
155   -// return new AndExpression(equalsTo, new Parenthesis(where));
156   -// } else {
157   -// return new AndExpression(equalsTo, where);
158   -// }
159   -// }
160   -// return equalsTo;
161   -// }
162   -
163 143 /**
164 144 * 处理 PlainSelect
165 145 */
... ... @@ -169,10 +149,6 @@ public class DataPermissionInterceptor extends JsqlParserSupport implements Inne
169 149 processWhereSubSelect(where);
170 150 if (fromItem instanceof Table) {
171 151 Table fromTable = (Table) fromItem;
172   -// if (!ignoreTable(fromTable.getName())) {
173   -// //#1186 github
174   -// plainSelect.setWhere(builderExpression(where, fromTable));
175   -// }
176 152 plainSelect.setWhere(builderExpression(where, fromTable));
177 153 } else {
178 154 processFromItem(fromItem);
... ... @@ -261,7 +237,7 @@ public class DataPermissionInterceptor extends JsqlParserSupport implements Inne
261 237 * <p>支持: 1. select fun(args..) 2. select fun1(fun2(args..),args..)<p>
262 238 * <p> fixed gitee pulls/141</p>
263 239 *
264   - * @param function
  240 + * @param function 函数
265 241 */
266 242 protected void processFunction(Function function) {
267 243 ExpressionList parameters = function.getParameters();
... ... @@ -326,21 +302,12 @@ public class DataPermissionInterceptor extends JsqlParserSupport implements Inne
326 302 processJoin(join);
327 303 continue;
328 304 }
329   -// // 当前表是否忽略
330   -// boolean needIgnore = ignoreTable(fromTable.getName());
331   -// // 表名压栈,忽略的表压入 null,以便后续不处理
332   -// tables.push(needIgnore ? null : fromTable);
333 305 tables.push(fromTable);
334 306 // 尾缀多个 on 表达式的时候统一处理
335 307 if (originOnExpressions.size() > 1) {
336 308 Collection<Expression> onExpressions = new LinkedList<>();
337 309 for (Expression originOnExpression : originOnExpressions) {
338 310 Table currentTable = tables.poll();
339   -// if (currentTable == null) {
340   -// onExpressions.add(originOnExpression);
341   -// } else {
342   -// onExpressions.add(builderExpression(originOnExpression, currentTable));
343   -// }
344 311 onExpressions.add(builderExpression(originOnExpression, currentTable));
345 312 }
346 313 join.setOnExpressions(onExpressions);
... ... @@ -358,15 +325,6 @@ public class DataPermissionInterceptor extends JsqlParserSupport implements Inne
358 325 protected void processJoin(Join join) {
359 326 if (join.getRightItem() instanceof Table) {
360 327 Table fromTable = (Table) join.getRightItem();
361   -// if (ignoreTable(fromTable.getName())) {
362   -// // 过滤退出执行
363   -// return;
364   -// }
365   - // 走到这里说明 on 表达式肯定只有一个
366   -// Collection<Expression> originOnExpressions = join.getOnExpressions();
367   -// List<Expression> onExpressions = new LinkedList<>();
368   -// onExpressions.add(builderExpression(originOnExpressions.iterator().next(), fromTable));
369   -// join.setOnExpressions(onExpressions);
370 328 Expression originOnExpression = CollUtil.getFirst(join.getOnExpressions());
371 329 originOnExpression = builderExpression(originOnExpression, fromTable);
372 330 join.setOnExpressions(CollUtil.newArrayList(originOnExpression));
... ... @@ -395,22 +353,6 @@ public class DataPermissionInterceptor extends JsqlParserSupport implements Inne
395 353 return new AndExpression(currentExpression, equalsTo);
396 354 }
397 355  
398   -// /**
399   -// * 租户字段别名设置
400   -// * <p>tenantId 或 tableAlias.tenantId</p>
401   -// *
402   -// * @param table 表对象
403   -// * @return 字段
404   -// */
405   -// protected Column getAliasColumn(Table table) {
406   -// StringBuilder column = new StringBuilder();
407   -// if (table.getAlias() != null) {
408   -// column.append(table.getAlias().getName()).append(StringPool.DOT);
409   -// }
410   -// column.append(getTenantIdColumn());
411   -// return new Column(column.toString());
412   -// }
413   -
414 356 /**
415 357 * 构建指定表的数据权限的 Expression 过滤条件
416 358 *
... ...
yudao-framework/yudao-spring-boot-starter-data-permission/src/test/java/cn/iocoder/yudao/framework/datapermission/core/interceptor/DataPermissionInterceptorTest2.java
... ... @@ -8,13 +8,15 @@ import net.sf.jsqlparser.expression.Alias;
8 8 import net.sf.jsqlparser.expression.Expression;
9 9 import net.sf.jsqlparser.expression.LongValue;
10 10 import net.sf.jsqlparser.expression.operators.relational.EqualsTo;
  11 +import net.sf.jsqlparser.expression.operators.relational.ExpressionList;
  12 +import net.sf.jsqlparser.expression.operators.relational.InExpression;
11 13 import net.sf.jsqlparser.schema.Column;
12 14 import org.junit.jupiter.api.BeforeEach;
13 15 import org.junit.jupiter.api.Test;
14 16 import org.mockito.InjectMocks;
15 17 import org.mockito.Mock;
16 18  
17   -import java.util.Collections;
  19 +import java.util.Arrays;
18 20 import java.util.Set;
19 21  
20 22 import static cn.iocoder.yudao.framework.common.util.collection.SetUtils.asSet;
... ... @@ -44,7 +46,8 @@ public class DataPermissionInterceptorTest2 extends BaseMockitoUnitTest {
44 46  
45 47 @Override
46 48 public Set<String> getTableNames() {
47   - return asSet("entity", "entity1", "entity2", "t1", "t2");
  49 + return asSet("entity", "entity1", "entity2", "t1", "t2", // 支持 MyBatis Plus 的单元测试
  50 + "t_user", "t_role"); // 满足自己的单元测试
48 51 }
49 52  
50 53 @Override
... ... @@ -55,8 +58,27 @@ public class DataPermissionInterceptorTest2 extends BaseMockitoUnitTest {
55 58 }
56 59  
57 60 };
  61 + // 部门的数据权限规则
  62 + DataPermissionRule deptRule = new DataPermissionRule() {
  63 +
  64 + private static final String COLUMN = "dept_id";
  65 +
  66 + @Override
  67 + public Set<String> getTableNames() {
  68 + return asSet("t_user"); // 满足自己的单元测试
  69 + }
  70 +
  71 + @Override
  72 + public Expression getExpression(String tableName, Alias tableAlias) {
  73 + Column column = MyBatisUtils.buildColumn(tableName, tableAlias, COLUMN);
  74 + ExpressionList values = new ExpressionList(new LongValue(10L),
  75 + new LongValue(20L));
  76 + return new InExpression(column, values);
  77 + }
  78 +
  79 + };
58 80 // 设置到上下文,保证
59   - DataPermissionInterceptor.ContextHolder.init(Collections.singletonList(tenantRule));
  81 + DataPermissionInterceptor.ContextHolder.init(Arrays.asList(tenantRule, deptRule));
60 82 }
61 83  
62 84 @Test
... ... @@ -252,7 +274,6 @@ public class DataPermissionInterceptorTest2 extends BaseMockitoUnitTest {
252 274 // "WHERE (e.id = ? OR e.name = ?) AND e.tenant_id = 1");
253 275 }
254 276  
255   -
256 277 @Test
257 278 void selectWithAs() {
258 279 assertSql("with with_as_A as (select * from entity) select * from with_as_A",
... ... @@ -263,4 +284,87 @@ public class DataPermissionInterceptorTest2 extends BaseMockitoUnitTest {
263 284 assertEquals(targetSql, interceptor.parserSingle(sql, null));
264 285 }
265 286  
  287 + // ========== 额外的测试 ==========
  288 +
  289 + @Test
  290 + public void testSelectSingle() {
  291 + // 单表
  292 + assertSql("select * from t_user where id = ?",
  293 + "SELECT * FROM t_user WHERE id = ? AND tenant_id = 1 AND dept_id IN (10, 20)");
  294 +
  295 + assertSql("select * from t_user where id = ? or name = ?",
  296 + "SELECT * FROM t_user WHERE (id = ? OR name = ?) AND tenant_id = 1 AND dept_id IN (10, 20)");
  297 +
  298 + assertSql("SELECT * FROM t_user WHERE (id = ? OR name = ?)",
  299 + "SELECT * FROM t_user WHERE (id = ? OR name = ?) AND tenant_id = 1 AND dept_id IN (10, 20)");
  300 +
  301 + /* not */
  302 + assertSql("SELECT * FROM t_user WHERE not (id = ? OR name = ?)",
  303 + "SELECT * FROM t_user WHERE NOT (id = ? OR name = ?) AND tenant_id = 1 AND dept_id IN (10, 20)");
  304 + }
  305 +
  306 + @Test
  307 + public void testSelectLeftJoin() {
  308 + // left join
  309 + assertSql("SELECT * FROM t_user e " +
  310 + "left join t_role e1 on e1.id = e.id " +
  311 + "WHERE e.id = ? OR e.name = ?",
  312 + "SELECT * FROM t_user e " +
  313 + "LEFT JOIN t_role e1 ON e1.id = e.id AND e1.tenant_id = 1 " +
  314 + "WHERE (e.id = ? OR e.name = ?) AND e.tenant_id = 1 AND e.dept_id IN (10, 20)");
  315 +
  316 + // 条件 e.id = ? OR e.name = ? 带括号
  317 + assertSql("SELECT * FROM t_user e " +
  318 + "left join t_role e1 on e1.id = e.id " +
  319 + "WHERE (e.id = ? OR e.name = ?)",
  320 + "SELECT * FROM t_user e " +
  321 + "LEFT JOIN t_role e1 ON e1.id = e.id AND e1.tenant_id = 1 " +
  322 + "WHERE (e.id = ? OR e.name = ?) AND e.tenant_id = 1 AND e.dept_id IN (10, 20)");
  323 + }
  324 +
  325 + @Test
  326 + public void testSelectRightJoin() {
  327 + // right join
  328 + assertSql("SELECT * FROM t_user e " +
  329 + "right join t_role e1 on e1.id = e.id " +
  330 + "WHERE e.id = ? OR e.name = ?",
  331 + "SELECT * FROM t_user e " +
  332 + "RIGHT JOIN t_role e1 ON e1.id = e.id AND e1.tenant_id = 1 " +
  333 + "WHERE (e.id = ? OR e.name = ?) AND e.tenant_id = 1 AND e.dept_id IN (10, 20)");
  334 +
  335 + // 条件 e.id = ? OR e.name = ? 带括号
  336 + assertSql("SELECT * FROM t_user e " +
  337 + "right join t_role e1 on e1.id = e.id " +
  338 + "WHERE (e.id = ? OR e.name = ?)",
  339 + "SELECT * FROM t_user e " +
  340 + "RIGHT JOIN t_role e1 ON e1.id = e.id AND e1.tenant_id = 1 " +
  341 + "WHERE (e.id = ? OR e.name = ?) AND e.tenant_id = 1 AND e.dept_id IN (10, 20)");
  342 + }
  343 +
  344 + @Test
  345 + public void testSelectInnerJoin() {
  346 + // inner join
  347 + assertSql("SELECT * FROM t_user e " +
  348 + "inner join entity1 e1 on e1.id = e.id " +
  349 + "WHERE e.id = ? OR e.name = ?",
  350 + "SELECT * FROM t_user e " +
  351 + "INNER JOIN entity1 e1 ON e1.id = e.id AND e1.tenant_id = 1 " +
  352 + "WHERE (e.id = ? OR e.name = ?) AND e.tenant_id = 1 AND e.dept_id IN (10, 20)");
  353 +
  354 + // 条件 e.id = ? OR e.name = ? 带括号
  355 + assertSql("SELECT * FROM t_user e " +
  356 + "inner join t_role e1 on e1.id = e.id " +
  357 + "WHERE (e.id = ? OR e.name = ?)",
  358 + "SELECT * FROM t_user e " +
  359 + "INNER JOIN t_role e1 ON e1.id = e.id AND e1.tenant_id = 1 " +
  360 + "WHERE (e.id = ? OR e.name = ?) AND e.tenant_id = 1 AND e.dept_id IN (10, 20)");
  361 +
  362 + // 垃圾 inner join todo
  363 +// assertSql("SELECT * FROM entity,entity1 " +
  364 +// "WHERE entity.id = entity1.id",
  365 +// "SELECT * FROM entity e " +
  366 +// "INNER JOIN entity1 e1 ON e1.id = e.id AND e1.tenant_id = 1 " +
  367 +// "WHERE (e.id = ? OR e.name = ?) AND e.tenant_id = 1");
  368 + }
  369 +
266 370 }
... ...