-
Notifications
You must be signed in to change notification settings - Fork 293
[Test Improver] test: add unit tests for LoggingManager.BuildAsync and ExtensionValidationHelper.ValidateUniqueExtension #8125
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
Open
Evangelink
wants to merge
5
commits into
main
Choose a base branch
from
test-assist/logging-manager-extension-validation-tests-853aaedb3e22557c
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+164
−177
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
c320708
test: add unit tests for LoggingManager.BuildAsync and ExtensionValid…
github-actions[bot] 13ba98c
test: address review nits in logging and extension validation tests
Copilot f8180d9
test: configure InitializeAsync in disabled-provider logging test
Copilot d64e3c6
Merge origin/main and resolve test file conflicts
Copilot 8a03224
Merge remote-tracking branch 'origin/main' into test-assist/logging-m…
Evangelink File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
173 changes: 65 additions & 108 deletions
173
.../UnitTests/Microsoft.Testing.Platform.UnitTests/Helpers/ExtensionValidationHelperTests.cs
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,198 +1,155 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT license. See LICENSE file in the project root for full license information. | ||
|
|
||
| using Microsoft.Testing.Platform.Extensions; | ||
| using Microsoft.Testing.Platform.Helpers; | ||
| using Microsoft.Testing.Platform.UnitTests.Helpers; | ||
|
|
||
| namespace Microsoft.Testing.Platform.UnitTests; | ||
|
|
||
| [TestClass] | ||
| public sealed class ExtensionValidationHelperTests | ||
| { | ||
| // Generic overload: ValidateUniqueExtension<T>(IEnumerable<T>, IExtension, Func<T, IExtension>) | ||
| [TestMethod] | ||
| public void ValidateUniqueExtension_WhenExistingExtensionsIsNull_ThrowsArgumentNullException() | ||
| public void ValidateUniqueExtension_WithNullExistingExtensions_ThrowsArgumentNullException() | ||
| { | ||
| IEnumerable<IExtension> existingExtensions = null!; | ||
| IExtension newExtension = CreateExtension("uid1"); | ||
| IEnumerable<IExtension> existing = null!; | ||
| TestExtension newExtension = new(); | ||
|
|
||
| Assert.ThrowsExactly<ArgumentNullException>( | ||
| () => existingExtensions.ValidateUniqueExtension(newExtension, x => x)); | ||
| Assert.ThrowsExactly<ArgumentNullException>(() => existing.ValidateUniqueExtension(newExtension)); | ||
| } | ||
|
|
||
| [TestMethod] | ||
| public void ValidateUniqueExtension_WhenNewExtensionIsNull_ThrowsArgumentNullException() | ||
| public void ValidateUniqueExtension_WithNullNewExtension_ThrowsArgumentNullException() | ||
| { | ||
| IExtension[] existingExtensions = []; | ||
| IExtension newExtension = null!; | ||
| List<IExtension> existing = []; | ||
|
|
||
| Assert.ThrowsExactly<ArgumentNullException>( | ||
| () => existingExtensions.ValidateUniqueExtension(newExtension, x => x)); | ||
| Assert.ThrowsExactly<ArgumentNullException>(() => existing.ValidateUniqueExtension(null!)); | ||
| } | ||
|
|
||
| [TestMethod] | ||
| public void ValidateUniqueExtension_WhenExtensionSelectorIsNull_ThrowsArgumentNullException() | ||
| public void ValidateUniqueExtension_WithEmptyCollection_DoesNotThrow() | ||
| { | ||
| IExtension[] existingExtensions = []; | ||
| IExtension newExtension = CreateExtension("uid1"); | ||
| List<IExtension> existing = []; | ||
| TestExtension newExtension = new("uid1"); | ||
|
|
||
| Assert.ThrowsExactly<ArgumentNullException>( | ||
| () => existingExtensions.ValidateUniqueExtension<IExtension>(newExtension, null!)); | ||
| existing.ValidateUniqueExtension(newExtension); | ||
| } | ||
|
|
||
| [TestMethod] | ||
| public void ValidateUniqueExtension_WhenCollectionIsEmpty_DoesNotThrow() | ||
| public void ValidateUniqueExtension_WithNonDuplicateUid_DoesNotThrow() | ||
| { | ||
| IExtension[] existingExtensions = []; | ||
| IExtension newExtension = CreateExtension("uid1"); | ||
| List<IExtension> existing = [new TestExtension("uid1")]; | ||
| TestExtension newExtension = new("uid2"); | ||
|
|
||
| existingExtensions.ValidateUniqueExtension(newExtension, x => x); | ||
| existing.ValidateUniqueExtension(newExtension); | ||
| } | ||
|
|
||
| [TestMethod] | ||
| public void ValidateUniqueExtension_WhenNoDuplicateUid_DoesNotThrow() | ||
| public void ValidateUniqueExtension_WithDuplicateUid_ThrowsInvalidOperationException() | ||
| { | ||
| IExtension[] existingExtensions = [CreateExtension("uid-A"), CreateExtension("uid-B")]; | ||
| IExtension newExtension = CreateExtension("uid-C"); | ||
| List<IExtension> existing = [new TestExtension("uid1")]; | ||
| TestExtension newExtension = new("uid1"); | ||
|
|
||
| existingExtensions.ValidateUniqueExtension(newExtension, x => x); | ||
| Assert.ThrowsExactly<InvalidOperationException>(() => existing.ValidateUniqueExtension(newExtension)); | ||
| } | ||
|
|
||
| [TestMethod] | ||
| public void ValidateUniqueExtension_WhenDuplicateUidExists_ErrorMessageContainsUid() | ||
| public void ValidateUniqueExtension_WithDuplicateUid_ErrorMessageContainsDuplicateUid() | ||
| { | ||
| const string duplicateUid = "my-duplicate-uid"; | ||
| IExtension[] existingExtensions = [CreateExtension(duplicateUid)]; | ||
| IExtension newExtension = CreateExtension(duplicateUid); | ||
| List<IExtension> existing = [new TestExtension("uid1")]; | ||
| TestExtension newExtension = new("uid1"); | ||
|
|
||
| InvalidOperationException ex = Assert.ThrowsExactly<InvalidOperationException>( | ||
| () => existingExtensions.ValidateUniqueExtension(newExtension, x => x)); | ||
| () => existing.ValidateUniqueExtension(newExtension)); | ||
|
|
||
| Assert.Contains(duplicateUid, ex.Message); | ||
| Assert.Contains("uid1", ex.Message); | ||
| } | ||
|
|
||
| [TestMethod] | ||
| public void ValidateUniqueExtension_WhenDuplicateUidExists_ErrorMessageContainsTypeNames() | ||
| public void ValidateUniqueExtension_WithDuplicateUid_ErrorMessageContainsTypeName() | ||
| { | ||
| const string duplicateUid = "my-duplicate-uid"; | ||
| FakeExtensionA existing = new(duplicateUid); | ||
| FakeExtensionB newExtension = new(duplicateUid); | ||
| List<IExtension> existing = [new TestExtension("uid1")]; | ||
| TestExtension newExtension = new("uid1"); | ||
|
|
||
| InvalidOperationException ex = Assert.ThrowsExactly<InvalidOperationException>( | ||
| () => ((IExtension[])[existing]).ValidateUniqueExtension(newExtension, x => x)); | ||
| () => existing.ValidateUniqueExtension(newExtension)); | ||
|
|
||
| Assert.Contains(typeof(FakeExtensionA).ToString(), ex.Message); | ||
| Assert.Contains(typeof(FakeExtensionB).ToString(), ex.Message); | ||
| Assert.Contains(typeof(TestExtension).ToString(), ex.Message); | ||
| } | ||
|
Evangelink marked this conversation as resolved.
|
||
|
|
||
| [TestMethod] | ||
| public void ValidateUniqueExtension_WhenMultipleDuplicatesExist_ErrorMessageContainsAllTypes() | ||
| public void ValidateUniqueExtension_WithMultipleDuplicates_ThrowsInvalidOperationException() | ||
| { | ||
| const string duplicateUid = "shared-uid"; | ||
| FakeExtensionA existing1 = new(duplicateUid); | ||
| FakeExtensionB existing2 = new(duplicateUid); | ||
| FakeExtensionC newExtension = new(duplicateUid); | ||
| List<IExtension> existing = [new TestExtension("uid1"), new TestExtension("uid1")]; | ||
| TestExtension newExtension = new("uid1"); | ||
|
|
||
| InvalidOperationException ex = Assert.ThrowsExactly<InvalidOperationException>( | ||
| () => ((IExtension[])[existing1, existing2]).ValidateUniqueExtension(newExtension, x => x)); | ||
|
|
||
| Assert.Contains(typeof(FakeExtensionA).ToString(), ex.Message); | ||
| Assert.Contains(typeof(FakeExtensionB).ToString(), ex.Message); | ||
| Assert.Contains(typeof(FakeExtensionC).ToString(), ex.Message); | ||
| } | ||
|
|
||
| [TestMethod] | ||
| public void ValidateUniqueExtension_WithWrapperType_SelectsExtensionViaSelector() | ||
| { | ||
| const string duplicateUid = "wrapper-uid"; | ||
| ExtensionWrapper existing = new(CreateExtension(duplicateUid)); | ||
| IExtension newExtension = CreateExtension(duplicateUid); | ||
|
|
||
| Assert.ThrowsExactly<InvalidOperationException>( | ||
| () => ((ExtensionWrapper[])[existing]).ValidateUniqueExtension(newExtension, w => w.Extension)); | ||
| Assert.ThrowsExactly<InvalidOperationException>(() => existing.ValidateUniqueExtension(newExtension)); | ||
| } | ||
|
|
||
| [TestMethod] | ||
| public void ValidateUniqueExtension_WithWrapperType_WhenNoDuplicate_DoesNotThrow() | ||
| public void ValidateUniqueExtension_Selector_WithNullExistingExtensions_ThrowsArgumentNullException() | ||
| { | ||
| ExtensionWrapper existing = new(CreateExtension("uid-X")); | ||
| IExtension newExtension = CreateExtension("uid-Y"); | ||
| IEnumerable<IExtension> existing = null!; | ||
| TestExtension newExtension = new(); | ||
|
|
||
| ((ExtensionWrapper[])[existing]).ValidateUniqueExtension(newExtension, w => w.Extension); | ||
| Assert.ThrowsExactly<ArgumentNullException>(() => existing.ValidateUniqueExtension(newExtension, x => x)); | ||
| } | ||
|
|
||
| [TestMethod] | ||
| public void ValidateUniqueExtension_WhenUidsDifferOnlyByCase_DoesNotThrow() | ||
| public void ValidateUniqueExtension_Selector_WithNullNewExtension_ThrowsArgumentNullException() | ||
| { | ||
| IExtension[] existingExtensions = [CreateExtension("uid-A")]; | ||
| IExtension newExtension = CreateExtension("uid-a"); | ||
| List<IExtension> existing = []; | ||
|
|
||
| existingExtensions.ValidateUniqueExtension(newExtension, x => x); | ||
| Assert.ThrowsExactly<ArgumentNullException>(() => existing.ValidateUniqueExtension(null!, x => x)); | ||
| } | ||
|
|
||
| // Simple overload: ValidateUniqueExtension(IEnumerable<IExtension>, IExtension) | ||
| [TestMethod] | ||
| public void ValidateUniqueExtension_SimpleOverload_WhenExistingExtensionsIsNull_ThrowsArgumentNullException() | ||
| public void ValidateUniqueExtension_Selector_WithNullSelector_ThrowsArgumentNullException() | ||
| { | ||
| IEnumerable<IExtension> existingExtensions = null!; | ||
| IExtension newExtension = CreateExtension("uid1"); | ||
| List<IExtension> existing = []; | ||
| TestExtension newExtension = new(); | ||
|
|
||
| Assert.ThrowsExactly<ArgumentNullException>( | ||
| () => existingExtensions.ValidateUniqueExtension(newExtension)); | ||
| Assert.ThrowsExactly<ArgumentNullException>(() => existing.ValidateUniqueExtension<IExtension>(newExtension, null!)); | ||
| } | ||
|
|
||
| [TestMethod] | ||
| public void ValidateUniqueExtension_SimpleOverload_WhenNewExtensionIsNull_ThrowsArgumentNullException() | ||
| public void ValidateUniqueExtension_Selector_WithNonDuplicateUid_DoesNotThrow() | ||
| { | ||
| IExtension[] existingExtensions = []; | ||
| List<(string Tag, IExtension Ext)> existing = [("a", new TestExtension("uid1"))]; | ||
| TestExtension newExtension = new("uid2"); | ||
|
|
||
| Assert.ThrowsExactly<ArgumentNullException>( | ||
| () => existingExtensions.ValidateUniqueExtension(null!)); | ||
| existing.ValidateUniqueExtension(newExtension, item => item.Ext); | ||
| } | ||
|
|
||
| [TestMethod] | ||
| public void ValidateUniqueExtension_SimpleOverload_WhenNoDuplicate_DoesNotThrow() | ||
| public void ValidateUniqueExtension_Selector_WithDuplicateUid_ThrowsInvalidOperationException() | ||
| { | ||
| IExtension[] existingExtensions = [CreateExtension("uid-A"), CreateExtension("uid-B")]; | ||
| IExtension newExtension = CreateExtension("uid-C"); | ||
| List<(string Tag, IExtension Ext)> existing = [("a", new TestExtension("uid1"))]; | ||
| TestExtension newExtension = new("uid1"); | ||
|
|
||
| existingExtensions.ValidateUniqueExtension(newExtension); | ||
| Assert.ThrowsExactly<InvalidOperationException>( | ||
| () => existing.ValidateUniqueExtension(newExtension, item => item.Ext)); | ||
| } | ||
|
|
||
| [TestMethod] | ||
| public void ValidateUniqueExtension_SimpleOverload_WhenDuplicateUidExists_ThrowsInvalidOperationException() | ||
| public void ValidateUniqueExtension_Selector_WithDuplicateUid_ErrorMessageContainsDuplicateUid() | ||
| { | ||
| const string duplicateUid = "my-duplicate-uid"; | ||
| IExtension[] existingExtensions = [CreateExtension(duplicateUid)]; | ||
| IExtension newExtension = CreateExtension(duplicateUid); | ||
| List<(string Tag, IExtension Ext)> existing = [("a", new TestExtension("uid1"))]; | ||
| TestExtension newExtension = new("uid1"); | ||
|
|
||
| InvalidOperationException ex = Assert.ThrowsExactly<InvalidOperationException>( | ||
| () => existingExtensions.ValidateUniqueExtension(newExtension)); | ||
| () => existing.ValidateUniqueExtension(newExtension, item => item.Ext)); | ||
|
|
||
| Assert.Contains(duplicateUid, ex.Message); | ||
| Assert.Contains("uid1", ex.Message); | ||
| } | ||
|
|
||
| private static IExtension CreateExtension(string uid) => new FakeExtension(uid); | ||
|
|
||
| private abstract class FakeExtensionBase(string uid) : IExtension | ||
| [TestMethod] | ||
| public void ValidateUniqueExtension_Selector_WithEmptyCollection_DoesNotThrow() | ||
| { | ||
| public string Uid => uid; | ||
|
|
||
| public string Version => "1.0"; | ||
|
|
||
| public string DisplayName => uid; | ||
| List<(string Tag, IExtension Ext)> existing = []; | ||
| TestExtension newExtension = new("uid1"); | ||
|
|
||
| public string Description => uid; | ||
|
|
||
| public Task<bool> IsEnabledAsync() => Task.FromResult(true); | ||
| existing.ValidateUniqueExtension(newExtension, item => item.Ext); | ||
| } | ||
|
|
||
| private sealed class FakeExtension(string uid) : FakeExtensionBase(uid); | ||
|
|
||
| private sealed class FakeExtensionA(string uid) : FakeExtensionBase(uid); | ||
|
|
||
| private sealed class FakeExtensionB(string uid) : FakeExtensionBase(uid); | ||
|
|
||
| private sealed class FakeExtensionC(string uid) : FakeExtensionBase(uid); | ||
|
|
||
| private sealed record ExtensionWrapper(IExtension Extension); | ||
| } | ||
This file contains hidden or 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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.