arch_test

拱門

ArchTest是基於規則的體系結構測試工具。它對指定的RUST項目應用靜態分析以提取使用關係。

特徵

• 檢測循環依賴性水平明智或模塊明智
• 禁止父母訪問
• 定義層關係，例如MayNotAccess ， MayOnlyAccess ， MyNotBeAccessedBy ， MayOnlyBeAccessedBy
• 還有更多，請諮詢文檔。

安裝

您可以將其作為貨物的子命令或開發人員依賴項中的包裝安裝。

 # Sub command
cargo install cargo-archtest --force

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

如何使用它

使用貨物子命令

在貨物根路徑中定義一個稱為architecture.json文件。根據Specification結構填充它。例子：

{
  "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
      }
    }
  ]
}

使用生鏽測試

您可以使用Architecture結構來定義架構。之後，您檢查失敗。

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

如果您對失敗感興趣，則可以像這樣漂亮打印出來：

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

連續整合

您可以使用兩種方法在連續集成中使用它。如果您決定在GitHub上使用Cargo Sub命令，則以下片段將允許您測試項目。

 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