support executing single @ArchTest members
#1280
Merged
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
hankem
approved these changes
Apr 4, 2024
.../junit5/engine/src/test/java/com/tngtech/archunit/junit/internal/ArchUnitTestEngineTest.java
Outdated
Show resolved
Hide resolved
...rc/main/java/com/tngtech/archunit/junit/internal/ArchUnitSystemPropertyTestFilterJUnit5.java
Show resolved
Hide resolved
Right now the ArchUnit website can't be started locally anymore, because Jekyll throws an error ``` Conversion error: Jekyll::Converters::Scss encountered an error while converting 'assets/css/main.scss': Broken pipe ``` From what I found online Jekyll 4 has become stricter in some way. I don't exactly understand why, because the scss file still seems to conform to the docs, but since I also found that GitHub pages uses Jekyll 3.9.5 at this time anyway, I figured we may as well just downgrade to that version, which then also fixes our problem. I don't remember the original reason why we weren't using the github-pages Gem, but from what I see right now it seems to work exactly as specified in the docs. It also fixes Jekyll to the correct version. So, I reverted the Gemfile to use the github-pages Gem instead of the jekyll Gem. Signed-off-by: Peter Gafert <peter.gafert@archunit.org>
One inconvenience of the current state of the `ArchUnitTestEngine` is the fact that there is no simple way to execute a single rule. For methods annotated with `@ArchTest` this might be supported by the IDE, but for fields there is no convenient way except of commenting all other `@ArchTest` annotations. We now provide a simple way to run any member in isolation by specifying a system property / `ArchConfiguration` value. This change allows to pass a simple test name filter that for now only supports exact member matches. E.g. specifying `-Darchunit.junit.testFilter=my_custom_rule` would run the rule declared in a field or member with name `my_custom_rule`. Multiple members can be joined by `,` and are then all executed in one run. Signed-off-by: Peter Gafert <peter.gafert@archunit.org>
One inconvenience of the current state of the `ArchUnitRunner` is the fact that there is no simple way to execute a single rule. For methods annotated with `@ArchTest` this might be supported by the IDE, but for fields there is no convenient way except of commenting all other `@ArchTest` annotations. We now provide a simple way to run any member in isolation by specifying a system property / `ArchConfiguration` value. This change allows to pass a simple test name filter that for now only supports exact member matches. E.g. specifying `-Darchunit.junit.testFilter=my_custom_rule` would run the rule declared in a field or member with name `my_custom_rule`. Multiple members can be joined by `,` and are then all executed in one run. Unfortunately, filtering in JUnit 4 is tied to only the `Description` of the current test. Since we don't want to couple text parsing of the description to filtering (e.g. if we change the description in the future), we have to introduce a hack to transmit the original member name to the `Filter`. Due to the fact that `Description` is effectively final and has no intended way for our use case, we (ab-)use the `annotations` of the test member to pass along the information in a custom annotation. This should have no further effect, since no infrastructure can react to unknown annotations, which may be present at any time for given tests. Signed-off-by: Peter Gafert <peter.gafert@archunit.org>
Yes, I was aware of that, but as you wrote, I doubt that will really be a problem in practice. If it is, we can still ponder about making this more powerful. But, let's see first if there are really requirements for this... |
codecholeric
force-pushed
the
support-executing-single-archtest-field
branch
from
5f81e5c
to
14d7f4d
Compare
This was referenced Apr 10, 2024
Closed
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.
Currently there is no convenient way to execute a single
@ArchTestrule of a test running with JUnit 4 or 5 support.As a simple mitigation we now provide the possibility to filter a single test via
archunit.properties/ system property.This change allows to e.g. pass
to a test run, which will then filter the tests and only run the
@Archtestfields or methods with the given name(s).For now we don't support any wildcards or narrowing the match down by surrounding class name
to see if this feature is even missed by users. Basic filtering for classes or packages should already be supported
by the respective test launcher (i.e. both JUnit 4 and 5 support should respect filter requests for classes or packages already).
Issue: #641