ignore unknown components in dependencies of PlantUML diagrams #1184
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tfij
force-pushed
the
ignore_unknow_components
branch
from
f72f096
to
e3ed562
Compare
codecholeric
requested changes
Jan 1, 2024
There was a problem hiding this comment.
Thanks a lot for adding this!! 😃 🙏 Looks quite good, I just have some comments you can check out. One bigger is around adding the component keyword support I guess, because for me that's a slightly different issue and should IMHO be split from ignoring dependencies from unknown components.
archunit/src/main/java/com/tngtech/archunit/library/plantuml/rules/PlantUmlComponents.java
Outdated
Show resolved
Hide resolved
archunit/src/main/java/com/tngtech/archunit/library/plantuml/rules/PlantUmlComponents.java
Outdated
Show resolved
Hide resolved
archunit/src/main/java/com/tngtech/archunit/library/plantuml/rules/PlantUmlParser.java
Show resolved
Hide resolved
archunit/src/main/java/com/tngtech/archunit/library/plantuml/rules/PlantUmlPatterns.java
Outdated
Show resolved
Hide resolved
archunit/src/main/java/com/tngtech/archunit/library/plantuml/rules/PlantUmlPatterns.java
Outdated
Show resolved
Hide resolved
archunit/src/test/java/com/tngtech/archunit/library/plantuml/rules/PlantUmlParserTest.java
Outdated
Show resolved
Hide resolved
tfij
force-pushed
the
ignore_unknow_components
branch
from
e3ed562
to
472ed02
Compare
|
@codecholeric thanks for CR |
codecholeric
force-pushed
the
ignore_unknow_components
branch
3 times, most recently
from
108b053
to
2e86f82
Compare
codecholeric
changed the title
codecholeric
approved these changes
Apr 10, 2024
Otherwise, `Objects.requireNonNull(..)` causes false positives. Signed-off-by: Peter Gafert <peter.gafert@archunit.org>
The current implementation prevents using PlantUML diagrams as rules that are used for wider documentation purposes (e.g. containing a database component or some other dependency that's irrelevant from the point of an ArchUnit test). The consequence of ignoring such unknown components is only to allow fewer dependencies and fewer classes to be present. So, at best the test will fail as a false positive, if the components are declared wrongly by accident. Thus, there is no major harm in simply ignoring these unknown components and giving users a little more freedom what elements they want to use in their diagrams. Issue: TNG#1132 Signed-off-by: Tomasz Fijalkowski <3066563+tfij@users.noreply.github.com>
codecholeric
force-pushed
the
ignore_unknow_components
branch
from
2e86f82
to
c1ecd8c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current implementation prevents using PlantUML diagrams as rules
that are used for wider documentation purposes (e.g. containing a
database component or some other dependency that's irrelevant from the
point of an ArchUnit test).
The consequence of ignoring such unknown components is only to allow
fewer dependencies and fewer classes to be present.
So, at best the test will fail as a false positive, if the components
are declared wrongly by accident.
Thus, there is no major harm in simply ignoring these unknown components
and giving users a little more freedom what elements they want to use
in their diagrams.
Resolves: #1132