junit 如何使用archunit验证方法注解是否正在使用具有特定值的属性

dhxwm5r4  于 2022-11-11  发布在  其他
关注(0)|答案(3)|浏览(186)

我有一个@Audit注解,它有许多可选属性,我需要强制使用一个布尔属性useAccount = true用于某些包。
我尝试使用archunit来完成此验证,这样,每当开发人员提交违反规则的代码时,CI就会中断并通知团队。
这会中断建置:

@Audit
public myMethod(...) {
...
}

这是正确的方法:

@Audit(useAccount = true)
public myMethod(...) {
...
}

问题是Archunit目前不支持Assert方法。我希望做如下操作:

methods().that().resideInAnyPackage("..controllers..", "..service..").and().areAnnotatedWith(Audit.class).should(attributeCheckCondition)

然后,我的自定义条件attributeCheckCondition将负责查看属性值。
有没有一种方法可以像检索类一样检索方法?而不必编写更复杂的 predicate 和条件?

kuhbmx9i

kuhbmx9i1#

更新

从ArchUnit 0.10.0开始,可以为成员创建规则。

methods().that()
  .areDeclaredInClassesThat()
  .resideInAnyPackage("..controllers..", "..service..")
  .and()
  .areAnnotatedWith(Audit.class)
  .should(attributeCheckCondition)

另请参阅《用户指南》中的“编写成员规则”。

原始答案

由于目前没有基本的规则定义可用于方法,因此需要一个中间步骤。ArchUnit有一个ClassesTransformer将JavaClasses转换为其他类型的集合。

ClassesTransformer<JavaMethod> methods = new AbstractClassesTransformer<JavaMethod>("methods") {
    @Override
    public Iterable<JavaMethod> doTransform(JavaClasses javaClasses) {
        Set<JavaMethod> allMethods = new HashSet<>();
        for (JavaClass javaClass : javaClasses) {
            allMethods.addAll(javaClass.getMethods());
        }
        return allMethods;
    }
};

然后,可以将此ClassesTransformer用作自定义规则定义的基础。

ArchRule rule = ArchRuleDefinition.all(methods)
    .that(owner(resideInAnyPackage("..controllers..", "..service..")))
    .and(annotatedWith(Audit.class))
    .should(haveAttributeValue());
rule.check(javaClasses);

另请参阅《使用指南》中的“具有自订概念的规则”和this issue

kuuvgm7e

kuuvgm7e2#

我找到了一种在类上使用自定义 predicate 和条件的方法,当我这样做的时候,我没有意识到罗兰的回应似乎更好,因为它提供了一种从方法的Angular 表达规则Assert的方法,这就是为什么我要求。
然而,我想在这里张贴的解决方案,使它可以对其他人有用。

DescribedPredicate<JavaClass> HAVE_A_METHOD_ANNOTATED_WITH_AUDIT =
    new DescribedPredicate<JavaClass>("have a method annotated with @Audit")
    {
        @Override
        public boolean apply(JavaClass input)
        {
            return input.getMethods().stream().anyMatch(method -> method.isAnnotatedWith(Audit.class));
        }
    };

ArchCondition<JavaClass> ONLY_SET_ATTRIBUTE_USE_ACCOUNT_SET_TO_TRUE =
    new ArchCondition<JavaClass>("only set useAccount attribute to true")
    {
        @Override
        public void check(JavaClass item, ConditionEvents events)
        {
            item.getMethods().stream().filter(method ->
           method.isAnnotatedWith(Audit.class) && !method.getAnnotationOfType(Audit.class)
                                                            .useAccount()
            )
                .forEach(method -> {
                    String message = String.format(
                        "Method %s is annotated with @Audit but useAccount is not set to true",
                        method.getFullName());
                    events.add(SimpleConditionEvent.violated(method, message));
                });
        }
    };

则该规则表示为:

ArchRule ANNOTATION_RULE = classes()
    .that()
    .resideInAnyPackage("..controller..", "..service..")
    .and(HAVE_A_METHOD_ANNOTATED_WITH_AUDIT)
    .should(ONLY_SET_ATTRIBUTE_USE_ACCOUNT_SET_TO_TRUE);
t3irkdon

t3irkdon3#

除了@raspacorp(谁启发了我!)之外,这里还有一个自定义示例。
为了检查@Secured(ROLE)方法注解,我实现了以下规则:

public static class SecuredByRoleArchCondition extends ArchCondition<JavaMethod> {
    private final String[] expectedRoles;

    public SecuredByRoleArchCondition(String[] expectedRoles) {
        super(String.format("accessed by @Secured methods with roles %s", Arrays.toString(expectedRoles)));
        this.expectedRoles = expectedRoles;
    }

    public static SecuredByRoleArchCondition haveSecuredAnnotationWithRoles(String... expectedRoles) {
        return new SecuredByRoleArchCondition(expectedRoles);
    }

    @Override
    public void check(JavaMethod javaMethod, ConditionEvents events) {
        if (!javaMethod.isAnnotatedWith(Secured.class)) {
            String message = String.format("Method %s annotation @Secured(%s) is missing",
                    javaMethod.getFullName(), Arrays.toString(expectedRoles));
            events.add(SimpleConditionEvent.violated(javaMethod, message));
            return;
        }
        String[] annotationRoleValues = javaMethod.getAnnotationOfType(Secured.class).value();
        if (!Arrays.equals(annotationRoleValues, expectedRoles)) {
            String message = String.format("Method %s @Secured with %s has wrong roles, expected %s instead",
                    javaMethod.getFullName(), Arrays.toString(annotationRoleValues), Arrays.toString(expectedRoles));
            events.add(SimpleConditionEvent.violated(javaMethod, message));
        }
    }
}

下面是此archCondition的示例用法:

@ArchTest
static ArchRule admin_actions_with_post_mapping_should_be_secured_by_ADMIN_WRITE_role =
        methods()
                .that().areDeclaredInClassesThat().resideInAnyPackage(ADMIN_PACKAGES)
                .and().areAnnotatedWith(PostMapping.class)
                .should(haveSecuredAnnotationWithRoles("ADMIN_WRITE"));

相关问题