Support for grouping rules

[mkjensen]

Summary

Please consider supporting that a configurable rule can be a grouping of rules.

Type of Issue

It is a :

• bug
• request
• question regarding the documentation

Motivation

Basically, given

class AllRulesTest {

    @ArchTest
    static final ArchTests SOME_RULES = ArchTests.in(SomeRules.class);

    @ArchTest
    static final ArchTests OTHER_RULES = ArchTests.in(OtherRules.class);
}

it would be nice that the Maven plugin would pick up all the rules via

(...)
<rules>
  <configurableRules>
      <configurableRule>
          <rule>package.AllRulesTest</rule>
      </configurableRule>
  </configurableRules>
</rules>
(...)

instead of having to do

(...)
<rules>
  <configurableRules>
      <configurableRule>
          <rule>package.SomeRules</rule>
      </configurableRule>
      <configurableRule>
          <rule>package.OtherRules</rule>
      </configurableRule>
  </configurableRules>
</rules>
(...)

Current Behavior

Grouping is ignored (rules referred to by ArchTests are not taken into consideration).

Currently it looks like grouping is not supported in InvokableRules.

Expected Behavior

Grouping works via the plugin just as if run as a test directly.

Steps to Reproduce (for bugs)

If the above is not clear, I can provide a sample.

Your Environment

ArchUnit 1.0.1
arch-unit-maven-plugin 3.0.0

[vincent-fuchs]

the configurableRules are supposed to be configured in the build config (maven or gradle). grouping would defeat the purpose, wouldn't it ? Maybe it could work with preconfiguredRules , but I am not convinced we would gain much.

[mkjensen]

You are right that one can continue to add rules to the plugin configuration.

The idea with this request is that the plugin configuration could be static and you could extend the referenced grouping class(es) instead.

The thinking is that keeping the plugin configuration static and leaving details to Java classes would be easier to maintain, but maybe this is subjective.