Search in sources :

Example 26 with ArchCondition

use of com.tngtech.archunit.lang.ArchCondition in project arch-unit-build-plugin-core by societe-generale.

the class NoTestIgnoreWithoutCommentRuleTest method notBeIgnoredWithoutAComment.

public static ArchCondition<JavaClass> notBeIgnoredWithoutAComment() {
    return new ArchCondition<JavaClass>(NO_JUNIT_IGNORE_WITHOUT_COMMENT_VIOLATION_MESSAGE) {

        @Override
        @SuppressWarnings("squid:S1166")
        public void check(JavaClass item, ConditionEvents events) {
            // class level checks
            String violationMessageAtClassLevel = item.getName() + ", at class level";
            addViolationEvent(buildViolationIfAnnotationWithNoValueFound(item, Ignore.class, violationMessageAtClassLevel), events);
            addViolationEvent(buildViolationIfAnnotationWithNoValueFound(item, Disabled.class, violationMessageAtClassLevel), events);
            // method level checks
            for (JavaMethod method : item.getMethods()) {
                String violationMessageAtMethodLevel = item.getName() + " - " + method.getName() + ", at method level";
                addViolationEvent(buildViolationIfAnnotationWithNoValueFound(method, Ignore.class, violationMessageAtMethodLevel), events);
                addViolationEvent(buildViolationIfAnnotationWithNoValueFound(method, Disabled.class, violationMessageAtMethodLevel), events);
            }
        }

        private void addViolationEvent(Optional<ConditionEvent> violation, ConditionEvents events) {
            if (violation.isPresent()) {
                events.add(violation.get());
            }
        }

        private Optional<ConditionEvent> buildViolationIfAnnotationWithNoValueFound(HasAnnotations item, Class annotation, String violationMessage) {
            try {
                if (getAnnotationValue(item, annotation).isEmpty()) {
                    return Optional.of(SimpleConditionEvent.violated(item, violationMessage));
                }
            } catch (IllegalArgumentException e) {
            // if there's no Ignore annotation, IllegalArgument exception is thrown.
            // we swallow it, as it means there's no annotation at class level.
            } catch (NoSuchMethodException | IllegalAccessException | InvocationTargetException e) {
            // this won't happen, as we use reflection on a type that we know has the method we are looking for
            }
            return Optional.empty();
        }

        private String getAnnotationValue(HasAnnotations annotatedObj, Class annotation) throws NoSuchMethodException, InvocationTargetException, IllegalAccessException {
            Annotation ann = annotatedObj.getAnnotationOfType(annotation);
            Method valueMethod = ann.getClass().getDeclaredMethod("value");
            return (String) valueMethod.invoke(ann);
        }
    };
}
Also used : HasAnnotations(com.tngtech.archunit.core.domain.properties.HasAnnotations) Ignore(org.junit.Ignore) Optional(java.util.Optional) ArchCondition(com.tngtech.archunit.lang.ArchCondition) JavaMethod(com.tngtech.archunit.core.domain.JavaMethod) Method(java.lang.reflect.Method) InvocationTargetException(java.lang.reflect.InvocationTargetException) Annotation(java.lang.annotation.Annotation) ConditionEvent(com.tngtech.archunit.lang.ConditionEvent) SimpleConditionEvent(com.tngtech.archunit.lang.SimpleConditionEvent) JavaClass(com.tngtech.archunit.core.domain.JavaClass) JavaMethod(com.tngtech.archunit.core.domain.JavaMethod) JavaClass(com.tngtech.archunit.core.domain.JavaClass) Disabled(org.junit.jupiter.api.Disabled) ConditionEvents(com.tngtech.archunit.lang.ConditionEvents)

Example 27 with ArchCondition

use of com.tngtech.archunit.lang.ArchCondition in project sirius-components by eclipse-sirius.

the class AbstractImmutableTests method haveAPublicGetter.

