-
Notifications
You must be signed in to change notification settings - Fork 6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
OSOE-402: Custom logging instead of NLog-based one #419
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
changed the title
Custom logging instead of NLog-based one
OSOE-402: Custom logging instead of NLog-based one
Nov 8, 2024
dministro
requested changes
Nov 13, 2024
Lombiq.Tests.UI/Extensions/ApplicationLogEnumerableExtensions.cs
Outdated
Show resolved
Hide resolved
dministro
approved these changes
Nov 17, 2024
dministro
approved these changes
Nov 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
OSOE-402
Fixes #206
To be added to the release notes on the next release:
Breaking changes in logging during UI tests
One of the implicit assertions that the UI Testing Toolbox does automatically is checking the Orchard Core application logs for any errors. By default, any error fails the test.
Previously, this relied on the tested web app using NLog for logging, and it parsed NLog log files. This not only required the app to use NLog over Serilog (that Orchard also supports out of the box) or any other logging framework, but it also depended on the structure of an otherwise freely configurable textual log format.
Now, the UI Testing Toolbox configures the app to use
FakeLogger
in addition to any logging framework it has set up, and uses it for assertions.FakeLogger
not only doesn't need anything specific in the app, but it also lets you access and assert on log entries in a structured, statically typed way.Using NLog is still support, and log files will be included in the test dump. Any other logging framework is also supported, your app doesn't need to do anything special.
What changed
IApplicationLog
andIApplicationLogEntry
instances.LogsShouldBeEmptyAsync
andGetLogOutputAsync
methods have changed, see the diff.CreateAppLogAssertionForSecurityScan
andCreateAppLogAssertionForSecurityScan
work the same but were moved into theLombiq.Tests.UI.SecurityScanning
namespace.OrchardCoreConfiguration.AfterFakeLoggingConfiguration
event handler is exposed to change the default configuration ofFakeLogger
.OrchardCoreUITestExecutorConfiguration.AssertAppLogsCanContainWarningsAsync
andOrchardCoreUITestExecutorConfiguration.AssertAppLogsCanContainWarningsAndCacheFolderErrorsAsync
are no longer available.How to adapt
OrchardCoreUITestExecutorConfiguration.AssertAppLogsCanContainCacheFolderErrorsAsync
instead ofOrchardCoreUITestExecutorConfiguration.AssertAppLogsCanContainWarningsAndCacheFolderErrorsAsync
.OrchardCoreUITestExecutorConfiguration.AssertAppLogsCanContainWarningsAsync
is not needed, since the new behavior is to not log warnings in the first place.Lombiq.Tests.UI.Samples.UITestBase
, see the diff. Check them out if you have custom app log assertion code.