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

Непрерывная интеграция

Вы можете использовать его в непрерывной интеграции, используя любой методы. Если вы решите использовать под командование Cargo на GitHub, следующий фрагмент позволит вам проверить ваш проект.

 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