com.tngtech.archunit.library.DependencyRules Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of archunit Show documentation

A Java architecture test library, to specify and assert architecture rules in plain Java - Module 'archunit'

There is a newer version: 1.3.0

/*
 * Copyright 2014-2021 TNG Technology Consulting GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.tngtech.archunit.library;

import com.tngtech.archunit.PublicAPI;
import com.tngtech.archunit.core.domain.Dependency;
import com.tngtech.archunit.core.domain.JavaClass;
import com.tngtech.archunit.lang.ArchCondition;
import com.tngtech.archunit.lang.ArchRule;
import com.tngtech.archunit.lang.ConditionEvents;
import com.tngtech.archunit.lang.SimpleConditionEvent;

import static com.tngtech.archunit.PublicAPI.Usage.ACCESS;
import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.noClasses;

@PublicAPI(usage = ACCESS)
public final class DependencyRules {
    private DependencyRules() {
    }

    @PublicAPI(usage = ACCESS)
    public static final ArchRule NO_CLASSES_SHOULD_DEPEND_UPPER_PACKAGES =
            noClasses().should(dependOnUpperPackages())
                    .because("that might prevent packages on that level from being split into separate artifacts in a clean way");

    @PublicAPI(usage = ACCESS)
    public static ArchCondition dependOnUpperPackages() {
        return new DependOnUpperPackagesCondition();
    }

    private static class DependOnUpperPackagesCondition extends ArchCondition {
        DependOnUpperPackagesCondition() {
            super("depend on upper packages");
        }

        @Override
        public void check(final JavaClass clazz, final ConditionEvents events) {
            for (Dependency dependency : clazz.getDirectDependenciesFromSelf()) {
                boolean dependencyOnUpperPackage = isDependencyOnUpperPackage(dependency.getOriginClass(), dependency.getTargetClass());
                events.add(new SimpleConditionEvent(dependency, dependencyOnUpperPackage, dependency.getDescription()));
            }
        }

        private boolean isDependencyOnUpperPackage(JavaClass origin, JavaClass target) {
            String originPackageName = origin.getPackageName();
            String targetSubPackagePrefix = target.getPackageName() + ".";
            return originPackageName.startsWith(targetSubPackagePrefix);
        }
    }
}