Phase 2 Stream D progress — non-destructive deliverables: appsettings → DriverConfig migration script, two-service Windows installer scripts, process-spawn cross-FX parity test, Stream D removal procedure doc with both Option A (rewrite 494 v1 tests) and Option B (archive + new v2 E2E suite) spelled out step-by-step. Cannot one-shot the actual legacy-Host deletion in any unattended session — explained in the procedure doc; the parity-defect debug cycle is intrinsically interactive (each iteration requires inspecting a v1↔v2 diff and deciding if it's a legitimate v2 improvement or a regression, then either widening the assertion or fixing the v2 code), and git rm -r src/ZB.MOM.WW.OtOpcUa.Host is destructive enough to need explicit operator authorization on a real PR review. scripts/migration/Migrate-AppSettings-To-DriverConfig.ps1 takes a v1 appsettings.json and emits the v2 DriverInstance.DriverConfig JSON blob (MxAccess/Database/Historian sections) ready to upsert into the central Configuration DB; null-leaf stripping; -DryRun mode; smoke-tested against the dev appsettings.json and produces the expected three-section ordered-dictionary output. scripts/install/Install-Services.ps1 registers the two v2 services with sc.exe — OtOpcUaGalaxyHost first (net48 x86 EXE with OTOPCUA_GALAXY_PIPE/OTOPCUA_ALLOWED_SID/OTOPCUA_GALAXY_SECRET/OTOPCUA_GALAXY_BACKEND/OTOPCUA_GALAXY_ZB_CONN/OTOPCUA_GALAXY_CLIENT_NAME env vars set via HKLM:\SYSTEM\CurrentControlSet\Services\OtOpcUaGalaxyHost\Environment registry), then OtOpcUa with depend=OtOpcUaGalaxyHost; resolves down-level account names to SID for the IPC ACL; generates a fresh 32-byte base64 shared secret per install if not supplied (kept out of registry — operators record offline for service rebinding scenarios); echoes start commands. scripts/install/Uninstall-Services.ps1 stops + removes both services. tests/ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Proxy.Tests/HostSubprocessParityTests.cs is the production-shape parity test — Proxy (.NET 10) spawns the actual OtOpcUa.Driver.Galaxy.Host.exe (net48 x86) as a subprocess via Process.Start with backend=db env vars, connects via real named pipe, calls Discover, asserts at least one Galaxy gobject comes back. Skipped when running as Administrator (PipeAcl denies admins, same guard as other IPC integration tests), when the Host EXE hasn't been built, or when the ZB SQL endpoint is unreachable. This is the cross-FX integration that the parity suite genuinely needs — the previous IPC tests all ran in-process; this one validates the production deployment topology where Proxy and Host are separate processes communicating only over the named pipe. docs/v2/implementation/stream-d-removal-procedure.md is the next-session playbook: Option A (rewrite 494 v1 tests via a ProxyMxAccessClientAdapter that implements v1's IMxAccessClient by forwarding to GalaxyProxyDriver — Vtq↔DataValueSnapshot, Quality↔StatusCode, OnTagValueChanged↔OnDataChange mapping; 3-5 days, full coverage), Option B (rename OtOpcUa.Tests → OtOpcUa.Tests.v1Archive with [Trait("Category", "v1Archive")] for opt-in CI runs; new OtOpcUa.Driver.Galaxy.E2E test project with 10-20 representative tests via the HostSubprocessParityTests pattern; 1-2 days, accreted coverage); deletion checklist with eight pre-conditions, ten ordered steps, and a rollback path (git revert restores the legacy Host alongside the v2 stack — both topologies remain installable until the downstream consumer cutover). Full solution 964 pass / 1 pre-existing Phase 0 baseline; the 494 v1 IntegrationTests + 6 v1 IntegrationTests-net48 still pass because legacy OtOpcUa.Host stays untouched until an interactive session executes the procedure doc.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Joseph Doherty
107
scripts/migration/Migrate-AppSettings-To-DriverConfig.ps1
Normal file
107
scripts/migration/Migrate-AppSettings-To-DriverConfig.ps1
Normal file
@@ -0,0 +1,107 @@
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Translates a v1 OtOpcUa.Host appsettings.json into a v2 DriverInstance.DriverConfig JSON
|
||||
blob suitable for upserting into the central Configuration DB.
|
||||
|
||||
.DESCRIPTION
|
||||
Phase 2 Stream D.3 — moves the legacy MxAccess + GalaxyRepository + Historian sections out
|
||||
of node-local appsettings.json and into the central DB so each node only needs Cluster.NodeId
|
||||
+ ClusterId + DB conn (per decision #18). Idempotent + dry-run-able.
|
||||
|
||||
Output shape matches the Galaxy DriverType schema in `docs/v2/plan.md` §"Galaxy DriverConfig":
|
||||
|
||||
{
|
||||
"MxAccess": { "ClientName": "...", "RequestTimeoutSeconds": 30 },
|
||||
"Database": { "ConnectionString": "...", "PollIntervalSeconds": 60 },
|
||||
"Historian": { "Enabled": false }
|
||||
}
|
||||
|
||||
.PARAMETER AppSettingsPath
|
||||
Path to the v1 appsettings.json. Defaults to ../../src/ZB.MOM.WW.OtOpcUa.Host/appsettings.json
|
||||
relative to the script.
|
||||
|
||||
.PARAMETER OutputPath
|
||||
Where to write the generated DriverConfig JSON. Defaults to stdout.
|
||||
|
||||
.PARAMETER DryRun
|
||||
Print what would be written without writing.
|
||||
|
||||
.EXAMPLE
|
||||
pwsh ./Migrate-AppSettings-To-DriverConfig.ps1 -AppSettingsPath C:\OtOpcUa\appsettings.json -OutputPath C:\tmp\galaxy-driverconfig.json
|
||||
#>
|
||||
[CmdletBinding()]
|
||||
param(
|
||||
[string]$AppSettingsPath,
|
||||
[string]$OutputPath,
|
||||
[switch]$DryRun
|
||||
)
|
||||
|
||||
$ErrorActionPreference = 'Stop'
|
||||
|
||||
if (-not $AppSettingsPath) {
|
||||
$AppSettingsPath = Join-Path (Split-Path -Parent $PSScriptRoot) '..\src\ZB.MOM.WW.OtOpcUa.Host\appsettings.json'
|
||||
}
|
||||
|
||||
if (-not (Test-Path $AppSettingsPath)) {
|
||||
Write-Error "AppSettings file not found: $AppSettingsPath"
|
||||
exit 1
|
||||
}
|
||||
|
||||
$src = Get-Content -Raw $AppSettingsPath | ConvertFrom-Json
|
||||
|
||||
$mx = $src.MxAccess
|
||||
$gr = $src.GalaxyRepository
|
||||
$hi = $src.Historian
|
||||
|
||||
$driverConfig = [ordered]@{
|
||||
MxAccess = [ordered]@{
|
||||
ClientName = $mx.ClientName
|
||||
NodeName = $mx.NodeName
|
||||
GalaxyName = $mx.GalaxyName
|
||||
RequestTimeoutSeconds = $mx.ReadTimeoutSeconds
|
||||
WriteTimeoutSeconds = $mx.WriteTimeoutSeconds
|
||||
MaxConcurrentOps = $mx.MaxConcurrentOperations
|
||||
MonitorIntervalSec = $mx.MonitorIntervalSeconds
|
||||
AutoReconnect = $mx.AutoReconnect
|
||||
ProbeTag = $mx.ProbeTag
|
||||
}
|
||||
Database = [ordered]@{
|
||||
ConnectionString = $gr.ConnectionString
|
||||
ChangeDetectionIntervalSec = $gr.ChangeDetectionIntervalSeconds
|
||||
CommandTimeoutSeconds = $gr.CommandTimeoutSeconds
|
||||
ExtendedAttributes = $gr.ExtendedAttributes
|
||||
Scope = $gr.Scope
|
||||
PlatformName = $gr.PlatformName
|
||||
}
|
||||
Historian = [ordered]@{
|
||||
Enabled = if ($null -ne $hi -and $null -ne $hi.Enabled) { $hi.Enabled } else { $false }
|
||||
}
|
||||
}
|
||||
|
||||
# Strip null-valued leaves so the resulting JSON is compact and round-trippable.
|
||||
function Remove-Nulls($obj) {
|
||||
$keys = @($obj.Keys)
|
||||
foreach ($k in $keys) {
|
||||
if ($null -eq $obj[$k]) { $obj.Remove($k) | Out-Null }
|
||||
elseif ($obj[$k] -is [System.Collections.Specialized.OrderedDictionary]) { Remove-Nulls $obj[$k] }
|
||||
}
|
||||
}
|
||||
Remove-Nulls $driverConfig
|
||||
|
||||
$json = $driverConfig | ConvertTo-Json -Depth 8
|
||||
|
||||
if ($DryRun) {
|
||||
Write-Host "=== DriverConfig (dry-run, would write to $OutputPath) ==="
|
||||
Write-Host $json
|
||||
return
|
||||
}
|
||||
|
||||
if ($OutputPath) {
|
||||
$dir = Split-Path -Parent $OutputPath
|
||||
if ($dir -and -not (Test-Path $dir)) { New-Item -ItemType Directory -Path $dir | Out-Null }
|
||||
Set-Content -Path $OutputPath -Value $json -Encoding UTF8
|
||||
Write-Host "Wrote DriverConfig to $OutputPath"
|
||||
}
|
||||
else {
|
||||
$json
|
||||
}
|
||||
Reference in New Issue
Block a user