From b4c7183f64c327cc6acca7dc8ee7b8d4e79aea58 Mon Sep 17 00:00:00 2001 From: Szabolcs Deme Date: Thu, 21 Dec 2023 01:55:12 +0100 Subject: [PATCH] Adding documentation about HTML validation rule changing --- Lombiq.Tests.UI/Docs/Configuration.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/Lombiq.Tests.UI/Docs/Configuration.md b/Lombiq.Tests.UI/Docs/Configuration.md index 933dc2d2c..cc7562cfe 100644 --- a/Lombiq.Tests.UI/Docs/Configuration.md +++ b/Lombiq.Tests.UI/Docs/Configuration.md @@ -57,6 +57,28 @@ Recommendations and notes for such configuration: - If you have several UI test projects it can be cumbersome to maintain a _TestConfiguration.json_ file for each. Instead you can set the value of the `LOMBIQ_UI_TESTING_TOOLBOX_SHARED_TEST_CONFIGURATION` environment variable to the absolute path of a central configuration file and then each project will look it up. If you place an individual _TestConfiguration.json_ into a test directory it will still take precedence in case you need special configuration for just that one. - `MaxParallelTests` sets how many UI tests should run at the same time. It is an important property if you want to run your UI tests in parallel, check out the inline documentation in [`OrchardCoreUITestExecutorConfiguration`](../Services/OrchardCoreUITestExecutorConfiguration.cs). +### HTML validation configuration + +If you want to change some HTML validation rules from only a few specific tests, you can create a custom `.htmlvalidate.json` (e.g. `TestName.htmlvalidate.json`), then you can change the configuration to use that: + +```cs + changeConfiguration: configuration => configuration.HtmlValidationConfiguration.HtmlValidationOptions = + configuration.HtmlValidationConfiguration.HtmlValidationOptions + .CloneWith(validationOptions => validationOptions.ConfigPath = + Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "TestName.htmlvalidate.json"))); +``` + +Make sure to also include the `root` attribute and set it to `true` inside the custom `.htmlvalidate.json` and include it in the test project like this: + +```xml + + + PreserveNewest + true + + + ``` + ## Multi-process test execution UI tests are executed in parallel by default for the given test execution process (see the [xUnit documentation](https://xunit.net/docs/running-tests-in-parallel.html)). However, if you'd like multiple processes to execute tests like when multiple build agents run tests for separate branches on the same build machine then you'll need to tell each process which build agent they are on. This is so clashes on e.g. network port numbers can be prevented.