Question

我有跟随的功能，并尝试在旧项目上添加单元测试。我是单元测试的初学者，请原谅我，如果问题是愚蠢的......

public static string GetDefaultName(bool isResponsive)
    {
        //Read web.config file
        Configuration configuration = WebConfigurationManager.OpenWebConfiguration(System.Web.HttpContext.Current.Request.ApplicationPath);
        if (!isResponsive)
        {
            if (configuration.AppSettings.Settings.AllKeys.Contains("defaultTheme"))
            {
                return configuration.AppSettings.Settings["defaultTheme"].Value;
            }
            else
                return "default";
        }
        else
        {
            // ...
        }
    }

我试图以这种方式编写单元测试：

 [TestMethod]
    public void ReturnDefaulThemeNametIfThemeIsResponsive()
    {
        var theme = new Theme {isResponsive = true};

        var defaultName = Themes.GetDefaultName(theme.isResponsive);
        Assert.AreEqual(defaultName, "defaultThemeResponsive");
    }

我想知道测试这个静态函数的最佳方法是什么，以及如何模拟读取web.config文件的部分？

Answer 1

目前设计方法的方式不允许您模拟读取配置文件的部分。如果您希望能够这样做，则需要将其作为方法的参数。使这更容易的一种方法是定义类似

的界面

public interface ISetting
{
    string GetConfigItem(string itemName);
}

然后将Configuration对象包装在实现此目的的设置管理器类中。

public class MySettings:ISetting
{
    public string GetConfigItem(string ItemName)
    {
        // return value of the setting. In your case code that gets value of "defaultTheme"
    }
}

您的方法现在依赖于ISetting。

出于测试目的，您可以创建一个实现接口的模拟，并返回您想要的值，而不依赖于web.config的当前状态和内容

public class SettingsTestHelper:ISetting
{
    private _valueToReturn;
    public SettingsTestHelper(string valueToReturn)
    {
        _valueToReturn=valueToReturn;
    }
    public string GetConfigItem(string itemName)
    {
        return valueToReturn;
    }
}

有了这个，你现在可以创建一个单元测试（没有编译，但你会得到这个想法）

[TestMethod]
public void CanGetSetting()
{
    var helper = new SettingsTestHelper("default");
    var result = ClasThatImplementsYourStaticMethod.GetDefaultName(helper, true);
    Assert.AreEqual(expected, actual);
}

Answer 2

我试图远离具有依赖关系的静态实用程序，因为它们很难进行单元测试。但在这种情况下，它是可能的。你将不得不做一些重构。

首先，您需要抽象所有调用来访问配置。

public interface IThemeSettings {
    bool Contains(string key);
    string this[string key] { get; }
}

然后，您可以更新静态Themes实用程序类，以将此抽象用作依赖项

public static class Themes {
    private static IThemeSettings themes;

    public static void Configure(Func<IThemeSettings> factory) {
        if (factory == null) throw new InvalidOperationException("Must provide a valid factory method");
        themes = factory();
    }

    public static string GetDefaultName(bool isResponsive) {
        if (themes == null) throw new InvalidOperationException("Themes has not been configured.");
        string result = string.Empty;
        if (!isResponsive) {
            if (themes.Contains("defaultTheme")) {
                result = themes["defaultTheme"];
            } else
                result = "default";
        } else {
            // ...
        }
        return result;
    }

    //...
}

现在，您可以将实用程序配置为在测试时使用模拟

[TestMethod]
public void ReturnDefaulThemeNametIfThemeIsResponsive() {
    //Arrange
    var key = "defaultTheme";
    var expected = "defaultThemeResponsive";

    var mockSettings = new Mock<IThemeSettings>();
    mockSettings.Setup(m => m.Contains(key)).Returns(true);
    mockSettings.Setup(m => m[key]).Returns(expected);

    //In production you would also do something like this with
    //the actual production implementation, not a mock
    Themes.Configure(() => mockSettings.Object);

    var theme = new Theme { isResponsive = true };

    //Act
    var defaultName = Themes.GetDefaultName(theme.isResponsive);

    //Assert
    Assert.AreEqual(expected, defaultName);
}

在这种情况下，我使用Moq作为模拟框架。

一些建议。尽量不要让你的课程与HttpContext紧密相连。你的课程应该依赖于抽象而不是结核。

对读取文件的静态函数进行单元测试

2 个答案: