Taking inventory: what is inside the program

<#
.SYNOPSIS
Inventory of a .NET project tree: projects, packages and hits for Windows dependencies. Only reads, changes nothing.

.EXAMPLE
./scripts/Inventory.ps1 -Path ./Brandt.OrderBook
#>
[CmdletBinding()]
param(
    [Parameter(Mandatory)]
    [string] $Path
)

$ErrorActionPreference = 'Stop'
$Path = (Resolve-Path -LiteralPath $Path).Path
$excludeBuild = '[\\/](bin|obj|packages)[\\/]'

# Name -> pattern -> what it means for the migration
$patterns = [ordered]@{
    'Windows Forms'       = @{ Regex = 'System\.Windows\.Forms'; Consequence = 'net10.0-windows, UseWindowsForms' }
    'DataSet/ADO.NET'     = @{ Regex = 'SqlDataAdapter|DataSet|DataTable|SqlCommandBuilder'; Consequence = 'Replace the data access' }
    'App.config'          = @{ Regex = 'ConfigurationManager'; Consequence = 'appsettings.json, Configuration' }
    'Windows sign-in'     = @{ Regex = 'WindowsIdentity|WindowsPrincipal'; Consequence = 'Microsoft Entra ID' }
    'Printing/Drawing'    = @{ Regex = 'PrintDocument|PrintPreviewDialog|System\.Drawing'; Consequence = 'System.Drawing.Common, PDF later' }
    'Browser control'     = @{ Regex = 'WebBrowser'; Consequence = 'WebView2' }
    'Registry'            = @{ Regex = 'Microsoft\.Win32|Registry\.'; Consequence = 'Windows Compatibility Pack' }
    'Event log'           = @{ Regex = 'EventLog'; Consequence = 'Windows Compatibility Pack' }
    'Network drive (UNC)' = @{ Regex = '\\\\[A-Za-z0-9._-]+\\'; Consequence = 'Blob storage or file share' }
    'Code pages'          = @{ Regex = 'Encoding\.GetEncoding\('; Consequence = 'Code pages provider needed' }
    'AppDomain/Remoting'  = @{ Regex = 'AppDomain\.CreateDomain|System\.Runtime\.Remoting|BinaryFormatter'; Consequence = 'Not available on .NET' }
    'Native calls'        = @{ Regex = 'DllImport'; Consequence = 'Check, Windows-specific' }
}

$projects = foreach ($file in Get-ChildItem -LiteralPath $Path -Filter '*.csproj' -Recurse -File | Where-Object FullName -NotMatch $excludeBuild) {
    $xml = [xml](Get-Content -LiteralPath $file.FullName -Raw)
    $sdk = $null -ne $xml.Project.Sdk
    $target = $xml.SelectNodes("//*[local-name()='TargetFramework' or local-name()='TargetFrameworkVersion' or local-name()='TargetFrameworks']") | Select-Object -First 1
    $kind = $xml.SelectNodes("//*[local-name()='OutputType']") | Select-Object -First 1
    $references = @($xml.SelectNodes("//*[local-name()='ProjectReference']") | ForEach-Object { $_.Include })
    [pscustomobject]@{
        Project    = $file.BaseName
        Format     = if ($sdk) { 'SDK' } else { 'classic' }
        Target     = if ($target) { $target.InnerText } else { '?' }
        Kind       = if ($kind) { $kind.InnerText } else { 'Library' }
        References = $references.Count
    }
}

$packages = foreach ($file in Get-ChildItem -LiteralPath $Path -Filter 'packages.config' -Recurse -File | Where-Object FullName -NotMatch $excludeBuild) {
    foreach ($package in ([xml](Get-Content -LiteralPath $file.FullName -Raw)).packages.package) {
        [pscustomobject]@{ Package = $package.id; Version = $package.version; Source = 'packages.config' }
    }
}

$sources = Get-ChildItem -LiteralPath $Path -Filter '*.cs' -Recurse -File | Where-Object FullName -NotMatch $excludeBuild
$configs = Get-ChildItem -LiteralPath $Path -Filter '*.config' -Recurse -File | Where-Object FullName -NotMatch $excludeBuild
$hits = foreach ($name in $patterns.Keys) {
    $found = @(($sources + $configs) | Select-String -Pattern $patterns[$name].Regex)
    if ($found.Count -gt 0) {
        [pscustomobject]@{
            Dependency  = $name
            Hits        = $found.Count
            Files       = ($found.Path | ForEach-Object { Split-Path $_ -Leaf } | Sort-Object -Unique) -join ', '
            Consequence = $patterns[$name].Consequence
        }
    }
}

