Architectural Constraint

Question

I have a package "parent" which contains packages "parent.child1", "parent.child2" etc.

I wish to enforce that classes in "parent.x" cannot reference classes in "parent.**" (other than in "parent.x" and "parent.x.**").

The first bit is an easy, albeit recursive, Architectural Constraint. The "other than" clause is the tricky bit.

The reason we have this structure in our multi-module maven project is that each "child" is a small and self-contained collection of classes. It is impractical to make each "child" into a maven module. We're talking 5 or 6 classes in each, and it is at developers' discretion to create new "child" packages.

Thanks and regards, Robin.

score 0 · Answer 1 · edited May 23 '17 at 10:26

0

Sorry, but you're going to have to do this the painful way (one rule for each forbidden subpackage) or be very clever with your regex. The parameter values are evaluated as Java regexes, so a negative lookahead ought to work.

EDIT: You could also try a custom rule. XPath's not supported anymore for Java, but you can write custom rules in Java. It's likely that you'd be able to do what you want in a custom rule, but I haven't explored the API's thoroughly enough to know for sure.

edited May 23 '17 at 10:26

Community

1
1

answered Sep 03 '15 at 19:26

G. Ann - SonarSource Team

22,346
4
40
76

Could I express a new rule as XPath? Not sure if you support XPath-based rules for Java artifacts though....? – Robin Roos Sep 04 '15 at 10:47
Is the ArchitecturalContraint rule implemented in Java, and could I see this code as a starting point for a custom rule? – Robin Roos Sep 07 '15 at 13:25
Of course: https://github.com/SonarSource/sonar-java/blob/master/java-checks/src/main/java/org/sonar/java/checks/ArchitectureCheck.java – G. Ann - SonarSource Team Sep 14 '15 at 11:21

Architectural Constraint

1 Answers1