Skip to main content

Crate arch_validation_core

Crate arch_validation_core 

Source
Expand description

§ArchTest

ArchTest is a rule based architecture testing tool. It applies static analyses on the specified rust project to extract use relationships.

§Features

  • Detect cyclic dependencies level wise or module wise
  • Prohibit parent access
  • Define layer relationships like MayNotAccess, MayOnlyAccess, MyNotBeAccessedBy, MayOnlyBeAccessedBy etc.
  • For more access rules consult access_rules.

§Install

[dev-dependencies]
arch_test_core = "*"

§How to use it

You can use the Architecture struct in order to define your architecture. Afterwards you check it for failures.

ⓘ
let architecture = Architecture::new(hash_set!["analyzer".to_owned(), "parser".to_owned(), ...])
.with_access_rule(NoParentAccess)
.with_access_rule(NoModuleCyclicDependencies)
.with_access_rule(NoLayerCyclicDependencies)
...
.with_access_rule(MayNotAccess::new(
    "materials".to_owned(),
    hash_set!["tests".to_owned()],
    true,
));
let module_tree = ModuleTree::new("src/lib.rs");
assert!(architecture.validate_access_rules().is_ok());
assert!(architecture.check_access_rules(&module_tree).is_ok());

If you are interested in the failure you can pretty print it like this:

ⓘ
architecture.check_access_rules(&module_tree).err().unwrap().print(module_tree.tree());

Modules§

access_rules
Access rules that define the Architecture

Macros§

hash_set
has_set![...] macro exposed from the velcro crate for utility An initializer for HashSet, allowing for items to be specified individually or “spread” using the .. operator.

Structs§

Architecture
This is the central object that holds the architecture rules and executes them. It allows defining layers, access rules, and optionally excluding specific modules from checks.
ModuleTree
This object is used to parse the ModuleTree and its use relationships from a directory