'--- Projects'
$projects | Format-Table -AutoSize | Out-String -Width 200
'--- Packages'
$packages | Format-Table -AutoSize | Out-String -Width 200
'--- Windows dependencies'
$hits | Format-Table -AutoSize -Wrap | Out-String -Width 200

./scripts/Inventory.ps1 -Path ./Brandt.OrderBook

--- Projects

Project          Format  Target Kind   References
-------          ------  ------ ----   ----------
Brandt.OrderBook classic v4.8   WinExe          0

--- Packages

Package         Version Source
-------         ------- ------
Newtonsoft.Json 13.0.3  packages.config

--- Windows dependencies

Dependency          Hits Files                                                              Consequence
----------          ---- -----                                                              -----------
Windows Forms          4 CustomersForm.cs, MainForm.cs, MaintenanceForm.cs, Program.cs      net10.0-windows, UseWindowsForms
DataSet/ADO.NET       15 Exports.cs, MainForm.cs, OrderData.cs                              Replace the data access
App.config             2 Settings.cs                                                        appsettings.json, Configuration
Windows sign-in        2 Permissions.cs                                                     Microsoft Entra ID
Printing/Drawing       8 CustomersForm.cs, InvoicePrint.cs, MainForm.cs, MaintenanceForm.cs System.Drawing.Common, PDF later
Browser control        2 CustomersForm.cs                                                   WebView2
Registry               3 MainForm.cs                                                        Windows Compatibility Pack
Event log              1 Program.cs                                                         Windows Compatibility Pack
Network drive (UNC)    1 App.config                                                         Blob storage or file share
Code pages             1 Exports.cs                                                         Code pages provider needed

SET NOCOUNT ON;

SELECT o.type_desc AS Kind, o.name AS Name, ISNULL(p.name, N'') AS BelongsTo
FROM sys.objects AS o
LEFT JOIN sys.objects AS p ON p.object_id = o.parent_object_id AND o.type = N'TR'
WHERE o.is_ms_shipped = 0 AND o.type IN (N'U', N'V', N'P', N'FN', N'TR')
ORDER BY o.type_desc, o.name;

SELECT OBJECT_NAME(d.referencing_id) AS [From], d.referenced_entity_name AS [To]
FROM sys.sql_expression_dependencies AS d
WHERE d.referencing_id IN (SELECT object_id FROM sys.objects WHERE is_ms_shipped = 0)
GROUP BY OBJECT_NAME(d.referencing_id), d.referenced_entity_name
ORDER BY [From], [To];

sqlcmd -S "(localdb)\MSSQLLocalDB" -E -d OrderBook -b -i scripts/Inventory-Database.sql -W

Kind Name BelongsTo
---- ---- ---------
SQL_STORED_PROCEDURE MaintenanceDue 
SQL_TRIGGER trg_Orders_MaintenanceDone Orders
USER_TABLE Customers 
USER_TABLE MaintenancePlan 
USER_TABLE Orders 
From To
---- --
CK_MaintenancePlan_Interval MaintenancePlan
CK_Orders_Kind Orders
CK_Orders_Status Orders
MaintenanceDue Customers
MaintenanceDue MaintenancePlan
trg_Orders_MaintenanceDone deleted
trg_Orders_MaintenanceDone inserted
trg_Orders_MaintenanceDone MaintenancePlan

flowchart LR
    subgraph Application["Brandt.OrderBook.exe"]
        P[Program]
        H[MainForm]
        K[CustomersForm]
        W[MaintenanceForm]
        D[OrderData]
        R[InvoicePrint]
        X[Exports]
        E[Settings]
        B[Permissions]
    end
    P --> D
    P --> H
    H --> K
    H --> W
    H --> R
    H --> X
    H --> D
    H --> B
    K --> D
    W --> D
    W --> X
    R -->|Price rules| H
    X -->|Price rules| H
    D --> E
    X --> E
    B --> E
    D --> SQL[("SQL Server: tables, procedure, trigger")]
    X --> NL["Network drive Accounting"]
    H --> REG["User's registry"]
    P --> EL["Event log"]
    B --> WIN["Windows sign-in and groups"]
    K --> WB["Browser control"]
    R --> DR["Printer"]