From 1c379e3a57241166b103c5c886104c2316840b7c Mon Sep 17 00:00:00 2001 From: Matt Sturgeon Date: Thu, 22 Aug 2024 17:05:19 +0100 Subject: [PATCH 1/2] buildDotnetModule: add `testFilters` arg In addition to the existing `disabledTests`, allow defining more general test filters using `testFilters`. --- doc/languages-frameworks/dotnet.section.md | 1 + pkgs/build-support/dotnet/build-dotnet-module/default.nix | 6 ++++++ .../dotnet/build-dotnet-module/hooks/dotnet-check-hook.sh | 8 +++++++- 3 files changed, 14 insertions(+), 1 deletion(-) diff --git a/doc/languages-frameworks/dotnet.section.md b/doc/languages-frameworks/dotnet.section.md index 546b451f31177..cdacec1c3a5ea 100644 --- a/doc/languages-frameworks/dotnet.section.md +++ b/doc/languages-frameworks/dotnet.section.md @@ -118,6 +118,7 @@ For more detail about managing the `deps.nix` file, see [Generating and updating * `dotnet-sdk` is useful in cases where you need to change what dotnet SDK is being used. You can also set this to the result of `dotnetSdkPackages.combinePackages`, if the project uses multiple SDKs to build. * `dotnet-runtime` is useful in cases where you need to change what dotnet runtime is being used. This can be either a regular dotnet runtime, or an aspnetcore. * `testProjectFile` is useful in cases where the regular project file does not contain the unit tests. It gets restored and build, but not installed. You may need to regenerate your nuget lockfile after setting this. Note that if set, only tests from this project are executed. +* `testFilters` is used to disable running unit tests based on various [filters](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-test#filter-option-details). This gets passed as: `dotnet test --filter "{}"`, with each filter being concatenated using `"&"`. * `disabledTests` is used to disable running specific unit tests. This gets passed as: `dotnet test --filter "FullyQualifiedName!={}"`, to ensure compatibility with all unit test frameworks. * `dotnetRestoreFlags` can be used to pass flags to `dotnet restore`. * `dotnetBuildFlags` can be used to pass flags to `dotnet build`. diff --git a/pkgs/build-support/dotnet/build-dotnet-module/default.nix b/pkgs/build-support/dotnet/build-dotnet-module/default.nix index c8ad6a174ce53..418c90c648996 100644 --- a/pkgs/build-support/dotnet/build-dotnet-module/default.nix +++ b/pkgs/build-support/dotnet/build-dotnet-module/default.nix @@ -67,7 +67,12 @@ let # platforms in meta.platforms which are supported by the sdk. runtimeId ? null, + # Test filters. This gets passed to `dotnet test --filter`, concatenated using `&`. + # You may also use `disabledTests` to filter tests based on their name. + # See https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-test#filter-option-details for more details. + testFilters ? [ ], # Tests to disable. This gets passed to `dotnet test --filter "FullyQualifiedName!={}"`, to ensure compatibility with all frameworks. + # You may also use `testFilters` to pass more generic filters to `dotnet test --filter`. # See https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-test#filter-option-details for more details. disabledTests ? [ ], # The project file to run unit tests against. This is usually referenced in the regular project file, but sometimes it needs to be manually set. @@ -132,6 +137,7 @@ let dotnetBuildType = buildType; dotnetProjectFiles = projectFiles; dotnetTestProjectFiles = testProjectFiles; + dotnetTestFilters = testFilters; dotnetDisabledTests = disabledTests; dotnetRuntimeIds = lib.singleton ( if runtimeId != null then runtimeId else systemToDotnetRid stdenvNoCC.hostPlatform.system diff --git a/pkgs/build-support/dotnet/build-dotnet-module/hooks/dotnet-check-hook.sh b/pkgs/build-support/dotnet/build-dotnet-module/hooks/dotnet-check-hook.sh index 4dc8b5a97a1f9..21ebbbe5381e1 100644 --- a/pkgs/build-support/dotnet/build-dotnet-module/hooks/dotnet-check-hook.sh +++ b/pkgs/build-support/dotnet/build-dotnet-module/hooks/dotnet-check-hook.sh @@ -9,6 +9,7 @@ dotnetCheckHook() { local dotnetProjectFilesArray=( "${dotnetProjectFiles[@]}" ) local dotnetTestProjectFilesArray=( "${dotnetTestProjectFiles[@]}" ) local dotnetTestFlagsArray=( "${dotnetTestFlags[@]}" ) + local dotnetTestFiltersArray=( "${dotnetTestFilters[@]}" ) local dotnetDisabledTestsArray=( "${dotnetDisabledTests[@]}" ) local dotnetRuntimeDepsArray=( "${dotnetRuntimeDeps[@]}" ) local dotnetRuntimeIdsArray=( "${dotnetRuntimeIds[@]}" ) @@ -16,6 +17,7 @@ dotnetCheckHook() { local dotnetProjectFilesArray=($dotnetProjectFiles) local dotnetTestProjectFilesArray=($dotnetTestProjectFiles) local dotnetTestFlagsArray=($dotnetTestFlags) + local dotnetTestFiltersArray=($dotnetTestFilters) local dotnetDisabledTestsArray=($dotnetDisabledTests) local dotnetRuntimeDepsArray=($dotnetRuntimeDeps) local dotnetRuntimeIdsArray=($dotnetRuntimeIds) @@ -23,8 +25,12 @@ dotnetCheckHook() { if (( ${#dotnetDisabledTestsArray[@]} > 0 )); then local disabledTestsFilters=("${dotnetDisabledTestsArray[@]/#/FullyQualifiedName!=}") + dotnetTestFiltersArray=( "${dotnetTestFiltersArray[@]}" "${disabledTestsFilters[@]//,/%2C}" ) + fi + + if (( ${#dotnetTestFiltersArray[@]} > 0 )); then local OLDIFS="$IFS" IFS='&' - dotnetTestFlagsArray+=("--filter:${disabledTestsFilters[*]//,/%2C}") + dotnetTestFlagsArray+=("--filter:${dotnetTestFiltersArray[*]}") IFS="$OLDIFS" fi From a177c637b91c7d40531327a04dfdc3e1035d293b Mon Sep 17 00:00:00 2001 From: Matt Sturgeon Date: Thu, 22 Aug 2024 17:08:39 +0100 Subject: [PATCH 2/2] nexusmods-app: use `testFilters` & `disabledTests` args --- pkgs/by-name/ne/nexusmods-app/package.nix | 32 +++++++++++------------ 1 file changed, 15 insertions(+), 17 deletions(-) diff --git a/pkgs/by-name/ne/nexusmods-app/package.nix b/pkgs/by-name/ne/nexusmods-app/package.nix index 875f17e876bb6..f8d49ce1660ba 100644 --- a/pkgs/by-name/ne/nexusmods-app/package.nix +++ b/pkgs/by-name/ne/nexusmods-app/package.nix @@ -69,25 +69,23 @@ buildDotnetModule rec { doCheck = true; - dotnetTestFlags = [ - "--environment=USER=nobody" - ( - "--filter=" - + lib.strings.concatStringsSep "&" ( - [ - "Category!=Disabled" - "FlakeyTest!=True" - "RequiresNetworking!=True" - "FullyQualifiedName!=NexusMods.UI.Tests.ImageCacheTests.Test_LoadAndCache_RemoteImage" - "FullyQualifiedName!=NexusMods.UI.Tests.ImageCacheTests.Test_LoadAndCache_ImageStoredFile" - ] - ++ lib.optionals (!_7zz.meta.unfree) [ - "FullyQualifiedName!=NexusMods.Games.FOMOD.Tests.FomodXmlInstallerTests.InstallsFilesSimple_UsingRar" - ] - ) - ) + dotnetTestFlags = [ "--environment=USER=nobody" ]; + + testFilters = [ + "Category!=Disabled" + "FlakeyTest!=True" + "RequiresNetworking!=True" ]; + disabledTests = + [ + "NexusMods.UI.Tests.ImageCacheTests.Test_LoadAndCache_RemoteImage" + "NexusMods.UI.Tests.ImageCacheTests.Test_LoadAndCache_ImageStoredFile" + ] + ++ lib.optionals (!_7zz.meta.unfree) [ + "NexusMods.Games.FOMOD.Tests.FomodXmlInstallerTests.InstallsFilesSimple_UsingRar" + ]; + passthru = { tests = let