search

sbabcoc / JUnit-Foundation

JUnit Foundation is a lightweight collection of JUnit watchers, interfaces, and static utility classes that supplement and augment the functionality provided by the JUnit API.
Apache License 2.0
22 stars 6 forks source link

Document the purpose and function of the RULE_CHAIN_LIST option - or remove it #84

Closed sbabcoc closed 3 years ago

sbabcoc commented 3 years ago

JUnit Foundation only has a few settings. One of these settings is RULE_CHAIN_LIST. At this point, there's no documentation for this option save the barest hints provided by the option name and its default value.

The code that uses the value of this option provides the remaining insights. The default value for RULE_CHAIN_LIST ("rulesStartingWithInnerMost") is the name of a private field of the RuleChain class, which is needed to acquire the list of rules attached to the chain maintained by each rule chain instance.

The theory behind providing this option is that the name of the field could change at some point, requiring a mechanism to specify the new field name to restore the ability to acquire the rules list. This possibility is remote at best, and I suspect that no one actually uses the RuleChainWalker anyway. I think the best answer to this option is to remove it.