using Microsoft.Extensions.Logging; using Shouldly; using Xunit; namespace ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Tests; /// /// Follow-up #2 — pins the three resolution forms supported by /// : env:NAME, file:PATH, /// and the literal-string fallback. A future DPAPI arm slots in here without /// touching the call site. /// public sealed class GalaxyDriverApiKeyResolverTests { [Fact] public void Literal_string_is_returned_unchanged() { GalaxyDriver.ResolveApiKey("plain-text-key").ShouldBe("plain-text-key"); } [Fact] public void Env_prefix_resolves_to_environment_variable() { const string name = "OTOPCUA_TEST_GALAXY_API_KEY"; Environment.SetEnvironmentVariable(name, "key-from-env"); try { GalaxyDriver.ResolveApiKey($"env:{name}").ShouldBe("key-from-env"); } finally { Environment.SetEnvironmentVariable(name, null); } } [Fact] public void Env_prefix_unset_variable_throws_with_descriptive_message() { const string name = "OTOPCUA_TEST_GALAXY_API_KEY_UNSET"; Environment.SetEnvironmentVariable(name, null); var ex = Should.Throw(() => GalaxyDriver.ResolveApiKey($"env:{name}")); ex.Message.ShouldContain(name); ex.Message.ShouldContain("unset"); } [Fact] public void File_prefix_resolves_to_trimmed_file_contents() { var path = Path.Combine(Path.GetTempPath(), $"galaxy-key-{Guid.NewGuid():N}.txt"); File.WriteAllText(path, " key-from-file \n"); try { GalaxyDriver.ResolveApiKey($"file:{path}").ShouldBe("key-from-file"); } finally { File.Delete(path); } } [Fact] public void File_prefix_missing_path_throws() { var path = Path.Combine(Path.GetTempPath(), $"does-not-exist-{Guid.NewGuid():N}.txt"); var ex = Should.Throw(() => GalaxyDriver.ResolveApiKey($"file:{path}")); ex.Message.ShouldContain(path); ex.Message.ShouldContain("doesn't exist"); } // ===== Driver.Galaxy-010 regression: literal arm warns + dev: prefix path ===== [Fact] public void Literal_string_emits_warning_when_logger_supplied() { // A literal API key on a production deployment means the cleartext key sits // in the DriverConfig JSON. The resolver must surface a warning so an // operator who committed one by accident sees it at startup. var logger = new CaptureLogger(); var key = GalaxyDriver.ResolveApiKey("plain-text-key", logger); key.ShouldBe("plain-text-key"); logger.Entries.ShouldContain(e => e.Level == LogLevel.Warning && e.Message.Contains("literal", StringComparison.OrdinalIgnoreCase)); } [Fact] public void Dev_prefix_returns_literal_without_warning() { // An explicit dev: prefix signals the operator knowingly opted into a literal // key (dev / parity rig). The resolver must accept it AND suppress the // warning so production logs aren't polluted on a deliberate dev choice. var logger = new CaptureLogger(); var key = GalaxyDriver.ResolveApiKey("dev:plain-text-key", logger); key.ShouldBe("plain-text-key"); logger.Entries.ShouldNotContain(e => e.Level == LogLevel.Warning); } [Fact] public void Env_prefix_does_not_emit_literal_warning() { const string name = "OTOPCUA_TEST_GALAXY_API_KEY_NOWARN"; Environment.SetEnvironmentVariable(name, "v"); try { var logger = new CaptureLogger(); GalaxyDriver.ResolveApiKey($"env:{name}", logger); logger.Entries.ShouldNotContain(e => e.Level == LogLevel.Warning); } finally { Environment.SetEnvironmentVariable(name, null); } } private sealed class CaptureLogger : ILogger { public List<(LogLevel Level, string Message)> Entries { get; } = new(); public IDisposable? BeginScope(TState state) where TState : notnull => null; public bool IsEnabled(LogLevel logLevel) => true; public void Log(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func formatter) => Entries.Add((logLevel, formatter(state, exception))); } [Fact] public void File_prefix_empty_file_throws() { var path = Path.Combine(Path.GetTempPath(), $"galaxy-key-empty-{Guid.NewGuid():N}.txt"); File.WriteAllText(path, " \n "); try { var ex = Should.Throw(() => GalaxyDriver.ResolveApiKey($"file:{path}")); ex.Message.ShouldContain("empty"); } finally { File.Delete(path); } } }