private ArchCondition<JavaField> haveAPublicGetter() {
    return new // $NON-NLS-1$
    ArchCondition<>(// $NON-NLS-1$
    "have a public getter") {

        @Override
        public void check(JavaField javaField, ConditionEvents events) {
            if (!javaField.getModifiers().contains(STATIC)) {
                JavaClass javaClass = javaField.getOwner();
                // $NON-NLS-1$
                String getterName = "get" + javaField.getName().substring(0, 1).toUpperCase() + javaField.getName().substring(1);
                if (javaField.getRawType().getFullName().equals("java.lang.Boolean") || javaField.getRawType().getFullName().equals("boolean")) {
                    // $NON-NLS-1$ //$NON-NLS-2$
                    // $NON-NLS-1$
                    getterName = "is" + javaField.getName().substring(0, 1).toUpperCase() + javaField.getName().substring(1);
                }
                boolean isConditionSatisfied = false;
                try {
                    JavaMethod method = javaClass.getMethod(getterName);
                    isConditionSatisfied = method != null && method.getModifiers().contains(PUBLIC);
                } catch (IllegalArgumentException exception) {
                    // Getter not found
                    isConditionSatisfied = false;
                }
                // $NON-NLS-1$
                String message = "The field has a getter";
                if (!isConditionSatisfied) {
                    // $NON-NLS-1$ //$NON-NLS-2$
                    message = "The field " + javaField.getFullName() + " does not have a getter";
                }
                events.add(new SimpleConditionEvent(javaField, isConditionSatisfied, message));
            }
        }
    };
}
Also used : SimpleConditionEvent(com.tngtech.archunit.lang.SimpleConditionEvent) JavaField(com.tngtech.archunit.core.domain.JavaField) JavaClass(com.tngtech.archunit.core.domain.JavaClass) ArchCondition(com.tngtech.archunit.lang.ArchCondition) JavaMethod(com.tngtech.archunit.core.domain.JavaMethod) ConditionEvents(com.tngtech.archunit.lang.ConditionEvents)

Example 28 with ArchCondition

use of com.tngtech.archunit.lang.ArchCondition in project sirius-components by eclipse-sirius.

the class AbstractImmutableTests method notHaveSetters.

private ArchCondition<JavaClass> notHaveSetters() {
    return new // $NON-NLS-1$
    ArchCondition<>(// $NON-NLS-1$
    "not have setters") {

        @Override
        public void check(JavaClass javaClass, ConditionEvents events) {
            // @formatter:off
            long settersCount = javaClass.getMethods().stream().filter(// $NON-NLS-1$
            javaMethod -> javaMethod.getName().startsWith("set")).count();
            // @formatter:on
            boolean isConditionSatisfied = settersCount == 0;
            // $NON-NLS-1$
            String message = "The class does not have any setters";
            if (!isConditionSatisfied) {
                // $NON-NLS-1$//$NON-NLS-2$
                message = "The class " + javaClass.getName() + " does have setters";
            }
            events.add(new SimpleConditionEvent(javaClass, isConditionSatisfied, message));
        }
    };
}
Also used : JavaClasses(com.tngtech.archunit.core.domain.JavaClasses) Immutable(org.eclipse.sirius.components.annotations.Immutable) JavaMethod(com.tngtech.archunit.core.domain.JavaMethod) STATIC(com.tngtech.archunit.core.domain.JavaModifier.STATIC) ArchCondition(com.tngtech.archunit.lang.ArchCondition) FINAL(com.tngtech.archunit.core.domain.JavaModifier.FINAL) JavaField(com.tngtech.archunit.core.domain.JavaField) MessageFormat(java.text.MessageFormat) Test(org.junit.jupiter.api.Test) ConditionEvents(com.tngtech.archunit.lang.ConditionEvents) ArchRule(com.tngtech.archunit.lang.ArchRule) ArchRuleDefinition(com.tngtech.archunit.lang.syntax.ArchRuleDefinition) SimpleConditionEvent(com.tngtech.archunit.lang.SimpleConditionEvent) JavaClass(com.tngtech.archunit.core.domain.JavaClass) PUBLIC(com.tngtech.archunit.core.domain.JavaModifier.PUBLIC) SimpleConditionEvent(com.tngtech.archunit.lang.SimpleConditionEvent) JavaClass(com.tngtech.archunit.core.domain.JavaClass) ArchCondition(com.tngtech.archunit.lang.ArchCondition) ConditionEvents(com.tngtech.archunit.lang.ConditionEvents)

Example 29 with ArchCondition

use of com.tngtech.archunit.lang.ArchCondition in project flink-mirror by flink-ci.

the class Conditions method haveLeafExceptionTypes.

/**
 * Tests leaf exception types of a method against the given predicate.
 *
 * <p>See {@link #haveLeafTypes(DescribedPredicate)} for details.
 */
