Главная

Как увидеть связи внутри вашего PowerShell модуля

2018-10-03 в 13:22, admin, рубрики: powershell

День добрый, коллеги. Сто лет назад где-то описывал быстрый и "грязный" способ увидеть граф вызовов внутри вашего PowerShell скрипта. Теперь, пришла, так сказать, пора, натянуть сову на глобус и посмотреть граф зависимостей внутри модуля.

Прежде всего, нудно установить PSQuickGraph module из Powershell Gallery. И следом за этим запустить скрипт, базу которого можно взять вот тут. Честно говоря, я не совсем понял, как вставить код из gist в пост на хабре. Если кто подскажет в коментах, буду премного благодарен.

Итак, продолжим. Прежде всего, в двух словал про сам модуль. Он строится на библиотеке QuickGraph. По сути, это PowerShell обертка над библиотекой, которая предназначена для быстрых и грубых тестов с графами. Одним из таких тестов может быть штука, которая разбирает ваш PowerShell код, генерирует из него граф связей, и представляет его визуально.

Кроме того, в самом скрипте используется встроенный в PowerShell механизм доступа к его AST что, собственно, значительно упрощает нам разбор кода. В конечном итоге скомбинировав одно и другое мы получаем граф.

В итоге, сам скрипт состоит из двух частей. Куска "парсера", работающего с AST, и части, которая соственно связывает AST и граф. Эта часть описана на следующем примере

# создаем экземпляр графа (модуль PSQuickGraph)
$g = New-Graph -Type BidirectionalGraph
# парсим PS1 файлы, выгребаем AST и добавляем функции как вершины в граф
$f = dir "C:RepoWorkTools*.ps1" -Recurse | Find-Function
$f.name | % { Add-Vertex -Vertex $_ -Graph $g}

# бежим второй раз, и добавляем вершины там, где происходят вызовы функций модуля и взяких других командлетов, которые нам могут быть интересны
$f | % {
    $fName = $_.name
    $tmpFile = New-TemporaryFile
    $_.line >> ($tmpFile.fullname)
    $expr = Find-Expression -Fullname $tmpFile.fullname
    $expr.name | ? {$_} | ? {$_ -notin "%","where","?","select","out-null","sort","ft","fl","Write-Verbose" } | % { Add-Edge -From $fName -to $_ -Graph $g}
}

# отображаем граф
Show-GraphLayout -Graph $g

# сохраняем его в формате DOT
Export-Graph -Format Graphviz -Graph $g -Path C:Tempg.gv

Ну и, примерно вот так это выглядит в результате

moduleStructure