TNG / ArchUnit

A Java architecture test library, to specify and assert architecture rules in plain Java
http://archunit.org
Apache License 2.0
3.24k stars 297 forks source link

Feature suggestion: Freeze files and stored.rules validation / sanity check #1264

Open keiki85 opened 8 months ago

keiki85 commented 8 months ago

Hi ArchUnit Team,

First of you do a great job here. ArchUnit is great.

In our project we currently have >70 freeze files in the stored.rules mentioned.

Digging deeper I noticed several things, which I am concerned about.

  1. The files referenced might not exist anymore, but the reference in stored.rules is
  2. When freeze files become empty you are not being advised to remove the freezing from your test.
  3. Freeze files might still be in the archunit folder, but not referenced anymore
  4. Tests were removed without removing the stored.rules line or freeze file
  5. stored.rules are not sorted. To make it better human readable it would be nice to have it sorted alphabetically.

Of course in the end it is our job to keep our source code in check and clean up correctly etc.

Yet I wonder how ArchUnit itself can help to have a sanity check of its freeze files and stored.rules?

What is your opinion on this?

codecholeric commented 1 week ago

Sorry for the late reply, I think it would be a nice addition, if anybody wants to give this a shot I would support it! In the past we've already sorted the actual violations alphabetically to ease human browsing and diffs if I remember correctly.