public static ArchCondition<JavaMethod> haveLeafExceptionTypes(DescribedPredicate<JavaClass> typePredicate) {
    return new ArchCondition<JavaMethod>("have leaf exception types" + typePredicate.getDescription()) {

        @Override
        public void check(JavaMethod method, ConditionEvents events) {
            final List<JavaClass> leafArgumentTypes = method.getExceptionTypes().stream().flatMap(argumentType -> getLeafTypes(argumentType).stream()).collect(Collectors.toList());
            for (JavaClass leafType : leafArgumentTypes) {
                if (!isJavaClass(leafType)) {
                    continue;
                }
                if (!typePredicate.apply(leafType)) {
                    final String message = String.format("%s: Exception leaf type %s does not satisfy: %s", method.getFullName(), leafType.getName(), typePredicate.getDescription());
                    events.add(SimpleConditionEvent.violated(method, message));
                }
            }
        }
    };
}
Also used : SourcePredicates.isJavaClass(org.apache.flink.architecture.common.SourcePredicates.isJavaClass) JavaMethod(com.tngtech.archunit.core.domain.JavaMethod) ArchCondition(com.tngtech.archunit.lang.ArchCondition) DescribedPredicate(com.tngtech.archunit.base.DescribedPredicate) JavaType(com.tngtech.archunit.core.domain.JavaType) Collectors(java.util.stream.Collectors) HasName(com.tngtech.archunit.core.domain.properties.HasName) List(java.util.List) ConditionEvents(com.tngtech.archunit.lang.ConditionEvents) Stream(java.util.stream.Stream) SimpleConditionEvent(com.tngtech.archunit.lang.SimpleConditionEvent) JavaClass(com.tngtech.archunit.core.domain.JavaClass) Collections(java.util.Collections) JavaParameterizedType(com.tngtech.archunit.core.domain.JavaParameterizedType) SourcePredicates.isJavaClass(org.apache.flink.architecture.common.SourcePredicates.isJavaClass) JavaClass(com.tngtech.archunit.core.domain.JavaClass) ArchCondition(com.tngtech.archunit.lang.ArchCondition) JavaMethod(com.tngtech.archunit.core.domain.JavaMethod) ConditionEvents(com.tngtech.archunit.lang.ConditionEvents)

Example 30 with ArchCondition

use of com.tngtech.archunit.lang.ArchCondition in project flink-mirror by flink-ci.

the class Conditions method haveLeafReturnTypes.

/**
 * Tests leaf return types of a method against the given predicate.
 *
 * <p>See {@link #haveLeafTypes(DescribedPredicate)} for details.
 */
public static ArchCondition<JavaMethod> haveLeafReturnTypes(DescribedPredicate<JavaClass> typePredicate) {
    return new ArchCondition<JavaMethod>("have leaf return types" + typePredicate.getDescription()) {

        @Override
        public void check(JavaMethod method, ConditionEvents events) {
            for (JavaClass leafType : getLeafTypes(method.getReturnType())) {
                if (!isJavaClass(leafType)) {
                    continue;
                }
                if (!typePredicate.apply(leafType)) {
                    final String message = String.format("%s: Returned leaf type %s does not satisfy: %s", method.getFullName(), leafType.getName(), typePredicate.getDescription());
                    events.add(SimpleConditionEvent.violated(method, message));
                }
            }
        }
    };
}
Also used : SourcePredicates.isJavaClass(org.apache.flink.architecture.common.SourcePredicates.isJavaClass) JavaClass(com.tngtech.archunit.core.domain.JavaClass) ArchCondition(com.tngtech.archunit.lang.ArchCondition) JavaMethod(com.tngtech.archunit.core.domain.JavaMethod) ConditionEvents(com.tngtech.archunit.lang.ConditionEvents)

Aggregations

ArchCondition (com.tngtech.archunit.lang.ArchCondition)30 ConditionEvents (com.tngtech.archunit.lang.ConditionEvents)30 JavaClass (com.tngtech.archunit.core.domain.JavaClass)23 SimpleConditionEvent (com.tngtech.archunit.lang.SimpleConditionEvent)21 JavaMethod (com.tngtech.archunit.core.domain.JavaMethod)20 SourcePredicates.isJavaClass (org.apache.flink.architecture.common.SourcePredicates.isJavaClass)9 DescribedPredicate (com.tngtech.archunit.base.DescribedPredicate)8 List (java.util.List)8 JavaMember (com.tngtech.archunit.core.domain.JavaMember)7 JavaParameterizedType (com.tngtech.archunit.core.domain.JavaParameterizedType)6 JavaType (com.tngtech.archunit.core.domain.JavaType)6 HasName (com.tngtech.archunit.core.domain.properties.HasName)6 Collections (java.util.Collections)6 Collectors (java.util.stream.Collectors)6 Stream (java.util.stream.Stream)6 Test (org.junit.Test)5 JavaField (com.tngtech.archunit.core.domain.JavaField)4 EvaluationResult (com.tngtech.archunit.lang.EvaluationResult)4 JavaClasses (com.tngtech.archunit.core.domain.JavaClasses)2 JavaConstructor (com.tngtech.archunit.core.domain.JavaConstructor)2