arch_test

Arco de arco

ArchTest es una herramienta de prueba de arquitectura basada en reglas. Aplica análisis estáticos en el proyecto de óxido especificado para extraer relaciones de uso.

Características

• Detectar el nivel de dependencias cíclicas en cuanto al módulo o en el módulo
• Prohibir el acceso de los padres
• Definir relaciones de capas como MayNotAccess , MayOnlyAccess , MyNotBeAccessedBy , MayOnlyBeAccessedBy
• Y más, consulte la documentación.

Instalar

Puede instalarlo como sub comando de carga o como un paquete en sus dependencias de desarrolladores.

 # Sub command
cargo install cargo-archtest --force

# Package
[dev-dependencies]
arch_test_core = "*"

Cómo usarlo

Usando el comando de carga de carga

Defina en la ruta de la raíz de carga un archivo llamado architecture.json . Llénelo de acuerdo con la estructura Specification . Ejemplo:

{
  "layer_names" : [ " analyzer " , " parser " , " domain_values " , " entities " , " materials " , " services " , " tests " , " utils " ],
  "access_rules" : [
    " NoLayerCyclicDependencies " ,
    " NoModuleCyclicDependencies " ,
    " NoParentAccess " ,
    {
      "MayNotAccess" : {
        "accessor" : " parser " ,
        "accessed" : [ " analyzer " ],
        "when_same_parent" : true
      }
    },
    {
      "MayOnlyBeAccessedBy" : {
        "accessors" : [ " services " , " tests " ],
        "accessed" : " materials " ,
        "when_same_parent" : false
      }
    },
    {
      "MayNotBeAccessedBy" : {
        "accessors" : [ " materials " , " domain_values " , " entities " , " utils " ],
        "accessed" : " services " ,
        "when_same_parent" : true
      }
    }
  ]
}

Usando una prueba de óxido

Puede usar la estructura Architecture para definir su arquitectura. Luego lo revisas por fallas.

 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 ( ) ) ;

Si está interesado en la falla, puede imprimirlo así:

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

Integración continua

Puede usarlo en integración continua utilizando cualquiera de los métodos. Si decide usar el comando de carga de carga en GitHub, el siguiente fragmento le permitirá probar su proyecto.

 arch_test :
  name : ArchTest
  runs-on : ubuntu-latest
  steps :
    - uses : actions/checkout@v2
    - uses : actions-rs/[email protected]
      with :
        crate : cargo-archtest
        version : latest
    - run : cargo archtest