Skip to content
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.

Sign up for GitHub

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

Add unit tests for LinkUtilities #12647

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add unit tests for LinkUtilities #12647

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3809f3d
Add unit tests for LinkUtilities
Olina-Zhang Dec 16, 2024
9028644
Update
Olina-Zhang Dec 18, 2024
0396ff9
handle feedback
Olina-Zhang Dec 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions src/System.Windows.Forms/tests/UnitTests/System/Windows/Forms/LinkUtilitiesTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

#nullable enable

using System.Drawing;
using Microsoft.Win32;

namespace System.Windows.Forms.Tests;

public class LinkUtilitiesTests
{
[WinFormsTheory]
[InlineData("no", LinkBehavior.NeverUnderline)]
[InlineData("hover", LinkBehavior.HoverUnderline)]
[InlineData("always", LinkBehavior.AlwaysUnderline)]
[InlineData(null, LinkBehavior.AlwaysUnderline)] // Default behavior when key is not set
public void LinkUtilities_GetIELinkBehavior_ReturnsExpected(string? registryValue, LinkBehavior expectedBehavior)
{
// Set registry value if provided
RegistryKey? key = Registry.CurrentUser.CreateSubKey(LinkUtilities.IEMainRegPath);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registry values are machine-wide singletons, multiple test cases might be accessing them at the same time. If we are changing these values, we have to move all tests that read and write them into a sequential collection. It will be hard to identify all tests that read these values behind the scenes. And we might miss that the future tests read this value going forward.
Instead of writing this key I would suggest to read it, and set the right expected LinkBehavior based on the key value.

if (registryValue is not null)
{
key.SetValue("Anchor Underline", registryValue);
}
else
{
key.DeleteValue("Anchor Underline", false); // Ensure no value is set
}

LinkUtilities.GetIELinkBehavior().Should().Be(expectedBehavior);
}

[WinFormsTheory]
[InlineData(LinkBehavior.AlwaysUnderline, FontStyle.Underline, FontStyle.Underline)]
[InlineData(LinkBehavior.HoverUnderline, FontStyle.Regular, FontStyle.Underline)]
[InlineData(LinkBehavior.NeverUnderline, FontStyle.Regular, FontStyle.Regular)]
[InlineData(LinkBehavior.SystemDefault, FontStyle.Regular, FontStyle.Regular)] // Adjust if different default styles are expected
public void LinkUtilities_EnsureLinkFonts_CreatesExpectedFonts(LinkBehavior behavior, FontStyle linkFontStyle, FontStyle hoverLinkFontStyle)
Olina-Zhang marked this conversation as resolved.
Show resolved Hide resolved
{
using Font baseFont = new("Arial", 12);
Font? linkFont = null;
Font? hoverLinkFont = null;

LinkUtilities.EnsureLinkFonts(baseFont, behavior, ref linkFont, ref hoverLinkFont);

linkFont.Should().NotBeNull();
hoverLinkFont.Should().NotBeNull();
linkFont!.Style.Should().Be(linkFontStyle);
Olina-Zhang marked this conversation as resolved.
Show resolved Hide resolved
hoverLinkFont!.Style.Should().Be(hoverLinkFontStyle);
}

[WinFormsTheory]
[InlineData(LinkBehavior.AlwaysUnderline, FontStyle.Underline | FontStyle.Bold, FontStyle.Underline | FontStyle.Bold)]
[InlineData(LinkBehavior.HoverUnderline, FontStyle.Regular, FontStyle.Underline)]
[InlineData(LinkBehavior.NeverUnderline, FontStyle.Bold, FontStyle.Bold)]
public void LinkUtilities_EnsureLinkFonts_CreatesExpectedFonts_WithActive(LinkBehavior behavior, FontStyle linkFontStyle, FontStyle hoverLinkFontStyle)
{
using Font baseFont = new("Arial", 12);
Font? linkFont = null;
Font? hoverLinkFont = null;

LinkUtilities.EnsureLinkFonts(baseFont, behavior, ref linkFont, ref hoverLinkFont, isActive: true);

linkFont.Should().NotBeNull();
hoverLinkFont.Should().NotBeNull();
linkFont!.Style.Should().Be(linkFontStyle);
hoverLinkFont!.Style.Should().Be(hoverLinkFontStyle);
}
}
Loading