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>
124 lines
4.3 KiB
PowerShell
124 lines
4.3 KiB
PowerShell
#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
|