Skip to content

Stabilize ModuleDependency descriptions #1648

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DragonFSKY wants to merge 1 commit into
base: main
Choose a base branch
from
+22 −1
Open

Stabilize ModuleDependency descriptions #1648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions archunit/src/main/java/com/tngtech/archunit/library/modules/ModuleDependency.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ public Set<Dependency> toClassDependencies() {
@PublicAPI(usage = ACCESS, state = EXPERIMENTAL)
public String getDescription() {
String classDependencyDescriptions = classDependencies.stream()
.sorted()
.map(HasDescription::getDescription)
.collect(joining(lineSeparator()));
return String.format("Module Dependency [%s -> %s]:%n%s", origin.getName(), target.getName(), classDependencyDescriptions);
Expand Down
22 changes: 21 additions & 1 deletion archunit/src/test/java/com/tngtech/archunit/library/modules/ModuleDependencyTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,14 @@
import com.tngtech.archunit.core.domain.Dependency;
import com.tngtech.archunit.core.importer.ClassFileImporter;
import com.tngtech.archunit.library.modules.syntax.testexamples.test_modules.one.ClassOne;
import com.tngtech.archunit.library.modules.syntax.testexamples.test_modules.one.one.ClassOneOne;
import com.tngtech.archunit.library.modules.syntax.testexamples.test_modules.two.ClassTwo;
import com.tngtech.archunit.library.modules.syntax.testexamples.test_modules.two.one.ClassTwoOne;
import org.junit.Test;

import static com.tngtech.archunit.testutil.Assertions.assertThatConversionOf;
import static java.lang.System.lineSeparator;
import static org.assertj.core.api.Assertions.assertThat;

public class ModuleDependencyTest {
@Test
Expand All @@ -21,10 +25,26 @@ public void can_be_converted_to_dependencies() {
.isPossibleTo(Dependency.class);
}

@Test
public void description_contains_class_dependencies_in_stable_order() {
ArchModules<?> modules = ArchModules.defineByPackages("..test_modules.(*)..")
.modularize(new ClassFileImporter().importPackagesOf(
ClassOne.class, ClassOneOne.class, ClassTwo.class, ClassTwoOne.class));

ModuleDependency<?> moduleDependency = createDependency(modules, "one", "two");

assertThat(moduleDependency.getDescription())
.isEqualTo(String.format("Module Dependency [one -> two]:%n%s%n%s",
String.format("Field <%s.classTwo> has type <%s> in (ClassOne.java:0)",
ClassOne.class.getName(), ClassTwo.class.getName()),
String.format("Field <%s.twoOne> has type <%s> in (ClassOneOne.java:0)",
ClassOneOne.class.getName(), ClassTwoOne.class.getName())));
}

private static <D extends ArchModule.Descriptor> ModuleDependency<D> createDependency(ArchModules<D> modules, String originIdentifier, String targetIdentifier) {
return ModuleDependency.tryCreate(
modules.getByIdentifier(originIdentifier),
modules.getByIdentifier(targetIdentifier)
).get();
}
}
}