FOCAS — retire Tier-C split, inline managed wire client, make read-only
Migration closes the FOCAS Tier-C architecture. OtOpcUa previously had
`Driver.FOCAS.Host` (NSSM-wrapped Windows service loading Fwlib64.dll via
P/Invoke) + `Driver.FOCAS.Shared` (MessagePack IPC contracts) + a C shim
DLL stand-in for unit tests. All of it is deleted; the driver is now a
single in-process managed assembly talking the FOCAS/2 Ethernet binary
protocol directly on TCP:8193.
Architecture
- Pure-managed `FocasWireClient` inlined at `src/.../Driver.FOCAS/Wire/`
(owner-imported — see Wire/FocasWireClient.cs for the full surface).
Opens two TCP sockets, runs the initiate handshake, serialises requests
on socket 2 through a semaphore, closes cleanly with PDU + socket
teardown. Both sync `IDisposable` and async `IAsyncDisposable`.
- `WireFocasClient` (same folder) adapts the wire client to OtOpcUa's
`IFocasClient` surface — fixed-tree reads, PARAM/MACRO/PMC addresses,
alarms. Writes return `BadNotWritable` by design — OtOpcUa is read-only
against FOCAS.
- `FocasDriverFactoryExtensions` now accepts `"Backend": "wire"` (default)
and `"Backend": "unimplemented"`. Legacy `ipc` and `fwlib` backends are
rejected at startup with a diagnostic pointing at the migration doc.
Deletions
- `src/ZB.MOM.WW.OtOpcUa.Driver.FOCAS.Host/` — whole project + Ipc/,
Backend/, Stability/, Program.cs.
- `src/ZB.MOM.WW.OtOpcUa.Driver.FOCAS.Shared/` — Contracts/, FrameReader,
FrameWriter, whole project.
- `tests/...Driver.FOCAS.Host.Tests/` + `.Shared.Tests/` — whole projects.
- `src/.../Driver.FOCAS/FwlibNative.cs` + `FwlibFocasClient.cs` — 21
P/Invokes + 7 `Pack=1` marshalling structs + the Fwlib-backed
`IFocasClient` implementation.
- `src/.../Driver.FOCAS/Ipc/` + `Supervisor/` — IPC client wrapper +
Host-process supervisor (backoff, circuit breaker, heartbeat, post-
mortem reader, process launcher).
- `scripts/install/Install-FocasHost.ps1` — NSSM service installer.
- `tests/.../Driver.FOCAS.Tests/{IpcFocasClientTests, IpcLoopback,
FwlibNativeHelperTests, PostMortemReaderCompatibilityTests,
SupervisorTests, FocasDriverFactoryExtensionsTests}.cs` — tests that
exercised the retired surfaces.
- `tests/.../Driver.FOCAS.IntegrationTests/Shim/` — the zig-built C shim
DLL that masqueraded as Fwlib64.dll.
Solution changes
- `ZB.MOM.WW.OtOpcUa.slnx` drops the 4 retired project refs.
- `src/.../Driver.FOCAS.csproj` drops the Shared ProjectReference, adds
`Microsoft.Extensions.Logging.Abstractions` for the optional `ILogger`
hook in `FocasWireClient`.
- `src/.../Driver.FOCAS.Cli.csproj` drops the six `<Content Include>`
entries that copied `vendor/fanuc/*.dll` into the CLI bin. CLI now uses
`WireFocasClient` directly.
- `FocasDriver` default factory flips to `Wire.WireFocasClientFactory`.
Integration tests
- New `tests/.../Driver.FOCAS.IntegrationTests/` project covering fixed-
tree reads (identity, axes, dynamic, program, operation mode, timers,
spindle load + max RPM, servo meters), user-authored PARAM / MACRO /
PMC reads, `DiscoverAsync` emission, `SubscribeAsync` + `OnDataChange`,
`IAlarmSource` raise/clear transitions, and `ProbeAsync` /
`OnHostStatusChanged`. 9 e2e tests against the focas-mock fixture
(Docker container with the vendored Python mock's native FOCAS/2
Ethernet responder).
- `scripts/integration/run-focas.ps1` orchestrates compose up → tests →
compose down. Dropped the shim-build stage + DLL-copy step + the split
testhost workaround (the latter only existed because of native-DLL
lifecycle bugs the shim tripped).
- Docker compose collapses from 11 per-series services to one `focas-sim`
service. Tests seed per-series state via `mock_load_profile` at test
start.
- Vendored focas-mock snapshot refreshed to pick up upstream's native
FOCAS/2 Ethernet responder (was 660 lines, now 1018) — the
pre-refresh snapshot only spoke the JSON admin protocol.
Tests
- 145/145 unit tests in `Driver.FOCAS.Tests` pass (was 208 pre-deletion;
63 removed tests exercised the retired IPC/shim/supervisor/Fwlib
surfaces).
- 9/9 integration tests pass against the refreshed mock.
- `FocasScaffoldingTests.Unimplemented_factory_throws_on_Create…` updated
to assert the new diagnostic message pointing at
`docs/drivers/FOCAS.md` rather than the now-gone `Fwlib64.dll`.
Docs
- `docs/drivers/FOCAS.md` rewritten for the managed wire topology —
deployment collapses to one `"Backend": "wire"` config block, no
separate service, no DLL deployment, no pipe ACL.
- `docs/drivers/FOCAS-Test-Fixture.md` updated — single TCP probe skip
gate instead of TCP + shim probe; fewer moving parts.
- `docs/drivers/README.md` row for FOCAS reflects the Tier-A managed
topology (previously listed Tier-C + `Fwlib64.dll` P/Invoke).
- `docs/Driver.FOCAS.Cli.md` drops the Tier-C architecture-note section.
- `docs/v2/implementation/focas-isolation-plan.md` marked historical —
the plan it documents was executed then superseded by the wire client.
- `docs/v2/v2-release-readiness.md` re-audited 2026-04-24. Phase 5
driver complement closed. FOCAS change-log entry added.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Joseph Doherty
@@ -34,7 +34,7 @@
|
||||
},
|
||||
|
||||
"focas": {
|
||||
"$comment": "Gated behind FOCAS_TRUST_WIRE=1 — no public simulator. Point at a real CNC + ensure Fwlib32.dll is on PATH.",
|
||||
"$comment": "Gated behind FOCAS_TRUST_WIRE=1 for real-CNC runs, or pass -ProfileName to run against the focas-mock Docker fixture. Managed wire client — no native dependencies.",
|
||||
"host": "192.168.1.20",
|
||||
"port": 8193,
|
||||
"address": "R100",
|
||||
@@ -60,6 +60,21 @@
|
||||
"historyLookbackSec": 3600
|
||||
},
|
||||
|
||||
"opcuaclient": {
|
||||
"$comment": "OPC UA Client (gateway) driver. Default opc-plc Docker fixture exposes ns=3;s=FastUInt1 as a ticker. The `bridgeNodeId` is the local mirror of remoteNodeId after the OpcUaClient driver's DiscoverAsync runs — dev-specific. Stages 5/7/8 are opt-in: supply writable* NodeIds to enable reverse-bridge, alarmNodeId to enable alarm, historyNodeId to enable history (opc-plc does not historize by default — a Prosys / UA Expert sample server is needed for stage 8).",
|
||||
"remoteUrl": "opc.tcp://localhost:50000",
|
||||
"remoteNodeId": "ns=3;s=FastUInt1",
|
||||
"bridgeNodeId": "ns=2;s=OpcUaClient/FastUInt1",
|
||||
"bridgeRootNodeId": "ns=2;s=OpcUaClient",
|
||||
"browseDepth": 3,
|
||||
"browseMinNodes": 5,
|
||||
"changeWaitSec": 8,
|
||||
"writableRemoteNodeId": "",
|
||||
"writableBridgeNodeId": "",
|
||||
"alarmNodeId": "",
|
||||
"historyNodeId": ""
|
||||
},
|
||||
|
||||
"phase7": {
|
||||
"$comment": "Virtual tags + scripted alarms. The VirtualNodeId must resolve to a server-side virtual tag whose script reads the modbus InputNodeId and writes VT = input * 2. The AlarmNodeId is the ConditionId of a scripted alarm that fires when VT > 100.",
|
||||
"modbusEndpoint": "127.0.0.1:5502",
|
||||
|
||||
@@ -1,16 +1,35 @@
|
||||
#Requires -Version 7.0
|
||||
#Requires -Version 7.0
|
||||
<#
|
||||
.SYNOPSIS
|
||||
End-to-end CLI test for the FOCAS (Fanuc CNC) driver.
|
||||
|
||||
.DESCRIPTION
|
||||
**Hardware-gated.** There is no public FOCAS simulator; the driver's
|
||||
FwlibFocasClient P/Invokes Fanuc's licensed Fwlib32.dll. Against a dev
|
||||
box without the DLL on PATH the test will skip with a clear message.
|
||||
Against a real CNC with the DLL present it runs probe / driver-loopback /
|
||||
server-bridge the same way the other scripts do.
|
||||
Runs the CLI against either the managed wire client (default — Driver.FOCAS.Cli
|
||||
dials the CNC on TCP:8193 directly, no native dependencies) or the focas-mock
|
||||
Docker fixture. Hardware-gated by default because the default CncHost is
|
||||
127.0.0.1; set FOCAS_TRUST_WIRE=1 once -CncHost points at a real CNC, or pass
|
||||
-ProfileName to run against the Docker sim.
|
||||
|
||||
Set FOCAS_TRUST_WIRE=1 when -CncHost points at a real CNC to un-gate.
|
||||
The script also supports three nice-to-have modes shipped 2026-04-24:
|
||||
|
||||
-Series — per-series matrix mode. Accepts a comma-separated list; the
|
||||
core stages are run once per series, swapping the -Address to
|
||||
the supplied per-series probe. Fails fast if any series's
|
||||
configured address is outside the documented range (the driver
|
||||
itself enforces that at InitializeAsync).
|
||||
|
||||
-ProfileName — for use with the Python Docker simulator (see
|
||||
docs/v2/implementation/focas-simulator-plan.md). Selects a
|
||||
docker-compose profile + matching -Series. When set, the
|
||||
FOCAS_TRUST_WIRE gate is considered satisfied because the sim
|
||||
is a legitimate non-hardware target.
|
||||
|
||||
-HandleLeakCycles <int> — stress stage that opens + closes <N> sessions
|
||||
via the CLI's `probe` command with a short sleep between
|
||||
cycles. Exercises the Tier-C supervisor's handle-recycle path
|
||||
without touching user data. Typical values: 100–1000. A CNC's
|
||||
FWLIB handle pool is finite (~5–10), so this shakes out
|
||||
handle-leak bugs if either side forgets to free.
|
||||
|
||||
.PARAMETER CncHost
|
||||
IP or hostname of the CNC. Default 127.0.0.1 — override for real runs.
|
||||
@@ -19,7 +38,22 @@
|
||||
FOCAS TCP port. Default 8193.
|
||||
|
||||
.PARAMETER Address
|
||||
FOCAS address to exercise. Default R100 (PMC R-file register).
|
||||
FOCAS address to exercise. Default R100 (PMC R-file register). Ignored
|
||||
when -Series is set and the series profile supplies its own probe.
|
||||
|
||||
.PARAMETER Series
|
||||
Comma-separated list of CNC series to run the matrix against. Known:
|
||||
ZeroI_D, ZeroI_F, ZeroI_MF, ZeroI_TF, Sixteen_i, Thirty_i, ThirtyOne_i,
|
||||
ThirtyTwo_i, PowerMotion_i. When empty the script runs a single pass
|
||||
without a series constraint.
|
||||
|
||||
.PARAMETER ProfileName
|
||||
docker-compose profile name from tests/.../Docker/profiles/. When set,
|
||||
the script assumes the Python simulator is the target + un-gates
|
||||
FOCAS_TRUST_WIRE.
|
||||
|
||||
.PARAMETER HandleLeakCycles
|
||||
Run a handle-leak stress stage with <N> open/close cycles. 0 = skip.
|
||||
|
||||
.PARAMETER OpcUaUrl
|
||||
OtOpcUa server endpoint.
|
||||
@@ -32,6 +66,9 @@ param(
|
||||
[string]$CncHost = "127.0.0.1",
|
||||
[int]$CncPort = 8193,
|
||||
[string]$Address = "R100",
|
||||
[string]$Series = "",
|
||||
[string]$ProfileName = "",
|
||||
[int]$HandleLeakCycles = 0,
|
||||
[string]$OpcUaUrl = "opc.tcp://localhost:4840",
|
||||
[Parameter(Mandatory)] [string]$BridgeNodeId
|
||||
)
|
||||
@@ -39,11 +76,41 @@ param(
|
||||
$ErrorActionPreference = "Stop"
|
||||
. "$PSScriptRoot/_common.ps1"
|
||||
|
||||
if (-not ($env:FOCAS_TRUST_WIRE -eq "1" -or $env:FOCAS_TRUST_WIRE -eq "true")) {
|
||||
Write-Skip "FOCAS_TRUST_WIRE not set — no public simulator exists (task #222 tracks the lab rig). Set =1 when -CncHost points at a real CNC with Fwlib32.dll on PATH."
|
||||
$simGated = -not [string]::IsNullOrWhiteSpace($ProfileName)
|
||||
if (-not $simGated -and -not ($env:FOCAS_TRUST_WIRE -eq "1" -or $env:FOCAS_TRUST_WIRE -eq "true")) {
|
||||
Write-Skip "FOCAS_TRUST_WIRE not set. Pass -ProfileName <profile> to run against the Docker mock in tests/.../Driver.FOCAS.IntegrationTests/Docker/, or set FOCAS_TRUST_WIRE=1 when -CncHost points at a real CNC."
|
||||
exit 0
|
||||
}
|
||||
|
||||
if ($simGated) {
|
||||
Write-Info "Sim mode — profile '$ProfileName'. FOCAS_TRUST_WIRE gate bypassed."
|
||||
}
|
||||
|
||||
# Per-series probe addresses — each one is inside the authoritative range for
|
||||
# that series (docs/v2/focas-version-matrix.md). Picking one representative per
|
||||
# kind (PMC / parameter / macro) is enough to exercise the driver's validator.
|
||||
$seriesProbes = @{
|
||||
"ZeroI_D" = "R100"
|
||||
"ZeroI_F" = "R100"
|
||||
"ZeroI_MF" = "R100"
|
||||
"ZeroI_TF" = "R100"
|
||||
"Sixteen_i" = "R100"
|
||||
"Thirty_i" = "R100"
|
||||
"ThirtyOne_i" = "R100"
|
||||
"ThirtyTwo_i" = "R100"
|
||||
"PowerMotion_i"= "R100"
|
||||
}
|
||||
|
||||
$seriesList = @()
|
||||
if (-not [string]::IsNullOrWhiteSpace($Series)) {
|
||||
$seriesList = @($Series.Split(',') | ForEach-Object { $_.Trim() } | Where-Object { $_ })
|
||||
$unknown = @($seriesList | Where-Object { -not $seriesProbes.ContainsKey($_) })
|
||||
if ($unknown.Count -gt 0) {
|
||||
Write-Fail "Unknown -Series entries: $($unknown -join ', '). Known: $($seriesProbes.Keys -join ', ')."
|
||||
exit 2
|
||||
}
|
||||
}
|
||||
|
||||
$focasCli = Get-CliInvocation `
|
||||
-ProjectFolder "src/ZB.MOM.WW.OtOpcUa.Driver.FOCAS.Cli" `
|
||||
-ExeName "otopcua-focas-cli"
|
||||
@@ -51,46 +118,103 @@ $opcUaCli = Get-CliInvocation `
|
||||
-ProjectFolder "src/ZB.MOM.WW.OtOpcUa.Client.CLI" `
|
||||
-ExeName "otopcua-cli"
|
||||
|
||||
$commonFocas = @("-h", $CncHost, "-p", $CncPort)
|
||||
$results = @()
|
||||
$allResults = @()
|
||||
|
||||
$results += Test-Probe `
|
||||
-Cli $focasCli `
|
||||
-ProbeArgs (@("probe") + $commonFocas + @("-a", $Address, "--type", "Int16"))
|
||||
function Invoke-FocasCore {
|
||||
param(
|
||||
[string]$Label,
|
||||
[string]$ProbeAddress
|
||||
)
|
||||
|
||||
$writeValue = Get-Random -Minimum 1 -Maximum 9999
|
||||
$results += Test-DriverLoopback `
|
||||
-Cli $focasCli `
|
||||
-WriteArgs (@("write") + $commonFocas + @("-a", $Address, "-t", "Int16", "-v", $writeValue)) `
|
||||
-ReadArgs (@("read") + $commonFocas + @("-a", $Address, "-t", "Int16")) `
|
||||
-ExpectedValue "$writeValue"
|
||||
Write-Header "FOCAS stages — $Label"
|
||||
$commonFocas = @("-h", $CncHost, "-p", $CncPort)
|
||||
$results = @()
|
||||
|
||||
$bridgeValue = Get-Random -Minimum 10000 -Maximum 19999
|
||||
$results += Test-ServerBridge `
|
||||
-DriverCli $focasCli `
|
||||
-DriverWriteArgs (@("write") + $commonFocas + @("-a", $Address, "-t", "Int16", "-v", $bridgeValue)) `
|
||||
-OpcUaCli $opcUaCli `
|
||||
-OpcUaUrl $OpcUaUrl `
|
||||
-OpcUaNodeId $BridgeNodeId `
|
||||
-ExpectedValue "$bridgeValue"
|
||||
$results += Test-Probe `
|
||||
-Cli $focasCli `
|
||||
-ProbeArgs (@("probe") + $commonFocas + @("-a", $ProbeAddress, "--type", "Int16"))
|
||||
|
||||
$reverseValue = Get-Random -Minimum 20000 -Maximum 29999
|
||||
$results += Test-OpcUaWriteBridge `
|
||||
-OpcUaCli $opcUaCli `
|
||||
-OpcUaUrl $OpcUaUrl `
|
||||
-OpcUaNodeId $BridgeNodeId `
|
||||
-DriverCli $focasCli `
|
||||
-DriverReadArgs (@("read") + $commonFocas + @("-a", $Address, "-t", "Int16")) `
|
||||
-ExpectedValue "$reverseValue"
|
||||
$writeValue = Get-Random -Minimum 1 -Maximum 9999
|
||||
$results += Test-DriverLoopback `
|
||||
-Cli $focasCli `
|
||||
-WriteArgs (@("write") + $commonFocas + @("-a", $ProbeAddress, "-t", "Int16", "-v", $writeValue)) `
|
||||
-ReadArgs (@("read") + $commonFocas + @("-a", $ProbeAddress, "-t", "Int16")) `
|
||||
-ExpectedValue "$writeValue"
|
||||
|
||||
$subValue = Get-Random -Minimum 30000 -Maximum 32766
|
||||
$results += Test-SubscribeSeesChange `
|
||||
-OpcUaCli $opcUaCli `
|
||||
-OpcUaUrl $OpcUaUrl `
|
||||
-OpcUaNodeId $BridgeNodeId `
|
||||
-DriverCli $focasCli `
|
||||
-DriverWriteArgs (@("write") + $commonFocas + @("-a", $Address, "-t", "Int16", "-v", $subValue)) `
|
||||
-ExpectedValue "$subValue"
|
||||
$bridgeValue = Get-Random -Minimum 10000 -Maximum 19999
|
||||
$results += Test-ServerBridge `
|
||||
-DriverCli $focasCli `
|
||||
-DriverWriteArgs (@("write") + $commonFocas + @("-a", $ProbeAddress, "-t", "Int16", "-v", $bridgeValue)) `
|
||||
-OpcUaCli $opcUaCli `
|
||||
-OpcUaUrl $OpcUaUrl `
|
||||
-OpcUaNodeId $BridgeNodeId `
|
||||
-ExpectedValue "$bridgeValue"
|
||||
|
||||
Write-Summary -Title "FOCAS e2e" -Results $results
|
||||
if ($results | Where-Object { -not $_.Passed }) { exit 1 }
|
||||
$reverseValue = Get-Random -Minimum 20000 -Maximum 29999
|
||||
$results += Test-OpcUaWriteBridge `
|
||||
-OpcUaCli $opcUaCli `
|
||||
-OpcUaUrl $OpcUaUrl `
|
||||
-OpcUaNodeId $BridgeNodeId `
|
||||
-DriverCli $focasCli `
|
||||
-DriverReadArgs (@("read") + $commonFocas + @("-a", $ProbeAddress, "-t", "Int16")) `
|
||||
-ExpectedValue "$reverseValue"
|
||||
|
||||
$subValue = Get-Random -Minimum 30000 -Maximum 32766
|
||||
$results += Test-SubscribeSeesChange `
|
||||
-OpcUaCli $opcUaCli `
|
||||
-OpcUaUrl $OpcUaUrl `
|
||||
-OpcUaNodeId $BridgeNodeId `
|
||||
-DriverCli $focasCli `
|
||||
-DriverWriteArgs (@("write") + $commonFocas + @("-a", $ProbeAddress, "-t", "Int16", "-v", $subValue)) `
|
||||
-ExpectedValue "$subValue"
|
||||
|
||||
return $results
|
||||
}
|
||||
|
||||
function Invoke-HandleLeakStage {
|
||||
param([int]$Cycles)
|
||||
|
||||
Write-Header "FOCAS handle-leak stress — $Cycles cycles"
|
||||
$commonFocas = @("-h", $CncHost, "-p", $CncPort)
|
||||
$failed = 0
|
||||
for ($i = 1; $i -le $Cycles; $i++) {
|
||||
$probe = Test-Probe `
|
||||
-Cli $focasCli `
|
||||
-ProbeArgs (@("probe") + $commonFocas + @("-a", $Address, "--type", "Int16"))
|
||||
if (-not $probe.Passed) {
|
||||
$failed++
|
||||
# First 3 failures are informative; the rest just tally.
|
||||
if ($failed -le 3) {
|
||||
Write-Fail "cycle $i failed: $($probe.Reason)"
|
||||
}
|
||||
}
|
||||
# Tiny delay so a broken loop can't DDoS the CNC; FWLIB handles take a
|
||||
# few tens of ms to recycle in practice.
|
||||
Start-Sleep -Milliseconds 50
|
||||
}
|
||||
$passed = $Cycles - $failed
|
||||
if ($failed -eq 0) {
|
||||
Write-Pass "handle-leak stress: $passed/$Cycles cycles succeeded"
|
||||
return @{ Passed = $true; Reason = "$passed/$Cycles" }
|
||||
} else {
|
||||
Write-Fail "handle-leak stress: $failed/$Cycles cycles failed"
|
||||
return @{ Passed = $false; Reason = "$failed/$Cycles failed" }
|
||||
}
|
||||
}
|
||||
|
||||
if ($seriesList.Count -eq 0) {
|
||||
$allResults += Invoke-FocasCore -Label "single" -ProbeAddress $Address
|
||||
} else {
|
||||
foreach ($series in $seriesList) {
|
||||
$probeAddr = $seriesProbes[$series]
|
||||
Write-Info "Running matrix pass for series '$series' with address $probeAddr"
|
||||
$allResults += Invoke-FocasCore -Label $series -ProbeAddress $probeAddr
|
||||
}
|
||||
}
|
||||
|
||||
if ($HandleLeakCycles -gt 0) {
|
||||
$allResults += Invoke-HandleLeakStage -Cycles $HandleLeakCycles
|
||||
}
|
||||
|
||||
Write-Summary -Title "FOCAS e2e" -Results $allResults
|
||||
if ($allResults | Where-Object { -not $_.Passed }) { exit 1 }
|
||||
|
||||
@@ -1,108 +0,0 @@
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Registers the OtOpcUaFocasHost Windows service. Optional companion to
|
||||
Install-Services.ps1 — only run this on nodes where FOCAS driver instances will run
|
||||
with Tier-C process isolation enabled.
|
||||
|
||||
.DESCRIPTION
|
||||
FOCAS PR #220 / Tier-C isolation plan. Wraps OtOpcUa.Driver.FOCAS.Host.exe (net48 x86)
|
||||
as a Windows service using NSSM, running under the same service account as the main
|
||||
OtOpcUa service so the named-pipe ACL works. Passes the per-process shared secret via
|
||||
environment variable at service-start time so it never hits disk.
|
||||
|
||||
.PARAMETER InstallRoot
|
||||
Where the FOCAS Host binaries live (typically
|
||||
C:\Program Files\OtOpcUa\Driver.FOCAS.Host).
|
||||
|
||||
.PARAMETER ServiceAccount
|
||||
Service account SID or DOMAIN\name. Must match the main OtOpcUa server account so the
|
||||
PipeAcl match succeeds.
|
||||
|
||||
.PARAMETER FocasSharedSecret
|
||||
Per-process secret passed via env var. Generated freshly per install if not supplied.
|
||||
|
||||
.PARAMETER FocasBackend
|
||||
Backend selector for the Host process. One of:
|
||||
fwlib32 (default — real Fanuc Fwlib32.dll integration; requires licensed DLL on PATH)
|
||||
fake (in-memory; smoke-test mode)
|
||||
unconfigured (safe default returning structured errors; use until hardware is wired)
|
||||
|
||||
.PARAMETER FocasPipeName
|
||||
Pipe name the Host listens on. Default: OtOpcUaFocas.
|
||||
|
||||
.EXAMPLE
|
||||
.\Install-FocasHost.ps1 -InstallRoot 'C:\Program Files\OtOpcUa\Driver.FOCAS.Host' `
|
||||
-ServiceAccount 'OTOPCUA\svc-otopcua' -FocasBackend fwlib32
|
||||
#>
|
||||
[CmdletBinding()]
|
||||
param(
|
||||
[Parameter(Mandatory)] [string]$InstallRoot,
|
||||
[Parameter(Mandatory)] [string]$ServiceAccount,
|
||||
[string]$FocasSharedSecret,
|
||||
[ValidateSet('fwlib32','fake','unconfigured')] [string]$FocasBackend = 'unconfigured',
|
||||
[string]$FocasPipeName = 'OtOpcUaFocas',
|
||||
[string]$ServiceName = 'OtOpcUaFocasHost',
|
||||
[string]$NssmPath = 'C:\Program Files\nssm\nssm.exe'
|
||||
)
|
||||
|
||||
$ErrorActionPreference = 'Stop'
|
||||
|
||||
function Resolve-Sid {
|
||||
param([string]$Account)
|
||||
if ($Account -match '^S-\d-\d+') { return $Account }
|
||||
try {
|
||||
$nt = New-Object System.Security.Principal.NTAccount($Account)
|
||||
return $nt.Translate([System.Security.Principal.SecurityIdentifier]).Value
|
||||
} catch {
|
||||
throw "Could not resolve '$Account' to a SID. Pass an explicit SID or check the account name."
|
||||
}
|
||||
}
|
||||
|
||||
if (-not (Test-Path $NssmPath)) {
|
||||
throw "nssm.exe not found at '$NssmPath'. Install NSSM or pass -NssmPath."
|
||||
}
|
||||
|
||||
$hostExe = Join-Path $InstallRoot 'OtOpcUa.Driver.FOCAS.Host.exe'
|
||||
if (-not (Test-Path $hostExe)) {
|
||||
throw "FOCAS Host binary not found at '$hostExe'. Publish the Driver.FOCAS.Host project first."
|
||||
}
|
||||
|
||||
if (-not $FocasSharedSecret) {
|
||||
$FocasSharedSecret = [System.Guid]::NewGuid().ToString('N')
|
||||
Write-Host "Generated FocasSharedSecret — store it alongside the OtOpcUa service config."
|
||||
}
|
||||
|
||||
$allowedSid = Resolve-Sid $ServiceAccount
|
||||
|
||||
# Idempotent install — remove + re-create if present.
|
||||
$existing = Get-Service -Name $ServiceName -ErrorAction SilentlyContinue
|
||||
if ($existing) {
|
||||
Write-Host "Removing existing '$ServiceName' service..."
|
||||
& $NssmPath stop $ServiceName confirm | Out-Null
|
||||
& $NssmPath remove $ServiceName confirm | Out-Null
|
||||
}
|
||||
|
||||
& $NssmPath install $ServiceName $hostExe | Out-Null
|
||||
& $NssmPath set $ServiceName DisplayName 'OT-OPC-UA FOCAS Host (Tier-C isolated Fwlib32)' | Out-Null
|
||||
& $NssmPath set $ServiceName Description 'Out-of-process Fwlib32.dll host for OtOpcUa FOCAS driver. Crash-isolated from the main OPC UA server.' | Out-Null
|
||||
& $NssmPath set $ServiceName ObjectName $ServiceAccount | Out-Null
|
||||
& $NssmPath set $ServiceName Start SERVICE_AUTO_START | Out-Null
|
||||
& $NssmPath set $ServiceName AppStdout (Join-Path $env:ProgramData 'OtOpcUa\focas-host-stdout.log') | Out-Null
|
||||
& $NssmPath set $ServiceName AppStderr (Join-Path $env:ProgramData 'OtOpcUa\focas-host-stderr.log') | Out-Null
|
||||
& $NssmPath set $ServiceName AppRotateFiles 1 | Out-Null
|
||||
& $NssmPath set $ServiceName AppRotateBytes 10485760 | Out-Null
|
||||
|
||||
& $NssmPath set $ServiceName AppEnvironmentExtra `
|
||||
"OTOPCUA_FOCAS_PIPE=$FocasPipeName" `
|
||||
"OTOPCUA_ALLOWED_SID=$allowedSid" `
|
||||
"OTOPCUA_FOCAS_SECRET=$FocasSharedSecret" `
|
||||
"OTOPCUA_FOCAS_BACKEND=$FocasBackend" | Out-Null
|
||||
|
||||
& $NssmPath set $ServiceName DependOnService OtOpcUa | Out-Null
|
||||
|
||||
Write-Host "Installed '$ServiceName' under '$ServiceAccount' (SID=$allowedSid)."
|
||||
Write-Host "Pipe: \\.\pipe\$FocasPipeName Backend: $FocasBackend"
|
||||
Write-Host "Start the service with: Start-Service $ServiceName"
|
||||
Write-Host ""
|
||||
Write-Host "NOTE: the Fwlib32 backend requires the licensed Fwlib32.dll on PATH"
|
||||
Write-Host "alongside the Host exe. See docs/v2/focas-deployment.md."
|
||||
87
scripts/integration/README.md
Normal file
87
scripts/integration/README.md
Normal file
@@ -0,0 +1,87 @@
|
||||
# Integration runners
|
||||
|
||||
Scripts that orchestrate multi-component integration-test loops —
|
||||
each one wires up docker fixtures, support binaries, and `dotnet test`
|
||||
in sequence so a developer (or a CI agent) can get from "freshly
|
||||
cloned repo" to "green integration suite" with one command.
|
||||
|
||||
Unlike `scripts/e2e/test-*.ps1` (which drive the built server through
|
||||
the CLI for black-box coverage), scripts in this folder operate
|
||||
**below** the server layer — they bring up the raw fixtures the
|
||||
driver-level `IntegrationTests` projects need.
|
||||
|
||||
## Scripts
|
||||
|
||||
| Script | Purpose |
|
||||
|--------|---------|
|
||||
| [`run-focas.ps1`](run-focas.ps1) | FOCAS driver: builds shim DLLs + starts focas-mock docker + copies shim into test bin + runs `WireCompatGatedTests` + `FocasSimSmokeTests` + tears down docker |
|
||||
|
||||
## run-focas.ps1
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- **Windows + PowerShell 7+**
|
||||
- **.NET 10 SDK** — `dotnet --version` prints 10.x
|
||||
- **Native C compiler** — one of:
|
||||
- Visual Studio Build Tools with the C++ workload (then run from an
|
||||
"x64 Native Tools Command Prompt for VS" shell), or
|
||||
- Zig (`zig.exe` on PATH) as a drop-in alternative
|
||||
- **Docker Desktop** running, OR pass `-SkipDocker` and run the mock
|
||||
externally
|
||||
|
||||
### One-shot run
|
||||
|
||||
```powershell
|
||||
cd C:\Users\dohertj2\Desktop\lmxopcua
|
||||
pwsh .\scripts\integration\run-focas.ps1
|
||||
```
|
||||
|
||||
That's the default invocation: thirtyone profile, debug build,
|
||||
docker cleans up on exit.
|
||||
|
||||
### Development iteration
|
||||
|
||||
Re-run the tests without rebuilding the shim or restarting docker:
|
||||
|
||||
```powershell
|
||||
# First run bootstraps everything + keeps the mock up.
|
||||
pwsh .\scripts\integration\run-focas.ps1 -KeepDocker
|
||||
|
||||
# Iterate on test bodies without re-doing the slow steps.
|
||||
pwsh .\scripts\integration\run-focas.ps1 -SkipShimBuild -SkipDocker
|
||||
```
|
||||
|
||||
### Per-series runs
|
||||
|
||||
```powershell
|
||||
pwsh .\scripts\integration\run-focas.ps1 -Profile thirty # 30i series
|
||||
pwsh .\scripts\integration\run-focas.ps1 -Profile zerod # 0i-D
|
||||
pwsh .\scripts\integration\run-focas.ps1 -Profile powermotion
|
||||
```
|
||||
|
||||
Full profile list is in
|
||||
`tests/ZB.MOM.WW.OtOpcUa.Driver.FOCAS.IntegrationTests/Docker/docker-compose.yml`.
|
||||
|
||||
### Exit codes
|
||||
|
||||
| Code | Meaning |
|
||||
|------|---------|
|
||||
| 0 | All tests passed or cleanly skipped |
|
||||
| 1 | `dotnet test` reported failures |
|
||||
| 2 | The runner itself crashed (missing file, unexpected exception) |
|
||||
| 3 | No C compiler detected for shim build |
|
||||
| 4 | Docker CLI not on PATH |
|
||||
|
||||
### CI integration
|
||||
|
||||
Wire this into the project's CI runner (Gitea Actions, Jenkins,
|
||||
whatever's hosting this repo) by calling:
|
||||
|
||||
```yaml
|
||||
- name: FOCAS integration
|
||||
shell: pwsh
|
||||
run: ./scripts/integration/run-focas.ps1
|
||||
```
|
||||
|
||||
The script is idempotent; a previous run's `docker compose down`
|
||||
failure won't block the next one.
|
||||
123
scripts/integration/run-focas.ps1
Normal file
123
scripts/integration/run-focas.ps1
Normal file
@@ -0,0 +1,123 @@
|
||||
#Requires -Version 7.0
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Orchestrates the FOCAS driver integration-test loop: bring up the
|
||||
focas-mock Docker container, run the managed wire-client integration
|
||||
tests, tear down Docker.
|
||||
|
||||
.DESCRIPTION
|
||||
The FOCAS integration fixture now needs just two things running
|
||||
together:
|
||||
1. A single focas-mock container listening on :8193 (one service,
|
||||
no per-series compose profile ceremony — the mock's native
|
||||
FOCAS Ethernet responder handles every call the managed driver
|
||||
issues).
|
||||
2. The integration-test assembly built. The managed
|
||||
`WireFocasClient` dials the mock directly; there is no shim
|
||||
DLL, no P/Invoke, no test-bin DLL copy step.
|
||||
This script handles both and cleans up on exit.
|
||||
|
||||
Designed to run unattended on a build agent or on a developer box.
|
||||
Exit code matches the test suite (0 = all pass or skip-clean,
|
||||
non-zero when any integration test failed).
|
||||
|
||||
.PARAMETER Profile
|
||||
focas-mock profile name to seed at startup (e.g. `ThirtyOne_i`,
|
||||
`Sixteen_i`, `fwlib30i64`). Defaults to `ThirtyOne_i`. The fixture
|
||||
resolves aliases via `FocasCncSeries`, and tests that need per-series
|
||||
state can call `fixture.LoadProfileAsync` directly at test start to
|
||||
override the default.
|
||||
|
||||
.PARAMETER SkipDocker
|
||||
Skip docker up/down. Use when the mock is already running from
|
||||
another shell.
|
||||
|
||||
.PARAMETER Configuration
|
||||
Build configuration — Debug or Release. Default: Debug.
|
||||
|
||||
.PARAMETER KeepDocker
|
||||
Don't tear down the docker stack on exit. Useful for iterating on
|
||||
tests.
|
||||
#>
|
||||
|
||||
param(
|
||||
[string]$Profile = "ThirtyOne_i",
|
||||
[switch]$SkipDocker,
|
||||
[ValidateSet("Debug", "Release")]
|
||||
[string]$Configuration = "Debug",
|
||||
[switch]$KeepDocker
|
||||
)
|
||||
|
||||
Set-StrictMode -Version 3.0
|
||||
$ErrorActionPreference = "Stop"
|
||||
|
||||
$repoRoot = (Resolve-Path (Join-Path $PSScriptRoot "..\..")).Path
|
||||
$integTests = Join-Path $repoRoot "tests\ZB.MOM.WW.OtOpcUa.Driver.FOCAS.IntegrationTests"
|
||||
$dockerYml = Join-Path $integTests "Docker\docker-compose.yml"
|
||||
|
||||
function Write-Step { param([string]$Msg) Write-Host ""; Write-Host "=== $Msg ===" -ForegroundColor Cyan }
|
||||
function Write-Info { param([string]$Msg) Write-Host "[INFO] $Msg" -ForegroundColor Gray }
|
||||
function Write-Fail { param([string]$Msg) Write-Host "[FAIL] $Msg" -ForegroundColor Red }
|
||||
|
||||
$cleanupScripts = @()
|
||||
trap {
|
||||
Write-Host ""
|
||||
Write-Fail "run-focas.ps1 crashed: $_"
|
||||
foreach ($c in $cleanupScripts) { try { & $c } catch { Write-Host "cleanup failed: $_" -ForegroundColor DarkYellow } }
|
||||
exit 2
|
||||
}
|
||||
|
||||
Write-Step "Build FOCAS IntegrationTests ($Configuration)"
|
||||
dotnet build (Join-Path $integTests "ZB.MOM.WW.OtOpcUa.Driver.FOCAS.IntegrationTests.csproj") `
|
||||
--configuration $Configuration --nologo --verbosity minimal
|
||||
if ($LASTEXITCODE -ne 0) { throw "dotnet build failed (exit $LASTEXITCODE)" }
|
||||
|
||||
if (-not $SkipDocker) {
|
||||
Write-Step "docker compose up"
|
||||
if (-not (Get-Command docker -ErrorAction SilentlyContinue)) {
|
||||
Write-Fail "docker CLI not on PATH. Install Docker Desktop or pass -SkipDocker + run the mock externally."
|
||||
exit 4
|
||||
}
|
||||
|
||||
docker compose -f $dockerYml up -d --build --wait 2>&1 | Write-Host
|
||||
if ($LASTEXITCODE -ne 0) { throw "docker compose up failed (exit $LASTEXITCODE)" }
|
||||
|
||||
if (-not $KeepDocker) {
|
||||
$cleanupScripts += {
|
||||
Write-Step "docker compose down"
|
||||
docker compose -f $dockerYml down --remove-orphans 2>&1 | Write-Host
|
||||
}
|
||||
}
|
||||
|
||||
Write-Info "probing localhost:8193..."
|
||||
$tcp = [System.Net.Sockets.TcpClient]::new()
|
||||
try {
|
||||
$ok = $tcp.ConnectAsync("127.0.0.1", 8193).Wait([TimeSpan]::FromSeconds(5))
|
||||
if (-not $ok -or -not $tcp.Connected) {
|
||||
throw "TCP probe to localhost:8193 failed after docker compose --wait succeeded"
|
||||
}
|
||||
}
|
||||
finally { $tcp.Dispose() }
|
||||
Write-Info "mock is accepting connections"
|
||||
}
|
||||
else {
|
||||
Write-Step "Docker (skipped)"
|
||||
}
|
||||
|
||||
Write-Step "dotnet test (wire-backend integration)"
|
||||
$env:OTOPCUA_FOCAS_SIM_PROFILE = $Profile
|
||||
|
||||
dotnet test (Join-Path $integTests "ZB.MOM.WW.OtOpcUa.Driver.FOCAS.IntegrationTests.csproj") `
|
||||
--configuration $Configuration --no-build --nologo --verbosity minimal
|
||||
$testExit = $LASTEXITCODE
|
||||
|
||||
foreach ($c in $cleanupScripts) { & $c }
|
||||
|
||||
if ($testExit -ne 0) {
|
||||
Write-Fail "integration tests failed with exit $testExit"
|
||||
exit $testExit
|
||||
}
|
||||
|
||||
Write-Host ""
|
||||
Write-Host "run-focas.ps1 completed successfully." -ForegroundColor Green
|
||||
exit 0
|
||||
Reference in New Issue
Block a user