dohertj2/ScadaBridge
1
0
Fork 0
Code Issues 1 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

perf(deployment): staleness/comparison paths no longer Roslyn-compile every script — deploy gate remains the authoritative compile

Browse Source 
Claude-Session: https://claude.ai/code/session_01MtdgwpEeCUn6cUA5f1LMPj
This commit is contained in:
Joseph Doherty
2026-07-09 15:48:45 -04:00
parent 730bf19162
commit 854a6a8c0b
9 changed files with 226 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/ZB.MOM.WW.ScadaBridge.DeploymentManager.Tests/DeploymentComparisonTests.cs
+93
View File
@@ -1,7 +1,23 @@
using NSubstitute;
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Instances;
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Sites;
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Templates;
using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories;
using ZB.MOM.WW.ScadaBridge.Commons.Types.Flattening;
using ZB.MOM.WW.ScadaBridge.TemplateEngine.Flattening;
using ZB.MOM.WW.ScadaBridge.TemplateEngine.Validation;
namespace ZB.MOM.WW.ScadaBridge.DeploymentManager.Tests;
/// <summary>
/// WP-8: Tests for deployed vs template-derived state comparison.
///
/// PLAN-05 Task 16: adds behavioral coverage proving the read-only
/// staleness/comparison path can flatten (and thus hash) an instance whose
/// script does NOT compile — because <c>validateScripts: false</c> skips the
/// expensive Roslyn <see cref="ValidationService.ValidateScriptCompilation"/>
/// step while keeping structural/semantic validation. The default (deploy) path
/// still compiles.
/// </summary>
public class DeploymentComparisonTests
{
@@ -34,4 +50,81 @@ public class DeploymentComparisonTests
Assert.Equal(deployedAt, result.DeployedAt);
}
// ── PLAN-05 Task 16: read-only paths skip Roslyn script compilation ──
private const int InstanceId = 1;
private const int TemplateId = 10;
private const int SiteId = 100;
// A deliberately non-compiling script body. The deploy gate
// (validateScripts: true) flags this as a ScriptCompilation error; the
// read-only staleness/comparison path (validateScripts: false) must skip
// the compile entirely and still produce a flattened config + hash.
private const string NonCompilingScript = "int x = ;";
private static FlatteningPipeline BuildPipeline(
ITemplateEngineRepository templateRepo,
ISiteRepository siteRepo,
ISharedSchemaRepository sharedSchemaRepo)
{
sharedSchemaRepo.ListAsync(Arg.Any<CancellationToken>()).Returns([]);
return new FlatteningPipeline(
templateRepo,
siteRepo,
new FlatteningService(),
new ValidationService(),
new RevisionHashService(),
sharedSchemaRepo);
}
private static (ITemplateEngineRepository, ISiteRepository, ISharedSchemaRepository) ArrangeNonCompilingScript()
{
var templateRepo = Substitute.For<ITemplateEngineRepository>();
var siteRepo = Substitute.For<ISiteRepository>();
var sharedSchemaRepo = Substitute.For<ISharedSchemaRepository>();
var template = new Template("Tank") { Id = TemplateId };
template.Scripts.Add(new TemplateScript("BadScript", NonCompilingScript));
var instance = new Instance("Tank-01") { Id = InstanceId, TemplateId = TemplateId, SiteId = SiteId };
templateRepo.GetInstanceByIdAsync(InstanceId, Arg.Any<CancellationToken>()).Returns(instance);
templateRepo.GetTemplateWithChildrenAsync(TemplateId, Arg.Any<CancellationToken>()).Returns(template);
templateRepo.GetCompositionsByTemplateIdAsync(TemplateId, Arg.Any<CancellationToken>()).Returns([]);
templateRepo.GetAllSharedScriptsAsync(Arg.Any<CancellationToken>()).Returns([]);
siteRepo.GetDataConnectionsBySiteIdAsync(SiteId, Arg.Any<CancellationToken>()).Returns([]);
return (templateRepo, siteRepo, sharedSchemaRepo);
}
[Fact]
public async Task FlattenAndValidate_ValidateScriptsFalse_NonCompilingScript_SucceedsWithHashAndNoCompilationError()
{
var (templateRepo, siteRepo, sharedSchemaRepo) = ArrangeNonCompilingScript();
var sut = BuildPipeline(templateRepo, siteRepo, sharedSchemaRepo);
var result = await sut.FlattenAndValidateAsync(InstanceId, validateScripts: false);
Assert.True(result.IsSuccess);
Assert.False(string.IsNullOrEmpty(result.Value.RevisionHash));
// The Roslyn compile step was skipped, so no ScriptCompilation error is raised
// even though the script body does not compile.
Assert.DoesNotContain(result.Value.Validation.Errors,
e => e.Category == ValidationCategory.ScriptCompilation);
}
[Fact]
public async Task FlattenAndValidate_DefaultValidateScripts_NonCompilingScript_ReportsCompilationError()
{
var (templateRepo, siteRepo, sharedSchemaRepo) = ArrangeNonCompilingScript();
var sut = BuildPipeline(templateRepo, siteRepo, sharedSchemaRepo);
// Default (deploy) path — compilation is the authoritative gate.
var result = await sut.FlattenAndValidateAsync(InstanceId);
Assert.True(result.IsSuccess);
Assert.Contains(result.Value.Validation.Errors,
e => e.Category == ValidationCategory.ScriptCompilation);
}
}
tests/ZB.MOM.WW.ScadaBridge.DeploymentManager.Tests/DeploymentServiceTests.cs
+71 -5
View File
@@ -520,7 +520,7 @@ public class DeploymentServiceTests : TestKit
_repo.GetDeployedSnapshotByInstanceIdAsync(1).Returns(snapshot);
var currentConfig = deployedConfig with { };
_pipeline.FlattenAndValidateAsync(1, Arg.Any<CancellationToken>())
_pipeline.FlattenAndValidateAsync(1, Arg.Any<CancellationToken>(), Arg.Any<bool>())
.Returns(Result<FlatteningPipelineResult>.Success(
new FlatteningPipelineResult(currentConfig, sameHash, ValidationResult.Success())));
@@ -557,7 +557,7 @@ public class DeploymentServiceTests : TestKit
Attributes = [new ResolvedAttribute { CanonicalName = "Setpoint", Value = "9", DataType = "Int32" }]
};
var currentHash = new RevisionHashService().ComputeHash(currentConfig);
_pipeline.FlattenAndValidateAsync(1, Arg.Any<CancellationToken>())
_pipeline.FlattenAndValidateAsync(1, Arg.Any<CancellationToken>(), Arg.Any<bool>())
.Returns(Result<FlatteningPipelineResult>.Success(
new FlatteningPipelineResult(currentConfig, currentHash, ValidationResult.Success())));
@@ -567,6 +567,72 @@ public class DeploymentServiceTests : TestKit
Assert.True(result.Value.IsStale);
}
// ── PLAN-05 Task 16: read-only paths skip Roslyn script compilation ──
[Fact]
public async Task GetDeploymentComparisonAsync_RequestsValidateScriptsFalse()
{
// The comparison page only needs the revision hash for staleness — the
// expensive Roslyn compile must be skipped (validateScripts: false).
var deployedConfig = new FlattenedConfiguration
{
InstanceUniqueName = "TestInst",
Attributes = [new ResolvedAttribute { CanonicalName = "Setpoint", Value = "5", DataType = "Int32" }]
};
var hash = new RevisionHashService().ComputeHash(deployedConfig);
var snapshot = new DeployedConfigSnapshot(
"dep1", hash, System.Text.Json.JsonSerializer.Serialize(deployedConfig))
{
InstanceId = 1,
DeployedAt = DateTimeOffset.UtcNow
};
_repo.GetDeployedSnapshotByInstanceIdAsync(1).Returns(snapshot);
_pipeline.FlattenAndValidateAsync(1, Arg.Any<CancellationToken>(), Arg.Any<bool>())
.Returns(Result<FlatteningPipelineResult>.Success(
new FlatteningPipelineResult(deployedConfig with { }, hash, ValidationResult.Success())));
var result = await _service.GetDeploymentComparisonAsync(1);
Assert.True(result.IsSuccess);
await _pipeline.Received(1).FlattenAndValidateAsync(1, Arg.Any<CancellationToken>(), false);
await _pipeline.DidNotReceive().FlattenAndValidateAsync(1, Arg.Any<CancellationToken>(), true);
}
[Fact]
public async Task DeployInstanceAsync_RequestsValidateScriptsTrue()
{
// The deploy gate stays the authoritative compile — validateScripts defaults to true.
var instance = new Instance("TestInst") { Id = 1, SiteId = 1, State = InstanceState.NotDeployed };
_repo.GetInstanceByIdAsync(1).Returns(instance);
var validationResult = new ValidationResult
{
Errors = [ValidationEntry.Error(ValidationCategory.ScriptCompilation, "Compile error")]
};
_pipeline.FlattenAndValidateAsync(1, Arg.Any<CancellationToken>(), Arg.Any<bool>())
.Returns(Result<FlatteningPipelineResult>.Success(
new FlatteningPipelineResult(new FlattenedConfiguration(), "hash1", validationResult)));
await _service.DeployInstanceAsync(1, "admin");
await _pipeline.Received().FlattenAndValidateAsync(1, Arg.Any<CancellationToken>(), true);
}
[Fact]
public async Task StaleInstanceProbe_RequestsValidateScriptsFalse()
{
// The Transport stale-instance probe also only needs the hash — same skip.
_pipeline.FlattenAndValidateAsync(5, Arg.Any<CancellationToken>(), Arg.Any<bool>())
.Returns(Result<FlatteningPipelineResult>.Success(
new FlatteningPipelineResult(new FlattenedConfiguration(), "sha256:probe", ValidationResult.Success())));
var probe = new StaleInstanceProbe(_pipeline);
var hash = await probe.GetCurrentRevisionHashAsync(5);
Assert.Equal("sha256:probe", hash);
await _pipeline.Received(1).FlattenAndValidateAsync(5, Arg.Any<CancellationToken>(), false);
}
// ── DeploymentManager-007: comparison must produce a structured diff ──
[Fact]
@@ -594,7 +660,7 @@ public class DeploymentServiceTests : TestKit
InstanceUniqueName = "DiffInst",
Attributes = [new ResolvedAttribute { CanonicalName = "NewAttr", DataType = "Int" }]
};
_pipeline.FlattenAndValidateAsync(40, Arg.Any<CancellationToken>())
_pipeline.FlattenAndValidateAsync(40, Arg.Any<CancellationToken>(), Arg.Any<bool>())
.Returns(Result<FlatteningPipelineResult>.Success(
new FlatteningPipelineResult(currentConfig, "sha256:new", ValidationResult.Success())));
@@ -668,7 +734,7 @@ public class DeploymentServiceTests : TestKit
]
};
var nativeHash = hasher.ComputeHash(nativeConfig);
_pipeline.FlattenAndValidateAsync(50, Arg.Any<CancellationToken>())
_pipeline.FlattenAndValidateAsync(50, Arg.Any<CancellationToken>(), Arg.Any<bool>())
.Returns(Result<FlatteningPipelineResult>.Success(
new FlatteningPipelineResult(nativeConfig, nativeHash, ValidationResult.Success())));
@@ -736,7 +802,7 @@ public class DeploymentServiceTests : TestKit
]
};
var currentHash = hasher.ComputeHash(currentConfig);
_pipeline.FlattenAndValidateAsync(51, Arg.Any<CancellationToken>())
_pipeline.FlattenAndValidateAsync(51, Arg.Any<CancellationToken>(), Arg.Any<bool>())
.Returns(Result<FlatteningPipelineResult>.Success(
new FlatteningPipelineResult(currentConfig, currentHash, ValidationResult.Success())));